rubocop 1.72.2 → 1.73.0

data/lib/rubocop/cop/style/trailing_comma_in_array_literal.rb

@@ -6,12 +6,13 @@ module RuboCop
       # Checks for trailing comma in array literals.
       # The configuration options are:
       #
-      # * `consistent_comma`: Requires a comma after the
-      # last item of all non-empty, multiline array literals.
-      # * `comma`: Requires a comma after last item in an array,
-      # but only when each item is on its own line.
-      # * `no_comma`: Does not require a comma after the
-      # last item in an array
+      # * `consistent_comma`: Requires a comma after the last item of all non-empty, multiline array
+      # literals.
+      # * `comma`: Requires a comma after the last item in an array, but only when each item is on
+      # its own line.
+      # * `diff_comma`: Requires a comma after the last item in an array, but only when that item is
+      # followed by an immediate newline.
+      # * `no_comma`: Does not require a comma after the last item in an array
       #
       # @example EnforcedStyleForMultiline: consistent_comma
       #   # bad
@@ -37,6 +38,14 @@ module RuboCop
       #     2,
       #   ]
       #
+      #   # bad
+      #   a = [1, 2,
+      #        3, 4]
+      #
+      #   # good
+      #   a = [1, 2,
+      #        3, 4,]
+      #
       # @example EnforcedStyleForMultiline: comma
       #   # bad
       #   a = [1, 2,]
@@ -72,6 +81,38 @@ module RuboCop
       #     2,
       #   ]
       #
+      # @example EnforcedStyleForMultiline: diff_comma
+      #   # bad
+      #   a = [1, 2,]
+      #
+      #   # good
+      #   a = [1, 2]
+      #
+      #   # good
+      #   a = [
+      #     1, 2,
+      #     3,
+      #   ]
+      #
+      #   # good
+      #   a = [
+      #     1, 2, 3,
+      #   ]
+      #
+      #   # good
+      #   a = [
+      #     1,
+      #     2,
+      #   ]
+      #
+      #   # bad
+      #   a = [1, 2,
+      #        3, 4,]
+      #
+      #   # good
+      #   a = [1, 2,
+      #        3, 4]
+      #
       # @example EnforcedStyleForMultiline: no_comma (default)
       #   # bad
       #   a = [1, 2,]

data/lib/rubocop/cop/style/trailing_comma_in_hash_literal.rb

@@ -6,12 +6,13 @@ module RuboCop
       # Checks for trailing comma in hash literals.
       # The configuration options are:
       #
-      # * `consistent_comma`: Requires a comma after the
-      # last item of all non-empty, multiline hash literals.
-      # * `comma`: Requires a comma after the last item in a hash,
-      # but only when each item is on its own line.
-      # * `no_comma`: Does not require a comma after the
-      # last item in a hash
+      # * `consistent_comma`: Requires a comma after the last item of all non-empty, multiline hash
+      # literals.
+      # * `comma`: Requires a comma after the last item in a hash, but only when each item is on its
+      # own line.
+      # * `diff_comma`: Requires a comma after the last item in a hash, but only when that item is
+      # followed by an immediate newline.
+      # * `no_comma`: Does not require a comma after the last item in a hash
       #
       # @example EnforcedStyleForMultiline: consistent_comma
       #
@@ -38,6 +39,14 @@ module RuboCop
       #     bar: 2,
       #   }
       #
+      #   # bad
+      #   a = { foo: 1, bar: 2,
+      #         baz: 3, qux: 4 }
+      #
+      #   # good
+      #   a = { foo: 1, bar: 2,
+      #         baz: 3, qux: 4, }
+      #
       # @example EnforcedStyleForMultiline: comma
       #
       #   # bad
@@ -74,6 +83,39 @@ module RuboCop
       #     bar: 2,
       #   }
       #
+      # @example EnforcedStyleForMultiline: diff_comma
+      #
+      #   # bad
+      #   a = { foo: 1, bar: 2, }
+      #
+      #   # good
+      #   a = { foo: 1, bar: 2 }
+      #
+      #   # good
+      #   a = {
+      #     foo: 1, bar: 2,
+      #     qux: 3,
+      #   }
+      #
+      #   # good
+      #   a = {
+      #     foo: 1, bar: 2, qux: 3,
+      #   }
+      #
+      #   # good
+      #   a = {
+      #     foo: 1,
+      #     bar: 2,
+      #   }
+      #
+      #   # bad
+      #   a = { foo: 1, bar: 2,
+      #         baz: 3, qux: 4, }
+      #
+      #   # good
+      #   a = { foo: 1, bar: 2,
+      #         baz: 3, qux: 4 }
+      #
       # @example EnforcedStyleForMultiline: no_comma (default)
       #
       #   # bad

data/lib/rubocop/cop/style/trivial_accessors.rb

@@ -113,7 +113,7 @@ module RuboCop
         private
 
         def in_module_or_instance_eval?(node)
-          node.each_ancestor(:block, :class, :sclass, :module).each do |pnode|
+          node.each_ancestor(:any_block, :class, :sclass, :module).each do |pnode|
             case pnode.type
             when :class, :sclass
               return false

data/lib/rubocop/cops_documentation_generator.rb

@@ -28,6 +28,12 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   #
   #   CopsDocumentationGenerator.new(departments: ['Lint']).call
   #
+  # For plugin extensions, specify `:plugin_name` keyword as follows:
+  #
+  #   CopsDocumentationGenerator.new(
+  #     departments: ['Performance'], plugin_name: 'rubocop-performance'
+  #   ).call
+  #
   # You can append additional information:
   #
   #   callback = ->(data) { required_rails_version(data.cop) }
@@ -36,11 +42,16 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   # This will insert the string returned from the lambda _after_ the section from RuboCop itself.
   # See `CopsDocumentationGenerator::STRUCTURE` for available sections.
   #
-  def initialize(departments: [], extra_info: {}, base_dir: Dir.pwd)
+  def initialize(departments: [], extra_info: {}, base_dir: Dir.pwd, plugin_name: nil)
     @departments = departments.map(&:to_sym).sort!
     @extra_info = extra_info
     @cops = RuboCop::Cop::Registry.global
     @config = RuboCop::ConfigLoader.default_configuration
+    # NOTE: For example, this prevents excessive plugin loading before another task executes,
+    # in cases where plugins are already loaded by `internal_investigation`.
+    if plugin_name && @config.loaded_plugins.none? { |plugin| plugin.about.name == plugin_name }
+      RuboCop::Plugin.integrate_plugins(RuboCop::Config.new, [plugin_name])
+    end
     @base_dir = base_dir
     @docs_path = "#{base_dir}/docs/modules/ROOT"
     FileUtils.mkdir_p("#{@docs_path}/pages")

data/lib/rubocop/plugin/load_error.rb

@@ -15,7 +15,7 @@ module RuboCop
         <<~MESSAGE
           Failed to load plugin `#{@plugin_name}` because the corresponding plugin class could not be determined for instantiation.
           Try upgrading it first (e.g., `bundle update #{@plugin_name}`).
-          If `#{@plugin_name}` is not yet a plugin, use `require: #{@plugin_name}` instead of `plugins: `#{@plugin_name}` in your configuration.
+          If `#{@plugin_name}` is not yet a plugin, use `require: #{@plugin_name}` instead of `plugins: #{@plugin_name}` in your configuration.
 
           For further assistance, check with the developer regarding the following points:
           https://docs.rubocop.org/rubocop/plugin_migration_guide.html

data/lib/rubocop/plugin.rb

@@ -22,9 +22,16 @@ module RuboCop
       def plugin_capable?(feature_name)
         return true if BUILTIN_INTERNAL_PLUGINS.key?(feature_name)
         return true if feature_name == OBSOLETE_INTERNAL_AFFAIRS_PLUGIN_NAME
-        return false unless (gem = Gem.loaded_specs[feature_name])
 
-        !!gem.metadata['default_lint_roller_plugin']
+        begin
+          # When not using Bundler. Makes the spec available but does not require it.
+          gem feature_name
+        rescue Gem::LoadError
+          # The user requested a gem that they do not have installed
+        end
+        return false unless (spec = Gem.loaded_specs[feature_name])
+
+        !!spec.metadata['default_lint_roller_plugin']
       end
 
       def integrate_plugins(rubocop_config, plugins)

data/lib/rubocop/rspec/shared_contexts.rb

@@ -80,6 +80,21 @@ RSpec.shared_context 'maintain registry' do
   end
 end
 
+RSpec.shared_context 'maintain default configuration' do
+  around(:each) do |example|
+    # Make a copy of the current configuration that will not change when source hash changes
+    default_configuration = RuboCop::ConfigLoader.default_configuration
+    config = RuboCop::Config.create(
+      default_configuration.to_h.clone,
+      default_configuration.loaded_path
+    )
+
+    example.run
+
+    RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
+  end
+end
+
 # This context assumes nothing and defines `cop`, among others.
 RSpec.shared_context 'config' do # rubocop:disable Metrics/BlockLength
   ### Meant to be overridden at will

data/lib/rubocop/rspec/support.rb

@@ -15,6 +15,7 @@ RSpec.configure do |config|
   config.include_context 'isolated bundler', :isolated_bundler
   config.include_context 'lsp', :lsp
   config.include_context 'maintain registry', :restore_registry
+  config.include_context 'maintain default configuration', :restore_configuration
   config.include_context 'ruby 2.0', :ruby20
   config.include_context 'ruby 2.1', :ruby21
   config.include_context 'ruby 2.2', :ruby22

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.72.2'
+    STRING = '1.73.0'
 
     MSG = '%<version>s (using %<parser_version>s, ' \
           'rubocop-ast %<rubocop_ast_version>s, ' \

data/lib/rubocop.rb

@@ -148,7 +148,6 @@ require_relative 'rubocop/cop/mixin/comments_help' # relies on visibility_help
 require_relative 'rubocop/cop/mixin/def_node' # relies on visibility_help
 
 require_relative 'rubocop/cop/utils/format_string'
-require_relative 'rubocop/cop/utils/regexp_ranges'
 
 require_relative 'rubocop/cop/migration/department_name'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.72.2
+  version: 1.73.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -9,7 +9,7 @@ authors:
 - Yuji Nakayama
 bindir: exe
 cert_chain: []
-date: 2025-02-17 00:00:00.000000000 Z
+date: 2025-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -971,7 +971,6 @@ files:
 - lib/rubocop/cop/team.rb
 - lib/rubocop/cop/util.rb
 - lib/rubocop/cop/utils/format_string.rb
-- lib/rubocop/cop/utils/regexp_ranges.rb
 - lib/rubocop/cop/variable_force.rb
 - lib/rubocop/cop/variable_force/assignment.rb
 - lib/rubocop/cop/variable_force/branch.rb
@@ -1075,9 +1074,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://rubocop.org/
-  changelog_uri: https://github.com/rubocop/rubocop/releases/tag/v1.72.2
+  changelog_uri: https://github.com/rubocop/rubocop/releases/tag/v1.73.0
   source_code_uri: https://github.com/rubocop/rubocop/
-  documentation_uri: https://docs.rubocop.org/rubocop/1.72/
+  documentation_uri: https://docs.rubocop.org/rubocop/1.73/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
 rdoc_options: []

data/lib/rubocop/cop/utils/regexp_ranges.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Utils
-      # Helper to abstract complexity of building range pairs
-      # with octal escape reconstruction (needed for regexp_parser < 2.7).
-      class RegexpRanges
-        attr_reader :root
-
-        def initialize(root)
-          @root = root
-          @compound_token = []
-          @pairs = []
-          @populated = false
-        end
-
-        def compound_token
-          populate_all unless @populated
-
-          @compound_token
-        end
-
-        def pairs
-          populate_all unless @populated
-
-          @pairs
-        end
-
-        private
-
-        def populate_all
-          populate(@root)
-
-          # If either bound is a compound the first one is an escape
-          # and that's all we need to work with.
-          # If there are any cops that wanted to operate on the compound
-          # expression we could wrap it with a facade class.
-          @pairs.map! { |pair| pair.map(&:first) }
-
-          @populated = true
-        end
-
-        def populate(expr)
-          expressions = expr.expressions.to_a
-
-          until expressions.empty?
-            current = expressions.shift
-
-            if escaped_octal?(current)
-              @compound_token << current
-              @compound_token.concat(pop_octal_digits(expressions))
-              # If we have all the digits we can discard.
-            end
-
-            next unless current.type == :set
-
-            process_set(expressions, current)
-            @compound_token.clear
-          end
-        end
-
-        def process_set(expressions, current)
-          case current.token
-          when :range
-            @pairs << compose_range(expressions, current)
-          when :character
-            # Child expressions may include the range we are looking for.
-            populate(current)
-          when :intersection
-            # Each child expression could have child expressions that lead to ranges.
-            current.expressions.each do |intersected|
-              populate(intersected)
-            end
-          end
-        end
-
-        def compose_range(expressions, current)
-          range_start, range_end = current.expressions
-          range_start = if @compound_token.size.between?(1, 2) && octal_digit?(range_start.text)
-                          @compound_token.dup << range_start
-                        else
-                          [range_start]
-                        end
-          range_end = [range_end]
-          range_end.concat(pop_octal_digits(expressions)) if escaped_octal?(range_end.first)
-          [range_start, range_end]
-        end
-
-        def escaped_octal?(expr)
-          expr.text.valid_encoding? && expr.text =~ /^\\[0-7]$/
-        end
-
-        def octal_digit?(char)
-          ('0'..'7').cover?(char)
-        end
-
-        def pop_octal_digits(expressions)
-          digits = []
-
-          2.times do
-            next unless (next_child = expressions.first)
-            next unless next_child.type == :literal && next_child.text =~ /^[0-7]$/
-
-            digits << expressions.shift
-          end
-
-          digits
-        end
-      end
-    end
-  end
-end