listen 2.7.6 → 2.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 962fc43324f716a5abe1d8acd8ea5df7c87d3d28
-  data.tar.gz: 84b801baff1f5026d64b15df0c9de5fceac572b7
+  metadata.gz: e6d5e368c0d42f2b677a88efcd2b983eb1551278
+  data.tar.gz: 656135661cb4e2c2bd82c9acdbf9d0779a1c707a
 SHA512:
-  metadata.gz: d95876a7d2bd3a39a8130685e2dfa40745ee6ca947646aa303a42b0ab1c4d8bb92347adf2b7e817209840c0a973a813ee5b3d90aafe0db6541361f2fa0d6b5a3
-  data.tar.gz: 3cf94f221c2c4debd84f14a4545ba6caecb45bf6c1d3097ab5482d4ce9e907858aa80d736cc66d54d74e9e100423aca970515ccc0debf89dfb5990f16d169752
+  metadata.gz: d3b07e9530ffa906cf9cc1413dba58b990dc5e720e7c42f4364ac84790e47c43d10bfa5aa5afcbe43e360e1f6c459a5f7ffb15f7dc20ef8467127c6d1c8c93de
+  data.tar.gz: c6e078178e2879ec66de6c54a52542aa973d9de372edda0c8e74356d7fd1377330f569ef8ae73bf61b4f09962fe341d53dec6201bfdd4261275163fcdfb1a035

data/Gemfile

@@ -38,6 +38,8 @@ group :tool do
   gem 'yard', require: false
   gem 'guard-rspec', require: false
   gem 'guard-rubocop'
+  gem 'pry-rescue'
+  gem 'pry-stack_explorer'
 end
 
 group :test do

data/Guardfile

@@ -1,3 +1,5 @@
+ignore(%r{spec/\.fixtures/})
+
 guard :rspec, cmd: 'bundle exec rspec', failed_mode: :keep do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }

data/lib/listen/adapter/base.rb

@@ -1,19 +1,58 @@
+require 'listen/options'
+
 module Listen
   module Adapter
     class Base
       include Celluloid
 
-      attr_accessor :listener
+      attr_reader :options
+
+      # TODO: only used by tests
+      DEFAULTS = {}
+
+      def initialize(opts)
+        @configured = nil
+        options = opts.dup
+        @mq = options.delete(:mq)
+        @directories = options.delete(:directories)
+
+        Array(@directories).each do |dir|
+          next if dir.is_a?(Pathname)
+          fail ArgumentError, "not a Pathname: #{dir.inspect}"
+        end
+
+        # TODO: actually use this in every adapter
+        @recursion = options.delete(:recursion)
+        @recursion = true if @recursion.nil?
 
-      def initialize(listener)
-        @listener = listener
+        defaults = self.class.const_get('DEFAULTS')
+        @options = Listen::Options.new(options, defaults)
       rescue
         _log :error, "adapter config failed: #{$!}:#{$@.join("\n")}"
         raise
       end
 
+      # TODO: it's a separate method as a temporary workaround for tests
+      def configure
+        return if @configured
+        @configured = true
+
+        @callbacks ||= {}
+        @directories.each do |dir|
+          unless dir.is_a?(Pathname)
+            fail ArgumentError, "not a Pathname: #{dir.inspect}"
+          end
+
+          callback = @callbacks[dir] || lambda do |event|
+            _process_event(dir, event)
+          end
+          @callbacks[dir] = callback
+          _configure(dir, &callback)
+        end
+      end
+
       def start
-        _configure
+        configure
         Thread.new do
           begin
             _run
@@ -34,23 +73,10 @@ module Listen
 
       private
 
-      def _configure
-      end
-
-      def _directories
-        listener.directories
-      end
-
-      def _notify_change(type, path, options = {})
-        unless (worker = listener.async(:change_pool))
-          _log :warn, 'Failed to allocate worker from change pool'
-          return
-        end
-
-        worker.change(type, path, options)
-      rescue RuntimeError
-        _log :error, "_notify_change crashed: #{$!}:#{$@.join("\n")}"
-        raise
+      def _queue_change(type, dir, rel_path, options)
+        # TODO: temporary workaround to remove dependency on Change through
+        # Celluloid in tests
+        @mq.send(:_queue_raw_change, type, dir, rel_path, options)
       end
 
       def _log(type, message)

data/lib/listen/adapter/bsd.rb

@@ -7,7 +7,16 @@ module Listen
     class BSD < Base
       OS_REGEXP = /bsd|dragonfly/i
 
-      EVENTS = [:delete, :write, :extend, :attrib, :rename] # :link, :revoke
+      DEFAULTS = {
+        events: [
+          :delete,
+          :write,
+          :extend,
+          :attrib,
+          :rename
+          # :link, :revoke
+        ]
+      }
 
       BUNDLER_DECLARE_GEM = <<-EOS.gsub(/^ {6}/, '')
         Please add the following to your Gemfile to avoid polling for changes:
@@ -47,36 +56,33 @@ module Listen
 
       private
 
-      def _configure
-        @worker = KQueue::Queue.new
-        _directories.each do |path|
-          # use Record to make a snapshot of dir, so we
-          # can detect new files
-          _find(path.to_s) { |file_path| _watch_file(file_path, @worker) }
-        end
+      def _configure(directory, &_callback)
+        @worker ||= KQueue::Queue.new
+        # use Record to make a snapshot of dir, so we
+        # can detect new files
+        _find(directory.to_s) { |path| _watch_file(path, @worker) }
       end
 
       def _run
         @worker.run
       end
 
-      def _worker_callback
-        lambda do |event|
-          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(:dir, path, recursive: true)
-          else
-            _notify_change(:file, path, change: _change(event.flags))
-          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 path.directory?
+      def _process_event(dir, event)
+        full_path = _event_path(event)
+        if full_path.directory?
+          # Force dir content tracking to kick in, or we won't have
+          # names of added files
+          _queue_change(:dir, dir, '.', recursive: true)
+        else
+          path = full_path.relative_path_from(dir)
+          _queue_change(:file, dir, path, change: _change(event.flags))
         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 path.directory?
       end
 
       def _change(event_flags)
@@ -103,7 +109,7 @@ module Listen
       end
 
       def _watch_file(path, queue)
-        queue.watch_file(path, *EVENTS, &_worker_callback)
+        queue.watch_file(path, *options.events, &_worker_callback)
       end
 
       # Quick rubocop workaround

data/lib/listen/adapter/darwin.rb

@@ -6,28 +6,29 @@ module Listen
       OS_REGEXP = /darwin(1.+)?$/i
 
       # The default delay between checking for changes.
-      DEFAULT_LATENCY = 0.1
+      DEFAULTS = { latency: 0.1 }
 
       private
 
-      def _configure
+      def _configure(dir, &callback)
         require 'rb-fsevent'
-        @worker = FSEvent.new
-        @worker.watch(_directories.map(&:to_s), latency: _latency) do |changes|
-          changes.each do |path|
-            new_path = Pathname.new(path.sub(/\/$/, ''))
-            _log :debug, "fsevent: #{new_path}"
-            _notify_change(:dir, new_path)
-          end
-        end
+        @worker ||= FSEvent.new
+        opts = { latency: options.latency }
+        @worker.watch(dir.to_s, opts, &callback)
       end
 
       def _run
         @worker.run
       end
 
-      def _latency
-        listener.options[:latency] || DEFAULT_LATENCY
+      def _process_event(dir, event)
+        event.each do |path|
+          new_path = Pathname.new(path.sub(/\/$/, ''))
+          _log :debug, "fsevent: #{new_path}"
+          # TODO: does this preserve symlinks?
+          rel_path = new_path.relative_path_from(dir).to_s
+          _queue_change(:dir, dir, rel_path, recursive: true)
+        end
       end
     end
   end

data/lib/listen/adapter/linux.rb

@@ -1,31 +1,34 @@
 module Listen
   module Adapter
-    # Listener implementation for Linux `inotify`.
     # @see https://github.com/nex3/rb-inotify
-    #
     class Linux < Base
       OS_REGEXP = /linux/i
 
-      EVENTS = [:recursive, :attrib, :create, :delete, :move, :close_write]
+      DEFAULTS = {
+        events: [
+          :recursive,
+          :attrib,
+          :create,
+          :delete,
+          :move,
+          :close_write
+        ]
+      }
+
+      private
 
       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 #{WIKI_URL}
-        for information on how to solve this issue.
+        Visit #{WIKI_URL} for info on how to fix this.
       EOS
 
-      private
-
-      def _configure
+      def _configure(directory, &callback)
         require 'rb-inotify'
-        @worker = INotify::Notifier.new
-        _directories.each do |path|
-          @worker.watch(path.to_s, *EVENTS, &_callback)
-        end
+        @worker ||= INotify::Notifier.new
+        @worker.watch(directory.to_s, *options.events, &callback)
       rescue Errno::ENOSPC
         # workaround - Celluloid catches abort and prints nothing
         STDERR.puts INOTIFY_LIMIT_MESSAGE
@@ -37,32 +40,38 @@ module Listen
         @worker.run
       end
 
-      def _callback
-        lambda do |event|
-          # NOTE: avoid using event.absolute_name since new API
-          # will need to have a custom recursion implemented
-          # to properly match events to configured directories
-          path = Pathname.new(event.watcher.path) + event.name
-
-          _log :debug, "inotify: #{event.name} #{path} (#{event.flags.inspect})"
-
-          if /1|true/ =~ ENV['LISTEN_GEM_SIMULATE_FSEVENT']
-            if (event.flags & [:moved_to, :moved_from]) || _dir_event?(event)
-              _notify_change(:dir, path.dirname)
-            else
-              _notify_change(:dir, path)
-            end
+      def _process_event(dir, event)
+        # NOTE: avoid using event.absolute_name since new API
+        # will need to have a custom recursion implemented
+        # to properly match events to configured directories
+        path = Pathname.new(event.watcher.path) + event.name
+        rel_path = path.relative_path_from(dir).to_s
+
+        _log :debug, "inotify: #{rel_path} (#{event.flags.inspect})"
+
+        if /1|true/ =~ ENV['LISTEN_GEM_SIMULATE_FSEVENT']
+          if (event.flags & [:moved_to, :moved_from]) || _dir_event?(event)
+            _queue_change(:dir, dir, Pathname(rel_path).dirname, {})
           else
-            next if _skip_event?(event)
-            cookie_opts = event.cookie.zero? ? {} : { cookie: event.cookie }
-            if _dir_event?(event)
-              _notify_change(:dir, path, cookie_opts)
-            else
-              options = { change: _change(event.flags) }
-              _notify_change(:file, path, options.merge(cookie_opts))
-            end
+            _queue_change(:dir, dir, rel_path, {})
           end
+          return
         end
+
+        return if _skip_event?(event)
+
+        cookie_params = event.cookie.zero? ? {} : { cookie: event.cookie }
+
+        # Note: don't pass options to force rescanning the directory, so we can
+        # detect moving/deleting a whole tree
+        if _dir_event?(event)
+          _queue_change(:dir, dir, rel_path, cookie_params)
+          return
+        end
+
+        params = cookie_params.merge(change: _change(event.flags))
+
+        _queue_change(:file, dir, rel_path, params)
       end
 
       def _skip_event?(event)

data/lib/listen/adapter/polling.rb

@@ -6,26 +6,31 @@ module Listen
     # file IO than the other implementations.
     #
     class Polling < Base
-      OS_REGEXP = // # match any
+      OS_REGEXP = // # match every OS
 
-      DEFAULT_POLLING_LATENCY = 1.0
+      DEFAULTS = { latency: 1.0 }
 
       private
 
-      def _latency
-        listener.options[:latency] || DEFAULT_POLLING_LATENCY
+      def _configure(_, &callback)
+        @polling_callbacks ||= []
+        @polling_callbacks << callback
       end
 
       def _run
         loop do
           start = Time.now.to_f
-          _directories.each do |path|
-            _notify_change(:dir, path, recursive: true)
-            nap_time = _latency - (Time.now.to_f - start)
+          @polling_callbacks.each do |callback|
+            callback.call(nil)
+            nap_time = options.latency - (Time.now.to_f - start)
             sleep(nap_time) if nap_time > 0
           end
         end
       end
+
+      def _process_event(dir, _)
+        _queue_change(:dir, dir, '.', recursive: true)
+      end
     end
   end
 end

data/lib/listen/adapter/tcp.rb

@@ -9,15 +9,19 @@ module Listen
       OS_REGEXP = // # match any
 
       include Celluloid::IO
-
       finalizer :finalize
 
+      DEFAULTS = {
+        host: 'localhost',
+        port: '4000'
+      }
+
       attr_reader :buffer, :socket
 
       # Initializes and starts a Celluloid::IO-powered TCP-recipient
       def start
         attempts = 3
-        @socket = TCPSocket.new(listener.host, listener.port)
+        @socket = TCPSocket.new(options.host, options.port)
         @buffer = ''
         async.run
       rescue Celluloid::Task::TerminatedError
@@ -66,8 +70,9 @@ module Listen
 
       # Handles incoming message by notifying of path changes
       def handle_message(message)
-        type, modification, path, _ = message.object
-        _notify_change(type.to_sym, path, change: modification.to_sym)
+        type, change, dir, path, _ = message.object
+        _log :debug, "TCP message: #{[type, change, dir, path].inspect}"
+        _queue_change(type.to_sym, Pathname(dir), path, change: change.to_sym)
       end
 
       def self.local_fs?