rubocop 1.31.1 → 1.51.0

data/lib/rubocop/server/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'optparse'
-require 'rainbow'
+require_relative '../arguments_env'
+require_relative '../arguments_file'
 
 #
 # This code is based on https://github.com/fohte/rubocop-daemon.
@@ -22,9 +22,16 @@ module RuboCop
       STATUS_ERROR = 2
 
       SERVER_OPTIONS = %w[
-        --server --no-server --server-status --restart-server --start-server --stop-server
+        --server
+        --no-server
+        --server-status
+        --restart-server
+        --start-server
+        --stop-server
+        --no-detach
       ].freeze
       EXCLUSIVE_OPTIONS = (SERVER_OPTIONS - %w[--server --no-server]).freeze
+      NO_DETACH_OPTIONS = %w[--server --start-server --restart-server].freeze
 
       def initialize
         @exit = false
@@ -37,34 +44,53 @@ module RuboCop
           return STATUS_SUCCESS
         end
 
-        deleted_server_arguments = delete_server_argument_from(argv)
+        Cache.cache_root_path = fetch_cache_root_path_from(argv)
 
-        if deleted_server_arguments.size >= 2
-          return error("#{deleted_server_arguments.join(', ')} cannot be specified together.")
+        process_arguments(argv)
+      end
+
+      def exit?
+        @exit
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def process_arguments(argv)
+        server_arguments = delete_server_argument_from(argv)
+
+        detach = !server_arguments.delete('--no-detach')
+
+        if server_arguments.size >= 2
+          return error("#{server_arguments.join(', ')} cannot be specified together.")
         end
 
-        server_command = deleted_server_arguments.first
+        server_command = server_arguments.first
 
-        if EXCLUSIVE_OPTIONS.include?(server_command) && argv.count >= 2
-          return error("#{server_command} cannot be combined with other options.")
+        unless detach || NO_DETACH_OPTIONS.include?(server_command)
+          return error("#{server_command} cannot be combined with --no-detach.")
         end
 
-        run_command(server_command)
+        if EXCLUSIVE_OPTIONS.include?(server_command) && argv.count > allowed_option_count
+          return error("#{server_command} cannot be combined with #{argv[0]}.")
+        end
 
-        STATUS_SUCCESS
-      end
+        if server_command.nil?
+          server_command = ArgumentsEnv.read_as_arguments.delete('--server') ||
+                           ArgumentsFile.read_as_arguments.delete('--server')
+        end
 
-      def exit?
-        @exit
-      end
+        run_command(server_command, detach: detach)
 
-      private
+        STATUS_SUCCESS
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength:
-      def run_command(server_command)
+      def run_command(server_command, detach:)
         case server_command
         when '--server'
-          Server::ClientCommand::Start.new.run unless Server.running?
+          Server::ClientCommand::Start.new(detach: detach).run unless Server.running?
         when '--no-server'
           Server::ClientCommand::Stop.new.run if Server.running?
         when '--restart-server'
@@ -72,7 +98,7 @@ module RuboCop
           Server::ClientCommand::Restart.new.run
         when '--start-server'
           @exit = true
-          Server::ClientCommand::Start.new.run
+          Server::ClientCommand::Start.new(detach: detach).run
         when '--stop-server'
           @exit = true
           Server::ClientCommand::Stop.new.run
@@ -83,6 +109,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,7 +130,13 @@ module RuboCop
         (argv & SERVER_OPTIONS).any?
       end
 
+      def allowed_option_count
+        Cache.cache_root_path ? 2 : 1
+      end
+
       def error(message)
+        require 'rainbow'
+
         @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/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
 
@@ -40,7 +41,11 @@ module RuboCop
         end
 
         def incompatible_version?
-          RuboCop::Version::STRING != Cache.version_path.read
+          Cache.version_path.read != RuboCop::Version::STRING
+        end
+
+        def stderr
+          Cache.stderr_path.read
         end
 
         def status

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

@@ -15,6 +15,11 @@ module RuboCop
       # This class is a client command to start server process.
       # @api private
       class Start < Base
+        def initialize(detach: true)
+          @detach = detach
+          super()
+        end
+
         def run
           if Server.running?
             warn "RuboCop server (#{Cache.pid_path.read}) is already running."
@@ -34,7 +39,7 @@ module RuboCop
             host = ENV.fetch('RUBOCOP_SERVER_HOST', '127.0.0.1')
             port = ENV.fetch('RUBOCOP_SERVER_PORT', 0)
 
-            Server::Core.new.start(host, port)
+            Server::Core.new.start(host, port, detach: @detach)
           end
         end
       end

data/lib/rubocop/server/core.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'socket'
 require 'securerandom'
+require 'socket'
 
 #
 # This code is based on https://github.com/fohte/rubocop-daemon.
@@ -17,6 +17,8 @@ module RuboCop
     # The core of server process. It starts TCP server and perform socket communication.
     # @api private
     class Core
+      JSON_FORMATS = %w[json j].freeze
+
       def self.token
         @token ||= SecureRandom.hex(4)
       end
@@ -25,30 +27,46 @@ module RuboCop
         self.class.token
       end
 
-      def start(host, port)
+      def start(host, port, detach: true)
         $PROGRAM_NAME = "rubocop --server #{Cache.project_dir}"
 
-        require 'rubocop'
+        require_relative '../../rubocop'
         start_server(host, port)
 
-        demonize if server_mode?
+        return unless server_mode?
+
+        detach ? detach_server : run_server
       end
 
       private
 
-      def demonize
-        Cache.write_port_and_token_files(port: @server.addr[1], token: token)
+      def detach_server
+        write_port_and_token_files
 
         pid = fork do
           Process.daemon(true)
-          Cache.write_pid_file do
-            read_socket(@server.accept) until @server.closed?
-          end
+          $stderr.reopen(Cache.stderr_path, 'w')
+          process_input
         end
 
         Process.waitpid(pid)
       end
 
+      def write_port_and_token_files
+        Cache.write_port_and_token_files(port: @server.addr[1], token: token)
+      end
+
+      def process_input
+        Cache.write_pid_file do
+          read_socket(@server.accept) until @server.closed?
+        end
+      end
+
+      def run_server
+        write_port_and_token_files
+        process_input
+      end
+
       def server_mode?
         true
       end
@@ -56,7 +74,12 @@ module RuboCop
       def start_server(host, port)
         @server = TCPServer.open(host, port)
 
-        puts "RuboCop server starting on #{@server.addr[3]}:#{@server.addr[1]}."
+        # JSON format does not expected output message when IDE integration with server mode.
+        # See: https://github.com/rubocop/rubocop/issues/11164
+        return if use_json_format?
+
+        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)
@@ -74,6 +97,15 @@ module RuboCop
       ensure
         socket.close
       end
+
+      def use_json_format?
+        return true if ARGV.include?('--format=json') || ARGV.include?('--format=j')
+        return false unless (index = ARGV.index('--format') || ARGV.index('-f'))
+
+        format = ARGV[index + 1]
+
+        JSON_FORMATS.include?(format)
+      end
     end
   end
 end

data/lib/rubocop/server/helper.rb

@@ -11,7 +11,7 @@
 #
 module RuboCop
   module Server
-    # This module has a helper memthod for `RuboCop::Server::SocketReader`.
+    # This module has a helper method for `RuboCop::Server::SocketReader`.
     # @api private
     module Helper
       def self.redirect(stdin: $stdin, stdout: $stdout, stderr: $stderr, &_block)

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

@@ -21,7 +21,7 @@ module RuboCop
           # We must pass the --color option to preserve this behavior.
           @args.unshift('--color') unless %w[--color --no-color].any? { |f| @args.include?(f) }
           status = RuboCop::CLI.new.run(@args)
-          # This status file is read by `rubocop --server` (`RuboCop::Server::Clientcommand::Exec`).
+          # This status file is read by `rubocop --server` (`RuboCop::Server::ClientCommand::Exec`).
           # so that they use the correct exit code.
           # Status is 1 when there are any issues, and 0 otherwise.
           Cache.write_status_file(status)

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

@@ -4,8 +4,8 @@ module RuboCop
   # The kind of Ruby that code inspected by RuboCop is written in.
   # @api private
   class TargetRuby
-    KNOWN_RUBIES = [2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2].freeze
-    DEFAULT_VERSION = 2.6
+    KNOWN_RUBIES = [2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2, 3.3].freeze
+    DEFAULT_VERSION = 2.7
 
     OBSOLETE_RUBIES = {
       1.9 => '0.41',
@@ -14,7 +14,8 @@ module RuboCop
       2.2 => '0.68',
       2.3 => '0.81',
       2.4 => '1.12',
-      2.5 => '1.28'
+      2.5 => '1.28',
+      2.6 => '1.50'
     }.freeze
     private_constant :KNOWN_RUBIES, :OBSOLETE_RUBIES
 
@@ -84,7 +85,7 @@ module RuboCop
     # @api private
     class ToolVersionsFile < RubyVersionFile
       TOOL_VERSIONS_FILENAME = '.tool-versions'
-      TOOL_VERSIONS_PATTERN = /\Aruby (?:ruby-)?(?<version>\d+\.\d+)/.freeze
+      TOOL_VERSIONS_PATTERN = /^(?:ruby )(?<version>\d+\.\d+)/.freeze
 
       def name
         "`#{TOOL_VERSIONS_FILENAME}`"
@@ -244,7 +245,6 @@ module RuboCop
     ].freeze
 
     private_constant :SOURCES
-
     def initialize(config)
       @config = config
     end

data/lib/rubocop/version.rb

@@ -3,11 +3,11 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.31.1'
+    STRING = '1.51.0'
 
     MSG = '%<version>s (using Parser %<parser_version>s, ' \
           'rubocop-ast %<rubocop_ast_version>s, ' \
-          'running on %<ruby_engine>s %<ruby_version>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,6 +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_mode: server_mode,
                                       ruby_platform: RUBY_PLATFORM)
         return verbose_version unless env
 
@@ -42,7 +43,7 @@ module RuboCop
         env.config_store.unvalidated.for_pwd.loaded_features.sort
       end
 
-      features.map do |loaded_feature|
+      features.filter_map do |loaded_feature|
         next unless (match = loaded_feature.match(/rubocop-(?<feature>.*)/))
 
         # Get the expected name of the folder containing the extension code.
@@ -60,7 +61,7 @@ module RuboCop
         next unless (feature_version = feature_version(feature))
 
         "  - #{loaded_feature} #{feature_version}"
-      end.compact
+      end
     end
 
     # Returns feature version in one of two ways:
@@ -88,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