rubocop-daemon 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e34a73d9ee5a5f38b2a531efc3a19103b93ae9eef54faea95751820815c893b4
-  data.tar.gz: 9968fd324e630f5ad2d40f9c9895d4dec8a03e016087ba3b95978a126ee045ab
+  metadata.gz: 190e538beeb1f58fc133eda7baff54f976c4835d14143d6ca7bb8780e15f88c1
+  data.tar.gz: 31f5094c298bc1af68a853990a8deb9aa39a5fabcc1de609403edea2081745fb
 SHA512:
-  metadata.gz: 03b61796952aa7762a0a4ecb967e6f0d3da0ad54c45395789255cbd188646d8662f0a2f31a8fd82b7fcfaad184fbed69df641c64ea5904bd7ffaa5d454fb36cf
-  data.tar.gz: e1dd9d6eccb027a1f4ddc3316fa488d69983108d5381348f0397ab8f01aa5b270846c3fec43cadeab28e5d5e93e5fd8f56d178c8dd6c3d48390c2228336084bb
+  metadata.gz: 6c8c1f9fe127c33de58c83a7e4bd0e283356432202aef18613476a5f597971139c00cfc6dc0de1814e886a3365f37cabc7558425429f0d15af4fb2268b482d4c
+  data.tar.gz: ec698adacaca218f38d95c4cb91ef0fd25dd8a2c35de20b2b2703cbd8282b8419760a1c44fd0e0cc53f34af2f889efafbc5b36b194ddaac5fd1408eb5a9db5c5

data/README.md

@@ -12,6 +12,12 @@ Install `rubocop-daemon` via rubygems.org:
 gem install rubocop-daemon
 ```
 
+or if you install RuboCop using bundler, put this in your `Gemfile`:
+
+```ruby
+gem 'rubocop-daemon', require: false
+```
+
 ## Usage
 
 To start the server, just run:
@@ -76,7 +82,17 @@ 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
+### Use with Bundler
+
+If you install `rubocop-daemon` with bundler, you should set `RUBOCOP_DAEMON_USE_BUNDLER` environment variable:
+
+```console
+$ export RUBOCOP_DAEMON_USE_BUNDLER=true
+```
+
+Now `rubocop-daemon-wrapper` will call the `rubocop-daemon` command with `bundle exec`.
+
+### 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.)
 
@@ -85,14 +101,46 @@ In the meantime, you could just override the `rubocop` binary with a symlink to
 ```bash
 # Find your rubocop path
 $ which rubocop
-# => /Users/username/.rvm/gems/ruby-2.5.3/bin/rubocop
+<HOME>/.rvm/gems/ruby-x.y.z/bin/rubocop
+
+# Override rubocop with a symlink to rubocop-daemon-wrapper
+$ ln -fs /usr/local/bin/rubocop-daemon-wrapper $HOME/.rvm/gems/ruby-x.y.z/bin/rubocop
+```
+
+Or, if you use rbenv:
+
+```bash
+# which rubocop is rbenv running?
+$ rbenv which rubocop
+<HOME>/.rbenv/versions/x.y.z/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
+$ ln -fs /usr/local/bin/rubocop-daemon-wrapper $HOME/.rbenv/versions/x.y.z/bin/rubocop
 ```
 
 Now VS Code will use the `rubocop-daemon-wrapper` script, and `formatOnSave` should be much faster (~150ms instead of 3-5 seconds).
 
+### Use with Neovim/Vim8 and ALE
+
+[ALE](https://github.com/w0rp/ale) setting example:
+
+```vim
+" Use `rubocop-daemon-wrapper` instead of `rubocop`
+let g:ale_ruby_rubocop_executable = 'rubocop-daemon-wrapper'
+```
+
+Auto-correct on save setting example:
+
+```vim
+" optional: Set fixer(not only linter).
+let g:ale_fixers = {
+\   'ruby': ['rubocop'],
+\}
+
+" optional: Auto-correct on save.
+let g:ale_fix_on_save = 1
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/fohte/rubocop-daemon.

data/bin/rubocop-daemon-wrapper

@@ -1,8 +1,24 @@
 #!/bin/bash
+
 set -e
 
+COMMAND_PREFIX=""
+
+if [ -n "$RUBOCOP_DAEMON_USE_BUNDLER" ]; then
+  COMMAND_PREFIX="bundle exec"
+fi
+
+if ! command -v rubocop-daemon > /dev/null; then
+  $COMMAND_PREFIX rubocop $@
+  exit $?
+fi
+
 if [[ "$OSTYPE" == "linux-gnu" ]]; then
-  NETCAT_CMD="nc -N"
+  if [ -f "/etc/fedora-release" ]; then
+    NETCAT_CMD="nc"
+  else
+    NETCAT_CMD="nc -N"
+  fi
 elif [[ "$OSTYPE" == "darwin"* ]]; then
   NETCAT_CMD="nc"
 elif [[ "$OSTYPE" == "freebsd"* ]]; then
@@ -46,16 +62,42 @@ TOKEN_PATH="$PROJECT_CACHE_DIR/token"
 PORT_PATH="$PROJECT_CACHE_DIR/port"
 STDIN_PATH="$PROJECT_CACHE_DIR/stdin"
 STATUS_PATH="$PROJECT_CACHE_DIR/status"
+LOCK_PATH="$CACHE_DIR/running.lock"
+RUBOCOP_DAEMON="$COMMAND_PREFIX rubocop-daemon"
+
+# If a lock file exist, wait up to 5 seconds.
+i=0
+while [ -d "$LOCK_PATH" ]; do
+  echo "rubocop-daemon-wrapper: rubocop-daemon is processing a request; pausing before trying again..." >&2
+  sleep 1
+  i=$((i + 1))
+  if [ $i -ge 5 ]; then
+    echo "rubocop-daemon-wrapper: Waited more than 5 seconds; ignoring the lock and proceeding." >&2
+    break
+  fi
+done
+
+unlock() {
+  rm -r "$LOCK_PATH" 2> /dev/null
+}
+
+trap unlock EXIT
+
+# Acquire a file lock before proceeding.
+# Macs don't support the `lockfile` command, so just use mkdir.
+mkdir -p "$LOCK_PATH"
 
 # 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)"
+    # Preserve final new lines when ingesting from STDIN
+    STDIN_CONTENT="$(cat; printf x)"
+    STDIN_CONTENT=${STDIN_CONTENT%x}
   fi
 done
 
 if [ ! -f "$TOKEN_PATH" ]; then
-  rubocop-daemon start
+  $RUBOCOP_DAEMON start
 fi
 
 run_rubocop_command() {
@@ -63,7 +105,7 @@ run_rubocop_command() {
   PORT="$(cat "$PORT_PATH")"
   COMMAND="$TOKEN $PROJECT_ROOT exec $@"
   rm -f "$STATUS_PATH" # Clear the previous status
-  if echo -e "$COMMAND${STDIN_CONTENT}" | $NETCAT_CMD localhost "$PORT"; then
+  if printf '%s\n%s' "$COMMAND" "$STDIN_CONTENT" | $NETCAT_CMD localhost "$PORT"; then
     if [ -f "$STATUS_PATH" ]; then
       exit "$(cat $STATUS_PATH)"
     else
@@ -80,7 +122,7 @@ if ! run_rubocop_command $@; then
   rm -rf "$CACHE_DIR"
   pkill -f "rubocop-daemon (re)?start"
   echo "Starting new rubocop-daemon server..." >&2
-  rubocop-daemon start
+  $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."

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

@@ -28,7 +28,7 @@ module RuboCop
           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+$/)
+          raise "rubocop-daemon: '#{status}' is not a valid status!" if (status =~ /^\d+$/).nil?
 
           exit status.to_i
         end

data/lib/rubocop/daemon/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Daemon
-    VERSION = '0.3.1'.freeze
+    VERSION = '0.3.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-daemon
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Hayato Kawai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-20 00:00:00.000000000 Z
+date: 2019-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -139,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Makes RuboCop faster