rubocop 0.81.0 → 0.85.1

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'
@@ -235,6 +188,7 @@ require_relative 'rubocop/cop/layout/hash_alignment'
 require_relative 'rubocop/cop/layout/heredoc_argument_closing_parenthesis'
 require_relative 'rubocop/cop/layout/heredoc_indentation'
 require_relative 'rubocop/cop/layout/indentation_consistency'
+require_relative 'rubocop/cop/layout/indentation_style'
 require_relative 'rubocop/cop/layout/indentation_width'
 require_relative 'rubocop/cop/layout/initial_indentation'
 require_relative 'rubocop/cop/layout/leading_comment_space'
@@ -261,6 +215,7 @@ require_relative 'rubocop/cop/layout/space_after_semicolon'
 require_relative 'rubocop/cop/layout/space_around_block_parameters'
 require_relative 'rubocop/cop/layout/space_around_equals_in_parameter_default'
 require_relative 'rubocop/cop/layout/space_around_keyword'
+require_relative 'rubocop/cop/layout/space_around_method_call_operator'
 require_relative 'rubocop/cop/layout/space_around_operators'
 require_relative 'rubocop/cop/layout/space_before_block_braces'
 require_relative 'rubocop/cop/layout/space_before_comma'
@@ -277,7 +232,6 @@ require_relative 'rubocop/cop/layout/space_inside_percent_literal_delimiters'
 require_relative 'rubocop/cop/layout/space_inside_range_literal'
 require_relative 'rubocop/cop/layout/space_inside_reference_brackets'
 require_relative 'rubocop/cop/layout/space_inside_string_interpolation'
-require_relative 'rubocop/cop/layout/tab'
 require_relative 'rubocop/cop/layout/trailing_empty_lines'
 require_relative 'rubocop/cop/layout/trailing_whitespace'
 
@@ -290,6 +244,7 @@ require_relative 'rubocop/cop/lint/boolean_symbol'
 require_relative 'rubocop/cop/lint/circular_argument_reference'
 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'
@@ -314,6 +269,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'
@@ -423,6 +379,7 @@ require_relative 'rubocop/cop/style/copyright'
 require_relative 'rubocop/cop/style/date_time'
 require_relative 'rubocop/cop/style/def_with_parentheses'
 require_relative 'rubocop/cop/style/dir'
+require_relative 'rubocop/cop/style/disable_cops_within_source_code_directive'
 require_relative 'rubocop/cop/style/documentation_method'
 require_relative 'rubocop/cop/style/documentation'
 require_relative 'rubocop/cop/style/double_cop_disable_directive'
@@ -440,6 +397,7 @@ require_relative 'rubocop/cop/style/end_block'
 require_relative 'rubocop/cop/style/eval_with_location'
 require_relative 'rubocop/cop/style/even_odd'
 require_relative 'rubocop/cop/style/expand_path_arguments'
+require_relative 'rubocop/cop/style/exponential_notation'
 require_relative 'rubocop/cop/style/float_division'
 require_relative 'rubocop/cop/style/for'
 require_relative 'rubocop/cop/style/format_string'
@@ -465,11 +423,9 @@ 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/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'
@@ -523,6 +479,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'
@@ -539,6 +497,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'
@@ -585,7 +544,6 @@ require_relative 'rubocop/formatter/simple_text_formatter'
 # relies on simple text
 require_relative 'rubocop/formatter/clang_style_formatter'
 require_relative 'rubocop/formatter/disabled_config_formatter'
-require_relative 'rubocop/formatter/disabled_lines_formatter'
 require_relative 'rubocop/formatter/emacs_style_formatter'
 require_relative 'rubocop/formatter/file_list_formatter'
 require_relative 'rubocop/formatter/fuubar_style_formatter'
@@ -611,10 +569,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.'
@@ -83,10 +83,7 @@ module RuboCop
     end
 
     def act_on_options
-      ConfigLoader.debug = @options[:debug]
-      ConfigLoader.auto_gen_config = @options[:auto_gen_config]
-      ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
-      ConfigLoader.options_config = @options[:config]
+      set_options_to_config_loader
 
       @config_store.options_config = @options[:config] if @options[:config]
       @config_store.force_default_config! if @options[:force_default_config]
@@ -102,6 +99,15 @@ module RuboCop
       end
     end
 
+    def set_options_to_config_loader
+      ConfigLoader.debug = @options[:debug]
+      ConfigLoader.auto_gen_config = @options[:auto_gen_config]
+      ConfigLoader.disable_pending_cops = @options[:disable_pending_cops]
+      ConfigLoader.enable_pending_cops = @options[:enable_pending_cops]
+      ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
+      ConfigLoader.options_config = @options[:config]
+    end
+
     def handle_exiting_options
       return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }
 
@@ -117,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/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

@@ -47,7 +47,7 @@ module RuboCop
     end
 
     def_delegators :@hash, :[], :[]=, :delete, :each, :key?, :keys, :each_key,
-                   :map, :merge, :to_h, :to_hash
+                   :map, :merge, :to_h, :to_hash, :transform_values
     def_delegators :@validator, :validate, :target_ruby_version
 
     def to_s
@@ -116,6 +116,14 @@ module RuboCop
       @for_all_cops ||= self['AllCops'] || {}
     end
 
+    def disabled_new_cops?
+      for_all_cops['NewCops'] == 'disable'
+    end
+
+    def enabled_new_cops?
+      for_all_cops['NewCops'] == 'enable'
+    end
+
     def file_to_include?(file)
       relative_file_path = path_relative_to_config(file)
 
@@ -253,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

@@ -24,7 +24,7 @@ module RuboCop
       include FileFinder
 
       attr_accessor :debug, :auto_gen_config, :ignore_parent_exclusion,
-                    :options_config
+                    :options_config, :disable_pending_cops, :enable_pending_cops
       attr_writer :default_configuration
 
       alias debug? debug
@@ -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?)
 
@@ -55,7 +56,10 @@ module RuboCop
       end
 
       def add_missing_namespaces(path, hash)
-        hash.keys.each do |key|
+        # Using `hash.each_key` will cause the
+        # `can't add a new key into hash during iteration` error
+        hash_keys = hash.keys
+        hash_keys.each do |key|
           q = Cop::Cop.qualified_cop_name(key, path)
           next if q == key
 
@@ -76,30 +80,33 @@ module RuboCop
       # user's home directory is checked. If there's no .rubocop.yml
       # there either, the path to the default file is returned.
       def configuration_file_for(target_dir)
-        find_project_dotfile(target_dir) ||
-          find_user_dotfile ||
-          find_user_xdg_config ||
-          DEFAULT_FILE
+        find_project_dotfile(target_dir) || find_user_dotfile ||
+          find_user_xdg_config || DEFAULT_FILE
       end
 
       def configuration_from_file(config_file)
-        config = load_file(config_file)
-        return config if config_file == DEFAULT_FILE
+        return ConfigLoader.default_configuration if config_file == DEFAULT_FILE
 
+        config = load_file(config_file)
         if ignore_parent_exclusion?
           print 'Ignoring AllCops/Exclude from parent folders' if debug?
         else
           add_excludes_from_files(config, config_file)
         end
+
         merge_with_default(config, config_file).tap do |merged_config|
-          warn_on_pending_cops(merged_config.pending_cops)
+          warn_on_pending_cops(merged_config.pending_cops) unless possible_new_cops?(config)
         end
       end
 
+      def possible_new_cops?(config)
+        disable_pending_cops || enable_pending_cops ||
+          config.disabled_new_cops? || config.enabled_new_cops?
+      end
+
       def add_excludes_from_files(config, config_file)
-        found_files =
-          find_files_upwards(DOTFILE, config_file) +
-          [find_user_dotfile, find_user_xdg_config].compact
+        found_files = find_files_upwards(DOTFILE, config_file) +
+                      [find_user_dotfile, find_user_xdg_config].compact
 
         return if found_files.empty?
         return if PathUtil.relative_path(found_files.last) ==
@@ -124,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
@@ -198,7 +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"
-          f.write "\n#{rubocop_yml_contents}" if rubocop_yml_contents =~ /\S/
+          f.write "\n#{rubocop_yml_contents}" if /\S/.match?(rubocop_yml_contents)
         end
       end
 
@@ -207,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
@@ -231,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
@@ -250,17 +257,14 @@ module RuboCop
 
       def yaml_safe_load(yaml_code, filename)
         if defined?(SafeYAML) && SafeYAML.respond_to?(:load)
-          SafeYAML.load(yaml_code, filename,
-                        whitelisted_tags: %w[!ruby/regexp])
+          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