rubocop 1.65.1 → 1.75.6

data/lib/rubocop/cop/variable_force/variable_table.rb

@@ -61,8 +61,8 @@ module RuboCop
                   "at #{node.source_range}, #{node.inspect}"
           end
 
-          variable.assign(node)
           mark_variable_as_captured_by_block_if_so(variable)
+          variable.assign(node)
         end
 
         def reference_variable(name, node)
@@ -87,8 +87,8 @@ module RuboCop
           # So just skip.
           return unless variable
 
-          variable.reference!(node)
           mark_variable_as_captured_by_block_if_so(variable)
+          variable.reference!(node)
         end
 
         def find_variable(name)
@@ -100,7 +100,7 @@ module RuboCop
 
             # Only block scope allows referencing outer scope variables.
             node = scope.node
-            return nil unless node.block_type? || node.numblock_type?
+            return nil unless node.any_block_type?
           end
 
           nil
@@ -113,14 +113,14 @@ module RuboCop
         def accessible_variables
           scope_stack.reverse_each.with_object([]) do |scope, variables|
             variables.concat(scope.variables.values)
-            break variables unless scope.node.block_type? || scope.node.numblock_type?
+            break variables unless scope.node.any_block_type?
           end
         end
 
         private
 
         def mark_variable_as_captured_by_block_if_so(variable)
-          return unless current_scope.node.block_type? || current_scope.node.numblock_type?
+          return unless current_scope.node.any_block_type?
           return if variable.scope == current_scope
 
           variable.capture_with_block!

data/lib/rubocop/cop/variable_force.rb

@@ -54,7 +54,7 @@ module RuboCop
 
       ZERO_ARITY_SUPER_TYPE = :zsuper
 
-      TWISTED_SCOPE_TYPES = %i[block numblock class sclass defs module].freeze
+      TWISTED_SCOPE_TYPES = %i[block numblock itblock class sclass defs module].freeze
       SCOPE_TYPES = (TWISTED_SCOPE_TYPES + [:def]).freeze
 
       SEND_TYPE = :send
@@ -194,15 +194,10 @@ module RuboCop
       end
 
       def process_variable_operator_assignment(node)
-        if LOGICAL_OPERATOR_ASSIGNMENT_TYPES.include?(node.type)
-          asgn_node, rhs_node = *node
-        else
-          asgn_node, _operator, rhs_node = *node
-        end
-
+        asgn_node = node.lhs
         return unless asgn_node.lvasgn_type?
 
-        name = asgn_node.children.first
+        name = asgn_node.name
 
         variable_table.declare_variable(name, asgn_node) unless variable_table.variable_exist?(name)
 
@@ -222,7 +217,7 @@ module RuboCop
         # before processing rhs nodes.
 
         variable_table.reference_variable(name, node)
-        process_node(rhs_node)
+        process_node(node.rhs)
         variable_table.assign_to_variable(name, asgn_node)
 
         skip_children!
@@ -355,8 +350,7 @@ module RuboCop
         when :lvasgn
           AssignmentReference.new(node)
         when *OPERATOR_ASSIGNMENT_TYPES
-          asgn_node = node.children.first
-          VariableReference.new(asgn_node.children.first) if asgn_node.lvasgn_type?
+          VariableReference.new(node.lhs.name) if node.lhs.lvasgn_type?
         end
       end
 

data/lib/rubocop/cops_documentation_generator.rb

@@ -1,23 +1,60 @@
 # frozen_string_literal: true
 
 require 'fileutils'
+require 'yard'
 
 # Class for generating documentation of all cops departments
 # @api private
 class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   include ::RuboCop::Cop::Documentation
+  CopData = Struct.new(
+    :cop, :description, :example_objects, :safety_objects, :see_objects, :config, keyword_init: true
+  )
+
+  STRUCTURE = {
+    name:                  ->(data) { cop_header(data.cop) },
+    required_ruby_version: ->(data) { required_ruby_version(data.cop) },
+    properties:            ->(data) { properties(data.cop) },
+    description:           ->(data) { "#{data.description}\n" },
+    safety:                ->(data) { safety_object(data.safety_objects, data.cop) },
+    examples:              ->(data) { examples(data.example_objects, data.cop) },
+    configuration:         ->(data) { configurations(data.cop.department, data.cop, data.config) },
+    references:            ->(data) { references(data.cop, data.see_objects) }
+  }.freeze
+
   # This class will only generate documentation for cops that belong to one of
   # the departments given in the `departments` array. E.g. if we only wanted
   # documentation for Lint cops:
   #
   #   CopsDocumentationGenerator.new(departments: ['Lint']).call
   #
-  def initialize(departments: [])
+  # 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) }
+  #   CopsDocumentationGenerator.new(extra_info: { ruby_version: callback }).call
+  #
+  # 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, plugin_name: nil)
     @departments = departments.map(&:to_sym).sort!
+    @extra_info = extra_info
     @cops = RuboCop::Cop::Registry.global
     @config = RuboCop::ConfigLoader.default_configuration
-    @docs_path = "#{Dir.pwd}/docs/modules/ROOT/pages/"
-    FileUtils.mkdir_p(@docs_path)
+    # 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")
   end
 
   def call
@@ -37,24 +74,21 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     cops.with_department(department).sort!
   end
 
-  def cops_body(cop, description, examples_objects, safety_objects, see_objects, pars) # rubocop:disable Metrics/AbcSize, Metrics/ParameterLists
-    check_examples_to_have_the_default_enforced_style!(examples_objects, cop)
-
-    content = h2(cop.cop_name)
-    content << required_ruby_version(cop)
-    content << properties(cop)
-    content << "#{description}\n"
-    content << safety_object(safety_objects) if safety_objects.any? { |s| !s.text.blank? }
-    content << examples(examples_objects) if examples_objects.any?
-    content << configurations(cop.department, pars)
-    content << references(cop, see_objects)
+  def cops_body(data)
+    check_examples_to_have_the_default_enforced_style!(data.example_objects, data.cop)
+
+    content = +''
+    STRUCTURE.each do |section, block|
+      content << instance_exec(data, &block)
+      content << @extra_info[section].call(data) if @extra_info[section]
+    end
     content
   end
 
-  def check_examples_to_have_the_default_enforced_style!(examples_object, cop)
-    return if examples_object.none?
+  def check_examples_to_have_the_default_enforced_style!(example_objects, cop)
+    return if example_objects.none?
 
-    examples_describing_enforced_style = examples_object.map(&:name).grep(/EnforcedStyle:/)
+    examples_describing_enforced_style = example_objects.map(&:name).grep(/EnforcedStyle:/)
     return if examples_describing_enforced_style.none?
 
     if examples_describing_enforced_style.index { |name| name.match?('default') }.nonzero?
@@ -66,16 +100,20 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     raise "Specify the default EnforcedStyle for #{cop.cop_name}"
   end
 
-  def examples(examples_object)
-    examples_object.each_with_object(h3('Examples').dup) do |example, content|
+  def examples(example_objects, cop)
+    return '' if example_objects.none?
+
+    example_objects.each_with_object(cop_subsection('Examples', cop).dup) do |example, content|
       content << "\n" unless content.end_with?("\n\n")
-      content << h4(example.name) unless example.name == ''
+      content << example_header(example.name, cop) unless example.name == ''
       content << code_example(example)
     end
   end
 
-  def safety_object(safety_object_objects)
-    safety_object_objects.each_with_object(h3('Safety').dup) do |safety_object, content|
+  def safety_object(safety_objects, cop)
+    return '' if safety_objects.all? { |s| s.text.blank? }
+
+    safety_objects.each_with_object(cop_subsection('Safety', cop).dup) do |safety_object, content|
       next if safety_object.text.blank?
 
       content << "\n" unless content.end_with?("\n\n")
@@ -87,7 +125,15 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   def required_ruby_version(cop)
     return '' unless cop.respond_to?(:required_minimum_ruby_version)
 
-    "NOTE: Required Ruby version: #{cop.required_minimum_ruby_version}\n\n"
+    if cop.required_minimum_ruby_version
+      requirement = cop.required_minimum_ruby_version
+    elsif cop.required_maximum_ruby_version
+      requirement = "<= #{cop.required_maximum_ruby_version}"
+    else
+      return ''
+    end
+
+    "NOTE: Requires Ruby version #{requirement}\n\n"
   end
 
   # rubocop:disable Metrics/MethodLength
@@ -115,22 +161,25 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   end
   # rubocop:enable Metrics/MethodLength
 
-  def h2(title)
+  def cop_header(cop)
     content = +"\n"
-    content << "== #{title}\n"
+    content << "[##{to_anchor(cop.cop_name)}]\n"
+    content << "== #{cop.cop_name}\n"
     content << "\n"
     content
   end
 
-  def h3(title)
+  def cop_subsection(title, cop)
     content = +"\n"
+    content << "[##{to_anchor(title)}-#{to_anchor(cop.cop_name)}]\n"
     content << "=== #{title}\n"
     content << "\n"
     content
   end
 
-  def h4(title)
-    content = +"==== #{title}\n"
+  def example_header(title, cop)
+    content = +"[##{to_anchor(title)}-#{to_anchor(cop.cop_name)}]\n"
+    content << "==== #{title}\n"
     content << "\n"
     content
   end
@@ -142,22 +191,22 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     content
   end
 
-  def configurations(department, pars)
-    return '' if pars.empty?
-
+  def configurations(department, cop, cop_config)
     header = ['Name', 'Default value', 'Configurable values']
-    configs = pars
+    configs = cop_config
               .each_key
               .reject { |key| key.start_with?('Supported') }
               .reject { |key| key.start_with?('AllowMultipleStyles') }
+    return '' if configs.empty?
+
     content = configs.map do |name|
-      configurable = configurable_values(pars, name)
-      default = format_table_value(pars[name])
+      configurable = configurable_values(cop_config, name)
+      default = format_table_value(cop_config[name])
 
       [configuration_name(department, name), default, configurable]
     end
 
-    h3('Configurable attributes') + to_table(header, content)
+    cop_subsection('Configurable attributes', cop) + to_table(header, content)
   end
 
   def configuration_name(department, name)
@@ -168,17 +217,17 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   end
 
   # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
-  def configurable_values(pars, name)
+  def configurable_values(cop_config, name)
     case name
     when /^Enforced/
       supported_style_name = RuboCop::Cop::Util.to_supported_styles(name)
-      format_table_value(pars[supported_style_name])
+      format_table_value(cop_config[supported_style_name])
     when 'IndentationWidth'
       'Integer'
     when 'Database'
-      format_table_value(pars['SupportedDatabases'])
+      format_table_value(cop_config['SupportedDatabases'])
     else
-      case pars[name]
+      case cop_config[name]
       when String
         'String'
       when Integer
@@ -218,7 +267,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
       else
         wrap_backtick(val.nil? ? '<none>' : val)
       end
-    value.gsub("#{Dir.pwd}/", '').rstrip
+    value.gsub("#{@base_dir}/", '').rstrip
   end
 
   def wrap_backtick(value)
@@ -235,7 +284,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     urls = RuboCop::Cop::MessageAnnotator.new(config, cop.name, cop_config, {}).urls
     return '' if urls.empty? && see_objects.empty?
 
-    content = h3('References')
+    content = cop_subsection('References', cop)
     content << urls.map { |url| "* #{url}" }.join("\n")
     content << "\n" unless urls.empty?
     content << see_objects.map { |see| "* #{see.name}" }.join("\n")
@@ -247,7 +296,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     return '' unless department == :Layout
 
     filename = "#{department_to_basename(department)}_footer.adoc"
-    file = "#{Dir.pwd}/docs/modules/ROOT/partials/#{filename}"
+    file = "#{docs_path}/partials/#{filename}"
     return '' unless File.exist?(file)
 
     "\ninclude::../partials/#{filename}[]\n"
@@ -267,7 +316,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     HEADER
     selected_cops.each { |cop| content << print_cop_with_doc(cop) }
     content << footer_for_department(department)
-    file_name = "#{docs_path}/#{department_to_basename(department)}.adoc"
+    file_name = "#{docs_path}/pages/#{department_to_basename(department)}.adoc"
     File.open(file_name, 'w') do |file|
       puts "* generated #{file_name}"
       file.write("#{content.strip}\n")
@@ -278,19 +327,25 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   def print_cop_with_doc(cop) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
     cop_config = config.for_cop(cop)
     non_display_keys = %w[
-      AutoCorrect Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
-      VersionChanged
+      Enabled
+      Description
+      StyleGuide
+      Reference References
+      Safe SafeAutoCorrect AutoCorrect
+      VersionAdded VersionChanged
     ]
-    pars = cop_config.reject { |k| non_display_keys.include? k }
+    parameters = cop_config.reject { |k| non_display_keys.include? k }
     description = 'No documentation'
-    examples_object = safety_object = see_object = []
+    example_objects = safety_objects = see_objects = []
     cop_code(cop) do |code_object|
       description = code_object.docstring unless code_object.docstring.blank?
-      examples_object = code_object.tags('example')
-      safety_object = code_object.tags('safety')
-      see_object = code_object.tags('see')
+      example_objects = code_object.tags('example')
+      safety_objects = code_object.tags('safety')
+      see_objects = code_object.tags('see')
     end
-    cops_body(cop, description, examples_object, safety_object, see_object, pars)
+    data = CopData.new(cop: cop, description: description, example_objects: example_objects,
+                       safety_objects: safety_objects, see_objects: see_objects, config: parameters)
+    cops_body(data)
   end
 
   def cop_code(cop)
@@ -306,7 +361,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     filename = "#{department_to_basename(department)}.adoc"
     content = +"=== Department xref:#{filename}[#{type_title}]\n\n"
     cops_of_department(department).each do |cop|
-      anchor = cop.cop_name.delete('/').downcase
+      anchor = to_anchor(cop.cop_name)
       content << "* xref:#{filename}##{anchor}[#{cop.cop_name}]\n"
     end
 
@@ -314,7 +369,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   end
 
   def print_table_of_contents
-    path = "#{docs_path}/cops.adoc"
+    path = "#{docs_path}/pages/cops.adoc"
 
     File.write(path, table_contents) and return unless File.exist?(path)
 
@@ -338,4 +393,13 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
 
     status == 'pending' ? 'Pending' : 'Enabled'
   end
+
+  # HTML anchor are somewhat limited in what characters they can contain, just
+  # accept a known-good subset. As long as it's consistent it doesn't matter.
+  #
+  # Style/AccessModifierDeclarations => styleaccessmodifierdeclarations
+  # OnlyFor: [] (default) => onlyfor_-__-_default_
+  def to_anchor(title)
+    title.delete('/').tr(' ', '-').gsub(/[^a-zA-Z0-9-]/, '_').downcase
+  end
 end

data/lib/rubocop/directive_comment.rb

@@ -12,16 +12,30 @@ module RuboCop
     # @api private
     LINT_SYNTAX_COP = "#{LINT_DEPARTMENT}/Syntax"
     # @api private
-    COP_NAME_PATTERN = '([A-Z]\w+/)*(?:[A-Z]\w+)'
+    COP_NAME_PATTERN = '([A-Za-z]\w+/)*(?:[A-Za-z]\w+)'
     # @api private
     COP_NAMES_PATTERN = "(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}"
     # @api private
     COPS_PATTERN = "(all|#{COP_NAMES_PATTERN})"
     # @api private
+    AVAILABLE_MODES = %w[disable enable todo].freeze
+    # @api private
+    DIRECTIVE_MARKER_PATTERN = '# rubocop : '
+    # @api private
+    DIRECTIVE_MARKER_REGEXP = Regexp.new(DIRECTIVE_MARKER_PATTERN.gsub(' ', '\s*'))
+    # @api private
+    DIRECTIVE_HEADER_PATTERN = "#{DIRECTIVE_MARKER_PATTERN}((?:#{AVAILABLE_MODES.join('|')}))\\b"
+    # @api private
     DIRECTIVE_COMMENT_REGEXP = Regexp.new(
-      "# rubocop : ((?:disable|enable|todo))\\b #{COPS_PATTERN}"
+      "#{DIRECTIVE_HEADER_PATTERN} #{COPS_PATTERN}"
         .gsub(' ', '\s*')
     )
+    # @api private
+    TRAILING_COMMENT_MARKER = '--'
+    # @api private
+    MALFORMED_DIRECTIVE_WITHOUT_COP_NAME_REGEXP = Regexp.new(
+      "\\A#{DIRECTIVE_HEADER_PATTERN}\\s*\\z".gsub(' ', '\s*')
+    )
 
     def self.before_comment(line)
       line.split(DIRECTIVE_COMMENT_REGEXP).first
@@ -32,9 +46,28 @@ module RuboCop
     def initialize(comment, cop_registry = Cop::Registry.global)
       @comment = comment
       @cop_registry = cop_registry
+      @match_data = comment.text.match(DIRECTIVE_COMMENT_REGEXP)
       @mode, @cops = match_captures
     end
 
+    # Checks if the comment starts with `# rubocop:` marker
+    def start_with_marker?
+      comment.text.start_with?(DIRECTIVE_MARKER_REGEXP)
+    end
+
+    # Checks if the comment is malformed as a `# rubocop:` directive
+    def malformed?
+      return true if !start_with_marker? || @match_data.nil?
+
+      tail = @match_data.post_match.lstrip
+      !(tail.empty? || tail.start_with?(TRAILING_COMMENT_MARKER))
+    end
+
+    # Checks if the directive comment is missing a cop name
+    def missing_cop_name?
+      MALFORMED_DIRECTIVE_WITHOUT_COP_NAME_REGEXP.match?(comment.text)
+    end
+
     # Checks if this directive relates to single line
     def single_line?
       !comment.text.start_with?(DIRECTIVE_COMMENT_REGEXP)
@@ -55,7 +88,7 @@ module RuboCop
 
     # Returns match captures to directive comment pattern
     def match_captures
-      @match_captures ||= comment.text.match(DIRECTIVE_COMMENT_REGEXP)&.captures
+      @match_captures ||= @match_data&.captures
     end
 
     # Checks if this directive disables cops
@@ -88,10 +121,15 @@ module RuboCop
       @cop_names ||= all_cops? ? all_cop_names : parsed_cop_names
     end
 
+    # Returns an array of cops for this directive comment, without resolving departments
+    def raw_cop_names
+      @raw_cop_names ||= (cops || '').split(/,\s*/)
+    end
+
     # Returns array of specified in this directive department names
     # when all department disabled
     def department_names
-      splitted_cops_string.select { |cop| department?(cop) }
+      raw_cop_names.select { |cop| department?(cop) }
     end
 
     # Checks if directive departments include cop
@@ -101,11 +139,11 @@ module RuboCop
 
     # Checks if cop department has already used in directive comment
     def overridden_by_department?(cop)
-      in_directive_department?(cop) && splitted_cops_string.include?(cop)
+      in_directive_department?(cop) && raw_cop_names.include?(cop)
     end
 
     def directive_count
-      splitted_cops_string.count
+      raw_cop_names.count
     end
 
     # Returns line number for directive
@@ -115,12 +153,8 @@ module RuboCop
 
     private
 
-    def splitted_cops_string
-      (cops || '').split(/,\s*/)
-    end
-
     def parsed_cop_names
-      cops = splitted_cops_string.map do |name|
+      cops = raw_cop_names.map do |name|
         department?(name) ? cop_names_for_department(name) : name
       end.flatten
       cops - [LINT_SYNTAX_COP]

data/lib/rubocop/ext/regexp_node.rb

@@ -43,7 +43,6 @@ module RuboCop
       def named_capturing?(exp, event, named)
         event == :enter &&
           named == exp.respond_to?(:name) &&
-          !exp.text.start_with?('(?<=') &&
           exp.respond_to?(:capturing?) &&
           exp.capturing?
       end

data/lib/rubocop/file_finder.rb

@@ -23,15 +23,20 @@ module RuboCop
       last_file
     end
 
+    def traverse_directories_upwards(start_dir, stop_dir = nil)
+      Pathname.new(start_dir).expand_path.ascend do |dir|
+        yield(dir)
+        dir = dir.to_s
+        break if dir == stop_dir || dir == FileFinder.root_level
+      end
+    end
+
     private
 
     def traverse_files_upwards(filename, start_dir, stop_dir)
-      Pathname.new(start_dir).expand_path.ascend do |dir|
+      traverse_directories_upwards(start_dir, stop_dir) do |dir|
         file = dir + filename
         yield(file.to_s) if file.exist?
-
-        dir = dir.to_s
-        break if dir == stop_dir || dir == FileFinder.root_level
       end
     end
   end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -10,7 +10,7 @@ module RuboCop
       HEADING = <<~COMMENTS
         # This configuration was generated by
         # `%<command>s`
-        # %<timestamp>susing RuboCop version #{Version.version}.
+        # %<timestamp>susing RuboCop version #{Version::STRING}.
         # The point is for the user to remove these configuration records
         # one by one as the offenses are removed from the code base.
         # Note that changes in the inspected code, or installation of new
@@ -164,7 +164,7 @@ module RuboCop
 
       def cop_config_params(default_cfg, cfg)
         default_cfg.keys -
-          %w[Description StyleGuide Reference Enabled Exclude Safe
+          %w[Description StyleGuide Reference References Enabled Exclude Safe
              SafeAutoCorrect VersionAdded VersionChanged VersionRemoved] -
           cfg.keys
       end
@@ -178,6 +178,7 @@ module RuboCop
           next unless value.is_a?(Array)
           next if value.empty?
 
+          value.map! { |v| v.nil? ? '~' : v } # Change nil back to ~ as in the YAML file.
           output_buffer.puts "# #{param}: #{value.uniq.join(', ')}"
         end
       end

data/lib/rubocop/formatter/formatter_set.rb

@@ -77,7 +77,7 @@ module RuboCop
         case formatter_type
         when Class
           formatter_type
-        when /\A[A-Z]/
+        when /\A(::)?[A-Z]/
           custom_formatter_class(formatter_type)
         else
           builtin_formatter_class(formatter_type)

data/lib/rubocop/formatter/html_formatter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'cgi'
+require 'cgi/escape'
 require 'erb'
 
 module RuboCop