guard 1.2.1 → 1.2.2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Master
 
+### 1.2.2 - 2 Juli, 2012
+
+### Bug fix
+
+- [#298][] Deprecations must be explicit enabled. ([@netzpirat][])
+
 ### 1.2.1 - 20 June, 2012
 
 ### Bug fix
@@ -31,7 +37,7 @@
 - New `--force-polling`/`-p` option to force usage of the Listen polling listener.
 - `--watch-all-modifications`/`-A` option is removed and is now always on.
 - `--no-vendor`/`-I` option is removed because the monitoring gems are now part of the [Listen gem](https://github.com/guard/listen). You can specify a custom version of any monitoring gem directly in your Gemfile if you want to overwrite Listen's default monitoring gems.
-- Guards implementations must now implement `run_on_additions`, `run_on_modifications`, `run_on_removals` and / or `run_on_changes`. The `run_on_change` and `run_on_deletion` methods are deprecated and should be removed as soon as possible. See the [Upgrade guide for existing guards to Guard v1.1](https://github.com/guard/guard/wiki/Upgrade-guide-for-existing-guards-to-Guard-v1.1) for more info.
+- Guard plugins must now implement `run_on_additions`, `run_on_modifications`, `run_on_removals` and / or `run_on_changes`. The `run_on_change` and `run_on_deletion` methods are deprecated and should be removed as soon as possible. See the [Upgrade guide for existing guards to Guard v1.1](https://github.com/guard/guard/wiki/Upgrade-guide-for-existing-guards-to-Guard-v1.1) for more info.
 
 The Listen integration has been supervised by [@thibaudgg][] and executed by [@Maher4Ever][], [@rymai][] and [@thibaudgg][].
 
@@ -219,7 +225,7 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 
 - [#136][] New CLI `:watch_all_modifications`/`-A` option to watch for deleted and moved files too. ([@limeyd][] and [@netzpirat][])
 - [#97][] Guard dependencies. Task execution can now be halted if a Guard throws `:task_has_failed` and `Guard::Dsl#group` options include `:halt_on_fail => true`. ([@rymai][])
-- [#121][] `Guard.guards` and `Guard.groups` are now smart accessors. Filters can be passed to find a specific Guard/group or several Guards/groups that match (see YARDoc). ([@rymai][] and [@ches][])
+- [#121][] `Guard.guards` and `Guard.groups` are now smart accessors. Filters can be passed to find a specific Guard/group or several Guard plugins/groups that match (see YARDoc). ([@rymai][] and [@ches][])
 - New `Guard::Group` class to store groups defined in Guardfile (with `Guard::Dsl#group`). ([@rymai][])
 
 ### Improvements
@@ -262,7 +268,7 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 ### New features
 
 - Groups are now stored in a `groups` instance variable (will be used for future features). ([@rymai][])
-- Guards will now receive their group in the options hash at initialization (will be used for future features). ([@rymai][])
+- Guard plugins will now receive their group in the options hash at initialization (will be used for future features). ([@rymai][])
 
 ### Improvement
 
@@ -308,7 +314,7 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 ### New features
 
 - Guard::Ego is now part of Guard, so Guardfile is automagically re-evaluated when modified. ([@thibaudgg][])
-- [#91][] Show Guards in Guardfile with the `guard -T`. ([@johnbintz][])
+- [#91][] Show Guard plugins in Guardfile with the `guard -T`. ([@johnbintz][])
 
 ### Improvements
 

data/README.md

@@ -7,6 +7,9 @@ This document contains a lot of information, please take your time and read thes
 any questions, ask them in our [Google group](http://groups.google.com/group/guard-dev) or on `#guard`
 (irc.freenode.net).
 
+Information on advanced topics like create your own Guard plugin, programatic use of Guard, hooks and callbacks and
+more can be found in the [Guard wiki](https://github.com/guard/guard/wiki).
+
 Before you file an issue, make sure you have read the _[file an issue](#file-an-issue)_ section that contains some
 important information.
 
@@ -15,7 +18,7 @@ Features
 
 * File system changes handled by our awesome [Listen](https://github.com/guard/listen) gem.
 * Support for visual system notifications.
-* Huge ([more than 120](https://rubygems.org/search?query=guard-)) guard extensions eco-system.
+* Huge eco-system with [more than 130](https://rubygems.org/search?query=guard-) guard plugins.
 * Tested against Ruby 1.8.7, 1.9.2, 1.9.3, REE and the latest versions of JRuby & Rubinius.
 
 Screencast
@@ -168,22 +171,22 @@ group :development do
 end
 ```
 
-Add more Guards
----------------
+Add Guard plugins
+-----------------
 
-Guard is now ready to use and you should add some Guards for your specific use. Start exploring the many Guards
-available by browsing the [Guard organization](https://github.com/guard) on GitHub or by searching for `guard-` on
-[RubyGems](https://rubygems.org/search?utf8=%E2%9C%93&query=guard-).
+Guard is now ready to use and you should add some Guard plugins for your specific use. Start exploring the many Guard
+plugins available by browsing the [Guard organization](https://github.com/guard) on GitHub or by searching for `guard-`
+on [RubyGems](https://rubygems.org/search?utf8=%E2%9C%93&query=guard-).
 
-When you have found a Guard of your interest, add it to your `Gemfile`:
+When you have found a Guard plugin of your interest, add it to your `Gemfile`:
 
 ```ruby
 group :development do
-  gem '<guard-name>'
+  gem '<guard-plugin-name>'
 end
 ```
 
-See the init section of the Guard usage below to see how to install the supplied Guard template that you can install and
+See the init section of the Guard usage below to see how to install the supplied plugin template that you can install and
 to suit your needs.
 
 Usage
@@ -208,14 +211,14 @@ $ guard help start
 
 ### Init
 
-You can generate a Guardfile and have all installed guards be automatically added into
+You can generate a Guardfile and have all installed plugins be automatically added into
 it by running the `init` task without any option:
 
 ```bash
 $ guard init
 ```
 
-You can also specify the name of an installed Guard to only get that Guard
+You can also specify the name of an installed plugin to only get that plugin template
 in the generated Guardfile:
 
 ```bash
@@ -230,8 +233,7 @@ $ guard init <template-name>
 ```
 
 **Note**: If you already have a `Guardfile` in the current directory, the `init` task can be used
-to append a supplied Guard template from an installed Guard to your existing
-`Guardfile`.
+to append a supplied template from an installed plugin to your existing `Guardfile`.
 
 #### `-b`/`--bare` option
 
@@ -276,7 +278,7 @@ Notifications can also be disabled globally by setting a `GUARD_NOTIFY` environm
 
 #### `-g`/`--group` option
 
-Only certain Guard groups can be run:
+Only certain plugin groups can be run:
 
 ```bash
 $ guard --group group_name another_group_name
@@ -297,7 +299,7 @@ $ guard -d # shortcut
 
 #### `-w`/`--watchdir` option
 
-Guard can watch in any directory instead of the current directory:
+Guard can watch any directory instead of the current directory:
 
 ```bash
 $ guard --watchdir ~/your/fancy/project
@@ -351,7 +353,7 @@ $ guard start --force-polling
 
 ### List
 
-You can list the available Guards with the `list` task:
+You can list the available plugins with the `list` task:
 
 ```bash
 $ guard list
@@ -371,7 +373,7 @@ See also https://github.com/guard/guard/wiki/List-of-available-Guards
 
 ### Show
 
-You can show the structure of the groups and their Guards with the `show` task:
+You can show the structure of the groups and their plugins with the `show` task:
 
 ```bash
 $ guard show
@@ -394,41 +396,41 @@ Interactions
 
 You can interact with Guard and enter commands when Guard has nothing to do. Guard understands the following commands:
 
-* `↩`:                 Run all Guards.
+* `↩`:                 Run all plugins.
 * `h`, `help`:         Show a help of the available interactor commands.
-* `r`, `reload`:       Reload all Guards.
+* `r`, `reload`:       Reload all plugins.
 * `c`, `change`:       Show a help of the available interactor commands.
-* `s`, `show`:         Show Guard plugin configuration.
+* `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.
                        This is useful when switching Git branches, rebase Git or change whitespace.
-* `e`, `exit`:         Stop all Guards and quit Guard.
+* `e`, `exit`:         Stop all plugins and quit Guard.
 
-Instead of running all Guards with the `↩` key, you can also run a single Guard by entering its name:
+Instead of running all plugins with the `↩` key, you can also run a single plugin by entering its name:
 
 ```bash
 > rspec
 ```
 
-It's also possible to run all Guards within a group by entering the group name:
+It's also possible to run all plugins within a group by entering the group name:
 
 ```bash
 > frontend
 ```
 
-The same applies to Guard reloading. You can reload a Guard with the following command:
+The same applies to reloading. You can reload a plugin with the following command:
 
 ```bash
 > ronn reload
 ```
 
-This will reload only the Ronn Guard. You can also reload all Guards within a group:
+This will reload only the Ronn plugin. You can also reload all plugins within a group:
 
 ```bash
 > backend reload
 ```
 
-The action and plugin or group name can have any order, so you can also write:
+The action and plugin/group name can have any order, so you can also write:
 
 ```bash
 > reload backend
@@ -493,14 +495,14 @@ Guard itself provides the following DSL methods that can be used for configurati
 
 ### guard
 
-The `guard` method allows you to add a Guard to your toolchain and configure it by passing the
-options after the name of the Guard:
+The `guard` method allows you to add a Guard plugin to your toolchain and configure it by passing the
+options after the name of the plugin:
 
 ```ruby
 guard :coffeescript, :input => 'coffeescripts', :output => 'javascripts'
 ```
 
-You can define the same Guard more than once:
+You can define the same plugin more than once:
 
 ```ruby
 guard :coffeescript, :input => 'coffeescripts', :output => 'javascripts'
@@ -526,13 +528,13 @@ guard :jessie do
 end
 ```
 
-This instructs the jessie Guard to watch for file changes in the `spec` folder,
+This instructs the jessie plugin to watch for file changes in the `spec` folder,
 but only for file names that ends with `_spec` or `Spec` and have a file type of `js` or `coffee`.
 
 You can easily test your watcher regular expressions with [Rubular](http://rubular.com/).
 
 When you add a block to the watch expression, you can modify the file name that has been
-detected before sending it to the Guard for processing:
+detected before sending it to the plugin for processing:
 
 ```ruby
 guard :rspec do
@@ -554,7 +556,7 @@ end
 
 ### group
 
-The `group` method allows you to group several Guards together. This comes in handy especially when you
+The `group` method allows you to group several plugins together. This comes in handy especially when you
 have a huge `Guardfile` and want to focus your development on a certain part.
 
 ```ruby
@@ -577,7 +579,7 @@ Groups to be run can be specified with the Guard DSL option `--group` (or `-g`):
 $ guard -g specs
 ```
 
-Guards that don't belong to a group are considered global and are always run.
+Guard plugins that don't belong to a group are considered global and are always run.
 
 ### notification
 
@@ -634,7 +636,8 @@ interactor :off
 ### callback
 
 The `callback` method allows you to execute arbitrary code before or after any of the `start`, `stop`, `reload`,
-`run_all` and `run_on_change` Guards' method. You can even insert more hooks inside these methods.
+`run_all`, `run_on_changes`, `run_on_additions`, `run_on_modifications` and `run_on_removals` Guard plugins method.
+You can even insert more hooks inside these methods.
 
 ```ruby
 guard :rspec do
@@ -725,7 +728,7 @@ You can report bugs and feature requests to [GitHub Issues](https://github.com/g
 **Please don't ask question in the issue tracker**, instead ask them in our
 [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
 
-Try to figure out where the issue belongs to: Is it an issue with Guard itself or with a Guard implementation you're
+Try to figure out where the issue belongs to: Is it an issue with Guard itself or with a Guard plugin you're
 using?
 
 When you file a bug, please try to follow these simple rules if applicable:

data/lib/guard.rb

@@ -2,7 +2,7 @@ require 'thread'
 require 'listen'
 
 # Guard is the main module for all Guard related modules and classes.
-# Also other Guard implementation should use this namespace.
+# Also Guard plugins should use this namespace.
 #
 module Guard
 
@@ -45,6 +45,7 @@ module Guard
       @options    = options
       @watchdir   = (options[:watchdir] && File.expand_path(options[:watchdir])) || Dir.pwd
       @runner     = Runner.new
+      @allow_stop = Listen::Turnstile.new
 
       UI.clear
       deprecated_options_warning
@@ -59,7 +60,7 @@ module Guard
       Dsl.evaluate_guardfile(options)
       UI.error 'No guards found in Guardfile, please add at least one.' if @guards.empty?
 
-      runner.deprecation_warning # Guard deprecation go here
+      runner.deprecation_warning if @options[:show_deprecations]
 
       setup_notifier
       setup_interactor
@@ -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.within_preserved_state do
           runner.run_on_changes(modified, added, removed)
         end
@@ -132,14 +133,14 @@ module Guard
       end
     end
 
-    # Start Guard by evaluate the `Guardfile`, initialize the declared Guards
+    # Start Guard by evaluate the `Guardfile`, initialize the declared Guard plugins
     # and start the available file change listener.
-    # Main method for Guard that is called from the CLI when guard starts.
+    # Main method for Guard that is called from the CLI when Guard starts.
     #
     # - Setup Guard internals
     # - Evaluate the `Guardfile`
     # - Configure Notifiers
-    # - Initialize the declared Guards
+    # - Initialize the declared Guard plugins
     # - Start the available file change listener
     #
     # @option options [Boolean] clear if auto clear the UI should be done
@@ -156,23 +157,26 @@ module Guard
       within_preserved_state do
         runner.run(:start)
       end
-      
-      listener.start
+
+      listener.start(false)
+
+      @allow_stop.wait if @allow_stop
     end
 
     # Stop Guard listening to file changes
     #
     def stop
+      listener.stop
       interactor.stop if interactor
       runner.run(:stop)
       UI.info 'Bye bye...', :reset => true
-      #TODO: Move to top when https://github.com/guard/listen/issues/46 is resolved
-      listener.stop
+
+      @allow_stop.signal if @allow_stop
     end
 
-    # Reload Guardfile and all Guards currently enabled.
+    # Reload Guardfile and all Guard plugins currently enabled.
     #
-    # @param [Hash] scopes an hash with a guard or a group scope
+    # @param [Hash] scopes an hash with a Guard plugin or a group scope
     #
     def reload(scopes)
       within_preserved_state do
@@ -183,9 +187,9 @@ module Guard
       end
     end
 
-    # Trigger `run_all` on all Guards currently enabled.
+    # Trigger `run_all` on all Guard plugins currently enabled.
     #
-    # @param [Hash] scopes an hash with a guard or a group scope
+    # @param [Hash] scopes an hash with a Guard plugin or a group scope
     #
     def run_all(scopes)
       within_preserved_state do
@@ -207,22 +211,22 @@ module Guard
       end
     end
 
-    # Smart accessor for retrieving a specific guard or several guards at once.
+    # Smart accessor for retrieving a specific Guard plugin or several Guard plugins at once.
     #
     # @see Guard.groups
     #
-    # @example Filter Guards by String or Symbol
+    # @example Filter Guard plugins by String or Symbol
     #   Guard.guards('rspec')
     #   Guard.guards(:rspec)
     #
-    # @example Filter Guards by Regexp
+    # @example Filter Guard plugins by Regexp
     #   Guard.guards(/rsp.+/)
     #
-    # @example Filter Guards by Hash
+    # @example Filter Guard plugins by Hash
     #   Guard.guards({ :name => 'rspec', :group => 'backend' })
     #
-    # @param [String, Symbol, Regexp, Hash] filter the filter to apply to the Guards
-    # @return [Array<Guard>] the filtered Guards
+    # @param [String, Symbol, Regexp, Hash] filter the filter to apply to the Guard plugins
+    # @return [Array<Guard>] the filtered Guard plugins
     #
     def guards(filter = nil)
       @guards ||= []
@@ -245,7 +249,7 @@ module Guard
       end
     end
 
-    # Smart accessor for retrieving a specific group or several groups at once.
+    # Smart accessor for retrieving a specific plugin group or several plugin groups at once.
     #
     # @see Guard.guards
     #
@@ -270,13 +274,13 @@ module Guard
       end
     end
 
-    # Add a Guard to use.
+    # Add a Guard plugin to use.
     #
     # @param [String] name the Guard name
     # @param [Array<Watcher>] watchers the list of declared watchers
     # @param [Array<Hash>] callbacks the list of callbacks
-    # @param [Hash] options the Guard options (see the given Guard documentation)
-    # @return [Guard::Guard] the guard added
+    # @param [Hash] options the plugin options (see the given Guard documentation)
+    # @return [Guard::Guard] the added Guard plugin
     #
     def add_guard(name, watchers = [], callbacks = [], options = {})
       if name.to_sym == :ego
@@ -290,11 +294,11 @@ module Guard
       end
     end
 
-    # Add a Guard group.
+    # Add a Guard plugin group.
     #
     # @param [String] name the group name
     # @option options [Boolean] halt_on_fail if a task execution
-    #   should be halted for all Guards in this group if one Guard throws `:task_has_failed`
+    #   should be halted for all Guard plugins in this group if one Guard throws `:task_has_failed`
     # @return [Guard::Group] the group added (or retrieved from the `@groups` variable if already present)
     #
     def add_group(name, options = {})
@@ -325,7 +329,7 @@ module Guard
       @result
     end
 
-    # Tries to load the Guard main class. This transforms the supplied Guard
+    # Tries to load the Guard plugin main class. This transforms the supplied Guard plugin
     # name into a class name:
     #
     # * `guardname` will become `Guard::Guardname`
@@ -363,9 +367,9 @@ module Guard
       end
     end
 
-    # Locate a path to a Guard gem.
+    # Locate a path to a Guard plugin gem.
     #
-    # @param [String] name the name of the Guard without the prefix `guard-`
+    # @param [String] name the name of the Guard plugin without the prefix `guard-`
     # @return [String] the full path to the Guard gem
     #
     def locate_guard(name)
@@ -378,9 +382,9 @@ module Guard
       UI.error "Could not find 'guard-#{ name }' gem path."
     end
 
-    # Returns a list of guard Gem names installed locally.
+    # Returns a list of Guard plugin Gem names installed locally.
     #
-    # @return [Array<String>] a list of guard gem names
+    # @return [Array<String>] a list of Guard plugin gem names
     #
     def guard_gem_names
       if Gem::Version.create(Gem::VERSION) >= Gem::Version.create('1.8.0')

data/lib/guard/cli.rb

@@ -73,6 +73,11 @@ module Guard
                   :aliases => '-B',
                   :banner => 'Turn off warning when Bundler is not present'
 
+    method_option :show_deprecations,
+                  :type => :boolean,
+                  :default => false,
+                  :banner => 'Turn on deprecation warnings'
+
     # Listen options
     method_option :latency,
                   :type    => :numeric,
@@ -85,7 +90,7 @@ module Guard
                   :aliases => '-p',
                   :banner  => 'Force usage of the Listen polling listener'
 
-    # Start Guard by initialize the defined Guards and watch the file system.
+    # Start Guard by initialize 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
@@ -100,7 +105,7 @@ module Guard
 
     desc 'list', 'Lists guards that can be used with init'
 
-    # List the Guards that are available for use in your system and marks
+    # List the Guard plugins that are available for use in your system and marks
     # those that are currently used in your `Guardfile`.
     #
     # @see Guard::DslDescriber.list
@@ -130,14 +135,14 @@ module Guard
                   :aliases => '-b',
                   :banner => 'Generate a bare Guardfile without adding any installed guard into it'
 
-    # Initializes the templates of all installed Guards and adds them
-    # to the `Guardfile` when no Guard name is passed. When passed
-    # a guard name is does the same but only for that Guard.
+    # Initializes the templates of all installed Guard pluginss 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.
     #
     # @see Guard::Guard.initialize_template
     # @see Guard::Guard.initialize_all_templates
     #
-    # @param [String] guard_name the name of the Guard to initialize
+    # @param [String] guard_name the name of the Guard plugin to initialize
     #
     def init(guard_name = nil)
       verify_bundler_presence
@@ -153,10 +158,10 @@ module Guard
       end
     end
 
-    desc 'show', 'Show all defined Guards and their options'
+    desc 'show', 'Show all defined Guard plugins and their options'
     map %w(-T) => :show
 
-    # Shows all Guards and their options that are defined in
+    # Shows all Guard plugins and their options that are defined in
     # the `Guardfile`
     #
     # @see Guard::DslDescriber.show

data/lib/guard/dsl.rb

@@ -4,9 +4,9 @@ module Guard
   # the behaviour of Guard.
   #
   # The main keywords of the DSL are `guard` and `watch`. These are necessary to define
-  # the used Guards and the file changes they are watching.
+  # the used Guard plugins and the file changes they are watching.
   #
-  # You can optionally group the Guards with the `group` keyword and ignore and filter certain paths
+  # You can optionally group the Guard plugins with the `group` keyword and ignore and filter certain paths
   # with the `ignore` and `filter` keywords.
   #
   # You can set your preferred system notification library with `notification` and pass
@@ -15,8 +15,9 @@ module Guard
   # specify `:off` as library). @see ::Guard::Notifier for more information about the supported libraries.
   #
   # A more advanced DSL use is the `callback` keyword that allows you to execute arbitrary
-  # code before or after any of the `start`, `stop`, `reload`, `run_all` and `run_on_change`
-  # Guards' method. You can even insert more hooks inside these methods.
+  # code before or after any of the `start`, `stop`, `reload`, `run_all`, `run_on_changes`,
+  # `run_on_additions`, `run_on_modifications` and `run_on_removals` Guard plugins method. 
+  # You can even insert more hooks inside these methods.
   # Please [checkout the Wiki page](https://github.com/guard/guard/wiki/Hooks-and-callbacks) for more details.
   #
   # The DSL will also evaluate normal Ruby code.
@@ -119,7 +120,7 @@ module Guard
         after_reevaluate_guardfile
       end
 
-      # Stop Guards and clear internal state
+      # Stop Guard and clear internal state
       # before the Guardfile will be re-evaluated.
       #
       def before_reevaluate_guardfile
@@ -131,7 +132,7 @@ module Guard
         @@options.delete(:guardfile_contents)
       end
 
-      # Start Guards and notification and show a message
+      # Start Guard and notification and show a message
       # after the Guardfile has been re-evaluated.
       #
       def after_reevaluate_guardfile
@@ -158,7 +159,7 @@ module Guard
         UI.error "Invalid Guardfile, original error is:\n#{ $! }"
       end
 
-      # Test if the current `Guardfile` contains a specific Guard.
+      # Test if the current `Guardfile` contains a specific Guard plugin.
       #
       # @param [String] guard_name the name of the Guard
       # @return [Boolean] whether the Guard has been declared
@@ -206,7 +207,7 @@ module Guard
         end
 
         unless guardfile_contents_usable?
-          UI.error 'No Guards found in Guardfile, please add at least one.'
+          UI.error 'No Guard plugins found in Guardfile, please add at least one.'
         end
       end
 
@@ -320,9 +321,9 @@ module Guard
       ::Guard::Interactor.interactor = interactor.to_sym
     end
 
-    # Declares a group of guards to be run with `guard start --group group_name`.
+    # Declares a group of Guard plugins to be run with `guard start --group group_name`.
     #
-    # @example Declare two groups of Guards
+    # @example Declare two groups of Guard plugins
     #
     #   group 'backend' do
     #     guard 'spork'
@@ -334,7 +335,7 @@ module Guard
     #     guard 'livereload'
     #   end
     #
-    # @param [Symbol, String] name the group's name called from the CLI
+    # @param [Symbol, String] name the group name called from the CLI
     # @param [Hash] options the options accepted by the group
     # @yield a block where you can declare several guards
     #
@@ -356,7 +357,7 @@ module Guard
       end
     end
 
-    # Declare a guard to be used when running `guard start`.
+    # Declare a Guard plugin to be used when running `guard start`.
     #
     # The name parameter is usually the name of the gem without
     # the 'guard-' prefix.
@@ -411,7 +412,8 @@ module Guard
     end
 
     # Define a callback to execute arbitrary code before or after any of
-    # the `start`, `stop`, `reload`, `run_all` and `run_on_change` guards' method.
+    # the `start`, `stop`, `reload`, `run_all`, `run_on_changes` `run_on_additions`, `run_on_modifications`
+    # and `run_on_removals` plugin method.
     #
     # @param [Array] args the callback arguments
     # @yield a block with listeners

data/lib/guard/dsl_describer.rb

@@ -27,7 +27,7 @@ module Guard
         super options
       end
 
-      # List the Guards that are available for use in your system and marks
+      # List the Guard plugins that are available for use in your system and marks
       # those that are currently used in your `Guardfile`.
       #
       # @example Guard list output
@@ -63,7 +63,7 @@ module Guard
         UI.info '* denotes ones already in your Guardfile'
       end
 
-      # Shows all Guards and their options that are defined in
+      # Shows all Guard plugins and their options that are defined in
       # the `Guardfile`.
       #
       # @example guard show output

data/lib/guard/group.rb

@@ -1,6 +1,6 @@
 module Guard
 
-  # A group of Guards. There are two reasons why you want to group your guards:
+  # A group of Guard plugins. There are two reasons why you want to group your guards:
   #
   # - You can start only certain Groups from the command line by passing the `--group` option.
   # - Abort task execution chain on failure within a group.
@@ -25,7 +25,7 @@ module Guard
     # @param [String] name the name of the group
     # @param [Hash] options the group options
     # @option options [Boolean] halt_on_fail if a task execution
-    #   should be halted for all Guards in this group if one Guard throws `:task_has_failed`
+    #   should be halted for all Guard plugins in this group if a Guard plugin throws `:task_has_failed`
     #
     def initialize(name, options = {})
       @name    = name.to_sym

data/lib/guard/guard.rb

@@ -1,6 +1,6 @@
 module Guard
 
-  # Base class that every Guard implementation must inherit from.
+  # Base class that every Guard plugin implementation must inherit from.
   #
   # Guard will trigger the `start`, `stop`, `reload`, `run_all` and `run_on_changes`
   # (`run_on_additions`, `run_on_modifications` and `run_on_removals`) task methods
@@ -13,8 +13,8 @@ module Guard
   # In each of these Guard task methods you have to implement some work when you want to
   # support this kind of task. The return value of each Guard task method is not evaluated
   # by Guard, but I'll be passed to the "_end" hook for further evaluation. You can
-  # throw `:task_has_failed` to indicate that your Guard method was not successful,
-  # and successive guard tasks will be aborted when the group has set the `:halt_on_fail`
+  # throw `:task_has_failed` to indicate that your Guard plugin method was not successful,
+  # and successive Guard plugin tasks will be aborted when the group has set the `:halt_on_fail`
   # option.
   #
   # @see Guard::Hook
@@ -28,11 +28,11 @@ module Guard
   #     end
   #   end
   #
-  # Each Guard should provide a template Guardfile located within the Gem
+  # Each Guard plugin should provide a template Guardfile located within the Gem
   # at `lib/guard/guard-name/templates/Guardfile`.
   #
-  # By default all watchers for a Guard are returning strings of paths to the
-  # Guard, but if your Guard want to allow any return value from a watcher,
+  # By default all watchers for a Guard plugin have to return strings of paths to the
+  # Guard, but if your Guard plugin wants to allow any return value from a watcher,
   # you can set the `any_return` option to true.
   #
   # If one of those methods raise an exception other than `:task_has_failed`,
@@ -43,11 +43,11 @@ module Guard
 
     attr_accessor :watchers, :options, :group
 
-    # Initializes a Guard.
+    # Initializes a Guard plugin.
     #
-    # @param [Array<Guard::Watcher>] watchers the Guard file watchers
-    # @param [Hash] options the custom Guard options
-    # @option options [Symbol] group the group this Guard belongs to
+    # @param [Array<Guard::Watcher>] watchers the Guard plugin file watchers
+    # @param [Hash] options the custom Guard plugin options
+    # @option options [Symbol] group the group this Guard plugin belongs to
     # @option options [Boolean] any_return allow any object to be returned from a watcher
     #
     def initialize(watchers = [], options = {})
@@ -55,10 +55,10 @@ module Guard
       @watchers, @options = watchers, options
     end
 
-    # Initialize the Guard. This will copy the Guardfile template inside the Guard gem.
+    # Initialize the Guard plugin. This will copy the Guardfile template inside the Guard plugin gem.
     # The template Guardfile must be located within the Gem at `lib/guard/guard-name/templates/Guardfile`.
     #
-    # @param [String] name the name of the Guard
+    # @param [String] name the name of the Guard plugin
     #
     def self.init(name)
       if ::Guard::Dsl.guardfile_include?(name)
@@ -86,16 +86,16 @@ module Guard
     # @raise [:task_has_failed] when start has failed
     # @return [Object] the task result
     #
-    # def start
-    # end
+    def start
+    end
 
     # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
     #
     # @raise [:task_has_failed] when stop has failed
     # @return [Object] the task result
     #
-    # def stop
-    # end
+    def stop
+    end
 
     # Called when `reload|r|z + enter` is pressed.
     # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
@@ -103,8 +103,8 @@ module Guard
     # @raise [:task_has_failed] when reload has failed
     # @return [Object] the task result
     #
-    # def reload
-    # end
+    def reload
+    end
 
     # Called when just `enter` is pressed
     # This method should be principally used for long action like running all specs/tests/...
@@ -112,44 +112,44 @@ module Guard
     # @raise [:task_has_failed] when run_all has failed
     # @return [Object] the task result
     #
-    # def run_all
-    # end
+    def run_all
+    end
 
-    # Default behaviour on file(s) changes that the Guard watches.
+    # Default behaviour on file(s) changes that the Guard plugin watches.
     #
     # @param [Array<String>] paths the changes files or paths
-    # @raise [:task_has_failed] when run_on_change has failed
+    # @raise [:task_has_failed] when run_on_changes has failed
     # @return [Object] the task result
     #
-    # def run_on_changes(paths)
-    # end
+    def run_on_changes(paths)
+    end
 
-    # Called on file(s) additions that the Guard watches.
+    # Called on file(s) additions that the Guard plugin watches.
     #
     # @param [Array<String>] paths the changes files or paths
-    # @raise [:task_has_failed] when run_on_change has failed
+    # @raise [:task_has_failed] when run_on_additions has failed
     # @return [Object] the task result
     #
-    # def run_on_additions(paths)
-    # end
+    def run_on_additions(paths)
+    end
 
-    # Called on file(s) modifications that the Guard watches.
+    # Called on file(s) modifications that the Guard plugin watches.
     #
     # @param [Array<String>] paths the changes files or paths
-    # @raise [:task_has_failed] when run_on_change has failed
+    # @raise [:task_has_failed] when run_on_modifications has failed
     # @return [Object] the task result
     #
-    # def run_on_modifications(paths)
-    # end
+    def run_on_modifications(paths)
+    end
 
-    # Called on file(s) removals that the Guard watches.
+    # Called on file(s) removals that the Guard plugin watches.
     #
     # @param [Array<String>] paths the changes files or paths
-    # @raise [:task_has_failed] when run_on_change has failed
+    # @raise [:task_has_failed] when run_on_removals has failed
     # @return [Object] the task result
     #
-    # def run_on_removals(paths)
-    # end
+    def run_on_removals(paths)
+    end
 
   end
 

data/lib/guard/hook.rb

@@ -1,7 +1,7 @@
 module Guard
 
-  # Guard has a hook mechanism that allows you to insert callbacks for individual Guards.
-  # By default, each of the Guard instance methods has a "_begin" and an "_end" hook.
+  # Guard has a hook mechanism that allows you to insert callbacks for individual Guard plugins.
+  # By default, each of the Guard plugin instance methods has a "_begin" and an "_end" hook.
   # For example, the Guard::Guard#start method has a :start_begin hook that is runs immediately
   # before Guard::Guard#start, and a :start_end hook that runs immediately after Guard::Guard#start.
   #

data/lib/guard/interactor.rb

@@ -185,17 +185,17 @@ module Guard
       puts '[n]otification   Toggle notifications'
       puts '[s]how           Show available Guard plugins'
       puts '[c]hange <file>  Trigger a file change'
-      puts '<enter>          Run all Guards'
+      puts '<enter>          Run all Guard plugins'
       puts ''
       puts 'You can scope the reload action to a specific guard or group:'
       puts ''
       puts 'rspec reload     Reload the RSpec Guard'
       puts 'backend reload   Reload the backend group'
       puts ''
-      puts 'You can also run only a specific Guard or all Guards in a specific group:'
+      puts 'You can also run only a specific Guard or all Guard plugins in a specific group:'
       puts ''
       puts 'jasmine          Run the jasmine Guard'
-      puts 'frontend         Run all Guards in the frontend group'
+      puts 'frontend         Run all Guard plugins in the frontend group'
       puts ''
     end
 

data/lib/guard/runner.rb

@@ -38,7 +38,7 @@ module Guard
     # Runs a Guard-task on all registered guards.
     #
     # @param [Symbol] task the task to run
-    # @param [Hash] scope either the guard or the group to run the task on
+    # @param [Hash] scope either the Guard plugin or the group to run the task on
     #
     # @see self.run_supervised_task
     #
@@ -73,7 +73,7 @@ module Guard
       end
     end
 
-    # Run a Guard task, but remove the Guard when his work leads to a system failure.
+    # Run a Guard plugin task, but remove the Guard plugin when his work leads to a system failure.
     #
     # When the Group has `:halt_on_fail` disabled, we've to catch `:task_has_failed`
     # here in order to avoid an uncaught throw error.
@@ -112,8 +112,7 @@ module Guard
     #   group level.
     # @see .scoped_guards
     #
-    # @param [Guard::Guard] guard the Guard to execute
-    #
+    # @param [Guard::Guard] guard the Guard plugin to execute
     # @return [Symbol] the symbol to catch
     #
     def self.stopping_symbol_for(guard)
@@ -128,7 +127,7 @@ module Guard
     # Tries to run the first implemented task by a given guard
     # from a collection of tasks.
     #
-    # @param [Guard::Guard] guard the guard to run the found task on
+    # @param [Guard::Guard] guard the Guard plugin to run the first found task on
     # @param [Array<Symbol>] tasks the tasks to run the first among
     # @param [Object] task_param the param to pass to each task
     #
@@ -143,12 +142,12 @@ module Guard
       end
     end
 
-    # Loop through all groups and run the given task for each Guard.
+    # Loop through all groups and run the given task for each Guard plugin.
     #
-    # Stop the task run for the all Guards within a group if one Guard
+    # Stop the task run for the all Guard plugins within a group if one Guard
     # throws `:task_has_failed`.
     #
-    # @param [Hash] scope an hash with a guard or a group scope
+    # @param [Hash] scope an hash with a Guard plugin or a group scope
     # @yield the task to run
     #
     def scoped_guards(scopes = {})
@@ -169,7 +168,7 @@ module Guard
     # Logic to know if the UI can be cleared or not in the run_on_changes method
     # based on the guard and the changes.
     #
-    # @param [Guard::Guard] guard the guard where run_on_changes is called
+    # @param [Guard::Guard] guard the Guard plugin where run_on_changes is called
     # @param [Array<String>] modified_paths the modified paths.
     # @param [Array<String>] added_paths the added paths.
     # @param [Array<String>] removed_paths the removed paths.

data/lib/guard/ui.rb

@@ -4,7 +4,7 @@ module Guard
   # through this class is considered either as an error message or a diagnostic
   # message and is written to standard error (STDERR).
   #
-  # If your Guard does some output that is piped into another process for further
+  # If your Guard plugin does some output that is piped into another process for further
   # processing, please just write it to STDOUT with `puts`.
   #
   module UI

data/lib/guard/version.rb

@@ -1,4 +1,4 @@
 module Guard
   # The current gem version of Guard
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

data/lib/guard/version.rbc

@@ -66,57 +66,21 @@ x
 5
 Guard
 i
-48
+12
 5
 66
-26
-93
-0
-15
-29
-21
-0
-45
-0
-1
+65
 7
-2
-3
-98
-3
-3
-30
-8
-27
-25
-92
 0
-27
-8
-32
-15
 7
-4
-8
-33
 1
-9
-38
-1
-8
-47
-65
-7
-2
-7
-5
 64
 49
-6
+2
 2
 11
 I
-4
+3
 I
 0
 I
@@ -125,42 +89,24 @@ I
 0
 n
 p
-7
-x
-5
-Guard
-n
+3
 x
 7
 VERSION
-x
-22
-vm_const_defined_under
-s
-8
-constant
 s
 5
-1.0.0
+1.2.1
 x
 9
 const_set
 p
-7
-I
-2
+3
 I
 2
 I
-26
-I
-4
-I
-2f
-I
-0
+3
 I
-30
+c
 x
 52
 /Users/michi/Repositories/guard/lib/guard/version.rb

data/lib/guard/watcher.rb

@@ -10,8 +10,8 @@ module Guard
 
     # Initialize a file watcher.
     #
-    # @param [String, Regexp] pattern the pattern to be watched by the guard
-    # @param [Block] action the action to execute before passing the result to the Guard
+    # @param [String, Regexp] pattern the pattern to be watched by the Guard plugin
+    # @param [Block] action the action to execute before passing the result to the Guard plugin
     #
     def initialize(pattern, action = nil)
       @pattern, @action = pattern, action
@@ -36,7 +36,7 @@ module Guard
 
     # Finds the files that matches a Guard.
     #
-    # @param [Guard::Guard] guard the guard which watchers are used
+    # @param [Guard::Guard] guard the Guard plugin which watchers are used
     # @param [Array<String>] files the changed files
     # @return [Array<Object>] the matched watcher response
     #
@@ -62,9 +62,9 @@ module Guard
       end
     end
 
-    # Test if a file would be matched by any of the Guards watchers.
+    # Test if a file would be matched by any of the Guard plugin watchers.
     #
-    # @param [Array<Guard::Guard>] guards the guards to use the watchers from
+    # @param [Array<Guard::Guard>] guards the Guard plugins to use the watchers from
     # @param [Array<String>] files the files to test
     # @return [Boolean] Whether a file matches
     #

data/man/guard.1

@@ -1,13 +1,13 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GUARD" "1" "December 2011" "" ""
+.TH "GUARD" "1" "July 2012" "" ""
 .
 .SH "NAME"
 \fBguard\fR \- Guard keeps an eye on your file modifications\.
 .
 .SH "DESCRIPTION"
-Guard is a command line tool that easily handle events on files modifications\.
+Guard is a command line tool to easily handle events on file system modifications\.
 .
 .SH "SYNOPSIS"
 \fBguard <COMMAND> <OPTIONS>\fR
@@ -39,22 +39,31 @@ The following options are available:
 \fB\-G\fR, \fB\-\-guardfile\fR \fIFILE\fR Tells Guard to use FILE as its Guardfile instead of \fB\./Guardfile\fR or \fB~/\.Guardfile\fR\.
 .
 .P
-\fB\-A\fR, \fB\-\-watch\-all\-modifications\fR Watch all file modifications like moves or deletions with\.
+\fB\-i\fR, \fB\-\-no\-interactions\fR Turn off completely any Guard terminal interactions\.
 .
 .P
-\fB\-i\fR, \fB\-\-no\-interactions\fR Turn off completely any Guard terminal interactions\.
+\fB\-B\fR, \fB\-\-no\-bundler\-warning\fR Turn off warning when Bundler is not present\.
+.
+.P
+\fB\-\-show\-deprecations\fR Turn on deprecation warnings\.
+.
+.P
+\fB\-l\fR, \fB\-\-latency\fR Overwrite Listen\'s default latency\.
+.
+.P
+\fB\-p\fR, \fB\-\-force\-polling\fR Force usage of the Listen polling listener\.
 .
 .SS "init [GUARD]"
 If no Guardfile is present in the current directory, creates an empty Guardfile\.
 .
 .P
-If \fIGUARD\fR is present, add its default Guardfile configuration to the current Guardfile\. Note that \fIGUARD\fR is the guard\'s name without the \fBguard\-\fR prefix\. For instance to initialize guard\-rspec, run \fBguard init rspec\fR\.
+If \fIGUARD\fR is present, add its default Guardfile configuration to the current Guardfile\. Note that \fIGUARD\fR is the Guard plugin name without the \fBguard\-\fR prefix\. For instance to initialize guard\-rspec, run \fBguard init rspec\fR\.
 .
 .SS "list"
-Lists guards that can be used with the \fBinit\fR command\.
+Lists Guard plugins that can be used with the \fBinit\fR command\.
 .
 .SS "\-T, show"
-List defined groups and guards for the current Guardfile\.
+List defined groups and Guard plugins for the current Guardfile\.
 .
 .SS "\-h, help [COMMAND]"
 List all of Guard\'s available commands\.
@@ -63,7 +72,7 @@ List all of Guard\'s available commands\.
 If \fICOMMAND\fR is given, displays a specific help for \fITASK\fR\.
 .
 .SH "EXAMPLES"
-Initialize Guard and a specific guard at the same time:
+Initialize Guard and a specific Guard plugin at the same time:
 .
 .P
 \fB[bundle exec] guard init [rspec]\fR

data/man/guard.1.html

@@ -75,7 +75,7 @@
 
 <h2 id="DESCRIPTION">DESCRIPTION</h2>
 
-<p>Guard is a command line tool that easily handle events on files modifications.</p>
+<p>Guard is a command line tool to easily handle events on file system modifications.</p>
 
 <h2 id="SYNOPSIS">SYNOPSIS</h2>
 
@@ -111,27 +111,36 @@
 <p><code>-G</code>, <code>--guardfile</code> <var>FILE</var>
   Tells Guard to use FILE as its Guardfile instead of <code>./Guardfile</code> or <code>~/.Guardfile</code>.</p>
 
-<p><code>-A</code>, <code>--watch-all-modifications</code>
-  Watch all file modifications like moves or deletions with.</p>
-
 <p><code>-i</code>, <code>--no-interactions</code>
   Turn off completely any Guard terminal interactions.</p>
 
+<p><code>-B</code>, <code>--no-bundler-warning</code>
+  Turn off warning when Bundler is not present.</p>
+
+<p><code>--show-deprecations</code>
+  Turn on deprecation warnings.</p>
+
+<p><code>-l</code>, <code>--latency</code>
+  Overwrite Listen's default latency.</p>
+
+<p><code>-p</code>, <code>--force-polling</code>
+  Force usage of the Listen polling listener.</p>
+
 <h3 id="init-GUARD-">init [GUARD]</h3>
 
 <p>If no Guardfile is present in the current directory, creates an empty Guardfile.</p>
 
 <p>If <var>GUARD</var> is present, add its default Guardfile configuration to the current Guardfile.
-Note that <var>GUARD</var> is the guard's name without the <code>guard-</code> prefix.
+Note that <var>GUARD</var> is the Guard plugin name without the <code>guard-</code> prefix.
 For instance to initialize guard-rspec, run <code>guard init rspec</code>.</p>
 
 <h3 id="list">list</h3>
 
-<p>Lists guards that can be used with the <code>init</code> command.</p>
+<p>Lists Guard plugins that can be used with the <code>init</code> command.</p>
 
 <h3 id="-T-show">-T, show</h3>
 
-<p>List defined groups and guards for the current Guardfile.</p>
+<p>List defined groups and Guard plugins for the current Guardfile.</p>
 
 <h3 id="-h-help-COMMAND-">-h, help [COMMAND]</h3>
 
@@ -141,7 +150,7 @@ For instance to initialize guard-rspec, run <code>guard init rspec</code>.</p>
 
 <h2 id="EXAMPLES">EXAMPLES</h2>
 
-<p>Initialize Guard and a specific guard at the same time:</p>
+<p>Initialize Guard and a specific Guard plugin at the same time:</p>
 
 <p><code>[bundle exec] guard init [rspec]</code></p>
 
@@ -172,7 +181,7 @@ https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>December 2011</li>
+    <li class='tc'>July 2012</li>
     <li class='tr'>guard(1)</li>
   </ol>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000 Z
+date: 2012-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -91,54 +91,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Guard is a command line tool to easily handle events on file system modifications.
 email:
 - thibaud@thibaud.me
@@ -197,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4057517212735074310
+      hash: -3637143437801209002
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: