listen 2.0.0.beta.1 → 2.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5eb3d853fcddc242d96e4e0295b3966b6349119
-  data.tar.gz: aa33f0a0e2d623d76027f758b78463ae2c052573
+  metadata.gz: b3c0d6aa22397845dc50777764501d381ec45bdb
+  data.tar.gz: 6cbfc75ffc6dde9be05a619696939f2ff2e90bbc
 SHA512:
-  metadata.gz: ce58ba37a3bdee68cb69dcff3b3a583dec582cb1ccb680e81c6e14d33fea0d5a0d99fcf16e4346c91d56786d31f0e694c671c52de3eab4269e48409bfce3d3c5
-  data.tar.gz: 9e6856329957aeedb9415eaf26255b373ff60d288128bd82a2ca8cbd9c7e9fe075a74c055e0ddcb7afd6fc68d6781262c94d7bde8005e6b0a765834e1ce79ec0
+  metadata.gz: 6ae4ce1cab4d08a3edba293614e20b82b112c1821f3f0e15f653e37b1f8d4ba6a14eb6f65727622faf7651dcf1f347e4f6f0fbae7a52e7359b3f47bc38cbc9a8
+  data.tar.gz: 6b657af0772fe26bf87916534247b52a22ba17afe80d9f515db139a6ef100d6764e6c19ed9bbeafcd0f95d5d6951a2a3578515b17d24d40c43e5a69e25dbf0bc

data/README.md

@@ -1,4 +1,4 @@
-# Listen [![Gem Version](https://badge.fury.io/rb/listen.png)](http://badge.fury.io/rb/listen) [![Build Status](https://secure.travis-ci.org/guard/listen.png?branch=master)](http://travis-ci.org/guard/listen) [![Dependency Status](https://gemnasium.com/guard/listen.png)](https://gemnasium.com/guard/listen) [![Code Climate](https://codeclimate.com/github/guard/listen.png)](https://codeclimate.com/github/guard/listen) [![Coverage Status](https://coveralls.io/repos/guard/listen/badge.png?branch=master)](https://coveralls.io/r/guard/listen)
+# Listen [![Gem Version](https://badge.fury.io/rb/listen.png)](http://badge.fury.io/rb/listen) [![Build Status](https://travis-ci.org/guard/listen.png)](https://travis-ci.org/guard/listen) [![Dependency Status](https://gemnasium.com/guard/listen.png)](https://gemnasium.com/guard/listen) [![Code Climate](https://codeclimate.com/github/guard/listen.png)](https://codeclimate.com/github/guard/listen) [![Coverage Status](https://coveralls.io/repos/guard/listen/badge.png?branch=master)](https://coveralls.io/r/guard/listen)
 
 The Listen gem listens to file modifications and notifies you about the changes.
 
@@ -66,6 +66,18 @@ listener.unpause # start listening to changes again
 listener.stop    # stop completely the listener
 ```
 
+### Ignore / ignore!
+
+Liste ignore some folder and extensions by default (See DEFAULT_IGNORED_DIRECTORIES and DEFAULT_IGNORED_EXTENSIONS in Listen::Silencer), you can add ignoring patterns with the `ignore` option/method or overwrite default with `ignore!` option/method.
+
+``` ruby
+listener = Listen.to('dir/path/to/listen', ignore: /\.txt/) { |modified, added, removed| # ... }
+listener.start
+listener.ignore! /\.pkg/  # overwrite all patterns and only ignore pkg extension.
+listener.ignore /\.rb/    # ignore rb extension in addition of pkg.
+sleep
+``
+
 ## Changes callback
 
 Changes to the listened-to directories gets reported back to the user in a callback.

data/lib/listen/adapter/bsd.rb

@@ -40,6 +40,7 @@ module Listen
       # the directories passed to the adapter.
       #
       # @return [INotify::Notifier] initialized kqueue
+      #
       def _init_worker
         KQueue::Queue.new.tap do |queue|
           _directories_path.each do |path|

data/lib/listen/adapter/linux.rb

@@ -42,6 +42,7 @@ module Listen
       # each directory passed to the adapter.
       #
       # @return [INotify::Notifier] initialized worker
+      #
       def _init_worker
         INotify::Notifier.new.tap do |worker|
           _directories_path.each { |path| worker.watch(path, *EVENTS, &_worker_callback) }

data/lib/listen/adapter/windows.rb

@@ -33,6 +33,7 @@ module Listen
       # each directory passed to the adapter.
       #
       # @return [WDM::Monitor] initialized worker
+      #
       def _init_worker
         WDM::Monitor.new.tap do |worker|
           _directories_path.each { |path| worker.watch_recursively(path, &_worker_callback) }

data/lib/listen/change.rb

@@ -1,20 +1,18 @@
 require 'listen/file'
 require 'listen/directory'
-require 'listen/silencer'
 
 module Listen
   class Change
     include Celluloid
 
-    attr_accessor :listener, :silencer
+    attr_accessor :listener
 
     def initialize(listener)
       @listener = listener
-      @silencer = Silencer.new(listener.options)
     end
 
     def change(path, options)
-      return if silencer.silenced?(path)
+      return if _silencer.silenced?(path)
       if change = options[:change]
         _notify_listener(change, path)
       else
@@ -38,5 +36,10 @@ module Listen
     def _notify_listener(change, path)
       listener.changes << { change => path }
     end
+
+    def _silencer
+      Celluloid::Actor[:listen_silencer]
+    end
+
   end
 end

data/lib/listen/listener.rb

@@ -1,10 +1,11 @@
 require 'listen/adapter'
 require 'listen/change'
 require 'listen/record'
+require 'listen/silencer'
 
 module Listen
   class Listener
-    attr_accessor :options, :directories, :paused, :changes, :block
+    attr_accessor :options, :directories, :paused, :changes, :block, :thread
 
     RELATIVE_PATHS_WITH_MULTIPLE_DIRECTORIES_WARNING_MESSAGE = "The relative_paths option doesn't work when listening to multiple diretories."
 
@@ -34,40 +35,66 @@ module Listen
       _signals_trap
       _init_actors
       unpause
-      adapter.async.start
+      Celluloid::Actor[:listen_adapter].async.start
       @thread = Thread.new { _wait_for_changes }
     end
 
+    # Terminates all Listen actors and kill the adapter.
+    #
     def stop
-      Celluloid::Actor.kill(adapter)
+      thread.kill
+      Celluloid::Actor.kill(Celluloid::Actor[:listen_adapter])
+      Celluloid::Actor[:listen_silencer].terminate
       Celluloid::Actor[:listen_change_pool].terminate
-      record && record.terminate
-      @thread && @thread.kill
+      Celluloid::Actor[:listen_record].terminate
     end
 
+    # Pauses listening callback (adapter still running)
+    #
     def pause
       @paused = true
     end
 
+    # Unpauses listening callback
+    #
     def unpause
-      _build_record_if_needed
+      Celluloid::Actor[:listen_record].build
       @paused = false
     end
 
+    # Returns true if Listener is paused
+    #
+    # @return [Boolean]
+    #
     def paused?
       @paused == true
     end
 
+    # Returns true if Listener is not paused
+    #
+    # @return [Boolean]
+    #
     def listen?
       @paused == false
     end
 
-    def adapter
-      Celluloid::Actor[:listen_adapter]
+    # Adds ignore patterns to the existing one (See DEFAULT_IGNORED_DIRECTORIES and DEFAULT_IGNORED_EXTENSIONS in Listen::Silencer)
+    #
+    # @param [Regexp, Hash<Regexp>] new ignoring patterns.
+    #
+    def ignore(regexps)
+      options[:ignore] = [options[:ignore], regexps]
+      Celluloid::Actor[:listen_silencer] = Silencer.new(options)
     end
 
-    def record
-      Celluloid::Actor[:listen_record]
+    # Overwrites ignore patterns (See DEFAULT_IGNORED_DIRECTORIES and DEFAULT_IGNORED_EXTENSIONS in Listen::Silencer)
+    #
+    # @param [Regexp, Hash<Regexp>] new ignoring patterns.
+    #
+    def ignore!(regexps)
+      options.delete(:ignore)
+      options[:ignore!] = regexps
+      Celluloid::Actor[:listen_silencer] = Silencer.new(options)
     end
 
     private
@@ -89,6 +116,7 @@ module Listen
 
     def _init_actors
       cores = Celluloid.cores || 2
+      Celluloid::Actor[:listen_silencer]    = Silencer.new(options)
       Celluloid::Actor[:listen_change_pool] = Change.pool(size: cores, args: self)
       Celluloid::Actor[:listen_adapter]     = Adapter.new(self)
       Celluloid::Actor[:listen_record]      = Record.new(self)
@@ -100,18 +128,11 @@ module Listen
       end
     end
 
-    def _build_record_if_needed
-      record && record.build
-    end
-
     def _wait_for_changes
       loop do
         changes = _pop_changes
-        unless changes.values.all?(&:empty?)
-          block.call(
-            changes[:modified].uniq,
-            changes[:added].uniq,
-            changes[:removed].uniq)
+        unless changes.all? { |_,v| v.empty? }
+          block.call(changes[:modified], changes[:added], changes[:removed])
         end
         sleep 0.1
       end
@@ -126,7 +147,7 @@ module Listen
         change = @changes.pop
         change.each { |k, v| changes[k] << v.to_s }
       end
-      changes
+      changes.each { |_, v| v.uniq! }
     end
   end
 end

data/lib/listen/silencer.rb

@@ -1,7 +1,9 @@
 module Listen
   class Silencer
+    include Celluloid
+
     # The default list of directories that get ignored.
-    DEFAULT_IGNORED_DIRECTORIES = %w[.rbx .bundle .git .svn .hg bundle log tmp vendor]
+    DEFAULT_IGNORED_DIRECTORIES = %w[.rbx .bundle .git .svn .hg bundle log tmp vendor/ruby]
 
     # The default list of files that get ignored.
     DEFAULT_IGNORED_EXTENSIONS  = %w[.DS_Store]
@@ -14,7 +16,7 @@ module Listen
     end
 
     def silenced?(path)
-      patterns.any? { |pattern| pattern =~ path.to_s }
+      patterns.any? { |pattern| path.to_s =~ pattern }
     end
 
     private
@@ -23,7 +25,7 @@ module Listen
       @patterns = []
       @patterns << _default_patterns unless options[:ignore!]
       @patterns << options[:ignore] << options[:ignore!]
-      @patterns.compact
+      @patterns.compact!
       @patterns.flatten!
     end
 

data/lib/listen/version.rb

@@ -1,3 +1,3 @@
 module Listen
-  VERSION = "2.0.0.beta.1"
+  VERSION = "2.0.0.beta.2"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: listen
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.1
+  version: 2.0.0.beta.2
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
-- Maher Sallam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-14 00:00:00.000000000 Z
+date: 2013-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -97,9 +96,7 @@ dependencies:
         version: '0'
 description: The Listen gem listens to file modifications and notifies you about the
   changes. Works everywhere!
-email:
-- thibaud@thibaud.me
-- maher@sallam.me
+email: thibaud@thibaud.me
 executables: []
 extensions: []
 extra_rdoc_files: []