file-tail 0.1.4 → 1.0.0

data/CHANGES

@@ -1,3 +1,13 @@
+2007-03-30 * 1.0.0 * Bugfix: David.Barzilay@swisscom.com reported, that file
+                     tails may skip some log file lines, after rotating it. I
+                     think, І fixed that problem.
+                     I added a after_reopen callback as well, that is called
+                     after reopening of the tailed file has occured.
+                   * Removed rewind/wind methods even earlier than planned: I
+                     placed the deprecation warning for rewind method in File
+                     instead of File::Tail, which caused rewind to stop working
+                     completely after loading file/tail. Duh! I blame vim's
+                     matchit, because it jumped to the wrong end keyword.
 2007-02-08 * 0.1.4 * Renamed rewind method to backward, and wind method to
                      forward, because someone already had the good idea to name
                      a method IO#rewind, which was overwritten by the mixed in

data/Rakefile

@@ -36,45 +36,19 @@ task :clean do
 end
 
 spec = Gem::Specification.new do |s|
-
-  #### Basic information.
-
   s.name = 'file-tail'
   s.version = PKG_VERSION
   s.summary = "File::Tail for Ruby"
   s.description = "Library to tail files in Ruby"
 
-  #### Dependencies and requirements.
-
-  #s.add_dependency('log4r', '> 1.0.4')
-  #s.requirements << ""
-
   s.files = PKG_FILES
 
-  #### C code extensions.
-
-  #s.extensions << "ext/extconf.rb"
-
-  #### Load-time details: library and application (you will need one or both).
-
-  s.require_path = 'lib'                         # Use these for libraries.
-  #s.autorequire = 'file/tail'
-
-  #s.bindir = "bin"                              # Use these for applications.
-  #s.executables = ["bla.rb"]
-  #s.default_executable = "bla.rb"
-
-  #### Documentation and testing.
+  s.require_path = 'lib'
 
   s.has_rdoc = true
-  #s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
-  s.rdoc_options <<
-    '--title' <<  'File::Tail' <<
-  #  '--line-numbers'
+  s.rdoc_options << '--title' <<  'File::Tail' << '--line-numbers'
   s.test_files << 'tests/test_file-tail.rb'
 
-  #### Author and project details.
-
   s.author = "Florian Frank"
   s.email = "flori@ping.de"
   s.homepage = "http://file-tail.rubyforge.org"
@@ -86,4 +60,23 @@ Rake::GemPackageTask.new(spec) do |pkg|
   pkg.package_files += PKG_FILES
 end
 
+desc m = "Writing version information for #{PKG_VERSION}"
+task :version do
+  puts m
+  File.open(File.join('lib', 'file', 'tail', 'version.rb'), 'w') do |v|
+    v.puts <<EOT
+class File
+  module Tail
+    # File::Tail version
+    VERSION         = '#{PKG_VERSION}'
+    VERSION_ARRAY   = VERSION.split(/\\./).map { |x| x.to_i } # :nodoc:
+    VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
+    VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
+    VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
+  end
+end
+EOT
+  end
+end
+
 task :release => [ :clean, :package ]

data/VERSION

@@ -1 +1 @@
-0.1.4
+1.0.0

data/install.rb

@@ -8,12 +8,15 @@ include Config
 
 cd 'lib' do
   libdir = CONFIG["sitelibdir"]
-  subdir = 'file'
-  filename = 'tail.rb'
 
-  dest = File.join(libdir, subdir)
+  dest = File.join(libdir, 'file')
   mkdir_p(dest)
-  file = File.join('file', filename)
+  file = File.join('file', 'tail.rb')
+  install(file, dest)
+
+  dest = File.join(dest, 'tail')
+  mkdir_p(dest)
+  file = File.join('file', 'tail', 'version.rb')
   install(file, dest)
 end
   # vim: set et sw=2 ts=2:

data/lib/file/tail.rb

@@ -1,4 +1,5 @@
 #
+require 'file/tail/version'
 # = File::Tail - Tailing files in Ruby
 #
 # == Description
@@ -92,8 +93,11 @@ class File
       # in the logfile for 10 lines at the start. The buffersize
       # for going backwards can be set with the
       # * <code>:bufsiz => 8192</code> option.
-      # Every attribute of File::Tail can be set with a
-      # <code>:attributename => value</code> option.
+      # To define a callback, that will be called after a reopening occurs, use:
+      # * <code>:after_reopen => lambda { |file| p file }</code>
+      #
+      # Every attribute of File::Tail can be set with a <code>:attributename =>
+      # value</code> option.
       def self.open(filename, opts = {}) # :yields: file
         file = new filename
         opts.each do |o, v|
@@ -111,6 +115,9 @@ class File
         elsif forward = opts[:forward] || opts[:wind]
           file.forward(forward)
         end
+        if opts[:after_reopen]
+          file.after_reopen &opts[:after_reopen]
+        end
         if block_given?
           yield file
           nil
@@ -187,6 +194,13 @@ class File
     # <code>suspicious_interval</code> seconds of silence.
     attr_accessor :reopen_suspicious
 
+    # The callback is called with _self_ as an argument after a reopen has
+    # occured. This allows a tailing script to find out, if a logfile has been
+    # rotated.
+    def after_reopen(&block)
+      @after_reopen = block
+    end
+
     # This attribute is the invterval in seconds before File::Tail
     # gets suspicious that something has happend to it's tailed file
     # and an attempt to reopen it is made.
@@ -215,12 +229,6 @@ class File
       self
     end
 
-    # The wind method is deprecated, use forward instead.
-    def wind(*args)
-      warn "File::Tail#wind method is deprecated, use forward instead"
-      forward *args
-    end
-
     # Rewind the last <code>n</code> lines of this file, starting
     # from the end. The default is to start tailing directly from the
     # end of the file.
@@ -279,6 +287,7 @@ class File
     # call doesn't return, but yields to block for every new line read from
     # this file for ever.
     def tail(n = nil, &block) # :yields: line
+      @n = n
       result = []
       array_result = false
       unless block
@@ -289,10 +298,15 @@ class File
       loop do
         begin
           restat
-          read_line(n, &block)
+          read_line(&block)
           redo
         rescue ReopenException => e
+          until eof? || @n == 0
+            block.call readline
+            @n -= 1 if @n
+          end
           reopen_file(e.mode)
+          @after_reopen.call self if @after_reopen
         rescue ReturnException
           return array_result ? result : nil
         end
@@ -301,12 +315,13 @@ class File
     
     private
 
-    def read_line(n)
-      if n
-        n.times do
+    def read_line
+      if @n
+        until @n == 0
           yield readline
           @lines += 1
           @no_read = 0
+          @n -= 1
           debug
         end
         raise ReturnException
@@ -323,8 +338,7 @@ class File
       raise BreakException if @break_if_eof
       raise ReturnException if @return_if_eof
       sleep_interval
-    rescue Errno::ENOENT
-    rescue Errno::ESTALE
+    rescue Errno::ENOENT, Errno::ESTALE
       raise ReopenException
     end
 
@@ -354,8 +368,7 @@ class File
       else
         @stat = stat
       end
-    rescue Errno::ENOENT
-    rescue Errno::ESTALE
+    rescue Errno::ENOENT, Errno::ESTALE
       raise ReopenException
     end
 
@@ -384,8 +397,7 @@ class File
       if mode == :bottom
         backward
       end
-    rescue Errno::ESTALE
-    rescue Errno::ENOENT
+    rescue Errno::ESTALE, Errno::ENOENT
       if @reopen_deleted    
         sleep @max_interval
         retry
@@ -400,20 +412,11 @@ class File
         :lines    => @lines,
         :interval => @interval,
         :no_read  => @no_read,
+        :n        => @n,
       }
       $stderr.print h.inspect, "\n"
     end
   end
-
-  # The rewind method is deprecated and will be removed soon, use backward
-  # instead. At the moment rewind accidentially overwrites the IO#rewind
-  # method, after the removal of the ol rewind mixin method, this will be no
-  # longer the case.
-  def rewind(*args)
-    warn "File::Tail#rewind method is deprecated and will be removed soon, "\
-      "use backward instead"
-    backward *args
-  end
 end
 
 if $0 == __FILE__

data/lib/file/tail/version.rb

@@ -0,0 +1,10 @@
+class File
+  module Tail
+    # File::Tail version
+    VERSION         = '0.1.5'
+    VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
+    VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
+    VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
+    VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
+  end
+end

data/tests/test_file-tail.rb

@@ -176,6 +176,8 @@ class TC_FileTail < Test::Unit::TestCase
   def test_tail_remove
 		return if File::PATH_SEPARATOR == ';' # Grmpf! Windows...
     @in.backward
+		reopened = false
+		@in.after_reopen { |f| reopened = true }
     lines = []
     threads = []
     threads << appender = Thread.new do
@@ -198,6 +200,77 @@ class TC_FileTail < Test::Unit::TestCase
     end
     threads.collect { |t| t.wakeup and t.join }
     assert_equal(10, lines.size)
+		assert reopened
+  end
+
+  def test_tail_remove2
+		return if File::PATH_SEPARATOR == ';' # Grmpf! Windows...
+    @in.backward
+		reopened = false
+		@in.after_reopen { |f| reopened = true }
+    lines = []
+    threads = []
+    threads << appender = Thread.new do
+      Thread.stop
+      @out.close
+      File.unlink(@out.path)
+      @out = File.new(@in.path, "wb")
+      append(@out, 10)
+			sleep 1
+      append(@out, 10)
+      File.unlink(@out.path)
+      @out = File.new(@in.path, "wb")
+      append(@out, 10)
+    end
+    threads << Thread.new do
+      begin
+        timeout(2) do
+          @in.tail do |l|
+            lines << l
+            lines.size == 100 and appender.wakeup
+          end
+        end
+      rescue TimeoutError
+      end
+    end
+    threads.collect { |t| t.wakeup and t.join }
+    assert_equal(30, lines.size)
+		assert reopened
+  end
+
+  def test_tail_remove3
+		return if File::PATH_SEPARATOR == ';' # Grmpf! Windows...
+    @in.backward
+		reopened = false
+		@in.after_reopen { |f| reopened = true }
+    lines = []
+    threads = []
+    threads << appender = Thread.new do
+      Thread.stop
+      @out.close
+      File.unlink(@out.path)
+      @out = File.new(@in.path, "wb")
+      append(@out, 10)
+			sleep 1
+      append(@out, 10)
+      File.unlink(@out.path)
+      @out = File.new(@in.path, "wb")
+      append(@out, 10)
+    end
+    threads << Thread.new do
+      begin
+        timeout(2) do
+          @in.tail(15) do |l|
+            lines << l
+            lines.size == 100 and appender.wakeup
+          end
+        end
+      rescue TimeoutError
+      end
+    end
+    threads.collect { |t| t.wakeup and t.join }
+    assert_equal(15, lines.size)
+		assert reopened
   end
 
   def teardown

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.2
 specification_version: 1
 name: file-tail
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
-date: 2007-02-08 00:00:00 +01:00
+  version: 1.0.0
+date: 2007-04-01 00:00:00 +02:00
 summary: File::Tail for Ruby
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - Florian Frank
 files: 
@@ -41,14 +42,15 @@ files:
 - examples/pager.rb
 - examples/tail.rb
 - lib/file
+- lib/file/tail
 - lib/file/tail.rb
-test_files: &id001 []
-
+- lib/file/tail/version.rb
+test_files: 
+- tests/test_file-tail.rb
 rdoc_options: 
 - --title
 - File::Tail
-- *id001
-- tests/test_file-tail.rb
+- --line-numbers
 extra_rdoc_files: []
 
 executables: []