listen 2.10.1 → 3.0.0

data/lib/listen/listener/config.rb

@@ -0,0 +1,45 @@
+module Listen
+  class Listener
+    class Config
+      DEFAULTS = {
+        # Listener options
+        debug: false, # TODO: is this broken?
+        wait_for_delay: nil, # NOTE: should be provided by adapter if possible
+        relative: false,
+
+        # Backend selecting options
+        force_polling: false,
+        polling_fallback_message: nil
+      }
+
+      def initialize(opts)
+        @options = DEFAULTS.merge(opts)
+        @relative = @options[:relative]
+        @min_delay_between_events = @options[:wait_for_delay]
+        @silencer_rules = @options # silencer will extract what it needs
+      end
+
+      def relative?
+        @relative
+      end
+
+      def min_delay_between_events
+        @min_delay_between_events
+      end
+
+      def silencer_rules
+        @silencer_rules
+      end
+
+      def adapter_instance_options(klass)
+        valid_keys = klass.const_get('DEFAULTS').keys
+        Hash[@options.select { |key, _| valid_keys.include?(key) }]
+      end
+
+      def adapter_select_options
+        valid_keys = %w(force_polling polling_fallback_message).map(&:to_sym)
+        Hash[@options.select { |key, _| valid_keys.include?(key) }]
+      end
+    end
+  end
+end

data/lib/listen/logger.rb

@@ -0,0 +1,32 @@
+module Listen
+  def self.logger
+    @logger
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.setup_default_logger_if_unset
+    self.logger ||= ::Logger.new(STDERR).tap do |logger|
+      debugging = ENV['LISTEN_GEM_DEBUGGING']
+      logger.level =
+        case debugging.to_s
+        when /2/
+          ::Logger::DEBUG
+        when /true|yes|1/i
+          ::Logger::INFO
+        else
+          ::Logger::ERROR
+        end
+    end
+  end
+
+  class Logger
+    %i(fatal error warn info debug).each do |meth|
+      define_singleton_method(meth) do |*args, &block|
+        Listen.logger.public_send(meth, *args, &block) if Listen.logger
+      end
+    end
+  end
+end

data/lib/listen/options.rb

@@ -10,7 +10,7 @@ module Listen
       return if given_options.empty?
 
       msg = "Unknown options: #{given_options.inspect}"
-      Celluloid::Logger.warn msg
+      Listen::Logger.warn msg
       fail msg
     end
 

data/lib/listen/queue_optimizer.rb

@@ -1,23 +1,40 @@
 module Listen
-  module QueueOptimizer
-    private
+  class QueueOptimizer
+    class Config
+      def initialize(adapter_class, silencer)
+        @adapter_class = adapter_class
+        @silencer = silencer
+      end
+
+      def exist?(path)
+        Pathname(path).exist?
+      end
+
+      def silenced?(path, type)
+        @silencer.silenced?(path, type)
+      end
+
+      def debug(*args, &block)
+        Listen.logger.debug(*args, &block)
+      end
+    end
 
-    def _smoosh_changes(changes)
+    def smoosh_changes(changes)
       # TODO: adapter could be nil at this point (shutdown)
-      if _adapter_class.local_fs?
-        cookies = changes.group_by do |_, _, _, _, options|
-          (options || {})[:cookie]
-        end
-        _squash_changes(_reinterpret_related_changes(cookies))
-      else
-        smooshed = { modified: [], added: [], removed: [] }
-        changes.each do |_, change, dir, rel_path, _|
-          smooshed[change] << (dir + rel_path).to_s if smooshed.key?(change)
-        end
-        smooshed.tap { |s| s.each { |_, v| v.uniq! } }
+      cookies = changes.group_by do |_, _, _, _, options|
+        (options || {})[:cookie]
       end
+      _squash_changes(_reinterpret_related_changes(cookies))
+    end
+
+    def initialize(config)
+      @config = config
     end
 
+    private
+
+    attr_reader :config
+
     # groups changes into the expected structure expected by
     # clients
     def _squash_changes(changes)
@@ -28,13 +45,14 @@ module Listen
       actions = changes.group_by(&:last).map do |path, action_list|
         [_logical_action_for(path, action_list.map(&:first)), path.to_s]
       end
-      _log :info, "listen: raw changes: #{actions.inspect}"
+
+      config.debug("listen: raw changes: #{actions.inspect}")
 
       { modified: [], added: [], removed: [] }.tap do |squashed|
         actions.each do |type, path|
           squashed[type] << path unless type.nil?
         end
-        _log :info, "listen: final changes: #{squashed.inspect}"
+        config.debug("listen: final changes: #{squashed.inspect}")
       end
     end
 
@@ -53,7 +71,7 @@ module Listen
 
       # TODO: avoid checking if path exists and instead assume the events are
       # in order (if last is :removed, it doesn't exist, etc.)
-      if path.exist?
+      if config.exist?(path)
         if diff > 0
           :added
         elsif diff.zero? && added > 0
@@ -77,7 +95,7 @@ module Listen
           [[:modified, to_dir, to_file]]
         else
           not_silenced = changes.reject do |type, _, _, path, _|
-            _silenced?(Pathname(path), type)
+            config.silenced?(Pathname(path), type)
           end
           not_silenced.map do |_, change, dir, path, _|
             [table.fetch(change, change), dir, path]
@@ -107,8 +125,8 @@ module Listen
 
       # Expect an ignored moved_from and non-ignored moved_to
       # to qualify as an "editor modify"
-      return unless _silenced?(Pathname(from), from_type)
-      _silenced?(Pathname(to), to_type) ? nil : [to_dir, to]
+      return unless config.silenced?(Pathname(from), from_type)
+      config.silenced?(Pathname(to), to_type) ? nil : [to_dir, to]
     end
   end
 end

data/lib/listen/record.rb

@@ -3,55 +3,53 @@ require 'listen/record/symlink_detector'
 
 module Listen
   class Record
-    include Celluloid
     # TODO: one Record object per watched directory?
-
     # TODO: deprecate
-    attr_accessor :paths, :listener
 
-    def initialize(listener)
-      @listener = listener
-      @paths    = _auto_hash
+    attr_reader :root
+    def initialize(directory)
+      @tree = _auto_hash
+      @root = directory.to_s
     end
 
-    def add_dir(dir, rel_path)
+    def add_dir(rel_path)
       return if [nil, '', '.'].include? rel_path
-      @paths[dir.to_s][rel_path] ||= {}
+      @tree[rel_path] ||= {}
     end
 
-    def update_file(dir, rel_path, data)
+    def update_file(rel_path, data)
       dirname, basename = Pathname(rel_path).split.map(&:to_s)
-      _fast_update_file(dir, dirname, basename, data)
+      _fast_update_file(dirname, basename, data)
     end
 
-    def unset_path(dir, rel_path)
+    def unset_path(rel_path)
       dirname, basename = Pathname(rel_path).split.map(&:to_s)
-      _fast_unset_path(dir, dirname, basename)
+      _fast_unset_path(dirname, basename)
     end
 
-    def file_data(dir, rel_path)
-      root = @paths[dir.to_s]
+    def file_data(rel_path)
       dirname, basename = Pathname(rel_path).split.map(&:to_s)
       if [nil, '', '.'].include? dirname
-        root[basename] ||= {}
-        root[basename].dup
+        tree[basename] ||= {}
+        tree[basename].dup
       else
-        root[dirname] ||= {}
-        root[dirname][basename] ||= {}
-        root[dirname][basename].dup
+        tree[dirname] ||= {}
+        tree[dirname][basename] ||= {}
+        tree[dirname][basename].dup
       end
     end
 
-    def dir_entries(dir, rel_path)
-      tree = if [nil, '', '.'].include? rel_path.to_s
-               @paths[dir.to_s]
-             else
-               @paths[dir.to_s][rel_path.to_s] ||= _auto_hash
-               @paths[dir.to_s][rel_path.to_s]
-             end
+    def dir_entries(rel_path)
+      subtree =
+        if [nil, '', '.'].include? rel_path.to_s
+          tree
+        else
+          tree[rel_path.to_s] ||= _auto_hash
+          tree[rel_path.to_s]
+        end
 
       result = {}
-      tree.each do |key, values|
+      subtree.each do |key, values|
         # only get data for file entries
         result[key] = values.key?(:mtime) ? values : {}
       end
@@ -59,18 +57,14 @@ module Listen
     end
 
     def build
-      start = Time.now.to_f
-      @paths = _auto_hash
-
-      # TODO: refactor this out (1 Record = 1 watched dir)
-      listener.directories.each do |directory|
-        _fast_build(directory.to_s)
-      end
-
-      Celluloid::Logger.info "Record.build(): #{Time.now.to_f - start} seconds"
-    rescue
-      Celluloid::Logger.warn "build crashed: #{$ERROR_INFO.inspect}"
-      raise
+      @tree = _auto_hash
+      # 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
@@ -79,56 +73,47 @@ module Listen
       Hash.new { |h, k| h[k] = Hash.new }
     end
 
-    def _fast_update_file(dir, dirname, basename, data)
-      root = @paths[dir.to_s]
+    def tree
+      @tree
+    end
+
+    def _fast_update_file(dirname, basename, data)
       if [nil, '', '.'].include? dirname
-        root[basename] = (root[basename] || {}).merge(data)
+        tree[basename] = (tree[basename] || {}).merge(data)
       else
-        root[dirname] ||= {}
-        root[dirname][basename] = (root[dirname][basename] || {}).merge(data)
+        tree[dirname] ||= {}
+        tree[dirname][basename] = (tree[dirname][basename] || {}).merge(data)
       end
     end
 
-    def _fast_unset_path(dir, dirname, basename)
-      root = @paths[dir.to_s]
+    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 root.key?(basename)
-        root.delete(basename)
+        return unless tree.key?(basename)
+        tree.delete(basename)
       else
-        return unless root.key?(dirname)
-        root[dirname].delete(basename)
+        return unless tree.key?(dirname)
+        tree[dirname].delete(basename)
       end
     end
 
-    # TODO: test with a file name given
-    # TODO: test other permissions
-    # TODO: test with mixed encoding
-    def _fast_build(root)
-      symlink_detector = SymlinkDetector.new
-      @paths[root] = _auto_hash
-      remaining = Queue.new
-      remaining << Entry.new(root, nil, nil)
-      _fast_build_dir(remaining, symlink_detector) until remaining.empty?
-    end
-
     def _fast_build_dir(remaining, symlink_detector)
       entry = remaining.pop
       children = entry.children # NOTE: children() implicitly tests if dir
       symlink_detector.verify_unwatched!(entry)
       children.each { |child| remaining << child }
-      add_dir(entry.root, entry.record_dir_key)
+      add_dir(entry.record_dir_key)
     rescue Errno::ENOTDIR
       _fast_try_file(entry)
     rescue SystemCallError, SymlinkDetector::Error
-      _fast_unset_path(entry.root, entry.relative, entry.name)
+      _fast_unset_path(entry.relative, entry.name)
     end
 
     def _fast_try_file(entry)
-      _fast_update_file(entry.root, entry.relative, entry.name, entry.meta)
+      _fast_update_file(entry.relative, entry.name, entry.meta)
     rescue SystemCallError
-      _fast_unset_path(entry.root, entry.relative, entry.name)
+      _fast_unset_path(entry.relative, entry.name)
     end
   end
 end

data/lib/listen/silencer/controller.rb

@@ -0,0 +1,48 @@
+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/version.rb

@@ -1,3 +1,3 @@
 module Listen
-  VERSION = '2.10.1'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 2.10.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-06-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: celluloid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
@@ -83,27 +69,32 @@ files:
 - lib/listen/adapter.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/tcp.rb
 - lib/listen/adapter/windows.rb
+- lib/listen/backend.rb
 - lib/listen/change.rb
 - lib/listen/cli.rb
 - lib/listen/directory.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/internals/logging.rb
+- lib/listen/fsm.rb
 - lib/listen/internals/thread_pool.rb
 - lib/listen/listener.rb
+- lib/listen/listener/config.rb
+- lib/listen/logger.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/tcp.rb
-- lib/listen/tcp/broadcaster.rb
-- lib/listen/tcp/message.rb
+- lib/listen/silencer/controller.rb
 - lib/listen/version.rb
 homepage: https://github.com/guard/listen
 licenses: