driskell-listen 3.0.6.10

data/lib/driskell-listen/internals/thread_pool.rb

@@ -0,0 +1,21 @@
+module Driskell::Listen
+  # @private api
+  module Internals
+    module ThreadPool
+      def self.add(&block)
+        Thread.new { block.call }.tap do |th|
+          (@threads ||= Queue.new) << th
+        end
+      end
+
+      def self.stop
+        return unless @threads ||= nil
+        return if @threads.empty? # return to avoid using possibly stubbed Queue
+
+        killed = Queue.new
+        killed << @threads.pop.kill until @threads.empty?
+        killed.pop.join until killed.empty?
+      end
+    end
+  end
+end

data/lib/driskell-listen/listener.rb

@@ -0,0 +1,132 @@
+require 'English'
+
+require 'driskell-listen/version'
+
+require 'driskell-listen/backend'
+
+require 'driskell-listen/silencer'
+require 'driskell-listen/silencer/controller'
+
+require 'driskell-listen/queue_optimizer'
+
+require 'driskell-listen/fsm'
+
+require 'driskell-listen/event/loop'
+require 'driskell-listen/event/queue'
+require 'driskell-listen/event/config'
+
+require 'driskell-listen/listener/config'
+
+module Driskell::Listen
+  class Listener
+    include Driskell::Listen::FSM
+
+    # Initializes the directories listener.
+    #
+    # @param [String] directory the directories to listen to
+    # @param [Hash] options the listen options (see Driskell::Listen::Listener::Options)
+    #
+    # @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
+    #
+    def initialize(*dirs, &block)
+      options = dirs.last.is_a?(Hash) ? dirs.pop : {}
+
+      @config = Config.new(options)
+
+      eq_config = Event::Queue::Config.new(@config.relative?)
+      queue = Event::Queue.new(eq_config) { @processor.wakeup_on_event }
+
+      silencer = Silencer.new
+      rules = @config.silencer_rules
+      @silencer_controller = Silencer::Controller.new(silencer, rules)
+
+      @backend = Backend.new(dirs, queue, silencer, @config)
+
+      optimizer_config = QueueOptimizer::Config.new(@backend, silencer)
+
+      pconfig = Event::Config.new(
+        self,
+        queue,
+        QueueOptimizer.new(optimizer_config),
+        @backend.min_delay_between_events,
+        &block)
+
+      @processor = Event::Loop.new(pconfig)
+
+      super() # FSM
+    end
+
+    default_state :initializing
+
+    state :initializing, to: :backend_started
+
+    state :backend_started, to: [:frontend_ready] do
+      backend.start
+    end
+
+    state :frontend_ready, to: [:processing_events] do
+      processor.setup
+    end
+
+    state :processing_events, to: [:paused, :stopped] do
+      processor.resume
+    end
+
+    state :paused, to: [:processing_events, :stopped] do
+      processor.pause
+    end
+
+    state :stopped, to: [:backend_started] do
+      backend.stop # should be before processor.teardown to halt events ASAP
+      processor.teardown
+    end
+
+    # Starts processing events and starts adapters
+    # or resumes invoking callbacks if paused
+    def start
+      transition :backend_started if state == :initializing
+      transition :frontend_ready if state == :backend_started
+      transition :processing_events if state == :frontend_ready
+      transition :processing_events if state == :paused
+    end
+
+    # Stops both listening for events and processing them
+    def stop
+      transition :stopped
+    end
+
+    # Stops invoking callbacks (messages pile up)
+    def pause
+      transition :paused
+    end
+
+    # processing means callbacks are called
+    def processing?
+      state == :processing_events
+    end
+
+    def paused?
+      state == :paused
+    end
+
+    def ignore(regexps)
+      @silencer_controller.append_ignores(regexps)
+    end
+
+    def ignore!(regexps)
+      @silencer_controller.replace_with_bang_ignores(regexps)
+    end
+
+    def only(regexps)
+      @silencer_controller.replace_with_only(regexps)
+    end
+
+    private
+
+    attr_reader :processor
+    attr_reader :backend
+  end
+end

data/lib/driskell-listen/listener/config.rb

@@ -0,0 +1,45 @@
+module Driskell::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/driskell-listen/logger.rb

@@ -0,0 +1,32 @@
+module Driskell::Listen
+  def self.logger
+    @logger ||= nil
+  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
+    [:fatal, :error, :warn, :info, :debug].each do |meth|
+      define_singleton_method(meth) do |*args, &block|
+        Driskell::Listen.logger.public_send(meth, *args, &block) if Driskell::Listen.logger
+      end
+    end
+  end
+end

data/lib/driskell-listen/options.rb

@@ -0,0 +1,23 @@
+module Driskell::Listen
+  class Options
+    def initialize(opts, defaults)
+      @options = {}
+      given_options = opts.dup
+      defaults.keys.each do |key|
+        @options[key] = given_options.delete(key) || defaults[key]
+      end
+
+      return if given_options.empty?
+
+      msg = "Unknown options: #{given_options.inspect}"
+      Driskell::Listen::Logger.warn msg
+      fail msg
+    end
+
+    def method_missing(name, *_)
+      return @options[name] if @options.key?(name)
+      msg = "Bad option: #{name.inspect} (valid:#{@options.keys.inspect})"
+      fail NameError, msg
+    end
+  end
+end

data/lib/driskell-listen/queue_optimizer.rb

@@ -0,0 +1,132 @@
+module Driskell::Listen
+  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)
+        Driskell::Listen.logger.debug(*args, &block)
+      end
+    end
+
+    def smoosh_changes(changes)
+      # TODO: adapter could be nil at this point (shutdown)
+      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)
+      # We combine here for backward compatibility
+      # Newer clients should receive dir and path separately
+      changes = changes.map { |change, dir, path| [change, dir + path] }
+
+      actions = changes.group_by(&:last).map do |path, action_list|
+        [_logical_action_for(path, action_list.map(&:first)), path.to_s]
+      end
+
+      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
+        config.debug("listen: final changes: #{squashed.inspect}")
+      end
+    end
+
+    def _logical_action_for(path, actions)
+      actions << :added if actions.delete(:moved_to)
+      actions << :removed if actions.delete(:moved_from)
+
+      modified = actions.detect { |x| x == :modified }
+      _calculate_add_remove_difference(actions, path, modified)
+    end
+
+    def _calculate_add_remove_difference(actions, path, default_if_exists)
+      added = actions.count { |x| x == :added }
+      removed = actions.count { |x| x == :removed }
+      diff = added - removed
+
+      # TODO: avoid checking if path exists and instead assume the events are
+      # in order (if last is :removed, it doesn't exist, etc.)
+      if config.exist?(path)
+        if diff > 0
+          :added
+        elsif diff.zero? && added > 0
+          :modified
+        else
+          default_if_exists
+        end
+      else
+        diff < 0 ? :removed : nil
+      end
+    end
+
+    # remove extraneous rb-inotify events, keeping them only if it's a possible
+    # editor rename() call (e.g. Kate and Sublime)
+    def _reinterpret_related_changes(cookies)
+      table = { moved_to: :added, moved_from: :removed }
+      cookies.map do |_, changes|
+        data = _detect_possible_editor_save(changes)
+        if data
+          to_dir, to_file = data
+          [[:modified, to_dir, to_file]]
+        else
+          not_silenced = changes.reject do |type, _, _, path, _|
+            config.silenced?(Pathname(path), type)
+          end
+          not_silenced.map do |_, change, dir, path, _|
+            [table.fetch(change, change), dir, path]
+          end
+        end
+      end.flatten(1)
+    end
+
+    def _detect_possible_editor_save(changes)
+      return unless changes.size == 2
+
+      from_type = from_change = from = nil
+      to_type = to_change = to_dir = to = nil
+
+      changes.each do |data|
+        case data[1]
+        when :moved_from
+          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]
+    end
+  end
+end

data/lib/driskell-listen/record.rb

@@ -0,0 +1,104 @@
+require 'thread'
+require 'driskell-listen/record/entry'
+
+module Driskell::Listen
+  class Record
+    attr_reader :root
+
+    def initialize(directory)
+      @tree = _auto_hash
+      @tree['.'] = _auto_hash
+      @root = directory.to_s
+    end
+
+    def update_dir(rel_path)
+      dirname, basename = Pathname(rel_path).split.map(&:to_s)
+      _fast_update_dir(rel_path, dirname, basename)
+    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(rel_path, dirname, basename)
+    end
+
+    def file_data(rel_path)
+      dirname, basename = Pathname(rel_path).split.map(&:to_s)
+      tree[dirname] ||= {}
+      tree[dirname][basename] ||= {}
+      tree[dirname][basename].dup
+    end
+
+    def dir_entries(rel_path)
+      rel_path = rel_path.to_s
+      # Do not store anything for the directory when querying
+      tree.has_key?(rel_path) ? tree[rel_path] : {}
+    end
+
+    def build
+      @tree = _auto_hash
+      # TODO: test with a file name given
+      # TODO: test other permissions
+      # TODO: test with mixed encoding
+      remaining = ::Queue.new
+      remaining << Entry.new(root, nil, nil)
+      _fast_build_dir(remaining) until remaining.empty?
+    end
+
+    private
+
+    def _auto_hash
+      Hash.new { |h, k| h[k] = Hash.new }
+    end
+
+    def tree
+      @tree
+    end
+
+    def _fast_update_dir(record_as_key, dirname, basename)
+      tree[record_as_key] ||= {}
+      tree[dirname] ||= {}
+      exists = tree[dirname].has_key?(basename)
+      tree[dirname].merge!(basename => {}) if basename != '.'
+      exists
+    end
+
+    def _fast_update_file(dirname, basename, data)
+      tree[dirname] ||= {}
+      exists = tree[dirname].has_key?(basename)
+      tree[dirname][basename] = (tree[dirname][basename] || {}).merge(data)
+      exists
+    end
+
+    def _fast_unset_path(rel_path, dirname, basename)
+      # this may need to be reworked to properly remove
+      # entries from a tree, without adding non-existing dirs to the record
+      return unless tree.key?(dirname)
+      tree[dirname].delete basename
+      tree.delete rel_path
+    end
+
+    def _fast_build_dir(remaining)
+      entry = remaining.pop
+      fail Errno::ENOTDIR if ::File.symlink?(entry.sys_path)
+      children = entry.children
+      children.each { |child| remaining << child }
+      return if entry.name.nil?
+      _fast_update_dir(entry.record_dir_key, entry.relative, entry.name)
+    rescue Errno::ENOTDIR
+      _fast_try_file(entry)
+    rescue SystemCallError
+      _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.record_dir_key, entry.relative, entry.name)
+    end
+  end
+end