eventmachine-tail 0.5.20101005181243 → 0.5.20101204110840

data/lib/em/filetail.rb

@@ -13,6 +13,13 @@ EventMachine.kqueue = true if EventMachine.kqueue?
 #     def receive_data(data)
 #       puts "Got #{data.length} bytes"
 #     end
+#
+#     # Optional
+#     def eof
+#       puts "Got EOF!"
+#       # If you want to stop
+#       stop
+#     end
 #   end
 #
 #   # Now add it to EM
@@ -64,7 +71,7 @@ class EventMachine::FileTail
     @logger.debug("Tailing #{path} starting at position #{startpos}")
 
     @file = nil
-    @want_eof = false
+    @want_eof_handling = false
     @want_read = false
     @want_reopen = false
     @reopen_on_eof = false
@@ -132,6 +139,16 @@ class EventMachine::FileTail
     end
   end # def receive_data
 
+  # This method is called when a tailed file reaches EOF.
+  #
+  # If you want to stop reading this file, call close(), otherwise
+  # this eof is handled as normal tailing does. The default
+  # EOF handler is to do nothing.
+  public
+  def eof
+    # do nothing, subclassers should implement this.
+  end # def eof
+
   # notify is invoked by EM::watch_file when the file you are tailing has been
   # modified or otherwise needs to be acted on.
   private
@@ -144,13 +161,17 @@ class EventMachine::FileTail
       @reopen_on_eof = true
       schedule_next_read
     elsif status == :unbind
-      # Do what?
+      # :unbind is called after the :deleted handler
+      # :deleted happens on FreeBSD's newsyslog instead of :moved
+      # clean up @watch since its reference is wiped in EM's file_deleted callback
+      @watch = nil
     end
   end # def notify
 
   # Open (or reopen, if necessary) our file and schedule a read.
   private
   def open
+    return if @closed
     @file.close if @file
     begin
       @logger.debug "Opening file #{@path}"
@@ -165,6 +186,15 @@ class EventMachine::FileTail
     schedule_next_read
   end # def open
 
+  # Close this filetail
+  public
+  def close
+    @closed = true
+    EM.schedule do
+      @file.close if @file
+    end
+  end # def close
+
   # Watch our file.
   private
   def watch
@@ -213,6 +243,7 @@ class EventMachine::FileTail
   # Read CHUNKSIZE from our file and pass it to .receive_data()
   private
   def read
+    return if @closed
     @logger.debug "#{self}: Reading..."
     begin
       data = @file.sysread(CHUNKSIZE)
@@ -227,17 +258,18 @@ class EventMachine::FileTail
     rescue EOFError
       schedule_eof
     end
-  end
+  end # def read
 
   # Do EOF handling on next EM iteration
+  private
   def schedule_eof
-    if !@want_eof
-      @want_eof = true
+    if !@want_eof_handling
+      eof # Call our own eof event
+      @want_eof_handling = true
       EventMachine::next_tick do
-        @want_eof = false
-        eof
+        handle_eof
       end # EventMachine::next_tick
-    end # if !@want_eof
+    end # if !@want_eof_handling
   end # def schedule_eof
 
   private
@@ -252,8 +284,8 @@ class EventMachine::FileTail
   end # def schedule_reopen
 
   private
-  def eof
-    @want_eof = false
+  def handle_eof
+    @want_eof_handling = false
 
     if @reopen_on_eof
       @reopen_on_eof = false
@@ -284,7 +316,7 @@ class EventMachine::FileTail
         end # begin/rescue ENOENT
       end # EM::PeriodicTimer
     end # begin/rescue ENOENT
-  end # def eof
+  end # def handle_eof
 
   private
   def read_file_metadata(&block)

data/test/test_filetail.rb

@@ -28,9 +28,17 @@ class Reader < EventMachine::FileTail
       expected = @data.shift
       @testobj.assert_equal(expected, line, 
           "Expected '#{expected}' on line #{@lineno}, but got '#{line}'")
-      @testobj.finish if @data.length == 0
     end # @buffer.extract
   end # def receive_data
+  
+  # This effectively tests EOF handling by requiring it to work in order
+  # for the tests to pass.
+  def eof
+    if @data.length == 0
+      close
+      @testobj.finish
+    end
+  end # def eof
 end # class Reader
 
 class TestFileTail < Test::Unit::TestCase

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: eventmachine-tail
 version: !ruby/object:Gem::Version 
+  hash: 40202408221691
   prerelease: false
   segments: 
   - 0
   - 5
-  - 20101005181243
-  version: 0.5.20101005181243
+  - 20101204110840
+  version: 0.5.20101204110840
 platform: ruby
 authors: 
 - Jordan Sissel
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-05 00:00:00 -07:00
+date: 2010-12-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: eventmachine
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -62,23 +65,27 @@ require_paths:
 - lib
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: eventmachine tail - a file tail implementation with glob support