listen 3.0.2 → 3.8.0

data/lib/listen/adapter/base.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 require 'listen/options'
 require 'listen/record'
 require 'listen/change'
+require 'listen/thread'
 
 module Listen
   module Adapter
     class Base
-      attr_reader :options
+      attr_reader :options, :config
 
       # TODO: only used by tests
-      DEFAULTS = {}
-
-      attr_reader :config
+      DEFAULTS = {}.freeze
 
       def initialize(config)
         @started = false
@@ -28,9 +29,10 @@ module Listen
       end
 
       # TODO: it's a separate method as a temporary workaround for tests
+      # rubocop:disable Metrics/MethodLength
       def configure
         if @configured
-          _log(:warn, 'Adapter already configured!')
+          Listen.logger.warn('Adapter already configured!')
           return
         end
 
@@ -49,11 +51,12 @@ module Listen
         # TODO: separate config per directory (some day maybe)
         change_config = Change::Config.new(config.queue, config.silencer)
         config.directories.each do |dir|
-          record = Record.new(dir)
+          record = Record.new(dir, config.silencer)
           snapshot = Change.new(change_config, record)
           @snapshots[dir] = snapshot
         end
       end
+      # rubocop:enable Metrics/MethodLength
 
       def started?
         @started
@@ -63,41 +66,39 @@ module Listen
         configure
 
         if started?
-          _log(:warn, 'Adapter already started!')
+          Listen.logger.warn('Adapter already started!')
           return
         end
 
         @started = true
 
-        calling_stack = caller.dup
-        Listen::Internals::ThreadPool.add do
-          begin
-            @snapshots.values.each do |snapshot|
-              _timed('Record.build()') { snapshot.record.build }
-            end
-            _run
-          rescue
-            msg = 'run() in thread failed: %s:\n'\
-              ' %s\n\ncalled from:\n %s'
-            _log_exception(msg, calling_stack)
-            raise # for unit tests mostly
+        @run_thread = Listen::Thread.new("run_thread") do
+          @snapshots.each_value do |snapshot|
+            _timed('Record.build()') { snapshot.record.build }
           end
+          _run
         end
       end
 
-      def self.usable?
-        const_get('OS_REGEXP') =~ RbConfig::CONFIG['target_os']
+      def stop
+        _stop
+        config.queue.close # this causes queue.pop to return `nil` to the front-end
       end
 
       private
 
+      def _stop
+        @run_thread&.kill
+        @run_thread = nil
+      end
+
       def _timed(title)
-        start = Time.now.to_f
+        start = MonotonicTime.now
         yield
-        diff = Time.now.to_f - start
-        Listen::Logger.info format('%s: %.05f seconds', title, diff)
+        diff = MonotonicTime.now - start
+        Listen.logger.info format('%s: %.05f seconds', title, diff)
       rescue
-        Listen::Logger.warn "#{title} crashed: #{$ERROR_INFO.inspect}"
+        Listen.logger.warn "#{title} crashed: #{$ERROR_INFO.inspect}"
         raise
       end
 
@@ -107,10 +108,6 @@ module Listen
         @snapshots[dir].invalidate(type, rel_path, options)
       end
 
-      def _log(*args, &block)
-        self.class.send(:_log, *args, &block)
-      end
-
       def _log_exception(msg, caller_stack)
         formatted = format(
           msg,
@@ -119,11 +116,13 @@ module Listen
           caller_stack * "\n"
         )
 
-        _log(:error, formatted)
+        Listen.logger.error(formatted)
       end
 
-      def self._log(*args, &block)
-        Listen::Logger.send(*args, &block)
+      class << self
+        def usable?
+          const_get('OS_REGEXP') =~ RbConfig::CONFIG['target_os']
+        end
       end
     end
   end

data/lib/listen/adapter/bsd.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -5,7 +7,7 @@
 module Listen
   module Adapter
     class BSD < Base
-      OS_REGEXP = /bsd|dragonfly/i
+      OS_REGEXP = /bsd|dragonfly/i.freeze
 
       DEFAULTS = {
         events: [
@@ -16,7 +18,7 @@ module Listen
           :rename
           # :link, :revoke
         ]
-      }
+      }.freeze
 
       BUNDLER_DECLARE_GEM = <<-EOS.gsub(/^ {6}/, '')
         Please add the following to your Gemfile to avoid polling for changes:
@@ -38,9 +40,9 @@ module Listen
 
       private
 
-      def _configure(directory, &_callback)
+      def _configure(directory, &callback)
         @worker ||= KQueue::Queue.new
-        @callback = _callback
+        @callback = callback
         # use Record to make a snapshot of dir, so we
         # can detect new files
         _find(directory.to_s) { |path| _watch_file(path, @worker) }
@@ -71,8 +73,7 @@ module Listen
       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
@@ -85,7 +86,7 @@ module Listen
       def _watch_for_new_file(event)
         queue = event.watcher.queue
         _find(_event_path(event).to_s) do |file_path|
-          unless queue.watchers.detect { |_, v| v.path == file_path.to_s }
+          unless queue.watchers.find { |_, v| v.path == file_path.to_s }
             _watch_file(file_path, queue)
           end
         end
@@ -94,7 +95,7 @@ module Listen
       def _watch_file(path, queue)
         queue.watch_file(path, *options.events, &@callback)
       rescue Errno::ENOENT => e
-        _log :warn, "kqueue: watch file failed: #{e.message}"
+        Listen.logger.warn "kqueue: watch file failed: #{e.message}"
       end
 
       # Quick rubocop workaround

data/lib/listen/adapter/config.rb

@@ -1,19 +1,27 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module Listen
   module Adapter
     class Config
-      attr_reader :directories
-      attr_reader :silencer
-      attr_reader :queue
-      attr_reader :adapter_options
+      attr_reader :directories, :silencer, :queue, :adapter_options
 
       def initialize(directories, queue, silencer, adapter_options)
+        # Default to current directory if no directories are supplied
+        directories = [Dir.pwd] if directories.to_a.empty?
+
         # TODO: fix (flatten, array, compact?)
         @directories = directories.map do |directory|
           Pathname.new(directory.to_s).realpath
         end
 
+        @directories.each do |pathname|
+          unless pathname.directory?
+            fail ArgumentError, "must be a directory: #{pathname}"
+          end
+        end
+
         @silencer = silencer
         @queue = queue
         @adapter_options = adapter_options

data/lib/listen/adapter/darwin.rb

@@ -1,52 +1,76 @@
-require 'listen/internals/thread_pool'
+# frozen_string_literal: true
+
+require 'listen/thread'
 
 module Listen
   module Adapter
     # Adapter implementation for Mac OS X `FSEvents`.
     #
     class Darwin < Base
-      OS_REGEXP = /darwin(1.+)?$/i
+      OS_REGEXP = /darwin(?<major_version>(1|2)\d+)/i.freeze
 
       # The default delay between checking for changes.
-      DEFAULTS = { latency: 0.1 }
+      DEFAULTS = { latency: 0.1 }.freeze
 
-      private
+      INCOMPATIBLE_GEM_VERSION = <<-EOS.gsub(/^ {8}/, '')
+        rb-fsevent > 0.9.4 no longer supports OS X 10.6 through 10.8.
+
+        Please add the following to your Gemfile to avoid polling for changes:
+          require 'rbconfig'
+          if RbConfig::CONFIG['target_os'] =~ /darwin(1[0-3])/i
+            gem 'rb-fsevent', '<= 0.9.4'
+          end
+      EOS
+
+      def self.usable?
+        version = RbConfig::CONFIG['target_os'][OS_REGEXP, :major_version]
+        return false unless version
+        return true if version.to_i >= 13 # darwin13 is OS X 10.9
 
-      # NOTE: each directory gets a DIFFERENT callback!
-      def _configure(dir, &callback)
         require 'rb-fsevent'
-        opts = { latency: options.latency }
+        fsevent_version = Gem::Version.new(FSEvent::VERSION)
+        return true if fsevent_version <= Gem::Version.new('0.9.4')
+        Kernel.warn INCOMPATIBLE_GEM_VERSION
+        false
+      end
 
-        @workers ||= Queue.new
-        @workers << FSEvent.new.tap do |worker|
-          worker.watch(dir.to_s, opts, &callback)
-        end
+      private
+
+      def _configure(dir, &callback)
+        @callbacks[dir] = callback
       end
 
-      # NOTE: _run is called within a thread, so run every other
-      # worker in it's own thread
       def _run
-        first = @workers.pop
-        until @workers.empty?
-          Listen::Internals::ThreadPool.add do
-            begin
-              @workers.pop.run
-            rescue
-              _log_exception 'run() in extra thread(s) failed: %s: %s'
+        require 'rb-fsevent'
+        worker = FSEvent.new
+        dirs_to_watch = @callbacks.keys.map(&:to_s)
+        Listen.logger.info { "fsevent: watching: #{dirs_to_watch.inspect}" }
+        worker.watch(dirs_to_watch, { latency: options.latency }, &method(:_process_changes))
+        @worker_thread = Listen::Thread.new("worker_thread") { worker.run }
+      end
+
+      def _process_changes(dirs)
+        dirs.each do |dir|
+          dir = Pathname.new(dir.sub(%r{/$}, ''))
+
+          @callbacks.each do |watched_dir, callback|
+            if watched_dir.eql?(dir) || Listen::Directory.ascendant_of?(watched_dir, dir)
+              callback.call(dir)
             end
           end
         end
-        first.run
       end
 
-      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
+      def _process_event(dir, path)
+        Listen.logger.debug { "fsevent: processing path: #{path.inspect}" }
+        # TODO: does this preserve symlinks?
+        rel_path = path.relative_path_from(dir).to_s
+        _queue_change(:dir, dir, rel_path, recursive: true)
+      end
+
+      def _stop
+        @worker_thread&.kill
+        super
       end
     end
   end

data/lib/listen/adapter/linux.rb

@@ -1,43 +1,44 @@
+# frozen_string_literal: true
+
 module Listen
   module Adapter
     # @see https://github.com/nex3/rb-inotify
     class Linux < Base
-      OS_REGEXP = /linux/i
+      OS_REGEXP = /linux/i.freeze
 
       DEFAULTS = {
         events: [
           :recursive,
           :attrib,
           :create,
+          :modify,
           :delete,
           :move,
           :close_write
         ],
         wait_for_delay: 0.1
-      }
+      }.freeze
 
       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.
-        Visit #{WIKI_URL} for info on how to fix this.
-      EOS
+      README_URL = 'https://github.com/guard/listen'\
+        '/blob/master/README.md#increasing-the-amount-of-inotify-watchers'
 
       def _configure(directory, &callback)
-        Kernel.require 'rb-inotify'
+        require 'rb-inotify'
         @worker ||= ::INotify::Notifier.new
         @worker.watch(directory.to_s, *options.events, &callback)
       rescue Errno::ENOSPC
-        abort(INOTIFY_LIMIT_MESSAGE)
+        raise ::Listen::Error::INotifyMaxWatchesExceeded, <<~EOS
+          Unable to monitor directories for changes because iNotify max watches exceeded. See #{README_URL} .
+        EOS
       end
 
       def _run
         @worker.run
       end
 
+      # rubocop:disable Metrics/MethodLength
       def _process_event(dir, event)
         # NOTE: avoid using event.absolute_name since new API
         # will need to have a custom recursion implemented
@@ -45,15 +46,13 @@ module Listen
         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})" }
+        Listen.logger.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)
             rel_path = path.dirname.relative_path_from(dir).to_s
-            _queue_change(:dir, dir, rel_path, {})
-          else
-            _queue_change(:dir, dir, rel_path, {})
           end
+          _queue_change(:dir, dir, rel_path, {})
           return
         end
 
@@ -72,6 +71,7 @@ module Listen
 
         _queue_change(:file, dir, rel_path, params)
       end
+      # rubocop:enable Metrics/MethodLength
 
       def _skip_event?(event)
         # Event on root directory
@@ -97,6 +97,12 @@ module Listen
       def _dir_event?(event)
         event.flags.include?(:isdir)
       end
+
+      def _stop
+        @worker&.close
+
+        super
+      end
     end
   end
 end

data/lib/listen/adapter/polling.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   module Adapter
     # Polling Adapter that works cross-platform and
@@ -6,9 +8,9 @@ module Listen
     # file IO than the other implementations.
     #
     class Polling < Base
-      OS_REGEXP = // # match every OS
+      OS_REGEXP = //.freeze # match every OS
 
-      DEFAULTS = { latency: 1.0, wait_for_delay: 0.05 }
+      DEFAULTS = { latency: 1.0, wait_for_delay: 0.05 }.freeze
 
       private
 
@@ -19,12 +21,13 @@ module Listen
 
       def _run
         loop do
-          start = Time.now.to_f
+          start = MonotonicTime.now
           @polling_callbacks.each do |callback|
             callback.call(nil)
-            nap_time = options.latency - (Time.now.to_f - start)
-            # TODO: warn if nap_time is negative (polling too slow)
-            sleep(nap_time) if nap_time > 0
+            if (nap_time = options.latency - (MonotonicTime.now - start)) > 0
+              # TODO: warn if nap_time is negative (polling too slow)
+              sleep(nap_time)
+            end
           end
         end
       end

data/lib/listen/adapter/windows.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Listen
   module Adapter
     # Adapter implementation for Windows `wdm`.
     #
     class Windows < Base
-      OS_REGEXP = /mswin|mingw|cygwin/i
+      OS_REGEXP = /mswin|mingw|cygwin/i.freeze
 
       BUNDLER_DECLARE_GEM = <<-EOS.gsub(/^ {6}/, '')
         Please add the following to your Gemfile to avoid polling for changes:
@@ -15,8 +17,8 @@ module Listen
         require 'wdm'
         true
       rescue LoadError
-        _log :debug, format('wdm - load failed: %s:%s', $ERROR_INFO,
-                            $ERROR_POSITION * "\n")
+        Listen.logger.debug format('wdm - load failed: %s:%s', $ERROR_INFO,
+                                   $ERROR_POSITION * "\n")
 
         Kernel.warn BUNDLER_DECLARE_GEM
         false
@@ -24,21 +26,20 @@ module Listen
 
       private
 
-      def _configure(dir, &callback)
+      def _configure(dir)
         require 'wdm'
-        _log :debug, 'wdm - starting...'
+        Listen.logger.debug 'wdm - starting...'
         @worker ||= WDM::Monitor.new
         @worker.watch_recursively(dir.to_s, :files) do |change|
-          callback.call([:file, change])
+          yield([:file, change])
         end
 
         @worker.watch_recursively(dir.to_s, :directories) do |change|
-          callback.call([:dir, change])
+          yield([:dir, change])
         end
 
-        events = [:attributes, :last_write]
-        @worker.watch_recursively(dir.to_s, *events) do |change|
-          callback.call([:attr, change])
+        @worker.watch_recursively(dir.to_s, :attributes, :last_write) do |change|
+          yield([:attr, change])
         end
       end
 
@@ -46,8 +47,9 @@ module Listen
         @worker.run!
       end
 
+      # rubocop:disable Metrics/MethodLength
       def _process_event(dir, event)
-        _log :debug, "wdm - callback: #{event.inspect}"
+        Listen.logger.debug "wdm - callback: #{event.inspect}"
 
         type, change = event
 
@@ -65,12 +67,12 @@ module Listen
             _queue_change(:file, dir, rel_path, options)
           end
         when :dir
-          if change.type == :removed
+          case change.type
+          when :removed
             # TODO: check if watched dir?
             _queue_change(:dir, dir, Pathname(rel_path).dirname.to_s, {})
-          elsif change.type == :added
+          when :added
             _queue_change(:dir, dir, rel_path, {})
-          else
             # do nothing - changed directory means either:
             #   - removed subdirs (handled above)
             #   - added subdirs (handled above)
@@ -79,20 +81,15 @@ module Listen
             # so what's left?
           end
         end
-      rescue
-        details = event.inspect
-        _log :error, format('wdm - callback (%): %s:%s', details, $ERROR_INFO,
-                            $ERROR_POSITION * "\n")
-        raise
       end
+      # rubocop:enable Metrics/MethodLength
 
       def _change(type)
         { modified: [:modified, :attrib], # TODO: is attrib really passed?
           added:    [:added, :renamed_new_file],
-          removed:  [:removed, :renamed_old_file] }.each do |change, types|
-          return change if types.include?(type)
+          removed:  [:removed, :renamed_old_file] }.find do |change, types|
+          types.include?(type) and break change
         end
-        nil
       end
     end
   end

data/lib/listen/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'listen/adapter/base'
 require 'listen/adapter/bsd'
 require 'listen/adapter/darwin'
@@ -7,37 +9,35 @@ require 'listen/adapter/windows'
 
 module Listen
   module Adapter
-    OPTIMIZED_ADAPTERS = [Darwin, Linux, BSD, Windows]
+    OPTIMIZED_ADAPTERS = [Darwin, Linux, BSD, Windows].freeze
     POLLING_FALLBACK_MESSAGE = 'Listen will be polling for changes.'\
       'Learn more at https://github.com/guard/listen#listen-adapters.'
 
-    def self.select(options = {})
-      _log :debug, 'Adapter: considering polling ...'
-      return Polling if options[:force_polling]
-      _log :debug, 'Adapter: considering optimized backend...'
-      return _usable_adapter_class if _usable_adapter_class
-      _log :debug, 'Adapter: falling back to polling...'
-      _warn_polling_fallback(options)
-      Polling
-    rescue
-      _log :warn, format('Adapter: failed: %s:%s', $ERROR_POSITION.inspect,
-                         $ERROR_POSITION * "\n")
-      raise
-    end
+    class << self
+      def select(options = {})
+        Listen.logger.debug 'Adapter: considering polling ...'
+        return Polling if options[:force_polling]
+        Listen.logger.debug 'Adapter: considering optimized backend...'
+        return _usable_adapter_class if _usable_adapter_class
+        Listen.logger.debug 'Adapter: falling back to polling...'
+        _warn_polling_fallback(options)
+        Polling
+      rescue
+        Listen.logger.warn format('Adapter: failed: %s:%s', $ERROR_POSITION.inspect,
+                                  $ERROR_POSITION * "\n")
+        raise
+      end
 
-    private
+      private
 
-    def self._usable_adapter_class
-      OPTIMIZED_ADAPTERS.detect(&:usable?)
-    end
-
-    def self._warn_polling_fallback(options)
-      msg = options.fetch(:polling_fallback_message, POLLING_FALLBACK_MESSAGE)
-      Kernel.warn "[Listen warning]:\n  #{msg}" if msg
-    end
+      def _usable_adapter_class
+        OPTIMIZED_ADAPTERS.find(&:usable?)
+      end
 
-    def self._log(type, message)
-      Listen::Logger.send(type, message)
+      def _warn_polling_fallback(options)
+        msg = options.fetch(:polling_fallback_message, POLLING_FALLBACK_MESSAGE)
+        Kernel.warn "[Listen warning]:\n  #{msg}" if msg
+      end
     end
   end
 end

data/lib/listen/backend.rb

@@ -1,11 +1,17 @@
+# frozen_string_literal: true
+
 require 'listen/adapter'
 require 'listen/adapter/base'
 require 'listen/adapter/config'
 
+require 'forwardable'
+
 # This class just aggregates configuration object to avoid Listener specs
 # from exploding with huge test setup blocks
 module Listen
   class Backend
+    extend Forwardable
+
     def initialize(directories, queue, silencer, config)
       adapter_select_opts = config.adapter_select_options
 
@@ -22,17 +28,10 @@ module Listen
       @adapter = adapter_class.new(aconfig)
     end
 
-    def start
-      adapter.start
-    end
+    delegate start: :adapter
+    delegate stop: :adapter
 
-    def stop
-      # TODO: does nothing
-    end
-
-    def min_delay_between_events
-      @min_delay_between_events
-    end
+    attr_reader :min_delay_between_events
 
     private