rubocop 1.74.0 → 1.75.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 440bee0e28f294bab2eba4c11e9c681342917c69ad4c00e36eceb88743767c29
-  data.tar.gz: 68e9e209a22e891a38b677f97344d2d10e9a8913dd999751472f301deed43b31
+  metadata.gz: e806cf86ed67dd63a42a7aa49d9d7078fbc9adbf2445ae4ad078746755aab399
+  data.tar.gz: c987baa5c2b372e4e223f660ee1b703f82c07f9a31a641aa0e53e0b1fb3f85a3
 SHA512:
-  metadata.gz: 70db27a5b7a0e00696672a5b4fcd4e3bf35aa40c85ef65ccb630914ab110a5e5b657927aa1b1c8637be76b7041a90e2ad3c4ed188110266c048d0c4d6a4be0b4
-  data.tar.gz: e5599d30a4f776d85d202acad2ac03c7e4568e64a1c4038cb87b8ee3372b2428882924a91ea49853c98cf0614280d002918363eef41fe0990dc8b1895d8e9776
+  metadata.gz: 8182e7c9d9e1f55ea0c53dfe9c56ff157621384ee399efeea397a2cef82ec83e066c4f7868b498c7dd25cf5072223b6475daeb62fa82520539974f07fbcdbd2e
+  data.tar.gz: fa8b6cb67554bf5da2121ad5005f9d5dca3840cb5416711f38665ac5859f48ef3a4fb165aef554c5ce46d957dcaa315140e77b193162c59ef6f8924bee9e3516

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

data/config/default.yml

@@ -146,12 +146,14 @@ AllCops:
   # Ruby version is still unresolved, RuboCop will use the oldest officially
   # supported Ruby version (currently Ruby 2.7).
   TargetRubyVersion: ~
-  # You can specify the parser engine. There are two options available:
+  # RuboCop choses the parser engine automatically but you can also specify it yourself.
+  # These options are available:
+  # - `default`
   # - `parser_whitequark` ... https://github.com/whitequark/parser
   # - `parser_prism` ... https://github.com/ruby/prism (`Prism::Translation::Parser`)
-  # By default, `parser` is used. For the `TargetRubyVersion` value, `parser` can be specified for versions `2.0` and above.
-  # `parser_prism` can be specified for versions `3.3` and above. `parser_prism` is faster but still considered experimental.
-  ParserEngine: parser_whitequark
+  # Not every parser engine can handle every `TargetRubyVersion`. `parser_whitequark`
+  # only works with versions 3.4 and below, `parser_prism` with versions 3.3 and above.
+  ParserEngine: default
   # Determines if a notification for extension libraries should be shown when
   # rubocop is run. Keys are the name of the extension, and values are an array
   # of gems in the Gemfile that the extension is suggested for, if not already
@@ -2995,6 +2997,7 @@ Naming/MethodName:
   StyleGuide: '#snake-case-symbols-methods-vars'
   Enabled: true
   VersionAdded: '0.50'
+  VersionChanged: '1.75'
   EnforcedStyle: snake_case
   SupportedStyles:
     - snake_case
@@ -3006,6 +3009,10 @@ Naming/MethodName:
   #     - '\A\s*onSelectionCleared\s*'
   #
   AllowedPatterns: []
+  ForbiddenIdentifiers:
+    - __id__
+    - __send__
+  ForbiddenPatterns: []
 
 Naming/MethodParameterName:
   Description: >-
@@ -3042,17 +3049,19 @@ Naming/PredicateName:
   StyleGuide: '#bool-methods-qmark'
   Enabled: true
   VersionAdded: '0.50'
-  VersionChanged: '0.77'
+  VersionChanged: '1.75'
   # Predicate name prefixes.
   NamePrefix:
     - is_
     - has_
     - have_
+    - does_
   # Predicate name prefixes that should be removed.
   ForbiddenPrefixes:
     - is_
     - has_
     - have_
+    - does_
   # Predicate names which, despite having a forbidden prefix, or no `?`,
   # should still be accepted
   AllowedMethods:
@@ -4195,6 +4204,12 @@ Style/HashExcept:
   VersionAdded: '1.7'
   VersionChanged: '1.39'
 
+Style/HashFetchChain:
+  Description: 'Use `Hash#dig` instead of chained `fetch` calls.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.75'
+
 Style/HashLikeCase:
   Description: >-
                   Checks for places where `case-when` represents a simple 1:1
@@ -4405,6 +4420,16 @@ Style/ItAssignment:
   Enabled: pending
   VersionAdded: '1.70'
 
+Style/ItBlockParameter:
+  Description: 'Checks for blocks with one argument where `it` block parameter can be used.'
+  Enabled: pending
+  EnforcedStyle: allow_named_parameter
+  SupportedStyles:
+    - allow_named_parameter
+    - always
+    - disallow
+  VersionAdded: '1.75'
+
 Style/KeywordArgumentsMerging:
   Description: >-
                  When passing an existing hash as keyword arguments, provide additional arguments
@@ -4793,7 +4818,7 @@ Style/Next:
   StyleGuide: '#no-nested-conditionals'
   Enabled: true
   VersionAdded: '0.22'
-  VersionChanged: '0.35'
+  VersionChanged: '1.75'
   # With `always` all conditions at the end of an iteration needs to be
   # replaced by next - with `skip_modifier_ifs` the modifier if like this one
   # are ignored: [1, 2].each { |a| return 'yes' if a == 1 }
@@ -4801,6 +4826,7 @@ Style/Next:
   # `MinBodyLength` defines the number of lines of the a body of an `if` or `unless`
   # needs to have to trigger this cop
   MinBodyLength: 3
+  AllowConsecutiveConditionals: false
   SupportedStyles:
     - skip_modifier_ifs
     - always

data/config/obsoletion.yml

@@ -43,7 +43,9 @@ renamed:
   Style/MethodCallParentheses: Style/MethodCallWithoutArgsParentheses
   Style/MethodName: Naming/MethodName
   Style/OpMethod: Naming/BinaryOperatorParameterName
-  Style/PredicateName: Naming/PredicateName
+  Style/PredicateName:
+    new_name: Naming/PredicateName
+    severity: warning
   Style/SingleSpaceBeforeFirstArg: Layout/SpaceBeforeFirstArg
   Style/UnneededCapitalW: Style/RedundantCapitalW
   Style/UnneededCondition: Style/RedundantCondition

data/lib/rubocop/cli.rb

@@ -52,7 +52,7 @@ module RuboCop
         end
       end
     rescue ConfigNotFoundError, IncorrectCopNameError, OptionArgumentError => e
-      warn e.message
+      warn Rainbow(e.message).red
       STATUS_ERROR
     rescue RuboCop::Error => e
       warn Rainbow("Error: #{e.message}").red

data/lib/rubocop/config.rb

@@ -27,14 +27,43 @@ module RuboCop
       config
     end
 
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def initialize(hash = RuboCop::ConfigLoader.default_configuration, loaded_path = nil)
       @loaded_path = loaded_path
       @for_cop = Hash.new do |h, cop|
         cop_name = cop.respond_to?(:cop_name) ? cop.cop_name : cop
-        qualified_cop_name = Cop::Registry.qualified_cop_name(cop_name, loaded_path)
-        cop_options = self[qualified_cop_name].dup || {}
-        cop_options['Enabled'] = enable_cop?(qualified_cop_name, cop_options)
+
+        if ConfigObsoletion.deprecated_cop_name?(cop)
+          # Since a deprecated cop will no longer have a qualified name (as the badge is no
+          # longer valid), and since we do not want to automatically enable the cop, we just
+          # set the configuration to an empty hash if it is unset.
+          # This is necessary to allow a renamed cop have its old configuration merged in
+          # before being used (which is necessary to allow it to be disabled via config).
+          cop_options = self[cop_name].dup || {}
+        else
+          qualified_cop_name = Cop::Registry.qualified_cop_name(cop_name, loaded_path, warn: false)
+          cop_options = self[qualified_cop_name].dup || {}
+          cop_options['Enabled'] = enable_cop?(qualified_cop_name, cop_options)
+
+          # If the cop has deprecated names (ie. it has been renamed), it is possible that
+          # users will still have old configuration for the cop's old name. In this case,
+          # if `ConfigObsoletion` is configured to warn rather than error (and therefore
+          # RuboCop runs), we want to respect the old configuration, so merge it in.
+          #
+          # NOTE: If there is configuration for both the cop and a deprecated names, the old
+          # configuration will be merged on top of the new configuration!
+          ConfigObsoletion.deprecated_names_for(cop).each do |deprecated_cop_name|
+            deprecated_config = @for_cop[deprecated_cop_name]
+            next if deprecated_config.empty?
+
+            warn Rainbow(<<~WARNING).yellow
+              Warning: Using `#{deprecated_cop_name}` configuration in #{loaded_path} for `#{cop}`.
+            WARNING
+
+            cop_options.merge!(@for_cop[deprecated_cop_name])
+          end
+        end
+
         h[cop] = h[cop_name] = cop_options
       end
       @hash = hash
@@ -43,7 +72,7 @@ module RuboCop
       @badge_config_cache = {}.compare_by_identity
       @clusivity_config_exists_cache = {}
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def loaded_plugins
       @loaded_plugins ||= ConfigLoader.loaded_plugins
@@ -262,7 +291,7 @@ module RuboCop
     end
 
     def parser_engine
-      @parser_engine ||= for_all_cops.fetch('ParserEngine', :parser_whitequark).to_sym
+      @parser_engine ||= for_all_cops.fetch('ParserEngine', :default).to_sym
     end
 
     def target_rails_version

data/lib/rubocop/config_loader.rb

@@ -91,8 +91,12 @@ module RuboCop
       def add_missing_namespaces(path, hash)
         # Using `hash.each_key` will cause the
         # `can't add a new key into hash during iteration` error
+        obsoletion = ConfigObsoletion.new(hash)
+
         hash_keys = hash.keys
         hash_keys.each do |key|
+          next if obsoletion.deprecated_cop_name?(key)
+
           q = Cop::Registry.qualified_cop_name(key, path)
           next if q == key
 

data/lib/rubocop/config_obsoletion/renamed_cop.rb

@@ -6,17 +6,28 @@ module RuboCop
     # a cop or moving it to a new department.
     # @api private
     class RenamedCop < CopRule
-      attr_reader :new_name
+      attr_reader :new_name, :metadata
 
-      def initialize(config, old_name, new_name)
+      def initialize(config, old_name, name_or_hash)
         super(config, old_name)
-        @new_name = new_name
+
+        if name_or_hash.is_a?(Hash)
+          @metadata = name_or_hash
+          @new_name = name_or_hash['new_name']
+        else
+          @metadata = {}
+          @new_name = name_or_hash
+        end
       end
 
       def rule_message
         "The `#{old_name}` cop has been #{verb} to `#{new_name}`."
       end
 
+      def warning?
+        severity == 'warning'
+      end
+
       private
 
       def moved?
@@ -29,6 +40,10 @@ module RuboCop
       def verb
         moved? ? 'moved' : 'renamed'
       end
+
+      def severity
+        metadata['severity']
+      end
     end
   end
 end

data/lib/rubocop/config_obsoletion.rb

@@ -23,9 +23,40 @@ module RuboCop
     class << self
       attr_accessor :files
 
+      def global
+        @global ||= new(Config.new)
+      end
+
+      def reset!
+        @global = nil
+        @deprecated_names = {}
+        LOAD_RULES_CACHE[rules_cache_key] = nil
+      end
+
+      def rules_cache_key
+        files.hash
+      end
+
       def legacy_cop_names
         # Used by DepartmentName#qualified_legacy_cop_name
-        new(Config.new).rules.select(&:cop_rule?).map(&:old_name)
+        global.legacy_cop_names
+      end
+
+      def deprecated_cop_name?(name)
+        global.deprecated_cop_name?(name)
+      end
+
+      def deprecated_names_for(cop)
+        @deprecated_names ||= {}
+        return @deprecated_names[cop] if @deprecated_names.key?(cop)
+
+        @deprecated_names[cop] = global.rules.filter_map do |rule|
+          next unless rule.cop_rule?
+          next unless rule.respond_to?(:new_name)
+          next unless rule.new_name == cop
+
+          rule.old_name
+        end
       end
     end
 
@@ -45,12 +76,21 @@ module RuboCop
       raise ValidationError, messages.join("\n")
     end
 
+    def legacy_cop_names
+      # Used by DepartmentName#qualified_legacy_cop_name
+      cop_rules.map(&:old_name)
+    end
+
+    def deprecated_cop_name?(name)
+      legacy_cop_names.include?(name)
+    end
+
     private
 
     # Default rules for obsoletions are in config/obsoletion.yml
     # Additional rules files can be added with `RuboCop::ConfigObsoletion.files << filename`
     def load_rules # rubocop:disable Metrics/AbcSize
-      rules = LOAD_RULES_CACHE[self.class.files.hash] ||=
+      rules = LOAD_RULES_CACHE[self.class.rules_cache_key] ||=
         self.class.files.each_with_object({}) do |filename, hash|
           hash.merge!(YAML.safe_load(File.read(filename)) || {}) do |_key, first, second|
             case first
@@ -107,5 +147,9 @@ module RuboCop
         rule.message
       end
     end
+
+    def cop_rules
+      rules.select(&:cop_rule?)
+    end
   end
 end

data/lib/rubocop/config_validator.rb

@@ -118,6 +118,7 @@ module RuboCop
       invalid_cop_names.each do |name|
         # There could be a custom cop with this name. If so, don't warn
         next if Cop::Registry.global.contains_cop_matching?([name])
+        next if ConfigObsoletion.deprecated_cop_name?(name)
 
         # Special case for inherit_mode, which is a directive that we keep in
         # the configuration (even though it's not a cop), because it's easier

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

@@ -27,7 +27,7 @@ module RuboCop
         MSG = 'Replace `%<names>s` in node pattern union with `%<replacement>s`.'
         RESTRICT_ON_SEND = %i[def_node_matcher def_node_search].freeze
         NODE_GROUPS = {
-          any_block: %i[block numblock],
+          any_block: %i[block numblock itblock],
           argument: %i[arg optarg restarg kwarg kwoptarg kwrestarg blockarg forward_arg shadowarg],
           boolean: %i[true false],
           call: %i[send csend],

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

@@ -38,23 +38,24 @@ module RuboCop
 
           describe = find_describe_method_node(node)
 
-          unless (exist_config = describe.last_argument.source == ':config')
-            additional_message = ' and specify `:config` in `describe`'
-          end
+          should_append_config = describe && describe.last_argument.source != ':config'
+          additional_message = ' and specify `:config` in `describe`' if should_append_config
 
           message = format(MSG, additional_message: additional_message)
 
           add_offense(node, message: message) do |corrector|
             corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
 
-            corrector.insert_after(describe.last_argument, ', :config') unless exist_config
+            corrector.insert_after(describe.last_argument, ', :config') if should_append_config
           end
         end
 
         private
 
         def find_describe_method_node(block_node)
-          block_node.ancestors.find { |node| node.block_type? && node.method?(:describe) }.send_node
+          block_node.ancestors.find do |node|
+            node.block_type? && node.method?(:describe)
+          end&.send_node
         end
       end
     end

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

@@ -87,6 +87,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         def style_parameter_name
           'EnforcedStyleAlignWith'

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

@@ -43,6 +43,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 

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

@@ -92,7 +92,7 @@ module RuboCop
           case parent.type
           when :def, :defs then base_for_method_definition(parent)
           when :kwbegin then parent.loc.begin
-          when :block, :numblock
+          when :block, :numblock, :itblock
             assignment_node = assignment_node(parent)
             if same_line?(parent, assignment_node)
               assignment_node.source_range

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

@@ -277,7 +277,7 @@ module RuboCop
           case node.type
           when :def, :defs
             :method
-          when :numblock
+          when :numblock, :itblock
             :block
           else
             node.type

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

@@ -83,6 +83,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         def on_send(node)
           return unless node.bare_access_modifier? && !node.block_literal?

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

@@ -34,6 +34,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
       end
     end
   end

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

@@ -91,6 +91,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         def on_class(node)
           base = node.loc.keyword

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

@@ -75,6 +75,7 @@ module RuboCop
           check_for_breakable_block(node)
         end
         alias on_numblock on_block
+        alias on_itblock on_block
 
         def on_str(node)
           check_for_breakable_str(node)
@@ -92,6 +93,7 @@ module RuboCop
         alias on_send on_potential_breakable_node
         alias on_csend on_potential_breakable_node
         alias on_def on_potential_breakable_node
+        alias on_defs on_potential_breakable_node
 
         def on_new_investigation
           return unless processed_source.raw_source.include?(';')
@@ -370,7 +372,9 @@ module RuboCop
 
         def string_delimiter(node)
           delimiter = node.loc.begin
-          delimiter ||= node.parent.loc.begin if node.parent&.dstr_type?
+          if node.parent&.dstr_type? && node.parent.loc.respond_to?(:begin)
+            delimiter ||= node.parent.loc.begin
+          end
           delimiter = delimiter&.source
 
           delimiter if %w[' "].include?(delimiter)

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

@@ -69,6 +69,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 

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

@@ -65,6 +65,7 @@ module RuboCop
 
           check_line_breaks(node, node.arguments, ignore_last: ignore_last_element?)
         end
+        alias on_defs on_def
 
         private
 

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

@@ -6,25 +6,29 @@ module RuboCop
       # Checks whether certain expressions, e.g. method calls, that could fit
       # completely on a single line, are broken up into multiple lines unnecessarily.
       #
-      # @example any configuration
+      # @example
       #   # bad
       #   foo(
       #     a,
       #     b
       #   )
       #
+      #   # good
+      #   foo(a, b)
+      #
+      #   # bad
       #   puts 'string that fits on ' \
       #        'a single line'
       #
+      #   # good
+      #   puts 'string that fits on a single line'
+      #
+      #   # bad
       #   things
       #     .select { |thing| thing.cond? }
       #     .join('-')
       #
       #   # good
-      #   foo(a, b)
-      #
-      #   puts 'string that fits on a single line'
-      #
       #   things.select { |thing| thing.cond? }.join('-')
       #
       # @example InspectBlocks: false (default)

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

@@ -96,7 +96,7 @@ module RuboCop
         def alignment_source(node, starting_loc)
           ending_loc =
             case node.type
-            when :block, :numblock, :kwbegin
+            when :block, :numblock, :itblock, :kwbegin
               node.loc.begin
             when :def, :defs, :class, :module,
                  :lvasgn, :ivasgn, :cvasgn, :gvasgn, :casgn

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

@@ -260,7 +260,10 @@ module RuboCop
         end
 
         def hash_table_style?
-          align_hash_cop_config && align_hash_cop_config['EnforcedHashRocketStyle'] == 'table'
+          return false unless align_hash_cop_config
+
+          enforced_styles = Array(align_hash_cop_config['EnforcedHashRocketStyle'])
+          enforced_styles.include?('table')
         end
 
         def space_around_exponent_operator?

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

@@ -77,6 +77,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 

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

@@ -103,6 +103,7 @@ module RuboCop
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 

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

@@ -73,7 +73,7 @@ module RuboCop
       #   require 'my_debugger/start'
       class Debugger < Base
         MSG = 'Remove debugger entry point `%<source>s`.'
-        BLOCK_TYPES = %i[block numblock kwbegin].freeze
+        BLOCK_TYPES = %i[block numblock itblock kwbegin].freeze
 
         def on_send(node)
           return if assumed_usage_context?(node)
@@ -120,7 +120,7 @@ module RuboCop
           return true if assumed_argument?(node)
 
           node.each_ancestor.none? do |ancestor|
-            BLOCK_TYPES.include?(ancestor.type) || ancestor.lambda_or_proc?
+            ancestor.type?(:any_block, :kwbegin) || ancestor.lambda_or_proc?
           end
         end