rubocop 1.40.0 → 1.41.0

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for redundant uses of double splat hash braces.
+      #
+      # @example
+      #
+      #   # bad
+      #   do_something(**{foo: bar, baz: qux})
+      #
+      #   # good
+      #   do_something(foo: bar, baz: qux)
+      #
+      class RedundantDoubleSplatHashBraces < Base
+        extend AutoCorrector
+
+        MSG = 'Remove the redundant double splat and braces, use keyword arguments directly.'
+
+        # @!method double_splat_hash_braces?(node)
+        def_node_matcher :double_splat_hash_braces?, <<~PATTERN
+          (hash (kwsplat (hash ...)))
+        PATTERN
+
+        def on_hash(node)
+          return if node.pairs.empty? || node.pairs.any?(&:hash_rocket?)
+
+          grandparent = node.parent&.parent
+          return unless double_splat_hash_braces?(grandparent)
+
+          add_offense(grandparent) do |corrector|
+            corrector.replace(grandparent, node.pairs.map(&:source).join(', '))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -36,6 +36,33 @@ module RuboCop
       #   require 'b'
       #   require_relative 'c'
       #   require 'a'
+      #
+      #   # bad
+      #   require 'a'
+      #   require 'c' if foo
+      #   require 'b'
+      #
+      #   # good
+      #   require 'a'
+      #   require 'b'
+      #   require 'c' if foo
+      #
+      #   # bad
+      #   require 'c'
+      #   if foo
+      #     require 'd'
+      #     require 'b'
+      #   end
+      #   require 'a'
+      #
+      #   # good
+      #   require 'c'
+      #   if foo
+      #     require 'b'
+      #     require 'd'
+      #   end
+      #   require 'a'
+      #
       class RequireOrder < Base
         extend AutoCorrector
 
@@ -43,17 +70,27 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[require require_relative].freeze
 
+        MSG = 'Sort `%<name>s` in alphabetical order.'
+
+        # @!method if_inside_only_require(node)
+        def_node_matcher :if_inside_only_require, <<~PATTERN
+          {
+            (if _ _ $(send nil? {:require :require_relative} _))
+            (if _ $(send nil? {:require :require_relative} _) _)
+          }
+        PATTERN
+
         def on_send(node)
+          return unless node.arguments?
+          return if not_modifier_form?(node.parent)
+
           previous_older_sibling = find_previous_older_sibling(node)
           return unless previous_older_sibling
 
-          add_offense(
-            node,
-            message: "Sort `#{node.method_name}` in alphabetical order."
-          ) do |corrector|
+          add_offense(node, message: format(MSG, name: node.method_name)) do |corrector|
             swap(
               range_with_comments_and_lines(previous_older_sibling),
-              range_with_comments_and_lines(node),
+              range_with_comments_and_lines(node.parent.if_type? ? node.parent : node),
               corrector: corrector
             )
           end
@@ -61,16 +98,31 @@ module RuboCop
 
         private
 
-        def find_previous_older_sibling(node)
-          node.left_siblings.reverse.find do |sibling|
-            break unless sibling.send_type?
-            break unless sibling.method?(node.method_name)
+        def not_modifier_form?(node)
+          node.if_type? && !node.modifier_form?
+        end
+
+        def find_previous_older_sibling(node) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity
+          search_node(node).left_siblings.reverse.find do |sibling|
+            sibling = sibling_node(sibling)
+            break unless sibling&.send_type? && sibling&.method?(node.method_name)
+            break unless sibling.arguments? && !sibling.receiver
             break unless in_same_section?(sibling, node)
 
             node.first_argument.source < sibling.first_argument.source
           end
         end
 
+        def search_node(node)
+          node.parent.if_type? ? node.parent : node
+        end
+
+        def sibling_node(node)
+          return if not_modifier_form?(node)
+
+          node.if_type? ? if_inside_only_require(node) : node
+        end
+
         def in_same_section?(node1, node2)
           !node1.location.expression.with(
             end_pos: node2.location.expression.end_pos

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

@@ -37,13 +37,14 @@ module RuboCop
         end
 
         def on_new_investigation
-          return if processed_source.blank?
+          return if processed_source.blank? || !processed_source.raw_source.include?(';')
 
           check_for_line_terminator_or_opener
         end
 
         def on_begin(node)
           return if cop_config['AllowAsExpressionSeparator']
+          return unless node.source.include?(';')
 
           exprs = node.children
 

data/lib/rubocop/cop/util.rb

@@ -52,6 +52,21 @@ module RuboCop
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
+      def any_descendant?(node, *types)
+        if block_given?
+          node.each_descendant(*types) do |descendant|
+            return true if yield(descendant)
+          end
+        else
+          # Use a block version to avoid allocating enumerators.
+          node.each_descendant do # rubocop:disable Lint/UnreachableLoop
+            return true
+          end
+        end
+
+        false
+      end
+
       def args_begin(node)
         loc = node.loc
         selector = if node.super_type? || node.yield_type?
@@ -71,14 +86,19 @@ module RuboCop
       def on_node(syms, sexp, excludes = [], &block)
         return to_enum(:on_node, syms, sexp, excludes) unless block
 
-        yield sexp if Array(syms).include?(sexp.type)
-        return if Array(excludes).include?(sexp.type)
+        yield sexp if include_or_equal?(syms, sexp.type)
+        return if include_or_equal?(excludes, sexp.type)
 
         sexp.each_child_node { |elem| on_node(syms, elem, excludes, &block) }
       end
 
+      LINE_BEGINS_REGEX_CACHE = Hash.new do |hash, index|
+        hash[index] = /^\s{#{index}}\S/
+      end
+      private_constant :LINE_BEGINS_REGEX_CACHE
+
       def begins_its_line?(range)
-        range.source_line.index(/\S/) == range.column
+        range.source_line.match?(LINE_BEGINS_REGEX_CACHE[range.column])
       end
 
       # Returns, for example, a bare `if` node if the given node is an `if`
@@ -152,8 +172,11 @@ module RuboCop
         ' ' * (node.loc.column + offset)
       end
 
+      @to_supported_styles_cache = {}
+
       def to_supported_styles(enforced_style)
-        enforced_style.sub(/^Enforced/, 'Supported').sub('Style', 'Styles')
+        @to_supported_styles_cache[enforced_style] ||=
+          enforced_style.sub(/^Enforced/, 'Supported').sub('Style', 'Styles')
       end
 
       private
@@ -162,6 +185,10 @@ module RuboCop
         src = src.dup if RUBY_ENGINE == 'jruby'
         src.force_encoding(Encoding.default_external).valid_encoding?
       end
+
+      def include_or_equal?(source, target)
+        source == target || (source.is_a?(Array) && source.include?(target))
+      end
     end
   end
 end

data/lib/rubocop/cops_documentation_generator.rb

@@ -42,7 +42,7 @@ 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 << configurations(cop.department, pars)
     content << references(cop)
     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
@@ -227,10 +235,21 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     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}"

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

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

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.40.0'
+    STRING = '1.41.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'
@@ -545,6 +546,7 @@ 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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.40.0
+  version: 1.41.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-08 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -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
@@ -824,6 +825,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
@@ -918,6 +920,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 +947,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,7 +992,7 @@ 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.41/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
 post_install_message: 

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