rubocop-daemon 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b7fc85bc8f0d4eec8c3e059c0dfd63131165881e99b9df8f675569cc9f482d5
-  data.tar.gz: 8ac1b60ad89d68fd52b9bae1ce5d5f9f2579307e4f68934726077efb4669fa1f
+  metadata.gz: d60258fcc9e9afc6e69f83a509ce6af552e8cf2c66ef6fd0553de6e88532b27a
+  data.tar.gz: be0da846dbb327c3b61b9cdd0a2ce160a327963f270a758ee2f6912f1cc1b32d
 SHA512:
-  metadata.gz: 4ee5f72d514f94b91b5ddddee5a68db28627367e09639e017b80a73500b0343c78f6d4ebee344ed17f88ce3a99558b17b232f75cf8d45541bd733b46db9dc0d8
-  data.tar.gz: cabc9bca1782ec0b20425b76ca4494e7b887135b0b8f50729044055d7795ba4698a3f355c9ca89fb62b33e931b01c07187198d0dabbf74c310741603a9113df1
+  metadata.gz: 1fbb5f36a050acaa7848ccd2f3307696d0cef5fc7b940df7d2088057a7128fbbab28270d555ee4998c9fcab7934c149f47c1122886650cbde54d790a1d764ce1
+  data.tar.gz: eb852d20656a2f41a2de055c6a540d00c96a733ea01a514762e4b7eb4c4d60aba33330bfc1dae06ee494cd5d8e152dfd04ef9d6692e803f3a7a84890e26c20a8

data/.gitignore

@@ -1,6 +1,7 @@
 *.gem
 *.rbc
 /.config
+.vscode/
 /coverage/
 /InstalledFiles
 /pkg/

data/README.md

@@ -48,20 +48,51 @@ rubocop-daemon <command>
 
 Available commands:
 
-* `start`: start the server
-* `stop`: stop the server
-* `status`: print out whether the server is currently running
-* `restart`: restart the server
-* `exec [file1, file2, ...] [-- [rubocop-options]]`: invoke `rubocop` with the given `rubocop-options`
+- `start`: start the server
+- `stop`: stop the server
+- `status`: print out whether the server is currently running
+- `restart`: restart the server
+- `exec [file1, file2, ...] [-- [rubocop-options]]`: invoke `rubocop` with the given `rubocop-options`
 
 ## More speed
 
-If you're really into performance and want the lowest possible latency, talk to the `rubocop-daemon` server with netcat:
+`rubocop-daemon-wrapper` is a bash script that talks to the `rubocop-daemon` server via `netcat`. This provides much lower latency than the `rubocop-daemon` Ruby script.
 
-```sh
-echo "$(cat ~/.cache/rubocop-daemon/token) $PWD exec [rubocop-options]" | nc localhost $(cat ~/.cache/rubocop-daemon/port)
+For now, you have to manually download and install the bash script:
+
+> (`rubygems` will wrap any executable files with a Ruby script, and [you can't disable this behavior](https://github.com/rubygems/rubygems/issues/88).)
+
+```
+curl https://raw.githubusercontent.com/fohte/rubocop-daemon/master/bin/rubocop-daemon-wrapper -o /tmp/rubocop-daemon-wrapper
+sudo mv /tmp/rubocop-daemon-wrapper /usr/local/bin/rubocop-daemon-wrapper
+sudo chmod +x /usr/local/bin/rubocop-daemon-wrapper
+```
+
+You can then replace any calls to `rubocop` with `rubocop-daemon-wrapper`.
+
+```
+rubocop-daemon-wrapper foo.rb bar.rb
 ```
 
+`rubocop-daemon-wrapper` will automatically start the daemon server if it is not already running. So the first call will be about the same as `rubocop`, but the second call will be much faster.
+
+## Use with VS Code
+
+Unfortunately, the [vscode-ruby extension doesn't really allow you to customize the `rubocop` path or binary](https://github.com/rubyide/vscode-ruby/issues/413). (You can change the linter path, but not the formatter.)
+
+In the meantime, you could just override the `rubocop` binary with a symlink to `rubocop-daemon-wrapper`:
+
+```bash
+# Find your rubocop path
+$ which rubocop
+# => /Users/username/.rvm/gems/ruby-2.5.3/bin/rubocop
+
+# Override rubocop with a symlink to rubocop-daemon-wrapper
+$ ln -fs /usr/local/bin/rubocop-daemon-wrapper /Users/username/.rvm/gems/ruby-2.5.3/bin/rubocop
+```
+
+Now VS Code will use the `rubocop-daemon-wrapper` script, and `formatOnSave` should be much faster (~150ms instead of 3-5 seconds).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/fohte/rubocop-daemon.

data/bin/rubocop-daemon-wrapper

@@ -0,0 +1,66 @@
+#!/bin/bash
+set -e
+
+find_project_root() {
+  path=$(pwd -P)
+  while [[ "$path" != "" && ! -f "$path/Gemfile" && ! -f "$path/gems.rb" ]]; do
+    path=${path%/*}
+  done
+  echo "$path"
+}
+
+PROJECT_ROOT="$(find_project_root)"
+if [ -z "$PROJECT_ROOT" ]; then
+  # If we can't find a Gemfile, just use the current directory
+  PROJECT_ROOT="$(pwd -P)"
+fi
+
+CACHE_DIR="$HOME/.cache/rubocop-daemon"
+PROJECT_CACHE_KEY="$(echo ${PROJECT_ROOT:1} | tr '/' '+')"
+PROJECT_CACHE_DIR="$CACHE_DIR/$PROJECT_CACHE_KEY"
+TOKEN_PATH="$PROJECT_CACHE_DIR/token"
+PORT_PATH="$PROJECT_CACHE_DIR/port"
+STDIN_PATH="$PROJECT_CACHE_DIR/stdin"
+STATUS_PATH="$PROJECT_CACHE_DIR/status"
+
+# If -s or --stdin args are present, read stdin with `cat`
+for ARG in $@; do
+  if [ -z "$STDIN_CONTENT" ] && [ "$ARG" == "--stdin" ] || [ "$ARG" == "-s" ]; then
+    STDIN_CONTENT="\n$(cat)"
+  fi
+done
+
+if [ ! -f "$TOKEN_PATH" ]; then
+  rubocop-daemon start
+fi
+
+run_rubocop_command() {
+  TOKEN="$(cat "$TOKEN_PATH")"
+  PORT="$(cat "$PORT_PATH")"
+  COMMAND="$TOKEN $PROJECT_ROOT exec $@"
+  rm -f "$STATUS_PATH" # Clear the previous status
+  if echo -e "$COMMAND${STDIN_CONTENT}" | nc localhost "$PORT"; then
+    if [ -f "$STATUS_PATH" ]; then
+      exit "$(cat $STATUS_PATH)"
+    else
+      echo "rubocop-daemon-wrapper: server did not write status to $STATUS_PATH!" >&2
+      exit 1
+    fi
+  fi
+  return 1
+}
+
+if ! run_rubocop_command $@; then
+  echo "rubocop-daemon-wrapper: Error sending command to localhost:$PORT ($COMMAND)" >&2
+  echo "Killing all rubocop-daemon processes and removing cache directory..." >&2
+  rm -rf "$CACHE_DIR"
+  pkill -f "rubocop-daemon (re)?start"
+  echo "Starting new rubocop-daemon server..." >&2
+  rubocop-daemon start
+  if ! run_rubocop_command $@; then
+    echo "Sorry, something went wrong with rubocop-daemon!" >&2
+    echo "Please try updating the gem or re-installing the rubocop-daemon-wrapper script."
+    echo "If that doesn't work, please open an issue on GitHub:" \
+      "https://github.com/fohte/rubocop-daemon/issues/new" >&2
+  fi
+fi

data/lib/rubocop/daemon.rb

@@ -2,6 +2,8 @@
 
 module RuboCop
   module Daemon
+    TIMEOUT = 20
+
     autoload :VERSION, 'rubocop/daemon/version'
 
     autoload :CLI, 'rubocop/daemon/cli'
@@ -15,6 +17,17 @@ module RuboCop
     def self.running?
       Cache.dir.exist? && Cache.pid_path.file? && Cache.pid_running?
     end
+
+    def self.wait_for_running_status!(expected)
+      start_time = Time.now
+      while Daemon.running? != expected
+        sleep 0.1
+        next unless Time.now - start_time > TIMEOUT
+
+        warn "running? was not #{expected} after #{TIMEOUT} seconds!"
+        exit 1
+      end
+    end
   end
 end
 

data/lib/rubocop/daemon/cache.rb

@@ -5,37 +5,82 @@ require 'pathname'
 module RuboCop
   module Daemon
     class Cache
-      def self.dir
-        Pathname.new(File.join(File.expand_path('~/.cache/rubocop-daemon'), Dir.pwd[1..-1].tr('/', '+'))).tap do |d|
-          d.mkpath unless d.exist?
+      class << self
+        # Searches for Gemfile or gems.rb in the current dir or any parent dirs
+        def project_dir
+          current_dir = Dir.pwd
+          while current_dir != '/'
+            return current_dir if %w[Gemfile gems.rb].any? do |gemfile|
+              File.exist?(File.join(current_dir, gemfile))
+            end
+
+            current_dir = File.expand_path('..', current_dir)
+          end
+          # If we can't find a Gemfile, just use the current directory
+          Dir.pwd
         end
-      end
 
-      def self.port_path
-        dir.join('port')
-      end
+        def project_dir_cache_key
+          @project_dir_cache_key ||= project_dir[1..-1].tr('/', '+')
+        end
 
-      def self.token_path
-        dir.join('token')
-      end
+        def dir
+          cache_path = File.expand_path('~/.cache/rubocop-daemon')
+          Pathname.new(File.join(cache_path, project_dir_cache_key)).tap do |d|
+            d.mkpath unless d.exist?
+          end
+        end
 
-      def self.pid_path
-        dir.join('pid')
-      end
+        def port_path
+          dir.join('port')
+        end
 
-      def self.pid_running?
-        Process.kill 0, pid_path.read.to_i
-      rescue Errno::ESRCH
-        false
-      end
+        def token_path
+          dir.join('token')
+        end
 
-      def self.make_server_file(port:, token:)
-        port_path.write(port)
-        token_path.write(token)
-        pid_path.write(Process.pid)
-        yield
-      ensure
-        dir.rmtree
+        def pid_path
+          dir.join('pid')
+        end
+
+        def lock_path
+          dir.join('lock')
+        end
+
+        def status_path
+          dir.join('status')
+        end
+
+        def pid_running?
+          Process.kill(0, pid_path.read.to_i) == 1
+        rescue Errno::ESRCH
+          false
+        end
+
+        def acquire_lock
+          lock_file = File.open(lock_path, File::CREAT)
+          flock_result = lock_file.flock(File::LOCK_EX | File::LOCK_NB)
+          yield flock_result.zero?
+        ensure
+          lock_file.flock(File::LOCK_UN)
+          lock_file.close
+        end
+
+        def write_port_and_token_files(port:, token:)
+          port_path.write(port)
+          token_path.write(token)
+        end
+
+        def write_pid_file
+          pid_path.write(Process.pid)
+          yield
+        ensure
+          dir.rmtree
+        end
+
+        def write_status_file(status)
+          status_path.write(status)
+        end
       end
     end
   end

data/lib/rubocop/daemon/cli.rb

@@ -23,9 +23,6 @@ module RuboCop
       rescue UnknownClientCommandError => e
         warn "rubocop-daemon: #{e.message}. See 'rubocop-daemon --help'."
         exit 1
-      rescue ServerIsNotRunningError
-        warn 'rubocop-daemon: server is not running.'
-        exit 1
       end
 
       def parser

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

@@ -25,8 +25,16 @@ module RuboCop
           end
         end
 
-        def check_running_server!
-          raise ServerIsNotRunningError unless Daemon.running?
+        def check_running_server
+          Daemon.running?.tap do |running|
+            warn 'rubocop-daemon: server is not running.' unless running
+          end
+        end
+
+        def ensure_server!
+          return if check_running_server
+
+          ClientCommand::Start.new([]).run
         end
       end
     end

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

@@ -6,12 +6,14 @@ module RuboCop
       class Exec < Base
         def run
           args = parser.parse(@argv)
-          check_running_server!
+          ensure_server!
+          Cache.status_path.delete if Cache.status_path.file?
           send_request(
             command: 'exec',
             args: args,
             body: $stdin.tty? ? '' : $stdin.read,
           )
+          exit_with_status!
         end
 
         private
@@ -21,6 +23,15 @@ module RuboCop
             p.banner = 'usage: rubocop-daemon exec [options] [files...] [-- [rubocop-options]]'
           end
         end
+
+        def exit_with_status!
+          raise "rubocop-daemon: Could not find status file at: #{Cache.status_path}" unless Cache.status_path.file?
+
+          status = Cache.status_path.read
+          raise "rubocop-daemon: '#{status}' is not a valid status!" unless status.match?(/^\d+$/)
+
+          exit status.to_i
+        end
       end
     end
   end

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

@@ -6,9 +6,9 @@ module RuboCop
       class Restart < Base
         def run
           parser.parse(@argv)
-          check_running_server!
-          send_request(command: 'stop')
-          Server.new.start(@options.fetch(:port, 0))
+
+          ClientCommand::Stop.new([]).run
+          ClientCommand::Start.new(@argv).run
         end
 
         private

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

@@ -5,8 +5,22 @@ module RuboCop
     module ClientCommand
       class Start < Base
         def run
-          parser.parse(@argv)
-          Server.new(@options.fetch(:no_daemon, false)).start(@options.fetch(:port, 0))
+          if Daemon.running?
+            warn 'rubocop-daemon: server is already running.'
+            return
+          end
+
+          Cache.acquire_lock do |locked|
+            unless locked
+              # Another process is already starting the daemon,
+              # so wait for it to be ready.
+              Daemon.wait_for_running_status!(true)
+              exit 0
+            end
+
+            parser.parse(@argv)
+            Server.new(@options.fetch(:no_daemon, false)).start(@options.fetch(:port, 0))
+          end
         end
 
         private

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

@@ -5,9 +5,11 @@ module RuboCop
     module ClientCommand
       class Stop < Base
         def run
+          return unless check_running_server
+
           parser.parse(@argv)
-          check_running_server!
           send_request(command: 'stop')
+          Daemon.wait_for_running_status!(false)
         end
 
         private

data/lib/rubocop/daemon/errors.rb

@@ -2,8 +2,8 @@
 
 module RuboCop
   module Daemon
+    class GemfileNotFound < StandardError; end
     class InvalidTokenError < StandardError; end
-    class ServerIsNotRunningError < StandardError; end
     class ServerStopRequest < StandardError; end
     class UnknownClientCommandError < StandardError; end
     class UnknownServerCommandError < StandardError; end

data/lib/rubocop/daemon/server.rb

@@ -24,8 +24,9 @@ module RuboCop
       def start(port)
         require 'rubocop'
         start_server(port)
+        Cache.write_port_and_token_files(port: @server.addr[1], token: token)
         Process.daemon(true) unless verbose
-        Cache.make_server_file(port: @server.addr[1], token: token) do
+        Cache.write_pid_file do
           read_socket(@server.accept) until @server.closed?
         end
       end

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

@@ -5,8 +5,17 @@ module RuboCop
     module ServerCommand
       class Exec < Base
         def run
-          RuboCop::CLI.new.run(@args)
-        rescue SystemExit # rubocop:disable Lint/HandleExceptions
+          Cache.status_path.delete if Cache.status_path.file?
+          # 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-daemon exec` and `rubocop-daemon-wrapper`,
+          # 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

data/lib/rubocop/daemon/socket_reader.rb

@@ -26,8 +26,12 @@ module RuboCop
       private
 
       def parse_request(content)
-        puts content if @verbose
         raw_header, *body = content.lines
+        if @verbose
+          puts raw_header.to_s
+          puts "STDIN: #{body.size} lines" if body.any?
+        end
+
         Request.new(parse_header(raw_header), body.join)
       end
 

data/lib/rubocop/daemon/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Daemon
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/rubocop-daemon.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rubocop'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-daemon
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Hayato Kawai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-14 00:00:00.000000000 Z
+date: 2018-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +97,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rubocop-daemon-wrapper
 - bin/setup
 - exe/rubocop-daemon
 - lib/rubocop/daemon.rb