listen 0.5.3 → 3.7.1

data/lib/listen/record.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'thread'
+require 'listen/record/entry'
+require 'listen/record/symlink_detector'
+
+module Listen
+  class Record
+    # TODO: one Record object per watched directory?
+    # TODO: deprecate
+
+    attr_reader :root
+
+    def initialize(directory, silencer)
+      reset_tree
+      @root = directory.to_s
+      @silencer = silencer
+    end
+
+    def add_dir(rel_path)
+      if !empty_dirname?(rel_path.to_s)
+        @tree[rel_path.to_s]
+      end
+    end
+
+    def update_file(rel_path, data)
+      dirname, basename = Pathname(rel_path).split.map(&:to_s)
+      _fast_update_file(dirname, basename, data)
+    end
+
+    def unset_path(rel_path)
+      dirname, basename = Pathname(rel_path).split.map(&:to_s)
+      _fast_unset_path(dirname, basename)
+    end
+
+    def file_data(rel_path)
+      dirname, basename = Pathname(rel_path).split.map(&:to_s)
+      if empty_dirname?(dirname)
+        @tree[basename].dup
+      else
+        @tree[dirname][basename] ||= {}
+        @tree[dirname][basename].dup
+      end
+    end
+
+    def dir_entries(rel_path)
+      rel_path_s = rel_path.to_s
+      subtree = if empty_dirname?(rel_path_s)
+        @tree
+      else
+        @tree[rel_path_s]
+      end
+
+      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
+      reset_tree
+      # TODO: test with a file name given
+      # TODO: test other permissions
+      # TODO: test with mixed encoding
+      symlink_detector = SymlinkDetector.new
+      remaining = ::Queue.new
+      remaining << Entry.new(root, nil, nil)
+      _fast_build_dir(remaining, symlink_detector) until remaining.empty?
+    end
+
+    private
+
+    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 empty_dirname?(dirname.to_s)
+        @tree[basename] = @tree[basename].merge(data)
+      else
+        @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 empty_dirname?(dirname.to_s)
+        if @tree.key?(basename)
+          @tree.delete(basename)
+        end
+      elsif @tree.key?(dirname)
+        @tree[dirname].delete(basename)
+      end
+    end
+
+    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 }
+      add_dir(entry.record_dir_key)
+    rescue Errno::ENOTDIR
+      _fast_try_file(entry)
+    rescue SystemCallError, SymlinkDetector::Error
+      _fast_unset_path(entry.relative, entry.name)
+    end
+
+    def _fast_try_file(entry)
+      _fast_update_file(entry.relative, entry.name, entry.meta)
+    rescue SystemCallError
+      _fast_unset_path(entry.relative, entry.name)
+    end
+  end
+end

data/lib/listen/silencer/controller.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Listen
+  class Silencer
+    class Controller
+      def initialize(silencer, default_options)
+        @silencer = silencer
+
+        opts = default_options
+
+        @prev_silencer_options = {}
+        rules = [:only, :ignore, :ignore!].map do |option|
+          [option, opts[option]] if opts.key? option
+        end
+
+        _reconfigure_silencer(Hash[rules.compact])
+      end
+
+      def append_ignores(*regexps)
+        prev_ignores = Array(@prev_silencer_options[:ignore])
+        _reconfigure_silencer(ignore: [prev_ignores + regexps])
+      end
+
+      def replace_with_bang_ignores(regexps)
+        _reconfigure_silencer(ignore!: regexps)
+      end
+
+      def replace_with_only(regexps)
+        _reconfigure_silencer(only: regexps)
+      end
+
+      private
+
+      def _reconfigure_silencer(extra_options)
+        opts = extra_options.dup
+        opts = opts.map do |key, value|
+          [key, Array(value).flatten.compact]
+        end
+        opts = Hash[opts]
+
+        if opts.key?(:ignore) && opts[:ignore].empty?
+          opts.delete(:ignore)
+        end
+
+        @prev_silencer_options = opts
+        @silencer.configure(@prev_silencer_options.dup.freeze)
+      end
+    end
+  end
+end

data/lib/listen/silencer.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Listen
+  class Silencer
+    # The default list of directories that get ignored.
+    DEFAULT_IGNORED_FILES = %r{\A(?:
+    \.git
+      | \.svn
+      | \.hg
+      | \.rbx
+      | \.bundle
+      | bundle
+      | vendor/bundle
+      | log
+      | tmp
+      | vendor/ruby
+
+      # emacs temp files
+      | \#.+\#
+      | \.\#.+
+      )(/|\z)}x.freeze
+
+    # The default list of files that get ignored.
+    DEFAULT_IGNORED_EXTENSIONS = %r{(?:
+      # Kate's tmp\/swp files
+      \..*\d+\.new
+      | \.kate-swp
+
+      # Gedit tmp files
+      | \.goutputstream-.{6}
+
+      # Intellij files
+      | ___jb_bak___
+      | ___jb_old___
+
+      # Vim swap files and write test
+      | \.sw[px]
+      | \.swpx
+      | ^4913
+
+      # Sed temporary files - but without actual words, like 'sedatives'
+      | (?:\A
+         sed
+
+         (?:
+          [a-zA-Z0-9]{0}[A-Z]{1}[a-zA-Z0-9]{5} |
+          [a-zA-Z0-9]{1}[A-Z]{1}[a-zA-Z0-9]{4} |
+          [a-zA-Z0-9]{2}[A-Z]{1}[a-zA-Z0-9]{3} |
+          [a-zA-Z0-9]{3}[A-Z]{1}[a-zA-Z0-9]{2} |
+          [a-zA-Z0-9]{4}[A-Z]{1}[a-zA-Z0-9]{1} |
+          [a-zA-Z0-9]{5}[A-Z]{1}[a-zA-Z0-9]{0}
+         )
+        )
+
+      # Mutagen sync temporary files
+      | \.mutagen-temporary.*
+
+      # other files
+      | \.DS_Store
+      | \.tmp
+      | ~
+    )\z}x.freeze
+
+    # TODO: deprecate these mutators; use attr_reader instead
+    attr_accessor :only_patterns, :ignore_patterns
+
+    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
+
+    def silenced?(relative_path, type)
+      path = relative_path.to_s   # in case it is a Pathname
+
+      _ignore?(path) || (only_patterns && type == :file && !_only?(path))
+    end
+
+    private
+
+    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 = []
+      unless overrides
+        patterns << DEFAULT_IGNORED_FILES
+        patterns << DEFAULT_IGNORED_EXTENSIONS
+      end
+
+      patterns << ignores
+      patterns << overrides
+
+      patterns.compact.flatten
+    end
+  end
+end

data/lib/listen/thread.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'thread'
+
+require_relative 'logger'
+
+module Listen
+  module Thread
+    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
+
+        ::Thread.new do
+          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
+        _log_exception(exception, method_name, caller_stack: caller_stack)
+      end
+
+      private
+
+      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(exception)
+        result = +"#{exception.class}: #{exception}"
+        if exception.cause
+          result << "\n"
+          result << "--- Caused by: ---\n"
+          result << _exception_with_causes(exception.cause)
+        end
+        result
+      end
+    end
+  end
+end

data/lib/listen/version.rb

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

data/lib/listen.rb

@@ -1,39 +1,47 @@
-module Listen
+# frozen_string_literal: true
 
-  autoload :Turnstile,         'listen/turnstile'
-  autoload :Listener,          'listen/listener'
-  autoload :MultiListener,     'listen/multi_listener'
-  autoload :DirectoryRecord,   'listen/directory_record'
-  autoload :DependencyManager, 'listen/dependency_manager'
-  autoload :Adapter,           'listen/adapter'
+require 'logger'
+require 'weakref'
+require 'listen/logger'
+require 'listen/listener'
 
-  module Adapters
-    autoload :Darwin,  'listen/adapters/darwin'
-    autoload :Linux,   'listen/adapters/linux'
-    autoload :Windows, 'listen/adapters/windows'
-    autoload :Polling, 'listen/adapters/polling'
-  end
+# Won't print anything by default because of level - unless you've set
+# LISTEN_GEM_DEBUGGING or provided your own logger with a high enough level
+Listen.logger.info "Listen loglevel set to: #{Listen.logger.level}"
+Listen.logger.info "Listen version: #{Listen::VERSION}"
+
+module Listen
+  @listeners = Queue.new
 
-  # Listens to filesystem modifications on a either single directory or multiple directories.
-  #
-  # @param (see Listen::Listener#new)
-  # @param (see Listen::MultiListener#new)
-  #
-  # @yield [modified, added, removed] the changed files
-  # @yieldparam [Array<String>] modified the list of modified files
-  # @yieldparam [Array<String>] added the list of added files
-  # @yieldparam [Array<String>] removed the list of removed files
-  #
-  # @return [Listen::Listener] the file listener if no block given
-  #
-  def self.to(*args, &block)
-    listener = if args.length == 1 || ! args[1].is_a?(String)
-      Listener.new(*args, &block)
-    else
-      MultiListener.new(*args, &block)
+  class << self
+    # Listens to file system modifications on a either single directory or
+    # multiple directories.
+    #
+    # @param (see Listen::Listener#new)
+    #
+    # @yield [modified, added, removed] the changed files
+    # @yieldparam [Array<String>] modified the list of modified files
+    # @yieldparam [Array<String>] added the list of added files
+    # @yieldparam [Array<String>] removed the list of removed files
+    #
+    # @return [Listen::Listener] the listener
+    #
+    def to(*args, &block)
+      Listener.new(*args, &block).tap do |listener|
+        @listeners.enq(WeakRef.new(listener))
+      end
     end
 
-    block ? listener.start : listener
+    # This is used by the `listen` binary to handle Ctrl-C
+    #
+    def stop
+      while (listener = @listeners.deq(true))
+        begin
+          listener.stop
+        rescue WeakRef::RefError
+        end
+      end
+    rescue ThreadError
+    end
   end
-
 end

metadata

@@ -1,79 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 0.5.3
-  prerelease: 
+  version: 3.7.1
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
-- Maher Sallam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-03 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.10
 description: The Listen gem listens to file modifications and notifies you about the
   changes. Works everywhere!
-email:
-- thibaud@thibaud.me
-- maher@sallam.me
-executables: []
+email: thibaud@thibaud.gg
+executables:
+- listen
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.txt
+- README.md
+- bin/listen
+- lib/listen.rb
 - lib/listen/adapter.rb
-- lib/listen/adapters/darwin.rb
-- lib/listen/adapters/linux.rb
-- lib/listen/adapters/polling.rb
-- lib/listen/adapters/windows.rb
-- lib/listen/dependency_manager.rb
-- lib/listen/directory_record.rb
+- lib/listen/adapter/base.rb
+- lib/listen/adapter/bsd.rb
+- lib/listen/adapter/config.rb
+- lib/listen/adapter/darwin.rb
+- lib/listen/adapter/linux.rb
+- lib/listen/adapter/polling.rb
+- lib/listen/adapter/windows.rb
+- lib/listen/backend.rb
+- 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
+- lib/listen/event/queue.rb
+- lib/listen/file.rb
+- lib/listen/fsm.rb
 - lib/listen/listener.rb
-- lib/listen/multi_listener.rb
-- lib/listen/turnstile.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
+- lib/listen/record/entry.rb
+- lib/listen/record/symlink_detector.rb
+- lib/listen/silencer.rb
+- lib/listen/silencer/controller.rb
+- lib/listen/thread.rb
 - lib/listen/version.rb
-- lib/listen.rb
-- CHANGELOG.md
-- LICENSE
-- README.md
 homepage: https://github.com/guard/listen
-licenses: []
+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.7.1
+  homepage_uri: https://github.com/guard/listen
+  source_code_uri: https://github.com/guard/listen/tree/v3.7.1
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubyforge_project: listen
-rubygems_version: 1.8.23
+rubygems_version: 3.0.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Listen to file modifications
 test_files: []

data/lib/listen/adapters/darwin.rb

@@ -1,85 +0,0 @@
-module Listen
-  module Adapters
-
-    # Adapter implementation for Mac OS X `FSEvents`.
-    #
-    class Darwin < Adapter
-      extend DependencyManager
-
-      # Declare the adapter's dependencies
-      dependency 'rb-fsevent', '~> 0.9.1'
-
-      LAST_SEPARATOR_REGEX = /\/$/
-
-      # Initializes the Adapter. See {Listen::Adapter#initialize} for more info.
-      #
-      def initialize(directories, options = {}, &callback)
-        super
-        @worker = init_worker
-      end
-
-      # Starts the adapter.
-      #
-      # @param [Boolean] blocking whether or not to block the current thread after starting
-      #
-      def start(blocking = true)
-        @mutex.synchronize do
-          return if @stop == false
-          super
-        end
-
-        @worker_thread = Thread.new { @worker.run }
-
-        # The FSEvent worker needs sometime to startup. Turnstiles can't
-        # be used to wait for it as it runs in a loop.
-        # TODO: Find a better way to block until the worker starts.
-        sleep 0.1
-
-        @poll_thread = Thread.new { poll_changed_dirs } if @report_changes
-        @worker_thread.join if blocking
-      end
-
-      # Stops the adapter.
-      #
-      def stop
-        @mutex.synchronize do
-          return if @stop == true
-          super
-        end
-
-        @worker.stop
-        @worker_thread.join if @worker_thread
-        @poll_thread.join if @poll_thread
-      end
-
-      # Checks if the adapter is usable on the current OS.
-      #
-      # @return [Boolean] whether usable or not
-      #
-      def self.usable?
-        return false unless RbConfig::CONFIG['target_os'] =~ /darwin(1.+)?$/i
-        super
-      end
-
-      private
-
-      # Initializes a FSEvent worker and adds a watcher for
-      # each directory passed to the adapter.
-      #
-      # @return [FSEvent] initialized worker
-      #
-      def init_worker
-        FSEvent.new.tap do |worker|
-          worker.watch(@directories.dup, :latency => @latency) do |changes|
-            next if @paused
-            @mutex.synchronize do
-              changes.each { |path| @changed_dirs << path.sub(LAST_SEPARATOR_REGEX, '') }
-            end
-          end
-        end
-      end
-
-    end
-
-  end
-end