driskell-listen 3.0.6.10

data/lib/driskell-listen/adapter/base.rb

@@ -0,0 +1,147 @@
+require 'driskell-listen/options'
+require 'driskell-listen/record'
+require 'driskell-listen/change'
+
+module Driskell::Listen
+  module Adapter
+    class Base
+      attr_reader :options
+
+      # TODO: only used by tests
+      DEFAULTS = {}
+
+      attr_reader :config
+
+      def initialize(config)
+        @started = false
+        @config = config
+
+        @configured = nil
+
+        fail 'No directories to watch!' if config.directories.empty?
+
+        defaults = self.class.const_get('DEFAULTS')
+        @options = Driskell::Listen::Options.new(config.adapter_options, defaults)
+      rescue
+        _log_exception 'adapter config failed: %s:%s called from: %s', caller
+        raise
+      end
+
+      # TODO: it's a separate method as a temporary workaround for tests
+      def configure
+        if @configured
+          _log(:warn, 'Adapter already configured!')
+          return
+        end
+
+        @configured = true
+
+        @callbacks ||= {}
+        config.directories.each do |dir|
+          callback = @callbacks[dir] || lambda do |event|
+            _process_event(dir, event)
+          end
+          @callbacks[dir] = callback
+          _configure(dir, &callback)
+        end
+
+        @snapshots ||= {}
+        # TODO: separate config per directory (some day maybe)
+        change_config = Change::Config.new(config.queue, config.silencer)
+        config.directories.each do |dir|
+          record = Record.new(dir)
+          snapshot = Change.new(change_config, record)
+          @snapshots[dir] = snapshot
+        end
+      end
+
+      def started?
+        @started
+      end
+
+      def start
+        configure
+
+        if started?
+          _log(:warn, 'Adapter already started!')
+          return
+        end
+
+        @started = true
+
+        calling_stack = caller.dup
+        Driskell::Listen::Internals::ThreadPool.add do
+          begin
+            @snapshots.values.each do |snapshot|
+              _timed('Record.build()') { snapshot.record.build }
+            end
+            _run
+          rescue
+            msg = 'run() in thread failed: %s:\n'\
+              ' %s\n\ncalled from:\n %s'
+            _log_exception(msg, calling_stack)
+            raise # for unit tests mostly
+          end
+        end
+      end
+
+      def stop
+        _stop
+      end
+
+      def self.usable?
+        const_get('OS_REGEXP') =~ RbConfig::CONFIG['target_os']
+      end
+
+      # Seeds
+      def preempt_change(dir, rel_path, data)
+        if @snapshots.nil? || !@snapshots.key?(dir)
+          _log(:warn, 'Cannot preempt change for directory not being watched')
+          return
+        end
+
+        @snapshots[dir].record.update_file(rel_path, data)
+      end
+
+      private
+
+      def _stop
+      end
+
+      def _timed(title)
+        start = Time.now.to_f
+        yield
+        diff = Time.now.to_f - start
+        Driskell::Listen::Logger.info format('%s: %.05f seconds', title, diff)
+      rescue
+        Driskell::Listen::Logger.warn "#{title} crashed: #{$ERROR_INFO.inspect}"
+        raise
+      end
+
+      # TODO: allow backend adapters to pass specific invalidation objects
+      # e.g. Darwin -> DirRescan, INotify -> MoveScan, etc.
+      def _queue_change(type, dir, rel_path, options = {})
+        @snapshots[dir].invalidate(type, rel_path, options)
+      end
+
+      def _log(*args, &block)
+        self.class.send(:_log, *args, &block)
+      end
+
+      def _log_exception(msg, caller_stack)
+        formatted = format(
+          msg,
+          $ERROR_INFO,
+          $ERROR_POSITION * "\n",
+          caller_stack * "\n"
+        )
+
+        _log(:error, formatted)
+      end
+
+      def self._log(*args, &block)
+        Driskell::Listen::Logger.send(*args, &block)
+      end
+    end
+  end
+end

data/lib/driskell-listen/adapter/bsd.rb

@@ -0,0 +1,106 @@
+# Listener implementation for BSD's `kqueue`.
+# @see http://www.freebsd.org/cgi/man.cgi?query=kqueue
+# @see https://github.com/mat813/rb-kqueue/blob/master/lib/rb-kqueue/queue.rb
+#
+module Driskell::Listen
+  module Adapter
+    class BSD < Base
+      OS_REGEXP = /bsd|dragonfly/i
+
+      DEFAULTS = {
+        events: [
+          :delete,
+          :write,
+          :extend,
+          :attrib,
+          :rename
+          # :link, :revoke
+        ]
+      }
+
+      BUNDLER_DECLARE_GEM = <<-EOS.gsub(/^ {6}/, '')
+        Please add the following to your Gemfile to avoid polling for changes:
+          require 'rbconfig'
+          if RbConfig::CONFIG['target_os'] =~ /#{OS_REGEXP}/
+            gem 'rb-kqueue', '>= 0.2'
+          end
+      EOS
+
+      def self.usable?
+        return false unless super
+        require 'rb-kqueue'
+        require 'find'
+        true
+      rescue LoadError
+        Kernel.warn BUNDLER_DECLARE_GEM
+        false
+      end
+
+      private
+
+      def _configure(directory, &_callback)
+        @worker ||= KQueue::Queue.new
+        @callback = _callback
+        # use Record to make a snapshot of dir, so we
+        # can detect new files
+        _find(directory.to_s) { |path| _watch_file(path, @worker) }
+      end
+
+      def _run
+        @worker.run
+      end
+
+      def _process_event(dir, event)
+        full_path = _event_path(event)
+        if full_path.directory?
+          # Force dir content tracking to kick in, or we won't have
+          # names of added files
+          _queue_change(:dir, dir, '.', recursive: true)
+        elsif full_path.exist?
+          path = full_path.relative_path_from(dir)
+          _queue_change(:file, dir, path.to_s, change: _change(event.flags))
+        end
+
+        # If it is a directory, and it has a write flag, it means a
+        # file has been added so find out which and deal with it.
+        # No need to check for removed files, kqueue will forget them
+        # when the vfs does.
+        _watch_for_new_file(event) if full_path.directory?
+      end
+
+      def _change(event_flags)
+        { modified: [:attrib, :extend],
+          added:    [:write],
+          removed:  [:rename, :delete]
+        }.each do |change, flags|
+          return change unless (flags & event_flags).empty?
+        end
+        nil
+      end
+
+      def _event_path(event)
+        Pathname.new(event.watcher.path)
+      end
+
+      def _watch_for_new_file(event)
+        queue = event.watcher.queue
+        _find(_event_path(event).to_s) do |file_path|
+          unless queue.watchers.detect { |_, v| v.path == file_path.to_s }
+            _watch_file(file_path, queue)
+          end
+        end
+      end
+
+      def _watch_file(path, queue)
+        queue.watch_file(path, *options.events, &@callback)
+      rescue Errno::ENOENT => e
+        _log :warn, "kqueue: watch file failed: #{e.message}"
+      end
+
+      # Quick rubocop workaround
+      def _find(*paths, &block)
+        Find.send(:find, *paths, &block)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'pathname'
+
+module Driskell::Listen
+  module Adapter
+    class Config
+      attr_reader :directories
+      attr_reader :silencer
+      attr_reader :queue
+      attr_reader :adapter_options
+
+      def initialize(directories, queue, silencer, adapter_options)
+        # Default to current directory if no directories are supplied
+        directories = [Dir.pwd] if directories.to_a.empty?
+        
+        # TODO: fix (flatten, array, compact?)
+        @directories = directories.map do |directory|
+          Pathname.new(directory.to_s).realpath
+        end
+
+        @silencer = silencer
+        @queue = queue
+        @adapter_options = adapter_options
+      end
+    end
+  end
+end

data/lib/driskell-listen/adapter/darwin.rb

@@ -0,0 +1,71 @@
+require 'thread'
+require 'driskell-listen/internals/thread_pool'
+
+module Driskell::Listen
+  module Adapter
+    # Adapter implementation for Mac OS X `FSEvents`.
+    #
+    class Darwin < Base
+      OS_REGEXP = /darwin(1.+)?$/i
+
+      # The default delay between checking for changes.
+      DEFAULTS = { latency: 0.1 }
+
+      private
+
+      # NOTE: each directory gets a DIFFERENT callback!
+      def _configure(dir, &callback)
+        require 'rb-fsevent'
+
+        opts = { latency: options.latency }
+
+        @workers ||= ::Queue.new
+        @workers << FSEvent.new.tap do |worker|
+          _log :debug, "fsevent: watching: #{dir.to_s.inspect}"
+          worker.watch(dir.to_s, opts, &callback)
+        end
+      end
+
+      def _run
+        first = @workers.pop
+
+        # NOTE: _run is called within a thread, so run every other
+        # worker in it's own thread
+        _run_workers_in_background(_to_array(@workers))
+        _run_worker(first)
+      end
+
+      def _process_event(dir, event)
+        _log :debug, "fsevent: processing event: #{event.inspect}"
+        event.each do |path|
+          new_path = Pathname.new(path.sub(/\/$/, ''))
+          _log :debug, "fsevent: #{new_path}"
+          # TODO: does this preserve symlinks?
+          rel_path = new_path.relative_path_from(dir).to_s
+          _queue_change(:dir, dir, rel_path)
+        end
+      end
+
+      def _run_worker(worker)
+        _log :debug, "fsevent: running worker: #{worker.inspect}"
+        worker.run
+      rescue
+        _log_exception 'fsevent: running worker failed: %s:%s called from: %s', caller
+      end
+
+      def _run_workers_in_background(workers)
+        workers.each do |worker|
+          # NOTE: while passing local variables to the block below is not
+          # thread safe, using 'worker' from the enumerator above is ok
+          Driskell::Listen::Internals::ThreadPool.add { _run_worker(worker) }
+        end
+      end
+
+      def _to_array(queue)
+        workers = []
+        workers << queue.pop until queue.empty?
+        workers
+      end
+    end
+  end
+end

data/lib/driskell-listen/adapter/linux.rb

@@ -0,0 +1,96 @@
+module Driskell::Listen
+  module Adapter
+    # @see https://github.com/nex3/rb-inotify
+    class Linux < Base
+      OS_REGEXP = /linux/i
+
+      DEFAULTS = {
+        events: [
+          :recursive,
+          :attrib,
+          :create,
+          :delete,
+          :move,
+          :close_write
+        ],
+        wait_for_delay: 0.1
+      }
+
+      private
+
+      WIKI_URL = 'https://github.com/guard/listen'\
+        '/wiki/Increasing-the-amount-of-inotify-watchers'
+
+      INOTIFY_LIMIT_MESSAGE = <<-EOS.gsub(/^\s*/, '')
+        FATAL: Listen error: unable to monitor directories for changes.
+        Visit #{WIKI_URL} for info on how to fix this.
+      EOS
+
+      def _configure(directory, &callback)
+        require 'rb-inotify'
+        @worker ||= ::INotify::Notifier.new
+        @worker.watch(directory.to_s, *options.events, &callback)
+      rescue Errno::ENOSPC
+        abort(INOTIFY_LIMIT_MESSAGE)
+      end
+
+      def _run
+        @worker.run
+      end
+
+      def _process_event(dir, event)
+        # NOTE: avoid using event.absolute_name since new API
+        # will need to have a custom recursion implemented
+        # to properly match events to configured directories
+        path = Pathname.new(event.watcher.path) + event.name
+        rel_path = path.relative_path_from(dir).to_s
+
+        _log(:debug) { "inotify: #{rel_path} (#{event.flags.inspect})" }
+
+        return if _skip_event?(event)
+
+        cookie_params = event.cookie.zero? ? {} : { cookie: event.cookie }
+
+        # Note: don't pass options to force rescanning the directory, so we can
+        # detect moving/deleting a whole tree
+        if _dir_event?(event)
+          _queue_change(:dir, dir, rel_path, cookie_params)
+          return
+        end
+
+        params = cookie_params.merge(change: _change(event.flags))
+
+        _queue_change(:file, dir, rel_path, params)
+      end
+
+      def _skip_event?(event)
+        # Event on root directory
+        return true if event.name == ''
+        # INotify reports changes to files inside directories as events
+        # on the directories themselves too.
+        #
+        # @see http://linux.die.net/man/7/inotify
+        _dir_event?(event) && (event.flags & [:close, :modify]).any?
+      end
+
+      def _change(event_flags)
+        { modified:   [:attrib, :close_write],
+          moved_to:   [:moved_to],
+          moved_from: [:moved_from],
+          added:      [:create],
+          removed:    [:delete] }.each do |change, flags|
+          return change unless (flags & event_flags).empty?
+        end
+        nil
+      end
+
+      def _dir_event?(event)
+        event.flags.include?(:isdir)
+      end
+
+      def _stop
+        @worker.close
+      end
+    end
+  end
+end