rubocop 1.31.1 → 1.33.0

data/lib/rubocop/options.rb

@@ -421,12 +421,9 @@ module RuboCop
     end
 
     def invalid_arguments_for_parallel
-      [('--auto-gen-config'    if @options.key?(:auto_gen_config)),
-       ('-F/--fail-fast'       if @options.key?(:fail_fast)),
-       ('-x/--fix-layout'      if @options.key?(:fix_layout)),
-       ('-a/--autocorrect'     if @options.key?(:safe_autocorrect)),
-       ('-A/--autocorrect-all' if @options.key?(:autocorrect_all)),
-       ('--cache false'        if @options > { cache: 'false' })].compact
+      [('--auto-gen-config' if @options.key?(:auto_gen_config)),
+       ('-F/--fail-fast'    if @options.key?(:fail_fast)),
+       ('--cache false'     if @options > { cache: 'false' })].compact
     end
 
     def only_includes_redundant_disable?

data/lib/rubocop/rake_task.rb

@@ -73,11 +73,15 @@ module RuboCop
       namespace(name) do
         # rubocop:todo Naming/InclusiveLanguage
         task(:auto_correct, *args) do
+          require 'rainbow'
           warn Rainbow(
             'rubocop:auto_correct task is deprecated; ' \
             'use rubocop:autocorrect task or rubocop:autocorrect_all task instead.'
           ).yellow
-          ::Rake::Task['rubocop:autocorrect'].invoke
+          RakeFileUtils.verbose(verbose) do
+            yield(*[self, task_args].slice(0, task_block.arity)) if task_block
+            perform('--autocorrect')
+          end
         end
         # rubocop:enable Naming/InclusiveLanguage
 

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/rspec/shared_contexts.rb

@@ -2,7 +2,7 @@
 
 require 'tmpdir'
 
-RSpec.shared_context 'isolated environment', :isolated_environment do
+RSpec.shared_context 'isolated environment' do
   around do |example|
     Dir.mktmpdir do |tmpdir|
       original_home = Dir.home
@@ -38,7 +38,7 @@ RSpec.shared_context 'isolated environment', :isolated_environment do
   end
 end
 
-RSpec.shared_context 'maintain registry', :restore_registry do
+RSpec.shared_context 'maintain registry' do
   around(:each) { |example| RuboCop::Cop::Registry.with_temporary_global { example.run } }
 
   def stub_cop_class(name, inherit: RuboCop::Cop::Base, &block)
@@ -49,7 +49,7 @@ RSpec.shared_context 'maintain registry', :restore_registry do
 end
 
 # This context assumes nothing and defines `cop`, among others.
-RSpec.shared_context 'config', :config do # rubocop:disable Metrics/BlockLength
+RSpec.shared_context 'config' do # rubocop:disable Metrics/BlockLength
   ### Meant to be overridden at will
 
   let(:cop_class) do
@@ -116,46 +116,46 @@ RSpec.shared_context 'mock console output' do
   end
 end
 
-RSpec.shared_context 'ruby 2.0', :ruby20 do
+RSpec.shared_context 'ruby 2.0' do
   let(:ruby_version) { 2.0 }
 end
 
-RSpec.shared_context 'ruby 2.1', :ruby21 do
+RSpec.shared_context 'ruby 2.1' do
   let(:ruby_version) { 2.1 }
 end
 
-RSpec.shared_context 'ruby 2.2', :ruby22 do
+RSpec.shared_context 'ruby 2.2' do
   let(:ruby_version) { 2.2 }
 end
 
-RSpec.shared_context 'ruby 2.3', :ruby23 do
+RSpec.shared_context 'ruby 2.3' do
   let(:ruby_version) { 2.3 }
 end
 
-RSpec.shared_context 'ruby 2.4', :ruby24 do
+RSpec.shared_context 'ruby 2.4' do
   let(:ruby_version) { 2.4 }
 end
 
-RSpec.shared_context 'ruby 2.5', :ruby25 do
+RSpec.shared_context 'ruby 2.5' do
   let(:ruby_version) { 2.5 }
 end
 
-RSpec.shared_context 'ruby 2.6', :ruby26 do
+RSpec.shared_context 'ruby 2.6' do
   let(:ruby_version) { 2.6 }
 end
 
-RSpec.shared_context 'ruby 2.7', :ruby27 do
+RSpec.shared_context 'ruby 2.7' do
   let(:ruby_version) { 2.7 }
 end
 
-RSpec.shared_context 'ruby 3.0', :ruby30 do
+RSpec.shared_context 'ruby 3.0' do
   let(:ruby_version) { 3.0 }
 end
 
-RSpec.shared_context 'ruby 3.1', :ruby31 do
+RSpec.shared_context 'ruby 3.1' do
   let(:ruby_version) { 3.1 }
 end
 
-RSpec.shared_context 'ruby 3.2', :ruby32 do
+RSpec.shared_context 'ruby 3.2' do
   let(:ruby_version) { 3.2 }
 end

data/lib/rubocop/rspec/support.rb

@@ -11,4 +11,18 @@ require_relative 'parallel_formatter'
 RSpec.configure do |config|
   config.include CopHelper
   config.include HostEnvironmentSimulatorHelper
+  config.include_context 'config', :config
+  config.include_context 'isolated environment', :isolated_environment
+  config.include_context 'maintain registry', :restore_registry
+  config.include_context 'ruby 2.0', :ruby20
+  config.include_context 'ruby 2.1', :ruby21
+  config.include_context 'ruby 2.2', :ruby22
+  config.include_context 'ruby 2.3', :ruby23
+  config.include_context 'ruby 2.4', :ruby24
+  config.include_context 'ruby 2.5', :ruby25
+  config.include_context 'ruby 2.6', :ruby26
+  config.include_context 'ruby 2.7', :ruby27
+  config.include_context 'ruby 3.0', :ruby30
+  config.include_context 'ruby 3.1', :ruby31
+  config.include_context 'ruby 3.2', :ruby32
 end

data/lib/rubocop/runner.rb

@@ -63,8 +63,12 @@ module RuboCop
     # Warms up the RuboCop cache by forking a suitable number of RuboCop
     # instances that each inspects its allotted group of files.
     def warm_cache(target_files)
+      saved_options = @options.dup
       puts 'Running parallel inspection' if @options[:debug]
+      %i[autocorrect safe_autocorrect].each { |opt| @options[opt] = false }
       Parallel.each(target_files) { |target_file| file_offenses(target_file) }
+    ensure
+      @options = saved_options
     end
 
     def find_target_files(paths)

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,40 @@ 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)
+
+            # Ruby 3.1+
+            config_yaml = if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('4.0.0')
+                            YAML.safe_load_file(config_path, permitted_classes: [Regexp, Symbol])
+                          else
+                            YAML.load_file(config_path)
+                          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/server/client_command/base.rb

@@ -29,7 +29,7 @@ module RuboCop
             socket.puts [Cache.token_path.read, Dir.pwd, command, *args].shelljoin
             socket.write body
             socket.close_write
-            $stdout.write socket.read(4096) until socket.eof?
+            $stdout.write socket.readpartial(4096) until socket.eof?
           end
         end
 

data/lib/rubocop/version.rb

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

data/lib/rubocop.rb

@@ -72,7 +72,6 @@ require_relative 'rubocop/cop/mixin/configurable_enforced_style'
 require_relative 'rubocop/cop/mixin/configurable_formatting'
 require_relative 'rubocop/cop/mixin/configurable_naming'
 require_relative 'rubocop/cop/mixin/configurable_numbering'
-require_relative 'rubocop/cop/mixin/def_node'
 require_relative 'rubocop/cop/mixin/documentation_comment'
 require_relative 'rubocop/cop/mixin/duplication'
 require_relative 'rubocop/cop/mixin/range_help'
@@ -87,7 +86,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'
@@ -130,6 +128,7 @@ require_relative 'rubocop/cop/mixin/uncommunicative_name'
 require_relative 'rubocop/cop/mixin/unused_argument'
 require_relative 'rubocop/cop/mixin/visibility_help'
 require_relative 'rubocop/cop/mixin/comments_help' # relies on visibility_help
+require_relative 'rubocop/cop/mixin/def_node' # relies on visibility_help
 
 require_relative 'rubocop/cop/utils/format_string'
 
@@ -233,6 +232,7 @@ require_relative 'rubocop/cop/layout/multiline_method_argument_line_breaks'
 require_relative 'rubocop/cop/layout/multiline_method_call_brace_layout'
 require_relative 'rubocop/cop/layout/multiline_method_call_indentation'
 require_relative 'rubocop/cop/layout/multiline_method_definition_brace_layout'
+require_relative 'rubocop/cop/layout/multiline_method_parameter_line_breaks'
 require_relative 'rubocop/cop/layout/multiline_operation_indentation'
 require_relative 'rubocop/cop/layout/parameter_alignment'
 require_relative 'rubocop/cop/layout/redundant_line_break'
@@ -356,6 +356,7 @@ require_relative 'rubocop/cop/lint/redundant_with_object'
 require_relative 'rubocop/cop/lint/refinement_import_methods'
 require_relative 'rubocop/cop/lint/regexp_as_condition'
 require_relative 'rubocop/cop/lint/require_parentheses'
+require_relative 'rubocop/cop/lint/require_range_parentheses'
 require_relative 'rubocop/cop/lint/require_relative_self_path'
 require_relative 'rubocop/cop/lint/rescue_exception'
 require_relative 'rubocop/cop/lint/rescue_type'
@@ -479,6 +480,7 @@ require_relative 'rubocop/cop/style/each_with_object'
 require_relative 'rubocop/cop/style/empty_block_parameter'
 require_relative 'rubocop/cop/style/empty_case_condition'
 require_relative 'rubocop/cop/style/empty_else'
+require_relative 'rubocop/cop/style/empty_heredoc'
 require_relative 'rubocop/cop/style/empty_lambda_parameter'
 require_relative 'rubocop/cop/style/empty_literal'
 require_relative 'rubocop/cop/style/empty_method'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.31.1
+  version: 1.33.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -120,7 +120,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -208,6 +208,7 @@ files:
 - exe/rubocop
 - lib/rubocop.rb
 - lib/rubocop/ast_aliases.rb
+- lib/rubocop/cache_config.rb
 - lib/rubocop/cached_data.rb
 - lib/rubocop/cli.rb
 - lib/rubocop/cli/command.rb
@@ -222,6 +223,7 @@ files:
 - lib/rubocop/cli/environment.rb
 - lib/rubocop/comment_config.rb
 - lib/rubocop/config.rb
+- lib/rubocop/config_finder.rb
 - lib/rubocop/config_loader.rb
 - lib/rubocop/config_loader_resolver.rb
 - lib/rubocop/config_obsoletion.rb
@@ -301,6 +303,7 @@ files:
 - lib/rubocop/cop/internal_affairs/style_detected_api_use.rb
 - lib/rubocop/cop/internal_affairs/undefined_config.rb
 - lib/rubocop/cop/internal_affairs/useless_message_assertion.rb
+- lib/rubocop/cop/internal_affairs/useless_restrict_on_send.rb
 - lib/rubocop/cop/layout/access_modifier_indentation.rb
 - lib/rubocop/cop/layout/argument_alignment.rb
 - lib/rubocop/cop/layout/array_alignment.rb
@@ -366,6 +369,7 @@ files:
 - lib/rubocop/cop/layout/multiline_method_call_brace_layout.rb
 - lib/rubocop/cop/layout/multiline_method_call_indentation.rb
 - lib/rubocop/cop/layout/multiline_method_definition_brace_layout.rb
+- lib/rubocop/cop/layout/multiline_method_parameter_line_breaks.rb
 - lib/rubocop/cop/layout/multiline_operation_indentation.rb
 - lib/rubocop/cop/layout/parameter_alignment.rb
 - lib/rubocop/cop/layout/redundant_line_break.rb
@@ -490,6 +494,7 @@ files:
 - lib/rubocop/cop/lint/refinement_import_methods.rb
 - lib/rubocop/cop/lint/regexp_as_condition.rb
 - lib/rubocop/cop/lint/require_parentheses.rb
+- lib/rubocop/cop/lint/require_range_parentheses.rb
 - lib/rubocop/cop/lint/require_relative_self_path.rb
 - lib/rubocop/cop/lint/rescue_exception.rb
 - lib/rubocop/cop/lint/rescue_type.rb
@@ -578,7 +583,6 @@ files:
 - lib/rubocop/cop/mixin/hash_shorthand_syntax.rb
 - lib/rubocop/cop/mixin/hash_transform_method.rb
 - lib/rubocop/cop/mixin/heredoc.rb
-- lib/rubocop/cop/mixin/ignored_methods.rb
 - lib/rubocop/cop/mixin/integer_node.rb
 - lib/rubocop/cop/mixin/interpolation.rb
 - lib/rubocop/cop/mixin/line_length_help.rb
@@ -695,6 +699,7 @@ files:
 - lib/rubocop/cop/style/empty_block_parameter.rb
 - lib/rubocop/cop/style/empty_case_condition.rb
 - lib/rubocop/cop/style/empty_else.rb
+- lib/rubocop/cop/style/empty_heredoc.rb
 - lib/rubocop/cop/style/empty_lambda_parameter.rb
 - lib/rubocop/cop/style/empty_literal.rb
 - lib/rubocop/cop/style/empty_method.rb
@@ -967,7 +972,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.31/
+  documentation_uri: https://docs.rubocop.org/rubocop/1.33/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
 post_install_message: 
@@ -985,7 +990,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Automatic Ruby code style checking tool.

data/lib/rubocop/cop/mixin/ignored_methods.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    # This module encapsulates the ability to ignore certain methods when
-    # parsing.
-    # Cops that use `IgnoredMethods` can accept either strings or regexes to match
-    # against.
-    module IgnoredMethods
-      # Configuration for IgnoredMethods. It is added to classes that include
-      # the module so that configuration can be set using the `ignored_methods`
-      # class macro.
-      module Config
-        attr_accessor :deprecated_key
-
-        def ignored_methods(**config)
-          self.deprecated_key = config[:deprecated_key]
-        end
-      end
-
-      def self.included(base)
-        base.extend(Config)
-      end
-
-      def ignored_method?(name)
-        ignored_methods.any? do |value|
-          case value
-          when Regexp
-            value.match? String(name)
-          else
-            value == String(name)
-          end
-        end
-      end
-
-      def ignored_methods
-        keys = %w[IgnoredMethods]
-        keys << deprecated_key if deprecated_key
-
-        cop_config.slice(*keys).values.reduce(&:concat)
-      end
-
-      private
-
-      def deprecated_key
-        return unless self.class.respond_to?(:deprecated_key)
-
-        self.class.deprecated_key&.to_s
-      end
-    end
-  end
-end