rubocop 1.30.1 → 1.64.0

data/lib/rubocop/server/cli.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require_relative '../arguments_env'
+require_relative '../arguments_file'
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    # The CLI is a class responsible of handling server command line interface logic.
+    # @api private
+    class CLI
+      # Same exit status value as `RuboCop::CLI`.
+      STATUS_SUCCESS = 0
+      STATUS_ERROR = 2
+
+      SERVER_OPTIONS = %w[
+        --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
+      end
+
+      def run(argv = ARGV)
+        unless Server.support_server?
+          return error('RuboCop server is not supported by this Ruby.') if use_server_option?(argv)
+
+          return STATUS_SUCCESS
+        end
+
+        Cache.cache_root_path = fetch_cache_root_path_from(argv)
+
+        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 = server_arguments.first
+
+        unless detach || NO_DETACH_OPTIONS.include?(server_command)
+          return error("#{server_command} cannot be combined with --no-detach.")
+        end
+
+        if EXCLUSIVE_OPTIONS.include?(server_command) && argv.count > allowed_option_count
+          return error("#{server_command} cannot be combined with #{argv[0]}.")
+        end
+
+        if server_command.nil?
+          server_command = ArgumentsEnv.read_as_arguments.delete('--server') ||
+                           ArgumentsFile.read_as_arguments.delete('--server')
+        end
+
+        run_command(server_command, detach: detach)
+
+        STATUS_SUCCESS
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength:
+      def run_command(server_command, detach:)
+        case server_command
+        when '--server'
+          Server::ClientCommand::Start.new(detach: detach).run unless Server.running?
+        when '--no-server'
+          Server::ClientCommand::Stop.new.run if Server.running?
+        when '--restart-server'
+          @exit = true
+          Server::ClientCommand::Restart.new.run
+        when '--start-server'
+          @exit = true
+          Server::ClientCommand::Start.new(detach: detach).run
+        when '--stop-server'
+          @exit = true
+          Server::ClientCommand::Stop.new.run
+        when '--server-status'
+          @exit = true
+          Server::ClientCommand::Status.new.run
+        end
+      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)
+        end.compact
+      end
+
+      def use_server_option?(argv)
+        (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
+
+        STATUS_ERROR
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'socket'
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ClientCommand
+      # Abstract base class for server client command.
+      # @api private
+      class Base
+        def run
+          raise NotImplementedError
+        end
+
+        private
+
+        def send_request(command:, args: [], body: '')
+          TCPSocket.open('127.0.0.1', Cache.port_path.read) do |socket|
+            socket.puts [Cache.token_path.read, Dir.pwd, command, *args].shelljoin
+            socket.write body
+            socket.close_write
+            $stdout.write socket.readpartial(4096) until socket.eof?
+          end
+        end
+
+        def check_running_server
+          Server.running?.tap do |running|
+            warn 'RuboCop server is not running.' unless running
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ClientCommand
+      # This class is a client command to execute server process.
+      # @api private
+      class Exec < Base
+        def run
+          ensure_server!
+          read_stdin = ARGV.include?('-s') || ARGV.include?('--stdin')
+          send_request(
+            command: 'exec',
+            args: ARGV.dup,
+            body: read_stdin ? $stdin.read : ''
+          )
+          warn stderr unless stderr.empty?
+          status
+        end
+
+        private
+
+        def ensure_server!
+          if incompatible_version?
+            warn 'RuboCop version incompatibility found, RuboCop server restarting...'
+            ClientCommand::Stop.new.run
+          elsif check_running_server
+            return
+          end
+
+          ClientCommand::Start.new.run
+        end
+
+        def incompatible_version?
+          Cache.version_path.read != RuboCop::Version::STRING
+        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}"
+          end
+
+          status = Cache.status_path.read
+          raise "RuboCop server: '#{status}' is not a valid status!" if (status =~ /^\d+$/).nil?
+
+          status.to_i
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ClientCommand
+      # This class is a client command to restart server process.
+      # @api private
+      class Restart < Base
+        def run
+          ClientCommand::Stop.new.run
+          ClientCommand::Start.new.run
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ClientCommand
+      # 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."
+            return
+          end
+
+          Cache.acquire_lock do |locked|
+            unless locked
+              # Another process is already starting server,
+              # so wait for it to be ready.
+              Server.wait_for_running_status!(true)
+              exit 0
+            end
+
+            Cache.write_version_file(RuboCop::Version::STRING)
+
+            host = ENV.fetch('RUBOCOP_SERVER_HOST', '127.0.0.1')
+            port = ENV.fetch('RUBOCOP_SERVER_PORT', 0)
+
+            Server::Core.new.start(host, port, detach: @detach)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ClientCommand
+      # This class is a client command to show server process status.
+      # @api private
+      class Status < Base
+        def run
+          if Server.running?
+            puts "RuboCop server (#{Cache.pid_path.read}) is running."
+          else
+            puts 'RuboCop server is not running.'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ClientCommand
+      # This class is a client command to stop server process.
+      # @api private
+      class Stop < Base
+        def run
+          return unless check_running_server
+
+          pid = fork do
+            send_request(command: 'stop')
+            Server.wait_for_running_status!(false)
+          end
+
+          Process.waitpid(pid)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/server/client_command.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  autoload :Version, 'rubocop/version'
+
+  module Server
+    # @api private
+    module ClientCommand
+      autoload :Base, 'rubocop/server/client_command/base'
+      autoload :Exec, 'rubocop/server/client_command/exec'
+      autoload :Restart, 'rubocop/server/client_command/restart'
+      autoload :Start, 'rubocop/server/client_command/start'
+      autoload :Status, 'rubocop/server/client_command/status'
+      autoload :Stop, 'rubocop/server/client_command/stop'
+    end
+  end
+end

data/lib/rubocop/server/core.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'socket'
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    # 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
+
+      def token
+        self.class.token
+      end
+
+      def start(host, port, detach: true)
+        $PROGRAM_NAME = "rubocop --server #{Cache.project_dir}"
+
+        require_relative '../../rubocop'
+        start_server(host, port)
+
+        return unless server_mode?
+
+        detach ? detach_server : run_server
+      end
+
+      private
+
+      def detach_server
+        write_port_and_token_files
+
+        pid = fork do
+          Process.daemon(true)
+          $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
+
+      def start_server(host, port)
+        @server = TCPServer.open(host, port)
+
+        # 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)
+        SocketReader.new(socket).read!
+      rescue InvalidTokenError
+        socket.puts 'token is not valid.'
+      rescue ServerStopRequest
+        @server.close
+      rescue UnknownServerCommandError => e
+        socket.puts e.message
+      rescue Errno::EPIPE => e
+        warn e.inspect
+      rescue StandardError => e
+        socket.puts e.full_message
+      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/errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    # @api private
+    class InvalidTokenError < StandardError; end
+
+    # @api private
+    class ServerStopRequest < StandardError; end
+
+    # @api private
+    class UnknownServerCommandError < StandardError; end
+  end
+end

data/lib/rubocop/server/helper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    # This module has a helper method for `RuboCop::Server::SocketReader`.
+    # @api private
+    module Helper
+      def self.redirect(stdin: $stdin, stdout: $stdout, stderr: $stderr, &_block)
+        old_stdin = $stdin.dup
+        old_stdout = $stdout.dup
+        old_stderr = $stderr.dup
+
+        $stdin = stdin
+        $stdout = stdout
+        $stderr = stderr
+
+        yield
+      ensure
+        $stdin = old_stdin
+        $stdout = old_stdout
+        $stderr = old_stderr
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ServerCommand
+      # Abstract base class for server command.
+      # @api private
+      class Base
+        # Common functionality for working with subclasses of this class.
+        # @api private
+        module Runner
+          def run
+            validate_token!
+            Dir.chdir(@cwd) do
+              super
+            end
+          end
+        end
+
+        def self.inherited(child)
+          super
+          child.prepend Runner
+        end
+
+        def initialize(args, token: '', cwd: Dir.pwd)
+          @args = args
+          @token = token
+          @cwd = cwd
+        end
+
+        def run; end
+
+        private
+
+        def validate_token!
+          raise InvalidTokenError unless Cache.token_path.read == @token
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ServerCommand
+      # This class is a server command to execute `rubocop` command using `RuboCop::CLI.new#run`.
+      # @api private
+      class Exec < Base
+        def run
+          # RuboCop output is colorized by default where there is a TTY.
+          # 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`).
+          # so that they use the correct exit code.
+          # Status is 1 when there are any issues, and 0 otherwise.
+          Cache.write_status_file(status)
+        rescue SystemExit
+          Cache.write_status_file(1)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ServerCommand
+      # This class is a server command to stop server process.
+      # @api private
+      class Stop < Base
+        def run
+          raise ServerStopRequest
+        end
+      end
+    end
+  end
+end