listen 3.3.1 → 3.4.1

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

@@ -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,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)
-        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/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,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 => exception # rubocop:disable Lint/RescueException
+        _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.1'
+  VERSION = '3.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.1
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-13 00:00:00.000000000 Z
+date: 2021-01-14 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,6 +101,11 @@ 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.4.1
+  homepage_uri: https://github.com/guard/listen
+  source_code_uri: https://github.com/guard/listen/tree/v3.4.1
 post_install_message: 
 rdoc_options: []
 require_paths: