directory_watcher 1.3.2 → 1.4.0

data/.gitignore

@@ -0,0 +1,14 @@
+# git-ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg
+tags
+temp.dir
+tmp.rb
+tmp.yml

data/History.txt

@@ -1,3 +1,8 @@
+== 1.4.0 / 2011-03-15
+
+Minor Enhancements
+- added support for 'cool.io' [Jonathan Stott]
+
 == 1.3.2 / 2010-04-09
 
 * 1 bug fix

data/bin/dw

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+

data/lib/directory_watcher.rb

@@ -175,14 +175,14 @@ require 'yaml'
 # This approach is fairly intensive for short intervals and/or directories
 # with many files.
 #
-# DirectoryWatcher supports using Rev () or EventMachine () instead of a
-# busy polling thread. These libraries use system level kernel hooks to
+# DirectoryWatcher supports using Cool.io, EventMachine, or Rev instead
+# of a busy polling thread. These libraries use system level kernel hooks to
 # receive notifications of file system changes. This makes DirectoryWorker
 # much more efficient.
 #
-# This example will use Rev to generate file notifications.
+# This example will use Cool.io to generate file notifications.
 #
-#    dw = DirectoryWatcher.new '.', :glob => '**/*.rb', :scanner => :rev
+#    dw = DirectoryWatcher.new '.', :glob => '**/*.rb', :scanner => :coolio
 #    dw.add_observer {|*args| args.each {|event| puts event}}
 #
 #    dw.start
@@ -193,6 +193,17 @@ require 'yaml'
 # created. To use an EventMachine scanner, pass :em as the :scanner
 # option.
 #
+# If you wish to use the Cool.io scanner, then you must have the Cool.io gem
+# installed. The same goes for EventMachine and Rev. To install any of these
+# gems run the following on the command line:
+#
+#   gem install cool.io
+#   gem install eventmachine
+#   gem install rev
+#
+# Note: Rev has been replace by Cool.io and support for the Rev scanner will
+# eventually be dropped from DirectoryWatcher.
+#
 # == Contact
 #
 # A lot of discussion happens about Ruby in general on the ruby-talk
@@ -300,7 +311,7 @@ class DirectoryWatcher
   #                            from the file when the directory watcher is
   #                            stopped and started (respectively)
   #    :scanner   =>  nil      the directory scanning strategy to use with
-  #                            the directory watcher (either :em :rev or nil)
+  #                            the directory watcher (either :coolio, :em, :rev or nil)
   #
   # The default glob pattern will scan all files in the configured directory.
   # Setting the :stable option to +nil+ will prevent stable events from being
@@ -395,7 +406,12 @@ class DirectoryWatcher
     glob.uniq!
     @scanner.glob = glob
   end
-  attr_reader :glob
+
+  # Returns the array of glob patterns used to monitor files in the directory.
+  #
+  def glob
+    @scanner.glob
+  end
 
   # Sets the directory scan interval. The directory will be scanned every
   # _interval_ seconds for changes to files matching the glob pattern.
@@ -569,6 +585,7 @@ end  # class DirectoryWatcher
 
 DirectoryWatcher.libpath {
   require 'directory_watcher/scanner'
+  require 'directory_watcher/coolio_scanner'
   require 'directory_watcher/em_scanner'
   require 'directory_watcher/rev_scanner'
 }

data/lib/directory_watcher/coolio_scanner.rb

@@ -0,0 +1,184 @@
+begin
+  require 'coolio'
+  DirectoryWatcher::HAVE_COOLIO = true
+rescue LoadError
+  DirectoryWatcher::HAVE_COOLIO = false
+end
+
+if DirectoryWatcher::HAVE_COOLIO
+
+# The CoolioScanner uses the Coolio loop to monitor changes to files in the
+# watched directory. This scanner is more efficient than the pure Ruby
+# scanner because it relies on the operating system kernel notifictions
+# instead of a periodic polling and stat of every file in the watched
+# directory (the technique used by the Scanner class).
+#
+class DirectoryWatcher::CoolioScanner < ::DirectoryWatcher::Scanner
+
+  # call-seq:
+  #    CoolioScanner.new { |events| block }
+  #
+  # Create a Coolio based scanner that will generate file events and pass
+  # those events (as an array) to the given _block_.
+  #
+  def initialize( &block )
+    super(&block)
+    @watchers = {}
+  end
+
+  # Start the Coolio scanner loop. If the scanner is already running, this method
+  # will return without taking any action.
+  #
+  def start
+    return if running?
+
+    @timer = Timer.new self
+    @thread = Thread.new {
+      coolio_loop = Thread.current._coolio_loop
+      @files.keys.each do |fn|
+        if test ?e, fn
+          _watch_file fn
+          next
+        end
+
+        @files.delete fn
+        @events << ::DirectoryWatcher::Event.new(:removed, fn)
+      end
+
+      @timer.attach(coolio_loop)
+      coolio_loop.run
+    }
+  end
+
+  # Stop the Coolio scanner loop. If the scanner is already stopped, this method
+  # will return without taking any action.
+  #
+  def stop
+    return unless running?
+
+    @timer.detach
+    @timer = nil
+
+    @watchers.each_value {|w| w.detach}
+    @watchers.clear
+
+    notify
+
+    @thread._coolio_loop.stop rescue nil
+    @thread.kill    # for some reason the rev loop is not returning after stopping
+    @thread = nil
+  end
+
+  # :stopdoc:
+  #
+  # This callback is invoked by a Watcher instance when some change has
+  # occured on the file. The scanner determines if the file has been
+  # modified or deleted and notifies the directory watcher accordingly.
+  #
+  def _on_change( watcher )
+    fn = watcher.path
+    stat = watcher.stat
+
+    if stat
+      if @files[fn] != stat
+        @files[fn] = stat
+        @events << ::DirectoryWatcher::Event.new(:modified, fn)
+      end
+    else
+      watcher.detach
+      @watchers.delete fn
+      @files.delete fn
+      @events << ::DirectoryWatcher::Event.new(:removed, fn)
+    end
+
+    notify
+  end
+
+  # This callback is invoked by the Timer instance when it is triggered by
+  # the Coolio loop. This method will check for added files and stable files
+  # and notify the directory watcher accordingly.
+  #
+  def _on_timer
+    _find_added
+    _find_stable
+    notify
+  end
+  # :startdoc:
+
+
+  private
+
+  # From the list of files in the watched directory, find those that we are
+  # not currently watching and add them to the watch list. Generate "added"
+  # events for those newly found files.
+  #
+  def _find_added
+    cur = list_files
+    prev = @files.keys
+    added = cur - prev
+
+    added.each do |fn|
+      @files[fn] = _watch_file(fn).stat
+      @events << ::DirectoryWatcher::Event.new(:added, fn)
+    end
+  end
+
+  # Iterate over the FileStat instances looking for those with non-nil
+  # stable counts. Decrement these counts and generate "stable" events for
+  # those files whose count reaches zero.
+  #
+  def _find_stable
+    @files.each do |fn, stat|
+      next if stat.stable.nil?
+      stat.stable -= 1
+      if stat.stable <= 0
+        @events << ::DirectoryWatcher::Event.new(:stable, fn)
+        stat.stable = nil
+      end
+    end
+  end
+
+  # Create and return a new Watcher instance for the given filename _fn_.
+  #
+  def _watch_file( fn )
+    w = Watcher.new(fn, self)
+    w.attach(@thread ? @thread._coolio_loop : Thread.current._coolio_loop)
+    @watchers[fn] = w
+  end
+
+  # :stopdoc:
+  #
+  class Watcher < Coolio::StatWatcher
+    def initialize( fn, scanner )
+      super(fn, scanner.interval)
+      @scanner = scanner
+    end
+
+    def on_change
+      @scanner._on_change self
+    end
+
+    def stat
+      return unless test ?e, path
+      stat = File.stat path
+      ::DirectoryWatcher::FileStat.new(stat.mtime, stat.size, @scanner.stable)
+    end
+  end
+
+  class Timer < Coolio::TimerWatcher
+    def initialize( scanner )
+      super(scanner.interval, true)
+      @scanner = scanner
+    end
+
+    def on_timer
+      @scanner._on_timer
+    end
+  end
+  # :startdoc:
+
+end  # class DirectoryWatcher::CoolioScanner
+
+end  # if DirectoryWatcher::HAVE_COOLIO
+
+# EOF

data/version.txt

@@ -1 +1 @@
-1.3.2
+1.4.0

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: directory_watcher
 version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: false
   segments: 
   - 1
-  - 3
-  - 2
-  version: 1.3.2
+  - 4
+  - 0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -14,63 +15,67 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-09 00:00:00 -06:00
+date: 2011-03-15 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bones-git
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
-        - 1
-        - 1
-        version: 1.1.1
+        - 2
+        - 4
+        version: 1.2.4
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rev
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
-        - 3
-        - 2
-        version: 0.3.2
+        version: "0"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: eventmachine
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
-        - 12
-        - 10
-        version: 0.12.10
+        version: "0"
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: bones
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
         - 3
-        - 4
-        - 1
-        version: 3.4.1
+        - 6
+        - 5
+        version: 3.6.5
   type: :development
   version_requirements: *id004
 description: |-
@@ -80,19 +85,22 @@ description: |-
   dispatched to registered observers. Three types of events are supported --
   added, modified, and removed.
 email: tim.pease@gmail.com
-executables: []
-
+executables: 
+- dw
 extensions: []
 
 extra_rdoc_files: 
 - History.txt
 - README.txt
-- version.txt
+- bin/dw
 files: 
+- .gitignore
 - History.txt
 - README.txt
 - Rakefile
+- bin/dw
 - lib/directory_watcher.rb
+- lib/directory_watcher/coolio_scanner.rb
 - lib/directory_watcher/em_scanner.rb
 - lib/directory_watcher/rev_scanner.rb
 - lib/directory_watcher/scanner.rb
@@ -108,23 +116,27 @@ rdoc_options:
 require_paths: 
 - 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: directory_watcher
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A class for watching files within a directory and generating events when those files change