file-tail 0.1.3 → 0.1.4

data/CHANGES

@@ -1,3 +1,9 @@
+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
+                     File::Tail methods. The old methods are now deprecated and
+                     will be removed in a new 0.2.x version of the library.
+                   * Added a bit more of documentation.
 2005-08-20 * 0.1.3 * Applied LOAD_PATH  patch by Daniel Berger, binary mode
                      changes were already in the CVS. Seemed to be like cheating
                      to me, though. ;)

data/README.en

@@ -3,6 +3,10 @@ Installation
 
 Just type into the command line as root:
 
+# rake install
+
+or
+
 # ruby install.rb
 
 Documentation
@@ -10,6 +14,10 @@ Documentation
 
 To create the documentation of this module, type
 
+$ rake doc
+
+or
+
 $ ruby make_doc.rb
 
 and the API documentation is generated by your rdoc command.
@@ -26,5 +34,5 @@ Florian Frank <flori@ping.de>
 License
 =======
 
-GNU General Public License (GPL)
+GNU General Public License (GPL), Version 2
 

data/Rakefile

@@ -1,4 +1,4 @@
-# Rakefile for File::Tail  -*- ruby -*-
+# vim: set filetype=ruby et sw=2 ts=2:
 
 require 'rake/gempackagetask'
 require 'rbconfig'
@@ -7,20 +7,32 @@ include Config
 
 PKG_NAME = 'file-tail'
 PKG_VERSION = File.read('VERSION').chomp
-PKG_FILES = Dir.glob("**/*").delete_if { |item|
-  item.include?("CVS") or item.include?("pkg")
-}
+PKG_FILES = FileList["**/*"].exclude(/pkg|coverage|doc/)
 
 desc "Installing library"
 task :install  do
-  libdir = CONFIG["sitelibdir"]
-  dest = File.join(libdir, 'file')
-  install('lib/file/tail.rb', dest)
+  ruby 'install.rb'
+end
+
+desc "Creating documentation"
+task :doc do
+  ruby 'make_doc.rb'
 end
 
 desc "Testing library"
 task :test  do
-  ruby %{-Ilib tests/test.rb}
+  ruby %{-Ilib tests/test_file-tail.rb}
+end
+
+desc "Testing library with rcov"
+task :coverage  do
+  system %{rcov -x '\\btests\/' -Ilib tests/test_file-tail.rb}
+end
+
+desc "Removing generated files"
+task :clean do
+  rm_rf 'doc'
+  rm_rf 'coverage'
 end
 
 spec = Gem::Specification.new do |s|
@@ -30,7 +42,7 @@ spec = Gem::Specification.new do |s|
   s.name = 'file-tail'
   s.version = PKG_VERSION
   s.summary = "File::Tail for Ruby"
-  s.description = ""
+  s.description = "Library to tail files in Ruby"
 
   #### Dependencies and requirements.
 
@@ -46,7 +58,7 @@ spec = Gem::Specification.new do |s|
   #### 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.autorequire = 'file/tail'
 
   #s.bindir = "bin"                              # Use these for applications.
   #s.executables = ["bla.rb"]
@@ -56,11 +68,10 @@ spec = Gem::Specification.new do |s|
 
   s.has_rdoc = true
   #s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
-  #s.rdoc_options <<
-  #  '--title' <<  'Rake -- Ruby Make' <<
-  #  '--main' << 'README' <<
+  s.rdoc_options <<
+    '--title' <<  'File::Tail' <<
   #  '--line-numbers'
-  s.test_files << 'tests/test.rb'
+  s.test_files << 'tests/test_file-tail.rb'
 
   #### Author and project details.
 
@@ -74,4 +85,5 @@ Rake::GemPackageTask.new(spec) do |pkg|
   pkg.need_tar = true
   pkg.package_files += PKG_FILES
 end
-  # vim: set et sw=2 ts=2:
+
+task :release => [ :clean, :package ]

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/examples/pager.rb

@@ -1,18 +1,19 @@
 #!/usr/bin/env ruby
+# vim: set et sw=2 ts=2:
 # A poor man's pager... :)
 
 require 'file/tail'
 
 filename = ARGV.shift or fail "Usage: #$0 filename [height]"
-height = (ARGV.shift || 24).to_i - 1
+height = (ARGV.shift || ENV['LINES'] || 23).to_i - 1
+p height
 
 File::Tail::Logfile.open(filename, :break_if_eof => true) do |log|
-	begin
-		log.tail(height) { |line| puts line }
-		print "Press return key to continue!" ; gets
-		print ""
-		redo
-	rescue File::Tail::BreakException
-	end
+  begin
+    log.tail(height) { |line| puts line }
+    print "Press return key to continue!" ; gets
+    print ""
+    redo
+  rescue File::Tail::BreakException
+  end
 end
-	# vim: set noet sw=4 ts=4:

data/examples/tail.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# vim: set et sw=2 ts=2:
 
 require 'file/tail'
 
@@ -6,6 +7,5 @@ filename = ARGV.pop or fail "Usage: #$0 number filename"
 number = (ARGV.pop || 0).to_i.abs
 
 File::Tail::Logfile.open(filename) do |log|
-	log.rewind(number).tail { |line| puts line }
+  log.backward(number).tail { |line| puts line }
 end
-	# vim: set noet sw=4 ts=4:

data/lib/file/tail.rb

@@ -1,45 +1,79 @@
+#
+# = File::Tail - Tailing files in Ruby
+#
+# == Description
+#
+# This is a small ruby library that allows it to "tail" files in Ruby,
+# including following a file, that still is growing like the unix command 'tail
+# -f' can.
+#
+# == Author
+#
+# Florian Frank mailto:flori@ping.de
+#
+# == License
+#
+# This is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License Version 2 as published by
+# the Free Software Foundation: http://www.gnu.org/copyleft/gpl.html
+#
+# == Download
+#
+# The latest version of <b>File::Tail</b> (file-tail) can be found at
+#
+# http://rubyforge.org/frs/?group_id=393
+#
+# Online Documentation should be located at
+#
+# http://file-tail.rubyforge.org
+#
+# == Usage
+#
 # File::Tail is a module in the File class. A lightweight class interface for
 # logfiles can be seen under File::Tail::Logfile.
+#
+# Direct extension of File objects with File::Tail works like that:
+#  File.open(filename) do |log|
+#    log.extend(File::Tail)
+#    log.interval = 10
+#    log.backward(10)
+#    log.tail { |line| puts line }
+#  end
+#
+# It's also possible to mix File::Tail in your own File classes
+# (see also File::Tail::Logfile):
+#  class MyFile < File
+#    include File::Tail
+#  end
+#  log = MyFile.new("myfile")
+#  log.interval = 10
+#  log.backward(10)
+#  log.tail { |line| print line }
+#
+# The forward/backward method returns self, so it's possible to chain
+# methods together like that:
+#  log.backward(10).tail { |line| puts line }
+#
 class File
-
   # The File::Tail module can be included in File objects and mixes in
-  # the wind, rewind and tail methods.
-  #
-  # === Usage
-  # Direct extension of File objects works like that:
-  #  File.open(filename) do |log|
-  #    log.extend(File::Tail)
-  #    log.interval = 10
-  #    log.rewind(10)
-  #    log.tail { |line| puts line }
-  # end
-  #
-  # It's also possible to mix File::Tail in your own File classes
-  # (see also File::Tail::Logfile):
-  #  class MyFile < File
-  #    include File::Tail
-  #  end
-  #  log = MyFile.new("myfile")
-  #  log.interval = 10
-  #  log.rewind(10)
-  #  log.tail { |line| print line }
-  #
-  # The wind/rewind method returns self, so it's possible to chain
-  # methods together like that:
-  #  log.rewind(10).tail { |line| puts line }
+  # the forward, backward and tail methods.
   module Tail
-
     # This is an easy to use Logfile class that includes
     # the File::Tail module.
     #
     # === Usage
     # The unix command "tail -10f filename" can be emulated like that:
-    #  File::Tail::Logfile.open(filename, :rewind => 10) do |log|
+    #  File::Tail::Logfile.open(filename, :backward => 10) do |log|
     #    log.tail { |line| puts line }
     #  end
     #
+    # Or a bit shorter:
+    #  File::Tail::Logfile.tail(filename, :backward => 10) do |line|
+    #    puts line
+    #  end
+    #
     # To skip the first 10 lines of the file do that:
-    #  File::Tail::Logfile.open(filename, :wind => 10) do |log|
+    #  File::Tail::Logfile.open(filename, :forward => 10) do |log|
     #    log.tail { |line| puts line }
     #  end
     #
@@ -48,31 +82,34 @@ class File
     #    log.tail(10) { |line| puts line }
     #  end
     class Logfile < File
-    
       include File::Tail
 
       # This method creates an File::Tail::Logfile object and
       # yields to it if a block is given, otherwise it just
       # returns it. The opts hash takes an option like
-      # <code>:rewind => 10</code> to rewind
-      # <code>:wind => 10</code> to wind
-      # the logfile for 10 lines at the start. The buffersize
-      # for rewind can be set with the
-      # <code>:bufsiz => 8192</code> option.
+      # * <code>:backward => 10</code> to go backwards
+      # * <code>:forward => 10</code> to go forwards
+      # 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.
-      def Logfile.open(filename, opts = {}) # :yields: file
+      def self.open(filename, opts = {}) # :yields: file
         file = new filename
         opts.each do |o, v|
           writer = o.to_s + "=" 
           file.__send__(writer, v) if file.respond_to? writer
         end
-        if opts[:rewind]
-          (args = []) << opts[:rewind]
+        if opts.key?(:wind) or opts.key?(:rewind)
+          warn ":wind and :rewind options are deprecated, "\
+            "use :forward and :backward instead!"
+        end
+        if backward = opts[:backward] || opts[:rewind]
+          (args = []) << backward
           args << opt[:bufsiz] if opts[:bufsiz]
-          file.rewind(*args)
-        elsif opts[:wind]
-          file.wind(opts[:wind])
+          file.backward(*args)
+        elsif forward = opts[:forward] || opts[:wind]
+          file.forward(forward)
         end
         if block_given?
           yield file
@@ -81,7 +118,16 @@ class File
           file
         end
       end
-      
+
+      # Like open, but yields to every new line encountered in the logfile.
+      def self.tail(filename, opts = {})
+        if ([ :forward, :backward ] & opts.keys).empty?
+          opts[:backward] = 0
+        end
+        open(filename, opts) do |log|
+          log.tail { |line| yield line }
+        end
+      end
     end
 
     # This is the base class of all exceptions that are raised
@@ -106,7 +152,6 @@ class File
     # the tailed file, e. g., it was rotated away. The exception
     # is caught and an attempt to reopen it is made.
     class ReopenException < TailException
-  
       attr_reader :mode
     
       # Creates an ReopenException object. The mode defaults to
@@ -118,7 +163,6 @@ class File
         super(self.class.name)
         @mode = mode
       end
-
     end
 
     # The maximum interval File::Tail sleeps, before it tries
@@ -160,9 +204,9 @@ class File
     # just returns if the end of the file is reached.
     attr_accessor :return_if_eof
 
-    # Skip the first <code>n</code> lines of this file. The default is to
-    # don't skip any lines at all and start at the beginning of this file.
-    def wind(n = 0)
+    # Skip the first <code>n</code> lines of this file. The default is to don't
+    # skip any lines at all and start at the beginning of this file.
+    def forward(n = 0)
       seek(0, File::SEEK_SET)
       while n > 0 and not eof?
         readline
@@ -171,6 +215,12 @@ 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.
@@ -180,7 +230,7 @@ class File
     # the file backwards. It defaults to the block size of the 
     # filesystem this file belongs to or 8192 bytes if this cannot
     # be determined.
-    def rewind(n = 0, bufsiz = nil)
+    def backward(n = 0, bufsiz = nil)
       if n <= 0
         seek(0, File::SEEK_END)
         return self
@@ -332,7 +382,7 @@ class File
       @no_read = 0
       reopen(path)
       if mode == :bottom
-        rewind
+        backward
       end
     rescue Errno::ESTALE
     rescue Errno::ENOENT
@@ -353,9 +403,17 @@ class File
       }
       $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__
@@ -369,7 +427,7 @@ if $0 == __FILE__
     log.reopen_deleted      = true # is default
     log.reopen_suspicious   = true # is default
     log.suspicious_interval = 20
-    number >= 0 ? log.rewind(number, 8192) : log.wind(-number)
+    number >= 0 ? log.backward(number, 8192) : log.forward(-number)
     #loop do          # grab 5 lines at a time and return
     #  log.tail(5) { |line| puts line }
     #  print "Got 5!\n"
@@ -377,4 +435,4 @@ if $0 == __FILE__
     log.tail { |line| puts line }
   end
 end
-  # vim: set et sw=2 ts=2:
+# vim: set et sw=2 ts=2:

data/tests/{test.rb → test_file-tail.rb}

@@ -14,7 +14,6 @@ require 'thread'
 Thread.abort_on_exception = true
 
 class TC_FileTail < Test::Unit::TestCase
-
   include File::Tail
 
   def setup
@@ -29,49 +28,49 @@ class TC_FileTail < Test::Unit::TestCase
     @in.suspicious_interval  = 60
   end
 
-  def test_wind
+  def test_forward
     [ 0, 1, 2, 10, 100 ].each do |lines|
-      @in.wind(lines)
+      @in.forward(lines)
       assert_equal(100 - lines, count(@in))
     end
-    @in.wind(101)
+    @in.forward(101)
     assert_equal(0, count(@in))
   end
 
-  def test_rewind
+  def test_backward
     [ 0, 1, 2, 10, 100 ].each do |lines|
-      @in.rewind(lines)
+      @in.backward(lines)
       assert_equal(lines, count(@in))
     end
-    @in.rewind(101)
+    @in.backward(101)
     assert_equal(100, count(@in))
   end
 
   def test_tail_with_block_without_n
     timeout(10) do
       lines = []
-      @in.rewind(1)
+      @in.backward(1)
       assert_raises(TimeoutError) do
         timeout(1) { @in.tail { |l| lines << l } }
       end
       assert_equal(1, lines.size)
       #
       lines = []
-      @in.rewind(10)
+      @in.backward(10)
       assert_raises(TimeoutError) do
         timeout(1) { @in.tail { |l| lines << l } }
       end
       assert_equal(10, lines.size)
       #
       lines = []
-      @in.rewind(100)
+      @in.backward(100)
       assert_raises(TimeoutError) do
         timeout(1) { @in.tail { |l| lines << l } }
       end
       assert_equal(100, lines.size)
       #
       lines = []
-      @in.rewind(101)
+      @in.backward(101)
       assert_raises(TimeoutError) do
         timeout(1) { @in.tail { |l| lines << l } }
       end
@@ -80,24 +79,24 @@ class TC_FileTail < Test::Unit::TestCase
 
   def test_tail_with_block_with_n
     timeout(10) do
-      @in.rewind(1)
+      @in.backward(1)
       lines = []
       timeout(1) { @in.tail(0) { |l| lines << l } }
       assert_equal(0, lines.size)
       #
-      @in.rewind(1)
+      @in.backward(1)
       lines = []
       timeout(1) { @in.tail(1) { |l| lines << l } }
       assert_equal(1, lines.size)
       #
-      @in.rewind(10)
+      @in.backward(10)
       lines = []
       timeout(1) { @in.tail(10) { |l| lines << l } }
       assert_equal(10, lines.size)
       #
-      @in.rewind(100)
+      @in.backward(100)
       lines = []
-      @in.rewind(1)
+      @in.backward(1)
       assert_raises(TimeoutError) do
         timeout(1) { @in.tail(2) { |l| lines << l } }
       end
@@ -108,24 +107,24 @@ class TC_FileTail < Test::Unit::TestCase
 
   def test_tail_without_block_with_n
     timeout(10) do
-      @in.rewind(1)
+      @in.backward(1)
       lines = []
       timeout(1) { lines += @in.tail(0) }
       assert_equal(0, lines.size)
       #
-      @in.rewind(1)
+      @in.backward(1)
       lines = []
       timeout(1) { lines += @in.tail(1) }
       assert_equal(1, lines.size)
       #
-      @in.rewind(10)
+      @in.backward(10)
       lines = []
       timeout(1) { lines += @in.tail(10) }
       assert_equal(10, lines.size)
       #
-      @in.rewind(100)
+      @in.backward(100)
       lines = []
-      @in.rewind(1)
+      @in.backward(1)
       assert_raises(TimeoutError) do
         timeout(1) { lines += @in.tail(2) }
       end
@@ -134,7 +133,7 @@ class TC_FileTail < Test::Unit::TestCase
   end
 
   def test_tail_withappend
-    @in.rewind
+    @in.backward
     lines = []
     threads = []
     threads << Thread.new do
@@ -149,7 +148,7 @@ class TC_FileTail < Test::Unit::TestCase
   end
 
   def test_tail_truncated
-    @in.rewind
+    @in.backward
     lines = []
     threads = []
     threads << appender = Thread.new do
@@ -176,7 +175,7 @@ class TC_FileTail < Test::Unit::TestCase
 
   def test_tail_remove
 		return if File::PATH_SEPARATOR == ';' # Grmpf! Windows...
-    @in.rewind
+    @in.backward
     lines = []
     threads = []
     threads << appender = Thread.new do
@@ -222,6 +221,5 @@ class TC_FileTail < Test::Unit::TestCase
     (1..n).each { |x| file << "#{x} #{"A" * 70}\n" }
     file.flush
   end
-
 end
   # vim: set noet sw=2 ts=2:

metadata

@@ -1,52 +1,61 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
+rubygems_version: 0.8.11
 specification_version: 1
 name: file-tail
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
-date: 2005-08-20
+  version: 0.1.4
+date: 2007-02-08 00:00:00 +01:00
 summary: File::Tail for Ruby
 require_paths: 
-  - lib
+- lib
 email: flori@ping.de
 homepage: http://file-tail.rubyforge.org
 rubyforge_project: file-tail
-description: ''
-autorequire: file/tail
+description: Library to tail files in Ruby
+autorequire: 
 default_executable: 
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
 authors: 
-  - Florian Frank
+- Florian Frank
 files: 
-  - examples
-  - examples/tail.rb
-  - examples/pager.rb
-  - install.rb
-  - GPL
-  - Rakefile
-  - VERSION
-  - tests
-  - tests/test.rb
-  - CHANGES
-  - lib
-  - lib/file
-  - lib/file/tail.rb
-  - make_doc.rb
-  - README.en
-test_files: 
-  - tests/test.rb
-rdoc_options: []
+- VERSION
+- tests
+- GPL
+- README.en
+- install.rb
+- Rakefile
+- examples
+- lib
+- CHANGES
+- tests/test_file-tail.rb
+- examples/pager.rb
+- examples/tail.rb
+- lib/file
+- lib/file/tail.rb
+test_files: &id001 []
+
+rdoc_options: 
+- --title
+- File::Tail
+- *id001
+- tests/test_file-tail.rb
 extra_rdoc_files: []
+
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+

data/make_doc.rb

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-
-$outdir = 'doc/'
-puts "Creating documentation in '#$outdir'."
-system "rdoc -o #$outdir lib/file/tail.rb"
-  # vim: set et sw=2 ts=2: