listen 0.6.0 → 0.7.0

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.7.0 - December 29, 2012
+
+### Bug fixes
+
+- [#73] Rescue Errno::EOPNOTSUPP on sha1_checksum generation. (fixed by [@thibaudgg][])
+
+### New feature
+
+- Add support for *BSD with rb-kqueue. ([@mat813][])
+
 ## 0.6.0 - November 21, 2012
 
 ### New feature
@@ -180,6 +190,7 @@
 [@daemonza]: https://github.com/daemonza
 [@fny]: https://github.com/fny
 [@markiz]: https://github.com/markiz
+[@mat813]: https://github.com/mat813
 [@napcs]: https://github.com/napcs
 [@netzpirat]: https://github.com/netzpirat
 [@nex3]: https://github.com/nex3

data/README.md

@@ -6,7 +6,7 @@ The Listen gem listens to file modifications and notifies you about the changes.
 
 * Works everywhere!
 * Supports watching multiple directories from a single listener.
-* OS-specific adapters for Mac OS X 10.6+, Linux and Windows.
+* OS-specific adapters for Mac OS X 10.6+, Linux, *BSD and Windows.
 * Automatic fallback to polling if OS-specific adapter doesn't work.
 * Detects file modification, addition and removal.
 * Checksum comparison for modifications made under the same second.
@@ -242,7 +242,7 @@ block execution. See the "Block API" section for an example.
 ## Listen adapters
 
 The Listen gem has a set of adapters to notify it when there are changes.
-There are 3 OS-specific adapters to support Mac, Linux and Windows. These adapters are fast
+There are 3 OS-specific adapters to support Mac, Linux, *BSD and Windows. These adapters are fast
 as they use some system-calls to implement the notifying function.
 
 There is also a polling adapter which is a cross-platform adapter and it will
@@ -287,6 +287,7 @@ For questions please join us in our [Google group](http://groups.google.com/grou
 * [Michael Kessler (netzpirat)][] for having written the [initial specs](https://github.com/guard/listen/commit/1e457b13b1bb8a25d2240428ce5ed488bafbed1f).
 * [Travis Tilley (ttilley)][] for this awesome work on [fssm][] & [rb-fsevent][].
 * [Nathan Weizenbaum (nex3)][] for [rb-inotify][], a thorough inotify wrapper.
+* [Mathieu Arnold (mat813)][] for [rb-kqueue][], a simple kqueue wrapper.
 * [stereobooster][] for [rb-fchange][], windows support wouldn't exist without him.
 * [Yehuda Katz (wycats)][] for [vigilo][], that has been a great source of inspiration.
 
@@ -305,6 +306,7 @@ For questions please join us in our [Google group](http://groups.google.com/grou
 [Travis Tilley (ttilley)]: https://github.com/ttilley
 [fssm]: https://github.com/ttilley/fssm
 [rb-fsevent]: https://github.com/thibaudgg/rb-fsevent
+[Mathieu Arnold (mat813)]: https://github.com/mat813
 [Nathan Weizenbaum (nex3)]: https://github.com/nex3
 [rb-inotify]: https://github.com/nex3/rb-inotify
 [stereobooster]: https://github.com/stereobooster

data/lib/listen.rb

@@ -10,6 +10,7 @@ module Listen
   module Adapters
     autoload :Darwin,  'listen/adapters/darwin'
     autoload :Linux,   'listen/adapters/linux'
+    autoload :BSD,     'listen/adapters/bsd'
     autoload :Windows, 'listen/adapters/windows'
     autoload :Polling, 'listen/adapters/polling'
   end

data/lib/listen/adapter.rb

@@ -45,6 +45,8 @@ module Listen
           return Adapters::Darwin.new(directories, options, &callback)
         elsif Adapters::Linux.usable_and_works?(directories, options)
           return Adapters::Linux.new(directories, options, &callback)
+        elsif Adapters::BSD.usable_and_works?(directories, options)
+          return Adapters::BSD.new(directories, options, &callback)
         elsif Adapters::Windows.usable_and_works?(directories, options)
           return Adapters::Windows.new(directories, options, &callback)
         end

data/lib/listen/adapters/bsd.rb

@@ -0,0 +1,112 @@
+module Listen
+  module Adapters
+
+    # Listener implementation for BSD's `kqueue`.
+    #
+    class BSD < Adapter
+      extend DependencyManager
+
+      # Declare the adapter's dependencies
+      dependency 'rb-kqueue', '~> 0.2'
+
+      # Watched kqueue events
+      #
+      # @see http://www.freebsd.org/cgi/man.cgi?query=kqueue
+      # @see https://github.com/nex3/rb-kqueue/blob/master/lib/rb-kqueue/queue.rb
+      #
+      EVENTS = [ :delete, :write, :extend, :attrib, :link, :rename, :revoke ]
+
+      # Initializes the Adapter. See {Listen::Adapter#initialize} for
+      # more info.
+      #
+      def initialize(directories, options = {}, &callback)
+        super
+        @kqueue = init_kqueue
+      end
+
+      # Starts the adapter.
+      #
+      # @param [Boolean] blocking whether or not to block the current thread after starting
+      #
+      def start(blocking = true)
+        @mutex.synchronize do
+          return if @stop == false
+          super
+        end
+
+        @kqueue_thread = Thread.new do
+          until @stop
+            @kqueue.poll
+            sleep(@latency)
+          end
+        end
+        @poll_thread   = Thread.new { poll_changed_dirs } if @report_changes
+
+        @kqueue_thread.join if blocking
+      end
+
+      # Stops the adapter.
+      #
+      def stop
+        @mutex.synchronize do
+          return if @stop == true
+          super
+        end
+
+        @kqueue.stop
+        Thread.kill(@kqueue_thread) if @kqueue_thread
+        @poll_thread.join if @poll_thread
+      end
+
+      # Checks if the adapter is usable on the current OS.
+      #
+      # @return [Boolean] whether usable or not
+      #
+      def self.usable?
+        return false unless RbConfig::CONFIG['target_os'] =~ /freebsd/i
+        super
+      end
+
+      private
+
+      # Initializes a kqueue Queue and adds a watcher for each files in
+      # the directories passed to the adapter.
+      #
+      # @return [INotify::Notifier] initialized kqueue
+      #
+      def init_kqueue
+        require 'find'
+
+        callback = lambda do |event|
+          path = event.watcher.path
+          @mutex.synchronize do
+            # kqueue watches everything, but Listen only needs the
+            # directory where stuffs happens.
+            @changed_dirs << (File.directory?(path) ? path : File.dirname(path))
+
+            # If it is a directory, and it has a write flag, it means a
+            # file has been added so find out which and deal with it.
+            # No need to check for removed file, kqueue will forget them
+            # when the vfs does..
+            if File.directory?(path) && !(event.flags & [:write]).empty?
+              queue = event.watcher.queue
+              Find.find(path) do |file|
+                unless queue.watchers.detect {|k,v| v.path == file.to_s}
+                  queue.watch_file(file, *EVENTS, &callback)
+                end
+              end
+            end
+          end
+        end
+
+        KQueue::Queue.new.tap do |queue|
+          @directories.each do |directory|
+            Find.find(directory) do |path|
+              queue.watch_file(path, *EVENTS, &callback)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/listen/directory_record.rb

@@ -304,7 +304,7 @@ module Listen
     #
     def sha1_checksum(path)
       Digest::SHA1.file(path).to_s
-    rescue Errno::EACCES, Errno::ENOENT, Errno::ENXIO
+    rescue Errno::EACCES, Errno::ENOENT, Errno::ENXIO, Errno::EOPNOTSUPP
       nil
     end
 

data/lib/listen/version.rb

@@ -1,3 +1,3 @@
 module Listen
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2012-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/listen/adapter.rb
+- lib/listen/adapters/bsd.rb
 - lib/listen/adapters/darwin.rb
 - lib/listen/adapters/linux.rb
 - lib/listen/adapters/polling.rb
@@ -64,9 +65,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2035972010079293192
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -80,4 +78,3 @@ signing_key:
 specification_version: 3
 summary: Listen to file modifications
 test_files: []
-has_rdoc: