notified_tail 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a2903e3cddd8da5107080ea930b4b410f4d7183
-  data.tar.gz: 926996d000172e71d502019a646dc64b15171326
+  metadata.gz: fa437427fdd1f03240d821e5f1a54aab0b6355b0
+  data.tar.gz: aee28adbc8cc8fded7ec0d43814e5d85166b18f4
 SHA512:
-  metadata.gz: 4a61d2ae2fdc622ba708f51f9137882d5091701b21a1135eef380674eb525aacd03b1e6240adbb5aac89ba7b42a015fe355a36d33744772d54b6b39368bcb59d
-  data.tar.gz: 05a6a3d10b602fbf805f7dee69dab70d7065d58a0116bc4d46f200352601382dfd8869939173df5f97da2cc4b5f26cd8be00d01113de7007934cd597bd3923a0
+  metadata.gz: c5307f2e8fbe14b24a20026e3481fce94ec7b47003a4214faf75717b554b54bc2e081461cebf18db9f5eea920588f3beb22b0d6cb92de1b5909531b9ed077295
+  data.tar.gz: d73efb21eb53a20db71335a63580c0dc7526f440a056affd99979b35c4c01e3baea805549af4a5a2e97e6d81e4b2031230633ab159b326224953c0b3917b4994

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 .idea
+*.gem

data/lib/notified_tail.rb

@@ -8,22 +8,25 @@ class NotifiedTail
   # @option opts [Boolean] seek_end (true)
   #   If true, seeks to the end of the file before reporting lines.
   #   Otherwise, reports all lines starting at the beginning of the file.
+  # @option opts [Boolean] force_poll (false)
+  #   Poll even if inotify or kqueue are available
   def self.tail(file_path, opts={}, &on_line)
     new.tail(file_path, opts, &on_line)
   end
 
-  def tail(filename, opts, &on_line)
+  def tail(file_path, opts, &on_line)
     @stopped = false
     seek_end = opts.fetch(:seek_end, true)
-    sleep(0.25) until File.exists?(filename)
-    File.open(filename) do |file|
+    @force_poll = opts.fetch(:force_poll, false)
+    sleep(0.25) until File.exists?(file_path)
+    File.open(file_path) do |file|
       unreported_line = ''
       if seek_end
         file.seek(0, IO::SEEK_END)
       else
         read_and_report_lines(file, unreported_line, &on_line)
       end
-      when_modified(filename) { read_and_report_lines(file, unreported_line, &on_line) }
+      when_modified(file_path) { read_and_report_lines(file, unreported_line, &on_line) }
     end
   end
 
@@ -49,25 +52,38 @@ class NotifiedTail
     # done for now
   end
 
-  def when_modified(file_path)
-    case NotifiedTail.get_ruby_platform
-    when /bsd/, /darwin/
-      require 'rb-kqueue'
-      @queue = KQueue::Queue.new
-      @queue.watch_file(ARGV.first, :extend) { yield }
-      @queue.run
-    when /linux/
-      require 'rb-inotify'
-      @queue = INotify::Notifier.new
-      @queue.watch(file_path, :modify) { yield }
-      @queue.run
+  def when_modified(file_path, &block)
+    if @force_poll
+      poll(file_path, &block)
     else
-      last_mtime = File.mtime(file_path)
-      until @stopped do
-        sleep(0.5)
-        mtime = File.mtime(file_path)
-        yield if mtime != last_mtime # use != instead of > to mitigate DST complications
+      case NotifiedTail.get_ruby_platform
+      when /bsd/, /darwin/
+        require 'rb-kqueue'
+        @queue = KQueue::Queue.new
+        @queue.watch_file(file_path, :extend) { block.call }
+        @queue.run
+      when /linux/
+        require 'rb-inotify'
+        @queue = INotify::Notifier.new
+        @queue.watch(file_path, :modify) { block.call }
+        @queue.run
+      else
+        poll(file_path, &block)
+      end
+    end
+  end
+
+  def poll(file_path, &block)
+    last_mtime = File.mtime(file_path)
+    last_notify_time = nil
+    until @stopped do
+      sleep(0.5)
+      mtime = File.mtime(file_path)
+      changed = mtime != last_mtime
+      if changed || last_notify_time == nil || (Time.now - last_notify_time) > 5
         last_mtime = mtime
+        last_notify_time = Time.now
+        block.call
       end
     end
   end

data/notified_tail.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'notified_tail'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Peter Winton']
   spec.email         = ['pwinton@indigobio.com']
   spec.summary       = %q{Low latency file tailing in ruby}

data/spec/lib/notified_tail_spec.rb

@@ -4,6 +4,8 @@ require 'notified_tail'
 
 describe NotifiedTail do
   describe '#tail' do
+    let!(:seek_end) { false }
+    let!(:force_poll) { false }
 
     shared_examples 'tail -f' do
       let!(:lines) { [] }
@@ -16,7 +18,7 @@ describe NotifiedTail do
 
         watcher = Thread.start do
           notifier = NotifiedTail.new
-          notifier.tail(fn, seek_end: seek_end) do |line|
+          notifier.tail(fn, seek_end: seek_end, force_poll: force_poll) do |line|
             puts "saw #{line.inspect}"
             expect(line).to eql expected.first
             expected.shift
@@ -51,13 +53,11 @@ describe NotifiedTail do
     end
 
     context 'when not seeking to the end' do
-      let!(:seek_end) { false }
       it_behaves_like 'tail -f -n 9999PB'
     end
 
     context 'when the platform does not support notifications' do
       before(:each) { allow(NotifiedTail).to receive(:get_ruby_platform).and_return('wha??') }
-      let!(:seek_end) { false }
       it_behaves_like 'tail -f -n 9999PB'
     end
 
@@ -66,5 +66,14 @@ describe NotifiedTail do
       it_behaves_like 'tail -f -n 0'
     end
 
+    context 'when forcing polling' do
+      let!(:force_poll) { true }
+      before(:each) do
+        expect(INotify::Notifier).to_not receive(:new) if defined?(INotify::Notifier)
+        expect(KQueue::Queue).to_not receive(:new) if defined?(KQueue::Queue)
+      end
+      it_behaves_like 'tail -f -n 9999PB'
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notified_tail
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Winton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler