listen 2.7.7 → 2.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6d5e368c0d42f2b677a88efcd2b983eb1551278
-  data.tar.gz: 656135661cb4e2c2bd82c9acdbf9d0779a1c707a
+  metadata.gz: 75b73ca8c3df5774760e1a9e9cd4281a4fb91f7b
+  data.tar.gz: f09049b304ca5bf11a288ee36cc81ff7f0f4d624
 SHA512:
-  metadata.gz: d3b07e9530ffa906cf9cc1413dba58b990dc5e720e7c42f4364ac84790e47c43d10bfa5aa5afcbe43e360e1f6c459a5f7ffb15f7dc20ef8467127c6d1c8c93de
-  data.tar.gz: c6e078178e2879ec66de6c54a52542aa973d9de372edda0c8e74356d7fd1377330f569ef8ae73bf61b4f09962fe341d53dec6201bfdd4261275163fcdfb1a035
+  metadata.gz: beb3b0ff8fd1e133ea01b700a147f4aeac44bf670fdb3c16f4e66da5fc24545645a51899cbd241add9be9887091a5312dd196606b23229c3d574f9e4f9db390a
+  data.tar.gz: c5f4d09de7c8f336aee3f4c8c69e8707e174de4692c83beb7640213bae9254dcffaa07642ea212c632eb38c4ed5fd75ca2871af859589c06fff0e86179f8f516

data/README.md

@@ -10,7 +10,7 @@ The Listen gem listens to file modifications and notifies you about the changes.
 * OS-specific adapters on MRI for Mac OS X 10.6+, Linux, ~~\*BSD~~ and Windows, [more info](#listen-adapters) below.
 * Detects file modification, addition and removal.
 * Allows supplying regexp-patterns to ignore paths for better results.
-* File content checksum comparison for modifications made under the same second (OS X only).
+* File content checksum comparison for modifications made under the same second (OS X HFS volumes, VFAT volumes).
 * Forwarding file events over TCP, [more info](#forwarding-file-events-over-tcp) below.
 * Tested on MRI Ruby environments (1.9+ only) via [Travis CI](https://travis-ci.org/guard/listen),
 
@@ -22,8 +22,10 @@ Please note that:
 
 ## Pending features
 
-* Non-recursive directory scanning. [#111](https://github.com/guard/listen/issues/111)
+* ~~Non-recursive directory scanning~~ [#111](https://github.com/guard/listen/issues/111)
 * Symlinks support. [#25](https://github.com/guard/listen/issues/25)
+* Directory/adapter specific configuration options
+* Support for plugins
 
 Pull request or help is very welcome for these.
 
@@ -55,14 +57,21 @@ Listeners can also be easily paused/unpaused:
 
 ``` ruby
 listener = Listen.to('dir/path/to/listen') { |modified, added, removed| # ... }
+
 listener.start
-listener.listen? # => true
-listener.pause   # stop listening to changes
+listener.paused? # => false
+listener.processing? # => true
+
+listener.pause   # stops processing changes (but keeps on collecting them)
 listener.paused? # => true
-listener.unpause # start listening to changes again
-listener.stop    # stop completely the listener
+listener.processing? # => false
+
+listener.unpause # resumes processing changes ("start" would do the same)
+listener.stop    # stop both listening to changes and processing them
 ```
 
+  Note: While paused, Listen keeps on collecting changes in the background - to clear them, call "stop"
+
   Note: You should keep track of all started listeners and stop them properly on finish.
 
 ### Ignore / ignore!
@@ -90,7 +99,8 @@ listener.only /_spec\.rb$/ # overwrite all existing only patterns.
 sleep
 ```
 
-Note: Only regexp patterns are evaluated only against relative **file** paths.
+Note: ':only' regexp patterns are evaluated only against relative **file** paths.
+
 
 ## Changes callback
 
@@ -225,6 +235,22 @@ Listen traps SIGINT signal to properly finalize listeners. If you plan
 on trapping this signal yourself - make sure to call `Listen.stop` in
 signal handler.
 
+## Performance
+
+If Listen seems slow or unresponsive, make sure you're not using the Polling adapter (you should see a warning upon startup if you are).
+
+Also, if the directories you're watching contain many files, make sure you're:
+
+* not using Polling (ideally)
+* using `:ignore` and `:only` options to avoid tracking directories you don't care about
+* not using a version of Listen prior to 2.7.7
+* not getting silent crashes within Listen (see LISTEN_GEM_DEBUGGING=2)
+* not running multiple instances of Listen in the background
+* using a file system with atime modification disabled (ideally)
+* not using a filesystem with inaccurate file modification times (ideally), e.g. HFS, VFAT
+* running Listen with the latency option not too small or too big (depends on needs)
+
+When in doubt, LISTEN_GEM_DEBUGGING=2 can help discover the actual events and time they happened.
 
 ## Forwarding file events over TCP
 

data/lib/listen.rb

@@ -3,8 +3,6 @@ require 'listen/listener'
 
 module Listen
   class << self
-    attr_accessor :stopping
-
     # Listens to file system modifications on a either single directory or
     # multiple directories.
     #
@@ -21,13 +19,12 @@ module Listen
     # @return [Listen::Listener] the listener
     #
     def to(*args, &block)
-      boot_celluloid
-      @stopping = false
+      Celluloid.boot unless Celluloid.running?
       options = args.last.is_a?(Hash) ? args.last : {}
       if target = options.delete(:forward_to)
-        Listener.new(target, :broadcaster, *args, &block)
+        _add_listener(target, :broadcaster, *args, &block)
       else
-        Listener.new(*args, &block)
+        _add_listener(*args, &block)
       end
     end
 
@@ -36,7 +33,15 @@ module Listen
     # Use it for testing purpose or when you are sure that Celluloid could be
     # ended.
     #
+    # This is used by the `listen` binary to handle Ctrl-C
+    #
     def stop
+      @listeners ||= []
+      @listeners.each do |listener|
+        # call stop to halt the main loop
+        listener.stop
+      end
+
       Celluloid.shutdown
     end
 
@@ -52,13 +57,16 @@ module Listen
     # @return [Listen::Listener] the listener
     #
     def on(target, *args, &block)
-      Listener.new(target, :recipient, *args, &block)
+      _add_listener(target, :recipient, *args, &block)
     end
 
     private
 
-    def boot_celluloid
-      Celluloid.boot unless Celluloid.running?
+    def _add_listener(*args, &block)
+      @listeners ||= []
+      Listener.new(*args, &block).tap do |listener|
+        @listeners << listener
+      end
     end
   end
 end

data/lib/listen/adapter/base.rb

@@ -79,8 +79,12 @@ module Listen
         @mq.send(:_queue_raw_change, type, dir, rel_path, options)
       end
 
-      def _log(type, message)
-        Celluloid.logger.send(type, message)
+      def _log(*args)
+        self.class.send(:_log, *args)
+      end
+
+      def self._log(*args)
+        Celluloid.logger.send(*args)
       end
     end
   end

data/lib/listen/version.rb

@@ -1,3 +1,3 @@
 module Listen
-  VERSION = '2.7.7'
+  VERSION = '2.7.8'
 end

data/spec/lib/listen_spec.rb

@@ -14,12 +14,6 @@ describe Listen do
         described_class.to('/path', forward_to: 4000)
       end
     end
-
-    it 'sets stopping at false' do
-      allow(Listen::Listener).to receive(:new)
-      Listen.to('/path')
-      expect(Listen.stopping).to be_falsey
-    end
   end
 
   describe '.stop' do

data/spec/spec_helper.rb

@@ -40,7 +40,6 @@ Thread.abort_on_exception = true
 Celluloid.logger.level = Logger::ERROR
 
 RSpec.configuration.before(:each) do
-  Listen.stopping = false
   Celluloid.boot
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 2.7.7
+  version: 2.7.8
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid