rb-inotify 0.5.1 → 0.6.0

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/rb-inotify.rb

@@ -13,5 +13,5 @@ module INotify
   # An array containing the version number of rb-inotify.
   # The numbers in the array are the major, minor, and patch versions,
   # respectively.
-  VERSION = [0, 5, 1]
+  VERSION = [0, 6, 0]
 end

data/lib/rb-inotify/event.rb

@@ -18,6 +18,11 @@ module INotify
     #
     # This pathname is relative to the enclosing directory.
     # For the absolute pathname, use \{#absolute\_name}.
+    # Note that when the `:recursive` flag is passed to {Notifier#watch},
+    # events in nested subdirectories will still have a `#name` field
+    # relative to their immediately enclosing directory.
+    # For example, an event on the file `"foo/bar/baz"`
+    # will have name `"baz"`.
     #
     # @return [String]
     attr_reader :name

data/lib/rb-inotify/notifier.rb

@@ -79,6 +79,10 @@ module INotify
     # calling the callback when there are.
     # This is only activated once \{#process} or \{#run} is called.
     #
+    # **Note that by default, this does not recursively watch subdirectories
+    # of the watched directory**.
+    # To do so, use the `:recursive` flag.
+    #
     # ## Flags
     #
     # `:access`
@@ -151,6 +155,14 @@ module INotify
     # `:oneshot`
     # : Only send the event once, then shut down the watcher.
     #
+    # `:recursive`
+    # : Recursively watch any subdirectories that are created.
+    #   Note that this is a feature of rb-inotify,
+    #   rather than of inotify itself, which can only watch one level of a directory.
+    #   This means that the {Event#name} field
+    #   will contain only the basename of the modified file.
+    #   When using `:recursive`, {Event#absolute_name} should always be used.
+    #
     # @param path [String] The path to the file or directory
     # @param flags [Array<Symbol>] Which events to watch for
     # @yield [event] A block that will be called
@@ -162,7 +174,15 @@ module INotify
     #   e.g. if the file isn't found, read access is denied,
     #   or the flags don't contain any events
     def watch(path, *flags, &callback)
-      Watcher.new(self, path, *flags, &callback)
+      return Watcher.new(self, path, *flags, &callback) unless flags.include?(:recursive)
+      Dir[File.join(path, '*/')].each {|d| watch(d, *flags, &callback)}
+
+      rec_flags = [:create, :moved_to]
+      return watch(path, *((flags - [:recursive]) | rec_flags)) do |event|
+        callback.call(event) unless (flags & event.flags).empty?
+        next if (rec_flags & event.flags).empty? || !event.flags.include?(:isdir)
+        watch(event.absolute_name, *flags, &callback)
+      end
     end
 
     # Starts the notifier watching for filesystem events.

data/rb-inotify.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rb-inotify}
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Weizenbaum"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rb-inotify
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Nathan Weizenbaum