rubocop 1.32.0 → 1.35.1

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

@@ -148,7 +148,18 @@ module RuboCop
           )
           corrector.replace(range, and_operator)
           corrector.remove(range_by_whole_lines(node.loc.end, include_final_newline: true))
-          corrector.wrap(if_branch.condition, '(', ')') if wrap_condition?(if_branch.condition)
+
+          wrap_condition(corrector, if_branch.condition)
+        end
+
+        def wrap_condition(corrector, condition)
+          # Handle `send` and `block` nodes that need to be wrapped in parens
+          # FIXME: autocorrection prevents syntax errors by wrapping the entire node in parens,
+          #        but wrapping the argument list would be a more ergonomic correction.
+          node_to_check = condition&.block_type? ? condition.send_node : condition
+          return unless wrap_condition?(node_to_check)
+
+          corrector.wrap(condition, '(', ')')
         end
 
         def correct_for_outer_condition_modify_form_style(corrector, node, if_branch)
@@ -162,8 +173,6 @@ module RuboCop
         end
 
         def correct_for_comment(corrector, node, if_branch)
-          return if config.for_cop('Style/IfUnlessModifier')['Enabled']
-
           comments = processed_source.ast_with_comments[if_branch]
           comment_text = comments.map(&:text).join("\n") << "\n"
 
@@ -207,7 +216,7 @@ module RuboCop
         end
 
         def require_parentheses?(condition)
-          condition.send_type? && !condition.arguments.empty? && !condition.parenthesized? &&
+          condition.call_type? && !condition.arguments.empty? && !condition.parenthesized? &&
             !condition.comparison_method?
         end
 
@@ -219,7 +228,7 @@ module RuboCop
 
         def wrap_condition?(node)
           node.and_type? || node.or_type? ||
-            (node.send_type? && node.arguments.any? && !node.parenthesized?)
+            (node.call_type? && node.arguments.any? && !node.parenthesized?)
         end
 
         def replace_condition(condition)

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

@@ -69,7 +69,7 @@ module RuboCop
             if c.dsym_type?
               string_literal = to_string_literal(c.source)
 
-              ":#{trim_string_interporation_escape_character(string_literal)}"
+              ":#{trim_string_interpolation_escape_character(string_literal)}"
             else
               to_symbol_literal(c.value.to_s)
             end

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

@@ -7,13 +7,13 @@ module RuboCop
       #
       # If you prefer a style that allows block for method with arguments,
       # please set `true` to `AllowMethodsWithArguments`.
-      # respond_to , and `define_method?` methods are ignored by default.
-      # These are customizable with `IgnoredMethods` option.
+      # respond_to , and `define_method?` methods are allowed by default.
+      # These are customizable with `AllowedMethods` option.
       #
       # @safety
       #   This cop is unsafe because `proc`s and blocks work differently
       #   when additional arguments are passed in. A block will silently
-      #   ignore additional arguments, but a `proc` will raise
+      #   allow additional arguments, but a `proc` will raise
       #   an `ArgumentError`.
       #
       #   For example:
@@ -71,15 +71,25 @@ module RuboCop
       #     # some comment
       #   end
       #
-      # @example IgnoredMethods: [respond_to, define_method] (default)
+      # @example AllowedMethods: [respond_to, define_method] (default)
       #   # good
       #   respond_to { |foo| foo.bar }
       #   define_method(:foo) { |foo| foo.bar }
       #
+      #
+      # @example AllowedPatterns: [] (default)
+      #   # bad
+      #   something.map { |s| s.upcase }
+      #
+      # @example AllowedPatterns: [/map/] (default)
+      #   # good
+      #   something.map { |s| s.upcase }
+      #
       class SymbolProc < Base
         include CommentsHelp
         include RangeHelp
-        include IgnoredMethods
+        include AllowedMethods
+        include AllowedPattern
         extend AutoCorrector
 
         MSG = 'Pass `&:%<method>s` as an argument to `%<block_method>s` instead of a block.'
@@ -103,15 +113,17 @@ module RuboCop
           [Layout::SpaceBeforeBlockBraces]
         end
 
-        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def on_block(node)
           symbol_proc?(node) do |dispatch_node, arguments_node, method_name|
             # TODO: Rails-specific handling that we should probably make
             # configurable - https://github.com/rubocop/rubocop/issues/1485
-            # we should ignore lambdas & procs
+            # we should allow lambdas & procs
             return if proc_node?(dispatch_node)
+            return if unsafe_hash_usage?(dispatch_node)
+            return if unsafe_array_usage?(dispatch_node)
             return if %i[lambda proc].include?(dispatch_node.method_name)
-            return if ignored_method?(dispatch_node.method_name)
+            return if allowed_method_name?(dispatch_node.method_name)
             return if allow_if_method_has_argument?(node.send_node)
             return if node.block_type? && destructuring_block_argument?(arguments_node)
             return if allow_comments? && contains_comments?(node)
@@ -119,7 +131,7 @@ module RuboCop
             register_offense(node, method_name, dispatch_node.method_name)
           end
         end
-        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         alias on_numblock on_block
 
         def destructuring_block_argument?(argument_node)
@@ -128,6 +140,19 @@ module RuboCop
 
         private
 
+        # See: https://github.com/rubocop/rubocop/issues/10864
+        def unsafe_hash_usage?(node)
+          node.receiver&.hash_type? && %i[reject select].include?(node.method_name)
+        end
+
+        def unsafe_array_usage?(node)
+          node.receiver&.array_type? && %i[min max].include?(node.method_name)
+        end
+
+        def allowed_method_name?(name)
+          allowed_method?(name) || matches_allowed_pattern?(name)
+        end
+
         def register_offense(node, method_name, block_method_name)
           block_start = node.loc.begin.begin_pos
           block_end = node.loc.end.end_pos

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

@@ -71,7 +71,7 @@ module RuboCop
 
           return if only_closing_parenthesis_is_last_line?(condition)
           return if condition_as_parenthesized_one_line_pattern_matching?(condition)
-          return unless node.ternary? && !infinite_loop? && offense?(node)
+          return unless node.ternary? && offense?(node)
 
           message = message(node)
 
@@ -166,22 +166,10 @@ module RuboCop
           style == :require_parentheses_when_complex
         end
 
-        def redundant_parentheses_enabled?
-          @config.for_cop('Style/RedundantParentheses').fetch('Enabled')
-        end
-
         def parenthesized?(node)
           node.begin_type?
         end
 
-        # When this cop is configured to enforce parentheses and the
-        # `RedundantParentheses` cop is enabled, it will cause an infinite loop
-        # as they compete to add and remove the parentheses respectively.
-        def infinite_loop?
-          (require_parentheses? || require_parentheses_when_complex?) &&
-            redundant_parentheses_enabled?
-        end
-
         def unsafe_autocorrect?(condition)
           condition.children.any? do |child|
             unparenthesized_method_call?(child) || below_ternary_precedence?(child)

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

@@ -63,6 +63,8 @@ module RuboCop
           add_offense(node)
         end
 
+        alias on_numblock on_block
+
         private
 
         def top_level_method_definition?(node)
@@ -75,7 +77,7 @@ module RuboCop
 
         # @!method define_method_block?(node)
         def_node_matcher :define_method_block?, <<~PATTERN
-          (block (send _ {:define_method} _) ...)
+          ({block numblock} (send _ {:define_method} _) ...)
         PATTERN
       end
     end

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

@@ -64,7 +64,7 @@ module RuboCop
 
         MSG = 'Useless trailing comma present in block arguments.'
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           # lambda literal (`->`) never has block arguments.
           return if node.send_node.lambda_literal?
           return unless useless_trailing_comma?(node)

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

@@ -87,7 +87,7 @@ module RuboCop
             if word.dstr_type?
               string_literal = to_string_literal(word.source)
 
-              trim_string_interporation_escape_character(string_literal)
+              trim_string_interpolation_escape_character(string_literal)
             else
               to_string_literal(word.children[0])
             end

data/lib/rubocop/cop/util.rb

@@ -126,7 +126,7 @@ module RuboCop
         end
       end
 
-      def trim_string_interporation_escape_character(str)
+      def trim_string_interpolation_escape_character(str)
         str.gsub(/\\\#\{(.*?)\}/) { "\#{#{Regexp.last_match(1)}}" }
       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/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

@@ -161,7 +161,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
 

data/lib/rubocop/formatter/html_formatter.rb

@@ -93,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>'
@@ -115,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/markdown_formatter.rb

@@ -71,7 +71,7 @@ module RuboCop
       end
 
       def possible_ellipses(location)
-        location.first_line == location.last_line ? '' : ' ...'
+        location.single_line? ? '' : ' ...'
       end
     end
   end

data/lib/rubocop/formatter/tap_formatter.rb

@@ -29,7 +29,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/result_cache.rb

@@ -4,6 +4,7 @@ require 'digest/sha1'
 require 'find'
 require 'etc'
 require 'zlib'
+require_relative 'cache_config'
 
 module RuboCop
   # Provides functionality for caching RuboCop runs.
@@ -13,6 +14,12 @@ module RuboCop
                       fix_layout autocorrect safe_autocorrect autocorrect_all
                       cache fail_fast stdin parallel].freeze
 
+    DL_EXTENSIONS = ::RbConfig::CONFIG
+                    .values_at('DLEXT', 'DLEXT2')
+                    .reject { |ext| !ext || ext.empty? }
+                    .map    { |ext| ".#{ext}" }
+                    .freeze
+
     # Remove old files so that the cache doesn't grow too big. When the
     # threshold MaxFilesInCache has been exceeded, the oldest 50% of all the
     # files in the cache are removed. The reason for removing so much is that
@@ -67,24 +74,9 @@ module RuboCop
     end
 
     def self.cache_root(config_store)
-      root = ENV.fetch('RUBOCOP_CACHE_ROOT', nil)
-      root ||= config_store.for_pwd.for_all_cops['CacheRootDirectory']
-      root ||= if ENV.key?('XDG_CACHE_HOME')
-                 # Include user ID in the path to make sure the user has write
-                 # access.
-                 File.join(ENV.fetch('XDG_CACHE_HOME'), Process.uid.to_s)
-               else
-                 # On FreeBSD, the /home path is a symbolic link to /usr/home
-                 # and the $HOME environment variable returns the /home path.
-                 #
-                 # As $HOME is a built-in environment variable, FreeBSD users
-                 # always get a warning message.
-                 #
-                 # To avoid raising warn log messages on FreeBSD, we retrieve
-                 # the real path of the home folder.
-                 File.join(File.realpath(Dir.home), '.cache')
-               end
-      File.join(root, 'rubocop_cache')
+      CacheConfig.root_dir do
+        config_store.for_pwd.for_all_cops['CacheRootDirectory']
+      end
     end
 
     def self.allow_symlinks_in_cache_location?(config_store)
@@ -188,14 +180,24 @@ module RuboCop
             .select { |path| File.file?(path) }
             .sort!
             .each do |path|
-              content = File.binread(path)
-              digest << Zlib.crc32(content).to_s # mtime not reliable
+              digest << digest(path)
             end
           digest << RuboCop::Version::STRING << RuboCop::AST::Version::STRING
           digest.hexdigest
         end
     end
 
+    def digest(path)
+      content = if path.end_with?(*DL_EXTENSIONS)
+                  # Shared libraries often contain timestamps of when
+                  # they were compiled and other non-stable data.
+                  File.basename(path)
+                else
+                  File.binread(path) # mtime not reliable
+                end
+      Zlib.crc32(content).to_s
+    end
+
     def rubocop_extra_features
       lib_root = File.join(File.dirname(__FILE__), '..')
       exe_root = File.join(lib_root, '..', 'exe')

data/lib/rubocop/server/cache.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'pathname'
+require_relative '../cache_config'
+require_relative '../config_finder'
 
 #
 # This code is based on https://github.com/fohte/rubocop-daemon.
@@ -19,6 +21,8 @@ module RuboCop
       GEMFILE_NAMES = %w[Gemfile gems.rb].freeze
 
       class << self
+        attr_accessor :cache_root_path
+
         # Searches for Gemfile or gems.rb in the current dir or any parent dirs
         def project_dir
           current_dir = Dir.pwd
@@ -38,12 +42,43 @@ module RuboCop
         end
 
         def dir
-          cache_path = File.expand_path('~/.cache/rubocop_cache/server')
           Pathname.new(File.join(cache_path, project_dir_cache_key)).tap do |d|
             d.mkpath unless d.exist?
           end
         end
 
+        def cache_path
+          cache_root_dir = if cache_root_path
+                             File.join(cache_root_path, 'rubocop_cache')
+                           else
+                             cache_root_dir_from_config
+                           end
+
+          File.expand_path(File.join(cache_root_dir, 'server'))
+        end
+
+        def cache_root_dir_from_config
+          CacheConfig.root_dir do
+            # `RuboCop::ConfigStore` has heavy dependencies, this is a lightweight implementation
+            # so that only the necessary `CacheRootDirectory` can be obtained.
+            require 'yaml'
+            config_path = ConfigFinder.find_config_path(Dir.pwd)
+
+            require 'erb'
+            file_contents = File.read(config_path)
+            yaml_code = ERB.new(file_contents).result
+
+            config_yaml = YAML.safe_load(yaml_code, permitted_classes: [Regexp, Symbol])
+
+            # For compatibility with Ruby 3.0 or lower.
+            if Gem::Version.new(Psych::VERSION) < Gem::Version.new('4.0.0')
+              config_yaml == false ? nil : config_yaml
+            end
+
+            config_yaml&.dig('AllCops', 'CacheRootDirectory')
+          end
+        end
+
         def port_path
           dir.join('port')
         end

data/lib/rubocop/server/cli.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'optparse'
 require 'rainbow'
 
 #
@@ -30,6 +29,7 @@ module RuboCop
         @exit = false
       end
 
+      # rubocop:disable Metrics/MethodLength
       def run(argv = ARGV)
         unless Server.support_server?
           return error('RuboCop server is not supported by this Ruby.') if use_server_option?(argv)
@@ -37,6 +37,7 @@ module RuboCop
           return STATUS_SUCCESS
         end
 
+        Cache.cache_root_path = fetch_cache_root_path_from(argv)
         deleted_server_arguments = delete_server_argument_from(argv)
 
         if deleted_server_arguments.size >= 2
@@ -45,7 +46,7 @@ module RuboCop
 
         server_command = deleted_server_arguments.first
 
-        if EXCLUSIVE_OPTIONS.include?(server_command) && argv.count >= 2
+        if EXCLUSIVE_OPTIONS.include?(server_command) && argv.count > allowed_option_count
           return error("#{server_command} cannot be combined with other options.")
         end
 
@@ -53,6 +54,7 @@ module RuboCop
 
         STATUS_SUCCESS
       end
+      # rubocop:enable Metrics/MethodLength
 
       def exit?
         @exit
@@ -83,6 +85,17 @@ module RuboCop
       end
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength:
 
+      def fetch_cache_root_path_from(arguments)
+        cache_root = arguments.detect { |argument| argument.start_with?('--cache-root') }
+        return unless cache_root
+
+        if cache_root.start_with?('--cache-root=')
+          cache_root.split('=')[1]
+        else
+          arguments[arguments.index(cache_root) + 1]
+        end
+      end
+
       def delete_server_argument_from(all_arguments)
         SERVER_OPTIONS.each_with_object([]) do |server_option, server_arguments|
           server_arguments << all_arguments.delete(server_option)
@@ -93,6 +106,10 @@ module RuboCop
         (argv & SERVER_OPTIONS).any?
       end
 
+      def allowed_option_count
+        Cache.cache_root_path ? 2 : 1
+      end
+
       def error(message)
         @exit = true
         warn Rainbow(message).red

data/lib/rubocop/version.rb

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

data/lib/rubocop.rb

@@ -16,6 +16,7 @@ require 'rubocop-ast'
 require_relative 'rubocop/ast_aliases'
 require_relative 'rubocop/ext/regexp_node'
 require_relative 'rubocop/ext/regexp_parser'
+require_relative 'rubocop/ext/range'
 
 require_relative 'rubocop/core_ext/string'
 require_relative 'rubocop/ext/processed_source'
@@ -47,6 +48,7 @@ require_relative 'rubocop/cop/severity'
 require_relative 'rubocop/cop/generator'
 require_relative 'rubocop/cop/generator/configuration_injector'
 require_relative 'rubocop/cop/generator/require_file_injector'
+require_relative 'rubocop/magic_comment'
 
 require_relative 'rubocop/cop/variable_force'
 require_relative 'rubocop/cop/variable_force/branch'
@@ -86,7 +88,6 @@ require_relative 'rubocop/cop/mixin/gem_declaration'
 require_relative 'rubocop/cop/mixin/gemspec_help'
 require_relative 'rubocop/cop/mixin/hash_alignment_styles'
 require_relative 'rubocop/cop/mixin/hash_transform_method'
-require_relative 'rubocop/cop/mixin/ignored_methods'
 require_relative 'rubocop/cop/mixin/integer_node'
 require_relative 'rubocop/cop/mixin/interpolation'
 require_relative 'rubocop/cop/mixin/line_length_help'
@@ -529,6 +530,7 @@ require_relative 'rubocop/cop/style/keyword_parameters_order'
 require_relative 'rubocop/cop/style/lambda'
 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/method_call_without_args_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
@@ -690,18 +692,18 @@ require_relative 'rubocop/config_obsoletion/split_cop'
 require_relative 'rubocop/config_obsoletion'
 require_relative 'rubocop/config_store'
 require_relative 'rubocop/config_validator'
+require_relative 'rubocop/feature_loader'
 require_relative 'rubocop/lockfile'
 require_relative 'rubocop/target_finder'
 require_relative 'rubocop/directive_comment'
 require_relative 'rubocop/comment_config'
-require_relative 'rubocop/magic_comment'
 require_relative 'rubocop/result_cache'
 require_relative 'rubocop/runner'
 require_relative 'rubocop/cli'
 require_relative 'rubocop/cli/command'
 require_relative 'rubocop/cli/environment'
 require_relative 'rubocop/cli/command/base'
-require_relative 'rubocop/cli/command/auto_genenerate_config'
+require_relative 'rubocop/cli/command/auto_generate_config'
 require_relative 'rubocop/cli/command/execute_runner'
 require_relative 'rubocop/cli/command/init_dotfile'
 require_relative 'rubocop/cli/command/show_cops'