rubocop 1.26.1 → 1.32.0

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

@@ -89,7 +89,7 @@ module RuboCop
           # See: https://github.com/rubocop/rubocop/issues/8673
           return if INTEGRATION_FORMATTERS.include?(@options[:format])
 
-          return unless @options[:stdin] && @options[:auto_correct]
+          return unless @options[:stdin] && @options[:autocorrect]
 
           (@options[:stderr] ? $stderr : $stdout).puts '=' * 20
           print @options[:stdin]

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

@@ -47,7 +47,7 @@ module RuboCop
 
         def print_cop_details(cops)
           cops.each do |cop|
-            puts '# Supports --auto-correct' if cop.support_autocorrect?
+            puts '# Supports --autocorrect' if cop.support_autocorrect?
             puts "#{cop.cop_name}:"
             puts config_lines(cop)
             puts

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

@@ -18,7 +18,7 @@ module RuboCop
           return if skip? || extensions.none?
 
           puts
-          puts 'Tip: Based on detected gems, the following '\
+          puts 'Tip: Based on detected gems, the following ' \
                'RuboCop extension libraries might be helpful:'
 
           extensions.sort.each do |extension|
@@ -26,8 +26,8 @@ module RuboCop
           end
 
           puts
-          puts 'You can opt out of this message by adding the following to your config '\
-               '(see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions '\
+          puts 'You can opt out of this message by adding the following to your config ' \
+               '(see https://docs.rubocop.org/rubocop/extensions.html#extension-suggestions ' \
                'for more options):'
           puts '  AllCops:'
           puts '    SuggestExtensions: false'
@@ -42,7 +42,7 @@ module RuboCop
           # 1. On CI
           # 2. When given RuboCop options that it doesn't make sense for
           # 3. For all formatters except specified in `INCLUDED_FORMATTERS'`
-          ENV['CI'] ||
+          ENV.fetch('CI', nil) ||
             @options[:only] || @options[:debug] || @options[:list_target_files] ||
             @options[:out] || @options[:stdin] ||
             !INCLUDED_FORMATTERS.include?(current_formatter)

data/lib/rubocop/cli.rb

@@ -12,6 +12,7 @@ module RuboCop
       color debug display_style_guide display_time display_only_fail_level_offenses
       display_only_failed except extra_details fail_level fix_layout format
       ignore_disable_comments lint only only_guide_cops require safe
+      autocorrect safe_autocorrect autocorrect_all
     ].freeze
 
     class Finished < StandardError; end
@@ -124,6 +125,7 @@ module RuboCop
       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.ignore_unrecognized_cops = @options[:ignore_unrecognized_cops]
     end
 
     def handle_exiting_options

data/lib/rubocop/config.rb

@@ -25,7 +25,7 @@ module RuboCop
       @loaded_path = loaded_path
       @for_cop = Hash.new do |h, cop|
         qualified_cop_name = Cop::Registry.qualified_cop_name(cop, loaded_path)
-        cop_options = self[qualified_cop_name] || {}
+        cop_options = self[qualified_cop_name].dup || {}
         cop_options['Enabled'] = enable_cop?(qualified_cop_name, cop_options)
         h[cop] = cop_options
       end
@@ -146,6 +146,10 @@ module RuboCop
       for_all_cops['NewCops'] == 'enable'
     end
 
+    def active_support_extensions_enabled?
+      for_all_cops['ActiveSupportExtensionsEnabled']
+    end
+
     def file_to_include?(file)
       relative_file_path = path_relative_to_config(file)
 

data/lib/rubocop/config_loader.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'erb'
 require 'yaml'
 require 'pathname'
 
@@ -22,7 +23,8 @@ module RuboCop
     class << self
       include FileFinder
 
-      attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops
+      attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
+                    :ignore_unrecognized_cops
       attr_writer :default_configuration, :project_root
       attr_reader :loaded_features
 

data/lib/rubocop/config_loader_resolver.rb

@@ -179,7 +179,7 @@ module RuboCop
 
     def determine_inherit_mode(hash, key)
       cop_cfg = hash[key]
-      local_inherit = cop_cfg.delete('inherit_mode') if cop_cfg.is_a?(Hash)
+      local_inherit = cop_cfg['inherit_mode'] if cop_cfg.is_a?(Hash)
       local_inherit || hash['inherit_mode'] || {}
     end
 

data/lib/rubocop/config_obsoletion/extracted_cop.rb

@@ -33,7 +33,9 @@ module RuboCop
         return old_name unless old_name.end_with?('*')
 
         # Handle whole departments (expressed as `Department/*`)
-        config.keys.grep(Regexp.new("^#{department}"))
+        config.keys.select do |key|
+          key == department || key.start_with?("#{department}/")
+        end
       end
 
       def feature_loaded?

data/lib/rubocop/config_validator.rb

@@ -102,6 +102,22 @@ module RuboCop
     end
 
     def alert_about_unrecognized_cops(invalid_cop_names)
+      unknown_cops = list_unknown_cops(invalid_cop_names)
+
+      return if unknown_cops.empty?
+
+      if ConfigLoader.ignore_unrecognized_cops
+        warn Rainbow('The following cops or departments are not ' \
+                     'recognized and will be ignored:').yellow
+        warn unknown_cops.join("\n")
+
+        return
+      end
+
+      raise ValidationError, unknown_cops.join("\n")
+    end
+
+    def list_unknown_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
@@ -119,7 +135,8 @@ module RuboCop
 
         unknown_cops << message
       end
-      raise ValidationError, unknown_cops.join("\n") if unknown_cops.any?
+
+      unknown_cops
     end
 
     def suggestion(name)
@@ -227,7 +244,7 @@ module RuboCop
         next unless cop_config.is_a?(Hash)
         next unless cop_config['Safe'] == false && cop_config['SafeAutoCorrect'] == true
 
-        msg = 'Unsafe cops cannot have a safe auto-correction ' \
+        msg = 'Unsafe cops cannot have a safe autocorrection ' \
               "(section #{name} in #{smart_loaded_path})"
         raise ValidationError, msg
       end
@@ -248,8 +265,8 @@ module RuboCop
     # 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."
+        "Property #{Rainbow(key).yellow} of cop #{Rainbow(parent).yellow} " \
+        "is supposed to be a boolean and #{Rainbow(value).yellow} is not."
     end
   end
 end

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -8,8 +8,12 @@ module RuboCop
         autocorrect_requested? && correctable? && autocorrect_enabled?
       end
 
+      def autocorrect_with_disable_uncorrectable?
+        autocorrect_requested? && disable_uncorrectable? && autocorrect_enabled?
+      end
+
       def autocorrect_requested?
-        @options.fetch(:auto_correct, false)
+        @options.fetch(:autocorrect, false)
       end
 
       def correctable?
@@ -30,7 +34,9 @@ module RuboCop
 
         return false if cop_config['AutoCorrect'] == false
 
-        return safe_autocorrect? if @options.fetch(:safe_auto_correct, false)
+        # :safe_autocorrect is a derived option based on several command-line
+        # arguments - see Rubocop::Options#add_autocorrection_options
+        return safe_autocorrect? if @options.fetch(:safe_autocorrect, false)
 
         true
       end

data/lib/rubocop/cop/badge.rb

@@ -15,7 +15,7 @@ module RuboCop
       def self.for(class_name)
         parts = class_name.split('::')
         name_deep_enough = parts.length >= 4
-        new(name_deep_enough ? parts[2..-1] : parts.last(2))
+        new(name_deep_enough ? parts[2..] : parts.last(2))
       end
 
       def self.parse(identifier)

data/lib/rubocop/cop/base.rb

@@ -48,7 +48,7 @@ module RuboCop
       InvestigationReport = Struct.new(:cop, :processed_source, :offenses, :corrector)
 
       # List of methods names to restrict calls for `on_send` / `on_csend`
-      RESTRICT_ON_SEND = Set[].freeze
+      RESTRICT_ON_SEND = Set[].freeze # rubocop:disable InternalAffairs/UselessRestrictOnSend
 
       # List of cops that should not try to autocorrect at the same
       # time as this cop
@@ -158,7 +158,7 @@ module RuboCop
         Registry.global.dismiss(self)
       end
 
-      # Returns if class supports auto_correct.
+      # Returns if class supports autocorrect.
       # It is recommended to extend AutoCorrector instead of overriding
       def self.support_autocorrect?
         false
@@ -220,6 +220,10 @@ module RuboCop
         @config.target_rails_version
       end
 
+      def active_support_extensions_enabled?
+        @config.active_support_extensions_enabled?
+      end
+
       def relevant_file?(file)
         file == RuboCop::AST::ProcessedSource::STRING_SOURCE_NAME ||
           (file_name_matches_any?(file, 'Include', true) &&

data/lib/rubocop/cop/bundler/duplicated_gem.rb

@@ -38,19 +38,15 @@ module RuboCop
       class DuplicatedGem < Base
         include RangeHelp
 
-        MSG = 'Gem `%<gem_name>s` requirements already given on line '\
+        MSG = 'Gem `%<gem_name>s` requirements already given on line ' \
               '%<line_of_first_occurrence>d of the Gemfile.'
 
         def on_new_investigation
           return if processed_source.blank?
 
           duplicated_gem_nodes.each do |nodes|
-            nodes[1..-1].each do |node|
-              register_offense(
-                node,
-                node.first_argument.to_a.first,
-                nodes.first.first_line
-              )
+            nodes[1..].each do |node|
+              register_offense(node, node.first_argument.to_a.first, nodes.first.first_line)
             end
           end
         end

data/lib/rubocop/cop/bundler/gem_comment.rb

@@ -152,7 +152,7 @@ module RuboCop
         def restrictive_version_specified_gem?(node)
           return unless version_specified_gem?(node)
 
-          node.arguments[1..-1]
+          node.arguments[1..]
               .any? { |arg| arg&.str_type? && RESTRICTIVE_VERSION_PATTERN.match?(arg.value) }
         end
 

data/lib/rubocop/cop/bundler/gem_filename.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Bundler
-      # This cop verifies that a project contains Gemfile or gems.rb file and correct
+      # Verifies that a project contains Gemfile or gems.rb file and correct
       # associated lock file based on the configuration.
       #
       # @example EnforcedStyle: Gemfile (default)
@@ -29,13 +29,13 @@ module RuboCop
         include ConfigurableEnforcedStyle
         include RangeHelp
 
-        MSG_GEMFILE_REQUIRED = '`gems.rb` file was found but `Gemfile` is required '\
+        MSG_GEMFILE_REQUIRED = '`gems.rb` file was found but `Gemfile` is required ' \
                                '(file path: %<file_path>s).'
-        MSG_GEMS_RB_REQUIRED = '`Gemfile` was found but `gems.rb` file is required '\
+        MSG_GEMS_RB_REQUIRED = '`Gemfile` was found but `gems.rb` file is required ' \
                                '(file path: %<file_path>s).'
-        MSG_GEMFILE_MISMATCHED = 'Expected a `Gemfile.lock` with `Gemfile` but found '\
+        MSG_GEMFILE_MISMATCHED = 'Expected a `Gemfile.lock` with `Gemfile` but found ' \
                                  '`gems.locked` file (file path: %<file_path>s).'
-        MSG_GEMS_RB_MISMATCHED = 'Expected a `gems.locked` file with `gems.rb` but found '\
+        MSG_GEMS_RB_MISMATCHED = 'Expected a `gems.locked` file with `gems.rb` but found ' \
                                  '`Gemfile.lock` (file path: %<file_path>s).'
         GEMFILE_FILES = %w[Gemfile Gemfile.lock].freeze
         GEMS_RB_FILES = %w[gems.rb gems.locked].freeze

data/lib/rubocop/cop/bundler/ordered_gems.rb

@@ -28,8 +28,8 @@ module RuboCop
         extend AutoCorrector
         include OrderedGemNode
 
-        MSG = 'Gems should be sorted in an alphabetical order within their '\
-              'section of the Gemfile. '\
+        MSG = 'Gems should be sorted in an alphabetical order within their ' \
+              'section of the Gemfile. ' \
               'Gem `%<previous>s` should appear before `%<current>s`.'
 
         def on_new_investigation

data/lib/rubocop/cop/corrector.rb

@@ -109,8 +109,8 @@ module RuboCop
                 "Parser::Source::Buffer, but got #{buffer.class}"
         end
         raise "Correction target buffer #{buffer.object_id} " \
-              "name:#{buffer.name.inspect}" \
-              " is not current #{@source_buffer.object_id} " \
+              "name:#{buffer.name.inspect} " \
+              "is not current #{@source_buffer.object_id} " \
               "name:#{@source_buffer.name.inspect} under investigation"
       end
     end

data/lib/rubocop/cop/correctors/alignment_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This class does auto-correction of nodes that should just be moved to
+    # This class does autocorrection of nodes that should just be moved to
     # the left or to the right, amount being determined by the instance
     # variable column_delta.
     class AlignmentCorrector

data/lib/rubocop/cop/correctors/condition_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This class does condition auto-correction
+    # This class does condition autocorrection
     class ConditionCorrector
       class << self
         def correct_negative_condition(corrector, node)

data/lib/rubocop/cop/correctors/each_to_for_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This class auto-corrects `#each` enumeration to `for` iteration.
+    # This class autocorrects `#each` enumeration to `for` iteration.
     class EachToForCorrector
       extend NodePattern::Macros
 

data/lib/rubocop/cop/correctors/empty_line_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This class does empty line auto-correction
+    # This class does empty line autocorrection
     class EmptyLineCorrector
       class << self
         def correct(corrector, node)

data/lib/rubocop/cop/correctors/for_to_each_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This class auto-corrects `for` iteration to `#each` enumeration.
+    # This class autocorrects `for` iteration to `#each` enumeration.
     class ForToEachCorrector
       extend NodePattern::Macros
 
@@ -35,7 +35,9 @@ module RuboCop
       end
 
       def requires_parentheses?
-        collection_node.range_type?
+        return true if collection_node.send_type? && collection_node.operator_method?
+
+        collection_node.range_type? || collection_node.or_type? || collection_node.and_type?
       end
 
       def end_position

data/lib/rubocop/cop/correctors/if_then_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This class auto-corrects `if...then` structures to a multiline `if` statement
+    # This class autocorrects `if...then` structures to a multiline `if` statement
     class IfThenCorrector
       DEFAULT_INDENTATION_WIDTH = 2
 

data/lib/rubocop/cop/correctors/lambda_literal_to_method_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This class auto-corrects lambda literal to method notation.
+    # This class autocorrects lambda literal to method notation.
     class LambdaLiteralToMethodCorrector
       def initialize(block_node)
         @block_node = block_node

data/lib/rubocop/cop/correctors/line_break_corrector.rb

@@ -50,7 +50,13 @@ module RuboCop
 
         def semicolon(node)
           @semicolon ||= {}.compare_by_identity
-          @semicolon[node] ||= processed_source.tokens_within(node).find(&:semicolon?)
+          @semicolon[node] ||= processed_source.sorted_tokens.select(&:semicolon?).find do |token|
+            same_line?(token, node.body) && trailing_class_definition?(token, node.body)
+          end
+        end
+
+        def trailing_class_definition?(token, body)
+          token.column < body.loc.column
         end
       end
     end

data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb

@@ -41,7 +41,7 @@ module RuboCop
       end
 
       def correct_next_line_brace(corrector)
-        corrector.remove(range_with_surrounding_space(range: node.loc.end, side: :left))
+        corrector.remove(range_with_surrounding_space(node.loc.end, side: :left))
 
         corrector.insert_before(
           last_element_range_with_trailing_comma(node).end,
@@ -51,7 +51,7 @@ module RuboCop
 
       def content_if_comment_present(corrector, node)
         range = range_with_surrounding_space(
-          range: children(node).last.source_range,
+          children(node).last.source_range,
           side: :right
         ).end.resize(1)
         if range.source == '#'
@@ -86,7 +86,7 @@ module RuboCop
 
       def last_element_trailing_comma_range(node)
         range = range_with_surrounding_space(
-          range: children(node).last.source_range,
+          children(node).last.source_range,
           side: :right
         ).end.resize(1)
 

data/lib/rubocop/cop/correctors/ordered_gem_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects gem dependency order
+    # This autocorrects gem dependency order
     class OrderedGemCorrector
       class << self
         include OrderedGemNode

data/lib/rubocop/cop/correctors/parentheses_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects parentheses
+    # This autocorrects parentheses
     class ParenthesesCorrector
       class << self
         def correct(corrector, node)

data/lib/rubocop/cop/correctors/percent_literal_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects percent literals
+    # This autocorrects percent literals
     class PercentLiteralCorrector
       include Util
 

data/lib/rubocop/cop/correctors/punctuation_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects punctuation
+    # This autocorrects punctuation
     class PunctuationCorrector
       class << self
         def remove_space(corrector, space_before)

data/lib/rubocop/cop/correctors/space_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects whitespace
+    # This autocorrects whitespace
     class SpaceCorrector
       extend SurroundingSpace
 

data/lib/rubocop/cop/correctors/string_literal_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects string literals
+    # This autocorrects string literals
     class StringLiteralCorrector
       extend Util
 

data/lib/rubocop/cop/correctors/unused_arg_corrector.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    # This auto-corrects unused arguments.
+    # This autocorrects unused arguments.
     class UnusedArgCorrector
       extend RangeHelp
 
@@ -29,7 +29,7 @@ module RuboCop
         end
 
         def correct_for_blockarg_type(corrector, node)
-          range = range_with_surrounding_space(range: node.source_range, side: :left)
+          range = range_with_surrounding_space(node.source_range, side: :left)
           range = range_with_surrounding_comma(range, :left)
 
           corrector.remove(range)