notified_tail 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in notified_tail.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Peter Winton
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,14 @@
+# NotifiedTail
+
+`tail -f` for ruby using inotify/kqueue to avoid polling. Polling adds
+latency and overhead. Falls back to polling on platforms where neither
+inotify nor kqueue are supported.
+
+Inspired by http://rubyforadmins.com/reading-growing-files
+
+```ruby
+require 'notified_tail'
+NotifiedTail.tail(file_path, seek_end: true) do |line|
+  puts line
+end
+```

data/Rakefile

@@ -0,0 +1,9 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/notified_tail.rb

@@ -0,0 +1,82 @@
+# Tail lines in a given file
+# Inspired by http://rubyforadmins.com/reading-growing-files
+class NotifiedTail
+
+  # Yields complete lines, one at a time.
+  # Works even if file doesn't exist yet.
+  # @param file_path [String] The file to tail
+  # @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.
+  def self.tail(file_path, opts={}, &on_line)
+    new.tail(file_path, opts, &on_line)
+  end
+
+  def tail(filename, opts, &on_line)
+    @stopped = false
+    seek_end = opts.fetch(:seek_end, true)
+    sleep(0.25) until File.exists?(filename)
+    File.open(filename) 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) }
+    end
+  end
+
+  def stop
+    @queue.stop if @queue
+    @queue = nil
+    @stopped = true
+  end
+
+  private
+
+  def read_and_report_lines(file, unreported_line, &on_line)
+    loop do
+      c = file.readchar
+      if line_ending?(c)
+        on_line.call(unreported_line.dup)
+        unreported_line.clear
+        while (c = file.readchar) && line_ending?(c) do; end
+      end
+      unreported_line << c
+    end
+  rescue EOFError
+    # 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
+    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
+        last_mtime = mtime
+      end
+    end
+  end
+
+  def self.get_ruby_platform
+    RUBY_PLATFORM
+  end
+
+  def line_ending?(c)
+    c == "\n" || c == "\r"
+  end
+end

data/notified_tail.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'notified_tail'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Peter Winton']
+  spec.email         = ['pwinton@indigobio.com']
+  spec.summary       = %q{Low latency file tailing in ruby}
+  spec.description   = %q{Uses inotify/kqueue on supported platforms to avoid polling latency and overhead}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+
+  spec.add_runtime_dependency 'rb-inotify'
+  spec.add_runtime_dependency 'rb-kqueue'
+end

data/spec/lib/notified_tail_spec.rb

@@ -0,0 +1,70 @@
+require 'rspec'
+require 'securerandom'
+require 'notified_tail'
+
+describe NotifiedTail do
+  describe '#tail' do
+
+    shared_examples 'tail -f' do
+      let!(:lines) { [] }
+      let!(:fn) { SecureRandom.uuid }
+      after(:each) { File.delete(fn) }
+
+      it 'tails a growing file, line by line' do
+
+        append(fn, "before\ntailing\n")
+
+        watcher = Thread.start do
+          notifier = NotifiedTail.new
+          notifier.tail(fn, seek_end: seek_end) do |line|
+            puts "saw #{line.inspect}"
+            expect(line).to eql expected.first
+            expected.shift
+            notifier.stop if expected.empty?
+          end
+        end
+        sleep(0.25) # let the notifier start up
+
+        append(fn, "one\n")
+        append(fn, "two\nthree\n")
+        append(fn, "gr")
+        append(fn, "ow")
+        append(fn, "ing\nlonger\n")
+        append(fn, "line with words\n")
+        watcher.join
+      end
+
+      def append(fn, text)
+        File.open(fn, 'a') { |f| f.print(text) }
+        sleep(0.1)
+      end
+    end
+
+    shared_examples 'tail -f -n 9999PB' do
+      let!(:expected) { ['before', 'tailing', 'one', 'two', 'three', 'growing', 'longer', 'line with words'] }
+      it_behaves_like 'tail -f'
+    end
+
+    shared_examples 'tail -f -n 0' do
+      let!(:expected) { ['one', 'two', 'three', 'growing', 'longer', 'line with words'] }
+      it_behaves_like 'tail -f'
+    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
+
+    context 'when seeking to the end' do
+      let!(:seek_end) { true }
+      it_behaves_like 'tail -f -n 0'
+    end
+
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: notified_tail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Winton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-kqueue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses inotify/kqueue on supported platforms to avoid polling latency and
+  overhead
+email:
+- pwinton@indigobio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/notified_tail.rb
+- notified_tail.gemspec
+- spec/lib/notified_tail_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Low latency file tailing in ruby
+test_files:
+- spec/lib/notified_tail_spec.rb
+has_rdoc: