filewatcher 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 025e651355a5bbbae353527112232253ee4f682d
-  data.tar.gz: 95ca7990a7e002768ac0a7a814a4129841efe3d6
+SHA256:
+  metadata.gz: 9221be161e73cc2f85ea6f9706a2e558c31ff314664bc31817e9715439a31927
+  data.tar.gz: bae2bc1ba2f5b88693fe1c8093b135652885094c69adc3da51193916ada96b44
 SHA512:
-  metadata.gz: b8576d1ff169c063a664ae9c538c51ad079ccfae4a604e0c277b84df261dc438b25f912863e5bd9b2ae542bac48026ea8f5a9a0990ccb81265206751b6138a1a
-  data.tar.gz: 25b04df22331575a7ffbfce5c1acc5168c0ee58e9d15fa4d4f7f3dff309fe1382be5920c315015309217bbf108882d994777cda67376c511c1197d6840952e7e
+  metadata.gz: 0aec2e10e03aad69fd0e4ccda0a6f488efc7c908abe31640319971dda6ed71ca8873588d87693f91309d13ac996bb62a952e3c7430c41b462d663e0064185e8e
+  data.tar.gz: ebf1581b4e3e56c77c4a18867ce55d2cb9a6fbf97d7804da305192dd9622a39d9b16cfe1392dd880c6dd1c43f47539a66a10f61956de7fad0202f2c43222b64d

data/lib/filewatcher.rb

@@ -8,7 +8,8 @@ require_relative 'filewatcher/cycles'
 class Filewatcher
   include Filewatcher::Cycles
 
-  attr_writer :interval
+  attr_accessor :interval
+  attr_reader :keep_watching
 
   def update_spinner(label)
     return unless @show_spinner
@@ -28,7 +29,7 @@ class Filewatcher
   end
 
   def watch(&on_update)
-    trap('SIGINT') { return }
+    %w[HUP INT TERM].each { |signal| trap(signal) { exit } }
     @on_update = on_update
     @keep_watching = true
     yield('', '') if @immediate

data/lib/filewatcher/env.rb

@@ -10,8 +10,12 @@ class Filewatcher
       @filename = filename
       @event = event
       @path = Pathname.new(@filename)
-      @realpath = @path.realpath
+      @realpath = @path.exist? ? @path.realpath : @path
       @current_dir = Pathname.new(Dir.pwd)
+      # For safely `immediate` option with empty-strings arguments
+      @relative_path =
+        (@realpath.to_s.empty? ? @current_dir : @realpath)
+          .relative_path_from(@current_dir)
     end
 
     def to_h
@@ -22,7 +26,7 @@ class Filewatcher
         'EVENT' => @event.to_s,
         'DIRNAME' => @path.parent.realpath.to_s,
         'ABSOLUTE_FILENAME' => @realpath.to_s,
-        'RELATIVE_FILENAME' => @realpath.relative_path_from(@current_dir).to_s
+        'RELATIVE_FILENAME' => @relative_path.to_s
       }
     end
   end

data/lib/filewatcher/version.rb

@@ -3,5 +3,5 @@
 require_relative '../filewatcher'
 
 class Filewatcher
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/test/helper.rb

@@ -12,50 +12,93 @@ end
 class WatchRun
   TMP_DIR = File.join(__dir__, 'tmp')
 
-  attr_reader :filename, :filewatcher, :thread, :watched, :processed
+  attr_reader :filename
 
   def initialize(
     filename: 'tmp_file.txt',
     directory: false,
-    every: false,
-    filewatcher: Filewatcher.new(
-      File.join(TMP_DIR, '**', '*'), interval: 0.1, every: every
-    ),
     action: :update
   )
     @filename =
       filename.start_with?('/', '~') ? filename : File.join(TMP_DIR, filename)
     @directory = directory
-    @filewatcher = filewatcher
     @action = action
   end
 
   def start
     File.write(@filename, 'content1') unless @action == :create
-
-    @thread = thread_initialize
-    sleep 3 # thread needs a chance to start
   end
 
   def run
     start
 
     make_changes
-    # Some OS, filesystems and Ruby interpretators
-    # doesn't catch milliseconds of `File.mtime`
-    sleep 3
 
     stop
   end
 
   def stop
     FileUtils.rm_r(@filename) if File.exist?(@filename)
-    @thread.exit
-    sleep 3
   end
 
   private
 
+  def make_changes
+    if @action == :delete
+      FileUtils.remove(@filename)
+    elsif @directory
+      FileUtils.mkdir_p(@filename)
+    else
+      File.write(@filename, 'content2')
+    end
+  end
+end
+
+class RubyWatchRun < WatchRun
+  attr_reader :filewatcher, :thread, :watched, :processed
+
+  def initialize(
+    every: false,
+    filewatcher: Filewatcher.new(
+      File.join(TMP_DIR, '**', '*'), interval: 0.1, every: every
+    ),
+    **args
+  )
+    super(**args)
+    @filewatcher = filewatcher
+  end
+
+  def start
+    super
+    @thread = thread_initialize
+    # thread needs a chance to start
+    wait 3 do
+      filewatcher.keep_watching
+    end
+  end
+
+  def stop
+    thread.exit
+
+    wait 3 do
+      thread.stop?
+    end
+
+    super
+  end
+
+  private
+
+  def make_changes
+    super
+
+    # Some OS, filesystems and Ruby interpretators
+    # doesn't catch milliseconds of `File.mtime`
+    wait 3 do
+      processed.any?
+    end
+  end
+
   def thread_initialize
     @watched ||= 0
     Thread.new(
@@ -72,56 +115,95 @@ class WatchRun
     @watched += 1
   end
 
-  def make_changes
-    return FileUtils.remove(@filename) if @action == :delete
-    return FileUtils.mkdir_p(@filename) if @directory
-    File.write(@filename, 'content2')
+  def wait(seconds)
+    max_count = seconds / filewatcher.interval
+    count = 0
+    while count < max_count && !yield
+      sleep filewatcher.interval
+      count += 1
+    end
   end
 end
 
-class ShellWatchRun
+class ShellWatchRun < WatchRun
   EXECUTABLE = "#{'ruby ' if Gem.win_platform?}" \
     "#{File.realpath File.join(__dir__, '..', 'bin', 'filewatcher')}".freeze
 
-  attr_reader :output
+  SLEEP_MULTIPLIER = RUBY_PLATFORM == 'java' ? 5 : 1
+
+  ENV_FILE = File.join(TMP_DIR, 'env')
 
   def initialize(
-    options: '',
+    options: {},
     dumper: :watched,
-    output: File.join(WatchRun::TMP_DIR, 'env')
+    **args
   )
+    super(**args)
     @options = options
+    @options[:interval] ||= 0.1
+    @options_string =
+      @options.map { |key, value| "--#{key}=#{value}" }.join(' ')
     @dumper = dumper
-    @output = output
   end
 
   def start
+    super
+
     @pid = spawn(
-      "#{EXECUTABLE} #{@options} \"#{WatchRun::TMP_DIR}/foo*\"" \
-        " \"ruby #{File.join(__dir__, 'dumpers', "#{@dumper}_dumper.rb")}\""
+      "#{EXECUTABLE} #{@options_string} \"#{@filename}\"" \
+        " \"ruby #{File.join(__dir__, 'dumpers', "#{@dumper}_dumper.rb")}\"",
+      pgroup: true
     )
-    Process.detach(@pid)
-    sleep 12
-  end
 
-  def run
-    start
+    Process.detach(@pid)
 
-    make_changes
+    wait 12 do
+      pid_state == 'S' && (!@options[:immediate] || File.exist?(ENV_FILE))
+    end
 
-    stop
+    # a little more time
+    sleep 1 * SLEEP_MULTIPLIER
   end
 
   def stop
-    Process.kill('KILL', @pid)
-    sleep 6
+    ## Problems: https://github.com/thomasfl/filewatcher/pull/83
+    ## Solution: https://stackoverflow.com/a/45032252/2630849
+    Process.kill('TERM', -Process.getpgid(@pid))
+    Process.waitall
+
+    wait 12 do
+      pid_state.empty?
+    end
+
+    # a little more time
+    sleep 1 * SLEEP_MULTIPLIER
+
+    super
   end
 
   private
 
   def make_changes
-    FileUtils.touch "#{WatchRun::TMP_DIR}/foo.txt"
-    sleep 12
+    super
+
+    wait 12 do
+      File.exist?(ENV_FILE)
+    end
+  end
+
+  def pid_state
+    ## For macOS output:
+    ## https://travis-ci.org/thomasfl/filewatcher/jobs/304433538
+    `ps -ho state -p #{@pid}`.sub('STAT', '').strip
+  end
+
+  def wait(seconds)
+    max_count = seconds / @options[:interval]
+    count = 0
+    while count < max_count && !yield
+      sleep @options[:interval]
+      count += 1
+    end
   end
 end
 
@@ -130,5 +212,5 @@ custom_matcher :include_all_files do |obj, elements|
 end
 
 def dump_to_env_file(content)
-  File.write File.join(WatchRun::TMP_DIR, 'env'), content
+  File.write File.join(ShellWatchRun::ENV_FILE), content
 end

data/test/test_filewatcher.rb

@@ -10,11 +10,18 @@ describe Filewatcher do
 
   after do
     FileUtils.rm_r WatchRun::TMP_DIR
+
+    interval = 0.1
+    wait = 5
+    count = 0
+    while File.exist?(WatchRun::TMP_DIR) && count < (wait / interval)
+      sleep interval
+    end
   end
 
   describe '#initialize' do
     it 'should exclude selected file patterns' do
-      wr = WatchRun.new(
+      wr = RubyWatchRun.new(
         filewatcher: Filewatcher.new(
           File.expand_path('test/tmp/**/*'),
           exclude: File.expand_path('test/tmp/**/*.txt')
@@ -27,7 +34,7 @@ describe Filewatcher do
     end
 
     it 'should handle absolute paths with globs' do
-      wr = WatchRun.new(
+      wr = RubyWatchRun.new(
         filewatcher: Filewatcher.new(
           File.expand_path('test/tmp/**/*')
         )
@@ -41,7 +48,7 @@ describe Filewatcher do
     end
 
     it 'should handle globs' do
-      wr = WatchRun.new(
+      wr = RubyWatchRun.new(
         filewatcher: Filewatcher.new('test/tmp/**/*')
       )
 
@@ -53,7 +60,7 @@ describe Filewatcher do
     end
 
     it 'should handle explicit relative paths with globs' do
-      wr = WatchRun.new(
+      wr = RubyWatchRun.new(
         filewatcher: Filewatcher.new('./test/tmp/**/*')
       )
 
@@ -65,7 +72,7 @@ describe Filewatcher do
     end
 
     it 'should handle explicit relative paths' do
-      wr = WatchRun.new(
+      wr = RubyWatchRun.new(
         filewatcher: Filewatcher.new('./test/tmp')
       )
 
@@ -79,7 +86,7 @@ describe Filewatcher do
     it 'should handle tilde expansion' do
       filename = File.expand_path('~/file_watcher_1.txt')
 
-      wr = WatchRun.new(
+      wr = RubyWatchRun.new(
         filename: filename,
         filewatcher: Filewatcher.new('~/file_watcher_1.txt')
       )
@@ -92,7 +99,7 @@ describe Filewatcher do
     end
 
     it 'should immediately run with corresponding option' do
-      wr = WatchRun.new(
+      wr = RubyWatchRun.new(
         filewatcher: Filewatcher.new('**/*', immediate: true)
       )
 
@@ -104,7 +111,7 @@ describe Filewatcher do
     end
 
     it 'should not be executed without immediate option and changes' do
-      wr = WatchRun.new(
+      wr = RubyWatchRun.new(
         filewatcher: Filewatcher.new('**/*', immediate: false)
       )
 
@@ -118,7 +125,7 @@ describe Filewatcher do
 
   describe '#watch' do
     it 'should detect file deletions' do
-      wr = WatchRun.new(action: :delete)
+      wr = RubyWatchRun.new(action: :delete)
 
       wr.run
 
@@ -128,7 +135,7 @@ describe Filewatcher do
     end
 
     it 'should detect file additions' do
-      wr = WatchRun.new(action: :create)
+      wr = RubyWatchRun.new(action: :create)
 
       wr.run
 
@@ -138,7 +145,7 @@ describe Filewatcher do
     end
 
     it 'should detect file updates' do
-      wr = WatchRun.new(action: :update)
+      wr = RubyWatchRun.new(action: :update)
 
       wr.run
 
@@ -150,7 +157,7 @@ describe Filewatcher do
     it 'should detect new files in subfolders' do
       FileUtils.mkdir_p subfolder = File.expand_path('test/tmp/new_sub_folder')
 
-      wr = WatchRun.new(
+      wr = RubyWatchRun.new(
         filename: File.join(subfolder, 'file.txt'),
         action: :create,
         every: true
@@ -167,7 +174,7 @@ describe Filewatcher do
     it 'should detect new subfolders' do
       subfolder = 'new_sub_folder'
 
-      wr = WatchRun.new(
+      wr = RubyWatchRun.new(
         filename: subfolder,
         directory: true,
         action: :create
@@ -183,7 +190,7 @@ describe Filewatcher do
 
   describe '#stop' do
     it 'should work' do
-      wr = WatchRun.new
+      wr = RubyWatchRun.new
 
       wr.start
 
@@ -196,7 +203,7 @@ describe Filewatcher do
 
   describe '#pause, #resume' do
     it 'should work' do
-      wr = WatchRun.new(action: :create, every: true)
+      wr = RubyWatchRun.new(action: :create, every: true)
 
       wr.start
 
@@ -230,7 +237,7 @@ describe Filewatcher do
 
   describe '#finalize' do
     it 'should process all remaining changes' do
-      wr = WatchRun.new(action: :create, every: true)
+      wr = RubyWatchRun.new(action: :create, every: true)
 
       wr.start
 
@@ -249,7 +256,7 @@ describe Filewatcher do
   end
 
   describe 'executable' do
-    tmp_dir = WatchRun::TMP_DIR
+    tmp_dir = ShellWatchRun::TMP_DIR
 
     it 'should run' do
       null_output = Gem.win_platform? ? 'NUL' : '/dev/null'
@@ -257,49 +264,77 @@ describe Filewatcher do
         .should.be.true
     end
 
-    it 'should set correct ENV variables' do
+    it 'should set correct ENV variables for file creation' do
+      filename = 'foo.txt'
+
       swr = ShellWatchRun.new(
+        filename: filename,
+        action: :create,
         dumper: :env
       )
 
       swr.run
 
-      File.read(swr.output)
+      File.read(ShellWatchRun::ENV_FILE)
         .should.equal(
           %W[
-            #{tmp_dir}/foo.txt
-            foo.txt
+            #{tmp_dir}/#{filename}
+            #{filename}
             created
             #{tmp_dir}
-            #{tmp_dir}/foo.txt
-            test/tmp/foo.txt
+            #{tmp_dir}/#{filename}
+            test/tmp/#{filename}
+          ].join(', ')
+        )
+    end
+
+    it 'should set correct ENV variables for file deletion' do
+      filename = 'foo.txt'
+
+      swr = ShellWatchRun.new(
+        filename: filename,
+        action: :delete,
+        dumper: :env
+      )
+
+      swr.run
+
+      File.read(ShellWatchRun::ENV_FILE)
+        .should.equal(
+          %W[
+            #{tmp_dir}/#{filename}
+            #{filename}
+            deleted
+            #{tmp_dir}
+            #{tmp_dir}/#{filename}
+            test/tmp/#{filename}
           ].join(', ')
         )
     end
 
     it 'should be executed immediately with corresponding option' do
       swr = ShellWatchRun.new(
-        options: '--immediate',
+        options: { immediate: true },
         dumper: :watched
       )
 
       swr.start
       swr.stop
 
-      File.exist?(swr.output).should.be.true
-      File.read(swr.output).should.equal 'watched'
+      File.exist?(ShellWatchRun::ENV_FILE).should.be.true
+      File.read(ShellWatchRun::ENV_FILE).should.equal 'watched'
     end
 
     it 'should not be executed without immediate option and changes' do
       swr = ShellWatchRun.new(
-        options: '',
+        options: {},
         dumper: :watched
       )
 
       swr.start
       swr.stop
 
-      File.exist?(swr.output).should.be.false
+      File.exist?(ShellWatchRun::ENV_FILE).should.be.false
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: filewatcher
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Thomas Flemming
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-11-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -45,19 +59,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: bacon
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.51'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.51'
 description: Detect changes in filesystem. Works anywhere.
 email:
 - thomas.flemming@gmail.com
@@ -100,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: Lighweight filewatcher.