rubocop 1.77.0 → 1.79.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 871a632c96e6a5c92e57b651037eaf7efd7412e64ac77440d5275027ef791d4e
-  data.tar.gz: f375ec6479b1f90193cd39e863411707d60cd071e170888005339d89a19ea65b
+  metadata.gz: 5919779b3b5bcc30656adbfd28f00fc821327d6ecf4abff825eea32150319aef
+  data.tar.gz: d94231324f779e1f99469dc032b762825a761bc0a3ed85e44f34ae3fdc4ea78a
 SHA512:
-  metadata.gz: f8dac3eb5cb12741c110c8726ec64595cefb89700527144cc590d7febb676164e3902dff171594278f7895d1c3df336dea3e14f869d285a0c7080b1467bd6362
-  data.tar.gz: 4aadc7a712774810e1815f4f31bea43fc6d9e121a547621f57894c7df848a6459dfc962af0fb725f4fef6e2017b6a499c203cc05a4d2879d0e50aceaee156b95
+  metadata.gz: fff3036cd812063f449fc41c2e1b536c6735fd1e85742692a5f710769a619b2eab1c5800180744b748ab3ba37fe1f4e6c64dd8edf9d4a9abc2f426bf89b47091
+  data.tar.gz: d174e5c8d47b012a591bd59292411c2e23927d378c88362bf1f77427b6bf92230f1f95417e7f2ec44454d78bbfe41bf40fd7e7c07add9047beda6655d307e7ed

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

data/config/default.yml

@@ -378,7 +378,7 @@ Gemspec/RubyVersionGlobalsUsage:
 #################### Layout ###########################
 
 Layout/AccessModifierIndentation:
-  Description: Check indentation of private/protected visibility modifiers.
+  Description: Checks indentation of private/protected visibility modifiers.
   StyleGuide: '#indent-public-private-protected'
   Enabled: true
   VersionAdded: '0.49'
@@ -638,6 +638,12 @@ Layout/EmptyLines:
   Enabled: true
   VersionAdded: '0.49'
 
+Layout/EmptyLinesAfterModuleInclusion:
+  Description: 'Keeps track of empty lines after module inclusion methods.'
+  StyleGuide: '#empty-lines-after-module-inclusion'
+  Enabled: pending
+  VersionAdded: '1.79'
+
 Layout/EmptyLinesAroundAccessModifier:
   Description: "Keep blank lines around access modifiers."
   StyleGuide: '#empty-lines-around-access-modifier'
@@ -1051,7 +1057,7 @@ Layout/LeadingCommentSpace:
   AllowSteepAnnotation: false
 
 Layout/LeadingEmptyLines:
-  Description: Check for unnecessary blank lines at the beginning of a file.
+  Description: Checks for unnecessary blank lines at the beginning of a file.
   Enabled: true
   VersionAdded: '0.57'
   VersionChanged: '0.77'
@@ -1141,7 +1147,7 @@ Layout/MultilineArrayLineBreaks:
   AllowMultilineFinalElement: false
 
 Layout/MultilineAssignmentLayout:
-  Description: 'Check for a newline after the assignment operator in multi-line assignments.'
+  Description: 'Checks for a newline after the assignment operator in multi-line assignments.'
   StyleGuide: '#indent-conditional-assignment'
   Enabled: false
   VersionAdded: '0.49'
@@ -1655,7 +1661,7 @@ Lint/BinaryOperatorWithIdenticalOperands:
   VersionChanged: '1.69'
 
 Lint/BooleanSymbol:
-  Description: 'Check for `:true` and `:false` symbols.'
+  Description: 'Checks for `:true` and `:false` symbols.'
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: '0.50'
@@ -1688,7 +1694,7 @@ Lint/ConstantReassignment:
   VersionAdded: '1.70'
 
 Lint/ConstantResolution:
-  Description: 'Check that constants are fully qualified with `::`.'
+  Description: 'Checks that constants are fully qualified with `::`.'
   Enabled: false
   VersionAdded: '0.86'
   # Restrict this cop to only looking at certain names
@@ -1702,7 +1708,7 @@ Lint/CopDirectiveSyntax:
   VersionAdded: '1.72'
 
 Lint/Debugger:
-  Description: 'Check for debugger calls.'
+  Description: 'Checks for debugger calls.'
   Enabled: true
   VersionAdded: '0.14'
   VersionChanged: '1.63'
@@ -1753,7 +1759,7 @@ Lint/Debugger:
       - debug/start
 
 Lint/DeprecatedClassMethods:
-  Description: 'Check for deprecated class method calls.'
+  Description: 'Checks for deprecated class method calls.'
   Enabled: true
   VersionAdded: '0.19'
 
@@ -1827,13 +1833,13 @@ Lint/DuplicateElsifCondition:
   VersionAdded: '0.88'
 
 Lint/DuplicateHashKey:
-  Description: 'Check for duplicate keys in hash literals.'
+  Description: 'Checks for duplicate keys in hash literals.'
   Enabled: true
   VersionAdded: '0.34'
   VersionChanged: '0.77'
 
 Lint/DuplicateMagicComment:
-  Description: 'Check for duplicated magic comments.'
+  Description: 'Checks for duplicated magic comments.'
   Enabled: pending
   VersionAdded: '1.37'
 
@@ -1843,7 +1849,7 @@ Lint/DuplicateMatchPattern:
   VersionAdded: '1.50'
 
 Lint/DuplicateMethods:
-  Description: 'Check for duplicate method definitions.'
+  Description: 'Checks for duplicate method definitions.'
   Enabled: true
   VersionAdded: '0.29'
 
@@ -1853,7 +1859,7 @@ Lint/DuplicateRegexpCharacterClassElement:
   VersionAdded: '1.1'
 
 Lint/DuplicateRequire:
-  Description: 'Check for duplicate `require`s and `require_relative`s.'
+  Description: 'Checks for duplicate `require`s and `require_relative`s.'
   Enabled: true
   SafeAutoCorrect: false
   VersionAdded: '0.90'
@@ -1870,12 +1876,12 @@ Lint/DuplicateSetElement:
   VersionAdded: '1.67'
 
 Lint/EachWithObjectArgument:
-  Description: 'Check for immutable argument given to each_with_object.'
+  Description: 'Checks for immutable argument given to each_with_object.'
   Enabled: true
   VersionAdded: '0.31'
 
 Lint/ElseLayout:
-  Description: 'Check for odd code arrangement in an else block.'
+  Description: 'Checks for odd code arrangement in an else block.'
   Enabled: true
   VersionAdded: '0.17'
   VersionChanged: '1.2'
@@ -2278,6 +2284,7 @@ Lint/RedundantSafeNavigation:
   Description: 'Checks for redundant safe navigation calls.'
   Enabled: true
   VersionAdded: '0.93'
+  VersionChanged: '1.79'
   AllowedMethods:
     - instance_of?
     - kind_of?
@@ -2285,6 +2292,12 @@ Lint/RedundantSafeNavigation:
     - eql?
     - respond_to?
     - equal?
+  InferNonNilReceiver: false
+  AdditionalNilMethods:
+    - present?
+    - blank?
+    - try
+    - try!
   Safe: false
 
 Lint/RedundantSplatExpansion:
@@ -2817,7 +2830,7 @@ Migration/DepartmentName:
 #################### Naming ##############################
 
 Naming/AccessorMethodName:
-  Description: Check the naming of accessor methods for get_/set_.
+  Description: Checks the naming of accessor methods for get_/set_.
   StyleGuide: '#accessor_mutator_method_names'
   Enabled: true
   VersionAdded: '0.50'
@@ -3072,7 +3085,7 @@ Naming/PredicateMethod:
   Description: 'Checks that predicate methods end with `?` and non-predicate methods do not.'
   Enabled: pending
   VersionAdded: '1.76'
-  VersionChanged: '1.76'
+  VersionChanged: '1.78'
   # In `aggressive` mode, the cop will register an offense for predicate methods that
   #   may return a non-boolean value.
   # In `conservative` mode, the cop will *not* register an offense for predicate methods
@@ -3082,6 +3095,9 @@ Naming/PredicateMethod:
     - call
   AllowedPatterns: []
   AllowBangMethods: false
+  # Methods that are known to not return a boolean value, despite ending in `?`.
+  WaywardPredicates:
+    - nonzero?
 
 Naming/PredicatePrefix:
   Description: 'Predicate method names should not be prefixed and end with a `?`.'
@@ -4221,7 +4237,7 @@ Style/GlobalVars:
   AllowedVariables: []
 
 Style/GuardClause:
-  Description: 'Check for conditionals that can be replaced with guard clauses.'
+  Description: 'Checks for conditionals that can be replaced with guard clauses.'
   StyleGuide: '#no-nested-conditionals'
   Enabled: true
   VersionAdded: '0.20'
@@ -4483,7 +4499,7 @@ Style/IpAddresses:
     - '**/*.gemspec'
 
 Style/ItAssignment:
-  Description: 'Checks for assignment to `it` inside a block.'
+  Description: 'Checks for local variables and method parameters named `it`.'
   Enabled: pending
   VersionAdded: '1.70'
 
@@ -5184,7 +5200,7 @@ Style/RandomWithOffset:
   VersionAdded: '0.52'
 
 Style/RedundantArgument:
-  Description: 'Check for a redundant argument passed to certain methods.'
+  Description: 'Checks for a redundant argument passed to certain methods.'
   Enabled: pending
   Safe: false
   VersionAdded: '1.4'
@@ -5345,7 +5361,7 @@ Style/RedundantInterpolationUnfreeze:
   VersionAdded: '1.66'
 
 Style/RedundantLineContinuation:
-  Description: 'Check for redundant line continuation.'
+  Description: 'Checks for redundant line continuation.'
   Enabled: pending
   VersionAdded: '1.49'
 
@@ -5639,7 +5655,7 @@ Style/SpecialGlobalVars:
     - use_builtin_english_names
 
 Style/StabbyLambdaParentheses:
-  Description: 'Check for the usage of parentheses around stabby lambda arguments.'
+  Description: 'Checks for the usage of parentheses around stabby lambda arguments.'
   StyleGuide: '#stabby-lambda-with-args'
   Enabled: true
   VersionAdded: '0.35'

data/lib/rubocop/cli.rb

@@ -12,7 +12,7 @@ module RuboCop
     STATUS_INTERRUPTED = Signal.list['INT'] + 128
     DEFAULT_PARALLEL_OPTIONS = %i[
       color config debug display_style_guide display_time display_only_fail_level_offenses
-      display_only_failed editor_mode except extra_details fail_level fix_layout format
+      display_only_failed editor_mode except extra_details fail_level fix_layout format formatters
       ignore_disable_comments lint only only_guide_cops require safe
       autocorrect safe_autocorrect autocorrect_all
     ].freeze
@@ -48,6 +48,7 @@ module RuboCop
           validate_options_vs_config
           parallel_by_default!
           apply_default_formatter
+          report_pending_cops
           execute_runners
         end
       end
@@ -155,6 +156,7 @@ module RuboCop
 
     def act_on_options
       set_options_to_config_loader
+      set_options_to_pending_cops_reporter
       handle_editor_mode
 
       @config_store.options_config = @options[:config] if @options[:config]
@@ -179,6 +181,11 @@ module RuboCop
       ConfigLoader.ignore_unrecognized_cops = @options[:ignore_unrecognized_cops]
     end
 
+    def set_options_to_pending_cops_reporter
+      PendingCopsReporter.disable_pending_cops = @options[:disable_pending_cops]
+      PendingCopsReporter.enable_pending_cops = @options[:enable_pending_cops]
+    end
+
     def handle_editor_mode
       RuboCop::LSP.enable if @options[:editor_mode]
     end
@@ -208,5 +215,9 @@ module RuboCop
         [[formatter, @options[:output_path]]]
       end
     end
+
+    def report_pending_cops
+      PendingCopsReporter.warn_if_needed(@config_store.for_pwd)
+    end
   end
 end

data/lib/rubocop/config_loader.rb

@@ -22,14 +22,6 @@ module RuboCop
     class << self
       include FileFinder
 
-      PENDING_BANNER = <<~BANNER
-        The following cops were added to RuboCop, but are not configured. Please set Enabled to either `true` or `false` in your `.rubocop.yml` file.
-
-        Please also note that you can opt-in to new cops by default by adding this to your config:
-          AllCops:
-            NewCops: enable
-      BANNER
-
       attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
                     :ignore_unrecognized_cops
       attr_writer :default_configuration
@@ -132,21 +124,7 @@ module RuboCop
           add_excludes_from_files(config, config_file)
         end
 
-        merge_with_default(config, config_file).tap do |merged_config|
-          unless possible_new_cops?(merged_config)
-            pending_cops = pending_cops_only_qualified(merged_config.pending_cops)
-            warn_on_pending_cops(pending_cops) unless pending_cops.empty?
-          end
-        end
-      end
-
-      def pending_cops_only_qualified(pending_cops)
-        pending_cops.select { |cop| Cop::Registry.qualified_cop?(cop.name) }
-      end
-
-      def possible_new_cops?(config)
-        disable_pending_cops || enable_pending_cops ||
-          config.disabled_new_cops? || config.enabled_new_cops?
+        merge_with_default(config, config_file)
       end
 
       def add_excludes_from_files(config, config_file)
@@ -208,21 +186,6 @@ module RuboCop
         ConfigFinder.project_root
       end
 
-      def warn_on_pending_cops(pending_cops)
-        warn Rainbow(PENDING_BANNER).yellow
-
-        pending_cops.each { |cop| warn_pending_cop cop }
-
-        warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
-      end
-
-      def warn_pending_cop(cop)
-        version = cop.metadata['VersionAdded'] || 'N/A'
-
-        warn Rainbow("#{cop.name}: # new in #{version}").yellow
-        warn Rainbow('  Enabled: true').yellow
-      end
-
       # Merges the given configuration with the default one.
       def merge_with_default(config, config_file, unset_nil: true)
         resolver.merge_with_default(config, config_file, unset_nil: unset_nil)

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

@@ -46,7 +46,7 @@ module RuboCop
           /\A(does not|doesn't) (register|find|flag|report)/ => 'registers',
           /\A(does not|doesn't) add (a|an|any )?offense/ => 'registers an offense',
           /\Aregisters no offense/ => 'registers an offense',
-          /\A(accepts|register)\b/ => 'registers'
+          /\A(accepts|allows|register)\b/ => 'registers'
         }.freeze
 
         EXPECT_NO_CORRECTIONS_DESCRIPTION_MAPPING = {

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

@@ -66,8 +66,9 @@ module RuboCop
         end
 
         def autocorrect_to_explicit_predicate(corrector, node, group_name)
-          corrector.replace(node.selector, "#{group_name}_type?")
-          corrector.remove(arguments_range(node))
+          range = node.loc.selector.begin.join(node.source_range.end)
+
+          corrector.replace(range, "#{group_name}_type?")
         end
 
         def autocorrect_keep_method(corrector, symbol_args, group_name, group_types)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module InternalAffairs
-      # Check for useless `RESTRICT_ON_SEND`.
+      # Checks for useless `RESTRICT_ON_SEND`.
       #
       # @example
       #   # bad

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # Checks for an empty line after a module inclusion method (`extend`,
+      # `include` and `prepend`), or a group of them.
+      #
+      # @example
+      #   # bad
+      #   class Foo
+      #     include Bar
+      #     attr_reader :baz
+      #   end
+      #
+      #   # good
+      #   class Foo
+      #     include Bar
+      #
+      #     attr_reader :baz
+      #   end
+      #
+      #   # also good - multiple module inclusions grouped together
+      #   class Foo
+      #     extend Bar
+      #     include Baz
+      #     prepend Qux
+      #   end
+      #
+      class EmptyLinesAfterModuleInclusion < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Add an empty line after module inclusion.'
+
+        MODULE_INCLUSION_METHODS = %i[include extend prepend].freeze
+
+        RESTRICT_ON_SEND = MODULE_INCLUSION_METHODS
+
+        def on_send(node)
+          return if node.receiver
+          return if node.parent&.send_type?
+
+          return if next_line_empty_or_enable_directive_comment?(node.last_line)
+
+          next_line_node = next_line_node(node)
+          return unless require_empty_line?(next_line_node)
+
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
+        end
+
+        private
+
+        def autocorrect(corrector, node)
+          node_range = range_by_whole_lines(node.source_range)
+
+          next_line = node_range.last_line + 1
+          if enable_directive_comment?(next_line)
+            node_range = processed_source.comment_at_line(next_line)
+          end
+
+          corrector.insert_after(node_range, "\n")
+        end
+
+        def next_line_empty_or_enable_directive_comment?(line)
+          line_empty?(line) || (enable_directive_comment?(line + 1) && line_empty?(line + 1))
+        end
+
+        def enable_directive_comment?(line)
+          return false unless (comment = processed_source.comment_at_line(line))
+
+          DirectiveComment.new(comment).enabled?
+        end
+
+        def line_empty?(line)
+          processed_source[line].nil? || processed_source[line].blank?
+        end
+
+        def require_empty_line?(node)
+          return false unless node
+
+          !allowed_method?(node)
+        end
+
+        def allowed_method?(node)
+          return false unless node.send_type?
+
+          MODULE_INCLUSION_METHODS.include?(node.method_name)
+        end
+
+        def next_line_node(node)
+          return if node.parent.if_type?
+
+          node.right_sibling
+        end
+      end
+    end
+  end
+end

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

@@ -16,6 +16,8 @@ module RuboCop
       #
       #   something = 123if test
       #
+      #   return(foo + bar)
+      #
       #   # good
       #   something 'test' do |x|
       #   end
@@ -24,6 +26,9 @@ module RuboCop
       #   end
       #
       #   something = 123 if test
+      #
+      #   return (foo + bar)
+      #
       class SpaceAroundKeyword < Base
         extend AutoCorrector
 
@@ -33,7 +38,7 @@ module RuboCop
         DO = 'do'
         SAFE_NAVIGATION = '&.'
         NAMESPACE_OPERATOR = '::'
-        ACCEPT_LEFT_PAREN = %w[break defined? next not rescue return super yield].freeze
+        ACCEPT_LEFT_PAREN = %w[break defined? next not rescue super yield].freeze
         ACCEPT_LEFT_SQUARE_BRACKET = %w[super yield].freeze
         ACCEPT_NAMESPACE_OPERATOR = 'super'
         RESTRICT_ON_SEND = %i[!].freeze

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

@@ -151,6 +151,14 @@ module RuboCop
           check_operator(:match_pattern, node.loc.operator, node)
         end
 
+        def on_match_alt(node)
+          check_operator(:match_alt, node.loc.operator, node)
+        end
+
+        def on_match_as(node)
+          check_operator(:match_as, node.loc.operator, node)
+        end
+
         alias on_or       on_binary
         alias on_and      on_binary
         alias on_lvasgn   on_assignment

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

@@ -6,6 +6,10 @@ module RuboCop
       # Checks for duplicated instance (or singleton) method
       # definitions.
       #
+      # NOTE: Aliasing a method to itself is allowed, as it indicates that
+      # the developer intends to suppress Ruby's method redefinition warnings.
+      # See https://bugs.ruby-lang.org/issues/13574.
+      #
       # @example
       #
       #   # bad
@@ -40,6 +44,18 @@ module RuboCop
       #
       #   alias bar foo
       #
+      #   # good
+      #   alias foo foo
+      #   def foo
+      #     1
+      #   end
+      #
+      #   # good
+      #   alias_method :foo, :foo
+      #   def foo
+      #     1
+      #   end
+      #
       # @example AllCops:ActiveSupportExtensionsEnabled: false (default)
       #
       #   # good
@@ -113,11 +129,13 @@ module RuboCop
 
         # @!method method_alias?(node)
         def_node_matcher :method_alias?, <<~PATTERN
-          (alias (sym $_name) sym)
+          (alias (sym $_name) (sym $_original_name))
         PATTERN
 
         def on_alias(node)
-          return unless (name = method_alias?(node))
+          name, original_name = method_alias?(node)
+          return unless name && original_name
+          return if name == original_name
           return if node.ancestors.any?(&:if_type?)
 
           found_instance_method(node, name)
@@ -125,7 +143,7 @@ module RuboCop
 
         # @!method alias_method?(node)
         def_node_matcher :alias_method?, <<~PATTERN
-          (send nil? :alias_method (sym $_name) _)
+          (send nil? :alias_method (sym $_name) (sym $_original_name))
         PATTERN
 
         # @!method delegate_method?(node)
@@ -140,7 +158,10 @@ module RuboCop
         def_node_matcher :sym_name, '(sym $_name)'
 
         def on_send(node) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-          if (name = alias_method?(node))
+          name, original_name = alias_method?(node)
+
+          if name && original_name
+            return if name == original_name
             return if node.ancestors.any?(&:if_type?)
 
             found_instance_method(node, name)

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

@@ -123,7 +123,9 @@ module RuboCop
         # rubocop:enable Metrics/AbcSize
 
         def on_case(case_node)
-          if case_node.condition
+          if (cond = case_node.condition)
+            return if !cond.falsey_literal? && !cond.truthy_literal?
+
             check_case(case_node)
           else
             case_node.when_branches.each do |when_node|

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

@@ -45,6 +45,7 @@ module RuboCop
       #
       class NumericOperationWithConstantResult < Base
         extend AutoCorrector
+
         MSG = 'Numeric operation with a constant result detected.'
         RESTRICT_ON_SEND = %i[* / **].freeze