rubocop 1.25.1 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54b88752efa8bb84dc034391460b9071f31179dcb279550a209d31829e7b8c93
-  data.tar.gz: 31115cff5fdbf562dee62cf7e07033205d150b61ac5fd11476708f21e67000cf
+  metadata.gz: d48fd91bc57ba3589a331c3c0141d3e168c7631e5db47238a88cecbd10b12292
+  data.tar.gz: 9393d3cab7e09e86a9276ca4614f8f2c4fc2895f2070bd3364096569c2cd5828
 SHA512:
-  metadata.gz: acdaf069659a775853b20e05734e85cd65c0c8734b09e568d4360dc9a7440a49ec8e47928b0da78866e1326a588638d18f2564e6e94023bb17b2f39493555027
-  data.tar.gz: 2765d9c9c10966c485be6cd70190b69a25aa99800c8d483bd67c1fdfe3dc5d13bb97cb1ca7f9f663776869acda5a426bc797f3b40adda17e0241ff8b62a374f1
+  metadata.gz: 13d85485214ca48904b07a6da11f89d2e2ef33fceab05912fb4c4f4c1e025da4be79139845d13724a749f97eb837b943eef5515639a5116299b6a164d7517944
+  data.tar.gz: 668abbcaedb1f06c43a2e5f61774909d684767659979bc3787c0827ca22adf42be0edf1d30544909a74fc6aac18bcd3758c7c5f77352cb97b51fd96acd24ab18

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.25', require: false
+gem 'rubocop', '~> 1.27', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.

data/config/default.yml

@@ -262,7 +262,7 @@ Gemspec/OrderedDependencies:
     - '**/*.gemspec'
 
 Gemspec/RequireMFA:
-  Description: 'Checks that the gemspec has metadata to require MFA from RubyGems.'
+  Description: 'Checks that the gemspec has metadata to require Multi-Factor Authentication from RubyGems.'
   Enabled: pending
   VersionAdded: '1.23'
   Reference:
@@ -1816,12 +1816,14 @@ Lint/IneffectiveAccessModifier:
 Lint/InheritException:
   Description: 'Avoid inheriting from the `Exception` class.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.41'
+  VersionChanged: '1.26'
   # The default base class in favour of `Exception`.
-  EnforcedStyle: runtime_error
+  EnforcedStyle: standard_error
   SupportedStyles:
-    - runtime_error
     - standard_error
+    - runtime_error
 
 Lint/InterpolationCheck:
   Description: 'Raise warning for interpolation in single q strs.'
@@ -2011,6 +2013,8 @@ Lint/RedundantDirGlobSort:
   Description: 'Checks for redundant `sort` method to `Dir.glob` and `Dir[]`.'
   Enabled: pending
   VersionAdded: '1.8'
+  VersionChanged: '1.26'
+  SafeAutoCorrect: false
 
 Lint/RedundantRequireStatement:
   Description: 'Checks for unnecessary `require` statement.'
@@ -2054,6 +2058,12 @@ Lint/RedundantWithObject:
   Enabled: true
   VersionAdded: '0.51'
 
+Lint/RefinementImportMethods:
+  Description: 'Use `Refinement#import_methods` when using `include` or `prepend` in `refine` block.'
+  Enabled: pending
+  SafeAutoCorrect: false
+  VersionAdded: '1.27'
+
 Lint/RegexpAsCondition:
   Description: >-
                  Do not use regexp literal as a condition.
@@ -2323,8 +2333,8 @@ Lint/UselessMethodDefinition:
   Description: 'Checks for useless method definitions.'
   Enabled: true
   VersionAdded: '0.90'
+  VersionChanged: '0.91'
   Safe: false
-  AllowComments: true
 
 Lint/UselessRuby2Keywords:
   Description: 'Finds unnecessary uses of `ruby2_keywords`.'
@@ -3542,8 +3552,9 @@ Style/For:
   Description: 'Checks use of for or each in multiline loops.'
   StyleGuide: '#no-for-loops'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.13'
-  VersionChanged: '0.59'
+  VersionChanged: '1.26'
   EnforcedStyle: each
   SupportedStyles:
     - each
@@ -4122,6 +4133,11 @@ Style/NegatedWhile:
   Enabled: true
   VersionAdded: '0.20'
 
+Style/NestedFileDirname:
+  Description: 'Checks for nested `File.dirname`.'
+  Enabled: pending
+  VersionAdded: '1.26'
+
 Style/NestedModifier:
   Description: 'Avoid using nested modifiers.'
   StyleGuide: '#no-nested-modifiers'
@@ -4514,6 +4530,11 @@ Style/RedundantFreeze:
   VersionAdded: '0.34'
   VersionChanged: '0.66'
 
+Style/RedundantInitialize:
+  Description: 'Checks for redundant `initialize` methods.'
+  Enabled: pending
+  VersionAdded: '1.27'
+
 Style/RedundantInterpolation:
   Description: 'Checks for strings that are just an interpolated expression.'
   Enabled: true
@@ -4635,7 +4656,7 @@ Style/SafeNavigation:
                   be `nil` or truthy, but never `false`.
   Enabled: true
   VersionAdded: '0.43'
-  VersionChanged: '0.77'
+  VersionChanged: '1.27'
   # Safe navigation may cause a statement to start returning `nil` in addition
   # to whatever it used to return.
   ConvertCodeThatCanStartToReturnNil: false
@@ -4646,6 +4667,8 @@ Style/SafeNavigation:
     - try
     - try!
   SafeAutoCorrect: false
+  # Maximum length of method chains for register an offense.
+  MaxChainLength: 2
 
 Style/Sample:
   Description: >-

data/lib/rubocop/cli.rb

@@ -14,7 +14,7 @@ module RuboCop
       ignore_disable_comments lint only only_guide_cops require safe
     ].freeze
 
-    class Finished < RuntimeError; end
+    class Finished < StandardError; end
 
     attr_reader :options, :config_store
 

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/cop/autocorrect_logic.rb

@@ -8,6 +8,10 @@ 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)
       end

data/lib/rubocop/cop/badge.rb

@@ -19,7 +19,13 @@ module RuboCop
       end
 
       def self.parse(identifier)
-        new(identifier.split('/'))
+        new(identifier.split('/').map { |i| camel_case(i) })
+      end
+
+      def self.camel_case(name_part)
+        return 'RSpec' if name_part == 'rspec'
+
+        name_part.gsub(/^\w|_\w/) { |match| match[-1, 1].upcase }
       end
 
       def initialize(class_name_parts)

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

@@ -46,11 +46,7 @@ module RuboCop
 
           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
-              )
+              register_offense(node, node.first_argument.to_a.first, nodes.first.first_line)
             end
           end
         end

data/lib/rubocop/cop/gemspec/duplicated_assignment.rb

@@ -52,11 +52,7 @@ module RuboCop
 
           duplicated_assignment_method_nodes.each do |nodes|
             nodes[1..-1].each do |node|
-              register_offense(
-                node,
-                node.method_name,
-                nodes.first.first_line
-              )
+              register_offense(node, node.method_name, nodes.first.first_line)
             end
           end
         end

data/lib/rubocop/cop/gemspec/require_mfa.rb

@@ -5,9 +5,10 @@ module RuboCop
     module Gemspec
       # Requires a gemspec to have `rubygems_mfa_required` metadata set.
       #
-      # This setting tells RubyGems that MFA is required for accounts to
-      # be able perform privileged operations, such as (see
-      # RubyGems' documentation for the full list of privileged operations):
+      # This setting tells RubyGems that MFA (Multi-Factor Authentication) is
+      # required for accounts to be able perform privileged operations, such as
+      # (see RubyGems' documentation for the full list of privileged
+      # operations):
       #
       # * `gem push`
       # * `gem yank`

data/lib/rubocop/cop/generator.rb

@@ -8,13 +8,7 @@ module RuboCop
     # and spec file when given a valid qualified cop name.
     # @api private
     class Generator
-      # NOTE: RDoc 5.1.0 or lower has the following issue.
-      # https://github.com/rubocop/rubocop/issues/7043
-      #
-      # The following `String#gsub` can be replaced with
-      # squiggly heredoc when RuboCop supports Ruby 2.5 or higher
-      # (RDoc 6.0 or higher).
-      SOURCE_TEMPLATE = <<-RUBY.gsub(/^ {8}/, '')
+      SOURCE_TEMPLATE = <<~RUBY
         # frozen_string_literal: true
 
         module RuboCop
@@ -68,6 +62,7 @@ module RuboCop
                 # For example
                 MSG = 'Use `#good_method` instead of `#bad_method`.'
 
+                # @!method bad_method?(node)
                 def_node_matcher :bad_method?, <<~PATTERN
                   (send nil? :bad_method ...)
                 PATTERN

data/lib/rubocop/cop/internal_affairs/redundant_context_config_parameter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # Checks for redundant `:config` parameter in the `context` arguments.
+      #
+      # @example
+      #
+      #   # bad
+      #   context 'foo', :config do
+      #   end
+      #
+      #   # good
+      #   context 'foo' do
+      #   end
+      #
+      class RedundantContextConfigParameter < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Remove the redundant `:config` parameter.'
+        RESTRICT_ON_SEND = %i[context].freeze
+
+        def on_send(node)
+          arguments = node.arguments
+          config_node = arguments.detect { |argument| argument.source == ':config' }
+          return unless config_node
+
+          add_offense(config_node) do |corrector|
+            dup_arguments = arguments.dup
+            dup_arguments.delete(config_node)
+
+            corrector.replace(offense_range(arguments), dup_arguments.map(&:source).join(', '))
+          end
+        end
+
+        private
+
+        def offense_range(arguments)
+          range_between(arguments.first.source_range.begin_pos, arguments.last.source_range.end_pos)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/internal_affairs.rb

@@ -9,6 +9,7 @@ require_relative 'internal_affairs/node_destructuring'
 require_relative 'internal_affairs/node_matcher_directive'
 require_relative 'internal_affairs/node_type_predicate'
 require_relative 'internal_affairs/offense_location_keyword'
+require_relative 'internal_affairs/redundant_context_config_parameter'
 require_relative 'internal_affairs/redundant_described_class_as_subject'
 require_relative 'internal_affairs/redundant_let_rubocop_config_new'
 require_relative 'internal_affairs/redundant_location_argument'

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks how the `when` and `in`s of a `case` expression
+      # This cop checks how the `when` and ``in``s of a `case` expression
       # are indented in relation to its `case` or `end` keyword.
       #
       # It will register a separate offense for each misaligned `when` and `in`.

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

@@ -185,8 +185,7 @@ module RuboCop
 
         def check_members_for_indented_internal_methods_style(members)
           each_member(members) do |member, previous_modifier|
-            check_indentation(previous_modifier, member,
-                              indentation_consistency_style)
+            check_indentation(previous_modifier, member, indentation_consistency_style)
           end
         end
 

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

@@ -3,27 +3,26 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks the indentation of the right hand side operand in
-      # binary operations that span more than one line.
+      # This cop checks the indentation of the right hand side operand in binary operations that
+      # span more than one line.
       #
-      # The `aligned` style checks that operators are aligned if they are part
-      # of an `if` or `while` condition, a `return` statement, etc. In other
-      # contexts, the second operand should be indented regardless of enforced
-      # style.
+      # The `aligned` style checks that operators are aligned if they are part of an `if` or `while`
+      # condition, an explicit `return` statement, etc. In other contexts, the second operand should
+      # be indented regardless of enforced style.
       #
       # @example EnforcedStyle: aligned (default)
       #   # bad
       #   if a +
       #       b
       #     something &&
-      #       something_else
+      #     something_else
       #   end
       #
       #   # good
       #   if a +
       #      b
       #     something &&
-      #     something_else
+      #       something_else
       #   end
       #
       # @example EnforcedStyle: indented

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

@@ -105,10 +105,9 @@ module RuboCop
         end
 
         def convertible_block?(node)
-          return false unless node.parent&.block_type?
-
-          send_node = node.parent&.send_node
-          send_node.parenthesized? || !send_node.arguments?
+          parent = node.parent
+          parent&.block_type? && node == parent.send_node &&
+            (node.parenthesized? || !node.arguments?)
         end
 
         def comment_within?(node)

data/lib/rubocop/cop/lint/ambiguous_operator.rb

@@ -24,11 +24,11 @@ module RuboCop
         extend AutoCorrector
 
         AMBIGUITIES = {
-          '+'  => { actual: 'positive number', possible: 'addition' },
-          '-'  => { actual: 'negative number', possible: 'subtraction' },
-          '*'  => { actual: 'splat',           possible: 'multiplication' },
-          '&'  => { actual: 'block',           possible: 'binary AND' },
-          '**' => { actual: 'keyword splat',   possible: 'exponent' }
+          '+'  => { actual: 'positive number', possible: 'an addition' },
+          '-'  => { actual: 'negative number', possible: 'a subtraction' },
+          '*'  => { actual: 'splat',           possible: 'a multiplication' },
+          '&'  => { actual: 'block',           possible: 'a binary AND' },
+          '**' => { actual: 'keyword splat',   possible: 'an exponent' }
         }.each do |key, hash|
           hash[:operator] = key
         end
@@ -36,7 +36,7 @@ module RuboCop
         MSG_FORMAT = 'Ambiguous %<actual>s operator. Parenthesize the method ' \
                      "arguments if it's surely a %<actual>s operator, or add " \
                      'a whitespace to the right of the `%<operator>s` if it ' \
-                     'should be a %<possible>s.'
+                     'should be %<possible>s.'
 
         def on_new_investigation
           processed_source.diagnostics.each do |diagnostic|

data/lib/rubocop/cop/lint/empty_conditional_body.rb

@@ -53,11 +53,13 @@ module RuboCop
       #   end
       #
       class EmptyConditionalBody < Base
+        include CommentsHelp
+
         MSG = 'Avoid `%<keyword>s` branches without a body.'
 
         def on_if(node)
           return if node.body
-          return if cop_config['AllowComments'] && comment_lines?(node)
+          return if cop_config['AllowComments'] && contains_comments?(node)
 
           add_offense(node, message: format(MSG, keyword: node.keyword))
         end

data/lib/rubocop/cop/lint/empty_in_pattern.rb

@@ -44,6 +44,7 @@ module RuboCop
       #
       class EmptyInPattern < Base
         extend TargetRubyVersion
+        include CommentsHelp
 
         MSG = 'Avoid `in` branches without a body.'
 
@@ -51,7 +52,8 @@ module RuboCop
 
         def on_case_match(node)
           node.in_pattern_branches.each do |branch|
-            next if branch.body || (cop_config['AllowComments'] && comment_lines?(node))
+            next if branch.body
+            next if cop_config['AllowComments'] && contains_comments?(branch)
 
             add_offense(branch)
           end

data/lib/rubocop/cop/lint/empty_when.rb

@@ -45,12 +45,14 @@ module RuboCop
       #   end
       #
       class EmptyWhen < Base
+        include CommentsHelp
+
         MSG = 'Avoid `when` branches without a body.'
 
         def on_case(node)
           node.each_when do |when_node|
             next if when_node.body
-            next if cop_config['AllowComments'] && comment_lines?(node)
+            next if cop_config['AllowComments'] && contains_comments?(when_node)
 
             add_offense(when_node)
           end

data/lib/rubocop/cop/lint/incompatible_io_select_with_fiber_scheduler.rb

@@ -6,6 +6,15 @@ module RuboCop
       #
       # This cop checks for `IO.select` that is incompatible with Fiber Scheduler since Ruby 3.0.
       #
+      # NOTE: When the method is successful the return value of `IO.select` is `[[IO]]`,
+      # and the return value of `io.wait_readable` and `io.wait_writable` are `self`.
+      # They are not auto-corrected when assigning a return value because these types are different.
+      # It's up to user how to handle the return value.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because `NoMethodError` occurs
+      #   if `require 'io/wait'` is not called.
+      #
       # @example
       #
       #   # bad
@@ -20,10 +29,6 @@ module RuboCop
       #   # good
       #   io.wait_writable(timeout)
       #
-      # @safety
-      #   This cop's autocorrection is unsafe because `NoMethodError` occurs
-      #   if `require 'io/wait'` is not called.
-      #
       class IncompatibleIoSelectWithFiberScheduler < Base
         extend AutoCorrector
 
@@ -45,6 +50,8 @@ module RuboCop
           message = format(MSG, preferred: preferred, current: node.source)
 
           add_offense(node, message: message) do |corrector|
+            next if node.parent&.assignment?
+
             corrector.replace(node, preferred)
           end
         end

data/lib/rubocop/cop/lint/inherit_exception.rb

@@ -3,12 +3,16 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop looks for error classes inheriting from `Exception`
-      # and its standard library subclasses, excluding subclasses of
-      # `StandardError`. It is configurable to suggest using either
-      # `RuntimeError` (default) or `StandardError` instead.
+      # This cop looks for error classes inheriting from `Exception`.
+      # It is configurable to suggest using either `StandardError` (default) or
+      # `RuntimeError` instead.
       #
-      # @example EnforcedStyle: runtime_error (default)
+      # @safety
+      #   This cop's autocorrection is unsafe because `rescue` that omit
+      #   exception class handle `StandardError` and its subclasses,
+      #   but not `Exception` and its subclasses.
+      #
+      # @example EnforcedStyle: standard_error (default)
       #   # bad
       #
       #   class C < Exception; end
@@ -17,11 +21,11 @@ module RuboCop
       #
       #   # good
       #
-      #   class C < RuntimeError; end
+      #   class C < StandardError; end
       #
-      #   C = Class.new(RuntimeError)
+      #   C = Class.new(StandardError)
       #
-      # @example EnforcedStyle: standard_error
+      # @example EnforcedStyle: runtime_error
       #   # bad
       #
       #   class C < Exception; end
@@ -30,31 +34,18 @@ module RuboCop
       #
       #   # good
       #
-      #   class C < StandardError; end
+      #   class C < RuntimeError; end
       #
-      #   C = Class.new(StandardError)
+      #   C = Class.new(RuntimeError)
       class InheritException < Base
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
-        MSG = 'Inherit from `%<prefer>s` instead of `%<current>s`.'
+        MSG = 'Inherit from `%<prefer>s` instead of `Exception`.'
         PREFERRED_BASE_CLASS = {
           runtime_error: 'RuntimeError',
           standard_error: 'StandardError'
         }.freeze
-        ILLEGAL_CLASSES = %w[
-          Exception
-          SystemStackError
-          NoMemoryError
-          SecurityError
-          NotImplementedError
-          LoadError
-          SyntaxError
-          ScriptError
-          Interrupt
-          SignalException
-          SystemExit
-        ].freeze
 
         RESTRICT_ON_SEND = %i[new].freeze
 
@@ -66,7 +57,7 @@ module RuboCop
         PATTERN
 
         def on_class(node)
-          return unless node.parent_class && illegal_class_name?(node.parent_class)
+          return unless node.parent_class && exception_class?(node.parent_class)
 
           message = message(node.parent_class)
 
@@ -77,7 +68,7 @@ module RuboCop
 
         def on_send(node)
           constant = class_new_call?(node)
-          return unless constant && illegal_class_name?(constant)
+          return unless constant && exception_class?(constant)
 
           message = message(constant)
 
@@ -92,8 +83,8 @@ module RuboCop
           format(MSG, prefer: preferred_base_class, current: node.const_name)
         end
 
-        def illegal_class_name?(class_node)
-          ILLEGAL_CLASSES.include?(class_node.const_name)
+        def exception_class?(class_node)
+          class_node.const_name == 'Exception'
         end
 
         def preferred_base_class

data/lib/rubocop/cop/lint/lambda_without_literal_block.rb

@@ -31,8 +31,15 @@ module RuboCop
         MSG = 'lambda without a literal block is deprecated; use the proc without lambda instead.'
         RESTRICT_ON_SEND = %i[lambda].freeze
 
+        # @!method lambda_with_symbol_proc?(node)
+        def_node_matcher :lambda_with_symbol_proc?, <<~PATTERN
+          (send nil? :lambda (block_pass (sym _)))
+        PATTERN
+
         def on_send(node)
-          return if node.parent&.block_type? || !node.first_argument
+          if node.parent&.block_type? || !node.first_argument || lambda_with_symbol_proc?(node)
+            return
+          end
 
           add_offense(node) do |corrector|
             corrector.replace(node, node.first_argument.source.delete('&'))

data/lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb

@@ -19,7 +19,7 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
-        MSG = '`(...)` interpreted as grouped expression.'
+        MSG = '`%<argument>s` interpreted as grouped expression.'
 
         def on_send(node)
           return if valid_context?(node)
@@ -28,8 +28,9 @@ module RuboCop
           return unless space_length.positive?
 
           range = space_range(node.first_argument.source_range, space_length)
+          message = format(MSG, argument: node.first_argument.source)
 
-          add_offense(range) { |corrector| corrector.remove(range) }
+          add_offense(range, message: message) { |corrector| corrector.remove(range) }
         end
         alias on_csend on_send
 

data/lib/rubocop/cop/lint/redundant_dir_glob_sort.rb

@@ -6,6 +6,11 @@ module RuboCop
       # Sort globbed results by default in Ruby 3.0.
       # This cop checks for redundant `sort` method to `Dir.glob` and `Dir[]`.
       #
+      # @safety
+      #   This cop is unsafe, in case of having a file and a directory with
+      #   identical names, since directory will be loaded before the file, which
+      #   will break `exe/files.rb` that rely on `exe.rb` file.
+      #
       # @example
       #
       #   # bad