listen 3.3.1 → 3.4.1

data/lib/listen/change.rb

@@ -30,13 +30,16 @@ module Listen
     end
 
     # Invalidate some part of the snapshot/record (dir, file, subtree, etc.)
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     def invalidate(type, rel_path, options)
       watched_dir = Pathname.new(record.root)
 
       change = options[:change]
       cookie = options[:cookie]
 
-      if !cookie && config.silenced?(rel_path, type)
+      if !cookie && @config.silenced?(rel_path, type)
         Listen.logger.debug { "(silenced): #{rel_path.inspect}" }
         return
       end
@@ -50,29 +53,17 @@ module Listen
 
       if change
         options = cookie ? { cookie: cookie } : {}
-        config.queue(type, change, watched_dir, rel_path, options)
+        @config.queue(type, change, watched_dir, rel_path, options)
       elsif type == :dir
         # NOTE: POSSIBLE RECURSION
         # TODO: fix - use a queue instead
         Directory.scan(self, rel_path, options)
-      else
-        change = File.change(record, rel_path)
-        return if !change || options[:silence]
-        config.queue(:file, change, watched_dir, rel_path)
+      elsif (change = File.change(record, rel_path)) && !options[:silence]
+        @config.queue(:file, change, watched_dir, rel_path)
       end
-    rescue RuntimeError => ex
-      msg = format(
-        '%s#%s crashed %s:%s',
-        self.class,
-        __method__,
-        exinspect,
-        ex.backtrace * "\n")
-      Listen.logger.error(msg)
-      raise
     end
-
-    private
-
-    attr_reader :config
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
   end
 end

data/lib/listen/cli.rb

@@ -35,6 +35,7 @@ module Listen
 
   class Forwarder
     attr_reader :logger
+
     def initialize(options)
       @options = options
       @logger = ::Logger.new(STDOUT, level: ::Logger::INFO)
@@ -43,6 +44,7 @@ module Listen
 
     def start
       logger.info 'Starting listen...'
+
       directory = @options[:directory]
       relative = @options[:relative]
       callback = proc do |modified, added, removed|
@@ -53,10 +55,7 @@ module Listen
         end
       end
 
-      listener = Listen.to(
-        directory,
-        relative: relative,
-        &callback)
+      listener = Listen.to(directory, relative: relative, &callback)
 
       listener.start
 

data/lib/listen/directory.rb

@@ -5,6 +5,7 @@ require 'set'
 module Listen
   # TODO: refactor (turn it into a normal object, cache the stat, etc)
   class Directory
+    # rubocop:disable Metrics/MethodLength
     def self.scan(snapshot, rel_path, options)
       record = snapshot.record
       dir = Pathname.new(record.root)
@@ -38,22 +39,19 @@ module Listen
       previous = previous.reject { |entry, _| current.include? path + entry }
 
       _async_changes(snapshot, Pathname.new(rel_path), previous, options)
-
     rescue Errno::ENOENT, Errno::EHOSTDOWN
       record.unset_path(rel_path)
       _async_changes(snapshot, Pathname.new(rel_path), previous, options)
-
     rescue Errno::ENOTDIR
       # TODO: path not tested
       record.unset_path(rel_path)
       _async_changes(snapshot, path, previous, options)
       _change(snapshot, :file, rel_path, options)
     rescue
-      Listen.logger.warn do
-        format('scan DIED: %s:%s', $ERROR_INFO, $ERROR_POSITION * "\n")
-      end
+      Listen.logger.warn { format('scan DIED: %s:%s', $ERROR_INFO, $ERROR_POSITION * "\n") }
       raise
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.ascendant_of?(base, other)
       other.ascend do |ascendant|
@@ -88,8 +86,8 @@ module Listen
       # https://github.com/jruby/jruby/issues/3840
       exists = path.exist?
       directory = path.directory?
-      return path.children unless exists && !directory
-      raise Errno::ENOTDIR, path.to_s
+      exists && !directory and raise Errno::ENOTDIR, path.to_s
+      path.children
     end
   end
 end

data/lib/listen/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Besides programming error exceptions like ArgumentError,
+# all public interface exceptions should be declared here and inherit from Listen::Error.
+module Listen
+  class Error < RuntimeError
+    class NotStarted < Error; end
+    class SymlinkLoop < Error; end
+  end
+end

data/lib/listen/event/config.rb

@@ -3,16 +3,15 @@
 module Listen
   module Event
     class Config
-      attr_reader :listener
-      attr_reader :event_queue
-      attr_reader :min_delay_between_events
+      attr_reader :listener, :event_queue, :min_delay_between_events
 
       def initialize(
         listener,
         event_queue,
         queue_optimizer,
         wait_for_delay,
-        &block)
+        &block
+      )
 
         @listener = listener
         @event_queue = event_queue
@@ -26,11 +25,7 @@ module Listen
       end
 
       def call(*args)
-        @block.call(*args) if @block
-      end
-
-      def timestamp
-        Time.now.to_f
+        @block&.call(*args)
       end
 
       def callable?

data/lib/listen/event/loop.rb

@@ -5,15 +5,15 @@ require 'thread'
 require 'timeout'
 require 'listen/event/processor'
 require 'listen/thread'
+require 'listen/error'
 
 module Listen
   module Event
     class Loop
       include Listen::FSM
 
-      class Error < RuntimeError
-        class NotStarted < Error; end
-      end
+      Error = ::Listen::Error
+      NotStarted = ::Listen::Error::NotStarted # for backward compatibility
 
       start_state :pre_start
       state :pre_start
@@ -40,6 +40,7 @@ module Listen
 
       MAX_STARTUP_SECONDS = 5.0
 
+      # @raises Error::NotStarted if background thread hasn't started in MAX_STARTUP_SECONDS
       def start
         # TODO: use a Fiber instead?
         return unless state == :pre_start
@@ -52,7 +53,7 @@ module Listen
 
         Listen.logger.debug("Waiting for processing to start...")
 
-        wait_for_state(:started, MAX_STARTUP_SECONDS) or
+        wait_for_state(:started, timeout: MAX_STARTUP_SECONDS) or
           raise Error::NotStarted, "thread didn't start in #{MAX_STARTUP_SECONDS} seconds (in state: #{state.inspect})"
 
         Listen.logger.debug('Processing started.')

data/lib/listen/event/processor.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'listen/monotonic_time'
+
 module Listen
   module Event
     class Processor
@@ -33,7 +35,7 @@ module Listen
 
       def _wait_until_events_calm_down
         loop do
-          now = _timestamp
+          now = MonotonicTime.now
 
           # Assure there's at least latency between callbacks to allow
           # for accumulating changes
@@ -51,10 +53,10 @@ module Listen
       end
 
       def _check_stopped
-        return unless @listener.stopped?
-
-        _flush_wakeup_reasons
-        raise Stopped
+        if @listener.stopped?
+          _flush_wakeup_reasons
+          raise Stopped
+        end
       end
 
       def _sleep(seconds)
@@ -70,22 +72,22 @@ module Listen
       end
 
       def _remember_time_of_first_unprocessed_event
-        @first_unprocessed_event_time ||= _timestamp
+        @_remember_time_of_first_unprocessed_event ||= MonotonicTime.now
       end
 
       def _reset_no_unprocessed_events
-        @first_unprocessed_event_time = nil
+        @_remember_time_of_first_unprocessed_event = nil
       end
 
       def _deadline
-        @first_unprocessed_event_time + @latency
+        @_remember_time_of_first_unprocessed_event + @latency
       end
 
       # blocks until event is popped
       # returns the event or `nil` when the event_queue is closed
       def _wait_until_events
         config.event_queue.pop.tap do |_event|
-          @first_unprocessed_event_time ||= _timestamp
+          @_remember_time_of_first_unprocessed_event ||= MonotonicTime.now
         end
       end
 
@@ -96,10 +98,6 @@ module Listen
         end
       end
 
-      def _timestamp
-        config.timestamp
-      end
-
       # for easier testing without sleep loop
       def _process_changes(event)
         _reset_no_unprocessed_events
@@ -113,13 +111,13 @@ module Listen
         result = [hash[:modified], hash[:added], hash[:removed]]
         return if result.all?(&:empty?)
 
-        block_start = _timestamp
+        block_start = MonotonicTime.now
         exception_note = " (exception)"
         ::Listen::Thread.rescue_and_log('_process_changes') do
           config.call(*result)
           exception_note = nil
         end
-        Listen.logger.debug "Callback#{exception_note} took #{_timestamp - block_start} sec"
+        Listen.logger.debug "Callback#{exception_note} took #{MonotonicTime.now - block_start} sec"
       end
 
       attr_reader :config

data/lib/listen/event/queue.rb

@@ -30,21 +30,21 @@ module Listen
         fail "Invalid change: #{change.inspect}" unless change.is_a?(Symbol)
         fail "Invalid path: #{path.inspect}" unless path.is_a?(String)
 
-        dir = _safe_relative_from_cwd(dir)
-        event_queue.public_send(:<<, [type, change, dir, path, options])
+        dir = if @config.relative?
+          _safe_relative_from_cwd(dir)
+        else
+          dir
+        end
+        @event_queue << [type, change, dir, path, options]
       end
 
-      delegate empty?: :event_queue
-      delegate pop: :event_queue
-      delegate close: :event_queue
+      delegate empty?: :@event_queue
+      delegate pop: :@event_queue
+      delegate close: :@event_queue
 
       private
 
-      attr_reader :event_queue
-      attr_reader :config
-
       def _safe_relative_from_cwd(dir)
-        return dir unless config.relative?
         dir.relative_path_from(Pathname.pwd)
       rescue ArgumentError
         dir

data/lib/listen/file.rb

@@ -4,6 +4,9 @@ require 'digest/md5'
 
 module Listen
   class File
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     def self.change(record, rel_path)
       path = Pathname.new(record.root) + rel_path
       lstat = path.lstat
@@ -74,6 +77,9 @@ module Listen
       Listen.logger.debug "lstat failed for: #{rel_path} (#{$ERROR_INFO})"
       raise
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def self.inaccurate_mac_time?(stat)
       # 'mac' means Modified/Accessed/Created

data/lib/listen/fsm.rb

@@ -53,6 +53,9 @@ module Listen
     # if not already, waits for a state change (up to timeout seconds--`nil` means infinite)
     # returns truthy iff the transition to one of the desired state has occurred
     def wait_for_state(*wait_for_states, timeout: nil)
+      wait_for_states.each do |state|
+        state.is_a?(Symbol) or raise ArgumentError, "states must be symbols (got #{state.inspect})"
+      end
       @mutex.synchronize do
         if !wait_for_states.include?(@state)
           @state_changed.wait(@mutex, timeout)
@@ -113,8 +116,8 @@ module Listen
         @name = name
         @block = block
         @transitions = if transitions
-                         Array(transitions).map(&:to_sym)
-                       end
+          Array(transitions).map(&:to_sym)
+        end
       end
 
       def call(obj)

data/lib/listen/listener.rb

@@ -33,6 +33,7 @@ module Listen
     # @yieldparam [Array<String>] added the list of added files
     # @yieldparam [Array<String>] removed the list of removed files
     #
+    # rubocop:disable Metrics/MethodLength
     def initialize(*dirs, &block)
       options = dirs.last.is_a?(Hash) ? dirs.pop : {}
 
@@ -60,6 +61,7 @@ module Listen
 
       initialize_fsm
     end
+    # rubocop:enable Metrics/MethodLength
 
     start_state :initializing
 

data/lib/listen/listener/config.rb

@@ -25,9 +25,7 @@ module Listen
         @relative
       end
 
-      attr_reader :min_delay_between_events
-
-      attr_reader :silencer_rules
+      attr_reader :min_delay_between_events, :silencer_rules
 
       def adapter_instance_options(klass)
         valid_keys = klass.const_get('DEFAULTS').keys
@@ -35,7 +33,7 @@ module Listen
       end
 
       def adapter_select_options
-        valid_keys = %w(force_polling polling_fallback_message).map(&:to_sym)
+        valid_keys = %w[force_polling polling_fallback_message].map(&:to_sym)
         Hash[@options.select { |key, _| valid_keys.include?(key) }]
       end
     end

data/lib/listen/logger.rb

@@ -16,18 +16,19 @@ module Listen
     private
 
     def default_logger
-      level = case ENV['LISTEN_GEM_DEBUGGING'].to_s
-              when /debug|2/i
-                ::Logger::DEBUG
-              when /info|true|yes|1/i
-                ::Logger::INFO
-              when /warn/i
-                ::Logger::WARN
-              when /fatal/i
-                ::Logger::FATAL
-              else
-                ::Logger::ERROR
-              end
+      level =
+        case ENV['LISTEN_GEM_DEBUGGING'].to_s
+        when /debug|2/i
+          ::Logger::DEBUG
+        when /info|true|yes|1/i
+          ::Logger::INFO
+        when /warn/i
+          ::Logger::WARN
+        when /fatal/i
+          ::Logger::FATAL
+        else
+          ::Logger::ERROR
+        end
 
       ::Logger.new(STDERR, level: level)
     end

data/lib/listen/monotonic_time.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Listen
+  module MonotonicTime
+    class << self
+      if defined?(Process::CLOCK_MONOTONIC)
+
+        def now
+          Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        end
+
+      elsif defined?(Process::CLOCK_MONOTONIC_RAW)
+
+        def now
+          Process.clock_gettime(Process::CLOCK_MONOTONIC_RAW)
+        end
+
+      else
+
+        def now
+          Time.now.to_f
+        end
+
+      end
+    end
+  end
+end