rubocop 1.29.1 → 1.48.0

data/lib/rubocop/cops_documentation_generator.rb

@@ -33,18 +33,35 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     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)
     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.count.positive?
-    content << configurations(pars)
-    content << references(cop)
+    content << examples(examples_objects) if examples_objects.any?
+    content << configurations(cop.department, pars)
+    content << references(cop, see_objects)
     content
   end
 
+  def check_examples_to_have_the_default_enforced_style!(examples_object, cop)
+    return if examples_object.none?
+
+    examples_describing_enforced_style = examples_object.map(&:name).grep(/EnforcedStyle:/)
+    return if examples_describing_enforced_style.none?
+
+    if examples_describing_enforced_style.index { |name| name.match?('default') }.nonzero?
+      raise "Put the example with the default EnforcedStyle on top for #{cop.cop_name}"
+    end
+
+    return if examples_describing_enforced_style.any? { |name| name.match?('default') }
+
+    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|
       content << "\n" unless content.end_with?("\n\n")
@@ -119,7 +136,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']
@@ -130,12 +147,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
@@ -168,7 +193,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"
@@ -198,21 +224,34 @@ 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
+
   def print_cops_of_department(department)
     selected_cops = cops_of_department(department)
     content = +"= #{department}\n"
     selected_cops.each { |cop| content << print_cop_with_doc(cop) }
+    content << footer_for_department(department)
     file_name = "#{Dir.pwd}/docs/modules/ROOT/pages/#{department_to_basename(department)}.adoc"
     File.open(file_name, 'w') do |file|
       puts "* generated #{file_name}"
@@ -220,7 +259,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     end
   end
 
-  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
@@ -228,13 +267,14 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     ]
     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)

data/lib/rubocop/directive_comment.rb

@@ -35,7 +35,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 +45,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 +108,7 @@ module RuboCop
 
     # Returns line number for directive
     def line_number
-      comment.loc.expression.line
+      comment.source_range.line
     end
 
     private

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/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_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

@@ -41,7 +41,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)}")

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -65,18 +65,26 @@ module RuboCop
         @options.fetch(:offense_counts, true)
       end
 
+      def auto_gen_enforced_style?
+        @options.fetch(:auto_gen_enforced_style, true)
+      end
+
       def command
         command = 'rubocop --auto-gen-config'
 
         command += ' --auto-gen-only-exclude' if @options[:auto_gen_only_exclude]
 
-        if @exclude_limit_option
+        if no_exclude_limit?
+          command += ' --no-exclude-limit'
+        elsif @exclude_limit_option
           command += format(' --exclude-limit %<limit>d', limit: Integer(@exclude_limit_option))
         end
         command += ' --no-offense-counts' unless show_offense_counts?
 
         command += ' --no-auto-gen-timestamp' unless show_timestamp?
 
+        command += ' --no-auto-gen-enforced-style' unless auto_gen_enforced_style?
+
         command
       end
 
@@ -123,10 +131,10 @@ module RuboCop
         cop_class = Cop::Registry.global.find_by_cop_name(cop_name)
         default_cfg = default_config(cop_name)
 
-        if supports_safe_auto_correct?(cop_class, default_cfg)
-          output_buffer.puts '# This cop supports safe auto-correction (--auto-correct).'
+        if supports_safe_autocorrect?(cop_class, default_cfg)
+          output_buffer.puts '# This cop supports safe autocorrection (--autocorrect).'
         elsif supports_unsafe_autocorrect?(cop_class, default_cfg)
-          output_buffer.puts '# This cop supports unsafe auto-correction (--auto-correct-all).'
+          output_buffer.puts '# This cop supports unsafe autocorrection (--autocorrect-all).'
         end
 
         return unless default_cfg
@@ -137,13 +145,12 @@ module RuboCop
         output_cop_param_comments(output_buffer, params, default_cfg)
       end
 
-      def supports_safe_auto_correct?(cop_class, default_cfg)
-        cop_class&.support_autocorrect? &&
-          (default_cfg.nil? || default_cfg['Safe'] || default_cfg['Safe'].nil?)
+      def supports_safe_autocorrect?(cop_class, default_cfg)
+        cop_class&.support_autocorrect? && (default_cfg.nil? || safe_autocorrect?(default_cfg))
       end
 
       def supports_unsafe_autocorrect?(cop_class, default_cfg)
-        cop_class&.support_autocorrect? && !default_cfg.nil? && default_cfg['Safe'] == false
+        cop_class&.support_autocorrect? && !safe_autocorrect?(default_cfg)
       end
 
       def cop_config_params(default_cfg, cfg)
@@ -162,7 +169,7 @@ module RuboCop
           next unless value.is_a?(Array)
           next if value.empty?
 
-          output_buffer.puts "# #{param}: #{value.join(', ')}"
+          output_buffer.puts "# #{param}: #{value.uniq.join(', ')}"
         end
       end
 
@@ -171,24 +178,29 @@ module RuboCop
       end
 
       def output_cop_config(output_buffer, cfg, cop_name)
-        # 'Enabled' option will be put into file only if exclude
-        # limit is exceeded.
-        cfg_without_enabled = cfg.reject { |key| key == 'Enabled' }
-
+        filtered_cfg = filtered_config(cfg)
         output_buffer.puts "#{cop_name}:"
-        cfg_without_enabled.each do |key, value|
+        filtered_cfg.each do |key, value|
           value = value[0] if value.is_a?(Array)
           output_buffer.puts "  #{key}: #{value}"
         end
 
-        output_offending_files(output_buffer, cfg_without_enabled, cop_name)
+        output_offending_files(output_buffer, filtered_cfg, cop_name)
+      end
+
+      def filtered_config(cfg)
+        # 'Enabled' option will be put into file only if exclude
+        # limit is exceeded.
+        rejected_keys = ['Enabled']
+        rejected_keys << 'EnforcedStyle' unless auto_gen_enforced_style?
+        cfg.reject { |key| rejected_keys.include?(key) }
       end
 
       def output_offending_files(output_buffer, cfg, cop_name)
         return unless cfg.empty?
 
         offending_files = @files_with_offenses[cop_name].sort
-        if offending_files.count > @exclude_limit
+        if !no_exclude_limit? && offending_files.count > @exclude_limit
           output_buffer.puts '  Enabled: false'
         else
           output_exclude_list(output_buffer, offending_files, cop_name)
@@ -242,6 +254,14 @@ module RuboCop
         regexp = exclude_path
         output_buffer.puts "    - !ruby/regexp /#{regexp.source}/"
       end
+
+      def safe_autocorrect?(config)
+        config.fetch('Safe', true) && config.fetch('SafeAutoCorrect', true)
+      end
+
+      def no_exclude_limit?
+        @options[:no_exclude_limit] == false
+      end
     end
   end
 end

data/lib/rubocop/formatter/formatter_set.rb

@@ -9,23 +9,23 @@ module RuboCop
     # which invoke same method of each formatters.
     class FormatterSet < Array
       BUILTIN_FORMATTERS_FOR_KEYS = {
-        '[a]utogenconf' => AutoGenConfigFormatter,
-        '[c]lang'       => ClangStyleFormatter,
-        '[e]macs'       => EmacsStyleFormatter,
-        '[fi]les'       => FileListFormatter,
-        '[fu]ubar'      => FuubarStyleFormatter,
-        '[g]ithub'      => GitHubActionsFormatter,
-        '[h]tml'        => HTMLFormatter,
-        '[j]son'        => JSONFormatter,
-        '[ju]nit'       => JUnitFormatter,
-        '[m]arkdown'    => MarkdownFormatter,
-        '[o]ffenses'    => OffenseCountFormatter,
-        '[pa]cman'      => PacmanFormatter,
-        '[p]rogress'    => ProgressFormatter,
-        '[q]uiet'       => QuietFormatter,
-        '[s]imple'      => SimpleTextFormatter,
-        '[t]ap'         => TapFormatter,
-        '[w]orst'       => WorstOffendersFormatter
+        '[a]utogenconf' => 'AutoGenConfigFormatter',
+        '[c]lang'       => 'ClangStyleFormatter',
+        '[e]macs'       => 'EmacsStyleFormatter',
+        '[fi]les'       => 'FileListFormatter',
+        '[fu]ubar'      => 'FuubarStyleFormatter',
+        '[g]ithub'      => 'GitHubActionsFormatter',
+        '[h]tml'        => 'HTMLFormatter',
+        '[j]son'        => 'JSONFormatter',
+        '[ju]nit'       => 'JUnitFormatter',
+        '[m]arkdown'    => 'MarkdownFormatter',
+        '[o]ffenses'    => 'OffenseCountFormatter',
+        '[pa]cman'      => 'PacmanFormatter',
+        '[p]rogress'    => 'ProgressFormatter',
+        '[q]uiet'       => 'QuietFormatter',
+        '[s]imple'      => 'SimpleTextFormatter',
+        '[t]ap'         => 'TapFormatter',
+        '[w]orst'       => 'WorstOffendersFormatter'
       }.freeze
 
       FORMATTER_APIS = %i[started finished].freeze
@@ -55,7 +55,7 @@ module RuboCop
       def add_formatter(formatter_type, output_path = nil)
         if output_path
           dir_path = File.dirname(output_path)
-          FileUtils.mkdir_p(dir_path) unless File.exist?(dir_path)
+          FileUtils.mkdir_p(dir_path)
           output = File.open(output_path, 'w')
         else
           output = $stdout
@@ -92,7 +92,8 @@ module RuboCop
 
         raise %(Cannot determine formatter for "#{specified_key}") if matching_keys.size > 1
 
-        BUILTIN_FORMATTERS_FOR_KEYS[matching_keys.first]
+        formatter_name = BUILTIN_FORMATTERS_FOR_KEYS[matching_keys.first]
+        RuboCop::Formatter.const_get(formatter_name)
       end
 
       def custom_formatter_class(specified_class_name)

data/lib/rubocop/formatter/git_hub_actions_formatter.rb

@@ -7,8 +7,21 @@ module RuboCop
     class GitHubActionsFormatter < BaseFormatter
       ESCAPE_MAP = { '%' => '%25', "\n" => '%0A', "\r" => '%0D' }.freeze
 
+      def started(_target_files)
+        @offenses_for_files = {}
+      end
+
       def file_finished(file, offenses)
-        offenses.each { |offense| report_offense(file, offense) }
+        @offenses_for_files[file] = offenses unless offenses.empty?
+      end
+
+      def finished(_inspected_files)
+        @offenses_for_files.each do |file, offenses|
+          offenses.each do |offense|
+            report_offense(file, offense)
+          end
+        end
+        output.puts
       end
 
       private
@@ -31,7 +44,7 @@ module RuboCop
 
       def report_offense(file, offense)
         output.printf(
-          "\n::%<severity>s file=%<file>s,line=%<line>d,col=%<column>d::%<message>s\n",
+          "\n::%<severity>s file=%<file>s,line=%<line>d,col=%<column>d::%<message>s",
           severity: github_severity(offense),
           file: PathUtil.smart_path(file),
           line: offense.line,

data/lib/rubocop/formatter/html_formatter.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
+require 'base64'
 require 'cgi'
 require 'erb'
 require 'ostruct'
-require 'base64'
-require_relative 'text_util'
 
 module RuboCop
   module Formatter
@@ -94,12 +93,12 @@ module RuboCop
 
         def highlighted_source_line(offense)
           source_before_highlight(offense) +
-            hightlight_source_tag(offense) +
+            highlight_source_tag(offense) +
             source_after_highlight(offense) +
             possible_ellipses(offense.location)
         end
 
-        def hightlight_source_tag(offense)
+        def highlight_source_tag(offense)
           "<span class=\"highlight #{offense.severity}\">" \
             "#{escape(offense.highlighted_area.source)}" \
             '</span>'
@@ -116,7 +115,7 @@ module RuboCop
         end
 
         def possible_ellipses(location)
-          location.first_line == location.last_line ? '' : " #{ELLIPSES}"
+          location.single_line? ? '' : " #{ELLIPSES}"
         end
 
         def escape(string)

data/lib/rubocop/formatter/junit_formatter.rb

@@ -62,7 +62,10 @@ module RuboCop
       end
 
       def classname_attribute_value(file)
-        file.gsub(/\.rb\Z/, '').gsub("#{Dir.pwd}/", '').tr('/', '.')
+        @classname_attribute_value_cache ||= Hash.new do |hash, key|
+          hash[key] = key.gsub(/\.rb\Z/, '').gsub("#{Dir.pwd}/", '').tr('/', '.')
+        end
+        @classname_attribute_value_cache[file]
       end
 
       def finished(_inspected_files)

data/lib/rubocop/formatter/markdown_formatter.rb

@@ -41,6 +41,8 @@ module RuboCop
 
       def write_file_messages
         files.each do |file|
+          next if file.offenses.empty?
+
           write_heading(file)
           file.offenses.each do |offense|
             write_context(offense)
@@ -69,7 +71,7 @@ module RuboCop
       end
 
       def possible_ellipses(location)
-        location.first_line == location.last_line ? '' : ' ...'
+        location.single_line? ? '' : ' ...'
       end
     end
   end