listen 3.4.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 393d712be43ee070ac7d14a4ddc090176c7f388ae2f2a7e447f674fc8875f27f
-  data.tar.gz: b4dfff00d893121350cb41362425a52ae4c78af20431b0567071a381d9216786
+  metadata.gz: 656e49f1b6eca9a31fd9c09b916aa73ed6d3df255e4859c4b77ebdb7a0f4a6bf
+  data.tar.gz: 98be9697f64242c869fa47211477f84f8b636402fa4e865989e1b54e020a8032
 SHA512:
-  metadata.gz: 7c7e46108e8cc30fc15289e12bedf0866ea6ef41a6798f701e16f265205ffee95a23b4526b098ae26ac910c942084d34280de31878e696e93f4d14a8f674c3ec
-  data.tar.gz: 3edd0902f5833038beb0b8e33b4f6f4933bea1659d51b68dbbc9a5abc63bf3ee3edd25a56309d16cd6acffead3e3be05f6ebc4d2895c893e70baff941015fcc1
+  metadata.gz: af8bfbe37ce9b791f78ebdee29c32781742f3e58e98eae92381c34169bdf389db38f82228b77a56ba13e73646dbb7d2dae9a275be0c5b75e300010adb4382129
+  data.tar.gz: f97c76664f9aa893bd89bcf93484701a6bda473ab9b13e2101cacb4f450f5ca0d116362027368fe561a724fb0c55213bbc6944bd58b0ee4cb6812f588d00feeb

data/CONTRIBUTING.md

@@ -4,7 +4,7 @@ Contribute to Listen
 File an issue
 -------------
 
-If you haven't already, first see [TROUBLESHOOTING](https://github.com/guard/listen/wiki/Troubleshooting) for known issues, solutions and workarounds.
+If you haven't already, first see [TROUBLESHOOTING](https://github.com/guard/listen/blob/master/README.md#Issues-and-Troubleshooting) for known issues, solutions and workarounds.
 
 You can report bugs and feature requests to [GitHub Issues](https://github.com/guard/listen/issues).
 
@@ -16,7 +16,7 @@ Try to figure out where the issue belongs to: Is it an issue with Listen itself
 
 **It's most likely that your bug gets resolved faster if you provide as much information as possible!**
 
-The MOST useful information is debugging output from Listen (`LISTEN_GEM_DEBUGGING=1`) - see [TROUBLESHOOTING](https://github.com/guard/listen/wiki/Troubleshooting) for details.
+The MOST useful information is debugging output from Listen (`LISTEN_GEM_DEBUGGING=1`) - see [TROUBLESHOOTING](https://github.com/guard/listen/blob/master/README.md#Issues-and-Troubleshooting) for details.
 
 
 Development

data/README.md

@@ -2,8 +2,6 @@
 
 The `listen` gem listens to file modifications and notifies you about the changes.
 
-:exclamation: `Listen` is currently accepting more maintainers. Please [read this](https://github.com/guard/guard/wiki/Maintainers) if you're interested in joining the team.
-
 [![Development Status](https://github.com/guard/listen/workflows/Development/badge.svg)](https://github.com/guard/listen/actions?workflow=Development)
 [![Gem Version](https://badge.fury.io/rb/listen.svg)](http://badge.fury.io/rb/listen)
 [![Code Climate](https://codeclimate.com/github/guard/listen.svg)](https://codeclimate.com/github/guard/listen)
@@ -27,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.

data/lib/listen/adapter/linux.rb

@@ -21,12 +21,12 @@ module Listen
 
       private
 
-      WIKI_URL = 'https://github.com/guard/listen'\
+      README_URL = 'https://github.com/guard/listen'\
         '/blob/master/README.md#increasing-the-amount-of-inotify-watchers'
 
-      INOTIFY_LIMIT_MESSAGE = <<-EOS.gsub(/^\s*/, '')
+      INOTIFY_LIMIT_MESSAGE = <<-EOS
         FATAL: Listen error: unable to monitor directories for changes.
-        Visit #{WIKI_URL} for info on how to fix this.
+        Visit #{README_URL} for info on how to fix this.
       EOS
 
       def _configure(directory, &callback)

data/lib/listen/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Besides programming error exceptions like ArgumentError,
+# all public interface exceptions should be declared here and inherit from Listen::Error.
+module Listen
+  class Error < RuntimeError
+    class NotStarted < Error; end
+    class SymlinkLoop < Error; end
+  end
+end

data/lib/listen/event/loop.rb

@@ -5,15 +5,15 @@ require 'thread'
 require 'timeout'
 require 'listen/event/processor'
 require 'listen/thread'
+require 'listen/error'
 
 module Listen
   module Event
     class Loop
       include Listen::FSM
 
-      class Error < RuntimeError
-        class NotStarted < Error; end
-      end
+      Error = ::Listen::Error
+      NotStarted = ::Listen::Error::NotStarted # for backward compatibility
 
       start_state :pre_start
       state :pre_start
@@ -40,6 +40,7 @@ module Listen
 
       MAX_STARTUP_SECONDS = 5.0
 
+      # @raises Error::NotStarted if background thread hasn't started in MAX_STARTUP_SECONDS
       def start
         # TODO: use a Fiber instead?
         return unless state == :pre_start
@@ -52,7 +53,7 @@ module Listen
 
         Listen.logger.debug("Waiting for processing to start...")
 
-        wait_for_state(:started, MAX_STARTUP_SECONDS) or
+        wait_for_state(:started, timeout: MAX_STARTUP_SECONDS) or
           raise Error::NotStarted, "thread didn't start in #{MAX_STARTUP_SECONDS} seconds (in state: #{state.inspect})"
 
         Listen.logger.debug('Processing started.')

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/fsm.rb

@@ -53,6 +53,9 @@ module Listen
     # if not already, waits for a state change (up to timeout seconds--`nil` means infinite)
     # returns truthy iff the transition to one of the desired state has occurred
     def wait_for_state(*wait_for_states, timeout: nil)
+      wait_for_states.each do |state|
+        state.is_a?(Symbol) or raise ArgumentError, "states must be symbols (got #{state.inspect})"
+      end
       @mutex.synchronize do
         if !wait_for_states.include?(@state)
           @state_changed.wait(@mutex, timeout)

data/lib/listen/record/symlink_detector.rb

@@ -1,12 +1,13 @@
 # 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'
+      README_URL = 'https://github.com/guard/listen/blob/master/README.md'
 
       SYMLINK_LOOP_ERROR = <<-EOS
         ** ERROR: directory is already being watched! **
@@ -15,11 +16,10 @@ module Listen
 
         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,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)
         warn(format(SYMLINK_LOOP_ERROR, symlinked, real_path))
-        raise Error, 'Failed due to looped symlinks'
+        raise ::Listen::Error::SymlinkLoop, 'Failed due to looped symlinks'
       end
     end
   end

data/lib/listen/thread.rb

@@ -24,7 +24,7 @@ module Listen
 
       def rescue_and_log(method_name, *args, caller_stack: nil)
         yield(*args)
-      rescue Exception => exception # rubocop:disable Lint/RescueException
+      rescue => exception
         _log_exception(exception, method_name, caller_stack: caller_stack)
       end
 

data/lib/listen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-31 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
@@ -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
@@ -102,10 +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.4.0
+  documentation_uri: https://www.rubydoc.info/gems/listen/3.6.0
   homepage_uri: https://github.com/guard/listen
-  source_code_uri: https://github.com/guard/listen/tree/v3.4.0
-  wiki_uri: https://github.com/guard/listen/wiki
+  source_code_uri: https://github.com/guard/listen/tree/v3.6.0
 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:
   - - ">="