listen 0.5.3 → 3.7.1

data/lib/listen/listener.rb

@@ -1,203 +1,136 @@
-require 'pathname'
+# frozen_string_literal: true
+
+require 'English'
+
+require 'listen/version'
+
+require 'listen/backend'
+
+require 'listen/silencer'
+require 'listen/silencer/controller'
+
+require 'listen/queue_optimizer'
+
+require 'listen/fsm'
+
+require 'listen/event/loop'
+require 'listen/event/queue'
+require 'listen/event/config'
+
+require 'listen/listener/config'
 
 module Listen
   class Listener
-    attr_reader :directory, :directory_record, :adapter
+    include Listen::FSM
 
-    # The default value for using relative paths in the callback.
-    DEFAULT_TO_RELATIVE_PATHS = false
-
-    # Initializes the directory listener.
+    # Initializes the directories listener.
     #
-    # @param [String] directory the directory to listen to
-    # @param [Hash] options the listen options
-    # @option options [Regexp] ignore a pattern for ignoring paths
-    # @option options [Regexp] filter a pattern for filtering paths
-    # @option options [Float] latency the delay between checking for changes in seconds
-    # @option options [Boolean] relative_paths whether or not to use relative-paths in the callback
-    # @option options [Boolean] force_polling whether to force the polling adapter or not
-    # @option options [String, Boolean] polling_fallback_message to change polling fallback message or remove it
+    # @param [String] directory the directories to listen to
+    # @param [Hash] options the listen options (see Listen::Listener::Options)
     #
     # @yield [modified, added, removed] the changed files
     # @yieldparam [Array<String>] modified the list of modified files
     # @yieldparam [Array<String>] added the list of added files
     # @yieldparam [Array<String>] removed the list of removed files
     #
-    def initialize(directory, options = {}, &block)
-      @block              = block
-      @directory          = Pathname.new(directory).realpath.to_s
-      @directory_record   = DirectoryRecord.new(@directory)
-      @use_relative_paths = DEFAULT_TO_RELATIVE_PATHS
+    # rubocop:disable Metrics/MethodLength
+    def initialize(*dirs, &block)
+      options = dirs.last.is_a?(Hash) ? dirs.pop : {}
 
-      @use_relative_paths = options.delete(:relative_paths) if options[:relative_paths]
-      @directory_record.ignore(*options.delete(:ignore))    if options[:ignore]
-      @directory_record.filter(*options.delete(:filter))    if options[:filter]
+      @config = Config.new(options)
 
-      @adapter_options = options
-    end
+      eq_config = Event::Queue::Config.new(@config.relative?)
+      queue = Event::Queue.new(eq_config)
 
-    # Starts the listener by initializing the adapter and building
-    # the directory record concurrently, then it starts the adapter to watch
-    # for changes.
-    #
-    # @param [Boolean] blocking whether or not to block the current thread after starting
-    #
-    def start(blocking = true)
-      t = Thread.new { @directory_record.build }
-      @adapter = initialize_adapter
-      t.join
-      @adapter.start(blocking)
-    end
+      silencer = Silencer.new
+      rules = @config.silencer_rules
+      @silencer_controller = Silencer::Controller.new(silencer, rules)
 
-    # Stops the listener.
-    #
-    def stop
-      @adapter.stop
+      @backend = Backend.new(dirs, queue, silencer, @config)
+
+      optimizer_config = QueueOptimizer::Config.new(@backend, silencer)
+
+      pconfig = Event::Config.new(
+        self,
+        queue,
+        QueueOptimizer.new(optimizer_config),
+        @backend.min_delay_between_events,
+        &block)
+
+      @processor = Event::Loop.new(pconfig)
+
+      initialize_fsm
     end
+    # rubocop:enable Metrics/MethodLength
 
-    # Pauses the listener.
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def pause
-      @adapter.paused = true
-      self
+    start_state :initializing
+
+    state :initializing, to: [:backend_started, :stopped]
+
+    state :backend_started, to: [:processing_events, :stopped] do
+      @backend.start
     end
 
-    # Unpauses the listener.
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def unpause
-      @directory_record.build
-      @adapter.paused = false
-      self
+    state :processing_events, to: [:paused, :stopped] do
+      @processor.start
     end
 
-    # Returns whether the listener is paused or not.
-    #
-    # @return [Boolean] adapter paused status
-    #
-    def paused?
-      !!@adapter && @adapter.paused == true
+    state :paused, to: [:processing_events, :stopped] do
+      @processor.pause
     end
 
-    # Adds ignoring patterns to the listener.
-    #
-    # @param (see Listen::DirectoryRecord#ignore)
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def ignore(*regexps)
-      @directory_record.ignore(*regexps)
-      self
+    state :stopped, to: [:backend_started] do
+      @backend.stop # halt events ASAP
+      @processor.stop
     end
 
-    # Adds filtering patterns to the listener.
-    #
-    # @param (see Listen::DirectoryRecord#filter)
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def filter(*regexps)
-      @directory_record.filter(*regexps)
-      self
+    # Starts processing events and starts adapters
+    # or resumes invoking callbacks if paused
+    def start
+      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
 
-    # Sets the latency for the adapter. This is a helper method
-    # to simplify changing the latency directly from the listener.
-    #
-    # @example Wait 0.5 seconds each time before checking changes
-    #   latency 0.5
-    #
-    # @param [Float] seconds the amount of delay, in seconds
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def latency(seconds)
-      @adapter_options[:latency] = seconds
-      self
+    # Stops both listening for events and processing them
+    def stop
+      transition :stopped
     end
 
-    # Sets whether the use of the polling adapter
-    # should be forced or not.
-    #
-    # @example Forcing the use of the polling adapter
-    #   force_polling true
-    #
-    # @param [Boolean] value whether to force the polling adapter or not
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def force_polling(value)
-      @adapter_options[:force_polling] = value
-      self
+    # Stops invoking callbacks (messages pile up)
+    def pause
+      transition :paused
     end
 
-    # Sets whether the paths in the callback should be
-    # relative or absolute.
-    #
-    # @example Enabling relative paths in the callback
-    #   relative_paths true
-    #
-    # @param [Boolean] value whether to enable relative paths in the callback or not
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def relative_paths(value)
-      @use_relative_paths = value
-      self
+    # processing means callbacks are called
+    def processing?
+      state == :processing_events
     end
 
-    # Defines a custom polling fallback message of disable it.
-    #
-    # @example Disabling the polling fallback message
-    #   polling_fallback_message false
-    #
-    # @param [String, Boolean] value to change polling fallback message or remove it
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def polling_fallback_message(value)
-      @adapter_options[:polling_fallback_message] = value
-      self
+    def paused?
+      state == :paused
     end
 
-    # Sets the callback that gets called on changes.
-    #
-    # @example Assign a callback to be called on changes
-    #   callback = lambda { |modified, added, removed| ... }
-    #   change &callback
-    #
-    # @param [Proc] block the callback proc
-    #
-    # @return [Listen::Listener] the listener
-    #
-    def change(&block) # modified, added, removed
-      @block = block
-      self
+    def stopped?
+      state == :stopped
     end
 
-    # Runs the callback passing it the changes if there are any.
-    #
-    # @param (see Listen::DirectoryRecord#fetch_changes)
-    #
-    def on_change(directories, options = {})
-      changes = @directory_record.fetch_changes(directories, options.merge(
-        :relative_paths => @use_relative_paths
-      ))
-      unless changes.values.all? { |paths| paths.empty? }
-        @block.call(changes[:modified],changes[:added],changes[:removed])
-      end
+    def ignore(regexps)
+      @silencer_controller.append_ignores(regexps)
     end
 
-    private
+    def ignore!(regexps)
+      @silencer_controller.replace_with_bang_ignores(regexps)
+    end
 
-    # Initializes an adapter passing it the callback and adapters' options.
-    #
-    def initialize_adapter
-      callback = lambda { |changed_dirs, options| self.on_change(changed_dirs, options) }
-      Adapter.select_and_initialize(@directory, @adapter_options, &callback)
+    def only(regexps)
+      @silencer_controller.replace_with_only(regexps)
     end
   end
 end

data/lib/listen/logger.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Listen
+  @logger = nil
+
+  # Listen.logger will always be present.
+  # If you don't want logging, set Listen.logger = ::Logger.new('/dev/null', level: ::Logger::UNKNOWN)
+
+  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 /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
+  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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Listen
+  class Options
+    def initialize(opts, defaults)
+      @options = {}
+      given_options = opts.dup
+      defaults.each_key do |key|
+        @options[key] = given_options.delete(key) || defaults[key]
+      end
+
+      given_options.empty? or raise ArgumentError, "Unknown options: #{given_options.inspect}"
+    end
+
+    # rubocop:disable Lint/MissingSuper
+    def respond_to_missing?(name, *_)
+      @options.has_key?(name)
+    end
+
+    def method_missing(name, *_)
+      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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Listen
+  class QueueOptimizer
+    class Config
+      def initialize(adapter_class, silencer)
+        @adapter_class = adapter_class
+        @silencer = silencer
+      end
+
+      def exist?(path)
+        Pathname(path).exist?
+      end
+
+      def silenced?(path, type)
+        @silencer.silenced?(path, type)
+      end
+
+      def debug(*args, &block)
+        Listen.logger.debug(*args, &block)
+      end
+    end
+
+    def smoosh_changes(changes)
+      # TODO: adapter could be nil at this point (shutdown)
+      cookies = changes.group_by do |_, _, _, _, options|
+        (options || {})[:cookie]
+      end
+      _squash_changes(_reinterpret_related_changes(cookies))
+    end
+
+    def initialize(config)
+      @config = config
+    end
+
+    private
+
+    attr_reader :config
+
+    # groups changes into the expected structure expected by
+    # clients
+    def _squash_changes(changes)
+      # We combine here for backward compatibility
+      # Newer clients should receive dir and path separately
+      changes = changes.map { |change, dir, path| [change, dir + path] }
+
+      actions = changes.group_by(&:last).map do |path, action_list|
+        [_logical_action_for(path, action_list.map(&:first)), path.to_s]
+      end
+
+      config.debug("listen: raw changes: #{actions.inspect}")
+
+      { modified: [], added: [], removed: [] }.tap do |squashed|
+        actions.each do |type, path|
+          squashed[type] << path unless type.nil?
+        end
+        config.debug("listen: final changes: #{squashed.inspect}")
+      end
+    end
+
+    def _logical_action_for(path, actions)
+      actions << :added if actions.delete(:moved_to)
+      actions << :removed if actions.delete(:moved_from)
+
+      modified = actions.find { |x| x == :modified }
+      _calculate_add_remove_difference(actions, path, modified)
+    end
+
+    def _calculate_add_remove_difference(actions, path, default_if_exists)
+      added = actions.count { |x| x == :added }
+      removed = actions.count { |x| x == :removed }
+      diff = added - removed
+
+      # TODO: avoid checking if path exists and instead assume the events are
+      # in order (if last is :removed, it doesn't exist, etc.)
+      if config.exist?(path)
+        if diff > 0
+          :added
+        elsif diff.zero? && added > 0
+          :modified
+        else
+          default_if_exists
+        end
+      else
+        diff < 0 ? :removed : nil
+      end
+    end
+
+    # remove extraneous rb-inotify events, keeping them only if it's a possible
+    # editor rename() call (e.g. Kate and Sublime)
+    def _reinterpret_related_changes(cookies)
+      table = { moved_to: :added, moved_from: :removed }
+      cookies.flat_map do |_, changes|
+        if (editor_modified = editor_modified?(changes))
+          [[:modified, *editor_modified]]
+        else
+          not_silenced = changes.reject do |type, _, _, path, _|
+            config.silenced?(Pathname(path), type)
+          end
+          not_silenced.map do |_, change, dir, path, _|
+            [table.fetch(change, change), dir, path]
+          end
+        end
+      end
+    end
+
+    def editor_modified?(changes)
+      return unless changes.size == 2
+
+      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
+        when :moved_to
+          to_type, _to_change, to_dir, to, = data
+        end
+      end
+
+      # Expect an ignored moved_from and non-ignored moved_to
+      # to qualify as an "editor modify"
+      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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Listen
+  # @private api
+  class Record
+    # Represents a directory entry (dir or file)
+    class Entry
+      # file: "/home/me/watched_dir", "app/models", "foo.rb"
+      # dir, "/home/me/watched_dir", "."
+      def initialize(root, relative, name = nil)
+        @root = root
+        @relative = relative
+        @name = name
+      end
+
+      attr_reader :root, :relative, :name
+
+      def children
+        child_relative = _join
+        (_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, size: lstat.size }
+      end
+
+      # record hash is e.g.
+      # if @record["/home/me/watched_dir"]["project/app/models"]["foo.rb"]
+      # if @record["/home/me/watched_dir"]["project/app"]["models"]
+      # record_dir_key is "project/app/models"
+      def record_dir_key
+        ::File.join(*[@relative, @name].compact)
+      end
+
+      def sys_path
+        # Use full path in case someone uses chdir
+        ::File.join(*[@root, @relative, @name].compact)
+      end
+
+      def real_path
+        @real_path ||= ::File.realpath(sys_path)
+      end
+
+      private
+
+      def _join
+        args = [@relative, @name].compact
+        args.empty? ? nil : ::File.join(*args)
+      end
+
+      def _entries(dir)
+        return Dir.entries(dir) unless RUBY_ENGINE == 'jruby'
+
+        # JRuby inconsistency workaround, see:
+        # https://github.com/jruby/jruby/issues/3840
+        exists = ::File.exist?(dir)
+        directory = ::File.directory?(dir)
+        return Dir.entries(dir) unless exists && !directory
+        raise Errno::ENOTDIR, dir
+      end
+    end
+  end
+end

data/lib/listen/record/symlink_detector.rb

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