rubocop 0.82.0 → 0.86.0

data/lib/rubocop.rb

@@ -1,74 +1,25 @@
 # frozen_string_literal: true
 
-require 'parser'
 require 'rainbow'
 
 require 'English'
 require 'set'
 require 'forwardable'
+require 'regexp_parser'
 require 'unicode/display_width/no_string_ext'
+require 'rubocop-ast'
+require_relative 'rubocop/ast_aliases'
 
 require_relative 'rubocop/version'
 
 require_relative 'rubocop/core_ext/string'
+require_relative 'rubocop/ext/processed_source'
+
 require_relative 'rubocop/path_util'
 require_relative 'rubocop/file_finder'
 require_relative 'rubocop/platform'
-require_relative 'rubocop/string_util'
 require_relative 'rubocop/name_similarity'
-require_relative 'rubocop/node_pattern'
 require_relative 'rubocop/string_interpreter'
-require_relative 'rubocop/ast/sexp'
-require_relative 'rubocop/ast/node'
-require_relative 'rubocop/ast/node/mixin/method_identifier_predicates'
-require_relative 'rubocop/ast/node/mixin/binary_operator_node'
-require_relative 'rubocop/ast/node/mixin/collection_node'
-require_relative 'rubocop/ast/node/mixin/conditional_node'
-require_relative 'rubocop/ast/node/mixin/hash_element_node'
-require_relative 'rubocop/ast/node/mixin/method_dispatch_node'
-require_relative 'rubocop/ast/node/mixin/modifier_node'
-require_relative 'rubocop/ast/node/mixin/numeric_node'
-require_relative 'rubocop/ast/node/mixin/parameterized_node'
-require_relative 'rubocop/ast/node/mixin/predicate_operator_node'
-require_relative 'rubocop/ast/node/mixin/basic_literal_node'
-require_relative 'rubocop/ast/node/alias_node'
-require_relative 'rubocop/ast/node/and_node'
-require_relative 'rubocop/ast/node/args_node'
-require_relative 'rubocop/ast/node/array_node'
-require_relative 'rubocop/ast/node/block_node'
-require_relative 'rubocop/ast/node/break_node'
-require_relative 'rubocop/ast/node/case_match_node'
-require_relative 'rubocop/ast/node/case_node'
-require_relative 'rubocop/ast/node/class_node'
-require_relative 'rubocop/ast/node/def_node'
-require_relative 'rubocop/ast/node/defined_node'
-require_relative 'rubocop/ast/node/ensure_node'
-require_relative 'rubocop/ast/node/for_node'
-require_relative 'rubocop/ast/node/forward_args_node'
-require_relative 'rubocop/ast/node/float_node'
-require_relative 'rubocop/ast/node/hash_node'
-require_relative 'rubocop/ast/node/if_node'
-require_relative 'rubocop/ast/node/int_node'
-require_relative 'rubocop/ast/node/keyword_splat_node'
-require_relative 'rubocop/ast/node/module_node'
-require_relative 'rubocop/ast/node/or_node'
-require_relative 'rubocop/ast/node/pair_node'
-require_relative 'rubocop/ast/node/range_node'
-require_relative 'rubocop/ast/node/regexp_node'
-require_relative 'rubocop/ast/node/resbody_node'
-require_relative 'rubocop/ast/node/retry_node'
-require_relative 'rubocop/ast/node/return_node'
-require_relative 'rubocop/ast/node/self_class_node'
-require_relative 'rubocop/ast/node/send_node'
-require_relative 'rubocop/ast/node/str_node'
-require_relative 'rubocop/ast/node/super_node'
-require_relative 'rubocop/ast/node/symbol_node'
-require_relative 'rubocop/ast/node/until_node'
-require_relative 'rubocop/ast/node/when_node'
-require_relative 'rubocop/ast/node/while_node'
-require_relative 'rubocop/ast/node/yield_node'
-require_relative 'rubocop/ast/builder'
-require_relative 'rubocop/ast/traversal'
 require_relative 'rubocop/error'
 require_relative 'rubocop/warning'
 
@@ -147,6 +98,7 @@ require_relative 'rubocop/cop/mixin/percent_literal'
 require_relative 'rubocop/cop/mixin/preceding_following_alignment'
 require_relative 'rubocop/cop/mixin/preferred_delimiters'
 require_relative 'rubocop/cop/mixin/rational_literal'
+require_relative 'rubocop/cop/mixin/regexp_literal_help'
 require_relative 'rubocop/cop/mixin/rescue_node'
 require_relative 'rubocop/cop/mixin/safe_assignment'
 require_relative 'rubocop/cop/mixin/space_after_punctuation'
@@ -213,10 +165,11 @@ require_relative 'rubocop/cop/layout/empty_line_after_magic_comment'
 require_relative 'rubocop/cop/layout/empty_line_between_defs'
 require_relative 'rubocop/cop/layout/empty_lines_around_access_modifier'
 require_relative 'rubocop/cop/layout/empty_lines_around_arguments'
+require_relative 'rubocop/cop/layout/empty_lines_around_attribute_accessor'
 require_relative 'rubocop/cop/layout/empty_lines_around_begin_body'
 require_relative 'rubocop/cop/layout/empty_lines_around_block_body'
 require_relative 'rubocop/cop/layout/empty_lines_around_class_body'
-require_relative 'rubocop/cop/layout/empty_lines_around_exception_handling_keywords' # rubocop:disable Layout/LineLength
+require_relative 'rubocop/cop/layout/empty_lines_around_exception_handling_keywords'
 require_relative 'rubocop/cop/layout/empty_lines_around_method_body'
 require_relative 'rubocop/cop/layout/empty_lines_around_module_body'
 require_relative 'rubocop/cop/layout/empty_lines'
@@ -289,8 +242,10 @@ require_relative 'rubocop/cop/lint/assignment_in_condition'
 require_relative 'rubocop/cop/lint/big_decimal_new'
 require_relative 'rubocop/cop/lint/boolean_symbol'
 require_relative 'rubocop/cop/lint/circular_argument_reference'
+require_relative 'rubocop/cop/lint/constant_resolution'
 require_relative 'rubocop/cop/lint/debugger'
 require_relative 'rubocop/cop/lint/deprecated_class_methods'
+require_relative 'rubocop/cop/lint/deprecated_open_ssl_constant'
 require_relative 'rubocop/cop/lint/disjunctive_assignment_in_constructor'
 require_relative 'rubocop/cop/lint/duplicate_case_condition'
 require_relative 'rubocop/cop/lint/duplicate_hash_key'
@@ -315,6 +270,7 @@ require_relative 'rubocop/cop/lint/literal_as_condition'
 require_relative 'rubocop/cop/lint/literal_in_interpolation'
 require_relative 'rubocop/cop/lint/loop'
 require_relative 'rubocop/cop/lint/missing_cop_enable_directive'
+require_relative 'rubocop/cop/lint/mixed_regexp_capture_types'
 require_relative 'rubocop/cop/lint/multiple_comparison'
 require_relative 'rubocop/cop/lint/nested_method_definition'
 require_relative 'rubocop/cop/lint/nested_percent_literal'
@@ -366,6 +322,7 @@ require_relative 'rubocop/cop/lint/useless_else_without_rescue'
 require_relative 'rubocop/cop/lint/useless_setter_call'
 require_relative 'rubocop/cop/lint/void'
 
+require_relative 'rubocop/cop/metrics/utils/iterating_block'
 require_relative 'rubocop/cop/metrics/cyclomatic_complexity'
 # relies on cyclomatic_complexity
 require_relative 'rubocop/cop/metrics/utils/abc_size_calculator'
@@ -468,11 +425,10 @@ require_relative 'rubocop/cop/style/lambda'
 require_relative 'rubocop/cop/style/lambda_call'
 require_relative 'rubocop/cop/style/line_end_concatenation'
 require_relative 'rubocop/cop/style/method_call_without_args_parentheses'
-# rubocop:disable Layout/LineLength
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
+require_relative 'rubocop/cop/style/redundant_fetch_block'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses/require_parentheses'
-# rubocop:enable Layout/LineLength
 require_relative 'rubocop/cop/style/method_called_on_do_end_block'
 require_relative 'rubocop/cop/style/method_def_parentheses'
 require_relative 'rubocop/cop/style/method_missing_super'
@@ -526,6 +482,8 @@ require_relative 'rubocop/cop/style/redundant_freeze'
 require_relative 'rubocop/cop/style/redundant_interpolation'
 require_relative 'rubocop/cop/style/redundant_parentheses'
 require_relative 'rubocop/cop/style/redundant_percent_q'
+require_relative 'rubocop/cop/style/redundant_regexp_character_class'
+require_relative 'rubocop/cop/style/redundant_regexp_escape'
 require_relative 'rubocop/cop/style/redundant_return'
 require_relative 'rubocop/cop/style/redundant_self'
 require_relative 'rubocop/cop/style/redundant_sort'
@@ -542,6 +500,7 @@ require_relative 'rubocop/cop/style/send'
 require_relative 'rubocop/cop/style/signal_exception'
 require_relative 'rubocop/cop/style/single_line_block_params'
 require_relative 'rubocop/cop/style/single_line_methods'
+require_relative 'rubocop/cop/style/slicing_with_range'
 require_relative 'rubocop/cop/style/special_global_vars'
 require_relative 'rubocop/cop/style/stabby_lambda_parentheses'
 require_relative 'rubocop/cop/style/stderr_puts'
@@ -613,10 +572,8 @@ require_relative 'rubocop/config_obsoletion'
 require_relative 'rubocop/config_store'
 require_relative 'rubocop/config_validator'
 require_relative 'rubocop/target_finder'
-require_relative 'rubocop/token'
 require_relative 'rubocop/comment_config'
 require_relative 'rubocop/magic_comment'
-require_relative 'rubocop/processed_source'
 require_relative 'rubocop/result_cache'
 require_relative 'rubocop/runner'
 require_relative 'rubocop/cli'

data/lib/rubocop/ast_aliases.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# These aliases are for compatibility.
+module RuboCop
+  NodePattern = AST::NodePattern
+  ProcessedSource = AST::ProcessedSource
+  Token = AST::Token
+end

data/lib/rubocop/cli.rb

@@ -35,8 +35,8 @@ module RuboCop
       if @options[:init]
         run_command(:init)
       else
-        validate_options_vs_config
         act_on_options
+        validate_options_vs_config
         apply_default_formatter
         execute_runners
       end
@@ -75,7 +75,7 @@ module RuboCop
 
     def validate_options_vs_config
       if @options[:parallel] &&
-         !@config_store.for(Dir.pwd).for_all_cops['UseCache']
+         !@config_store.for_dir(Dir.pwd).for_all_cops['UseCache']
         raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
                                    'execution, so combining with AllCops: ' \
                                    'UseCache: false is not allowed.'
@@ -123,7 +123,7 @@ module RuboCop
         if @options[:auto_gen_config]
           formatter = 'autogenconf'
         else
-          cfg = @config_store.for(Dir.pwd).for_all_cops
+          cfg = @config_store.for_dir(Dir.pwd).for_all_cops
           formatter = cfg['DefaultFormatter'] || 'progress'
         end
         [[formatter, @options[:output_path]]]

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

@@ -25,10 +25,10 @@ module RuboCop
         private
 
         def maybe_run_line_length_cop
-          if !line_length_enabled?(@config_store.for(Dir.pwd))
+          if !line_length_enabled?(@config_store.for_dir(Dir.pwd))
             skip_line_length_cop(PHASE_1_DISABLED)
           elsif !same_max_line_length?(
-            @config_store.for(Dir.pwd), ConfigLoader.default_configuration
+            @config_store.for_dir(Dir.pwd), ConfigLoader.default_configuration
           )
             skip_line_length_cop(PHASE_1_OVERRIDDEN)
           else

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

@@ -27,7 +27,7 @@ module RuboCop
               # RuboCop will start looking for the configuration file in the directory
               # where the inspected file is and continue its way up to the root directory.
               #
-              # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+              # See https://docs.rubocop.org/rubocop/configuration
             DESC
 
             File.open(DOTFILE, 'w') do |f|

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

@@ -42,18 +42,14 @@ module RuboCop
                             selected_cops_of_department(registry, department)
                           end
 
-          if show_all
-            puts "# Department '#{department}' (#{selected_cops.length}):"
-          end
+          puts "# Department '#{department}' (#{selected_cops.length}):" if show_all
 
           print_cop_details(selected_cops)
         end
 
         def print_cop_details(cops)
           cops.each do |cop|
-            if cop.new(@config).support_autocorrect?
-              puts '# Supports --auto-correct'
-            end
+            puts '# Supports --auto-correct' if cop.new(@config).support_autocorrect?
             puts "#{cop.cop_name}:"
             puts config_lines(cop)
             puts

data/lib/rubocop/comment_config.rb

@@ -124,7 +124,7 @@ module RuboCop
     end
 
     def directive_on_comment_line?(comment)
-      comment.text[1..-1].match(COMMENT_DIRECTIVE_REGEXP)
+      comment.text[1..-1].match?(COMMENT_DIRECTIVE_REGEXP)
     end
 
     def each_directive

data/lib/rubocop/config.rb

@@ -152,7 +152,7 @@ module RuboCop
       return true if File.extname(file) == '.gemspec'
 
       file_to_include?(file) do |pattern, relative_path, absolute_path|
-        pattern.to_s =~ /[A-Z]/ &&
+        /[A-Z]/.match?(pattern.to_s) &&
           (match_path?(pattern, relative_path) ||
            match_path?(pattern, absolute_path))
       end
@@ -261,9 +261,13 @@ module RuboCop
 
     def enable_cop?(qualified_cop_name, cop_options)
       department = department_of(qualified_cop_name)
+      cop_enabled = cop_options.fetch('Enabled') do
+        !for_all_cops['DisabledByDefault']
+      end
+      return true if cop_enabled == 'override_department'
       return false if department && department['Enabled'] == false
 
-      cop_options.fetch('Enabled') { !for_all_cops['DisabledByDefault'] }
+      cop_enabled
     end
 
     def department_of(qualified_cop_name)

data/lib/rubocop/config_loader.rb

@@ -36,7 +36,7 @@ module RuboCop
         FileFinder.root_level = nil
       end
 
-      def load_file(file)
+      def load_file(file) # rubocop:disable Metrics/AbcSize
         path = File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
 
         hash = load_yaml_configuration(path)
@@ -46,6 +46,7 @@ module RuboCop
 
         add_missing_namespaces(path, hash)
 
+        resolver.override_department_setting_for_cops({}, hash)
         resolver.resolve_inheritance_from_gems(hash)
         resolver.resolve_inheritance(path, hash, file, debug?)
 
@@ -94,9 +95,7 @@ module RuboCop
         end
 
         merge_with_default(config, config_file).tap do |merged_config|
-          unless possible_new_cops?(config)
-            warn_on_pending_cops(merged_config.pending_cops)
-          end
+          warn_on_pending_cops(merged_config.pending_cops) unless possible_new_cops?(config)
         end
       end
 
@@ -132,12 +131,12 @@ module RuboCop
                      '`false` in your `.rubocop.yml` file:').yellow
 
         pending_cops.each do |cop|
-          warn Rainbow(
-            " - #{cop.name} (#{cop.metadata['VersionAdded']})"
-          ).yellow
+          version = cop.metadata['VersionAdded'] || 'N/A'
+
+          warn Rainbow(" - #{cop.name} (#{version})").yellow
         end
 
-        warn Rainbow('For more information: https://docs.rubocop.org/en/latest/versioning/').yellow
+        warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
       end
 
       # Merges the given configuration with the default one. If
@@ -206,9 +205,7 @@ module RuboCop
       def write_config_file(file_name, file_string, rubocop_yml_contents)
         File.open(file_name, 'w') do |f|
           f.write "inherit_from:#{file_string}\n"
-          if /\S/.match?(rubocop_yml_contents)
-            f.write "\n#{rubocop_yml_contents}"
-          end
+          f.write "\n#{rubocop_yml_contents}" if /\S/.match?(rubocop_yml_contents)
         end
       end
 
@@ -217,15 +214,16 @@ module RuboCop
       end
 
       def load_yaml_configuration(absolute_path)
-        yaml_code = read_file(absolute_path)
+        file_contents = read_file(absolute_path)
+        yaml_code = Dir.chdir(File.dirname(absolute_path)) do
+          ERB.new(file_contents).result
+        end
         check_duplication(yaml_code, absolute_path)
         hash = yaml_safe_load(yaml_code, absolute_path) || {}
 
         puts "configuration from #{absolute_path}" if debug?
 
-        unless hash.is_a?(Hash)
-          raise(TypeError, "Malformed configuration in #{absolute_path}")
-        end
+        raise(TypeError, "Malformed configuration in #{absolute_path}") unless hash.is_a?(Hash)
 
         hash
       end
@@ -241,8 +239,7 @@ module RuboCop
                       "#{smart_path}:#{line1}: " \
                       "`#{value}` is concealed by line #{line2}"
                     else
-                      "#{smart_path}: " \
-                        "`#{value}` is concealed by duplicate"
+                      "#{smart_path}: `#{value}` is concealed by duplicate"
                     end
           warn Rainbow(message).yellow
         end
@@ -263,13 +260,11 @@ module RuboCop
           SafeYAML.load(yaml_code, filename, whitelisted_tags: %w[!ruby/regexp])
         # Ruby 2.6+
         elsif Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0')
-          YAML.safe_load(
-            yaml_code,
-            permitted_classes: [Regexp, Symbol],
-            permitted_symbols: [],
-            aliases: true,
-            filename: filename
-          )
+          YAML.safe_load(yaml_code,
+                         permitted_classes: [Regexp, Symbol],
+                         permitted_symbols: [],
+                         aliases: true,
+                         filename: filename)
         else
           YAML.safe_load(yaml_code, [Regexp, Symbol], [], true, filename)
         end

data/lib/rubocop/config_loader_resolver.rb

@@ -17,10 +17,12 @@ module RuboCop
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def resolve_inheritance(path, hash, file, debug)
       inherited_files = Array(hash['inherit_from'])
       base_configs(path, inherited_files, file)
         .reverse.each_with_index do |base_config, index|
+        override_department_setting_for_cops(base_config, hash)
         base_config.each do |k, v|
           next unless v.is_a?(Hash)
 
@@ -34,6 +36,7 @@ module RuboCop
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def resolve_inheritance_from_gems(hash)
       gems = hash.delete('inherit_gem')
@@ -68,9 +71,7 @@ module RuboCop
         end
       end
 
-      if disabled_by_default
-        config = handle_disabled_by_default(config, default_configuration)
-      end
+      config = handle_disabled_by_default(config, default_configuration) if disabled_by_default
 
       opts = { inherit_mode: config['inherit_mode'] || {},
                unset_nil: unset_nil }
@@ -100,8 +101,30 @@ module RuboCop
     end
     # rubocop:enable Metrics/AbcSize
 
+    # An `Enabled: true` setting in user configuration for a cop overrides an
+    # `Enabled: false` setting for its department.
+    def override_department_setting_for_cops(base_hash, derived_hash)
+      derived_hash.each_key do |key|
+        next unless key =~ %r{(.*)/.*}
+
+        department = Regexp.last_match(1)
+        next unless disabled?(derived_hash, department) ||
+                    disabled?(base_hash, department)
+
+        # The `override_department` setting for the `Enabled` parameter is an
+        # internal setting that's not documented in the manual. It will cause a
+        # cop to be enabled later, when logic surrounding enabled/disabled it
+        # run, even though its department is disabled.
+        derived_hash[key]['Enabled'] = 'override_department' if derived_hash[key]['Enabled']
+      end
+    end
+
     private
 
+    def disabled?(hash, department)
+      hash[department] && hash[department]['Enabled'] == false
+    end
+
     def duplicate_setting?(base_hash, derived_hash, key, inherited_file)
       return false if inherited_file.nil? # Not inheritance resolving merge
       return false if inherited_file.start_with?('..') # Legitimate override
@@ -148,10 +171,20 @@ module RuboCop
 
     def inherited_file(path, inherit_from, file)
       if remote_file?(inherit_from)
+        # A remote configuration, e.g. `inherit_from: http://example.com/rubocop.yml`.
         RemoteConfig.new(inherit_from, File.dirname(path))
+      elsif Pathname.new(inherit_from).absolute?
+        # An absolute path to a config, e.g. `inherit_from: /Users/me/rubocop.yml`.
+        # The path may come from `inherit_gem` option, where a gem name is expanded
+        # to an absolute path to that gem.
+        print 'Inheriting ' if ConfigLoader.debug?
+        inherit_from
       elsif file.is_a?(RemoteConfig)
+        # A path relative to a URL, e.g. `inherit_from: configs/default.yml`
+        # in a config included with `inherit_from: http://example.com/rubocop.yml`
         file.inherit_from_remote(inherit_from, path)
       else
+        # A local relative path, e.g. `inherit_from: default.yml`
         print 'Inheriting ' if ConfigLoader.debug?
         File.expand_path(inherit_from, File.dirname(path))
       end
@@ -159,7 +192,7 @@ module RuboCop
 
     def remote_file?(uri)
       regex = URI::DEFAULT_PARSER.make_regexp(%w[http https])
-      uri =~ /\A#{regex}\z/
+      /\A#{regex}\z/.match?(uri)
     end
 
     def handle_disabled_by_default(config, new_default_configuration)
@@ -185,8 +218,14 @@ module RuboCop
     end
 
     def gem_config_path(gem_name, relative_config_path)
-      spec = Gem::Specification.find_by_name(gem_name)
-      File.join(spec.gem_dir, relative_config_path)
+      if defined?(Bundler)
+        gem = Bundler.load.specs[gem_name].first
+        gem_path = gem.full_gem_path if gem
+      end
+
+      gem_path ||= Gem::Specification.find_by_name(gem_name).gem_dir
+
+      File.join(gem_path, relative_config_path)
     rescue Gem::LoadError => e
       raise Gem::LoadError,
             "Unable to find gem #{gem_name}; is the gem installed? #{e}"