listen 3.1.5 → 3.7.0

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

data/lib/listen/record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thread'
 require 'listen/record/entry'
 require 'listen/record/symlink_detector'
@@ -8,14 +10,17 @@ module Listen
     # TODO: deprecate
 
     attr_reader :root
-    def initialize(directory)
+
+    def initialize(directory, silencer)
       @tree = _auto_hash
       @root = directory.to_s
+      @silencer = silencer
     end
 
     def add_dir(rel_path)
-      return if [nil, '', '.'].include? rel_path
-      @tree[rel_path] ||= {}
+      if ![nil, '', '.'].include?(rel_path)
+        @tree[rel_path] ||= {}
+      end
     end
 
     def update_file(rel_path, data)
@@ -31,30 +36,27 @@ module Listen
     def file_data(rel_path)
       dirname, basename = Pathname(rel_path).split.map(&:to_s)
       if [nil, '', '.'].include? dirname
-        tree[basename] ||= {}
-        tree[basename].dup
+        @tree[basename] ||= {}
+        @tree[basename].dup
       else
-        tree[dirname] ||= {}
-        tree[dirname][basename] ||= {}
-        tree[dirname][basename].dup
+        @tree[dirname] ||= {}
+        @tree[dirname][basename] ||= {}
+        @tree[dirname][basename].dup
       end
     end
 
     def dir_entries(rel_path)
-      subtree =
-        if [nil, '', '.'].include? rel_path.to_s
-          tree
-        else
-          tree[rel_path.to_s] ||= _auto_hash
-          tree[rel_path.to_s]
-        end
+      subtree = if ['', '.'].include? rel_path.to_s
+        @tree
+      else
+        @tree[rel_path.to_s] ||= _auto_hash
+        @tree[rel_path.to_s]
+      end
 
-      result = {}
-      subtree.each do |key, values|
+      subtree.transform_values do |values|
         # only get data for file entries
-        result[key] = values.key?(:mtime) ? values : {}
+        values.key?(:mtime) ? values : {}
       end
-      result
     end
 
     def build
@@ -71,34 +73,34 @@ module Listen
     private
 
     def _auto_hash
-      Hash.new { |h, k| h[k] = Hash.new }
+      Hash.new { |h, k| h[k] = {} }
     end
 
-    attr_reader :tree
-
     def _fast_update_file(dirname, basename, data)
-      if [nil, '', '.'].include? dirname
-        tree[basename] = (tree[basename] || {}).merge(data)
+      if [nil, '', '.'].include?(dirname)
+        @tree[basename] = (@tree[basename] || {}).merge(data)
       else
-        tree[dirname] ||= {}
-        tree[dirname][basename] = (tree[dirname][basename] || {}).merge(data)
+        @tree[dirname] ||= {}
+        @tree[dirname][basename] = (@tree[dirname][basename] || {}).merge(data)
       end
     end
 
     def _fast_unset_path(dirname, basename)
       # this may need to be reworked to properly remove
       # entries from a tree, without adding non-existing dirs to the record
-      if [nil, '', '.'].include? dirname
-        return unless tree.key?(basename)
-        tree.delete(basename)
-      else
-        return unless tree.key?(dirname)
-        tree[dirname].delete(basename)
+      if [nil, '', '.'].include?(dirname)
+        if @tree.key?(basename)
+          @tree.delete(basename)
+        end
+      elsif @tree.key?(dirname)
+        @tree[dirname].delete(basename)
       end
     end
 
     def _fast_build_dir(remaining, symlink_detector)
       entry = remaining.pop
+      return if @silencer.silenced?(entry.record_dir_key, :dir)
+
       children = entry.children # NOTE: children() implicitly tests if dir
       symlink_detector.verify_unwatched!(entry)
       children.each { |child| remaining << child }

data/lib/listen/silencer/controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   class Silencer
     class Controller

data/lib/listen/silencer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
   class Silencer
     # The default list of directories that get ignored.
@@ -12,7 +14,7 @@ module Listen
       | log
       | tmp
       |vendor/ruby
-    )(/|$)}x
+    )(/|$)}x.freeze
 
     # The default list of files that get ignored.
     DEFAULT_IGNORED_EXTENSIONS = %r{(?:
@@ -46,40 +48,43 @@ module Listen
          )
         )
 
+      # Mutagen sync temporary files
+      | \.mutagen-temporary.*
+
       # other files
       | \.DS_Store
       | \.tmp
       | ~
-    )$}x
+    )$}x.freeze
 
+    # TODO: deprecate these mutators; use attr_reader instead
     attr_accessor :only_patterns, :ignore_patterns
 
-    def initialize
-      configure({})
+    def initialize(**options)
+      configure(options)
     end
 
+    # TODO: deprecate this mutator
     def configure(options)
       @only_patterns = options[:only] ? Array(options[:only]) : nil
       @ignore_patterns = _init_ignores(options[:ignore], options[:ignore!])
     end
 
-    # Note: relative_path is temporarily expected to be a relative Pathname to
-    # make refactoring easier (ideally, it would take a string)
-
-    # TODO: switch type and path places - and verify
     def silenced?(relative_path, type)
-      path = relative_path.to_s
-
-      if only_patterns && type == :file
-        return true unless only_patterns.any? { |pattern| path =~ pattern }
-      end
+      path = relative_path.to_s   # in case it is a Pathname
 
-      ignore_patterns.any? { |pattern| path =~ pattern }
+      _ignore?(path) || (only_patterns && type == :file && !_only?(path))
     end
 
     private
 
-    attr_reader :options
+    def _ignore?(path)
+      ignore_patterns.any? { |pattern| path =~ pattern }
+    end
+
+    def _only?(path)
+      only_patterns.any? { |pattern| path =~ pattern }
+    end
 
     def _init_ignores(ignores, overrides)
       patterns = []

data/lib/listen/thread.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'thread'
+
+require_relative 'logger'
+
+module Listen
+  module Thread
+    class << self
+      # Creates a new thread with the given name.
+      # Any exceptions raised by the thread will be logged with the thread name and complete backtrace.
+      # rubocop:disable Style/MultilineBlockChain
+      def new(name, &block)
+        thread_name = "listen-#{name}"
+        caller_stack = caller
+
+        ::Thread.new do
+          rescue_and_log(thread_name, caller_stack: caller_stack, &block)
+        end.tap do |thread|
+          thread.name = thread_name
+        end
+      end
+      # rubocop:enable Style/MultilineBlockChain
+
+      def rescue_and_log(method_name, *args, caller_stack: nil)
+        yield(*args)
+      rescue => exception
+        _log_exception(exception, method_name, caller_stack: caller_stack)
+      end
+
+      private
+
+      def _log_exception(exception, thread_name, caller_stack: nil)
+        complete_backtrace = if caller_stack
+          [*exception.backtrace, "--- Thread.new ---", *caller_stack]
+        else
+          exception.backtrace
+        end
+        message = "Exception rescued in #{thread_name}:\n#{_exception_with_causes(exception)}\n#{complete_backtrace * "\n"}"
+        Listen.logger.error(message)
+      end
+
+      def _exception_with_causes(exception)
+        result = +"#{exception.class}: #{exception}"
+        if exception.cause
+          result << "\n"
+          result << "--- Caused by: ---\n"
+          result << _exception_with_causes(exception.cause)
+        end
+        result
+      end
+    end
+  end
+end

data/lib/listen/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Listen
-  VERSION = '3.1.5'.freeze
+  VERSION = '3.7.0'
 end