rubocop 1.30.1 → 1.64.0

data/lib/rubocop/cops_documentation_generator.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 # Class for generating documentation of all cops departments
 # @api private
 class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
@@ -14,6 +16,8 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     @departments = departments.map(&:to_sym).sort!
     @cops = RuboCop::Cop::Registry.global
     @config = RuboCop::ConfigLoader.default_configuration
+    @docs_path = "#{Dir.pwd}/docs/modules/ROOT/pages/"
+    FileUtils.mkdir_p(@docs_path)
   end
 
   def call
@@ -27,13 +31,13 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
 
   private
 
-  attr_reader :departments, :cops, :config
+  attr_reader :departments, :cops, :config, :docs_path
 
   def cops_of_department(department)
     cops.with_department(department).sort!
   end
 
-  def cops_body(cop, description, examples_objects, safety_objects, pars) # rubocop:disable Metrics/AbcSize
+  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)
@@ -42,8 +46,8 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     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(pars)
-    content << references(cop)
+    content << configurations(cop.department, pars)
+    content << references(cop, see_objects)
     content
   end
 
@@ -93,7 +97,9 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
       'Version Changed'
     ]
     autocorrect = if cop.support_autocorrect?
-                    "Yes#{' (Unsafe)' unless cop.new(config).safe_autocorrect?}"
+                    context = cop.new.always_autocorrect? ? 'Always' : 'Command-line only'
+
+                    "#{context}#{' (Unsafe)' unless cop.new(config).safe_autocorrect?}"
                   else
                     'No'
                   end
@@ -136,7 +142,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     content
   end
 
-  def configurations(pars)
+  def configurations(department, pars)
     return '' if pars.empty?
 
     header = ['Name', 'Default value', 'Configurable values']
@@ -147,12 +153,20 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     content = configs.map do |name|
       configurable = configurable_values(pars, name)
       default = format_table_value(pars[name])
-      [name, default, configurable]
+
+      [configuration_name(department, name), default, configurable]
     end
 
     h3('Configurable attributes') + to_table(header, content)
   end
 
+  def configuration_name(department, name)
+    return name unless name == 'AllowMultilineFinalElement'
+
+    filename = "#{department_to_basename(department)}.adoc"
+    "xref:#{filename}#allowmultilinefinalelement[AllowMultilineFinalElement]"
+  end
+
   # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
   def configurable_values(pars, name)
     case name
@@ -185,7 +199,8 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   def to_table(header, content)
     table = ['|===', "| #{header.join(' | ')}\n\n"].join("\n")
     marked_contents = content.map do |plain_content|
-      plain_content.map { |c| "| #{c}" }.join("\n")
+      # Escape `|` with backslash to prevent the regexp `|` is not used as a table separator.
+      plain_content.map { |c| "| #{c.gsub('|', '\|')}" }.join("\n")
     end
     table << marked_contents.join("\n\n")
     table << "\n|===\n"
@@ -215,43 +230,67 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     end
   end
 
-  def references(cop)
+  def references(cop, see_objects) # rubocop:disable Metrics/AbcSize
     cop_config = config.for_cop(cop)
     urls = RuboCop::Cop::MessageAnnotator.new(config, cop.name, cop_config, {}).urls
-    return '' if urls.empty?
+    return '' if urls.empty? && see_objects.empty?
 
     content = h3('References')
     content << urls.map { |url| "* #{url}" }.join("\n")
-    content << "\n"
+    content << "\n" unless urls.empty?
+    content << see_objects.map { |see| "* #{see.name}" }.join("\n")
+    content << "\n" unless see_objects.empty?
     content
   end
 
+  def footer_for_department(department)
+    return '' unless department == :Layout
+
+    filename = "#{department_to_basename(department)}_footer.adoc"
+    file = "#{Dir.pwd}/docs/modules/ROOT/partials/#{filename}"
+    return '' unless File.exist?(file)
+
+    "\ninclude::../partials/#{filename}[]\n"
+  end
+
+  # rubocop:disable Metrics/MethodLength
   def print_cops_of_department(department)
     selected_cops = cops_of_department(department)
-    content = +"= #{department}\n"
+    content = +<<~HEADER
+      ////
+        Do NOT edit this file by hand directly, as it is automatically generated.
+
+        Please make any necessary changes to the cop documentation within the source files themselves.
+      ////
+
+      = #{department}
+    HEADER
     selected_cops.each { |cop| content << print_cop_with_doc(cop) }
-    file_name = "#{Dir.pwd}/docs/modules/ROOT/pages/#{department_to_basename(department)}.adoc"
+    content << footer_for_department(department)
+    file_name = "#{docs_path}/#{department_to_basename(department)}.adoc"
     File.open(file_name, 'w') do |file|
       puts "* generated #{file_name}"
       file.write("#{content.strip}\n")
     end
   end
+  # rubocop:enable Metrics/MethodLength
 
-  def print_cop_with_doc(cop)
+  def print_cop_with_doc(cop) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
     cop_config = config.for_cop(cop)
     non_display_keys = %w[
-      Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
+      AutoCorrect Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
       VersionChanged
     ]
     pars = cop_config.reject { |k| non_display_keys.include? k }
     description = 'No documentation'
-    examples_object = safety_object = []
+    examples_object = safety_object = see_object = []
     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')
     end
-    cops_body(cop, description, examples_object, safety_object, pars)
+    cops_body(cop, description, examples_object, safety_object, see_object, pars)
   end
 
   def cop_code(cop)
@@ -275,7 +314,10 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
   end
 
   def print_table_of_contents
-    path = "#{Dir.pwd}/docs/modules/ROOT/pages/cops.adoc"
+    path = "#{docs_path}/cops.adoc"
+
+    File.write(path, table_contents) and return unless File.exist?(path)
+
     original = File.read(path)
     content = +"// START_COP_LIST\n\n"
 

data/lib/rubocop/directive_comment.rb

@@ -6,9 +6,11 @@ module RuboCop
   # cops it contains.
   class DirectiveComment
     # @api private
-    REDUNDANT_DIRECTIVE_COP_DEPARTMENT = 'Lint'
+    LINT_DEPARTMENT = 'Lint'
     # @api private
-    REDUNDANT_DIRECTIVE_COP = "#{REDUNDANT_DIRECTIVE_COP_DEPARTMENT}/RedundantCopDisableDirective"
+    LINT_REDUNDANT_DIRECTIVE_COP = "#{LINT_DEPARTMENT}/RedundantCopDisableDirective"
+    # @api private
+    LINT_SYNTAX_COP = "#{LINT_DEPARTMENT}/Syntax"
     # @api private
     COP_NAME_PATTERN = '([A-Z]\w+/)*(?:[A-Z]\w+)'
     # @api private
@@ -35,7 +37,7 @@ module RuboCop
 
     # Checks if this directive relates to single line
     def single_line?
-      !self.class.before_comment(comment.text).empty?
+      !comment.text.start_with?(DIRECTIVE_COMMENT_REGEXP)
     end
 
     # Checks if this directive contains all the given cop names
@@ -45,9 +47,9 @@ module RuboCop
 
     def range
       match = comment.text.match(DIRECTIVE_COMMENT_REGEXP)
-      begin_pos = comment.loc.expression.begin_pos
+      begin_pos = comment.source_range.begin_pos
       Parser::Source::Range.new(
-        comment.loc.expression.source_buffer, begin_pos + match.begin(0), begin_pos + match.end(0)
+        comment.source_range.source_buffer, begin_pos + match.begin(0), begin_pos + match.end(0)
       )
     end
 
@@ -108,7 +110,7 @@ module RuboCop
 
     # Returns line number for directive
     def line_number
-      comment.loc.expression.line
+      comment.source_range.line
     end
 
     private
@@ -118,9 +120,10 @@ module RuboCop
     end
 
     def parsed_cop_names
-      splitted_cops_string.map do |name|
+      cops = splitted_cops_string.map do |name|
         department?(name) ? cop_names_for_department(name) : name
       end.flatten
+      cops - [LINT_SYNTAX_COP]
     end
 
     def department?(name)
@@ -128,17 +131,16 @@ module RuboCop
     end
 
     def all_cop_names
-      exclude_redundant_directive_cop(cop_registry.names)
+      exclude_lint_department_cops(cop_registry.names)
     end
 
     def cop_names_for_department(department)
       names = cop_registry.names_for_department(department)
-      has_redundant_directive_cop = department == REDUNDANT_DIRECTIVE_COP_DEPARTMENT
-      has_redundant_directive_cop ? exclude_redundant_directive_cop(names) : names
+      department == LINT_DEPARTMENT ? exclude_lint_department_cops(names) : names
     end
 
-    def exclude_redundant_directive_cop(cops)
-      cops - [REDUNDANT_DIRECTIVE_COP]
+    def exclude_lint_department_cops(cops)
+      cops - [LINT_REDUNDANT_DIRECTIVE_COP, LINT_SYNTAX_COP]
     end
   end
 end

data/lib/rubocop/ext/comment.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Ext
+    # Extensions to `Parser::Source::Comment`.
+    module Comment
+      def source
+        loc.expression.source
+      end
+
+      def source_range
+        loc.expression
+      end
+    end
+  end
+end
+
+Parser::Source::Comment.include RuboCop::Ext::Comment

data/lib/rubocop/ext/processed_source.rb

@@ -4,6 +4,8 @@ module RuboCop
   module Ext
     # Extensions to AST::ProcessedSource for our cached comment_config
     module ProcessedSource
+      attr_accessor :registry, :config
+
       def comment_config
         @comment_config ||= CommentConfig.new(self)
       end

data/lib/rubocop/ext/range.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Ext
+    # Extensions to Parser::Source::Range
+    module Range
+      # Adds `Range#single_line?` to parallel `Node#single_line?`
+      def single_line?
+        first_line == last_line
+      end
+    end
+  end
+end
+
+Parser::Source::Range.include RuboCop::Ext::Range

data/lib/rubocop/ext/regexp_node.rb

@@ -29,7 +29,7 @@ module RuboCop
           @parsed_tree&.each_expression(true) { |e| e.origin = origin }
         end
       # Please remove this `else` branch when support for regexp_parser 1.8 will be dropped.
-      # It's for compatibility with regexp_arser 1.8 and will never be maintained.
+      # It's for compatibility with regexp_parser 1.8 and will never be maintained.
       else
         def assign_properties(*)
           super
@@ -54,10 +54,7 @@ module RuboCop
         return enum_for(__method__, named: named) unless block_given?
 
         parsed_tree&.traverse do |event, exp, _index|
-          yield(exp) if event == :enter &&
-                        named == exp.respond_to?(:name) &&
-                        exp.respond_to?(:capturing?) &&
-                        exp.capturing?
+          yield(exp) if named_capturing?(exp, event, named)
         end
 
         self
@@ -65,6 +62,14 @@ module RuboCop
 
       private
 
+      def named_capturing?(exp, event, named)
+        event == :enter &&
+          named == exp.respond_to?(:name) &&
+          !exp.text.start_with?('(?<=') &&
+          exp.respond_to?(:capturing?) &&
+          exp.capturing?
+      end
+
       def with_interpolations_blanked
         # Ignore the trailing regopt node
         children[0...-1].map do |child|

data/lib/rubocop/ext/regexp_parser.rb

@@ -28,7 +28,7 @@ module RuboCop
               @expression ||= origin.adjust(begin_pos: ts, end_pos: ts + full_length)
             end
           # Please remove this `else` branch when support for regexp_parser 1.8 will be dropped.
-          # It's for compatibility with regexp_arser 1.8 and will never be maintained.
+          # It's for compatibility with regexp_parser 1.8 and will never be maintained.
           else
             attr_accessor :source
 
@@ -68,7 +68,9 @@ module RuboCop
             return { body: expression } unless (q = quantifier)
 
             body = expression.adjust(end_pos: -q.text.length)
-            q_loc = expression.with(begin_pos: body.end_pos)
+            q.origin = origin
+            q.source = source if q.respond_to?(:source=) # for regexp_parser 1.8
+            q_loc = q.expression
             { body: body, quantifier: q_loc }
           end
         end
@@ -86,6 +88,7 @@ module RuboCop
         end
       end
       ::Regexp::Expression::Base.include Expression::Base
+      ::Regexp::Expression::Quantifier.include Expression::Base
       ::Regexp::Expression::CharacterSet.include Expression::CharacterSet
     end
   end

data/lib/rubocop/feature_loader.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This class handles loading files (a.k.a. features in Ruby) specified
+  # by `--require` command line option and `require` directive in the config.
+  #
+  # Normally, the given string is directly passed to `require`. If a string
+  # beginning with `.` is given, it is assumed to be relative to the given
+  # directory.
+  #
+  # If a string containing `-` is given, it will be used as is, but if we
+  # cannot find the file to load, we will replace `-` with `/` and try it
+  # again as when Bundler loads gems.
+  #
+  # @api private
+  class FeatureLoader
+    class << self
+      # @param [String] config_directory_path
+      # @param [String] feature
+      def load(config_directory_path:, feature:)
+        new(config_directory_path: config_directory_path, feature: feature).load
+      end
+    end
+
+    # @param [String] config_directory_path
+    # @param [String] feature
+    def initialize(config_directory_path:, feature:)
+      @config_directory_path = config_directory_path
+      @feature = feature
+    end
+
+    def load
+      # Don't use `::Kernel.require(target)` to prevent the following error:
+      # https://github.com/rubocop/rubocop/issues/10893
+      require(target)
+    rescue ::LoadError => e
+      raise if e.path != target
+
+      begin
+        # Don't use `::Kernel.require(target)` to prevent the following error:
+        # https://github.com/rubocop/rubocop/issues/10893
+        require(namespaced_target)
+      rescue ::LoadError => error_for_namespaced_target
+        # NOTE: This wrap is necessary due to JRuby 9.3.4.0 incompatibility:
+        # https://github.com/jruby/jruby/issues/7316
+        raise LoadError, e if error_for_namespaced_target.path == namespaced_target
+
+        raise error_for_namespaced_target
+      end
+    end
+
+    private
+
+    # @return [String]
+    def namespaced_feature
+      @feature.tr('-', '/')
+    end
+
+    # @return [String]
+    def namespaced_target
+      if relative?
+        relative(namespaced_feature)
+      else
+        namespaced_feature
+      end
+    end
+
+    # @param [String]
+    # @return [String]
+    def relative(feature)
+      ::File.join(@config_directory_path, feature)
+    end
+
+    # @return [Boolean]
+    def relative?
+      @feature.start_with?('.')
+    end
+
+    # @param [LoadError] error
+    # @return [Boolean]
+    def seems_cannot_load_such_file_error?(error)
+      error.path == target
+    end
+
+    # @return [String]
+    def target
+      if relative?
+        relative(@feature)
+      else
+        @feature
+      end
+    end
+  end
+end

data/lib/rubocop/file_finder.rb

@@ -6,12 +6,8 @@ module RuboCop
   # Common methods for finding files.
   # @api private
   module FileFinder
-    def self.root_level=(level)
-      @root_level = level
-    end
-
-    def self.root_level?(path, stop_dir)
-      (@root_level || stop_dir) == path.to_s
+    class << self
+      attr_accessor :root_level
     end
 
     def find_file_upwards(filename, start_dir, stop_dir = nil)
@@ -34,7 +30,8 @@ module RuboCop
         file = dir + filename
         yield(file.to_s) if file.exist?
 
-        break if FileFinder.root_level?(dir, stop_dir)
+        dir = dir.to_s
+        break if dir == stop_dir || dir == FileFinder.root_level
       end
     end
   end

data/lib/rubocop/file_patterns.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # A wrapper around patterns array to perform optimized search.
+  #
+  # For projects with a large set of rubocop todo files, most items in `Exclude`/`Include`
+  # are exact file names. It is wasteful to linearly check the list of patterns over and over
+  # to check if the file is relevant to the cop.
+  #
+  # This class partitions an array of patterns into a set of exact match strings and the rest
+  # of the patterns. This way we can firstly do a cheap check in the set and then proceed via
+  # the costly patterns check, if needed.
+  # @api private
+  class FilePatterns
+    @cache = {}.compare_by_identity
+
+    def self.from(patterns)
+      @cache[patterns] ||= new(patterns)
+    end
+
+    def initialize(patterns)
+      @strings = Set.new
+      @patterns = []
+      partition_patterns(patterns)
+    end
+
+    def match?(path)
+      @strings.include?(path) || @patterns.any? { |pattern| PathUtil.match_path?(pattern, path) }
+    end
+
+    private
+
+    def partition_patterns(patterns)
+      patterns.each do |pattern|
+        if pattern.is_a?(String) && !pattern.match?(/[*{\[?]/)
+          @strings << pattern
+        else
+          @patterns << pattern
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/clang_style_formatter.rb

@@ -24,14 +24,10 @@ module RuboCop
           message: message(offense)
         )
 
-        begin
-          return unless valid_line?(offense)
+        return unless valid_line?(offense)
 
-          report_line(offense.location)
-          report_highlighted_area(offense.highlighted_area)
-        rescue IndexError
-          # range is not on a valid line; perhaps the source file is empty
-        end
+        report_line(offense.location)
+        report_highlighted_area(offense.highlighted_area)
       end
 
       def valid_line?(offense)
@@ -41,7 +37,7 @@ module RuboCop
       def report_line(location)
         source_line = location.source_line
 
-        if location.first_line == location.last_line
+        if location.single_line?
           output.puts(source_line)
         else
           output.puts("#{source_line} #{yellow(ELLIPSES)}")