filewatcher-cli 1.0.0.beta1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a7885738bc63e99bd2be26af12b8ec536f29ec6e117e191dc507b973b152f3b
-  data.tar.gz: e46bb7b473ec6cc0943cb71aa3d0d63047d8ac989e866fcd5c2d47b2ab3b0ad5
+  metadata.gz: ecc2b0f16f8b65900310497d4ba3ed44681a24955cbba174bb49bd46816096a1
+  data.tar.gz: b4a02f994d6c7f25c2c390baac9ec4593bfd21e98a42b1217932eb251de3f486
 SHA512:
-  metadata.gz: 00c729fb158d7cc1f49bf09c53117e8b6f284b3c922ef741e1202725d494111a8ccaa9d3d36687c66f35d85e8a8fa422504e30346357d5c8bb697868e25dffbc
-  data.tar.gz: d02829a6821d3f7b7aeb537299199062fba11025a5e71b6755cc83db6eb41e9dd27e2c19a397ccb0d9843e73623c42e80e0956fdadb04a217d4e99160fc44afe
+  metadata.gz: a0b6b45cac67c1ca798bf95ce79cb27af25f46d0005c27594477e5ea9ff8b26bbda2e8e69c8d87de6f85aeff1b5dc2626a2e902b071727613daa767500fc8e99
+  data.tar.gz: 99ef03d27a90356182d01e5871830894a06a7ceaf30c378383d173f6b015e576bf5c536ab9aa3277f76ebe5948c171fb5ec846fad068a88b604746e393cf85e8

data/CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
-## master (unreleased)
+## Unreleased
 
-## 1.0.0.beta1 (2020-09-19)
+## 1.0.0 (2022-09-09)
 
 *   Initial release.

data/README.md

@@ -1,12 +1,12 @@
 # Filewatcher CLI
 
 [![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/filewatcher/filewatcher-cli?style=flat-square)](https://cirrus-ci.com/github/filewatcher/filewatcher-cli)
-[![Codecov branch](https://img.shields.io/codecov/c/github/filewatcher/filewatcher-cli/master.svg?style=flat-square)](https://codecov.io/gh/filewatcher/filewatcher-cli)
+[![Codecov branch](https://img.shields.io/codecov/c/github/filewatcher/filewatcher-cli/main.svg?style=flat-square)](https://codecov.io/gh/filewatcher/filewatcher-cli)
 [![Code Climate](https://img.shields.io/codeclimate/maintainability/filewatcher/filewatcher-cli.svg?style=flat-square)](https://codeclimate.com/github/filewatcher/filewatcher-cli)
 [![Depfu](https://img.shields.io/depfu/filewatcher/filewatcher-cli?style=flat-square)](https://depfu.com/repos/github/filewatcher/filewatcher-cli)
-[![Inline docs](https://inch-ci.org/github/filewatcher/filewatcher-cli.svg?branch=master)](https://inch-ci.org/github/filewatcher/filewatcher-cli)
+[![Inline docs](https://inch-ci.org/github/filewatcher/filewatcher-cli.svg?branch=main)](https://inch-ci.org/github/filewatcher/filewatcher-cli)
 [![License](https://img.shields.io/github/license/filewatcher/filewatcher-cli.svg?style=flat-square)](LICENSE.txt)
-[![Gem](https://img.shields.io/gem/v/filewatcher-cli.svg?style=flat-square)](https://rubygems.org/gems/filewatcher-cli)
+[![Gem](https://img.shields.io/gem/v/filewatcher-cli.svg?include_prereleases&style=flat-square)](https://rubygems.org/gems/filewatcher-cli)
 
 CLI for [Filewatcher](https://github.com/filewatcher/filewatcher).
 
@@ -112,6 +112,10 @@ via `--restart-signal` option:
 $ filewatcher --restart --restart-signal=KILL "**/*.rb" "rake test"
 ```
 
+Due to [problems with signals on Windows](https://bugs.ruby-lang.org/issues/17820),
+the default value of restart signal is `KILL` on Windows (while on Unix-like is `TERM`),
+which is a single one supported at the current moment, so use other values carefully.
+
 The `--immediate/-I` option starts the command on startup without waiting for file system updates. To start a web server and have it automatically restart when HTML files are updated:
 
 ```sh

data/lib/filewatcher/cli/command/options.rb

@@ -17,8 +17,10 @@ class Filewatcher
       option %w[-r --restart --fork], :flag, 'restart process when file system is updated',
         default: false
 
+      ## Signal don't work on Windows for some reason:
+      ## https://bugs.ruby-lang.org/issues/17820
       option '--restart-signal', 'VALUE', 'termination signal for `restart` option',
-        default: 'TERM'
+        default: Gem.win_platform? ? 'KILL' : 'TERM'
 
       option %w[-l --list], :flag, 'print name of files being watched',
         default: false
@@ -30,7 +32,7 @@ class Filewatcher
         default: File.join('**', '*')
 
       option '--exclude', 'GLOB', 'exclude file(s) matching', default: nil do |string|
-        split_files_void_escaped_whitespace string.split(' ') unless string.to_s.empty?
+        split_files_void_escaped_whitespace string.split unless string.to_s.empty?
       end
 
       option %w[-i --interval], 'SECONDS', 'interval to scan file system', default: 0.5 do |string|

data/lib/filewatcher/cli/command.rb

@@ -22,6 +22,12 @@ class Filewatcher
 
       parameter '[COMMAND]', 'shell command to execute when file changes'
 
+      option ['-v', '--version'], :flag, 'Print versions' do
+        Filewatcher.print_version
+        puts "Filewatcher CLI #{Filewatcher::CLI::VERSION}"
+        exit 0
+      end
+
       def execute
         @child_pid = nil
 
@@ -42,9 +48,9 @@ class Filewatcher
         @filewatcher = Filewatcher.new(
           files,
           ## https://github.com/mdub/clamp/issues/105
-          self.class.declared_options.map do |option|
+          self.class.declared_options.to_h do |option|
             [option.attribute_name.to_sym, public_send(option.read_method)]
-          end.to_h
+          end
         )
       end
 
@@ -93,10 +99,23 @@ class Filewatcher
         end
       end
 
+      WINDOWS_SIGNALS_WARNING = <<~WARN
+        WARNING: Signals don't work on Windows properly: https://bugs.ruby-lang.org/issues/17820
+        It's recommended to use only the `KILL` (default `restart-signal` on Windows).
+      WARN
+      private_constant :WINDOWS_SIGNALS_WARNING
+
       def restart(pid, restart_signal, env, command)
         begin
           raise Errno::ESRCH unless pid
 
+          ## Signals don't work on Windows for some reason:
+          ## https://cirrus-ci.com/task/5706760947236864?logs=test#L346
+          ## https://bugs.ruby-lang.org/issues/17820
+          ## https://blog.simplificator.com/2016/01/18/how-to-kill-processes-on-windows-using-ruby/
+          ## But `KILL` works.
+          warn WINDOWS_SIGNALS_WARNING if Gem.win_platform? && restart_signal != 'KILL'
+
           Process.kill(restart_signal, pid)
           Process.wait(pid)
         rescue Errno::ESRCH

data/lib/filewatcher/cli/constants.rb

@@ -4,6 +4,6 @@ class Filewatcher
   module CLI
     BINDIR = 'exe'
 
-    VERSION = '1.0.0.beta1'
+    VERSION = '1.0.0'
   end
 end

data/lib/filewatcher/cli/spec_helper/dump_to_file.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'shell_watch_run'
+
+def dump_to_file(content)
+  File.write File.join(Filewatcher::CLI::SpecHelper::ShellWatchRun::DUMP_FILE), content
+end

data/lib/filewatcher/cli/spec_helper/dumpers/env_dumper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative '../dump_to_file'
+
+dump_to_file(
+  %w[
+    FILENAME BASENAME EVENT DIRNAME ABSOLUTE_FILENAME RELATIVE_FILENAME
+  ].map { |var| ENV.fetch(var) }.join(', ')
+)

data/lib/filewatcher/cli/spec_helper/dumpers/signal_dumper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative '../dump_to_file'
+
+signal = ARGV.first
+Signal.trap(signal) do
+  dump_to_file signal
+  exit
+end
+
+Filewatcher::CLI::SpecHelper.wait seconds: 60

data/lib/filewatcher/cli/spec_helper/dumpers/watched_dumper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative '../dump_to_file'
+
+dump_to_file 'watched'

data/lib/filewatcher/cli/spec_helper/shell_watch_run.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require_relative '../constants'
+require_relative '../spec_helper'
+
+class Filewatcher
+  module CLI
+    module SpecHelper
+      ## Watch runner for calls from shell
+      class ShellWatchRun
+        include Filewatcher::SpecHelper::WatchRun
+        include CLI::SpecHelper
+
+        executable_path = File.realpath "#{__dir__}/../../../../#{CLI::BINDIR}/filewatcher"
+        EXECUTABLE = "#{'ruby ' if Gem.win_platform?}#{executable_path}" \
+
+        DUMP_FILE = File.join(TMP_DIR, 'dump')
+
+        def initialize(options:, dumper:, dumper_args:, **rest_args)
+          super(**rest_args)
+          @options = options
+          @options[:interval] ||= 0.2
+          debug "options = #{options_string}"
+          @dumper = dumper
+          debug "dumper = #{@dumper}"
+          @dumper_args = dumper_args.join(' ')
+        end
+
+        def start
+          super
+
+          spawn_filewatcher
+
+          wait
+
+          wait seconds: 3 do
+            debug "pid state = #{pid_state.inspect}"
+            dump_file_exists = File.exist?(DUMP_FILE)
+            debug "#{__method__}: File.exist?(DUMP_FILE) = #{dump_file_exists}"
+            pid_ready? && (!@options[:immediate] || dump_file_exists)
+          end
+
+          ## Dump file can exists with `--immediate` option, but Filewatcher can not have time
+          ## to initialize `@last_snapshot` in main cycle.
+          wait
+        end
+
+        def stop
+          kill_filewatcher
+
+          wait do
+            pid_state.nil?
+          end
+
+          super
+        end
+
+        private
+
+        def options_string
+          @options_string ||=
+            @options
+              .map { |key, value| value.is_a?(TrueClass) ? "--#{key}" : "--#{key}=#{value}" }
+              .join(' ')
+        end
+
+        SPAWN_OPTIONS = Gem.win_platform? ? {} : { pgroup: true }
+
+        def spawn_filewatcher
+          dumper_full_command = "#{__dir__}/dumpers/#{@dumper}_dumper.rb #{@dumper_args}"
+          spawn_command =
+            "#{EXECUTABLE} #{options_string} \"#{@filename}\" \"ruby #{dumper_full_command}\""
+          debug "spawn_command = #{spawn_command}"
+          @pid = spawn spawn_command, **SPAWN_OPTIONS
+
+          debug "@pid = #{@pid}"
+
+          debug Process.detach(@pid)
+        end
+
+        def make_changes
+          super
+
+          wait seconds: 3 do
+            dump_file_exists = File.exist?(DUMP_FILE)
+            debug "#{__method__}: File.exist?(DUMP_FILE) = #{dump_file_exists}"
+            debug "#{__method__}: DUMP_FILE content = #{File.read(DUMP_FILE)}" if dump_file_exists
+            dump_file_exists
+          end
+        end
+
+        def kill_filewatcher
+          # debug __method__
+          if Gem.win_platform?
+            Process.kill('KILL', @pid)
+          else
+            ## Problems: https://github.com/thomasfl/filewatcher/pull/83
+            ## Solution: https://stackoverflow.com/a/45032252/2630849
+            Process.kill('TERM', -Process.getpgid(@pid))
+            Process.waitall
+          end
+        rescue Errno::ESRCH
+          nil ## already killed
+        ensure
+          wait
+        end
+
+        def pid_state
+          if Gem.win_platform?
+            match = `tasklist /FI "PID eq #{@pid}" /FO "LIST" /V`.match(/Status:\s+(\w+)/)
+            return unless match
+
+            match[1]
+          else
+            ## For macOS output:
+            ## https://travis-ci.org/thomasfl/filewatcher/jobs/304433538
+            state = `ps -ho state -p #{@pid}`.sub('STAT', '').strip
+            ## Return `nil` for consistency with Windows
+            state.empty? ? nil : state
+          end
+        end
+
+        def pid_ready?
+          ps = pid_state
+
+          return if ps.nil?
+
+          ps == (Gem.win_platform? ? 'Running' : 'S')
+        end
+
+        def wait(seconds: 1)
+          super seconds: seconds, interval: @options[:interval]
+        end
+      end
+    end
+  end
+end

data/lib/filewatcher/cli/spec_helper.rb

@@ -2,22 +2,36 @@
 
 require 'filewatcher/spec_helper'
 
+require_relative 'spec_helper/dump_to_file'
+
 class Filewatcher
   module CLI
     ## Helper for CLI specs
     module SpecHelper
       include Filewatcher::SpecHelper
 
+      ENVIRONMENT_SPECS_COEFFICIENTS = {
+        lambda do
+          RUBY_ENGINE == 'jruby' &&
+            is_a?(Filewatcher::CLI::SpecHelper::ShellWatchRun)
+        end => 2,
+        lambda do
+          RUBY_ENGINE == 'jruby' &&
+            ENV.fetch('CI', false) &&
+            is_a?(Filewatcher::CLI::SpecHelper::ShellWatchRun)
+        end => 1.5,
+        lambda do
+          RUBY_ENGINE == 'truffleruby' &&
+            ENV.fetch('CI', false) &&
+            is_a?(Filewatcher::CLI::SpecHelper::ShellWatchRun)
+        end => 3
+      }.freeze
+
       def environment_specs_coefficients
-        super.merge(
-          ## https://cirrus-ci.com/build/6442339705028608
-          lambda do
-            RUBY_PLATFORM == 'java' && ENV['CI'] && is_a?(Filewatcher::Spec::ShellWatchRun)
-          end => 2
-        )
+        @environment_specs_coefficients ||= super.merge ENVIRONMENT_SPECS_COEFFICIENTS
       end
 
-      ## https://github.com/rubocop-hq/ruby-style-guide/issues/556#issuecomment-691274359
+      ## https://github.com/rubocop/ruby-style-guide/issues/556#issuecomment-828672008
       # rubocop:disable Style/ModuleFunction
       extend self
       # rubocop:enable Style/ModuleFunction

data/lib/filewatcher/cli.rb

@@ -2,4 +2,4 @@
 
 require 'filewatcher'
 
-require_relative 'cli/constants'
+require_relative 'cli/command'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filewatcher-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0
 platform: ruby
 authors:
 - Thomas Flemming
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -67,48 +67,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: gem_toys
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
   name: toys
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -129,28 +143,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.0
+        version: 1.36.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.89.0
+        version: 1.36.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -171,14 +185,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.43'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.43'
+        version: '2.0'
 description: 'CLI for Filewatcher.
 
   '
@@ -201,13 +215,19 @@ files:
 - lib/filewatcher/cli/env.rb
 - lib/filewatcher/cli/runner.rb
 - lib/filewatcher/cli/spec_helper.rb
+- lib/filewatcher/cli/spec_helper/dump_to_file.rb
+- lib/filewatcher/cli/spec_helper/dumpers/env_dumper.rb
+- lib/filewatcher/cli/spec_helper/dumpers/signal_dumper.rb
+- lib/filewatcher/cli/spec_helper/dumpers/watched_dumper.rb
+- lib/filewatcher/cli/spec_helper/shell_watch_run.rb
 homepage: https://github.com/filewatcher/filewatcher-cli
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/filewatcher/filewatcher-cli
   homepage_uri: https://github.com/filewatcher/filewatcher-cli
-  changelog_uri: https://github.com/filewatcher/filewatcher-cli/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/filewatcher/filewatcher-cli/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -216,14 +236,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: CLI for Filewatcher