listen 2.7.4 → 2.7.5

data/lib/listen/adapter/bsd.rb

@@ -1,26 +1,46 @@
+# Listener implementation for BSD's `kqueue`.
+# @see http://www.freebsd.org/cgi/man.cgi?query=kqueue
+# @see https://github.com/mat813/rb-kqueue/blob/master/lib/rb-kqueue/queue.rb
+#
 module Listen
   module Adapter
-
-    # Listener implementation for BSD's `kqueue`.
-    #
     class BSD < Base
       # Watched kqueue events
       #
-      # @see http://www.freebsd.org/cgi/man.cgi?query=kqueue
-      # @see https://github.com/mat813/rb-kqueue/blob/master/lib/rb-kqueue/queue.rb
-      #
       EVENTS = [:delete, :write, :extend, :attrib, :rename] # :link, :revoke
 
+      BSD_OS_REGEXP = /bsd|dragonfly/i
+
       # The message to show when wdm gem isn't available
       #
       BUNDLER_DECLARE_GEM = <<-EOS.gsub(/^ {6}/, '')
         Please add the following to your Gemfile to avoid polling for changes:
           require 'rbconfig'
-          gem 'rb-kqueue', '>= 0.2' if RbConfig::CONFIG['target_os'] =~ /freebsd/i
+          if RbConfig::CONFIG['target_os'] =~ #{BSD_OS_REGEXP}
+            gem 'rb-kqueue', '>= 0.2'
+
+            # Base versions have known conflicts/bugs
+            # Even master branches may not work...
+            gem 'ffi', github: 'carpetsmoker/ffi', ref: 'ac63e07f7'
+            gem 'celluloid', github: 'celluloid/celluloid', ref: '7fdef04'
+          end
+      EOS
+
+      BSD_EXPERIMENTAL = <<-EOS.gsub(/^ {6}/, '')
+        NOTE *BSD SUPPORT IS EXPERIMENTAL!
+
+        In fact, it likely WONT WORK!!!!
+
+        (see: https://github.com/guard/listen/issues/220)
+
+        If you're brave enough, feel free to suggest pull requests and
+        experiment on your own. For help, browse existing issues marked 'bsd'
+        for clues, tips and workaround.
       EOS
 
       def self.usable?
-        if RbConfig::CONFIG['target_os'] =~ /freebsd/i
+        if RbConfig::CONFIG['target_os'] =~ BSD_OS_REGEXP
+          Kernel.warn BSD_EXPERIMENTAL
           require 'rb-kqueue'
           require 'find'
           true
@@ -32,7 +52,7 @@ module Listen
 
       def start
         worker = _init_worker
-        Thread.new { worker.poll }
+        Thread.new { worker.run }
       end
 
       private
@@ -45,27 +65,38 @@ module Listen
       def _init_worker
         KQueue::Queue.new.tap do |queue|
           _directories_path.each do |path|
-            Find.find(path) { |file_path| _watch_file(file_path, queue) }
+            # use Record to make a snapshot of dir, so we
+            # can detect new files
+            _find(path) { |file_path| _watch_file(file_path, queue) }
           end
         end
       end
 
       def _worker_callback
         lambda do |event|
-           _notify_change(_event_path(event), type: 'File', change: _change(event.flags))
+          change = _change(event.flags)
+          path = _event_path(event)
+          if path.directory?
+            # Force dir content tracking to kick in, or we won't have
+            # names of added files
+            _notify_change(path, type: 'Directory', recursive: true)
+          else
+            _notify_change(path, type: 'File', change: change)
+          end
 
-            # 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 files, kqueue will forget them
-            # when the vfs does.
-           _watch_for_new_file(event) if _new_file_added?(event)
+          # 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 files, kqueue will forget them
+          # when the vfs does.
+          _watch_for_new_file(event) if _new_file_added?(event)
         end
       end
 
       def _change(event_flags)
         { modified: [:attrib, :extend],
           added:    [:write],
-          removed:  [:rename, :delete] }.each do |change, flags|
+          removed:  [:rename, :delete]
+        }.each do |change, flags|
           return change unless (flags & event_flags).empty?
         end
         nil
@@ -76,20 +107,26 @@ module Listen
       end
 
       def _new_file_added?(event)
-        File.directory?(event.watcher.path) && event.flags.include?(:write)
+        ::File.directory?(event.watcher.path) && event.flags.include?(:write)
       end
 
       def _watch_for_new_file(event)
         queue = event.watcher.queue
-        Find.find(path) do |file_path|
-          _watch_file(file_path, queue) unless queue.watchers.detect { |k,v| v.path == file.to_s }
+        _find(_event_path(event).to_s) do |file_path|
+          unless queue.watchers.detect { |_, v| v.path == file_path.to_s }
+            _watch_file(file_path, queue)
+          end
         end
       end
 
       def _watch_file(path, queue)
         queue.watch_file(path, *EVENTS, &_worker_callback)
       end
-    end
 
+      # Quick rubocop workaround
+      def _find(*paths)
+        Find.send(:find, *paths)
+      end
+    end
   end
 end

data/lib/listen/adapter/darwin.rb

@@ -1,10 +1,8 @@
 module Listen
   module Adapter
-
     # Adapter implementation for Mac OS X `FSEvents`.
     #
     class Darwin < Base
-
       def self.usable?
         RbConfig::CONFIG['target_os'] =~ /darwin(1.+)?$/i
       end
@@ -27,7 +25,8 @@ module Listen
       def _init_worker
         FSEvent.new.tap do |worker|
           worker.watch(_directories_path, latency: _latency) do |changes|
-            _changes_path(changes).each { |path| _notify_change(path, type: 'Dir') }
+            paths = _changes_path(changes)
+            paths.each { |path| _notify_change(path, type: 'Dir') }
           end
         end
       end
@@ -39,6 +38,5 @@ module Listen
         end
       end
     end
-
   end
 end

data/lib/listen/adapter/linux.rb

@@ -1,22 +1,24 @@
 module Listen
   module Adapter
-
     # Listener implementation for Linux `inotify`.
     #
     class Linux < Base
       # 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
+      # @see https://github.com/nex3/rb-inotify
       #
       EVENTS = [:recursive, :attrib, :create, :delete, :move, :close_write]
 
       # The message to show when the limit of inotify watchers is not enough
       #
+      WIKI_URL = 'https://github.com/guard/listen'\
+        '/wiki/Increasing-the-amount-of-inotify-watchers'
+
       INOTIFY_LIMIT_MESSAGE = <<-EOS.gsub(/^\s*/, '')
         FATAL: Listen error: unable to monitor directories for changes.
 
-        Please head to https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers
+        Please head to #{WIKI_URL}
         for information on how to solve this issue.
       EOS
 
@@ -47,7 +49,9 @@ module Listen
       #
       def _init_worker
         INotify::Notifier.new.tap do |worker|
-          _directories_path.each { |path| worker.watch(path, *EVENTS, &_worker_callback) }
+          _directories_path.each do |path|
+            worker.watch(path, *EVENTS, &_worker_callback)
+          end
         end
       end
 
@@ -58,24 +62,25 @@ module Listen
           path = _event_path(event)
           cookie_opts = event.cookie.zero? ? {} : { cookie: event.cookie }
 
-          Celluloid.logger.info "listen: inotify event: #{event.flags.inspect}: #{event.name}"
+          _log(event)
 
           if _dir_event?(event)
-            _notify_change(path, { type: 'Dir'}.merge(cookie_opts))
+            _notify_change(path, { type: 'Dir' }.merge(cookie_opts))
           else
-            _notify_change(path, { type: 'File', change: _change(event.flags)}.merge(cookie_opts))
+            options = { type: 'File', change: _change(event.flags) }
+            _notify_change(path, options.merge(cookie_opts))
           end
         end
       end
 
       def _skip_event?(event)
         # Event on root directory
-        return true if event.name == ""
+        return true if event.name == ''
         # INotify reports changes to files inside directories as events
         # on the directories themselves too.
         #
         # @see http://linux.die.net/man/7/inotify
-        return true if _dir_event?(event) && (event.flags & [:close, :modify]).any?
+        _dir_event?(event) && (event.flags & [:close, :modify]).any?
       end
 
       def _change(event_flags)
@@ -96,7 +101,12 @@ module Listen
       def _event_path(event)
         Pathname.new(event.absolute_name)
       end
-    end
 
+      def _log(event)
+        name = event.name
+        flags = event.flags.inspect
+        Celluloid.logger.info "inotify event: #{flags}: #{name}"
+      end
+    end
   end
 end

data/lib/listen/adapter/polling.rb

@@ -1,6 +1,5 @@
 module Listen
   module Adapter
-
     # Polling Adapter that works cross-platform and
     # has no dependencies. This is the adapter that
     # uses the most CPU processing power and has higher
@@ -44,6 +43,5 @@ module Listen
         sleep(nap_time) if nap_time > 0
       end
     end
-
   end
 end

data/lib/listen/adapter/tcp.rb

@@ -2,7 +2,6 @@ require 'celluloid/io'
 
 module Listen
   module Adapter
-
     # Adapter to receive file system modifications over TCP
     class TCP < Base
       include Celluloid::IO
@@ -18,7 +17,7 @@ module Listen
       # Initializes and starts a Celluloid::IO-powered TCP-recipient
       def start
         @socket = TCPSocket.new(listener.host, listener.port)
-        @buffer = String.new
+        @buffer = ''
         run
       end
 
@@ -36,7 +35,7 @@ module Listen
 
       # Continuously receive and asynchronously handle data
       def run
-        while data = @socket.recv(RECEIVE_WINDOW)
+        while (data = @socket.recv(RECEIVE_WINDOW))
           async.handle_data(data)
         end
       end
@@ -44,7 +43,7 @@ module Listen
       # Buffers incoming data and handles messages accordingly
       def handle_data(data)
         @buffer << data
-        while message = Listen::TCP::Message.from_buffer(@buffer)
+        while (message = Listen::TCP::Message.from_buffer(@buffer))
           handle_message(message)
         end
       end
@@ -58,7 +57,9 @@ module Listen
         end
       end
 
+      def self.local_fs?
+        false
+      end
     end
-
   end
 end

data/lib/listen/adapter/windows.rb

@@ -1,16 +1,16 @@
 module Listen
   module Adapter
-
     # Adapter implementation for Windows `wdm`.
     #
     class Windows < Base
-
       # The message to show when wdm gem isn't available
       #
       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|cygwin/i
+          if RbConfig::CONFIG['target_os'] =~ /mswin|mingw|cygwin/i
+            gem 'wdm', '>= 0.1.0'
+          end
       EOS
 
       def self.usable?
@@ -37,13 +37,16 @@ module Listen
       #
       def _init_worker
         WDM::Monitor.new.tap do |worker|
-          _directories_path.each { |path| worker.watch_recursively(path, &_worker_callback) }
+          _directories_path.each do |path|
+            worker.watch_recursively(path, &_worker_callback)
+          end
         end
       end
 
       def _worker_callback
         lambda do |change|
-            _notify_change(_path(change.path), type: 'File', change: _change(change.type))
+          options = { type: 'File', change: _change(change.type) }
+          _notify_change(_path(change.path), options)
         end
       end
 
@@ -60,6 +63,5 @@ module Listen
         nil
       end
     end
-
   end
 end

data/lib/listen/change.rb

@@ -16,7 +16,7 @@ module Listen
       cookie = options[:cookie]
 
       unless cookie
-        #TODO: remove silencing here (it's done later)
+        # TODO: remove silencing here (it's done later)
         return if _silencer.silenced?(path, options[:type])
       end
 
@@ -47,6 +47,5 @@ module Listen
     def _silencer
       listener.registry[:silencer]
     end
-
   end
 end

data/lib/listen/cli.rb

@@ -1,5 +1,6 @@
 require 'thor'
 require 'listen'
+require 'logger'
 
 module Listen
   class CLI < Thor
@@ -8,44 +9,46 @@ module Listen
     desc 'start', 'Starts Listen'
 
     class_option :verbose,
-                  type:    :boolean,
-                  default: false,
-                  aliases: '-v',
-                  banner:  'Verbose'
+                 type:    :boolean,
+                 default: false,
+                 aliases: '-v',
+                 banner:  'Verbose'
 
     class_option :forward,
-                  type:    :string,
-                  default: '127.0.0.1:4000',
-                  aliases: '-f',
-                  banner:  'The address to forward filesystem events'
+                 type:    :string,
+                 default: '127.0.0.1:4000',
+                 aliases: '-f',
+                 banner:  'The address to forward filesystem events'
 
     class_option :directory,
-                  type:    :string,
-                  default: '.',
-                  aliases: '-d',
-                  banner:  'The directory to listen to'
-
-
-  def start
-    Listen::Forwarder.new(options).start
-  end
+                 type:    :string,
+                 default: '.',
+                 aliases: '-d',
+                 banner:  'The directory to listen to'
 
+    def start
+      Listen::Forwarder.new(options).start
+    end
   end
 
   class Forwarder
+    attr_reader :logger
     def initialize(options)
       @options = options
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+      @logger.formatter = proc { |_, _, _, msg| "#{msg}\n" }
     end
 
     def start
-      puts "Starting listen..."
+      logger.info 'Starting listen...'
       address = @options[:forward]
       directory = @options[:directory]
-      callback = Proc.new do |modified, added, removed|
+      callback = proc do |modified, added, removed|
         if @options[:verbose]
-          puts "+ #{added}" unless added.empty?
-          puts "- #{removed}" unless removed.empty?
-          puts "> #{modified}" unless modified.empty?
+          logger.info "+ #{added}" unless added.empty?
+          logger.info "- #{removed}" unless removed.empty?
+          logger.info "> #{modified}" unless modified.empty?
         end
       end