rubocop 1.68.0 → 1.69.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f0623068e9eac24fe4b1f5c7e4987d3a8adc7a2ec7f5f65c6cfb9d0ad9d1278
-  data.tar.gz: 9abb03dde6881cb7c11a21ee947c33a7d8874b9893f81e81cd7617f52f1bb714
+  metadata.gz: 8ab30572529c057731f5ebd7548808a1aa9f588f75a45ec0d41ecec2dbbc8015
+  data.tar.gz: 9beff10b3b9361a9ffc58c0da4920c9c7c7d1caa09e813ea96c46cd7f01683a4
 SHA512:
-  metadata.gz: 3392244d7137845de4f7c9867695350666750b349879ac4796590d090b0b1a182f21fb9c96f6d284bfd9eaf21a7594f8b7de2d59da62458400a709430bb6f7a2
-  data.tar.gz: e2a5a3dd61755c091a91ea99828846fa875b3b7ca8ffaea67425245755e147159691c587a7a80089a428480b7ad07fef8da1be7dc209ac0a60bb46cff3a37d0f
+  metadata.gz: a1fdca8813de85e849ba3ff5266c589b74986984192247fc53c541c81475ae672788a663444070fc5428cbfd1024de7cccc9ac7924fe0dab8e138069b3f6b8f7
+  data.tar.gz: 7896834ccaa34e897da918b457b7ab2c738e21b474536144ddbaf71af2d5ae1e829fdeb699701323f6c67d85cb7b2fb1adcc21f3fde1683cb6273387cd390ba2

data/README.md

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

data/config/default.yml

@@ -1086,11 +1086,11 @@ Layout/LineLength:
   StyleGuide: '#max-line-length'
   Enabled: true
   VersionAdded: '0.25'
-  VersionChanged: '1.4'
+  VersionChanged: '1.69'
   Max: 120
+  AllowHeredoc: true
   # To make it possible to copy or click on URIs in the code, we allow lines
   # containing a URI to be longer than Max.
-  AllowHeredoc: true
   AllowURI: true
   URISchemes:
     - http
@@ -1102,6 +1102,8 @@ 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: []
+  # If SplitStrings is true, long strings will be split using continuations
+  SplitStrings: false
 
 Layout/MultilineArrayBraceLayout:
   Description: >-
@@ -1499,7 +1501,6 @@ Layout/SpaceInsideHashLiteralBraces:
     - space
     - no_space
 
-
 Layout/SpaceInsideParens:
   Description: 'No spaces after ( or before ).'
   StyleGuide: '#spaces-braces'
@@ -1634,7 +1635,7 @@ Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: true
   Safe: false
   VersionAdded: '0.89'
-  VersionChanged: '1.7'
+  VersionChanged: '1.69'
 
 Lint/BooleanSymbol:
   Description: 'Check for `:true` and `:false` symbols.'
@@ -1956,6 +1957,11 @@ Lint/HashCompareByIdentity:
   Safe: false
   VersionAdded: '0.93'
 
+Lint/HashNewWithKeywordArgumentsAsDefault:
+  Description: 'Checks for the deprecated use of keyword arguments for hash default in `Hash.new`.'
+  Enabled: pending
+  VersionAdded: '1.69'
+
 Lint/HeredocMethodCallPosition:
   Description: >-
                  Checks for the ordering of a method call where
@@ -2146,6 +2152,11 @@ Lint/NumberedParameterAssignment:
   Enabled: pending
   VersionAdded: '1.9'
 
+Lint/NumericOperationWithConstantResult:
+  Description: 'Checks for numeric operations with constant results.'
+  Enabled: pending
+  VersionAdded: '1.69'
+
 Lint/OrAssignmentToConstant:
   Description: 'Checks unintended or-assignment to constant.'
   Enabled: pending
@@ -2377,7 +2388,6 @@ Lint/ShadowedArgument:
   VersionAdded: '0.52'
   IgnoreImplicitReferences: false
 
-
 Lint/ShadowedException:
   Description: >-
                   Avoid rescuing a higher level exception
@@ -2521,10 +2531,12 @@ Lint/UnusedMethodArgument:
   Enabled: true
   AutoCorrect: contextual
   VersionAdded: '0.21'
-  VersionChanged: '1.61'
+  VersionChanged: '1.69'
   AllowUnusedKeywordArguments: false
   IgnoreEmptyMethods: true
   IgnoreNotImplementedMethods: true
+  NotImplementedExceptions:
+    - NotImplementedError
 
 Lint/UriEscapeUnescape:
   Description: >-
@@ -2559,6 +2571,11 @@ Lint/UselessAssignment:
   VersionAdded: '0.11'
   VersionChanged: '1.66'
 
+Lint/UselessDefined:
+  Description: 'Checks for calls to `defined?` with strings and symbols. The result of such a call will always be truthy.'
+  Enabled: pending
+  VersionAdded: '1.69'
+
 Lint/UselessElseWithoutRescue:
   Description: 'Checks for useless `else` in `begin..end` without `rescue`.'
   Enabled: true
@@ -3698,6 +3715,12 @@ Style/DefWithParentheses:
   VersionAdded: '0.9'
   VersionChanged: '0.12'
 
+Style/DigChain:
+  Description: 'Use `dig` with multiple parameters instead of chaining multiple calls.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.69'
+
 Style/Dir:
   Description: >-
                  Use the `__dir__` method to retrieve the canonicalized
@@ -3924,12 +3947,24 @@ Style/FileEmpty:
   Safe: false
   VersionAdded: '1.48'
 
+Style/FileNull:
+  Description: 'Use `File::NULL` instead of hardcoding "dev/null".'
+  Enabled: pending
+  SafeAutoCorrect: false
+  VersionAdded: '1.69'
+
 Style/FileRead:
   Description: 'Favor `File.(bin)read` convenience methods.'
   StyleGuide: '#file-read'
   Enabled: pending
   VersionAdded: '1.24'
 
+Style/FileTouch:
+  Description: 'Favor `FileUtils.touch` for touching files.'
+  Enabled: pending
+  VersionAdded: '1.69'
+  SafeAutoCorrect: false
+
 Style/FileWrite:
   Description: 'Favor `File.(bin)write` convenience methods.'
   StyleGuide: '#file-write'

data/lib/rubocop/cop/base.rb

@@ -60,7 +60,7 @@ module RuboCop
         []
       end
 
-      # Returns an url to view this cops documentation online.
+      # Returns a url to view this cops documentation online.
       # Requires 'DocumentationBaseURL' to be set for your department.
       # Will follow the convention of RuboCops own documentation structure,
       # overwrite this method to accommodate your custom layout.

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

@@ -27,7 +27,6 @@ module RuboCop
       #   Project contains gems.rb and gems.locked files
       class GemFilename < Base
         include ConfigurableEnforcedStyle
-        include RangeHelp
 
         MSG_GEMFILE_REQUIRED = '`gems.rb` file was found but `Gemfile` is required ' \
                                '(file path: %<file_path>s).'

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

@@ -39,7 +39,6 @@ module RuboCop
       #   source 'http://rubygems.org'
       #
       class InsecureProtocolSource < Base
-        include RangeHelp
         extend AutoCorrector
 
         MSG = 'The source `:%<source>s` is deprecated because HTTP requests ' \

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

@@ -39,7 +39,7 @@ module RuboCop
       def requires_parentheses?
         return true if collection_node.send_type? && collection_node.operator_method?
 
-        collection_node.range_type? || collection_node.or_type? || collection_node.and_type?
+        collection_node.range_type? || collection_node.operator_keyword?
       end
 
       def end_range

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

@@ -62,8 +62,7 @@ module RuboCop
 
         def node_and_method_name(node, attribute)
           if node.op_asgn_type?
-            lhs, _op, _rhs = *node
-            [lhs, attribute]
+            [node.lhs, attribute]
           else
             [node, :"#{attribute}="]
           end

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

@@ -53,8 +53,6 @@ module RuboCop
       #     spec.required_ruby_version = '~> 2.5'
       #   end
       class RequiredRubyVersion < Base
-        include RangeHelp
-
         RESTRICT_ON_SEND = %i[required_ruby_version=].freeze
         NOT_EQUAL_MSG = '`required_ruby_version` and `TargetRubyVersion` ' \
                         '(%<target_ruby_version>s, which may be specified in ' \

data/lib/rubocop/cop/generator.rb

@@ -71,11 +71,17 @@ module RuboCop
                   (send nil? :bad_method ...)
                 PATTERN
 
+                # Called on every `send` node (method call) while walking the AST.
+                # TODO: remove this method if inspecting `send` nodes is unneeded for your cop.
+                # By default, this is aliased to `on_csend` as well to handle method calls
+                # with safe navigation, remove the alias if this is unnecessary.
+                # If kept, ensure your tests cover safe navigation as well!
                 def on_send(node)
                   return unless bad_method?(node)
 
                   add_offense(node)
                 end
+                alias on_csend on_send
               end
             end
           end

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

@@ -19,6 +19,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Use `%<preferred>s`.'
+        RESTRICT_ON_SEND = [:==].freeze
 
         # @!method line_send(node)
         def_node_matcher :line_send, <<~PATTERN
@@ -36,10 +37,8 @@ module RuboCop
         def on_send(node)
           return unless location_line_equality_comparison?(node)
 
-          lhs, _op, rhs = *node
-
-          lhs_receiver = extract_receiver(lhs)
-          rhs_receiver = extract_receiver(rhs)
+          lhs_receiver = extract_receiver(node.receiver)
+          rhs_receiver = extract_receiver(node.first_argument)
           preferred = "same_line?(#{lhs_receiver}, #{rhs_receiver})"
 
           add_offense(node, message: format(MSG, preferred: preferred)) do |corrector|

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module InternalAffairs
-      # Checks for missing `numblock handlers. The blocks with numbered
+      # Checks for missing `numblock` handlers. The blocks with numbered
       # arguments introduced in Ruby 2.7 are parsed with a node type of
       # `numblock` instead of block. Cops that define `block` handlers
       # need to define `numblock` handlers or disable this cope for them.

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # Enforces the use of `node.operator_keyword?` instead of `node.and_type? || node.or_type?`.
+      #
+      # @example
+      #   # bad
+      #   node.and_type? || node.or_type?
+      #   node.or_type? || node.and_type?
+      #
+      #   # good
+      #   node.operator_keyword?
+      #
+      class OperatorKeyword < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<prefer>s`.'
+
+        # @!method and_or_type(node)
+        def_node_matcher :and_or_type, <<~PATTERN
+          {
+            (or $(send _node :and_type?) $(send _node :or_type?))
+            (or $(send _node :or_type?) $(send _node :and_type?))
+            (or
+              (or _ $(send _node :and_type?)) $(send _node :or_type?))
+            (or
+              (or _ $(send _node :or_type?)) $(send _node :and_type?))
+          }
+        PATTERN
+
+        def on_or(node)
+          return unless (lhs, rhs = and_or_type(node))
+
+          offense = lhs.receiver.source_range.join(rhs.source_range.end)
+          prefer = "#{lhs.receiver.source}.operator_keyword?"
+
+          add_offense(offense, message: format(MSG, prefer: prefer)) do |corrector|
+            corrector.replace(offense, prefer)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -50,8 +50,6 @@ module RuboCop
       #   end
       #
       class StyleDetectedApiUse < Base
-        include RangeHelp
-
         MSG_FOR_POSITIVE_WITHOUT_NEGATIVE =
           '`correct_style_detected` method called without ' \
           'calling a negative `*_style_detected` method.'

data/lib/rubocop/cop/internal_affairs.rb

@@ -17,6 +17,7 @@ require_relative 'internal_affairs/node_matcher_directive'
 require_relative 'internal_affairs/node_type_predicate'
 require_relative 'internal_affairs/numblock_handler'
 require_relative 'internal_affairs/offense_location_keyword'
+require_relative 'internal_affairs/operator_keyword'
 require_relative 'internal_affairs/processed_source_buffer_name'
 require_relative 'internal_affairs/redundant_context_config_parameter'
 require_relative 'internal_affairs/redundant_described_class_as_subject'

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

@@ -3,8 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # Here we check if the arguments on a multi-line method
-      # definition are aligned.
+      # Check that the arguments on a multi-line method definition are aligned.
       #
       # @example EnforcedStyle: with_first_argument (default)
       #   # good

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Layout
-      # Here we check if the elements of a multi-line array literal are
+      # Check that the elements of a multi-line array literal are
       # aligned.
       #
       # @example EnforcedStyle: with_first_element (default)

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

@@ -40,7 +40,6 @@ module RuboCop
       #
       class BeginEndAlignment < Base
         include EndKeywordAlignment
-        include RangeHelp
         extend AutoCorrector
 
         MSG = '`end` at %d, %d is not aligned with `%s` at %d, %d.'

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

@@ -127,7 +127,6 @@ module RuboCop
                              start_loc,
                              end_loc,
                              do_source_line_column)
-
           error_source_line_column = if style == :start_of_block
                                        do_source_line_column
                                      else
@@ -189,7 +188,7 @@ module RuboCop
         # In offense message, we want to show the assignment LHS rather than
         # the entire assignment.
         def find_lhs_node(node)
-          node, = *node while node.op_asgn_type? || node.masgn_type?
+          node = node.lhs while node.op_asgn_type? || node.masgn_type?
           node
         end
 

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

@@ -200,7 +200,7 @@ module RuboCop
           parent = node.parent
           return false unless parent
 
-          parent.begin_type? && parent.single_line?
+          parent.begin_type? && same_line?(node, node.right_sibling)
         end
 
         # SimpleCov excludes code from the coverage report by wrapping it in `# :nocov:`:

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

@@ -84,9 +84,8 @@ module RuboCop
 
         alias on_numblock on_block
 
-        def on_send(node) # rubocop:disable Metrics/CyclomaticComplexity
-          return unless node.bare_access_modifier? &&
-                        !(node.parent&.block_type? || node.parent&.numblock_type?)
+        def on_send(node)
+          return unless node.bare_access_modifier? && !node.block_literal?
           return if expected_empty_lines?(node)
 
           message = message(node)

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

@@ -72,8 +72,7 @@ module RuboCop
         alias on_numblock on_def
 
         def on_kwbegin(node)
-          body, = *node
-          check_body(body, node.loc.line)
+          check_body(node.children.first, node.loc.line)
         end
 
         private
@@ -128,10 +127,10 @@ module RuboCop
         end
 
         def keyword_locations_in_ensure(node)
-          ensure_body, = *node
+          rescue_body_without_ensure = node.children.first
           [
             node.loc.keyword,
-            *keyword_locations(ensure_body)
+            *keyword_locations(rescue_body_without_ensure)
           ]
         end
       end

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

@@ -27,7 +27,9 @@ module RuboCop
         KIND = 'method'
 
         def on_def(node)
-          check(node, node.body)
+          first_line = node.arguments.source_range&.last_line
+
+          check(node, node.body, adjusted_first_line: first_line)
         end
         alias on_defs on_def
 

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

@@ -58,16 +58,17 @@ module RuboCop
         PATTERN
 
         def on_rescue(node)
-          _begin_node, *_rescue_nodes, else_node = *node
-          check_indentation(node.loc.else, else_node)
+          check_indentation(node.loc.else, node.else_branch)
         end
 
-        def on_ensure(node)
+        def on_resbody(node)
           check_indentation(node.loc.keyword, node.body)
         end
+        alias on_for on_resbody
 
-        alias on_resbody on_ensure
-        alias on_for     on_ensure
+        def on_ensure(node)
+          check_indentation(node.loc.keyword, node.branch)
+        end
 
         def on_kwbegin(node)
           # Check indentation against end keyword but only if it's first on its
@@ -325,8 +326,7 @@ module RuboCop
           if body_node.rescue_type?
             check_rescue?(body_node)
           elsif body_node.ensure_type?
-            block_body, = *body_node
-
+            block_body, = *body_node # rubocop:disable InternalAffairs/NodeDestructuring
             if block_body&.rescue_type?
               check_rescue?(block_body)
             else

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

@@ -96,6 +96,7 @@ module RuboCop
           processed_source.comments.each do |comment|
             next unless /\A(?!#\+\+|#--)(#+[^#\s=])/.match?(comment.text)
             next if comment.loc.line == 1 && allowed_on_first_line?(comment)
+            next if shebang_continuation?(comment)
             next if doxygen_comment_style?(comment)
             next if gemfile_ruby_comment?(comment)
             next if rbs_inline_annotation?(comment)
@@ -123,6 +124,20 @@ module RuboCop
           comment.text.start_with?('#!')
         end
 
+        def shebang_continuation?(comment)
+          return false unless shebang?(comment)
+          return true if comment.loc.line == 1
+
+          previous_line_comment = processed_source.comment_at_line(comment.loc.line - 1)
+          return false unless previous_line_comment
+
+          # If the comment is a shebang but not on the first line, check if the previous
+          # line has a shebang comment that wasn't marked as an offense; if so, this comment
+          # continues the shebang and is acceptable.
+          shebang?(previous_line_comment) &&
+            !current_offense_locations.include?(previous_line_comment.source_range)
+        end
+
         def rackup_options?(comment)
           comment.text.start_with?('#\\')
         end