listen 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00459a29639db27606681aa701f668d53134b3f8
-  data.tar.gz: a181ae4cf18614fd7622c668c1959eb51403674d
+  metadata.gz: 0c7fe2432921c30a0fc8bd2552a7bd2bac7b62b1
+  data.tar.gz: b0fab87bbb62064ab57b6ddf9c8c9e08a9fa4d6a
 SHA512:
-  metadata.gz: 9a6946eb30532c847e6b6a059f99b50c7d1c7a51c77471fb65f864486d83a094e5a16ff725091ddd988cedbdf598fc333db7537ff2c36d4b4446178fc620dca3
-  data.tar.gz: b2a0b44994e84253bffe43872c309bef6e83edb65837ddc1d98d166c017f346f5ad835e00c042d39abddf7dedf5b7b954e090137fd7e6d0179cdac542cca3d14
+  metadata.gz: fcf5fda1fd7cd0a63652d481cf2570f724cad065fa3ff63d7fc81cf02f74f6fb3856c97625fbcbe5a067d8b4a30e15ca03d2a60f48556b7400af7e5e535e866d
+  data.tar.gz: 6bd097ccf35884c62428ee1271c4b695ba90236adde490d39d44cbf18f883026599abdd30b11059c155d468b4b04e51401cf974998d70741360119d2f6ab2605

data/README.md

@@ -1,4 +1,4 @@
-### :warning: Listen is [looking for new maintainers](https://groups.google.com/forum/#!topic/guard-dev/2Td0QTvTIsE). Please [contact me](mailto:thibaud@thibaud.gg) if you're interested.
+:exclamation: Listen is currently accepting more maintainers. Please [read this](https://github.com/guard/guard/wiki/Maintainers) if you're interested in joining the team.
 
 # Listen
 
@@ -6,19 +6,6 @@
 
 The Listen gem listens to file modifications and notifies you about the changes.
 
-## Known issues / Quickfixes / Workarounds
-
-*NOTE: TCP functionality has been removed from Listen 3.x - please use Listen
-2.x until alternative server and client gems are created/released for 3.x.*
-
-*NOTE: Ruby 1.9.3 is no longer maintained (and may not work with Listen) - it's best to upgrade to Ruby 2.2.2*
-
-For other issues, just head over here: https://github.com/guard/listen/wiki/Quickfixes,-known-issues-and-workarounds
-
-## Tips and Techniques
-
-Make sure you know these few basic tricks: https://github.com/guard/listen/wiki/Tips-and-Techniques
-
 ## Features
 
 * OS-optimized adapters on MRI for Mac OS X 10.6+, Linux, \*BSD and Windows, [more info](#listen-adapters) below.
@@ -28,21 +15,21 @@ Make sure you know these few basic tricks: https://github.com/guard/listen/wiki/
 * Increased change detection accuracy on OS X HFS and VFAT volumes.
 * Tested on MRI Ruby environments (2.0+ only) via [Travis CI](https://travis-ci.org/guard/listen),
 
-NOTE: TCP functionality has been moved to a separate gem (listen-server and listen-client)
-
-NOTES:
-- Some filesystems won't work without polling (VM/Vagrant Shared folders, NFS, Samba, sshfs, etc.)
-- Specs suite on JRuby and Rubinius aren't reliable on Travis CI, but should work.
-- Windows and \*BSD adapter aren't continuously and automaticaly tested.
-
+## Issues / limitations
 
-## Pending features / issues
+* Limited support for symlinked directories ([#279](https://github.com/guard/listen/issues/279)):
+  * Symlinks are always followed ([#25](https://github.com/guard/listen/issues/25)).
+  * Symlinked directories pointing within a watched directory are not supported ([#273](https://github.com/guard/listen/pull/273)- see [Duplicate directory errors](https://github.com/guard/listen/wiki/Duplicate-directory-errors)).
+* No directory/adapter-specific configuration options.
+* Support for plugins planned for future.
+* TCP functionality was removed in Listen [3.0.0](https://github.com/guard/listen/releases/tag/v3.0.0) ([#319](https://github.com/guard/listen/issues/319), [#218](https://github.com/guard/listen/issues/218)). There are plans to extract this feature to separate gems ([#258](https://github.com/guard/listen/issues/258)), until this is finished, you can use by locking the `listen` gem to version `'~> 2.10'`.
+* Some filesystems won't work without polling (VM/Vagrant Shared folders, NFS, Samba, sshfs, etc.).
+* Specs suite on JRuby and Rubinius aren't reliable on Travis CI, but should work.
+* Windows and \*BSD adapter aren't continuously and automatically tested.
+* OSX adapter has some performance limitations ([#342](https://github.com/guard/listen/issues/342)).
+* Ruby 1.9.3 is no longer maintained (and may not work with Listen) - it's best to upgrade to Ruby 2.2.2.
 
-* symlinked directories aren't fully transparent yet: https://github.com/guard/listen/issues/279
-* Directory/adapter specific configuration options
-* Support for plugins
-
-Pull request or help is very welcome for these.
+Pull requests or help is very welcome for these.
 
 ## Install
 
@@ -52,7 +39,6 @@ The simplest way to install Listen is to use [Bundler](http://bundler.io).
 gem 'listen', '~> 3.0' # NOTE: for TCP functionality, use '~> 2.10' for now
 ```
 
-
 ## Usage
 
 Call `Listen.to` with either a single directory or multiple directories, then define the "changes" callback in a block.
@@ -72,7 +58,7 @@ sleep
 Listeners can also be easily paused/unpaused:
 
 ``` ruby
-listener = Listen.to('dir/path/to/listen') { |modified, added, removed| # ... }
+listener = Listen.to('dir/path/to/listen') { |modified, added, removed| puts 'handle changes here...' }
 
 listener.start
 listener.paused? # => false
@@ -102,13 +88,13 @@ listener.ignore /\.rb/   # ignore rb extension in addition of pkg.
 sleep
 ```
 
-Note: Ignoring regexp patterns are evaluated against relative paths.
+Note: `:ignore` regexp patterns are evaluated against relative paths.
 
-Note: ignoring paths does not improve performance - except when Polling
+Note: Ignoring paths does not improve performance, except when Polling ([#274](https://github.com/guard/listen/issues/274))
 
 ### Only
 
-Listen catches all files (less the ignored once) by default, if you want to only listen to a specific type of file (ie: just rb extension) you should use the `only` option/method.
+Listen catches all files (less the ignored ones) by default. If you want to only listen to a specific type of file (i.e., just `.rb` extension), you should use the `only` option/method.
 
 ``` ruby
 listener = Listen.to('dir/path/to/listen', only: /\.rb$/) { |modified, added, removed| # ... }
@@ -117,7 +103,7 @@ 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
@@ -174,14 +160,15 @@ force_polling: true                             # Force the use of the polling a
 relative: false                                 # Whether changes should be relative to current dir or not
                                                 # default: false
 
-debug: true                                     # Enable Listen logger
-                                                # default: false
-
 polling_fallback_message: 'custom message'      # Set a custom polling fallback message (or disable it with false)
                                                 # default: "Listen will be polling for changes. Learn more at https://github.com/guard/listen#listen-adapters."
 ```
 
-Also, setting the environment variable `LISTEN_GEM_DEBUGGING=1` does the same as `debug: true` above.
+## Debugging
+
+Setting the environment variable `LISTEN_GEM_DEBUGGING=1` sets up the INFO level logger, while `LISTEN_GEM_DEBUGGING=2` sets up the DEBUG level logger. 
+
+You can also set `Listen.logger` to a custom logger.
 
 
 ## Listen adapters
@@ -202,7 +189,7 @@ while initializing the listener.
 
 ### On Windows
 
-If your are on Windows, it's recommended to use the [`wdm`](https://github.com/Maher4Ever/wdm) adapter instead of polling.
+If you are on Windows, it's recommended to use the [`wdm`](https://github.com/Maher4Ever/wdm) adapter instead of polling.
 
 Please add the following to your Gemfile:
 
@@ -212,7 +199,7 @@ gem 'wdm', '>= 0.1.0' if Gem.win_platform?
 
 ### On \*BSD
 
-If your are on \*BSD you can try to use the [`rb-kqueue`](https://github.com/mat813/rb-kqueue) adapter instead of polling.
+If you are on \*BSD you can try to use the [`rb-kqueue`](https://github.com/mat813/rb-kqueue) adapter instead of polling.
 
 Please add the following to your Gemfile:
 
@@ -234,7 +221,6 @@ Please visit the [installation section of the Listen WIKI](https://github.com/gu
 
 See [TROUBLESHOOTING](https://github.com/guard/listen/wiki/Troubleshooting)
 
-
 ## 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).
@@ -255,6 +241,8 @@ Also, if the directories you're watching contain many files, make sure you're:
 
 When in doubt, LISTEN_GEM_DEBUGGING=2 can help discover the actual events and time they happened.
 
+See also [Tips and Techniques](https://github.com/guard/listen/wiki/Tips-and-Techniques).
+
 ## Development
 
 * Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/listen/master/frames).

data/lib/listen/adapter/config.rb

@@ -9,6 +9,9 @@ module Listen
       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

data/lib/listen/adapter/darwin.rb

@@ -16,32 +16,27 @@ module Listen
       # 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
 
-      # NOTE: _run is called within a thread, so run every other
-      # worker in it's own thread
       def _run
         first = @workers.pop
-        until @workers.empty?
-          next_worker = @workers.pop
-          Listen::Internals::ThreadPool.add do
-            begin
-              next_worker.run
-            rescue
-              _log_exception 'run() in extra thread(s) failed: %s: %s'
-            end
-          end
-        end
-        first.run
+
+        # 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}"
@@ -50,6 +45,27 @@ module Listen
           _queue_change(:dir, dir, rel_path, recursive: true)
         end
       end
+
+      def _run_worker(worker)
+        _log :debug, "fsevent: running worker: #{worker.inspect}"
+        worker.run
+      rescue
+        _log_exception 'fsevent: running worker failed: %s: %s'
+      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
+          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/listen/adapter/linux.rb

@@ -27,7 +27,7 @@ module Listen
       EOS
 
       def _configure(directory, &callback)
-        Kernel.require 'rb-inotify'
+        require 'rb-inotify'
         @worker ||= ::INotify::Notifier.new
         @worker.watch(directory.to_s, *options.events, &callback)
       rescue Errno::ENOSPC

data/lib/listen/version.rb

@@ -1,3 +1,3 @@
 module Listen
-  VERSION = '3.0.3'
+  VERSION = '3.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb-fsevent