mirror of
https://github.com/sinatra/sinatra
synced 2023-03-27 23:18:01 -04:00
8ae87a87f3
* Initialize rubocop * Style/StringLiterals: prefer single quotes * Style/AndOr: use `&&` and `||`, instead of `and` and `or` * Style/HashSyntax: use new hash syntax * Layout/EmptyLineAfterGuardClause: add empty lines after guard clause * Style/SingleLineMethods: temporary disable It breaks layout of the code, it is better to fix it manually * Style/Proc: prefer `proc` vs `Proc.new` * Disable Lint/AmbiguousBlockAssociation It affects proc definitions for sinatra DSL * Disable Style/CaseEquality * Lint/UnusedBlockArgument: put underscore in front of it * Style/Alias: prefer alias vs alias_method in a class body * Layout/EmptyLineBetweenDefs: add empty lines between defs * Style/ParallelAssignment: don't use parallel assigment * Style/RegexpLiteral: prefer %r for regular expressions * Naming/UncommunicativeMethodParamName: fix abbrevs * Style/PerlBackrefs: disable cop * Layout/SpaceAfterComma: add missing spaces * Style/Documentation: disable cop * Style/FrozenStringLiteralComment: add frozen_string_literal * Layout/AlignHash: align hash * Layout/ExtraSpacing: allow for alignment * Layout/SpaceAroundOperators: add missing spaces * Style/Not: prefer `!` instead of `not` * Style/GuardClause: add guard conditions * Style/MutableConstant: freeze contants * Lint/IneffectiveAccessModifier: disable cop * Lint/RescueException: disable cop * Style/SpecialGlobalVars: disable cop * Layout/DotPosition: fix position of dot for multiline method chains * Layout/SpaceInsideArrayLiteralBrackets: don't use spaces inside arrays * Layout/SpaceInsideBlockBraces: add space for blocks * Layout/SpaceInsideHashLiteralBraces: add spaces for hashes * Style/FormatString: use format string syntax * Style/StderrPuts: `warn` is preferable to `$stderr.puts` * Bundler/DuplicatedGem: disable cop * Layout/AlignArray: fix warning * Lint/AssignmentInCondition: remove assignments from conditions * Layout/IndentHeredoc: disable cop * Layout/SpaceInsideParens: remove extra spaces * Lint/UnusedMethodArgument: put underscore in front of unused arg * Naming/RescuedExceptionsVariableName: use `e` for exceptions * Style/CommentedKeyword: put comments before the method * Style/FormatStringToken: disable cop * Style/MultilineIfModifier: move condition before the method * Style/SignalException: prefer `raise` to `fail` * Style/SymbolArray: prefer %i for array of symbols * Gemspec/OrderedDependencies: Use alphabetical order for dependencies * Lint/UselessAccessModifier: disable cop * Naming/HeredocDelimiterNaming: change delimiter's name * Style/ClassCheck: prefer `is_a?` to `kind_of?` * Style/ClassVars: disable cop * Style/Encoding: remove coding comment * Style/RedundantParentheses: remove extra parentheses * Style/StringLiteralsInInterpolation: prefer singl quotes * Layout/AlignArguments: fix alignment * Layout/ClosingHeredocIndentation: align heredoc * Layout/EmptyLineAfterMagicComment: add empty line * Set RubyVersion for rubocop * Lint/UselessAssignment: disable cop * Style/EmptyLiteral: disable cop Causes test failures * Minor code-style fixes with --safe-auto-correct option * Disable the rest of the cops that cause warnings It would be easier to re-enable them in separate PRs * Add rubocop check to the default Rake task * Update to rubocop 1.32.0 * Rubocop updates for rack-protection and sinatra-contrib * Disable Style/SlicingWithRange cop * Make suggested updates Co-authored-by: Jordan Owens <jkowens@gmail.com>
74 lines
2 KiB
Ruby
74 lines
2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
$LOAD_PATH.unshift File.expand_path('lib', __dir__)
|
|
|
|
begin
|
|
require 'bundler'
|
|
Bundler::GemHelper.install_tasks
|
|
rescue LoadError => e
|
|
warn e
|
|
end
|
|
|
|
desc 'run specs'
|
|
task(:spec) { ruby '-S rspec' }
|
|
|
|
namespace :doc do
|
|
task :readmes do
|
|
Dir.glob 'lib/rack/protection/*.rb' do |file|
|
|
excluded_files = %w[lib/rack/protection/base.rb lib/rack/protection/version.rb]
|
|
next if excluded_files.include?(file)
|
|
|
|
doc = File.read(file)[/^ module Protection(\n)+( #[^\n]*\n)*/m].scan(/^ *#(?!#) ?(.*)\n/).join("\n")
|
|
file = "doc/#{file[4..-4].tr('/_', '-')}.rdoc"
|
|
Dir.mkdir 'doc' unless File.directory? 'doc'
|
|
puts "writing #{file}"
|
|
File.open(file, 'w') { |f| f << doc }
|
|
end
|
|
end
|
|
|
|
task :index do
|
|
doc = File.read('README.md')
|
|
file = 'doc/rack-protection-readme.md'
|
|
Dir.mkdir 'doc' unless File.directory? 'doc'
|
|
puts "writing #{file}"
|
|
File.open(file, 'w') { |f| f << doc }
|
|
end
|
|
|
|
task all: %i[readmes index]
|
|
end
|
|
|
|
desc 'generate documentation'
|
|
task doc: 'doc:all'
|
|
|
|
desc 'generate gemspec'
|
|
task 'rack-protection.gemspec' do
|
|
require 'rack/protection/version'
|
|
content = File.binread 'rack-protection.gemspec'
|
|
|
|
# fetch data
|
|
fields = {
|
|
authors: `git shortlog -sn`.force_encoding('utf-8').scan(/[^\d\s].*/),
|
|
email: ['mail@zzak.io', 'konstantin.haase@gmail.com'],
|
|
files: %w[License README.md Rakefile Gemfile rack-protection.gemspec] + Dir['lib/**/*']
|
|
}
|
|
|
|
# insert data
|
|
fields.each do |field, values|
|
|
updated = " s.#{field} = ["
|
|
updated << values.map { |v| "\n %p" % v }.join(',')
|
|
updated << "\n ]"
|
|
content.sub!(/ s\.#{field} = \[\n( .*\n)* \]/, updated)
|
|
end
|
|
|
|
# set version
|
|
content.sub! /(s\.version.*=\s+).*/, "\\1\"#{Rack::Protection::VERSION}\""
|
|
|
|
# escape unicode
|
|
content.gsub!(/./) { |c| c.bytesize > 1 ? "\\u{#{c.codepoints.first.to_s(16)}}" : c }
|
|
|
|
File.open('rack-protection.gemspec', 'w') { |f| f << content }
|
|
end
|
|
|
|
task gemspec: 'rack-protection.gemspec'
|
|
task default: :spec
|
|
task test: :spec
|