rubocop 1.40.0 → 1.42.0

data/lib/rubocop/cops_documentation_generator.rb

@@ -33,7 +33,7 @@ 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)
@@ -42,8 +42,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
 
@@ -136,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']
@@ -147,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
@@ -216,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}"
@@ -238,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
@@ -246,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

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.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module RuboCop
+  # The bootstrap module for formatter.
+  # @api private
   module Formatter
     require_relative 'formatter/text_util'
 

data/lib/rubocop/options.rb

@@ -465,7 +465,7 @@ module RuboCop
 
   # This module contains help texts for command line options.
   # @api private
-  module OptionsHelp # rubocop:disable Metrics/ModuleLength
+  module OptionsHelp
     MAX_EXCL = RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS.to_s
     FORMATTER_OPTION_LIST = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys
 

data/lib/rubocop/path_util.rb

@@ -3,23 +3,29 @@
 module RuboCop
   # Common methods and behaviors for dealing with paths.
   module PathUtil
+    class << self
+      attr_accessor :relative_paths_cache
+    end
+    self.relative_paths_cache = Hash.new { |hash, key| hash[key] = {} }
+
     module_function
 
     def relative_path(path, base_dir = Dir.pwd)
-      # Optimization for the common case where path begins with the base
-      # dir. Just cut off the first part.
-      if path.start_with?(base_dir)
-        base_dir_length = base_dir.length
-        result_length = path.length - base_dir_length - 1
-        return path[base_dir_length + 1, result_length]
-      end
-
-      path_name = Pathname.new(File.expand_path(path))
-      begin
-        path_name.relative_path_from(Pathname.new(base_dir)).to_s
-      rescue ArgumentError
-        path
-      end
+      PathUtil.relative_paths_cache[base_dir][path] ||=
+        # Optimization for the common case where path begins with the base
+        # dir. Just cut off the first part.
+        if path.start_with?(base_dir)
+          base_dir_length = base_dir.length
+          result_length = path.length - base_dir_length - 1
+          path[base_dir_length + 1, result_length]
+        else
+          path_name = Pathname.new(File.expand_path(path))
+          begin
+            path_name.relative_path_from(Pathname.new(base_dir)).to_s
+          rescue ArgumentError
+            path
+          end
+        end
     end
 
     def smart_path(path)
@@ -40,7 +46,7 @@ module RuboCop
         matches =
           if pattern == path
             true
-          elsif pattern.match?(/[*{\[?]/)
+          elsif glob?(pattern)
             File.fnmatch?(pattern, path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
           end
 
@@ -62,6 +68,11 @@ module RuboCop
       %r{\A([A-Z]:)?/}i.match?(path)
     end
 
+    # Returns true for a glob
+    def glob?(path)
+      path.match?(/[*{\[?]/)
+    end
+
     def hidden_file_in_not_hidden_dir?(pattern, path)
       hidden_file?(path) &&
         File.fnmatch?(

data/lib/rubocop/result_cache.rb

@@ -53,7 +53,7 @@ module RuboCop
       def remove_oldest_files(files, dirs, cache_root, verbose)
         # Add 1 to half the number of files, so that we remove the file if
         # there's only 1 left.
-        remove_count = 1 + (files.length / 2)
+        remove_count = (files.length / 2) + 1
         puts "Removing the #{remove_count} oldest files from #{cache_root}" if verbose
         sorted = files.sort_by { |path| File.mtime(path) }
         remove_files(sorted, dirs, remove_count)

data/lib/rubocop/runner.rb

@@ -27,6 +27,11 @@ module RuboCop
     # @api private
     MAX_ITERATIONS = 200
 
+    # @api private
+    REDUNDANT_COP_DISABLE_DIRECTIVE_RULES = %w[
+      Lint/RedundantCopDisableDirective RedundantCopDisableDirective Lint
+    ].freeze
+
     attr_reader :errors, :warnings
     attr_writer :aborting
 
@@ -194,7 +199,9 @@ module RuboCop
     end
 
     def check_for_redundant_disables?(source)
-      !source.disabled_line_ranges.empty? && !filtered_run?
+      return false if source.disabled_line_ranges.empty? || except_redundant_cop_disable_directive?
+
+      !@options[:only]
     end
 
     def redundant_cop_disable_directive(file)
@@ -205,8 +212,8 @@ module RuboCop
       yield cop if cop.relevant_file?(file)
     end
 
-    def filtered_run?
-      @options[:except] || @options[:only]
+    def except_redundant_cop_disable_directive?
+      @options[:except] && (@options[:except] & REDUNDANT_COP_DISABLE_DIRECTIVE_RULES).any?
     end
 
     def file_started(file)

data/lib/rubocop/target_finder.rb

@@ -88,7 +88,7 @@ module RuboCop
       patterns.map! { |dir| File.join(dir, '*') }
       # We need this special case to avoid creating the pattern
       # /**/* which searches the entire file system.
-      patterns = [File.join(dir, '**/*')] if patterns.empty?
+      patterns = [File.join(base_dir, '**/*')] if patterns.empty?
 
       Dir.glob(patterns, flags).select { |path| FileTest.file?(path) }
     end

data/lib/rubocop/target_ruby.rb

@@ -244,7 +244,6 @@ module RuboCop
     ].freeze
 
     private_constant :SOURCES
-
     def initialize(config)
       @config = config
     end

data/lib/rubocop/version.rb

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

data/lib/rubocop.rb

@@ -23,8 +23,8 @@ require_relative 'rubocop/ext/processed_source'
 
 require_relative 'rubocop/error'
 require_relative 'rubocop/file_finder'
+require_relative 'rubocop/file_patterns'
 require_relative 'rubocop/name_similarity'
-require_relative 'rubocop/optimized_patterns'
 require_relative 'rubocop/path_util'
 require_relative 'rubocop/platform'
 require_relative 'rubocop/string_interpreter'
@@ -470,6 +470,7 @@ require_relative 'rubocop/cop/style/combinable_loops'
 require_relative 'rubocop/cop/style/command_literal'
 require_relative 'rubocop/cop/style/comment_annotation'
 require_relative 'rubocop/cop/style/commented_keyword'
+require_relative 'rubocop/cop/style/concat_array_literals'
 require_relative 'rubocop/cop/style/conditional_assignment'
 require_relative 'rubocop/cop/style/constant_visibility'
 require_relative 'rubocop/cop/style/copyright'
@@ -537,14 +538,17 @@ require_relative 'rubocop/cop/style/lambda_call'
 require_relative 'rubocop/cop/style/line_end_concatenation'
 require_relative 'rubocop/cop/style/magic_comment_format'
 require_relative 'rubocop/cop/style/map_to_hash'
+require_relative 'rubocop/cop/style/map_to_set'
 require_relative 'rubocop/cop/style/method_call_without_args_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
+require_relative 'rubocop/cop/style/min_max_comparison'
 require_relative 'rubocop/cop/style/multiline_in_pattern_then'
 require_relative 'rubocop/cop/style/numbered_parameters'
 require_relative 'rubocop/cop/style/open_struct_use'
 require_relative 'rubocop/cop/style/operator_method_call'
 require_relative 'rubocop/cop/style/redundant_assignment'
 require_relative 'rubocop/cop/style/redundant_constant_base'
+require_relative 'rubocop/cop/style/redundant_double_splat_hash_braces'
 require_relative 'rubocop/cop/style/redundant_each'
 require_relative 'rubocop/cop/style/redundant_fetch_block'
 require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
@@ -673,6 +677,7 @@ require_relative 'rubocop/cop/style/while_until_do'
 require_relative 'rubocop/cop/style/while_until_modifier'
 require_relative 'rubocop/cop/style/word_array'
 require_relative 'rubocop/cop/style/yoda_condition'
+require_relative 'rubocop/cop/style/yoda_expression'
 require_relative 'rubocop/cop/style/zero_length_predicate'
 
 require_relative 'rubocop/cop/security/compound_hash'

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.40.0
+  version: 1.42.0
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Yuji Nakayama
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-08 00:00:00.000000000 Z
+date: 2023-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -120,7 +120,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.24.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.24.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -691,6 +691,7 @@ files:
 - lib/rubocop/cop/style/command_literal.rb
 - lib/rubocop/cop/style/comment_annotation.rb
 - lib/rubocop/cop/style/commented_keyword.rb
+- lib/rubocop/cop/style/concat_array_literals.rb
 - lib/rubocop/cop/style/conditional_assignment.rb
 - lib/rubocop/cop/style/constant_visibility.rb
 - lib/rubocop/cop/style/copyright.rb
@@ -759,6 +760,7 @@ files:
 - lib/rubocop/cop/style/magic_comment_format.rb
 - lib/rubocop/cop/style/map_compact_with_conditional_block.rb
 - lib/rubocop/cop/style/map_to_hash.rb
+- lib/rubocop/cop/style/map_to_set.rb
 - lib/rubocop/cop/style/method_call_with_args_parentheses.rb
 - lib/rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses.rb
 - lib/rubocop/cop/style/method_call_with_args_parentheses/require_parentheses.rb
@@ -766,6 +768,7 @@ files:
 - lib/rubocop/cop/style/method_called_on_do_end_block.rb
 - lib/rubocop/cop/style/method_def_parentheses.rb
 - lib/rubocop/cop/style/min_max.rb
+- lib/rubocop/cop/style/min_max_comparison.rb
 - lib/rubocop/cop/style/missing_else.rb
 - lib/rubocop/cop/style/missing_respond_to_missing.rb
 - lib/rubocop/cop/style/mixin_grouping.rb
@@ -824,6 +827,7 @@ files:
 - lib/rubocop/cop/style/redundant_condition.rb
 - lib/rubocop/cop/style/redundant_conditional.rb
 - lib/rubocop/cop/style/redundant_constant_base.rb
+- lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb
 - lib/rubocop/cop/style/redundant_each.rb
 - lib/rubocop/cop/style/redundant_exception.rb
 - lib/rubocop/cop/style/redundant_fetch_block.rb
@@ -896,6 +900,7 @@ files:
 - lib/rubocop/cop/style/while_until_modifier.rb
 - lib/rubocop/cop/style/word_array.rb
 - lib/rubocop/cop/style/yoda_condition.rb
+- lib/rubocop/cop/style/yoda_expression.rb
 - lib/rubocop/cop/style/zero_length_predicate.rb
 - lib/rubocop/cop/team.rb
 - lib/rubocop/cop/util.rb
@@ -918,6 +923,7 @@ files:
 - lib/rubocop/ext/regexp_parser.rb
 - lib/rubocop/feature_loader.rb
 - lib/rubocop/file_finder.rb
+- lib/rubocop/file_patterns.rb
 - lib/rubocop/formatter.rb
 - lib/rubocop/formatter/auto_gen_config_formatter.rb
 - lib/rubocop/formatter/base_formatter.rb
@@ -944,7 +950,6 @@ files:
 - lib/rubocop/lockfile.rb
 - lib/rubocop/magic_comment.rb
 - lib/rubocop/name_similarity.rb
-- lib/rubocop/optimized_patterns.rb
 - lib/rubocop/options.rb
 - lib/rubocop/path_util.rb
 - lib/rubocop/platform.rb
@@ -990,10 +995,10 @@ metadata:
   homepage_uri: https://rubocop.org/
   changelog_uri: https://github.com/rubocop/rubocop/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop/
-  documentation_uri: https://docs.rubocop.org/rubocop/1.40/
+  documentation_uri: https://docs.rubocop.org/rubocop/1.42/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -1008,8 +1013,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Automatic Ruby code style checking tool.
 test_files: []

data/lib/rubocop/optimized_patterns.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  # @api private
-  module OptimizedPatterns
-    # A wrapper around patterns array to perform optimized search.
-    # @api private
-    class PatternsSet
-      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
-
-    @cache = {}.compare_by_identity
-
-    def self.from(patterns)
-      @cache[patterns] ||= PatternsSet.new(patterns)
-    end
-  end
-end