guard 1.2.3 → 1.3.0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Master
 
+### Bug fix
+
+- [#299][] Fix Readline interactor on JRruby. ([@netzpirat][])
+
+### Improvements
+
+- Add support for OS X notification center ([@foxycoder][])
+- Add support for Emacs notifications ([@maio][])
+- Add support for multiple guards being passed to `guard init`. ([@jredville][])
+
 ### 1.2.1 - 2 Juli, 2012
 
 ### Bug fix
@@ -561,6 +571,8 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 [#274]: https://github.com/guard/guard/issues/274
 [#275]: https://github.com/guard/guard/issues/275
 [#283]: https://github.com/guard/guard/issues/283
+[#298]: https://github.com/guard/guard/issues/298
+[#299]: https://github.com/guard/guard/issues/299
 [@Gazer]: https://github.com/Gazer
 [@Maher4Ever]: https://github.com/Maher4Ever
 [@alandipert]: https://github.com/alandipert
@@ -581,6 +593,7 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 [@f1sherman]: https://github.com/f1sherman
 [@fabioyamate]: https://github.com/fabioyamate
 [@fnichol]: https://github.com/fnichol
+[@foxycoder]: https://github.com/foxycoder
 [@gix]: https://github.com/gix
 [@hardipe]: https://github.com/hardipe
 [@hashrocketeer]: https://github.com/hashrocketeer
@@ -590,11 +603,13 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 [@indirect]: https://github.com/indirect
 [@jeffutter]: https://github.com/jeffutter
 [@johnbintz]: https://github.com/johnbintz
+[@jredville]: https://github.com/jredville
 [@jrsacks]: https://github.com/jrsacks
 [@koshigoe]: https://github.com/koshigoe
 [@laserlemon]: https://github.com/laserlemon
 [@limeyd]: https://github.com/limeyd
 [@madtrick]: https://github.com/madtrick
+[@maio]: https://github.com/maio
 [@mcmire]: https://github.com/mcmire
 [@mislav]: https://github.com/mislav
 [@monocle]: https://github.com/monocle
@@ -629,4 +644,4 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 [@waldo]: https://github.com/waldo
 [@wereHamster]: https://github.com/wereHamster
 [@yannlugrin]: https://github.com/yannlugrin
-[@zonque]: https://github.com/zonque
+[@zonque]: https://github.com/zonque

data/README.md

@@ -171,6 +171,26 @@ group :development do
 end
 ```
 
+#### Emacs
+
+* Runs on any platform with Emacs + emacsclient (http://www.emacswiki.org/emacs/EmacsClient)
+
+#### Terminal Notifier
+
+* Runs on Mac OS X 10.8 only
+
+The [terminal notifier](https://github.com/alloy/terminal-notifier) sends notifications to the OS X Notification Center.
+The notification center doesn't support different icons for different message types, and it even shows only the icon
+from Terminal.app.
+
+To use `terminal_notifier` you have to add it to your `Gemfile` and run bundler:
+
+```ruby
+group :development do
+  gem 'terminal_notifier'
+end
+```
+
 Add Guard plugins
 -----------------
 
@@ -225,6 +245,13 @@ in the generated Guardfile:
 $ guard init <guard-name>
 ```
 
+You can also specify the names of multiple plugins to only get those plugin templates
+in the generated Guardfile:
+
+```bash
+$ guard init <guard1-name> <guard2-name>
+```
+
 You can also define your own templates in `~/.guard/templates/` which can be appended in the same way to your existing
 `Guardfile`:
 
@@ -399,7 +426,7 @@ You can interact with Guard and enter commands when Guard has nothing to do. Gua
 * `↩`:                 Run all plugins.
 * `h`, `help`:         Show a help of the available interactor commands.
 * `r`, `reload`:       Reload all plugins.
-* `c`, `change`:       Show a help of the available interactor commands.
+* `c`, `change`:       Trigger a file change to the plugins.
 * `s`, `show`:         Show the plugin configurations.
 * `n`, `notification`: Toggle system notifications on and off.
 * `p`, `pause`:        Toggles the file modification listener. The prompt will change to `p>` when paused.
@@ -473,7 +500,7 @@ Guard will automatically enable Coolline support if your environment supports it
 
 ### Signals
 
-You can also interact with Guard by sending POSIX signals to the Guard process (all but Windows).
+You can also interact with Guard by sending POSIX signals to the Guard process (all but Windows and JRuby).
 
 #### Pause watching
 
@@ -605,6 +632,7 @@ notification :gntp, :sticky => true, :host => '192.168.1.5', :password => 'secre
 notification :growl_notify, :sticky => true, :priority => 0
 notification :libnotify, :timeout => 5, :transient => true, :append => false, :urgency => :critical
 notification :notifu, :time => 5, :nosound => true, :xp => true
+notification :emacs
 ```
 
 It's possible to use more than one notifier. This allows you to configure different notifiers for different OS if your
@@ -652,9 +680,16 @@ more details.
 
 ### ignore
 
-The `ignore` method allows you to ignore specific paths. This comes is handy when you have large
-amounts of non-source data in you project. By default [`.rbx`, `.bundle`, `.git`, `.svn`, `log`, `tmp`, `vendor`](https://github.com/guard/listen/blob/master/lib/listen/directory_record.rb#L14) are ignored.
-Please note that method only accept regexps. More on the [Listen README](https://github.com/guard/listen#the-patterns-for-filtering-and-ignoring-paths).
+The `ignore` method can be used to exclude files and directories from the set of files being watched. Let's say you have
+used the `watch` method to monitor a directory, but you are not interested in changes happening to images, you could use
+the ignore method to exclude them.
+
+This comes in handy when you have large amounts of non-source data in you project. By default
+[`.rbx`, `.bundle`, `.git`, `.svn`, `log`, `tmp`, `vendor`](https://github.com/guard/listen/blob/master/lib/listen/directory_record.rb#L14)
+are ignored.
+
+Please note that method only accept regexps. More on the
+[Listen README](https://github.com/guard/listen#the-patterns-for-filtering-and-ignoring-paths).
 
 ```ruby
 ignore %r{^ignored/path/}, /public/
@@ -662,8 +697,12 @@ ignore %r{^ignored/path/}, /public/
 
 ### filter
 
-The `filter` method allows you to filter specific paths.
-Please note that method only accept regexps. More on the [Listen README](https://github.com/guard/listen#the-patterns-for-filtering-and-ignoring-paths).
+The `filter` method allows you to focus by filtering files and directories without having to specify them by hand in the
+`watch` method. E.g. if you are watching multiple directories but only interested in changes to the Ruby files, then use
+the `filter` method.
+
+Please note that method only accept regexps. More on the
+[Listen README](https://github.com/guard/listen#the-patterns-for-filtering-and-ignoring-paths).
 
 ```ruby
 filter /\.txt$/, /.*\.zip/

data/lib/guard.rb

@@ -6,19 +6,18 @@ require 'listen'
 #
 module Guard
 
-  autoload :UI,           'guard/ui'
-  autoload :Guardfile,    'guard/guardfile'
-  autoload :Dsl,          'guard/dsl'
-  autoload :DslDescriber, 'guard/dsl_describer'
-  autoload :Group,        'guard/group'
-  autoload :Interactor,   'guard/interactor'
-  autoload :Watcher,      'guard/watcher'
-  autoload :Notifier,     'guard/notifier'
-  autoload :Runner,       'guard/runner'
-  autoload :Hook,         'guard/hook'
+  require 'guard/dsl'
+  require 'guard/guardfile'
+  require 'guard/group'
+  require 'guard/interactor'
+  require 'guard/notifier'
+  require 'guard/runner'
+  require 'guard/ui'
+  require 'guard/watcher'
 
   # The Guardfile template for `guard init`
   GUARDFILE_TEMPLATE = File.expand_path('../guard/templates/Guardfile', __FILE__)
+
   # The location of user defined templates
   HOME_TEMPLATES = File.expand_path('~/.guard/templates')
 
@@ -44,10 +43,10 @@ module Guard
       @lock       = Mutex.new
       @options    = options
       @watchdir   = (options[:watchdir] && File.expand_path(options[:watchdir])) || Dir.pwd
-      @runner     = Runner.new
+      @runner     = ::Guard::Runner.new
       @allow_stop = Listen::Turnstile.new
 
-      UI.clear
+      ::Guard::UI.clear
       deprecated_options_warning
 
       setup_groups
@@ -57,8 +56,8 @@ module Guard
 
       debug_command_execution if @options[:debug]
 
-      Dsl.evaluate_guardfile(options)
-      UI.error 'No guards found in Guardfile, please add at least one.' if @guards.empty?
+      ::Guard::Dsl.evaluate_guardfile(options)
+      ::Guard::UI.error 'No guards found in Guardfile, please add at least one.' if @guards.empty?
 
       runner.deprecation_warning if @options[:show_deprecations]
 
@@ -84,19 +83,21 @@ module Guard
       @guards = []
     end
 
-    # Sets up traps to catch signlas used to control Guard.
+    # Sets up traps to catch signals used to control Guard.
     #
-    # Currently two signals are cought:
+    # Currently two signals are caught:
     # - `USR1` which pauses listening to changes.
     # - `USR2` which resumes listening to changes.
     #
     def setup_signal_traps
-      if Signal.list.keys.include?('USR1')
-        Signal.trap('USR1') { ::Guard.pause unless @listener.paused? }
-      end
-
-      if Signal.list.keys.include?('USR2')
-        Signal.trap('USR2') { ::Guard.pause if @listener.paused? }
+      unless defined?(JRUBY_VERSION)
+        if Signal.list.keys.include?('USR1')
+          Signal.trap('USR1') { ::Guard.pause unless @listener.paused? }
+        end
+  
+        if Signal.list.keys.include?('USR2')
+          Signal.trap('USR2') { ::Guard.pause if @listener.paused? }
+        end
       end
     end
 
@@ -104,7 +105,7 @@ module Guard
     #
     def setup_listener
       listener_callback = lambda do |modified, added, removed|
-        Dsl.reevaluate_guardfile if Watcher.match_guardfile?(modified)
+        ::Guard::Dsl.reevaluate_guardfile if ::Guard::Watcher.match_guardfile?(modified)
 
         ::Guard.within_preserved_state do
           runner.run_on_changes(modified, added, removed)
@@ -122,19 +123,19 @@ module Guard
     # Enables or disables the notifier based on user's configurations.
     #
     def setup_notifier
-      options[:notify] && ENV['GUARD_NOTIFY'] != 'false' ? Notifier.turn_on : Notifier.turn_off
+      options[:notify] && ENV['GUARD_NOTIFY'] != 'false' ? ::Guard::Notifier.turn_on : ::Guard::Notifier.turn_off
     end
 
     # Initializes the interactor unless the user has specified not to.
     #
     def setup_interactor
       unless options[:no_interactions]
-        @interactor = Interactor.fabricate
+        @interactor = ::Guard::Interactor.fabricate
       end
     end
 
-    # Start Guard by evaluate the `Guardfile`, initialize the declared Guard plugins
-    # and start the available file change listener.
+    # Start Guard by evaluating the `Guardfile`, initializing declared Guard plugins
+    # and starting the available file change listener.
     # Main method for Guard that is called from the CLI when Guard starts.
     #
     # - Setup Guard internals
@@ -152,7 +153,7 @@ module Guard
     #
     def start(options = {})
       setup(options)
-      UI.info "Guard is now watching at '#{ @watchdir }'"
+      ::Guard::UI.info "Guard is now watching at '#{ @watchdir }'"
 
       within_preserved_state do
         runner.run(:start)
@@ -169,32 +170,32 @@ module Guard
       listener.stop
       interactor.stop if interactor
       runner.run(:stop)
-      UI.info 'Bye bye...', :reset => true
+      ::Guard::UI.info 'Bye bye...', :reset => true
 
       @allow_stop.signal if @allow_stop
     end
 
     # Reload Guardfile and all Guard plugins currently enabled.
     #
-    # @param [Hash] scopes an hash with a Guard plugin or a group scope
+    # @param [Hash] scopes hash with a Guard plugin or a group scope
     #
     def reload(scopes)
       within_preserved_state do
-        UI.clear
-        UI.action_with_scopes('Reload', scopes)
-        Dsl.reevaluate_guardfile if scopes.empty?
+        ::Guard::UI.clear
+        ::Guard::UI.action_with_scopes('Reload', scopes)
+        ::Guard::Dsl.reevaluate_guardfile if scopes.empty?
         runner.run(:reload, scopes)
       end
     end
 
     # Trigger `run_all` on all Guard plugins currently enabled.
     #
-    # @param [Hash] scopes an hash with a Guard plugin or a group scope
+    # @param [Hash] scopes hash with a Guard plugin or a group scope
     #
     def run_all(scopes)
       within_preserved_state do
-        UI.clear
-        UI.action_with_scopes('Run', scopes)
+        ::Guard::UI.clear
+        ::Guard::UI.action_with_scopes('Run', scopes)
         runner.run(:run_all, scopes)
       end
     end
@@ -203,10 +204,10 @@ module Guard
     #
     def pause
       if listener.paused?
-        UI.info 'Un-paused files modification listening', :reset => true
+        ::Guard::UI.info 'Un-paused files modification listening', :reset => true
         listener.unpause
       else
-        UI.info 'Paused files modification listening', :reset => true
+        ::Guard::UI.info 'Paused files modification listening', :reset => true
         listener.pause
       end
     end
@@ -284,7 +285,7 @@ module Guard
     #
     def add_guard(name, watchers = [], callbacks = [], options = {})
       if name.to_sym == :ego
-        UI.deprecation('Guard::Ego is now part of Guard. You can remove it from your Guardfile.')
+        ::Guard::UI.deprecation('Guard::Ego is now part of Guard. You can remove it from your Guardfile.')
       else
         guard_class = get_guard_class(name)
         callbacks.each { |callback| Hook.add_callback(callback[:listener], guard_class, callback[:events]) }
@@ -304,7 +305,7 @@ module Guard
     def add_group(name, options = {})
       group = groups(name)
       if group.nil?
-        group = Group.new(name, options)
+        group = ::Guard::Group.new(name, options)
         @groups << group
       end
       group
@@ -357,12 +358,12 @@ module Guard
           try_require = true
           retry
         else
-          UI.error "Could not find class Guard::#{ const_name.capitalize }"
+          ::Guard::UI.error "Could not find class Guard::#{ const_name.capitalize }"
         end
       rescue LoadError => loadError
         unless fail_gracefully
-          UI.error "Could not load 'guard/#{ name.downcase }' or find class Guard::#{ const_name.capitalize }"
-          UI.error loadError.to_s
+          ::Guard::UI.error "Could not load 'guard/#{ name.downcase }' or find class Guard::#{ const_name.capitalize }"
+          ::Guard::UI.error loadError.to_s
         end
       end
     end
@@ -379,7 +380,7 @@ module Guard
         Gem.source_index.find_name("guard-#{ name }").last.full_gem_path
       end
     rescue
-      UI.error "Could not find 'guard-#{ name }' gem path."
+      ::Guard::UI.error "Could not find 'guard-#{ name }' gem path."
     end
 
     # Returns a list of Guard plugin Gem names installed locally.

data/lib/guard/cli.rb

@@ -1,5 +1,4 @@
 require 'thor'
-require 'guard/version'
 
 module Guard
 
@@ -9,6 +8,11 @@ module Guard
   #
   class CLI < Thor
 
+    require 'guard'
+    require 'guard/version'
+    require 'guard/dsl_describer'
+    require 'guard/guardfile'
+
     default_task :start
 
     desc 'start', 'Starts Guard'
@@ -90,7 +94,7 @@ module Guard
                   :aliases => '-p',
                   :banner  => 'Force usage of the Listen polling listener'
 
-    # Start Guard by initialize the defined Guard plugins and watch the file system.
+    # Start Guard by initializing the defined Guard plugins and watch the file system.
     # This is the default task, so calling `guard` is the same as calling `guard start`.
     #
     # @see Guard.start
@@ -127,7 +131,7 @@ module Guard
       ::Guard::UI.info "Guard version #{ ::Guard::VERSION }"
     end
 
-    desc 'init [GUARD]', 'Generates a Guardfile at the current directory (if it is not already there) and adds all installed guards or the given GUARD into it'
+    desc 'init [GUARDS]', 'Generates a Guardfile at the current directory (if it is not already there) and adds all installed guards or the given GUARDS into it'
 
     method_option :bare,
                   :type => :boolean,
@@ -135,26 +139,28 @@ module Guard
                   :aliases => '-b',
                   :banner => 'Generate a bare Guardfile without adding any installed guard into it'
 
-    # Initializes the templates of all installed Guard pluginss and adds them
+    # Initializes the templates of all installed Guard plugins and adds them
     # to the `Guardfile` when no Guard name is passed. When passing
-    # a Guard plugin name it does the same but only for that Guard plugin.
+    # Guard plugin names it does the same but only for those Guard plugins.
     #
     # @see Guard::Guard.initialize_template
     # @see Guard::Guard.initialize_all_templates
     #
-    # @param [String] guard_name the name of the Guard plugin to initialize
+    # @param [Array<String>] guard_names the name of the Guard plugins to initialize
     #
-    def init(guard_name = nil)
+    def init(*guard_names)
       verify_bundler_presence
 
       ::Guard::Guardfile.create_guardfile(:abort_on_existence => options[:bare])
 
       return if options[:bare]
 
-      if guard_name.nil?
+      if guard_names.empty?
         ::Guard::Guardfile::initialize_all_templates
       else
-        ::Guard::Guardfile.initialize_template(guard_name)
+        guard_names.each do |guard_name|
+          ::Guard::Guardfile.initialize_template(guard_name)
+        end
       end
     end
 

data/lib/guard/dsl.rb

@@ -84,6 +84,13 @@ module Guard
   #
   class Dsl
 
+    require 'guard'
+    require 'guard/dsl'
+    require 'guard/interactor'
+    require 'guard/notifier'
+    require 'guard/ui'
+    require 'guard/watcher'
+
     # Deprecation message for the `ignore_paths` method
     IGNORE_PATHS_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
       Starting with Guard v1.1 the use of the 'ignore_paths' Guardfile dsl method is deprecated.
@@ -116,7 +123,7 @@ module Guard
       #
       def reevaluate_guardfile
         before_reevaluate_guardfile
-        Dsl.evaluate_guardfile(@@options)
+        ::Guard::Dsl.evaluate_guardfile(@@options)
         after_reevaluate_guardfile
       end
 
@@ -156,7 +163,7 @@ module Guard
       def instance_eval_guardfile(contents)
         new.instance_eval(contents, @@options[:guardfile_path], 1)
       rescue
-        UI.error "Invalid Guardfile, original error is:\n#{ $! }"
+        ::Guard::UI.error "Invalid Guardfile, original error is:\n#{ $! }"
       end
 
       # Test if the current `Guardfile` contains a specific Guard plugin.
@@ -176,7 +183,7 @@ module Guard
         @@options[:guardfile_path]     = guardfile_path
         @@options[:guardfile_contents] = File.read(guardfile_path)
       rescue
-        UI.error("Error reading file #{ guardfile_path }")
+        ::Guard::UI.error("Error reading file #{ guardfile_path }")
         exit 1
       end
 
@@ -185,15 +192,15 @@ module Guard
       #
       def fetch_guardfile_contents
         if @@options[:guardfile_contents]
-          UI.info 'Using inline Guardfile.'
+          ::Guard::UI.info 'Using inline Guardfile.'
           @@options[:guardfile_path] = 'Inline Guardfile'
 
         elsif @@options[:guardfile]
           if File.exist?(@@options[:guardfile])
             read_guardfile(@@options[:guardfile])
-            UI.info "Using Guardfile at #{ @@options[:guardfile] }."
+            ::Guard::UI.info "Using Guardfile at #{ @@options[:guardfile] }."
           else
-            UI.error "No Guardfile exists at #{ @@options[:guardfile] }."
+            ::Guard::UI.error "No Guardfile exists at #{ @@options[:guardfile] }."
             exit 1
           end
 
@@ -201,13 +208,13 @@ module Guard
           if File.exist?(guardfile_default_path)
             read_guardfile(guardfile_default_path)
           else
-            UI.error 'No Guardfile found, please create one with `guard init`.'
+            ::Guard::UI.error 'No Guardfile found, please create one with `guard init`.'
             exit 1
           end
         end
 
         unless guardfile_contents_usable?
-          UI.error 'No Guard plugins found in Guardfile, please add at least one.'
+          ::Guard::UI.error 'No Guard plugins found in Guardfile, please add at least one.'
         end
       end
 
@@ -433,7 +440,7 @@ module Guard
     # @param [Array] paths the list of paths to ignore
     #
     def ignore_paths(*paths)
-      UI.deprecation(IGNORE_PATHS_DEPRECATION)
+      ::Guard::UI.deprecation(IGNORE_PATHS_DEPRECATION)
     end
 
     # Ignore certain patterns paths globally.