listen 3.5.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5e25ac03ba4db04d535b66611b0338245255079b9fbd0cee33ebab4d47ec8c2
-  data.tar.gz: f1976b3a4e76b6d805707c882ef6afb64b35d9589a09c908952d4db793f7d185
+  metadata.gz: 800a9d0af997cb48bc330b0aeaecdcb39b53e9bdeb2dbed6c08fd03b237a3d36
+  data.tar.gz: 5caa12c52d09e7447d0f1b43fddadf03e4e33ae4c611bd0ed7d367e3cd3a280b
 SHA512:
-  metadata.gz: b4e15faa34302e66a6b0ba0a6be476b281a23de75711b053bb06523c19773839a1e093588e206d558747852ffe2c0b1893b88cb1b65c7c33440f1f414a12393b
-  data.tar.gz: a893ac6996ee6294ffc3bdbd2aa1ccf7088fe1365e422858ce32f8d7c5b0cf9ab95931c987c38ee456c21fa14ab0bf9578c0c42bc3cfd41484f3fa21475375d4
+  metadata.gz: 8fa9b8758f30b8ececde07ca321a23fb02c9cfbec59e587011b1598d297f8a0a451728fb394e0bc1fa182e7ef40e4598bfa82b035bdccc29f6375b5df95dda6f
+  data.tar.gz: 8b94d5ab7085f27382cfca52d32ff8717c3d17f14ed3632a96853e8e4bcd2174bbc8f5f8f0ff3709f739b13c440fb87a82540bb0ae784395896fb0513837895a

data/README.md

@@ -25,10 +25,8 @@ 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.).
-* Specs suite on JRuby and Rubinius aren't reliable on Travis CI, but should work.
 * Windows and \*BSD adapter aren't continuously and automatically tested.
 * OSX adapter has some performance limitations ([#342](https://github.com/guard/listen/issues/342)).
-* FreeBSD users need patched version of rb-kqueue (as of 2020/11). See #475 for the issue, mat813/rb-kqueue#12 for the patch, and Bug 250432 in bugzilla.
 * 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).
 
 Pull requests or help is very welcome for these.
@@ -99,23 +97,23 @@ The callback receives **three** array parameters: `modified`, `added` and `remov
 Each of these three is always an array with 0 or more entries.
 Each array entry is an absolute path.
 
-### Pause / unpause / stop
+### Pause / start / stop
 
-Listeners can also be easily paused/unpaused:
+Listeners can also be easily paused and later un-paused with start:
 
 ``` ruby
 listener = Listen.to('dir/path/to/listen') { |modified, added, removed| puts 'handle changes here...' }
 
 listener.start
-listener.paused? # => false
+listener.paused?     # => false
 listener.processing? # => true
 
-listener.pause   # stops processing changes (but keeps on collecting them)
-listener.paused? # => true
+listener.pause       # stops processing changes (but keeps on collecting them)
+listener.paused?     # => true
 listener.processing? # => false
 
-listener.unpause # resumes processing changes ("start" would do the same)
-listener.stop    # stop both listening to changes and processing them
+listener.start       # resumes processing changes
+listener.stop        # stop both listening to changes and processing them
 ```
 
   Note: While paused, `listen` keeps on collecting changes in the background - to clear them, call `stop`.
@@ -124,7 +122,7 @@ listener.stop    # stop both listening to changes and processing them
 
 ### Ignore / ignore!
 
-`Listen` ignores some directories and extensions by default (See DEFAULT_IGNORED_DIRECTORIES and DEFAULT_IGNORED_EXTENSIONS in Listen::Silencer).
+`Listen` ignores some directories and extensions by default (See DEFAULT_IGNORED_FILES and DEFAULT_IGNORED_EXTENSIONS in Listen::Silencer).
 You can add ignoring patterns with the `ignore` option/method or overwrite default with `ignore!` option/method.
 
 ``` ruby
@@ -159,7 +157,7 @@ All the following options can be set through the `Listen.to` after the directory
 
 ```ruby
 ignore: [%r{/foo/bar}, /\.pid$/, /\.coffee$/]   # Ignore a list of paths
-                                                # default: See DEFAULT_IGNORED_DIRECTORIES and DEFAULT_IGNORED_EXTENSIONS in Listen::Silencer
+                                                # default: See DEFAULT_IGNORED_FILES and DEFAULT_IGNORED_EXTENSIONS in Listen::Silencer
 
 ignore!: %r{/foo/bar}                           # Same as ignore options, but overwrite default ignored paths.
 

data/lib/listen/adapter/base.rb

@@ -51,7 +51,7 @@ module Listen
         # TODO: separate config per directory (some day maybe)
         change_config = Change::Config.new(config.queue, config.silencer)
         config.directories.each do |dir|
-          record = Record.new(dir)
+          record = Record.new(dir, config.silencer)
           snapshot = Change.new(change_config, record)
           @snapshots[dir] = snapshot
         end

data/lib/listen/adapter/linux.rb

@@ -24,17 +24,14 @@ module Listen
       README_URL = 'https://github.com/guard/listen'\
         '/blob/master/README.md#increasing-the-amount-of-inotify-watchers'
 
-      INOTIFY_LIMIT_MESSAGE = <<-EOS
-        FATAL: Listen error: unable to monitor directories for changes.
-        Visit #{README_URL} for info on how to fix this.
-      EOS
-
       def _configure(directory, &callback)
         require 'rb-inotify'
         @worker ||= ::INotify::Notifier.new
         @worker.watch(directory.to_s, *options.events, &callback)
       rescue Errno::ENOSPC
-        abort(INOTIFY_LIMIT_MESSAGE)
+        raise ::Listen::Error::INotifyMaxWatchesExceeded, <<~EOS
+          Unable to monitor directories for changes because iNotify max watches exceeded. See #{README_URL} .
+        EOS
       end
 
       def _run

data/lib/listen/directory.rb

@@ -36,7 +36,7 @@ module Listen
       end
 
       # TODO: this is not tested properly
-      previous = previous.reject { |entry, _| current.include? path + entry }
+      previous = previous.reject { |entry, _| current.include?(path + entry) }
 
       _async_changes(snapshot, Pathname.new(rel_path), previous, options)
     rescue Errno::ENOENT, Errno::EHOSTDOWN

data/lib/listen/error.rb

@@ -6,5 +6,6 @@ module Listen
   class Error < RuntimeError
     class NotStarted < Error; end
     class SymlinkLoop < Error; end
+    class INotifyMaxWatchesExceeded < Error; end
   end
 end

data/lib/listen/file.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'digest/md5'
+require 'digest'
 
 module Listen
   class File
@@ -53,7 +53,7 @@ module Listen
       # then at ???14.998, but the fstat time would be ???14.0 in
       # both cases).
       #
-      # If change happend at ???14.999997, the mtime is 14.0, so for
+      # If change happened at ???14.999997, the mtime is 14.0, so for
       # an mtime=???14.0 we assume it could even be almost ???15.0
       #
       # So if Time.now.to_f is ???15.999998 and stat reports mtime
@@ -67,9 +67,11 @@ module Listen
       #
       return if data[:mtime].to_i + 2 <= Time.now.to_f
 
-      md5 = Digest::MD5.file(path).digest
-      record.update_file(rel_path, data.merge(md5: md5))
-      :modified if record_data[:md5] && md5 != record_data[:md5]
+      sha = Digest::SHA256.file(path).digest
+      record.update_file(rel_path, data.merge(sha: sha))
+      if record_data[:sha] && sha != record_data[:sha]
+        :modified
+      end
     rescue SystemCallError
       record.unset_path(rel_path)
       :removed

data/lib/listen/record.rb

@@ -11,14 +11,15 @@ module Listen
 
     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)
-      if ![nil, '', '.'].include?(rel_path)
-        @tree[rel_path] ||= {}
+      if !empty_dirname?(rel_path.to_s)
+        @tree[rel_path.to_s]
       end
     end
 
@@ -34,32 +35,32 @@ module Listen
 
     def file_data(rel_path)
       dirname, basename = Pathname(rel_path).split.map(&:to_s)
-      if [nil, '', '.'].include? dirname
-        @tree[basename] ||= {}
+      if empty_dirname?(dirname)
         @tree[basename].dup
       else
-        @tree[dirname] ||= {}
         @tree[dirname][basename] ||= {}
         @tree[dirname][basename].dup
       end
     end
 
     def dir_entries(rel_path)
-      subtree = if ['', '.'].include? rel_path.to_s
+      rel_path_s = rel_path.to_s
+      subtree = if empty_dirname?(rel_path_s)
         @tree
       else
-        @tree[rel_path.to_s] ||= _auto_hash
-        @tree[rel_path.to_s]
+        @tree[rel_path_s]
       end
 
-      subtree.transform_values do |values|
-        # only get data for file entries
-        values.key?(:mtime) ? values : {}
+      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
@@ -71,15 +72,18 @@ module Listen
 
     private
 
-    def _auto_hash
-      Hash.new { |h, k| h[k] = {} }
+    def empty_dirname?(dirname)
+      dirname == '.' || dirname == ''
+    end
+
+    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)
       end
     end
@@ -87,7 +91,7 @@ module Listen
     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)
+      if empty_dirname?(dirname.to_s)
         if @tree.key?(basename)
           @tree.delete(basename)
         end
@@ -98,6 +102,8 @@ module Listen
 
     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.freeze
+      | 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,25 +59,23 @@ module Listen
       | \.DS_Store
       | \.tmp
       | ~
-    )$}x.freeze
+    )\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
 
       _ignore?(path) || (only_patterns && type == :file && !_only?(path))
     end
@@ -91,7 +93,7 @@ module Listen
     def _init_ignores(ignores, overrides)
       patterns = []
       unless overrides
-        patterns << DEFAULT_IGNORED_DIRECTORIES
+        patterns << DEFAULT_IGNORED_FILES
         patterns << DEFAULT_IGNORED_EXTENSIONS
       end
 

data/lib/listen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.7.1
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
@@ -103,9 +103,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.5.0
+  documentation_uri: https://www.rubydoc.info/gems/listen/3.7.1
   homepage_uri: https://github.com/guard/listen
-  source_code_uri: https://github.com/guard/listen/tree/v3.5.0
+  source_code_uri: https://github.com/guard/listen/tree/v3.7.1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -114,7 +114,7 @@ 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:
   - - ">="