rubocop 0.77.0 → 0.81.0

data/lib/rubocop/ast/traversal.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ModuleLength
 module RuboCop
   module AST
     # Provides methods for traversing an AST.
@@ -18,15 +19,21 @@ module RuboCop
                              rational str sym regopt self lvar
                              ivar cvar gvar nth_ref back_ref cbase
                              arg restarg blockarg shadowarg
-                             kwrestarg zsuper lambda redo retry].freeze
+                             kwrestarg zsuper lambda redo retry
+                             forward_args forwarded_args
+                             match_var match_nil_pattern empty_else].freeze
       ONE_CHILD_NODE    = %i[splat kwsplat block_pass not break next
                              preexe postexe match_current_line defined?
-                             arg_expr].freeze
+                             arg_expr pin match_rest if_guard unless_guard
+                             match_with_trailing_comma].freeze
       MANY_CHILD_NODES  = %i[dstr dsym xstr regexp array hash pair
                              mlhs masgn or_asgn and_asgn
                              undef alias args super yield or and
                              while_post until_post iflipflop eflipflop
-                             match_with_lvasgn begin kwbegin return].freeze
+                             match_with_lvasgn begin kwbegin return
+                             in_match match_alt
+                             match_as array_pattern array_pattern_with_tail
+                             hash_pattern const_pattern].freeze
       SECOND_CHILD_ONLY = %i[lvasgn ivasgn cvasgn gvasgn optarg kwarg
                              kwoptarg].freeze
 
@@ -171,13 +178,25 @@ module RuboCop
         nil
       end
 
-      alias on_rescue  on_case
-      alias on_resbody on_case
-      alias on_ensure  on_case
-      alias on_for     on_case
-      alias on_when    on_case
-      alias on_irange  on_case
-      alias on_erange  on_case
+      alias on_rescue     on_case
+      alias on_resbody    on_case
+      alias on_ensure     on_case
+      alias on_for        on_case
+      alias on_when       on_case
+      alias on_case_match on_case
+      alias on_in_pattern on_case
+      alias on_irange     on_case
+      alias on_erange     on_case
+
+      def on_numblock(node)
+        children = node.children
+        child = children[0]
+        send(:"on_#{child.type}", child)
+        return unless (child = children[2])
+
+        send(:"on_#{child.type}", child)
+      end
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/rubocop/cli/command/auto_genenerate_config.rb

@@ -7,13 +7,13 @@ module RuboCop
       class AutoGenerateConfig < Base
         self.command_name = :auto_gen_config
 
-        PHASE_1 = 'Phase 1 of 2: run Metrics/LineLength cop'
+        PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
         PHASE_2 = 'Phase 2 of 2: run all cops'
 
         PHASE_1_OVERRIDDEN =
-          '(skipped because the default Metrics/LineLength:Max is overridden)'
+          '(skipped because the default Layout/LineLength:Max is overridden)'
         PHASE_1_DISABLED =
-          '(skipped because Metrics/LineLength is disabled)'
+          '(skipped because Layout/LineLength is disabled)'
 
         def run
           add_formatter
@@ -54,15 +54,15 @@ module RuboCop
         end
 
         def line_length_cop(config)
-          config.for_cop('Metrics/LineLength')
+          config.for_cop('Layout/LineLength')
         end
 
-        # Do an initial run with only Metrics/LineLength so that cops that
-        # depend on Metrics/LineLength:Max get the correct value for that
+        # Do an initial run with only Layout/LineLength so that cops that
+        # depend on Layout/LineLength:Max get the correct value for that
         # parameter.
         def run_line_length_cop
           puts Rainbow(PHASE_1).yellow
-          @options[:only] = ['Metrics/LineLength']
+          @options[:only] = ['Layout/LineLength']
           execute_runner
           @options.delete(:only)
           @config_store = ConfigStore.new

data/lib/rubocop/cli/command/show_cops.rb

@@ -8,6 +8,13 @@ module RuboCop
       class ShowCops < Base
         self.command_name = :show_cops
 
+        def initialize(env)
+          super
+
+          # Load the configs so the require()s are done for custom cops
+          @config = @config_store.for(Dir.pwd)
+        end
+
         def run
           print_available_cops
         end
@@ -15,8 +22,6 @@ module RuboCop
         private
 
         def print_available_cops
-          # Load the configs so the require()s are done for custom cops
-          @config_store.for(Dir.pwd)
           registry = Cop::Cop.registry
           show_all = @options[:show_cops].empty?
 
@@ -46,7 +51,9 @@ module RuboCop
 
         def print_cop_details(cops)
           cops.each do |cop|
-            puts '# Supports --auto-correct' if cop.new.support_autocorrect?
+            if cop.new(@config).support_autocorrect?
+              puts '# Supports --auto-correct'
+            end
             puts "#{cop.cop_name}:"
             puts config_lines(cop)
             puts
@@ -64,7 +71,7 @@ module RuboCop
         end
 
         def config_lines(cop)
-          cnf = @config_store.for(Dir.pwd).for_cop(cop)
+          cnf = @config.for_cop(cop)
           cnf.to_yaml.lines.to_a.drop(1).map { |line| '  ' + line }
         end
       end

data/lib/rubocop/comment_config.rb

@@ -113,7 +113,8 @@ module RuboCop
     def each_mentioned_cop
       each_directive do |comment, cop_names, disabled|
         comment_line_number = comment.loc.expression.line
-        single_line = !comment_only_line?(comment_line_number)
+        single_line = !comment_only_line?(comment_line_number) ||
+                      directive_on_comment_line?(comment)
 
         cop_names.each do |cop_name|
           yield qualified_cop_name(cop_name), disabled, comment_line_number,
@@ -122,6 +123,10 @@ module RuboCop
       end
     end
 
+    def directive_on_comment_line?(comment)
+      comment.text[1..-1].match(COMMENT_DIRECTIVE_REGEXP)
+    end
+
     def each_directive
       return if processed_source.comments.nil?
 

data/lib/rubocop/config.rb

@@ -2,6 +2,9 @@
 
 require 'pathname'
 
+# FIXME: Moving Rails department code to RuboCop Rails will remove
+# the following rubocop:disable comment.
+# rubocop:disable Metrics/ClassLength
 module RuboCop
   # This class represents the configuration of the RuboCop application
   # and all its cops. A Config is associated with a YAML configuration
@@ -13,6 +16,8 @@ module RuboCop
     include FileFinder
     extend Forwardable
 
+    CopConfig = Struct.new(:name, :metadata)
+
     DEFAULT_RAILS_VERSION = 5.0
     attr_reader :loaded_path
 
@@ -115,7 +120,7 @@ module RuboCop
       relative_file_path = path_relative_to_config(file)
 
       # Optimization to quickly decide if the given file is hidden (on the top
-      # level) and can not be matched by any pattern.
+      # level) and cannot be matched by any pattern.
       is_hidden = relative_file_path.start_with?('.') &&
                   !relative_file_path.start_with?('..')
       return false if is_hidden && !possibly_include_hidden?
@@ -215,6 +220,18 @@ module RuboCop
       nil
     end
 
+    def pending_cops
+      keys.each_with_object([]) do |qualified_cop_name, pending_cops|
+        department = department_of(qualified_cop_name)
+        next if department && department['Enabled'] == false
+
+        cop_metadata = self[qualified_cop_name]
+        next unless cop_metadata['Enabled'] == 'pending'
+
+        pending_cops << CopConfig.new(qualified_cop_name, cop_metadata)
+      end
+    end
+
     private
 
     def target_rails_version_from_bundler_lock_file
@@ -235,17 +252,18 @@ module RuboCop
     end
 
     def enable_cop?(qualified_cop_name, cop_options)
-      cop_department, cop_name = qualified_cop_name.split('/')
-      department = cop_name.nil?
-
-      unless department
-        department_options = self[cop_department]
-        if department_options && department_options['Enabled'] == false
-          return false
-        end
-      end
+      department = department_of(qualified_cop_name)
+      return false if department && department['Enabled'] == false
 
       cop_options.fetch('Enabled') { !for_all_cops['DisabledByDefault'] }
     end
+
+    def department_of(qualified_cop_name)
+      cop_department, cop_name = qualified_cop_name.split('/')
+      return nil if cop_name.nil?
+
+      self[cop_department]
+    end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/rubocop/config_loader.rb

@@ -91,7 +91,9 @@ module RuboCop
         else
           add_excludes_from_files(config, config_file)
         end
-        merge_with_default(config, config_file)
+        merge_with_default(config, config_file).tap do |merged_config|
+          warn_on_pending_cops(merged_config.pending_cops)
+        end
       end
 
       def add_excludes_from_files(config, config_file)
@@ -114,6 +116,22 @@ module RuboCop
                                    end
       end
 
+      def warn_on_pending_cops(pending_cops)
+        return if pending_cops.empty?
+
+        warn Rainbow('The following cops were added to RuboCop, but are not ' \
+                     'configured. Please set Enabled to either `true` or ' \
+                     '`false` in your `.rubocop.yml` file:').yellow
+
+        pending_cops.each do |cop|
+          warn Rainbow(
+            " - #{cop.name} (#{cop.metadata['VersionAdded']})"
+          ).yellow
+        end
+
+        warn Rainbow('For more information: https://docs.rubocop.org/en/latest/versioning/').yellow
+      end
+
       # Merges the given configuration with the default one. If
       # AllCops:DisabledByDefault is true, it changes the Enabled params so
       # that only cops from user configuration are enabled.
@@ -199,8 +217,6 @@ module RuboCop
           raise(TypeError, "Malformed configuration in #{absolute_path}")
         end
 
-        check_cop_config_value(hash)
-
         hash
       end
 
@@ -222,22 +238,6 @@ module RuboCop
         end
       end
 
-      def check_cop_config_value(hash, parent = nil)
-        hash.each do |key, value|
-          check_cop_config_value(value, key) if value.is_a?(Hash)
-
-          next unless %w[Enabled
-                         Safe
-                         SafeAutoCorrect
-                         AutoCorrect].include?(key) && value.is_a?(String)
-
-          abort(
-            "Property #{Rainbow(key).yellow} of cop #{Rainbow(parent).yellow}" \
-            " is supposed to be a boolean and #{Rainbow(value).yellow} is not."
-          )
-        end
-      end
-
       # Read the specified file, or exit with a friendly, concise message on
       # stderr. Care is taken to use the standard OS exit code for a "file not
       # found" error.

data/lib/rubocop/config_obsoletion.rb

@@ -19,6 +19,7 @@ module RuboCop
       'Layout/LeadingBlankLines' => 'Layout/LeadingEmptyLines',
       'Layout/TrailingBlankLines' => 'Layout/TrailingEmptyLines',
       'Lint/DuplicatedKey' => 'Lint/DuplicateHashKey',
+      'Lint/EndInMethod' => 'Style/EndBlock',
       'Lint/HandleExceptions' => 'Lint/SuppressedException',
       'Lint/MultipleCompare' => 'Lint/MultipleComparison',
       'Lint/StringConversionInInterpolation' => 'Lint/RedundantStringCoercion',
@@ -48,7 +49,7 @@ module RuboCop
                      Style/VariableName Style/VariableNumber
                      Style/AccessorMethodName Style/AsciiIdentifiers],
       'Layout' => %w[Lint/BlockAlignment Lint/EndAlignment
-                     Lint/DefEndAlignment],
+                     Lint/DefEndAlignment Metrics/LineLength],
       'Lint' => 'Style/FlipFlop'
     }.map do |new_department, old_names|
       Array(old_names).map do |old_name|
@@ -69,7 +70,8 @@ module RuboCop
                                'Style/TrailingCommaInHashLiteral',
       'Style/TrailingCommaInLiteral' => 'Style/TrailingCommaInArrayLiteral ' \
                                         'and/or ' \
-                                        'Style/TrailingCommaInHashLiteral'
+                                        'Style/TrailingCommaInHashLiteral',
+      'Style/BracesAroundHashParameters' => nil
     }.map do |old_name, other_cops|
       if other_cops
         more = ". Please use #{other_cops} instead".gsub(%r{[A-Z]\w+/\w+},
@@ -114,13 +116,13 @@ module RuboCop
         cops: 'Style/IfUnlessModifier',
         parameters: 'MaxLineLength',
         alternative: '`Style/IfUnlessModifier: MaxLineLength` has been ' \
-                     'removed. Use `Metrics/LineLength: Max` instead'
+                     'removed. Use `Layout/LineLength: Max` instead'
       },
       {
         cops: 'Style/WhileUntilModifier',
         parameters: 'MaxLineLength',
         alternative: '`Style/WhileUntilModifier: MaxLineLength` has been ' \
-                     'removed. Use `Metrics/LineLength: Max` instead'
+                     'removed. Use `Layout/LineLength: Max` instead'
       },
       {
         cops: 'AllCops',

data/lib/rubocop/config_validator.rb

@@ -14,25 +14,19 @@ module RuboCop
                          VersionAdded VersionChanged VersionRemoved
                          Reference Safe SafeAutoCorrect].freeze
 
-    # 2.3 is the oldest officially supported Ruby version.
-    DEFAULT_RUBY_VERSION = 2.3
-    KNOWN_RUBIES = [2.3, 2.4, 2.5, 2.6, 2.7].freeze
-    OBSOLETE_RUBIES = {
-      1.9 => '0.50', 2.0 => '0.50', 2.1 => '0.58', 2.2 => '0.69'
-    }.freeze
-    RUBY_VERSION_FILENAME = '.ruby-version'
-
-    def_delegators :@config,
-                   :smart_loaded_path, :for_all_cops, :find_file_upwards,
-                   :base_dir_for_path_parameters, :bundler_lock_file_path
+    def_delegators :@config, :smart_loaded_path, :for_all_cops
 
     def initialize(config)
       @config = config
       @config_obsoletion = ConfigObsoletion.new(config)
+      @target_ruby = TargetRuby.new(config)
     end
 
     def validate
-      # Don't validate RuboCop's own files. Avoids infinite recursion.
+      check_cop_config_value(@config)
+      reject_conflicting_safe_settings
+
+      # Don't validate RuboCop's own files further. Avoids infinite recursion.
       return if @config.internal?
 
       valid_cop_names, invalid_cop_names = @config.keys.partition do |key|
@@ -41,7 +35,7 @@ module RuboCop
 
       @config_obsoletion.reject_obsolete_cops_and_parameters
 
-      warn_about_unrecognized_cops(invalid_cop_names)
+      alert_about_unrecognized_cops(invalid_cop_names)
       check_target_ruby
       validate_parameter_names(valid_cop_names)
       validate_enforced_styles(valid_cop_names)
@@ -50,23 +44,7 @@ module RuboCop
     end
 
     def target_ruby_version
-      @target_ruby_version ||= begin
-        if for_all_cops['TargetRubyVersion']
-          @target_ruby_version_source = :rubocop_yml
-
-          for_all_cops['TargetRubyVersion'].to_f
-        elsif target_ruby_version_from_version_file
-          @target_ruby_version_source = :ruby_version_file
-
-          target_ruby_version_from_version_file
-        elsif target_ruby_version_from_bundler_lock_file
-          @target_ruby_version_source = :bundler_lock_file
-
-          target_ruby_version_from_bundler_lock_file
-        else
-          DEFAULT_RUBY_VERSION
-        end
-      end
+      target_ruby.version
     end
 
     def validate_section_presence(name)
@@ -78,25 +56,30 @@ module RuboCop
 
     private
 
+    attr_reader :target_ruby
+
     def check_target_ruby
-      return if KNOWN_RUBIES.include?(target_ruby_version)
+      return if target_ruby.supported?
 
-      msg = if OBSOLETE_RUBIES.include?(target_ruby_version)
+      source = target_ruby.source
+      last_version = target_ruby.rubocop_version_with_support
+
+      msg = if last_version
               "RuboCop found unsupported Ruby version #{target_ruby_version} " \
-              "in #{target_ruby_source}. #{target_ruby_version}-compatible " \
-              'analysis was dropped after version ' \
-              "#{OBSOLETE_RUBIES[target_ruby_version]}."
+              "in #{source}. #{target_ruby_version}-compatible " \
+              "analysis was dropped after version #{last_version}."
             else
               'RuboCop found unknown Ruby version ' \
-              "#{target_ruby_version.inspect} in #{target_ruby_source}."
+              "#{target_ruby_version.inspect} in #{source}."
             end
 
-      msg += "\nSupported versions: #{KNOWN_RUBIES.join(', ')}"
+      msg += "\nSupported versions: #{TargetRuby.supported_versions.join(', ')}"
 
       raise ValidationError, msg
     end
 
-    def warn_about_unrecognized_cops(invalid_cop_names)
+    def alert_about_unrecognized_cops(invalid_cop_names)
+      unknown_cops = []
       invalid_cop_names.each do |name|
         # There could be a custom cop with this name. If so, don't warn
         next if Cop::Cop.registry.contains_cop_matching?([name])
@@ -106,9 +89,10 @@ module RuboCop
         # to do so than to pass the value around to various methods.
         next if name == 'inherit_mode'
 
-        warn Rainbow("Warning: unrecognized cop #{name} found in " \
-                     "#{smart_loaded_path}").yellow
+        unknown_cops << "unrecognized cop #{name} found in " \
+          "#{smart_loaded_path}"
       end
+      raise ValidationError, unknown_cops.join(', ') if unknown_cops.any?
     end
 
     def validate_syntax_cop
@@ -176,71 +160,47 @@ module RuboCop
         formats.all? { |format| valid.include?(format) }
     end
 
-    def target_ruby_source
-      case @target_ruby_version_source
-      when :ruby_version_file
-        "`#{RUBY_VERSION_FILENAME}`"
-      when :bundler_lock_file
-        "`#{bundler_lock_file_path}`"
-      when :rubocop_yml
-        "`TargetRubyVersion` parameter (in #{smart_loaded_path})"
-      end
-    end
+    def reject_mutually_exclusive_defaults
+      disabled_by_default = for_all_cops['DisabledByDefault']
+      enabled_by_default = for_all_cops['EnabledByDefault']
+      return unless disabled_by_default && enabled_by_default
 
-    def ruby_version_file
-      @ruby_version_file ||=
-        find_file_upwards(RUBY_VERSION_FILENAME, base_dir_for_path_parameters)
+      msg = 'Cops cannot be both enabled by default and disabled by default'
+      raise ValidationError, msg
     end
 
-    def target_ruby_version_from_version_file
-      file = ruby_version_file
-      return unless file && File.file?(file)
+    def reject_conflicting_safe_settings
+      @config.each do |name, cop_config|
+        next unless cop_config.is_a?(Hash)
+        next unless cop_config['Safe'] == false &&
+                    cop_config['SafeAutoCorrect'] == true
 
-      @target_ruby_version_from_version_file ||=
-        File.read(file).match(/\A(ruby-)?(?<version>\d+\.\d+)/) do |md|
-          md[:version].to_f
-        end
+        msg = 'Unsafe cops cannot have a safe auto-correction ' \
+              "(section #{name} in #{smart_loaded_path})"
+        raise ValidationError, msg
+      end
     end
 
-    def target_ruby_version_from_bundler_lock_file
-      @target_ruby_version_from_bundler_lock_file ||=
-        read_ruby_version_from_bundler_lock_file
-    end
+    def check_cop_config_value(hash, parent = nil)
+      hash.each do |key, value|
+        check_cop_config_value(value, key) if value.is_a?(Hash)
+
+        next unless %w[Enabled
+                       Safe
+                       SafeAutoCorrect
+                       AutoCorrect].include?(key) && value.is_a?(String)
+
+        next if key == 'Enabled' && value == 'pending'
 
-    def read_ruby_version_from_bundler_lock_file
-      lock_file_path = bundler_lock_file_path
-      return nil unless lock_file_path
-
-      in_ruby_section = false
-      File.foreach(lock_file_path) do |line|
-        # If ruby is in Gemfile.lock or gems.lock, there should be two lines
-        # towards the bottom of the file that look like:
-        #     RUBY VERSION
-        #       ruby W.X.YpZ
-        # We ultimately want to match the "ruby W.X.Y.pZ" line, but there's
-        # extra logic to make sure we only start looking once we've seen the
-        # "RUBY VERSION" line.
-        in_ruby_section ||= line.match(/^\s*RUBY\s*VERSION\s*$/)
-        next unless in_ruby_section
-
-        # We currently only allow this feature to work with MRI ruby. If jruby
-        # (or something else) is used by the project, it's lock file will have a
-        # line that looks like:
-        #     RUBY VERSION
-        #       ruby W.X.YpZ (jruby x.x.x.x)
-        # The regex won't match in this situation.
-        result = line.match(/^\s*ruby\s+(\d+\.\d+)[p.\d]*\s*$/)
-        return result.captures.first.to_f if result
+        raise ValidationError, msg_not_boolean(parent, key, value)
       end
     end
 
-    def reject_mutually_exclusive_defaults
-      disabled_by_default = for_all_cops['DisabledByDefault']
-      enabled_by_default = for_all_cops['EnabledByDefault']
-      return unless disabled_by_default && enabled_by_default
-
-      msg = 'Cops cannot be both enabled by default and disabled by default'
-      raise ValidationError, msg
+    # FIXME: Handling colors in exception messages like this is ugly.
+    def msg_not_boolean(parent, key, value)
+      "#{Rainbow('').reset}" \
+        "Property #{Rainbow(key).yellow} of cop #{Rainbow(parent).yellow}" \
+        " is supposed to be a boolean and #{Rainbow(value).yellow} is not."
     end
   end
 end