listen 3.3.0.pre.3 → 3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6639e347ad2eafe447bbb0c00b50ceab5e3f7a6b3bdce169482c910765198d
-  data.tar.gz: 617efbcc3815ea658bc886e02d9ee24a0dd142cc0273442d4323d55766c5d8ed
+  metadata.gz: 3502b7f13a7eb3801aa2ccfb12825f13ce550b6339316389a17ed6319c3c450d
+  data.tar.gz: 433b372d311ea535f67999d23ef947dd3e4358849a60467dcf41582387d04b0f
 SHA512:
-  metadata.gz: 5e55c50925feb8a8909978344e3061cec23ae2ee9cdba2583928da45bb907eb17284e7fb94aad431c9b1ba141f6401f98f131c6b774fe49619ea7bf353c6f352
-  data.tar.gz: 221ca770caf975a3bd686704e93888a852cba10e725f582c22076a42d0540b085f929faaf474b9d81690beb0c88fb647107e3bf296e738bd913d1c0f5097a442
+  metadata.gz: 9a522a4498c0369db11679d60a7702e348f41442c33aa25e292807b91aa42fd7a672ed2ce77f1993c30da16b1dcae2733ecf2ddd70bbbd9a1bd89c8192483199
+  data.tar.gz: e8f695e75d67aa62ad4f3bd5e7d237717b7f58f1e6d444099697c901b21d49ed144250eca0ef3987dd33c625de4e181b86e57f35fdc839ccdb0b6a3b3578bf75

data/README.md

@@ -16,13 +16,13 @@ The `listen` gem listens to file modifications and notifies you about the change
 * You can watch multiple directories.
 * Regexp-patterns for ignoring paths for more accuracy and speed
 * Increased change detection accuracy on OS X HFS and VFAT volumes.
-* Tested on selected Ruby environments via [Travis CI](https://travis-ci.org/guard/listen). (See [.travis.yml](https:///github.com/guard/listen/master/.travis.yml) for supported/tested Ruby Versions),
+* Continuous Integration: tested on selected Ruby environments via [Github Workflows](https:///github.com/guard/listen/master/.github/workflows).
 
 ## Issues / limitations
 
 * Limited support for symlinked directories ([#279](https://github.com/guard/listen/issues/279)):
   * Symlinks are always followed ([#25](https://github.com/guard/listen/issues/25)).
-  * Symlinked directories pointing within a watched directory are not supported ([#273](https://github.com/guard/listen/pull/273)- see [Duplicate directory errors](https://github.com/guard/listen/wiki/Duplicate-directory-errors)).
+  * Symlinked directories pointing within a watched directory are not supported ([#273](https://github.com/guard/listen/pull/273).
 * No directory/adapter-specific configuration options.
 * 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'`.
@@ -40,7 +40,7 @@ Pull requests or help is very welcome for these.
 The simplest way to install `listen` is to use [Bundler](http://bundler.io).
 
 ```ruby
-gem 'listen', '~> 3.3' # NOTE: for TCP functionality, use '~> 2.10' for now
+gem 'listen'
 ```
 
 ## Complete Example
@@ -240,7 +240,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' if Gem.win_platform?
+gem 'wdm', '>= 0.1.0', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 ```
 
 ### On \*BSD
@@ -259,7 +259,82 @@ end
 
 ### Getting the [polling fallback message](#options)?
 
-Please visit the [installation section of the Listen WIKI](https://github.com/guard/listen/wiki#installation) for more information and options for potential fixes.
+If you see:
+```
+Listen will be polling for changes.
+```
+
+This means the Listen gem can’t find an optimized adapter. Typically this is caused by:
+
+- You’re on Windows and WDM gem isn’t installed.
+- You’re running the app without Bundler or RubyGems.
+- Using Sass which includes an ancient (the “dinosaur” type of ancient) version of the Listen gem.
+
+Possible solutions:
+
+1. Suppress the message by using the :force_polling option. Or, you could just ignore the message since it’s harmless.
+2. Windows users: Install the WDM gem.
+3. Upgrade Ruby (use RubyInstaller for Windows or RVM/rbenv for Mac) and RubyGems.
+3. Run your apps using Bundler.
+4. Sass users: Install the latest version of Listen and try again.
+
+#### Simplified Bundler and Sass example
+Create a Gemfile with these lines:
+```
+source 'https://rubygems.org'
+gem 'listen'
+gem 'sass'
+```
+Next, use Bundler to update gems:
+```
+$ bundle update
+$ bundle exec sass --watch # ... or whatever app is using Listen.
+```
+
+### Increasing the amount of inotify watchers
+
+If you are running Debian, RedHat, or another similar Linux distribution, run the following in a terminal:
+```
+$ sudo sh -c "echo fs.inotify.max_user_watches=524288 >> /etc/sysctl.conf"
+$ sudo sysctl -p
+```
+If you are running ArchLinux, search the `/etc/sysctl.d/` directory for config files with the setting:
+```
+$ grep -H -s "fs.inotify.max_user_watches" /etc/sysctl.d/*
+/etc/sysctl.d/40-max_user_watches.conf:fs.inotify.max_user_watches=100000
+```
+Then change the setting in the file you found above to a higher value (see [here](https://www.archlinux.org/news/deprecation-of-etcsysctlconf/) for why):
+```
+$ sudo sh -c "echo fs.inotify.max_user_watches=524288 > /etc/sysctl.d/40-max-user-watches.conf"
+$ sudo sysctl --system
+```
+
+#### The technical details
+Listen uses `inotify` by default on Linux to monitor directories for changes.
+It's not uncommon to encounter a system limit on the number of files you can monitor.
+For example, Ubuntu Lucid's (64bit) `inotify` limit is set to 8192.
+
+You can get your current inotify file watch limit by executing:
+```
+$ cat /proc/sys/fs/inotify/max_user_watches
+```
+When this limit is not enough to monitor all files inside a directory, the limit must be increased for Listen to work properly.
+
+You can set a new limit temporarily with:
+```
+$ sudo sysctl fs.inotify.max_user_watches=524288
+$ sudo sysctl -p
+```
+If you like to make your limit permanent, use:
+```
+$ sudo sh -c "echo fs.inotify.max_user_watches=524288 >> /etc/sysctl.conf"
+$ 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.
+
+#### 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).
 
 ### Issues and Troubleshooting
 
@@ -267,7 +342,35 @@ If the gem doesn't work as expected, start by setting `LISTEN_GEM_DEBUGGING=debu
 
 *NOTE: without providing the output after setting the `LISTEN_GEM_DEBUGGING=debug` environment variable, it is usually impossible to guess why `listen` is not working as expected.*
 
-See [TROUBLESHOOTING](https://github.com/guard/listen/wiki/Troubleshooting)
+#### 3 steps before you start diagnosing problems
+These 3 steps will:
+
+- help quickly troubleshoot obscure problems (trust me, most of them are obscure)
+- help quickly identify the area of the problem (a full list is below)
+- help you get familiar with listen's diagnostic mode (it really comes in handy, trust me)
+- help you create relevant output before you submit an issue (so we can respond with answers instead of tons of questions)
+
+Step 1 - The most important option in Listen
+For effective troubleshooting set the `LISTEN_GEM_DEBUGGING=info` variable before starting `listen`.
+
+Step 2 - Verify polling works
+Polling has to work ... or something is really wrong (and we need to know that before anything else).
+
+(see force_polling option).
+
+After starting `listen`, you should see something like:
+```
+INFO -- : Record.build(): 0.06773114204406738 seconds
+```
+Step 3 - Trigger some changes directly without using editors or apps
+Make changes e.g. touch foo or echo "a" >> foo (for troubleshooting, avoid using an editor which could generate too many misleading events).
+
+You should see something like:
+```
+INFO -- : listen: raw changes: [[:added, "/home/me/foo"]]
+INFO -- : listen: final changes: {:modified=>[], :added=>["/home/me/foo"], :removed=>[]}
+```
+"raw changes" contains changes collected during the :wait_for_delay and :latency intervals, while "final changes" is what listen decided are relevant changes (for better editor support).
 
 ## Performance
 
@@ -289,7 +392,11 @@ Also, if the directories you're watching contain many files, make sure you're:
 
 When in doubt, `LISTEN_GEM_DEBUGGING=debug` can help discover the actual events and time they happened.
 
-See also [Tips and Techniques](https://github.com/guard/listen/wiki/Tips-and-Techniques).
+## Tips and Techniques
+- Watch only directories you're interested in.
+- Set your editor to save quickly (e.g. without backup files, without atomic-save)
+- Tweak the `:latency` and `:wait_for_delay` options until you get good results (see [options](#options)).
+- Add `:ignore` rules to silence all events you don't care about (reduces a lot of noise, especially if you use it on directories)
 
 ## Development
 

data/bin/listen

@@ -1,12 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'listen'
 require 'listen/cli'
 
-unless defined?(JRUBY_VERSION)
-  if Signal.list.keys.include?('INT')
-    Signal.trap('INT') { Thread.new { Listen.stop } }
-  end
+if !defined?(JRUBY_VERSION) && Signal.list.keys.include?('INT')
+  Signal.trap('INT') { Thread.new { Listen.stop } }
 end
 
 Listen::CLI.start

data/lib/listen/adapter.rb

@@ -11,7 +11,7 @@ module Listen
   module Adapter
     OPTIMIZED_ADAPTERS = [Darwin, Linux, BSD, Windows].freeze
     POLLING_FALLBACK_MESSAGE = 'Listen will be polling for changes.'\
-      'Learn more at https://github.com/guard/listen#listen-adapters.'.freeze
+      'Learn more at https://github.com/guard/listen#listen-adapters.'
 
     class << self
       def select(options = {})
@@ -24,14 +24,14 @@ module Listen
         Polling
       rescue
         Listen.logger.warn format('Adapter: failed: %s:%s', $ERROR_POSITION.inspect,
-                           $ERROR_POSITION * "\n")
+                                  $ERROR_POSITION * "\n")
         raise
       end
 
       private
 
       def _usable_adapter_class
-        OPTIMIZED_ADAPTERS.detect(&:usable?)
+        OPTIMIZED_ADAPTERS.find(&:usable?)
       end
 
       def _warn_polling_fallback(options)

data/lib/listen/adapter/base.rb

@@ -8,13 +8,11 @@ require 'listen/thread'
 module Listen
   module Adapter
     class Base
-      attr_reader :options
+      attr_reader :options, :config
 
       # TODO: only used by tests
       DEFAULTS = {}.freeze
 
-      attr_reader :config
-
       def initialize(config)
         @started = false
         @config = config
@@ -31,6 +29,7 @@ module Listen
       end
 
       # TODO: it's a separate method as a temporary workaround for tests
+      # rubocop:disable Metrics/MethodLength
       def configure
         if @configured
           Listen.logger.warn('Adapter already configured!')
@@ -57,6 +56,7 @@ module Listen
           @snapshots[dir] = snapshot
         end
       end
+      # rubocop:enable Metrics/MethodLength
 
       def started?
         @started
@@ -73,7 +73,7 @@ module Listen
         @started = true
 
         @run_thread = Listen::Thread.new("run_thread") do
-          @snapshots.values.each do |snapshot|
+          @snapshots.each_value do |snapshot|
             _timed('Record.build()') { snapshot.record.build }
           end
           _run

data/lib/listen/adapter/bsd.rb

@@ -7,7 +7,7 @@
 module Listen
   module Adapter
     class BSD < Base
-      OS_REGEXP = /bsd|dragonfly/i
+      OS_REGEXP = /bsd|dragonfly/i.freeze
 
       DEFAULTS = {
         events: [
@@ -73,8 +73,7 @@ module Listen
       def _change(event_flags)
         { modified: [:attrib, :extend],
           added:    [:write],
-          removed:  [:rename, :delete]
-        }.each do |change, flags|
+          removed:  [:rename, :delete] }.each do |change, flags|
           return change unless (flags & event_flags).empty?
         end
         nil
@@ -87,7 +86,7 @@ module Listen
       def _watch_for_new_file(event)
         queue = event.watcher.queue
         _find(_event_path(event).to_s) do |file_path|
-          unless queue.watchers.detect { |_, v| v.path == file_path.to_s }
+          unless queue.watchers.find { |_, v| v.path == file_path.to_s }
             _watch_file(file_path, queue)
           end
         end

data/lib/listen/adapter/config.rb

@@ -5,10 +5,7 @@ require 'pathname'
 module Listen
   module Adapter
     class Config
-      attr_reader :directories
-      attr_reader :silencer
-      attr_reader :queue
-      attr_reader :adapter_options
+      attr_reader :directories, :silencer, :queue, :adapter_options
 
       def initialize(directories, queue, silencer, adapter_options)
         # Default to current directory if no directories are supplied

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
+      OS_REGEXP = /darwin(?<major_version>(1|2)\d+)/i.freeze
 
       # The default delay between checking for changes.
       DEFAULTS = { latency: 0.1 }.freeze
@@ -51,7 +51,7 @@ module Listen
 
       def _process_changes(dirs)
         dirs.each do |dir|
-          dir = Pathname.new(dir.sub(%r{\/$}, ''))
+          dir = Pathname.new(dir.sub(%r{/$}, ''))
 
           @callbacks.each do |watched_dir, callback|
             if watched_dir.eql?(dir) || Listen::Directory.ascendant_of?(watched_dir, dir)

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
+      OS_REGEXP = /linux/i.freeze
 
       DEFAULTS = {
         events: [
@@ -22,7 +22,7 @@ module Listen
       private
 
       WIKI_URL = 'https://github.com/guard/listen'\
-        '/wiki/Increasing-the-amount-of-inotify-watchers'.freeze
+        '/blob/master/README.md#increasing-the-amount-of-inotify-watchers'
 
       INOTIFY_LIMIT_MESSAGE = <<-EOS.gsub(/^\s*/, '')
         FATAL: Listen error: unable to monitor directories for changes.
@@ -41,6 +41,7 @@ module Listen
         @worker.run
       end
 
+      # rubocop:disable Metrics/MethodLength
       def _process_event(dir, event)
         # NOTE: avoid using event.absolute_name since new API
         # will need to have a custom recursion implemented
@@ -73,6 +74,7 @@ module Listen
 
         _queue_change(:file, dir, rel_path, params)
       end
+      # rubocop:enable Metrics/MethodLength
 
       def _skip_event?(event)
         # Event on root directory

data/lib/listen/adapter/polling.rb

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

data/lib/listen/adapter/windows.rb

@@ -5,7 +5,7 @@ module Listen
     # Adapter implementation for Windows `wdm`.
     #
     class Windows < Base
-      OS_REGEXP = /mswin|mingw|cygwin/i
+      OS_REGEXP = /mswin|mingw|cygwin/i.freeze
 
       BUNDLER_DECLARE_GEM = <<-EOS.gsub(/^ {6}/, '')
         Please add the following to your Gemfile to avoid polling for changes:
@@ -18,7 +18,7 @@ module Listen
         true
       rescue LoadError
         Listen.logger.debug format('wdm - load failed: %s:%s', $ERROR_INFO,
-                            $ERROR_POSITION * "\n")
+                                   $ERROR_POSITION * "\n")
 
         Kernel.warn BUNDLER_DECLARE_GEM
         false
@@ -38,8 +38,7 @@ module Listen
           yield([:dir, change])
         end
 
-        events = [:attributes, :last_write]
-        @worker.watch_recursively(dir.to_s, *events) do |change|
+        @worker.watch_recursively(dir.to_s, :attributes, :last_write) do |change|
           yield([:attr, change])
         end
       end
@@ -48,6 +47,7 @@ module Listen
         @worker.run!
       end
 
+      # rubocop:disable Metrics/MethodLength
       def _process_event(dir, event)
         Listen.logger.debug "wdm - callback: #{event.inspect}"
 
@@ -67,10 +67,11 @@ module Listen
             _queue_change(:file, dir, rel_path, options)
           end
         when :dir
-          if change.type == :removed
+          case change.type
+          when :removed
             # TODO: check if watched dir?
             _queue_change(:dir, dir, Pathname(rel_path).dirname.to_s, {})
-          elsif change.type == :added
+          when :added
             _queue_change(:dir, dir, rel_path, {})
             # do nothing - changed directory means either:
             #   - removed subdirs (handled above)
@@ -80,20 +81,15 @@ module Listen
             # so what's left?
           end
         end
-      rescue
-        details = event.inspect
-        Listen.logger.error format('wdm - callback (%s): %s:%s', details, $ERROR_INFO,
-                            $ERROR_POSITION * "\n")
-        raise
       end
+      # rubocop:enable Metrics/MethodLength
 
       def _change(type)
         { modified: [:modified, :attrib], # TODO: is attrib really passed?
           added:    [:added, :renamed_new_file],
-          removed:  [:removed, :renamed_old_file] }.each do |change, types|
-          return change if types.include?(type)
+          removed:  [:removed, :renamed_old_file] }.find do |change, types|
+          types.include?(type) and break change
         end
-        nil
       end
     end
   end

data/lib/listen/change.rb

@@ -30,13 +30,16 @@ module Listen
     end
 
     # Invalidate some part of the snapshot/record (dir, file, subtree, etc.)
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     def invalidate(type, rel_path, options)
       watched_dir = Pathname.new(record.root)
 
       change = options[:change]
       cookie = options[:cookie]
 
-      if !cookie && config.silenced?(rel_path, type)
+      if !cookie && @config.silenced?(rel_path, type)
         Listen.logger.debug { "(silenced): #{rel_path.inspect}" }
         return
       end
@@ -50,29 +53,17 @@ module Listen
 
       if change
         options = cookie ? { cookie: cookie } : {}
-        config.queue(type, change, watched_dir, rel_path, options)
+        @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)
-      else
-        change = File.change(record, rel_path)
-        return if !change || options[:silence]
-        config.queue(:file, change, watched_dir, rel_path)
+      elsif (change = File.change(record, rel_path)) && !options[:silence]
+        @config.queue(:file, change, watched_dir, rel_path)
       end
-    rescue RuntimeError => ex
-      msg = format(
-        '%s#%s crashed %s:%s',
-        self.class,
-        __method__,
-        exinspect,
-        ex.backtrace * "\n")
-      Listen.logger.error(msg)
-      raise
     end
-
-    private
-
-    attr_reader :config
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
   end
 end

data/lib/listen/cli.rb

@@ -35,6 +35,7 @@ module Listen
 
   class Forwarder
     attr_reader :logger
+
     def initialize(options)
       @options = options
       @logger = ::Logger.new(STDOUT, level: ::Logger::INFO)
@@ -43,6 +44,7 @@ module Listen
 
     def start
       logger.info 'Starting listen...'
+
       directory = @options[:directory]
       relative = @options[:relative]
       callback = proc do |modified, added, removed|
@@ -53,10 +55,7 @@ module Listen
         end
       end
 
-      listener = Listen.to(
-        directory,
-        relative: relative,
-        &callback)
+      listener = Listen.to(directory, relative: relative, &callback)
 
       listener.start
 

data/lib/listen/directory.rb

@@ -5,6 +5,7 @@ require 'set'
 module Listen
   # TODO: refactor (turn it into a normal object, cache the stat, etc)
   class Directory
+    # rubocop:disable Metrics/MethodLength
     def self.scan(snapshot, rel_path, options)
       record = snapshot.record
       dir = Pathname.new(record.root)
@@ -38,22 +39,19 @@ module Listen
       previous = previous.reject { |entry, _| current.include? path + entry }
 
       _async_changes(snapshot, Pathname.new(rel_path), previous, options)
-
     rescue Errno::ENOENT, Errno::EHOSTDOWN
       record.unset_path(rel_path)
       _async_changes(snapshot, Pathname.new(rel_path), previous, options)
-
     rescue Errno::ENOTDIR
       # TODO: path not tested
       record.unset_path(rel_path)
       _async_changes(snapshot, path, previous, options)
       _change(snapshot, :file, rel_path, options)
     rescue
-      Listen.logger.warn do
-        format('scan DIED: %s:%s', $ERROR_INFO, $ERROR_POSITION * "\n")
-      end
+      Listen.logger.warn { format('scan DIED: %s:%s', $ERROR_INFO, $ERROR_POSITION * "\n") }
       raise
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.ascendant_of?(base, other)
       other.ascend do |ascendant|
@@ -88,8 +86,8 @@ module Listen
       # https://github.com/jruby/jruby/issues/3840
       exists = path.exist?
       directory = path.directory?
-      return path.children unless exists && !directory
-      raise Errno::ENOTDIR, path.to_s
+      exists && !directory and raise Errno::ENOTDIR, path.to_s
+      path.children
     end
   end
 end

data/lib/listen/event/config.rb

@@ -3,16 +3,15 @@
 module Listen
   module Event
     class Config
-      attr_reader :listener
-      attr_reader :event_queue
-      attr_reader :min_delay_between_events
+      attr_reader :listener, :event_queue, :min_delay_between_events
 
       def initialize(
         listener,
         event_queue,
         queue_optimizer,
         wait_for_delay,
-        &block)
+        &block
+      )
 
         @listener = listener
         @event_queue = event_queue
@@ -26,7 +25,7 @@ module Listen
       end
 
       def call(*args)
-        @block.call(*args) if @block
+        @block&.call(*args)
       end
 
       def timestamp

data/lib/listen/event/loop.rb

@@ -64,12 +64,9 @@ module Listen
       end
 
       def stop
-        return if stopped?
         transition! :stopped
 
-        if @wait_thread.alive?
-          @wait_thread.join
-        end
+        @wait_thread&.join
         @wait_thread = nil
       end
 

data/lib/listen/event/processor.rb

@@ -51,10 +51,10 @@ module Listen
       end
 
       def _check_stopped
-        return unless @listener.stopped?
-
-        _flush_wakeup_reasons
-        raise Stopped
+        if @listener.stopped?
+          _flush_wakeup_reasons
+          raise Stopped
+        end
       end
 
       def _sleep(seconds)
@@ -70,22 +70,22 @@ module Listen
       end
 
       def _remember_time_of_first_unprocessed_event
-        @first_unprocessed_event_time ||= _timestamp
+        @_remember_time_of_first_unprocessed_event ||= _timestamp
       end
 
       def _reset_no_unprocessed_events
-        @first_unprocessed_event_time = nil
+        @_remember_time_of_first_unprocessed_event = nil
       end
 
       def _deadline
-        @first_unprocessed_event_time + @latency
+        @_remember_time_of_first_unprocessed_event + @latency
       end
 
       # blocks until event is popped
       # returns the event or `nil` when the event_queue is closed
       def _wait_until_events
         config.event_queue.pop.tap do |_event|
-          @first_unprocessed_event_time ||= _timestamp
+          @_remember_time_of_first_unprocessed_event ||= _timestamp
         end
       end
 
@@ -114,8 +114,12 @@ module Listen
         return if result.all?(&:empty?)
 
         block_start = _timestamp
-        config.call(*result)
-        Listen.logger.debug "Callback took #{_timestamp - block_start} sec"
+        exception_note = " (exception)"
+        ::Listen::Thread.rescue_and_log('_process_changes') do
+          config.call(*result)
+          exception_note = nil
+        end
+        Listen.logger.debug "Callback#{exception_note} took #{_timestamp - block_start} sec"
       end
 
       attr_reader :config

data/lib/listen/event/queue.rb

@@ -30,21 +30,21 @@ module Listen
         fail "Invalid change: #{change.inspect}" unless change.is_a?(Symbol)
         fail "Invalid path: #{path.inspect}" unless path.is_a?(String)
 
-        dir = _safe_relative_from_cwd(dir)
-        event_queue.public_send(:<<, [type, change, dir, path, options])
+        dir = if @config.relative?
+          _safe_relative_from_cwd(dir)
+        else
+          dir
+        end
+        @event_queue << [type, change, dir, path, options]
       end
 
-      delegate empty?: :event_queue
-      delegate pop: :event_queue
-      delegate close: :event_queue
+      delegate empty?: :@event_queue
+      delegate pop: :@event_queue
+      delegate close: :@event_queue
 
       private
 
-      attr_reader :event_queue
-      attr_reader :config
-
       def _safe_relative_from_cwd(dir)
-        return dir unless config.relative?
         dir.relative_path_from(Pathname.pwd)
       rescue ArgumentError
         dir

data/lib/listen/file.rb

@@ -4,6 +4,9 @@ require 'digest/md5'
 
 module Listen
   class File
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     def self.change(record, rel_path)
       path = Pathname.new(record.root) + rel_path
       lstat = path.lstat
@@ -74,6 +77,9 @@ module Listen
       Listen.logger.debug "lstat failed for: #{rel_path} (#{$ERROR_INFO})"
       raise
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def self.inaccurate_mac_time?(stat)
       # 'mac' means Modified/Accessed/Created

data/lib/listen/fsm.rb

@@ -113,8 +113,8 @@ module Listen
         @name = name
         @block = block
         @transitions = if transitions
-                         Array(transitions).map(&:to_sym)
-                       end
+          Array(transitions).map(&:to_sym)
+        end
       end
 
       def call(obj)

data/lib/listen/listener.rb

@@ -33,6 +33,7 @@ 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 : {}
 
@@ -60,6 +61,7 @@ module Listen
 
       initialize_fsm
     end
+    # rubocop:enable Metrics/MethodLength
 
     start_state :initializing
 

data/lib/listen/listener/config.rb

@@ -25,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
@@ -35,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/logger.rb

@@ -16,18 +16,19 @@ module Listen
     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
+      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

data/lib/listen/options.rb

@@ -5,21 +5,22 @@ module Listen
     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

@@ -62,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
 
@@ -91,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)
@@ -106,7 +104,7 @@ module Listen
       end
     end
 
-    def _detect_possible_editor_save(changes)
+    def editor_modified?(changes)
       return unless changes.size == 2
 
       from_type = from = nil
@@ -118,17 +116,14 @@ module Listen
           from_type, _from_change, _, from, = data
         when :moved_to
           to_type, _to_change, to_dir, to, = data
-        else
-          return nil
         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.rb

@@ -10,14 +10,16 @@ module Listen
     # TODO: deprecate
 
     attr_reader :root
+
     def initialize(directory)
       @tree = _auto_hash
       @root = directory.to_s
     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)
@@ -33,41 +35,26 @@ 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
-          _sub_tree(rel_path)
-        end
-
-      result = {}
-      subtree.each do |key, values|
-        # only get data for file entries
-        result[key] = values.key?(:mtime) ? values : {}
+      subtree = if ['', '.'].include? rel_path.to_s
+        @tree
+      else
+        @tree[rel_path.to_s] ||= _auto_hash
+        @tree[rel_path.to_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
-        end
+      subtree.transform_values do |values|
+        # only get data for file entries
+        values.key?(:mtime) ? values : {}
       end
     end
 
@@ -85,29 +72,27 @@ 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
 

data/lib/listen/record/entry.rb

@@ -17,7 +17,7 @@ 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

data/lib/listen/record/symlink_detector.rb

@@ -6,9 +6,9 @@ module Listen
   # @private api
   class Record
     class SymlinkDetector
-      WIKI = 'https://github.com/guard/listen/wiki/Duplicate-directory-errors'.freeze
+      WIKI = 'https://github.com/guard/listen/wiki/Duplicate-directory-errors'
 
-      SYMLINK_LOOP_ERROR = <<-EOS.freeze
+      SYMLINK_LOOP_ERROR = <<-EOS
         ** ERROR: directory is already being watched! **
 
         Directory: %s
@@ -33,8 +33,8 @@ module Listen
       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 Error, 'Failed due to looped symlinks'
       end
     end
   end

data/lib/listen/silencer.rb

@@ -14,7 +14,7 @@ module Listen
       | log
       | tmp
       |vendor/ruby
-    )(/|$)}x
+    )(/|$)}x.freeze
 
     # The default list of files that get ignored.
     DEFAULT_IGNORED_EXTENSIONS = %r{(?:
@@ -55,7 +55,7 @@ module Listen
       | \.DS_Store
       | \.tmp
       | ~
-    )$}x
+    )$}x.freeze
 
     attr_accessor :only_patterns, :ignore_patterns
 
@@ -75,16 +75,18 @@ module Listen
     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
-
-      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

@@ -9,36 +9,43 @@ 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.
-      def new(name)
+      # rubocop:disable Style/MultilineBlockChain
+      def new(name, &block)
         thread_name = "listen-#{name}"
-
         caller_stack = caller
+
         ::Thread.new do
-          begin
-            yield
-          rescue Exception => ex
-            _log_exception(ex, thread_name, caller_stack)
-            nil
-          end
+          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 => exception # rubocop:disable Lint/RescueException
+        _log_exception(exception, method_name, caller_stack: caller_stack)
+      end
 
       private
 
-      def _log_exception(ex, thread_name, caller_stack)
-        complete_backtrace = [*ex.backtrace, "--- Thread.new ---", *caller_stack]
-        message = "Exception rescued in #{thread_name}:\n#{_exception_with_causes(ex)}\n#{complete_backtrace * "\n"}"
+      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(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.pre.3'
+  VERSION = '3.3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 3.3.0.pre.3
+  version: 3.3.4
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2020-12-31 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
@@ -99,6 +99,12 @@ licenses:
 - MIT
 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.3.4
+  homepage_uri: https://github.com/guard/listen
+  source_code_uri: https://github.com/guard/listen/tree/v3.3.4
+  wiki_uri: https://github.com/guard/listen/wiki
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -110,9 +116,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.1
 signing_key: