rubocop 1.36.0 → 1.38.0

data/lib/rubocop/options.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require 'optparse'
-require 'shellwords'
+require_relative 'arguments_env'
+require_relative 'arguments_file'
 
 module RuboCop
   class IncorrectCopNameError < StandardError; end
@@ -24,7 +25,10 @@ module RuboCop
     end
 
     def parse(command_line_args)
+      args_from_file = ArgumentsFile.read_as_arguments
+      args_from_env = ArgumentsEnv.read_as_arguments
       args = args_from_file.concat(args_from_env).concat(command_line_args)
+
       define_options.parse!(args)
 
       @validator.validate_compatibility
@@ -45,18 +49,6 @@ module RuboCop
 
     private
 
-    def args_from_file
-      if File.exist?('.rubocop') && !File.directory?('.rubocop')
-        File.read('.rubocop').shellsplit
-      else
-        []
-      end
-    end
-
-    def args_from_env
-      Shellwords.split(ENV.fetch('RUBOCOP_OPTS', ''))
-    end
-
     def define_options
       OptionParser.new do |opts|
         opts.banner = rainbow.wrap('Usage: rubocop [options] [file1, file2, ...]').bright
@@ -73,7 +65,7 @@ module RuboCop
     end
 
     def add_check_options(opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      section(opts, 'Basic Options') do
+      section(opts, 'Basic Options') do # rubocop:disable Metrics/BlockLength
         option(opts, '-l', '--lint') do
           @options[:only] ||= []
           @options[:only] << 'Lint'
@@ -98,6 +90,7 @@ module RuboCop
         option(opts, '--force-default-config')
         option(opts, '-s', '--stdin FILE')
         option(opts, '-P', '--[no-]parallel')
+        option(opts, '--raise-cop-error')
         add_severity_option(opts)
       end
     end
@@ -169,6 +162,7 @@ module RuboCop
         end
 
         option(opts, '--exclude-limit COUNT') { @validator.validate_exclude_limit_option }
+        option(opts, '--no-exclude-limit')
 
         option(opts, '--[no-]offense-counts')
         option(opts, '--[no-]auto-gen-only-exclude')
@@ -400,6 +394,12 @@ module RuboCop
     end
 
     def validate_autocorrect
+      if @options.key?(:safe_autocorrect) && @options.key?(:autocorrect_all)
+        message = Rainbow(<<~MESSAGE).red
+          Error: Both safe and unsafe autocorrect options are specified, use only one.
+        MESSAGE
+        raise OptionArgumentError, message
+      end
       return if @options.key?(:autocorrect)
       return unless @options.key?(:disable_uncorrectable)
 
@@ -497,6 +497,7 @@ module RuboCop
       disable_uncorrectable:            ['Used with --autocorrect to annotate any',
                                          'offenses that do not support autocorrect',
                                          'with `rubocop:todo` comments.'],
+      no_exclude_limit:                 ['Do not set the limit for how many files to exclude.'],
       force_exclusion:                  ['Any files excluded by `Exclude` in configuration',
                                          'files will be excluded, even if given explicitly',
                                          'as arguments.'],
@@ -589,7 +590,10 @@ module RuboCop
       restart_server:                   'Restart server process.',
       start_server:                     'Start server process.',
       stop_server:                      'Stop server process.',
-      server_status:                    'Show server status.'
+      server_status:                    'Show server status.',
+      raise_cop_error:                  ['Raise cop-related errors with cause and location.',
+                                         'This is used to prevent cops from failing silently.',
+                                         'Default is false.']
     }.freeze
   end
 end

data/lib/rubocop/rspec/cop_helper.rb

@@ -28,7 +28,27 @@ module CopHelper
       file = file.path
     end
 
-    RuboCop::ProcessedSource.new(source, ruby_version, file)
+    processed_source = RuboCop::ProcessedSource.new(source, ruby_version, file)
+    processed_source.config = configuration
+    processed_source.registry = registry
+    processed_source
+  end
+
+  def configuration
+    @configuration ||= if defined?(config)
+                         config
+                       else
+                         RuboCop::Config.new({}, "#{Dir.pwd}/.rubocop.yml")
+                       end
+  end
+
+  def registry
+    @registry ||= begin
+      cops = configuration.keys.map { |cop| RuboCop::Cop::Registry.global.find_by_cop_name(cop) }
+      cops << cop_class if defined?(cop_class) && !cops.include?(cop_class)
+      cops.compact!
+      RuboCop::Cop::Registry.new(cops)
+    end
   end
 
   def autocorrect_source_file(source)

data/lib/rubocop/rspec/shared_contexts.rb

@@ -2,7 +2,7 @@
 
 require 'tmpdir'
 
-RSpec.shared_context 'isolated environment' do
+RSpec.shared_context 'isolated environment' do # rubocop:disable Metrics/BlockLength
   around do |example|
     Dir.mktmpdir do |tmpdir|
       original_home = Dir.home
@@ -36,6 +36,19 @@ RSpec.shared_context 'isolated environment' do
       end
     end
   end
+
+  if RuboCop.const_defined?(:Server)
+    around do |example|
+      RuboCop::Server::Cache.cache_root_path = nil
+      RuboCop::Server::Cache.instance_variable_set(:@project_dir_cache_key, nil)
+      begin
+        example.run
+      ensure
+        RuboCop::Server::Cache.cache_root_path = nil
+        RuboCop::Server::Cache.instance_variable_set(:@project_dir_cache_key, nil)
+      end
+    end
+  end
 end
 
 RSpec.shared_context 'maintain registry' do

data/lib/rubocop/runner.rb

@@ -423,17 +423,21 @@ module RuboCop
     end
 
     def get_processed_source(file)
-      ruby_version = @config_store.for_file(file).target_ruby_version
-
-      if @options[:stdin]
-        ProcessedSource.new(@options[:stdin], ruby_version, file)
-      else
-        begin
-          ProcessedSource.from_file(file, ruby_version)
-        rescue Errno::ENOENT
-          raise RuboCop::Error, "No such file or directory: #{file}"
-        end
-      end
+      config = @config_store.for_file(file)
+      ruby_version = config.target_ruby_version
+
+      processed_source = if @options[:stdin]
+                           ProcessedSource.new(@options[:stdin], ruby_version, file)
+                         else
+                           begin
+                             ProcessedSource.from_file(file, ruby_version)
+                           rescue Errno::ENOENT
+                             raise RuboCop::Error, "No such file or directory: #{file}"
+                           end
+                         end
+      processed_source.config = config
+      processed_source.registry = mobilized_cop_classes(config)
+      processed_source
     end
 
     # A Cop::Team instance is stateful and may change when inspecting.

data/lib/rubocop/server/cache.rb

@@ -103,9 +103,13 @@ module RuboCop
           dir.join('version')
         end
 
+        def stderr_path
+          dir.join('stderr')
+        end
+
         def pid_running?
           Process.kill(0, pid_path.read.to_i) == 1
-        rescue Errno::ESRCH
+        rescue Errno::ESRCH, Errno::ENOENT
           false
         end
 

data/lib/rubocop/server/cli.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'rainbow'
+require_relative '../arguments_env'
+require_relative '../arguments_file'
 
 #
 # This code is based on https://github.com/fohte/rubocop-daemon.
@@ -29,7 +31,7 @@ module RuboCop
         @exit = false
       end
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, 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)
@@ -50,11 +52,16 @@ module RuboCop
           return error("#{server_command} cannot be combined with other options.")
         end
 
+        if server_command.nil?
+          server_command = ArgumentsEnv.read_as_arguments.delete('--server') ||
+                           ArgumentsFile.read_as_arguments.delete('--server')
+        end
+
         run_command(server_command)
 
         STATUS_SUCCESS
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
       def exit?
         @exit

data/lib/rubocop/server/client_command/exec.rb

@@ -23,6 +23,7 @@ module RuboCop
             args: ARGV.dup,
             body: $stdin.tty? ? '' : $stdin.read
           )
+          warn stderr unless stderr.empty?
           status
         end
 
@@ -43,6 +44,10 @@ module RuboCop
           RuboCop::Version::STRING != Cache.version_path.read
         end
 
+        def stderr
+          Cache.stderr_path.read
+        end
+
         def status
           unless Cache.status_path.file?
             raise "RuboCop server: Could not find status file at: #{Cache.status_path}"

data/lib/rubocop/server/core.rb

@@ -41,6 +41,7 @@ module RuboCop
 
         pid = fork do
           Process.daemon(true)
+          $stderr.reopen(Cache.stderr_path, 'w')
           Cache.write_pid_file do
             read_socket(@server.accept) until @server.closed?
           end
@@ -56,7 +57,8 @@ module RuboCop
       def start_server(host, port)
         @server = TCPServer.open(host, port)
 
-        puts "RuboCop server starting on #{@server.addr[3]}:#{@server.addr[1]}."
+        output_stream = ARGV.include?('--stderr') ? $stderr : $stdout
+        output_stream.puts "RuboCop server starting on #{@server.addr[3]}:#{@server.addr[1]}."
       end
 
       def read_socket(socket)

data/lib/rubocop/server/socket_reader.rb

@@ -24,13 +24,17 @@ module RuboCop
       def read!
         request = parse_request(@socket.read)
 
+        stderr = StringIO.new
         Helper.redirect(
           stdin: StringIO.new(request.body),
           stdout: @socket,
-          stderr: @socket
+          stderr: stderr
         ) do
           create_command_instance(request).run
         end
+      ensure
+        Cache.stderr_path.write(stderr.string)
+        @socket.close
       end
 
       private

data/lib/rubocop/server.rb

@@ -33,7 +33,7 @@ module RuboCop
       def running?
         return false unless support_server? # Never running.
 
-        Cache.dir.exist? && Cache.pid_path.file? && Cache.pid_running?
+        Cache.pid_running?
       end
 
       def wait_for_running_status!(expected)

data/lib/rubocop/version.rb

@@ -3,11 +3,11 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.36.0'
+    STRING = '1.38.0'
 
     MSG = '%<version>s (using Parser %<parser_version>s, ' \
           'rubocop-ast %<rubocop_ast_version>s, ' \
-          'running on %<ruby_engine>s %<ruby_version>s)%<server>s [%<ruby_platform>s]'
+          'running on %<ruby_engine>s %<ruby_version>s)%<server_mode>s [%<ruby_platform>s]'
 
     CANONICAL_FEATURE_NAMES = { 'Rspec' => 'RSpec', 'Graphql' => 'GraphQL', 'Md' => 'Markdown',
                                 'Thread_safety' => 'ThreadSafety' }.freeze
@@ -19,7 +19,7 @@ module RuboCop
         verbose_version = format(MSG, version: STRING, parser_version: Parser::VERSION,
                                       rubocop_ast_version: RuboCop::AST::Version::STRING,
                                       ruby_engine: RUBY_ENGINE, ruby_version: RUBY_VERSION,
-                                      server: Server.running? ? ' +server' : '',
+                                      server_mode: server_mode,
                                       ruby_platform: RUBY_PLATFORM)
         return verbose_version unless env
 
@@ -89,5 +89,10 @@ module RuboCop
     def self.document_version
       STRING.match('\d+\.\d+').to_s
     end
+
+    # @api private
+    def self.server_mode
+      RuboCop.const_defined?(:Server) && Server.running? ? ' +server' : ''
+    end
   end
 end

data/lib/rubocop.rb

@@ -292,6 +292,7 @@ require_relative 'rubocop/cop/lint/duplicate_branch'
 require_relative 'rubocop/cop/lint/duplicate_case_condition'
 require_relative 'rubocop/cop/lint/duplicate_elsif_condition'
 require_relative 'rubocop/cop/lint/duplicate_hash_key'
+require_relative 'rubocop/cop/lint/duplicate_magic_comment'
 require_relative 'rubocop/cop/lint/duplicate_methods'
 require_relative 'rubocop/cop/lint/duplicate_regexp_character_class_element'
 require_relative 'rubocop/cop/lint/duplicate_require'
@@ -537,7 +538,9 @@ require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
 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_each'
 require_relative 'rubocop/cop/style/redundant_fetch_block'
 require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
 require_relative 'rubocop/cop/style/redundant_initialize'
@@ -612,6 +615,7 @@ require_relative 'rubocop/cop/style/redundant_return'
 require_relative 'rubocop/cop/style/redundant_self'
 require_relative 'rubocop/cop/style/redundant_sort'
 require_relative 'rubocop/cop/style/redundant_sort_by'
+require_relative 'rubocop/cop/style/redundant_string_escape'
 require_relative 'rubocop/cop/style/regexp_literal'
 require_relative 'rubocop/cop/style/rescue_modifier'
 require_relative 'rubocop/cop/style/rescue_standard_error'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.36.0
+  version: 1.38.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-01 00:00:00.000000000 Z
+date: 2022-11-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.20.1
+        version: 1.23.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.20.1
+        version: 1.23.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -207,6 +207,8 @@ files:
 - config/obsoletion.yml
 - exe/rubocop
 - lib/rubocop.rb
+- lib/rubocop/arguments_env.rb
+- lib/rubocop/arguments_file.rb
 - lib/rubocop/ast_aliases.rb
 - lib/rubocop/cache_config.rb
 - lib/rubocop/cached_data.rb
@@ -284,8 +286,10 @@ files:
 - lib/rubocop/cop/ignored_node.rb
 - lib/rubocop/cop/internal_affairs.rb
 - lib/rubocop/cop/internal_affairs/cop_description.rb
+- lib/rubocop/cop/internal_affairs/create_empty_file.rb
 - lib/rubocop/cop/internal_affairs/empty_line_between_expect_offense_and_correction.rb
 - lib/rubocop/cop/internal_affairs/example_description.rb
+- lib/rubocop/cop/internal_affairs/example_heredoc_delimiter.rb
 - lib/rubocop/cop/internal_affairs/inherit_deprecated_cop_class.rb
 - lib/rubocop/cop/internal_affairs/location_line_equality_comparison.rb
 - lib/rubocop/cop/internal_affairs/method_name_end_with.rb
@@ -430,6 +434,7 @@ files:
 - lib/rubocop/cop/lint/duplicate_case_condition.rb
 - lib/rubocop/cop/lint/duplicate_elsif_condition.rb
 - lib/rubocop/cop/lint/duplicate_hash_key.rb
+- lib/rubocop/cop/lint/duplicate_magic_comment.rb
 - lib/rubocop/cop/lint/duplicate_methods.rb
 - lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb
 - lib/rubocop/cop/lint/duplicate_require.rb
@@ -795,6 +800,7 @@ files:
 - lib/rubocop/cop/style/object_then.rb
 - lib/rubocop/cop/style/one_line_conditional.rb
 - lib/rubocop/cop/style/open_struct_use.rb
+- lib/rubocop/cop/style/operator_method_call.rb
 - lib/rubocop/cop/style/option_hash.rb
 - lib/rubocop/cop/style/optional_arguments.rb
 - lib/rubocop/cop/style/optional_boolean_parameter.rb
@@ -815,6 +821,7 @@ files:
 - lib/rubocop/cop/style/redundant_capital_w.rb
 - lib/rubocop/cop/style/redundant_condition.rb
 - lib/rubocop/cop/style/redundant_conditional.rb
+- lib/rubocop/cop/style/redundant_each.rb
 - lib/rubocop/cop/style/redundant_exception.rb
 - lib/rubocop/cop/style/redundant_fetch_block.rb
 - lib/rubocop/cop/style/redundant_file_extension_in_require.rb
@@ -831,6 +838,7 @@ files:
 - lib/rubocop/cop/style/redundant_self_assignment_branch.rb
 - lib/rubocop/cop/style/redundant_sort.rb
 - lib/rubocop/cop/style/redundant_sort_by.rb
+- lib/rubocop/cop/style/redundant_string_escape.rb
 - lib/rubocop/cop/style/regexp_literal.rb
 - lib/rubocop/cop/style/rescue_modifier.rb
 - lib/rubocop/cop/style/rescue_standard_error.rb
@@ -977,7 +985,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.36/
+  documentation_uri: https://docs.rubocop.org/rubocop/1.38/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
 post_install_message: