listen 0.7.3 → 1.0.0

data/lib/listen/adapters/darwin.rb

@@ -4,62 +4,11 @@ module Listen
     # Adapter implementation for Mac OS X `FSEvents`.
     #
     class Darwin < Adapter
-      extend DependencyManager
-
-      # Declare the adapter's dependencies
-      dependency 'rb-fsevent', '~> 0.9'
-
       LAST_SEPARATOR_REGEX = /\/$/
 
-      # Initializes the Adapter. See {Listen::Adapter#initialize} for more info.
-      #
-      def initialize(directories, options = {}, &callback)
-        super
-        @worker = init_worker
-      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
-
-        @worker_thread = Thread.new { @worker.run }
-
-        # The FSEvent worker needs sometime to startup. Turnstiles can't
-        # be used to wait for it as it runs in a loop.
-        # TODO: Find a better way to block until the worker starts.
-        sleep 0.1
 
-        @poll_thread = Thread.new { poll_changed_dirs } if @report_changes
-        @worker_thread.join if blocking
-      end
-
-      # Stops the adapter.
-      #
-      def stop
-        @mutex.synchronize do
-          return if @stop == true
-          super
-        end
-
-        @worker.stop
-        @worker_thread.join if @worker_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'] =~ /darwin(1.+)?$/i
-        super
-      end
+      def self.target_os_regex; /darwin(1.+)?$/i; end
+      def self.adapter_gem; 'rb-fsevent'; end
 
       private
 
@@ -68,17 +17,31 @@ module Listen
       #
       # @return [FSEvent] initialized worker
       #
-      def init_worker
+      # @see Listen::Adapter#initialize_worker
+      #
+      def initialize_worker
         FSEvent.new.tap do |worker|
-          worker.watch(@directories.dup, :latency => @latency) do |changes|
-            next if @paused
-            @mutex.synchronize do
-              changes.each { |path| @changed_dirs << path.sub(LAST_SEPARATOR_REGEX, '') }
+          worker.watch(directories.dup, :latency => latency) do |changes|
+            next if paused
+
+            mutex.synchronize do
+              changes.each { |path| @changed_directories << path.sub(LAST_SEPARATOR_REGEX, '') }
             end
           end
         end
       end
 
+      # Starts the worker in a new thread and sleep 0.1 second.
+      #
+      # @see Listen::Adapter#start_worker
+      #
+      def start_worker
+        @worker_thread = Thread.new { worker.run }
+        # The FSEvent worker needs some time to start up. Turnstiles can't
+        # be used to wait for it as it runs in a loop.
+        # TODO: Find a better way to block until the worker starts.
+        sleep 0.1
+      end
     end
 
   end

data/lib/listen/adapters/linux.rb

@@ -4,17 +4,12 @@ module Listen
     # Listener implementation for Linux `inotify`.
     #
     class Linux < Adapter
-      extend DependencyManager
-
-      # Declare the adapter's dependencies
-      dependency 'rb-inotify', '~> 0.9'
-
       # Watched inotify events
       #
       # @see http://www.tin.org/bin/man.cgi?section=7&topic=inotify
       # @see https://github.com/nex3/rb-inotify/blob/master/lib/rb-inotify/notifier.rb#L99-L177
       #
-      EVENTS = %w[recursive attrib create delete move close_write]
+      EVENTS = [:recursive, :attrib, :create, :delete, :move, :close_write]
 
       # The message to show when the limit of inotify watchers is not enough
       #
@@ -25,63 +20,31 @@ module Listen
         for information on how to solve this issue.
       EOS
 
-      # Initializes the Adapter. See {Listen::Adapter#initialize} for more info.
+      def self.target_os_regex; /linux/i; end
+      def self.adapter_gem; 'rb-inotify'; end
+
+      # Initializes the Adapter.
+      #
+      # @see Listen::Adapter#initialize
       #
       def initialize(directories, options = {}, &callback)
         super
-        @worker = init_worker
       rescue Errno::ENOSPC
         abort(INOTIFY_LIMIT_MESSAGE)
       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
-
-        @worker_thread = Thread.new { @worker.run }
-        @poll_thread   = Thread.new { poll_changed_dirs } if @report_changes
-
-        @worker_thread.join if blocking
-      end
-
-      # Stops the adapter.
-      #
-      def stop
-        @mutex.synchronize do
-          return if @stop == true
-          super
-        end
-
-        @worker.stop
-        Thread.kill(@worker_thread) if @worker_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'] =~ /linux/i
-        super
-      end
-
-    private
+      private
 
       # Initializes a INotify worker and adds a watcher for
       # each directory passed to the adapter.
       #
       # @return [INotify::Notifier] initialized worker
       #
-      def init_worker
+      # @see Listen::Adapter#initialize_worker
+      #
+      def initialize_worker
         callback = lambda do |event|
-          if @paused || (
+          if paused || (
             # Event on root directory
             event.name == ""
           ) || (
@@ -89,24 +52,29 @@ module Listen
             # on the directories themselves too.
             #
             # @see http://linux.die.net/man/7/inotify
-            event.flags.include?(:isdir) and event.flags & [:close, :modify] != []
+            event.flags.include?(:isdir) and (event.flags & [:close, :modify]).any?
           )
             # Skip all of these!
             next
           end
 
-          @mutex.synchronize do
-            @changed_dirs << File.dirname(event.absolute_name)
+          mutex.synchronize do
+            @changed_directories << File.dirname(event.absolute_name)
           end
         end
 
         INotify::Notifier.new.tap do |worker|
-          @directories.each do |directory|
-            worker.watch(directory, *EVENTS.map(&:to_sym), &callback)
-          end
+          directories.each { |dir| worker.watch(dir, *EVENTS, &callback) }
         end
       end
 
+      # Starts the worker in a new thread.
+      #
+      # @see Listen::Adapter#start_worker
+      #
+      def start_worker
+        @worker_thread = Thread.new { worker.run }
+      end
     end
 
   end

data/lib/listen/adapters/polling.rb

@@ -1,66 +1,57 @@
 module Listen
   module Adapters
 
-    # The default delay between checking for changes.
     DEFAULT_POLLING_LATENCY = 1.0
 
     # Polling Adapter that works cross-platform and
     # has no dependencies. This is the adapter that
     # uses the most CPU processing power and has higher
-    # file IO that the other implementations.
+    # file IO than the other implementations.
     #
     class Polling < Adapter
-      extend DependencyManager
+      private
 
-      # Initialize the Adapter. See {Listen::Adapter#initialize} for more info.
+      # The default delay between checking for changes.
       #
-      def initialize(directories, options = {}, &callback)
-        @latency ||= DEFAULT_POLLING_LATENCY
-        super
+      # @see Listen::Adapter#default_latency
+      #
+      def default_latency
+        1.0
       end
 
-      # Start the adapter.
+      # The thread on which the main thread should wait
+      # when the adapter has been started in blocking mode.
       #
-      # @param [Boolean] blocking whether or not to block the current thread after starting
+      # @see Listen::Adapter#blocking_thread
       #
-      def start(blocking = true)
-        @mutex.synchronize do
-          return if @stop == false
-          super
-        end
-
-        @poll_thread = Thread.new { poll }
-        @poll_thread.join if blocking
+      def blocking_thread
+        poller_thread
       end
 
-      # Stop the adapter.
+      # @see Listen::Adapter#start_worker
       #
-      def stop
-        @mutex.synchronize do
-          return if @stop == true
-          super
-        end
-
-        @poll_thread.join
+      # @see Listen::Adapter#start_worker
+      #
+      def start_worker
+        # The polling adapter has no worker! Sad panda! :'(
       end
 
-    private
-
       # Poll listener directory for file system changes.
       #
-      def poll
-        until @stop
-          next if @paused
+      # @see Listen::Adapter#poll_changed_directories
+      #
+      def poll_changed_directories
+        until stopped
+          next if paused
 
           start = Time.now.to_f
-          @callback.call(@directories.dup, :recursive => true)
-          @turnstile.signal
-          nap_time = @latency - (Time.now.to_f - start)
+          callback.call(directories.dup, :recursive => true)
+          turnstile.signal
+          nap_time = latency - (Time.now.to_f - start)
           sleep(nap_time) if nap_time > 0
         end
       rescue Interrupt
       end
-
     end
 
   end

data/lib/listen/adapters/windows.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'rubygems'
 
 module Listen
   module Adapters
@@ -6,81 +7,84 @@ module Listen
     # Adapter implementation for Windows `wdm`.
     #
     class Windows < Adapter
-      extend DependencyManager
 
-      # Declare the adapter's dependencies
-      dependency 'wdm', '~> 0.1'
+      BUNDLER_DECLARE_GEM = <<-EOS.gsub(/^ {6}/, '')
+        Please add the following to your Gemfile to avoid polling for changes:
+          require 'rbconfig'
+          gem 'wdm', '>= 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
+      EOS
 
-      # Initializes the Adapter. See {Listen::Adapter#initialize} for more info.
+      def self.target_os_regex; /mswin|mingw/i; end
+      def self.adapter_gem; 'wdm'; end
+
+      # Checks if the adapter is usable on target OS.
       #
-      def initialize(directories, options = {}, &callback)
-        super
-        @worker = init_worker
+      # @return [Boolean] whether usable or not
+      #
+      def self.usable?
+        super if mri? && at_least_ruby_1_9?
       end
 
-      # Starts the adapter.
+      # Load the adapter gem
       #
-      # @param [Boolean] blocking whether or not to block the current thread after starting
+      # @return [Boolean] whether required or not
       #
-      def start(blocking = true)
-        @mutex.synchronize do
-          return if @stop == false
-          super
-        end
-
-        @worker_thread = Thread.new { @worker.run! }
-
-        # Wait for the worker to start. This is needed to avoid a deadlock
-        # when stopping immediately after starting.
-        sleep 0.1
-
-        @poll_thread = Thread.new { poll_changed_dirs } if @report_changes
-
-        @worker_thread.join if blocking
+      def self.load_dependency
+        super
+      rescue Gem::LoadError
+        Kernel.warn BUNDLER_DECLARE_GEM
       end
 
-      # Stops the adapter.
-      #
-      def stop
-        @mutex.synchronize do
-          return if @stop == true
-          super
-        end
+      private
 
-        @worker.stop
-        @worker_thread.join if @worker_thread
-        @poll_thread.join if @poll_thread
+      # Checks if Ruby engine is MRI.
+      #
+      # @return [Boolean]
+      #
+      def self.mri?
+        defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ruby'
       end
 
-      # Checks if the adapter is usable on the current OS.
+      # Checks if Ruby engine is MRI.
       #
-      # @return [Boolean] whether usable or not
+      # @return [Boolean]
       #
-      def self.usable?
-        return false unless RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
-        super
+      def self.at_least_ruby_1_9?
+        Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9.2')
       end
 
-    private
-
       # Initializes a WDM monitor and adds a watcher for
       # each directory passed to the adapter.
       #
       # @return [WDM::Monitor] initialized worker
       #
-      def init_worker
+      # @see Listen::Adapter#initialize_worker
+      #
+      def initialize_worker
         callback = Proc.new do |change|
-          next if @paused
-          @mutex.synchronize do
-            @changed_dirs << File.dirname(change.path)
+          next if paused
+
+          mutex.synchronize do
+            @changed_directories << File.dirname(change.path)
           end
         end
 
         WDM::Monitor.new.tap do |worker|
-          @directories.each { |d| worker.watch_recursively(d, &callback) }
+          directories.each { |dir| worker.watch_recursively(dir, &callback) }
         end
       end
 
+      # Start the worker in a new thread and sleep 0.1 second.
+      #
+      # @see Listen::Adapter#start_worker
+      #
+      def start_worker
+        @worker_thread = Thread.new { worker.run! }
+        # Wait for the worker to start. This is needed to avoid a deadlock
+        # when stopping immediately after starting.
+        sleep 0.1
+      end
+
     end
 
   end