listen 3.9.0 → 3.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b365e353c2a0dc2a64459faa2c30a9b472130637b5fb4f50977c07adb2c6fd0c
-  data.tar.gz: 82d72d4f26f25a7fd1e285fbebe66fffcee246999696313a4f19997ce2017ef5
+  metadata.gz: 67245b3e45ef5fa6fec5fb54a2b8af298c98caf521cea53ab29cc6b9fd15565f
+  data.tar.gz: ff8ca5d435fc3c409f845a0fbada5d3e7ce606d4a5962e9b07912245d08b7540
 SHA512:
-  metadata.gz: f52228164dce447a048dea3e04268909004e17f0b40788495f58f9afc9a9a9f3a0207fd0acb541d0cffe0be78836a10f652acf6ff418cea9ea119708eaec0b83
-  data.tar.gz: ee91854777075dc80f4cbcff3e507f4ca162aabe37fa11709b145184ada246efd0401ba89a50de8008c2ca7345d0dd08d20bbad7c6d9272004ad3581e74abca5
+  metadata.gz: 448354fa9e581471cfa7888f6478c439c9e2e0d1dcd9351adf962847f629efaea060cc629512e48f663119e7431b5e63d956df0cb24e5275a4827eff8544dbcc
+  data.tar.gz: e76261c0062d5655db30e316ebbbf4b0405c4321c19044ceae27743449ae92449ecb139650dec91ab6bf9999d0a40d748ca2d8760d9952aa886a02e0fac405b6

data/README.md

@@ -25,7 +25,7 @@ The `listen` gem listens to file modifications and notifies you about the change
 * Support for plugins planned for future.
 * TCP functionality was removed in `listen` [3.0.0](https://github.com/guard/listen/releases/tag/v3.0.0) ([#319](https://github.com/guard/listen/issues/319), [#218](https://github.com/guard/listen/issues/218)). There are plans to extract this feature to separate gems ([#258](https://github.com/guard/listen/issues/258)), until this is finished, you can use by locking the `listen` gem to version `'~> 2.10'`.
 * Some filesystems won't work without polling (VM/Vagrant Shared folders, NFS, Samba, sshfs, etc.).
-* Windows and \*BSD adapter aren't continuously and automatically tested.
+* \*BSD adapter isn't continuously and automatically tested.
 * OSX adapter has some performance limitations ([#342](https://github.com/guard/listen/issues/342)).
 * Listeners do not notify across forked processes, if you wish for multiple processes to receive change notifications you must [listen inside of each process](https://github.com/guard/listen/issues/398#issuecomment-223957952).
 
@@ -135,8 +135,6 @@ sleep
 
 Note: `:ignore` regexp patterns are evaluated against relative paths.
 
-Note: Ignoring paths does not improve performance, except when Polling ([#274](https://github.com/guard/listen/issues/274)).
-
 ### Only
 
 `Listen` watches all files (less the ignored ones) by default. If you want to only listen to a specific type of file (i.e., just `.rb` extension), you should use the `only` option/method.
@@ -265,7 +263,7 @@ If you are on Windows, it's recommended to use the [`wdm`](https://github.com/Ma
 Please add the following to your Gemfile:
 
 ```ruby
-gem 'wdm', '>= 0.1.0', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+gem 'wdm', '>= 0.1.0'
 ```
 
 ### On \*BSD
@@ -275,11 +273,7 @@ If you are on \*BSD you can try to use the [`rb-kqueue`](https://github.com/mat8
 Please add the following to your Gemfile:
 
 ```ruby
-require 'rbconfig'
-if RbConfig::CONFIG['target_os'] =~ /bsd|dragonfly/i
-  gem 'rb-kqueue', '>= 0.2'
-end
-
+gem 'rb-kqueue', '>= 0.2'
 ```
 
 ### Getting the [polling fallback message](#options)?
@@ -357,6 +351,9 @@ $ sudo sysctl -p
 ```
 You may also need to pay attention to the values of `max_queued_events` and `max_user_instances` if Listen keeps on complaining.
 
+While 524,288 is the maximum number of files that can be watched. Each file watch [takes up 1,080 bytes](https://stackoverflow.com/a/7091897/1156119) on a 64-bit system, so assuming that all 524,288 watches are consumed, that allocates around 540 MiB.
+If you're in an environment that is particularly memory-constrained, consider to specify a lower number.
+
 #### More info
 Man page for [inotify(7)](https://linux.die.net/man/7/inotify).
 Blog post: [limit of inotify](https://blog.sorah.jp/2012/01/24/inotify-limitation).
@@ -431,7 +428,7 @@ When in doubt, `LISTEN_GEM_DEBUGGING=debug` can help discover the actual events
 Pull requests are very welcome! Please try to follow these simple rules if applicable:
 
 * Please create a topic branch for every separate change you make.
-* Make sure your patches are well tested. All specs must pass on [Travis CI](https://travis-ci.org/guard/listen).
+* Make sure your patches are well tested. All specs must pass on [CI](https://github.com/guard/listen/actions?workflow=Development).
 * Update the [Yard](http://yardoc.org/) documentation.
 * Update the [README](https://github.com/guard/listen/blob/master/README.md).
 * Please **do not change** the version number.

data/lib/listen/adapter/base.rb

@@ -88,7 +88,7 @@ module Listen
       private
 
       def _stop
-        @run_thread&.kill
+        @run_thread&.kill&.join
         @run_thread = nil
       end
 

data/lib/listen/adapter/bsd.rb

@@ -7,7 +7,7 @@
 module Listen
   module Adapter
     class BSD < Base
-      OS_REGEXP = /bsd|dragonfly/i.freeze
+      OS_REGEXP = /bsd|dragonfly/i
 
       DEFAULTS = {
         events: [
@@ -22,10 +22,7 @@ module Listen
 
       BUNDLER_DECLARE_GEM = <<-EOS.gsub(/^ {6}/, '')
         Please add the following to your Gemfile to avoid polling for changes:
-          require 'rbconfig'
-          if RbConfig::CONFIG['target_os'] =~ /#{OS_REGEXP}/
-            gem 'rb-kqueue', '>= 0.2'
-          end
+          gem 'rb-kqueue', '>= 0.2'
       EOS
 
       def self.usable?

data/lib/listen/adapter/darwin.rb

@@ -7,7 +7,7 @@ module Listen
     # Adapter implementation for Mac OS X `FSEvents`.
     #
     class Darwin < Base
-      OS_REGEXP = /darwin(?<major_version>(1|2)\d+)/i.freeze
+      OS_REGEXP = /darwin(?<major_version>(1|2)\d+)/i
 
       # The default delay between checking for changes.
       DEFAULTS = { latency: 0.1 }.freeze
@@ -69,7 +69,7 @@ module Listen
       end
 
       def _stop
-        @worker_thread&.kill
+        @worker_thread&.kill&.join
         super
       end
     end

data/lib/listen/adapter/linux.rb

@@ -4,7 +4,7 @@ module Listen
   module Adapter
     # @see https://github.com/nex3/rb-inotify
     class Linux < Base
-      OS_REGEXP = /linux/i.freeze
+      OS_REGEXP = /linux/i
 
       DEFAULTS = {
         events: [
@@ -60,7 +60,7 @@ module Listen
 
         cookie_params = event.cookie.zero? ? {} : { cookie: event.cookie }
 
-        # Note: don't pass options to force rescanning the directory, so we can
+        # NOTE: don't pass options to force rescanning the directory, so we can
         # detect moving/deleting a whole tree
         if _dir_event?(event)
           _queue_change(:dir, dir, rel_path, cookie_params)

data/lib/listen/adapter/polling.rb

@@ -8,7 +8,7 @@ module Listen
     # file IO than the other implementations.
     #
     class Polling < Base
-      OS_REGEXP = //.freeze # match every OS
+      OS_REGEXP = // # match every OS
 
       DEFAULTS = { latency: 1.0, wait_for_delay: 0.05 }.freeze
 

data/lib/listen/adapter/windows.rb

@@ -5,11 +5,11 @@ module Listen
     # Adapter implementation for Windows `wdm`.
     #
     class Windows < Base
-      OS_REGEXP = /mswin|mingw|cygwin/i.freeze
+      OS_REGEXP = /mswin|mingw|cygwin/i
 
       BUNDLER_DECLARE_GEM = <<-EOS.gsub(/^ {6}/, '')
         Please add the following to your Gemfile to avoid polling for changes:
-          gem 'wdm', '>= 0.1.0' if Gem.win_platform?
+          gem 'wdm', '>= 0.1.0'
       EOS
 
       def self.usable?

data/lib/listen/adapter.rb

@@ -18,7 +18,8 @@ module Listen
         Listen.logger.debug 'Adapter: considering polling ...'
         return Polling if options[:force_polling]
         Listen.logger.debug 'Adapter: considering optimized backend...'
-        return _usable_adapter_class if _usable_adapter_class
+        adapter_class = _usable_adapter_class
+        return adapter_class if adapter_class
         Listen.logger.debug 'Adapter: falling back to polling...'
         _warn_polling_fallback(options)
         Polling

data/lib/listen/change.rb

@@ -55,9 +55,7 @@ module Listen
         options = cookie ? { cookie: cookie } : {}
         @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)
+        _scan_directory(rel_path, options)
       elsif (change = File.change(record, rel_path)) && !options[:silence]
         @config.queue(:file, change, watched_dir, rel_path)
       end
@@ -65,5 +63,25 @@ module Listen
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity
+
+    private
+
+    def _scan_directory(rel_path, options)
+      @directory_scan_queue ||= []
+      @directory_scan_queue << [rel_path, options]
+      return if @scanning_directories
+
+      _drain_directory_scan_queue
+    end
+
+    def _drain_directory_scan_queue
+      @scanning_directories = true
+      @directory_scan_queue.each do |path, options|
+        Directory.scan(self, path, options)
+      end
+    ensure
+      @directory_scan_queue.clear
+      @scanning_directories = false
+    end
   end
 end

data/lib/listen/directory.rb

@@ -5,6 +5,8 @@ require 'set'
 module Listen
   # TODO: refactor (turn it into a normal object, cache the stat, etc)
   class Directory
+    MAX_RESCAN_ATTEMPTS = 5
+
     # rubocop:disable Metrics/MethodLength
     def self.scan(snapshot, rel_path, options)
       record = snapshot.record
@@ -23,6 +25,8 @@ module Listen
                rel_path, options.inspect, previous.inspect, current.inspect)
       end
 
+      rescan_attempts = 0
+      full_path = nil
       begin
         current.each do |full_path|
           type = ::File.lstat(full_path.to_s).directory? ? :dir : :file
@@ -31,8 +35,16 @@ module Listen
         end
       rescue Errno::ENOENT
         # The directory changed meanwhile, so rescan it
-        current = Set.new(_children(path))
-        retry
+        rescan_attempts += 1
+        if rescan_attempts <= MAX_RESCAN_ATTEMPTS
+          current = Set.new(_children(path))
+          retry
+        end
+
+        current.delete(full_path)
+        Listen.logger.debug do
+          "scan remained unstable after #{MAX_RESCAN_ATTEMPTS} rescans: #{path}"
+        end
       end
 
       # TODO: this is not tested properly
@@ -48,7 +60,9 @@ module Listen
       _async_changes(snapshot, path, previous, options)
       _change(snapshot, :file, rel_path, options)
     rescue
-      Listen.logger.warn { format('scan DIED: %s:%s', $ERROR_INFO, $ERROR_POSITION * "\n") }
+      Listen.logger.warn do
+        "scan DIED: #{$ERROR_INFO}:#{$ERROR_POSITION * "\n"}"
+      end
       raise
     end
     # rubocop:enable Metrics/MethodLength

data/lib/listen/event/config.rb

@@ -12,7 +12,6 @@ module Listen
         wait_for_delay,
         &block
       )
-
         @listener = listener
         @event_queue = event_queue
         @queue_optimizer = queue_optimizer

data/lib/listen/event/loop.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'thread'
-
 require 'timeout'
 require 'listen/event/processor'
 require 'listen/thread'

data/lib/listen/event/processor.rb

@@ -85,11 +85,13 @@ module Listen
 
       # blocks until event is popped
       # returns the event or `nil` when the event_queue is closed
+      # rubocop:disable Naming/MemoizedInstanceVariableName
       def _wait_until_events
         config.event_queue.pop.tap do |_event|
           @_remember_time_of_first_unprocessed_event ||= MonotonicTime.now
         end
       end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
 
       def _flush_wakeup_reasons
         until @reasons.empty?

data/lib/listen/event/queue.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'thread'
-
 require 'forwardable'
 
 module Listen

data/lib/listen/fsm.rb

@@ -2,8 +2,6 @@
 
 # Code copied from https://github.com/celluloid/celluloid-fsm
 
-require 'thread'
-
 module Listen
   module FSM
     # Included hook to extend class methods
@@ -38,7 +36,7 @@ module Listen
       end
     end
 
-    # Note: including classes must call initialize_fsm from their initialize method.
+    # NOTE: including classes must call initialize_fsm from their initialize method.
     def initialize_fsm
       @fsm_initialized = true
       @state = self.class.start_state

data/lib/listen/logger.rb

@@ -46,7 +46,7 @@ module Listen
 
       ::Logger.new(STDERR, level: level)
     end
-    
+
     def adapter_warn_behavior_callback(message)
       if adapter_warn_behavior.respond_to?(:call)
         case behavior = adapter_warn_behavior.call(message)

data/lib/listen/options.rb

@@ -12,7 +12,6 @@ module Listen
       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
@@ -21,6 +20,5 @@ module Listen
       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/record/symlink_detector.rb

@@ -9,7 +9,7 @@ module Listen
     class SymlinkDetector
       README_URL = 'https://github.com/guard/listen/blob/master/README.md'
 
-      SYMLINK_LOOP_ERROR = <<-EOS
+      SYMLINK_LOOP_ERROR = <<-EOS.freeze
         ** ERROR: directory is already being watched! **
 
         Directory: %s

data/lib/listen/record.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'thread'
 require 'listen/record/entry'
 require 'listen/record/symlink_detector'
 
@@ -73,7 +72,7 @@ module Listen
     private
 
     def empty_dirname?(dirname)
-      dirname == '.' || dirname == ''
+      ['.', ''].include?(dirname)
     end
 
     def reset_tree

data/lib/listen/silencer/controller.rb

@@ -17,16 +17,21 @@ module Listen
       end
 
       def append_ignores(*regexps)
-        prev_ignores = Array(@prev_silencer_options[:ignore])
-        _reconfigure_silencer(ignore: [prev_ignores + regexps])
+        opts = @prev_silencer_options.dup
+        opts[:ignore] = [opts[:ignore], regexps]
+        _reconfigure_silencer(opts)
       end
 
       def replace_with_bang_ignores(regexps)
-        _reconfigure_silencer(ignore!: regexps)
+        opts = @prev_silencer_options.dup
+        opts.delete(:ignore)
+        opts[:ignore!] = regexps
+        _reconfigure_silencer(opts)
       end
 
       def replace_with_only(regexps)
-        _reconfigure_silencer(only: regexps)
+        opts = @prev_silencer_options.merge(only: regexps)
+        _reconfigure_silencer(opts)
       end
 
       private

data/lib/listen/silencer.rb

@@ -18,7 +18,7 @@ module Listen
       # emacs temp files
       | \#.+\#
       | \.\#.+
-      )(/|\z)}x.freeze
+      )(/|\z)}x
 
     # The default list of files that get ignored.
     DEFAULT_IGNORED_EXTENSIONS = %r{(?:
@@ -59,7 +59,7 @@ module Listen
       | \.DS_Store
       | \.tmp
       | ~
-    )\z}x.freeze
+    )\z}x
 
     # TODO: deprecate these mutators; use attr_reader instead
     attr_accessor :only_patterns, :ignore_patterns
@@ -75,7 +75,7 @@ module Listen
     end
 
     def silenced?(relative_path, type)
-      path = relative_path.to_s   # in case it is a Pathname
+      path = relative_path.to_s # in case it is a Pathname
 
       _ignore?(path) || (only_patterns && type == :file && !_only?(path))
     end

data/lib/listen/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.10.1
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-24 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
@@ -103,9 +117,9 @@ metadata:
   allowed_push_host: https://rubygems.org
   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
+  documentation_uri: https://www.rubydoc.info/gems/listen/3.10.1
   homepage_uri: https://github.com/guard/listen
-  source_code_uri: https://github.com/guard/listen/tree/v3.9.0
+  source_code_uri: https://github.com/guard/listen/tree/v3.10.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -121,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Listen to file modifications