directory_watcher 0.1.4 → 1.0.0

data/Rakefile

@@ -19,6 +19,9 @@ dispatched to registered observers. Three types of events are supported --
 added, modified, and removed.
   DESC
   proj.changes = <<-CHANGES
+Version 1.0.0 / 2007-08-21
+  * added a join method (much like Thread#join)
+
 Version 0.1.4 / 2007-08-20
   * added version information to the class
 

data/lib/directory_watcher.rb

@@ -6,7 +6,6 @@
 
 require 'observer'
 
-#
 # == Synopsis
 #
 # A class for watching files within a directory and generating events when
@@ -152,9 +151,8 @@ require 'observer'
 class DirectoryWatcher
   include Observable
 
-  VERSION = '0.1.4'    # :nodoc:
+  VERSION = '1.0.0'    # :nodoc:
 
-  #
   # An +Event+ structure contains the _type_ of the event and the file _path_
   # to which the event pertains. The type can be one of the following:
   #
@@ -172,7 +170,6 @@ class DirectoryWatcher
   end
   # :startdoc:
 
-  #
   # call-seq:
   #    DirectoryWatcher.new( directory, options )
   #
@@ -215,13 +212,13 @@ class DirectoryWatcher
     @thread = nil
   end
 
-  #
   # call-seq:
   #    add_observer( observer )
-  #    add_observer {|*args| block}
+  #    add_observer {|*events| block}
   #
   # Adds the given _observer_ as an observer on this directory watcher. The
-  # _observer_ will now receive file events when they are generated.
+  # _observer_ will now receive file events when they are generated. The
+  # _observer_ must implement an <code>update( *events )</code> method.
   #
   # Optionally, a block can be passed as the observer. The block will be
   # executed with the file events passed as the arguments. A reference to the
@@ -238,7 +235,6 @@ class DirectoryWatcher
     super observer
   end
 
-  #
   # call-seq:
   #    glob = '*'
   #    glob = ['lib/**/*.rb', 'test/**/*.rb']
@@ -259,7 +255,6 @@ class DirectoryWatcher
   end
   attr_reader :glob
 
-  #
   # call-seq:
   #    interval = 30.0
   #
@@ -274,7 +269,6 @@ class DirectoryWatcher
   end
   attr_reader :interval
 
-  #
   # call-seq:
   #    stable = 2
   #
@@ -310,7 +304,6 @@ class DirectoryWatcher
   end
   attr_reader :stable
 
-  #
   # call-seq:
   #    running?
   #
@@ -321,7 +314,6 @@ class DirectoryWatcher
     !@thread.nil?
   end
 
-  #
   # call-seq:
   #    start
   #
@@ -336,7 +328,6 @@ class DirectoryWatcher
     self
   end
 
-  #
   # call-seq:
   #    stop
   #
@@ -353,7 +344,6 @@ class DirectoryWatcher
     self
   end
 
-  #
   # call-seq:
   #    reset( pre_load = false )
   #
@@ -372,8 +362,25 @@ class DirectoryWatcher
     start if was_running
   end
 
-  private
+  # call-seq:
+  #    join( limit = nil )
   #
+  # If the directory watcher is running, the calling thread will suspend
+  # execution and run the directory watcher thread. This method does not
+  # return until the directory watcher is stopped or until _limit_ seconds
+  # have passed.
+  #
+  # If the directory watcher is not running, this method returns immediately
+  # with +nil+.
+  #
+  def join( limit = nil )
+    return unless running?
+    @thread.join limit
+  end
+
+
+  private
+
   # call-seq:
   #    scan_files
   #
@@ -395,7 +402,6 @@ class DirectoryWatcher
     files
   end
 
-  #
   # call-seq:
   #    run
   #
@@ -424,7 +430,6 @@ class DirectoryWatcher
     end
   end
 
-  #
   # call-seq:
   #    find_added( files, cur, prev )
   #
@@ -441,7 +446,6 @@ class DirectoryWatcher
     self
   end
 
-  #
   # call-seq:
   #    find_removed( cur, prev )
   #
@@ -455,7 +459,6 @@ class DirectoryWatcher
     self
   end
 
-  #
   # call-seq:
   #    find_modified( files, cur, prev )
   #
@@ -489,7 +492,6 @@ class DirectoryWatcher
     self
   end
 
-  #
   # call-seq:
   #    notify_observers
   #

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: directory_watcher
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
-date: 2007-08-20 00:00:00 -06:00
+  version: 1.0.0
+date: 2007-08-21 00:00:00 -06:00
 summary: A class for watching files within a directory and generating events when those files change
 require_paths: 
 - lib