rubocop 1.44.1 → 1.45.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f6f58220d287e215fa9baaa9c274e89b128c0e42222595caa432132d27de274
-  data.tar.gz: e3c547bef6b2803f80ba22013eae4cff56f6fb572aca19a886bb2fb52e8ba665
+  metadata.gz: 648a8aa3156aebf0c078bc0b600f301d3aa0abaf92d6b3643c343718575f7302
+  data.tar.gz: 21b185886d70b70a163c6e7f3ea47e04ee0a0afcf11217e0d7bcb31e25440880
 SHA512:
-  metadata.gz: f9d29df635f00839a5da2cee59c55d4a279129529e3f0b130b7ad8602058fa11e733562a8e253dfa03b45e716c406e425d6c1f28fbd5a4a0b06436404058aa91
-  data.tar.gz: 4a80236cfa9402004dddf72346b395e944840da07525658de1a42ce5bbef7a030be86c38af798e6cf977b75b2c6153ecd7f33b9d91ab3cec1d631b68d21a4568
+  metadata.gz: ff5a5e947001ba9507f3e806896559baaf0e4bccc6b2cc56316dffc3ae334f62046040be389518139d2979c4d09900600f9b233bc1f4dbd2d1d37a2f8fe99037
+  data.tar.gz: 8f89f55198c9d206c5b8d0c32cbeb5033491046c0ea0f4311f6c1a23595bcce852ec732606ca1fd2bc499b31ecb2265dcf6d85edd352f6400d01bd9385993a44

data/README.md

@@ -53,7 +53,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.44', require: false
+gem 'rubocop', '~> 1.45', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.

data/config/default.yml

@@ -271,8 +271,7 @@ Gemspec/DevelopmentDependencies:
     - Gemfile
     - gems.rb
     - gemspec
-  AllowedGems:
-    - bundler
+  AllowedGems: []
   Include:
     - '**/*.gemspec'
     - '**/Gemfile'
@@ -407,9 +406,8 @@ Layout/AssignmentIndentation:
                 Checks the indentation of the first line of the
                 right-hand-side of a multi-line assignment.
   Enabled: true
-  SafeAutoCorrect: false
   VersionAdded: '0.49'
-  VersionChanged: '1.40'
+  VersionChanged: '1.45'
   # By default the indentation width from `Layout/IndentationWidth` is used,
   # but it can be overridden by setting this parameter.
   IndentationWidth: ~
@@ -980,7 +978,6 @@ Layout/IndentationWidth:
   # Number of spaces for each indentation level.
   Width: 2
   AllowedPatterns: []
-  IgnoredPatterns: [] # deprecated
 
 Layout/InitialIndentation:
   Description: >-
@@ -1008,10 +1005,8 @@ Layout/LineContinuationLeadingSpace:
                   Use trailing spaces instead of leading spaces in strings
                   broken over multiple lines (by a backslash).
   Enabled: pending
-  AutoCorrect: false
-  SafeAutoCorrect: false
   VersionAdded: '1.31'
-  VersionChanged: '1.32'
+  VersionChanged: '1.45'
   EnforcedStyle: trailing
   SupportedStyles:
     - leading
@@ -1063,7 +1058,6 @@ Layout/LineLength:
   # elements. Strings will be converted to Regexp objects. A line that matches
   # any regular expression listed in this option will be ignored by LineLength.
   AllowedPatterns: []
-  IgnoredPatterns: [] # deprecated
 
 Layout/MultilineArrayBraceLayout:
   Description: >-
@@ -1542,7 +1536,6 @@ Lint/AmbiguousBlockAssociation:
   VersionChanged: '1.13'
   AllowedMethods: []
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
 
 Lint/AmbiguousOperator:
   Description: >-
@@ -1579,7 +1572,9 @@ Lint/AssignmentInCondition:
   Description: "Don't use assignment in conditions."
   StyleGuide: '#safe-assignment-in-condition'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.9'
+  VersionChanged: '1.45'
   AllowSafeAssignment: true
 
 Lint/BigDecimalNew:
@@ -1636,12 +1631,12 @@ Lint/Debugger:
   Enabled: true
   VersionAdded: '0.14'
   VersionChanged: '1.10'
-  DebuggerReceivers: [] # deprecated
   DebuggerMethods:
     # Groups are available so that a specific group can be disabled in
     # a user's configuration, but are otherwise not significant.
     Kernel:
       - binding.irb
+      - p
       - Kernel.binding.irb
     Byebug:
       - byebug
@@ -1651,6 +1646,9 @@ Lint/Debugger:
     Capybara:
       - save_and_open_page
       - save_and_open_screenshot
+    PP:
+      - PP.pp
+      - pp
     debug.rb:
       - binding.b
       - binding.break
@@ -2053,7 +2051,6 @@ Lint/NumberConversion:
   SafeAutoCorrect: false
   AllowedMethods: []
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
   IgnoredClasses:
     - Time
     - DateTime
@@ -2404,7 +2401,6 @@ Lint/UnreachableLoop:
     # RSpec uses `times` in its message expectations
     # eg. `exactly(2).times`
     - !ruby/regexp /(exactly|at_least|at_most)\(\d+\)\.times/
-  IgnoredPatterns: [] # deprecated
 
 Lint/UnusedBlockArgument:
   Description: 'Checks for unused block arguments.'
@@ -2514,7 +2510,6 @@ Metrics/AbcSize:
   # a Float.
   AllowedMethods: []
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
   CountRepeatedAttributes: true
   Max: 17
 
@@ -2526,13 +2521,11 @@ Metrics/BlockLength:
   CountComments: false  # count full line comments?
   Max: 25
   CountAsOne: []
-  ExcludedMethods: [] # deprecated, retained for backwards compatibility
   AllowedMethods:
     # By default, exclude the `#refine` method, as it tends to have larger
     # associated blocks.
     - refine
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
   Exclude:
     - '**/*.gemspec'
 
@@ -2564,7 +2557,6 @@ Metrics/CyclomaticComplexity:
   VersionChanged: '0.81'
   AllowedMethods: []
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
   Max: 7
 
 Metrics/MethodLength:
@@ -2576,10 +2568,8 @@ Metrics/MethodLength:
   CountComments: false  # count full line comments?
   Max: 10
   CountAsOne: []
-  ExcludedMethods: [] # deprecated, retained for backwards compatibility
   AllowedMethods: []
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
 
 Metrics/ModuleLength:
   Description: 'Avoid modules longer than 100 lines of code.'
@@ -2609,7 +2599,6 @@ Metrics/PerceivedComplexity:
   VersionChanged: '0.81'
   AllowedMethods: []
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
   Max: 8
 
 ################## Migration #############################
@@ -2780,7 +2769,7 @@ Naming/HeredocDelimiterNaming:
   Enabled: true
   VersionAdded: '0.50'
   ForbiddenDelimiters:
-    - !ruby/regexp '/(^|\s)(EO[A-Z]{1}|END)(\s|$)/'
+    - !ruby/regexp '/(^|\s)(EO[A-Z]{1}|END)(\s|$)/i'
 
 Naming/InclusiveLanguage:
   Description: 'Recommend the use of inclusive language instead of problematic terms.'
@@ -2838,7 +2827,6 @@ Naming/MethodName:
   #     - '\A\s*onSelectionCleared\s*'
   #
   AllowedPatterns: []
-  IgnoredPatterns: [] # deprecated
 
 Naming/MethodParameterName:
   Description: >-
@@ -3208,7 +3196,6 @@ Style/BlockDelimiters:
     - proc
     - it
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
   # The AllowBracesOnProceduralOneLiners option is ignored unless the
   # EnforcedStyle is set to `semantic`. If so:
   #
@@ -3232,7 +3219,7 @@ Style/BlockDelimiters:
   #   collection.each do |element| puts element end
   AllowBracesOnProceduralOneLiners: false
   # The BracesRequiredMethods overrides all other configurations except
-  # IgnoredMethods. It can be used to enforce that all blocks for specific
+  # AllowedMethods. It can be used to enforce that all blocks for specific
   # methods use braces. For example, you can use this to enforce Sorbet
   # signatures use braces even when the rest of your codebase enforces
   # the `line_count_based` style.
@@ -3326,7 +3313,6 @@ Style/ClassEqualityComparison:
     - equal?
     - eql?
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
 
 Style/ClassMethods:
   Description: 'Use self when defining module/class methods.'
@@ -3801,7 +3787,6 @@ Style/FormatStringToken:
   VersionChanged: '1.0'
   AllowedMethods: []
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
 
 Style/FrozenStringLiteralComment:
   Description: >-
@@ -4180,9 +4165,7 @@ Style/MethodCallWithArgsParentheses:
   VersionChanged: '1.7'
   IgnoreMacros: true
   AllowedMethods: []
-  IgnoredMethods: [] # deprecated
   AllowedPatterns: []
-  IgnoredPatterns: [] # deprecated
   IncludedMacros: []
   AllowParenthesesInMultilineCall: false
   AllowParenthesesInChaining: false
@@ -4199,7 +4182,6 @@ Style/MethodCallWithoutArgsParentheses:
   Enabled: true
   AllowedMethods: []
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
   VersionAdded: '0.47'
   VersionChanged: '0.55'
 
@@ -4578,7 +4560,6 @@ Style/NumericPredicate:
     - comparison
   AllowedMethods: []
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
   # Exclude RSpec specs because assertions like `expect(1).to be > 0` cause
   # false positives.
   Exclude:
@@ -4858,6 +4839,11 @@ Style/RedundantFreeze:
   VersionAdded: '0.34'
   VersionChanged: '0.66'
 
+Style/RedundantHeredocDelimiterQuotes:
+  Description: 'Checks for redundant heredoc delimiter quotes.'
+  Enabled: pending
+  VersionAdded: '1.45'
+
 Style/RedundantInitialize:
   Description: 'Checks for redundant `initialize` methods.'
   Enabled: pending
@@ -5255,7 +5241,6 @@ Style/SymbolProc:
   AllowedMethods:
     - define_method
   AllowedPatterns: []
-  IgnoredMethods: [] # deprecated
   AllowComments: false
 
 Style/TernaryParentheses:

data/lib/rubocop/cli.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 module RuboCop
   # The CLI is a class responsible of handling all the command line interface
   # logic.
@@ -38,14 +40,16 @@ module RuboCop
       @options, paths = Options.new.parse(args)
       @env = Environment.new(@options, @config_store, paths)
 
-      if @options[:init]
-        run_command(:init)
-      else
-        act_on_options
-        validate_options_vs_config
-        parallel_by_default!
-        apply_default_formatter
-        execute_runners
+      profile_if_needed do
+        if @options[:init]
+          run_command(:init)
+        else
+          act_on_options
+          validate_options_vs_config
+          parallel_by_default!
+          apply_default_formatter
+          execute_runners
+        end
       end
     rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
       warn e.message
@@ -68,6 +72,48 @@ module RuboCop
 
     private
 
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def profile_if_needed
+      return yield unless @options[:profile]
+
+      return STATUS_ERROR unless require_gem('stackprof')
+
+      with_memory = @options[:memory]
+      if with_memory
+        return STATUS_ERROR unless require_gem('memory_profiler')
+
+        MemoryProfiler.start
+      end
+
+      tmp_dir = File.join(ConfigFinder.project_root, 'tmp')
+      FileUtils.mkdir_p(tmp_dir)
+      status = nil
+
+      StackProf.run(out: File.join(tmp_dir, 'rubocop-stackprof.dump')) do
+        status = yield
+      end
+      puts 'Profile report generated'
+
+      if with_memory
+        puts 'Building memory report...'
+        report = MemoryProfiler.stop
+        report.pretty_print(
+          to_file: File.join(tmp_dir, 'rubocop-memory_profiler.txt'),
+          scale_bytes: true
+        )
+      end
+      status
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+    def require_gem(name)
+      require name
+      true
+    rescue LoadError
+      warn("You don't have #{name} installed. Add it to your Gemfile and run `bundle install`")
+      false
+    end
+
     def run_command(name)
       @env.run(name)
     end

data/lib/rubocop/config_loader_resolver.rb

@@ -33,7 +33,7 @@ module RuboCop
                       inherit_mode: determine_inherit_mode(hash, k))
           end
           hash[k] = v
-          fix_include_paths(base_config.loaded_path, hash, path, k, v) if v.key?('Include')
+          fix_include_paths(base_config.loaded_path, hash, k, v) if v.key?('Include')
         end
       end
     end
@@ -42,13 +42,12 @@ module RuboCop
     # base configuration are relative to the directory where the base configuration file is. For the
     # derived configuration, we need to make those paths relative to where the derived configuration
     # file is.
-    def fix_include_paths(base_config_path, hash, path, key, value)
+    def fix_include_paths(base_config_path, hash, key, value)
       return unless File.basename(base_config_path).start_with?('.rubocop')
 
       base_dir = File.dirname(base_config_path)
-      derived_dir = File.dirname(path)
       hash[key]['Include'] = value['Include'].map do |include_path|
-        PathUtil.relative_path(File.join(base_dir, include_path), derived_dir)
+        PathUtil.relative_path(File.join(base_dir, include_path), Dir.pwd)
       end
     end
 

data/lib/rubocop/cop/base.rb

@@ -180,6 +180,10 @@ module RuboCop
 
         status, corrector = enabled_line?(range.line) ? correct(range, &block) : :disabled
 
+        # Since this range may be generated from Ruby code embedded in some
+        # template file, we convert it to location info in the original file.
+        range = range_for_original(range)
+
         current_offenses << Offense.new(severity, range, message, name, status, corrector)
       end
 
@@ -286,6 +290,21 @@ module RuboCop
       end
       # rubocop:enable Layout/ClassStructure
 
+      # Called before any investigation
+      # @api private
+      def begin_investigation(processed_source, offset: 0, original: processed_source)
+        @current_offenses = nil
+        @current_offense_locations = nil
+        @currently_disabled_lines = nil
+        @processed_source = processed_source
+        @current_corrector = nil
+
+        # We need to keep track of the original source and offset,
+        # because `processed_source` here may be an embedded code in it.
+        @current_offset = offset
+        @current_original = original
+      end
+
       private
 
       ### Reserved for Cop::Cop
@@ -320,15 +339,6 @@ module RuboCop
         @restrict_on_send ||= self::RESTRICT_ON_SEND.to_a.freeze
       end
 
-      # Called before any investigation
-      def begin_investigation(processed_source)
-        @current_offenses = nil
-        @current_offense_locations = nil
-        @currently_disabled_lines = nil
-        @processed_source = processed_source
-        @current_corrector = nil
-      end
-
       EMPTY_OFFENSES = [].freeze
       private_constant :EMPTY_OFFENSES
       # Called to complete an investigation
@@ -459,6 +469,14 @@ module RuboCop
           warn(Rainbow(message).red)
         end
       end
+
+      def range_for_original(range)
+        ::Parser::Source::Range.new(
+          @current_original.buffer,
+          range.begin_pos + @current_offset,
+          range.end_pos + @current_offset
+        )
+      end
     end
   end
 end

data/lib/rubocop/cop/commissioner.rb

@@ -76,10 +76,10 @@ module RuboCop
       end
 
       # @return [InvestigationReport]
-      def investigate(processed_source)
+      def investigate(processed_source, offset: 0, original: processed_source)
         reset
 
-        @cops.each { |cop| cop.send :begin_investigation, processed_source }
+        begin_investigation(processed_source, offset: offset, original: original)
         if processed_source.valid_syntax?
           invoke(:on_new_investigation, @cops)
           invoke_with_argument(:investigate, @forces, processed_source)
@@ -95,6 +95,12 @@ module RuboCop
 
       private
 
+      def begin_investigation(processed_source, offset:, original:)
+        @cops.each do |cop|
+          cop.begin_investigation(processed_source, offset: offset, original: original)
+        end
+      end
+
       def trigger_responding_cops(callback, node)
         @callbacks[callback]&.each do |cop|
           with_cop_error_handling(cop, node) do

data/lib/rubocop/cop/cop.rb

@@ -53,6 +53,11 @@ module RuboCop
       def add_offense(node_or_range, location: :expression, message: nil, severity: nil, &block)
         @v0_argument = node_or_range
         range = find_location(node_or_range, location)
+
+        # Since this range may be generated from Ruby code embedded in some
+        # template file, we convert it to location info in the original file.
+        range = range_for_original(range)
+
         if block.nil? && !support_autocorrect?
           super(range, message: message, severity: severity)
         else
@@ -93,14 +98,21 @@ module RuboCop
         super
       end
 
-      private
-
-      def begin_investigation(processed_source)
+      # Called before any investigation
+      # @api private
+      def begin_investigation(processed_source, offset: 0, original: processed_source)
         super
         @offenses = current_offenses
         @last_corrector = @current_corrector
+
+        # We need to keep track of the original source and offset,
+        # because `processed_source` here may be an embedded code in it.
+        @current_offset = offset
+        @current_original = original
       end
 
+      private
+
       # Override Base
       def callback_argument(_range)
         @v0_argument
@@ -141,6 +153,14 @@ module RuboCop
       rescue ::Parser::ClobberingError
         # ignore Clobbering errors
       end
+
+      def range_for_original(range)
+        ::Parser::Source::Range.new(
+          @current_original.buffer,
+          range.begin_pos + @current_offset,
+          range.end_pos + @current_offset
+        )
+      end
     end
   end
 end

data/lib/rubocop/cop/layout/array_alignment.rb

@@ -76,7 +76,7 @@ module RuboCop
         end
 
         def target_method_lineno(node)
-          node.loc.line
+          node.bracketed? ? node.loc.line : node.parent.loc.line
         end
       end
     end

data/lib/rubocop/cop/layout/class_structure.rb

@@ -134,6 +134,7 @@ module RuboCop
       #
       class ClassStructure < Base
         include VisibilityHelp
+        include CommentsHelp
         extend AutoCorrector
 
         HUMANIZED_NODE_TYPE = {
@@ -163,7 +164,7 @@ module RuboCop
 
         # Autocorrect by swapping between two nodes autocorrecting them
         def autocorrect(corrector, node)
-          previous = node.left_siblings.find do |sibling|
+          previous = node.left_siblings.reverse.find do |sibling|
             !ignore_for_autocorrect?(node, sibling)
           end
           return unless previous
@@ -283,21 +284,6 @@ module RuboCop
           node.arguments.any? { |arg| (arg.sym_type? || arg.str_type?) && arg.value == name }
         end
 
-        def source_range_with_comment(node)
-          begin_pos, end_pos =
-            if (node.def_type? && !node.method?(:initialize)) ||
-               (node.send_type? && node.def_modifier?)
-              start_node = find_visibility_start(node) || node
-              end_node = find_visibility_end(node) || node
-              [begin_pos_with_comment(start_node),
-               end_position_for(end_node) + 1]
-            else
-              [begin_pos_with_comment(node), end_position_for(node)]
-            end
-
-          Parser::Source::Range.new(buffer, begin_pos, end_pos)
-        end
-
         def end_position_for(node)
           heredoc = find_heredoc(node)
           return heredoc.location.heredoc_end.end_pos + 1 if heredoc

data/lib/rubocop/cop/layout/first_argument_indentation.rb

@@ -179,7 +179,7 @@ module RuboCop
 
           send_node = arg_node.parent
           text = base_range(send_node, arg_node).source.strip
-          base = if !/\n/.match?(text) && special_inner_call_indentation?(send_node)
+          base = if !text.include?("\n") && special_inner_call_indentation?(send_node)
                    "`#{text}`"
                  elsif comment_line?(text.lines.reverse_each.first)
                    'the start of the previous line (not counting the comment)'

data/lib/rubocop/cop/layout/space_around_keyword.rb

@@ -241,7 +241,7 @@ module RuboCop
         end
 
         def accept_namespace_operator?(range)
-          ACCEPT_NAMESPACE_OPERATOR == range.source
+          range.source == ACCEPT_NAMESPACE_OPERATOR
         end
 
         def safe_navigation_call?(range, pos)

data/lib/rubocop/cop/layout/space_around_operators.rb

@@ -177,7 +177,7 @@ module RuboCop
         end
 
         def autocorrect(corrector, range)
-          if /\*\*/.match?(range.source) && !space_around_exponent_operator?
+          if range.source.include?('**') && !space_around_exponent_operator?
             corrector.replace(range, '**')
           elsif range.source.end_with?("\n")
             corrector.replace(range, " #{range.source.strip}\n")

data/lib/rubocop/cop/layout/space_inside_array_literal_brackets.rb

@@ -78,8 +78,11 @@ module RuboCop
         def on_array(node)
           return unless node.square_brackets?
 
-          left, right = array_brackets(node)
-          return empty_offenses(node, left, right, EMPTY_MSG) if empty_brackets?(left, right)
+          tokens, left, right = array_brackets(node)
+
+          if empty_brackets?(left, right, tokens: tokens)
+            return empty_offenses(node, left, right, EMPTY_MSG)
+          end
 
           start_ok = next_to_newline?(node, left)
           end_ok = node.single_line? ? false : end_has_own_line?(right)
@@ -90,9 +93,9 @@ module RuboCop
         private
 
         def autocorrect(corrector, node)
-          left, right = array_brackets(node)
+          tokens, left, right = array_brackets(node)
 
-          if empty_brackets?(left, right)
+          if empty_brackets?(left, right, tokens: tokens)
             SpaceCorrector.empty_corrections(processed_source, corrector, empty_config, left, right)
           elsif style == :no_space
             SpaceCorrector.remove_space(processed_source, corrector, left, right)
@@ -104,15 +107,12 @@ module RuboCop
         end
 
         def array_brackets(node)
-          [left_array_bracket(node), right_array_bracket(node)]
-        end
+          tokens = processed_source.tokens_within(node)
 
-        def left_array_bracket(node)
-          processed_source.tokens_within(node).find(&:left_array_bracket?)
-        end
+          left = tokens.find(&:left_array_bracket?)
+          right = tokens.reverse_each.find(&:right_bracket?)
 
-        def right_array_bracket(node)
-          processed_source.tokens_within(node).reverse.find(&:right_bracket?)
+          [tokens, left, right]
         end
 
         def empty_config

data/lib/rubocop/cop/layout/space_inside_reference_brackets.rb

@@ -74,7 +74,7 @@ module RuboCop
 
           right_token = closing_bracket(tokens, left_token)
 
-          if empty_brackets?(left_token, right_token)
+          if empty_brackets?(left_token, right_token, tokens: tokens)
             return empty_offenses(node, left_token, right_token, EMPTY_MSG)
           end
 
@@ -90,9 +90,9 @@ module RuboCop
         private
 
         def autocorrect(corrector, node)
-          left, right = reference_brackets(node)
+          tokens, left, right = reference_brackets(node)
 
-          if empty_brackets?(left, right)
+          if empty_brackets?(left, right, tokens: tokens)
             SpaceCorrector.empty_corrections(processed_source, corrector, empty_config, left, right)
           elsif style == :no_space
             SpaceCorrector.remove_space(processed_source, corrector, left, right)
@@ -104,7 +104,7 @@ module RuboCop
         def reference_brackets(node)
           tokens = processed_source.tokens_within(node)
           left = left_ref_bracket(node, tokens)
-          [left, closing_bracket(tokens, left)]
+          [tokens, left, closing_bracket(tokens, left)]
         end
 
         def left_ref_bracket(node, tokens)