listen 3.1.5 → 3.8.0

data/lib/listen/fsm.rb

@@ -1,120 +1,123 @@
+# frozen_string_literal: true
+
 # Code copied from https://github.com/celluloid/celluloid-fsm
+
+require 'thread'
+
 module Listen
   module FSM
-    DEFAULT_STATE = :default # Default state name unless one is explicitly set
-
     # Included hook to extend class methods
     def self.included(klass)
       klass.send :extend, ClassMethods
     end
 
     module ClassMethods
-      # Obtain or set the default state
-      # Passing a state name sets the default state
-      def default_state(new_default = nil)
-        if new_default
-          @default_state = new_default.to_sym
+      # Obtain or set the start state
+      # Passing a state name sets the start state
+      def start_state(new_start_state = nil)
+        if new_start_state
+          new_start_state.is_a?(Symbol) or raise ArgumentError, "state name must be a Symbol (got #{new_start_state.inspect})"
+          @start_state = new_start_state
         else
-          defined?(@default_state) ? @default_state : DEFAULT_STATE
+          defined?(@start_state) or raise ArgumentError, "`start_state :<state>` must be declared before `new`"
+          @start_state
         end
       end
 
-      # Obtain the valid states for this FSM
+      # The valid states for this FSM, as a hash with state name symbols as keys and State objects as values.
       def states
         @states ||= {}
       end
 
-      # Declare an FSM state and optionally provide a callback block to fire
+      # Declare an FSM state and optionally provide a callback block to fire on state entry
       # Options:
       # * to: a state or array of states this state can transition to
-      def state(*args, &block)
-        if args.last.is_a? Hash
-          # Stringify keys :/
-          options = args.pop.each_with_object({}) { |(k, v), h| h[k.to_s] = v }
-        else
-          options = {}
-        end
-
-        args.each do |name|
-          name = name.to_sym
-          default_state name if options['default']
-          states[name] = State.new(name, options['to'], &block)
-        end
+      def state(state_name, to: nil, &block)
+        state_name.is_a?(Symbol) or raise ArgumentError, "state name must be a Symbol (got #{state_name.inspect})"
+        states[state_name] = State.new(state_name, to, &block)
       end
     end
 
-    # Be kind and call super if you must redefine initialize
-    def initialize
-      @state = self.class.default_state
+    # Note: including classes must call initialize_fsm from their initialize method.
+    def initialize_fsm
+      @fsm_initialized = true
+      @state = self.class.start_state
+      @mutex = ::Mutex.new
+      @state_changed = ::ConditionVariable.new
     end
 
-    # Obtain the current state of the FSM
+    # Current state of the FSM, stored as a symbol
     attr_reader :state
 
-    def transition(state_name)
-      new_state = validate_and_sanitize_new_state(state_name)
-      return unless new_state
-      transition_with_callbacks!(new_state)
+    # checks for one of the given states to wait for
+    # 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)
+        end
+        wait_for_states.include?(@state)
+      end
     end
 
-    # Immediate state transition with no checks, or callbacks. "Dangerous!"
-    def transition!(state_name)
-      @state = state_name
-    end
+    private
 
-    protected
+    def transition(new_state_name)
+      new_state_name.is_a?(Symbol) or raise ArgumentError, "state name must be a Symbol (got #{new_state_name.inspect})"
+      if (new_state = validate_and_sanitize_new_state(new_state_name))
+        transition_with_callbacks!(new_state)
+      end
+    end
 
-    def validate_and_sanitize_new_state(state_name)
-      state_name = state_name.to_sym
+    # Low-level, immediate state transition with no checks or callbacks.
+    def transition!(new_state_name)
+      new_state_name.is_a?(Symbol) or raise ArgumentError, "state name must be a Symbol (got #{new_state_name.inspect})"
+      @fsm_initialized or raise ArgumentError, "FSM not initialized. You must call initialize_fsm from initialize!"
+      @mutex.synchronize do
+        yield if block_given?
+        @state = new_state_name
+        @state_changed.broadcast
+      end
+    end
 
-      return if current_state_name == state_name
+    def validate_and_sanitize_new_state(new_state_name)
+      return nil if @state == new_state_name
 
-      if current_state && !current_state.valid_transition?(state_name)
+      if current_state && !current_state.valid_transition?(new_state_name)
         valid = current_state.transitions.map(&:to_s).join(', ')
-        msg = "#{self.class} can't change state from '#{@state}'"\
-          " to '#{state_name}', only to: #{valid}"
-        fail ArgumentError, msg
+        msg = "#{self.class} can't change state from '#{@state}' to '#{new_state_name}', only to: #{valid}"
+        raise ArgumentError, msg
       end
 
-      new_state = states[state_name]
-
-      unless new_state
-        return if state_name == default_state
-        fail ArgumentError, "invalid state for #{self.class}: #{state_name}"
+      unless (new_state = self.class.states[new_state_name])
+        new_state_name == self.class.start_state or raise ArgumentError, "invalid state for #{self.class}: #{new_state_name}"
       end
 
       new_state
     end
 
-    def transition_with_callbacks!(state_name)
-      transition! state_name.name
-      state_name.call(self)
-    end
-
-    def states
-      self.class.states
-    end
-
-    def default_state
-      self.class.default_state
+    def transition_with_callbacks!(new_state)
+      transition! new_state.name
+      new_state.call(self)
     end
 
     def current_state
-      states[@state]
-    end
-
-    def current_state_name
-      current_state && current_state.name || ''
+      self.class.states[@state]
     end
 
     class State
       attr_reader :name, :transitions
 
-      def initialize(name, transitions = nil, &block)
+      def initialize(name, transitions, &block)
         @name = name
         @block = block
-        @transitions = nil
-        @transitions = Array(transitions).map(&:to_sym) if transitions
+        @transitions = if transitions
+          Array(transitions).map(&:to_sym)
+        end
       end
 
       def call(obj)
@@ -122,10 +125,8 @@ module Listen
       end
 
       def valid_transition?(new_state)
-        # All transitions are allowed unless expressly
-        return true unless @transitions
-
-        @transitions.include? new_state.to_sym
+        # All transitions are allowed if none are expressly declared
+        !@transitions || @transitions.include?(new_state.to_sym)
       end
     end
   end

data/lib/listen/listener/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   class Listener
     class Config
@@ -23,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
@@ -33,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/listener.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'English'
 
 require 'listen/version'
@@ -19,7 +21,6 @@ require 'listen/listener/config'
 
 module Listen
   class Listener
-    # TODO: move the state machine's methods private
     include Listen::FSM
 
     # Initializes the directories listener.
@@ -32,13 +33,14 @@ 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 : {}
 
       @config = Config.new(options)
 
       eq_config = Event::Queue::Config.new(@config.relative?)
-      queue = Event::Queue.new(eq_config) { @processor.wakeup_on_event }
+      queue = Event::Queue.new(eq_config)
 
       silencer = Silencer.new
       rules = @config.silencer_rules
@@ -57,41 +59,43 @@ module Listen
 
       @processor = Event::Loop.new(pconfig)
 
-      super() # FSM
+      initialize_fsm
     end
+    # rubocop:enable Metrics/MethodLength
 
-    default_state :initializing
+    start_state :initializing
 
     state :initializing, to: [:backend_started, :stopped]
 
-    state :backend_started, to: [:frontend_ready, :stopped] do
-      backend.start
-    end
-
-    state :frontend_ready, to: [:processing_events, :stopped] do
-      processor.setup
+    state :backend_started, to: [:processing_events, :stopped] do
+      @backend.start
     end
 
     state :processing_events, to: [:paused, :stopped] do
-      processor.resume
+      @processor.start
     end
 
     state :paused, to: [:processing_events, :stopped] do
-      processor.pause
+      @processor.pause
     end
 
     state :stopped, to: [:backend_started] do
-      backend.stop # should be before processor.teardown to halt events ASAP
-      processor.teardown
+      @backend.stop # halt events ASAP
+      @processor.stop
     end
 
     # Starts processing events and starts adapters
     # or resumes invoking callbacks if paused
     def start
-      transition :backend_started if state == :initializing
-      transition :frontend_ready if state == :backend_started
-      transition :processing_events if state == :frontend_ready
-      transition :processing_events if state == :paused
+      case state
+      when :initializing
+        transition :backend_started
+        transition :processing_events
+      when :paused
+        transition :processing_events
+      else
+        raise ArgumentError, "cannot start from state #{state.inspect}"
+      end
     end
 
     # Stops both listening for events and processing them
@@ -113,6 +117,10 @@ module Listen
       state == :paused
     end
 
+    def stopped?
+      state == :stopped
+    end
+
     def ignore(regexps)
       @silencer_controller.append_ignores(regexps)
     end
@@ -124,10 +132,5 @@ module Listen
     def only(regexps)
       @silencer_controller.replace_with_only(regexps)
     end
-
-    private
-
-    attr_reader :processor
-    attr_reader :backend
   end
 end

data/lib/listen/logger.rb

@@ -1,32 +1,36 @@
+# frozen_string_literal: true
+
 module Listen
-  def self.logger
-    @logger ||= nil
-  end
+  @logger = nil
 
-  def self.logger=(logger)
-    @logger = logger
-  end
+  # Listen.logger will always be present.
+  # If you don't want logging, set Listen.logger = ::Logger.new('/dev/null', level: ::Logger::UNKNOWN)
 
-  def self.setup_default_logger_if_unset
-    self.logger ||= ::Logger.new(STDERR).tap do |logger|
-      debugging = ENV['LISTEN_GEM_DEBUGGING']
-      logger.level =
-        case debugging.to_s
-        when /2/
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= default_logger
+    end
+
+    private
+
+    def default_logger
+      level =
+        case ENV['LISTEN_GEM_DEBUGGING'].to_s
+        when /debug|2/i
           ::Logger::DEBUG
-        when /true|yes|1/i
+        when /info|true|yes|1/i
           ::Logger::INFO
+        when /warn/i
+          ::Logger::WARN
+        when /fatal/i
+          ::Logger::FATAL
         else
           ::Logger::ERROR
         end
-    end
-  end
 
-  class Logger
-    [:fatal, :error, :warn, :info, :debug].each do |meth|
-      define_singleton_method(meth) do |*args, &block|
-        Listen.logger.public_send(meth, *args, &block) if Listen.logger
-      end
+      ::Logger.new(STDERR, level: level)
     end
   end
 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

data/lib/listen/options.rb

@@ -1,23 +1,26 @@
+# frozen_string_literal: true
+
 module Listen
   class Options
     def initialize(opts, defaults)
       @options = {}
       given_options = opts.dup
-      defaults.keys.each do |key|
+      defaults.each_key do |key|
         @options[key] = given_options.delete(key) || defaults[key]
       end
 
-      return if given_options.empty?
+      given_options.empty? or raise ArgumentError, "Unknown options: #{given_options.inspect}"
+    end
 
-      msg = "Unknown options: #{given_options.inspect}"
-      Listen::Logger.warn msg
-      fail msg
+    # rubocop:disable Lint/MissingSuper
+    def respond_to_missing?(name, *_)
+      @options.has_key?(name)
     end
 
     def method_missing(name, *_)
-      return @options[name] if @options.key?(name)
-      msg = "Bad option: #{name.inspect} (valid:#{@options.keys.inspect})"
-      fail NameError, msg
+      respond_to_missing?(name) or raise NameError, "Bad option: #{name.inspect} (valid:#{@options.keys.inspect})"
+      @options[name]
     end
+    # rubocop:enable Lint/MissingSuper
   end
 end

data/lib/listen/queue_optimizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   class QueueOptimizer
     class Config
@@ -60,7 +62,7 @@ module Listen
       actions << :added if actions.delete(:moved_to)
       actions << :removed if actions.delete(:moved_from)
 
-      modified = actions.detect { |x| x == :modified }
+      modified = actions.find { |x| x == :modified }
       _calculate_add_remove_difference(actions, path, modified)
     end
 
@@ -89,10 +91,8 @@ module Listen
     def _reinterpret_related_changes(cookies)
       table = { moved_to: :added, moved_from: :removed }
       cookies.flat_map do |_, changes|
-        data = _detect_possible_editor_save(changes)
-        if data
-          to_dir, to_file = data
-          [[:modified, to_dir, to_file]]
+        if (editor_modified = editor_modified?(changes))
+          [[:modified, *editor_modified]]
         else
           not_silenced = changes.reject do |type, _, _, path, _|
             config.silenced?(Pathname(path), type)
@@ -104,29 +104,26 @@ module Listen
       end
     end
 
-    def _detect_possible_editor_save(changes)
+    def editor_modified?(changes)
       return unless changes.size == 2
 
-      from_type = from_change = from = nil
-      to_type = to_change = to_dir = to = nil
+      from_type = from = nil
+      to_type = to_dir = to = nil
 
       changes.each do |data|
         case data[1]
         when :moved_from
-          from_type, from_change, _, from, = data
+          from_type, _from_change, _, from, = data
         when :moved_to
-          to_type, to_change, to_dir, to, = data
-        else
-          return nil
+          to_type, _to_change, to_dir, to, = data
         end
       end
 
-      return unless from && to
-
       # Expect an ignored moved_from and non-ignored moved_to
       # to qualify as an "editor modify"
-      return unless config.silenced?(Pathname(from), from_type)
-      config.silenced?(Pathname(to), to_type) ? nil : [to_dir, to]
+      if from && to && config.silenced?(Pathname(from), from_type) && !config.silenced?(Pathname(to), to_type)
+        [to_dir, to]
+      end
     end
   end
 end

data/lib/listen/record/entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   # @private api
   class Record
@@ -15,14 +17,14 @@ module Listen
 
       def children
         child_relative = _join
-        (_entries(sys_path) - %w(. ..)).map do |name|
+        (_entries(sys_path) - %w[. ..]).map do |name|
           Entry.new(@root, child_relative, name)
         end
       end
 
       def meta
         lstat = ::File.lstat(sys_path)
-        { mtime: lstat.mtime.to_f, mode: lstat.mode }
+        { mtime: lstat.mtime.to_f, mode: lstat.mode, size: lstat.size }
       end
 
       # record hash is e.g.

data/lib/listen/record/symlink_detector.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 require 'set'
+require 'listen/error'
 
 module Listen
   # @private api
   class Record
     class SymlinkDetector
-      WIKI = 'https://github.com/guard/listen/wiki/Duplicate-directory-errors'.freeze
+      README_URL = 'https://github.com/guard/listen/blob/master/README.md'
 
-      SYMLINK_LOOP_ERROR = <<-EOS.freeze
+      SYMLINK_LOOP_ERROR = <<-EOS
         ** ERROR: directory is already being watched! **
 
         Directory: %s
 
         is already being watched through: %s
 
-        MORE INFO: #{WIKI}
+        MORE INFO: #{README_URL}
       EOS
 
-      class Error < RuntimeError
-      end
+      Error = ::Listen::Error # for backward compatibility
 
       def initialize
         @real_dirs = Set.new
@@ -25,14 +27,14 @@ module Listen
 
       def verify_unwatched!(entry)
         real_path = entry.real_path
-        @real_dirs.add?(real_path) || _fail(entry.sys_path, real_path)
+        @real_dirs.add?(real_path) or _fail(entry.sys_path, real_path)
       end
 
       private
 
       def _fail(symlinked, real_path)
-        STDERR.puts format(SYMLINK_LOOP_ERROR, symlinked, real_path)
-        fail Error, 'Failed due to looped symlinks'
+        warn(format(SYMLINK_LOOP_ERROR, symlinked, real_path))
+        raise ::Listen::Error::SymlinkLoop, 'Failed due to looped symlinks'
       end
     end
   end