Merge pull request #790 from deivid-rodriguez/bump-rubocop

Upgrade RuboCop, fix config and offenses, and run it in CI

Author: rafaelfranca

.github/workflows/lint.yml

@@ -0,0 +1,14 @@
+name: Run linters
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: lint_gems.rb
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rubocop

.gitignore

@@ -21,6 +21,7 @@
 .yardoc
 Desktop.ini
 Gemfile.lock
+lint_gems.rb.lock
 Icon?
 InstalledFiles
 Session.vim

.rubocop.yml

@@ -6,49 +6,50 @@ AllCops:
   Exclude:
     - spec/sandbox/**/*
     - spec/fixtures/**/*
+    - vendor/bundle/**/**
 
 # Enforce Ruby 1.8-compatible hash syntax
-HashSyntax:
+Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
 # No spaces inside hash literals
-SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
 # Enforce outdenting of access modifiers (i.e. public, private, protected)
-AccessModifierIndentation:
+Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
-EmptyLinesAroundAccessModifier:
+Layout/EmptyLinesAroundAccessModifier:
   Enabled: true
 
 # Align ends correctly
-EndAlignment:
+Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
+  Exclude:
+    - 'lib/thor/actions.rb'
+    - 'lib/thor/error.rb'
+    - 'lib/thor/shell/basic.rb'
+    - 'lib/thor/parser/option.rb'
 
 # Indentation of when/else
-CaseIndentation:
+Layout/CaseIndentation:
   EnforcedStyle: end
   IndentOneStep: false
 
-StringLiterals:
+Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 Lint/AssignmentInCondition:
   Exclude:
     - 'lib/thor/line_editor/readline.rb'
     - 'lib/thor/parser/arguments.rb'
 
-Lint/EndAlignment:
-  Exclude:
-    - 'lib/thor/actions.rb'
-    - 'lib/thor/parser/option.rb'
-
 Security/Eval:
   Exclude:
     - 'spec/helper.rb'
 
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Exclude:
     - 'lib/thor/line_editor/readline.rb'
 
@@ -99,10 +100,15 @@ Style/GlobalVars:
     - 'spec/register_spec.rb'
     - 'spec/thor_spec.rb'
 
-Layout/IndentArray:
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
-Style/MethodMissing:
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/thor/error.rb'
+    - 'spec/rake_compat_spec.rb'
+
+Style/MissingRespondToMissing:
   Exclude:
     - 'lib/thor/core_ext/hash_with_indifferent_access.rb'
     - 'lib/thor/runner.rb'

.rubocop_todo.yml

@@ -25,14 +25,6 @@ Layout/SpaceInsideHashLiteralBraces:
     - 'spec/actions_spec.rb'
     - 'spec/command_spec.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleAlignWith, SupportedStylesAlignWith, AutoCorrect.
-# SupportedStylesAlignWith: keyword, variable, start_of_line
-Lint/EndAlignment:
-  Exclude:
-    - 'lib/thor/error.rb'
-
 # Offense count: 65
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.

Gemfile

@@ -9,10 +9,9 @@ end
 
 group :test do
   gem "childlabor"
-  gem 'coveralls_reborn', '~> 0.23.1', require: false if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
+  gem 'coveralls_reborn', '~> 0.23.1', :require => false if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6.0")
   gem "rspec", ">= 3.2"
   gem "rspec-mocks", ">= 3"
-  gem "rubocop", "~> 0.50.0"
   gem "simplecov", ">= 0.13"
   gem "webmock"
 end

lib/thor.rb

@@ -356,7 +356,7 @@ def disable_required_check #:nodoc:
     end
 
     # The method responsible for dispatching given the args.
-    def dispatch(meth, given_args, given_opts, config) #:nodoc: # rubocop:disable MethodLength
+    def dispatch(meth, given_args, given_opts, config) #:nodoc:
       meth ||= retrieve_command_name(given_args)
       command = all_commands[normalize_command_name(meth)]
 

lib/thor/base.rb

@@ -610,7 +610,7 @@ def build_options(options, scope) #:nodoc:
       def find_and_refresh_command(name) #:nodoc:
         if commands[name.to_s]
           commands[name.to_s]
-        elsif command = all_commands[name.to_s] # rubocop:disable AssignmentInCondition
+        elsif command = all_commands[name.to_s] # rubocop:disable Lint/AssignmentInCondition
           commands[name.to_s] = command.clone
         else
           raise ArgumentError, "You supplied :for => #{name.inspect}, but the command #{name.inspect} could not be found."

lib/thor/group.rb

@@ -169,7 +169,7 @@ def class_options_help(shell, groups = {}) #:nodoc:
     # options are added to group_options hash. Options that already exists
     # in base_options are not added twice.
     #
-    def get_options_from_invocations(group_options, base_options) #:nodoc: # rubocop:disable MethodLength
+    def get_options_from_invocations(group_options, base_options) #:nodoc:
       invocations.each do |name, from_option|
         value = if from_option
           option = class_options[name]

lib/thor/parser/arguments.rb

@@ -1,5 +1,5 @@
 class Thor
-  class Arguments #:nodoc: # rubocop:disable ClassLength
+  class Arguments #:nodoc:
     NUMERIC = /[-+]?(\d*\.\d+|\d+)/
 
     # Receives an array of args and returns two arrays, one with arguments

lib/thor/parser/option.rb

@@ -58,7 +58,7 @@ def self.parse(key, value)
         default = nil
         if VALID_TYPES.include?(value)
           value
-        elsif required = (value == :required) # rubocop:disable AssignmentInCondition
+        elsif required = (value == :required) # rubocop:disable Lint/AssignmentInCondition
           :string
         end
       when TrueClass, FalseClass