listen 3.3.0 → 3.9.0

data/lib/listen/record/symlink_detector.rb

@@ -1,25 +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
@@ -27,14 +27,20 @@ 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
+
+      # Leaving this stub here since some warning work-arounds were referring to it.
+      # Deprecated. Will be removed in Listen v4.0.
+      def warn(message)
+        Listen.adapter_warn(message)
       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

@@ -10,14 +10,17 @@ module Listen
     # TODO: deprecate
 
     attr_reader :root
-    def initialize(directory)
-      @tree = _auto_hash
+
+    def initialize(directory, silencer)
+      reset_tree
       @root = directory.to_s
+      @silencer = silencer
     end
 
     def add_dir(rel_path)
-      return if [nil, '', '.'].include? rel_path
-      @tree[rel_path] ||= {}
+      if !empty_dirname?(rel_path.to_s)
+        @tree[rel_path.to_s]
+      end
     end
 
     def update_file(rel_path, data)
@@ -32,47 +35,32 @@ 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
+      if empty_dirname?(dirname)
+        @tree[basename].dup
       else
-        tree[dirname] ||= {}
-        tree[dirname][basename] ||= {}
-        tree[dirname][basename].dup
+        @tree[dirname][basename] ||= {}
+        @tree[dirname][basename].dup
       end
     end
 
     def dir_entries(rel_path)
-      subtree =
-        if [nil, '', '.'].include? rel_path.to_s
-          tree
-        else
-          _sub_tree(rel_path)
-        end
-
-      result = {}
-      subtree.each do |key, values|
-        # only get data for file entries
-        result[key] = values.key?(:mtime) ? values : {}
+      rel_path_s = rel_path.to_s
+      subtree = if empty_dirname?(rel_path_s)
+        @tree
+      else
+        @tree[rel_path_s]
       end
-      result
-    end
 
-    def _sub_tree(rel_path)
-      tree.each_with_object({}) do |(path, meta), result|
-        next unless path.start_with?(rel_path)
-
-        if path == rel_path
-          result.merge!(meta)
-        else
-          sub_path         = path.sub(%r{\A#{rel_path}/?}, '')
-          result[sub_path] = meta
+      subtree.each_with_object({}) do |(key, values), result|
+        # only return data for file entries inside the dir (which will each be sub-hashes)
+        if values.is_a?(Hash)
+          result[key] = values.has_key?(:mtime) ? values : {}
         end
       end
     end
 
     def build
-      @tree = _auto_hash
+      reset_tree
       # TODO: test with a file name given
       # TODO: test other permissions
       # TODO: test with mixed encoding
@@ -84,35 +72,38 @@ module Listen
 
     private
 
-    def _auto_hash
-      Hash.new { |h, k| h[k] = Hash.new }
+    def empty_dirname?(dirname)
+      dirname == '.' || dirname == ''
     end
 
-    attr_reader :tree
+    def reset_tree
+      @tree = Hash.new { |h, k| h[k] = {} }
+    end
 
     def _fast_update_file(dirname, basename, data)
-      if [nil, '', '.'].include? dirname
-        tree[basename] = (tree[basename] || {}).merge(data)
+      if empty_dirname?(dirname.to_s)
+        @tree[basename] = @tree[basename].merge(data)
       else
-        tree[dirname] ||= {}
-        tree[dirname][basename] = (tree[dirname][basename] || {}).merge(data)
+        @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 empty_dirname?(dirname.to_s)
+        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.rb

@@ -3,8 +3,8 @@
 module Listen
   class Silencer
     # The default list of directories that get ignored.
-    DEFAULT_IGNORED_DIRECTORIES = %r{^(?:
-      \.git
+    DEFAULT_IGNORED_FILES = %r{\A(?:
+    \.git
       | \.svn
       | \.hg
       | \.rbx
@@ -13,8 +13,12 @@ module Listen
       | vendor/bundle
       | log
       | tmp
-      |vendor/ruby
-    )(/|$)}x
+      | vendor/ruby
+
+      # emacs temp files
+      | \#.+\#
+      | \.\#.+
+      )(/|\z)}x.freeze
 
     # The default list of files that get ignored.
     DEFAULT_IGNORED_EXTENSIONS = %r{(?:
@@ -35,7 +39,7 @@ module Listen
       | ^4913
 
       # Sed temporary files - but without actual words, like 'sedatives'
-      | (?:^
+      | (?:\A
          sed
 
          (?:
@@ -55,41 +59,41 @@ module Listen
       | \.DS_Store
       | \.tmp
       | ~
-    )$}x
+    )\z}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
+      path = relative_path.to_s   # in case it is a Pathname
 
-      if only_patterns && type == :file
-        return true unless only_patterns.any? { |pattern| path =~ pattern }
-      end
-
-      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 = []
       unless overrides
-        patterns << DEFAULT_IGNORED_DIRECTORIES
+        patterns << DEFAULT_IGNORED_FILES
         patterns << DEFAULT_IGNORED_EXTENSIONS
       end
 

data/lib/listen/thread.rb

@@ -9,6 +9,7 @@ module Listen
     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
@@ -19,31 +20,32 @@ module Listen
           thread.name = thread_name
         end
       end
+      # rubocop:enable Style/MultilineBlockChain
 
       def rescue_and_log(method_name, *args, caller_stack: nil)
         yield(*args)
-      rescue Exception => ex
-        _log_exception(ex, method_name, caller_stack: caller_stack)
+      rescue => exception
+        _log_exception(exception, method_name, caller_stack: caller_stack)
       end
 
       private
 
-      def _log_exception(ex, thread_name, caller_stack: nil)
+      def _log_exception(exception, thread_name, caller_stack: nil)
         complete_backtrace = if caller_stack
-                               [*ex.backtrace, "--- Thread.new ---", *caller_stack]
-                             else
-                               ex.backtrace
-                             end
-        message = "Exception rescued in #{thread_name}:\n#{_exception_with_causes(ex)}\n#{complete_backtrace * "\n"}"
+          [*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(ex)
-        result = +"#{ex.class}: #{ex}"
-        if ex.cause
+      def _exception_with_causes(exception)
+        result = +"#{exception.class}: #{exception}"
+        if exception.cause
           result << "\n"
           result << "--- Caused by: ---\n"
-          result << _exception_with_causes(ex.cause)
+          result << _exception_with_causes(exception.cause)
         end
         result
       end

data/lib/listen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Listen
-  VERSION = '3.3.0'
+  VERSION = '3.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-10 00:00:00.000000000 Z
+date: 2024-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
@@ -51,7 +51,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.10
 description: The Listen gem listens to file modifications and notifies you about the
-  changegem. Works everywhere!
+  changes. Works everywhere!
 email: thibaud@thibaud.gg
 executables:
 - listen
@@ -76,6 +76,7 @@ files:
 - lib/listen/change.rb
 - lib/listen/cli.rb
 - lib/listen/directory.rb
+- lib/listen/error.rb
 - lib/listen/event/config.rb
 - lib/listen/event/loop.rb
 - lib/listen/event/processor.rb
@@ -85,6 +86,7 @@ files:
 - lib/listen/listener.rb
 - lib/listen/listener/config.rb
 - lib/listen/logger.rb
+- lib/listen/monotonic_time.rb
 - lib/listen/options.rb
 - lib/listen/queue_optimizer.rb
 - lib/listen/record.rb
@@ -99,7 +101,12 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  bug_tracker_uri: https://github.com/guard/listen/issues
+  changelog_uri: https://github.com/guard/listen/releases
+  documentation_uri: https://www.rubydoc.info/gems/listen/3.9.0
+  homepage_uri: https://github.com/guard/listen
+  source_code_uri: https://github.com/guard/listen/tree/v3.9.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,15 +114,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.7
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Listen to file modifications
 test_files: []