guard 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51523e4c27bf70920db3eb0b9311f75c64f3663d
-  data.tar.gz: f66ae96be8a6924b54b2019c58ee94ec7ae314f6
+  metadata.gz: 0de85bc26fc21a2ad3a06dc13ca89561c4c2d428
+  data.tar.gz: 38374af487597e7332a568ae647640b4cfd47a1a
 SHA512:
-  metadata.gz: e07ed5af1b2625f0afdeb65d3d583843155227b9a7f69297c2b1dc8094c81cc9826b5599b65ea748ddc27b1c33cf35a6bf5f808f83a720e05d7d1c46eb17e5c9
-  data.tar.gz: 0b48ae4d660f7d2091ce3e85a5433ec0ad1158ca090832aa6fb1004884620204033d30c82a1deccd65adb9e2b208f55f9dfa4e4b5a11a0a03c0d559799d64bee
+  metadata.gz: 7275e29868fee3b25c54bdab3693376bc093278bf0424cc7cd3ff2bdeb7be004a82be2a7fd4394d0b1eca76c0ce7ad2effc42b1f29544cb7d4c6ff8393a06693
+  data.tar.gz: 0b8d5b8e1be413c4052de5619e874d20085f3a929660b76ed542d2c98c81a3b4bd34cf957a1bd88cbf3e207942e1ddd23cc09b06e834ce3f6fc291dbc16f39da

data/CHANGELOG.md

@@ -1,10 +1,31 @@
+## 1.8.0 - 20 April, 2013
+
+### Improvements
+
+- [#416][] Support .guardrc file on the folder from which Guard is executed as well. ([@Nerian][])
+- Display an info message when a plugin throws `:task_has_failed`. ([@rymai][])
+- Ensure compatibility with new Listen's API. ([@rymai][])
+
+### Bug fixes
+
+- [#413][], [#414][] NoMethodError exceptions raised by plugins are no longer silently discarded. ([@aspiers][])
+- [#414][] Test suite now runs cleanly within a `tmux` session. ([@aspiers][])
+- Specs and Travis builds no longer require `guard-rspec`. ([@aspiers][], [@rymai][])
+- [#414][] Various minor issues with the test suite were fixed. ([@aspiers][])
+- [#409][], [#410][] Fix some typos and broken URLs. ([@aspiers][], [@rymai][])
+
+### Process changes
+
+- Guard has an open commit bit policy: Anyone with an accepted pull
+  request gets added as a repository collaborator. ([@netzpirat][])
+
 ## 1.7.0 - 28 March, 2013
 
 ### Improvements
 
-- [#400][] Drop dependency on `terminal-table` and use `formatador` instead. ([@netzpirat][])
+- [#407][], [#408][] Add file notifier to write notifications to a configured file. ([@amiel][])
 - Change the current work dir to the `watchdir`. ([@netzpirat][])
-- Add file notifier to write notifications to a configured file. ([@amiel][])
+- [#400][] Drop dependency on `terminal-table` and use `formatador` instead. ([@netzpirat][])
 
 ### Bug fixes
 
@@ -735,9 +756,18 @@ The Listen integration has been supervised by [@thibaudgg][] and executed by [@M
 [#401]: https://github.com/guard/guard/issues/401
 [#402]: https://github.com/guard/guard/issues/402
 [#406]: https://github.com/guard/guard/issues/406
+[#407]: https://github.com/guard/guard/issues/407
+[#408]: https://github.com/guard/guard/issues/408
+[#409]: https://github.com/guard/guard/issues/409
+[#410]: https://github.com/guard/guard/issues/410
+[#413]: https://github.com/guard/guard/issues/413
+[#414]: https://github.com/guard/guard/issues/414
+[#416]: https://github.com/guard/guard/issues/416
 [@Gazer]: https://github.com/Gazer
 [@Maher4Ever]: https://github.com/Maher4Ever
+[@Nerian]: https://github.com/Nerian
 [@alandipert]: https://github.com/alandipert
+[@amiel]: https://github.com/amiel
 [@anithri]: https://github.com/anithri
 [@ashleyconnor]: https://github.com/ashleyconnor
 [@aspiers]: https://github.com/aspiers

data/README.md

@@ -1,4 +1,4 @@
-Guard [![Gem Version](https://badge.fury.io/rb/guard.png)](http://badge.fury.io/rb/guard) [![Build Status](https://secure.travis-ci.org/guard/guard.png?branch=master)](http://travis-ci.org/guard/guard) [![Dependency Status](https://gemnasium.com/guard/guard.png)](https://gemnasium.com/guard/guard) [![Code Climate](https://codeclimate.com/github/guard/guard.png)](https://codeclimate.com/github/guard/guard) [![Coverage Status](https://coveralls.io/repos/guard/guard/badge.png?branch=master)](https://coveralls.io/r/guard/guard)
+Guard [![Gem Version](https://badge.fury.io/rb/guard.png)](http://badge.fury.io/rb/guard) [![Build Status](https://travis-ci.org/guard/guard.png?branch=master)](https://travis-ci.org/guard/guard) [![Dependency Status](https://gemnasium.com/guard/guard.png)](https://gemnasium.com/guard/guard) [![Code Climate](https://codeclimate.com/github/guard/guard.png)](https://codeclimate.com/github/guard/guard) [![Coverage Status](https://coveralls.io/repos/guard/guard/badge.png?branch=master)](https://coveralls.io/r/guard/guard)
 =====
 
 <img src="http://img515.imageshack.us/img515/1358/guardicon.png" alt="Guard Icon" align="right" />
@@ -24,14 +24,16 @@ Features
 
 * File system changes handled by our awesome [Listen](https://github.com/guard/listen) gem.
 * Support for visual system notifications.
-* Huge eco-system with [more than 150](https://rubygems.org/search?query=guard-) guard plugins.
+* Huge eco-system with [more than 190](https://rubygems.org/search?query=guard-) guard plugins.
 * Tested against Ruby 1.8.7, 1.9.2, 1.9.3, 2.0.0, REE and the latest versions of JRuby & Rubinius.
 
 Screencast
 ----------
 
-Ryan Bates made an excellent [RailsCast about Guard](http://railscasts.com/episodes/264-guard) and you should definitely
-watch it for a nice introduction to Guard.
+Two nice introduction screen casts to Guard are available that helps you get started:
+
+* [Guard is Your Best Friend](http://net.tutsplus.com/tutorials/tools-and-tips/guard-is-your-best-friend) on Net Tuts+
+* [Guard](http://railscasts.com/episodes/264-guard) on RailsCast
 
 Installation
 ------------
@@ -106,6 +108,11 @@ group :development do
 end
 ```
 
+## Interrupt handling
+
+If the Pry interactor is used, then `Ctrl-C` is delegated to Pry to exit continuation and `Ctrl-D` to exit Guard.
+Without interactor, `Ctrl-C` exits Guard and `Ctrl-D` is ignored.
+
 ## System notifications
 
 You can configure Guard to make use of the following system notification libraries:
@@ -233,7 +240,7 @@ end
 
 * Runs on any platform with Emacs + emacsclient (http://www.emacswiki.org/emacs/EmacsClient)
 
-### TMux
+#### TMux
 
 * To use TMux notifications, you have to start Guard within a [TMux](http://tmux.sourceforge.net/) session.
 
@@ -265,7 +272,7 @@ You can use nice powerline chars here if you have that configured.
 
 You can get the message history by using `Ctrl+b ~` (where `Ctrl+b` is your key to activate TMux).
 
-### File
+#### File
 
 * You can also have Guard write notifications to a file. Each notification will
   overwrite the file. This allows other commands to be run based on the status
@@ -690,6 +697,22 @@ $ guard -g specs
 
 Guard plugins that don't belong to a group are considered global and are always run.
 
+Another neat use of groups is to group dependant plugins and stop processing if one fails. In order
+to make this work, the group needs to have the `halt_on_fail` option enabled and the Guard plugin
+needs to throw `:task_has_failed` to indicate that the action was not successful.
+
+```ruby
+group :specs, :halt_on_fail => true do
+  guard :rspec do
+    watch(/.../)
+  end
+
+  guard :cucumber do
+    watch(/.../)
+  end
+end
+```
+
 ### scope
 
 The `scope` method allows you to define the default plugin or group scope for Guard, if not
@@ -942,15 +965,25 @@ Development
 Pull requests are very welcome! Please try to follow these simple rules if applicable:
 
 * Please create a topic branch for every separate change you make.
-* Make sure your patches are well tested. All specs run with `rake spec:portability` must pass.
+* Make sure your patches are well tested. All specs must pass on [Travis CI](https://travis-ci.org/guard/guard).
 * Update the [Yard](http://yardoc.org/) documentation.
 * Update the [README](https://github.com/guard/guard/blob/master/README.md).
-* Update the [CHANGELOG](https://github.com/guard/guard/blob/master/CHANGELOG.md) for noteworthy changes.
+* Update the [CHANGELOG](https://github.com/guard/guard/blob/master/CHANGELOG.md) for noteworthy changes (don't forget to run `bundle exec pimpmychangelog` and watch the magic happen)!
 * Please **do not change** the version number.
 
 For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
 `#guard` (irc.freenode.net).
 
+### Open Commit Bit
+
+Guard has an open commit bit policy: Anyone with an accepted pull request gets added as a repository collaborator.
+Please try to follow these simple rules:
+
+* Commit directly onto the master branch only for typos, improvements to the readme and documentation (please add
+  `[ci skip]` to the commit message).
+* Create a feature branch and open a pull-request early for any new features to get feedback.
+* Make sure you adhere to the general pull request rules above.
+
 ### Author
 
 [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](http://twitter.com/thibaudgg))

data/lib/guard.rb

@@ -52,33 +52,18 @@ module Guard
       @scope    = { :plugins => [], :groups => [] }
 
       Dir.chdir(@watchdir)
-
-      if options[:debug]
-        Thread.abort_on_exception = true
-        ::Guard::UI.options[:level] = :debug
-        debug_command_execution
-      end
-
       ::Guard::UI.clear(:force => true)
+      setup_debug
       deprecated_options_warning
 
       setup_groups
       setup_guards
       setup_listener
       setup_signal_traps
+      setup_from_guardfile
+      setup_scopes
 
-      ::Guard::Dsl.evaluate_guardfile(options)
-      ::Guard::UI.error 'No guards found in Guardfile, please add at least one.' if @guards.empty?
-
-      if @options[:group]
-        @scope[:groups] = @options[:group].map { |g| ::Guard.groups(g) }
-      end
-
-      if @options[:plugin]
-        @scope[:plugins] = @options[:plugin].map { |p| ::Guard.guards(p) }
-      end
-
-      runner.deprecation_warning if @options[:show_deprecations]
+      runner.deprecation_warning if options[:show_deprecations]
 
       setup_notifier
       setup_interactor
@@ -86,6 +71,14 @@ module Guard
       self
     end
 
+    def setup_debug
+      if options[:debug]
+        Thread.abort_on_exception = true
+        ::Guard::UI.options[:level] = :debug
+        debug_command_execution
+      end
+    end
+
     # Initialize the groups array with the `:default` group.
     #
     # @see Guard.groups
@@ -102,6 +95,25 @@ module Guard
       @guards = []
     end
 
+    # Initializes the listener and registers a callback for changes.
+    #
+    def setup_listener
+      listener_callback = lambda do |modified, added, removed|
+        ::Guard::Dsl.reevaluate_guardfile if ::Guard::Watcher.match_guardfile?(modified)
+
+        ::Guard.within_preserved_state do
+          runner.run_on_changes(modified, added, removed)
+        end
+      end
+
+      listener_options = { :relative_paths => true }
+      %w[latency force_polling].each do |option|
+        listener_options[option.to_sym] = options[option] if options.key?(option)
+      end
+
+      @listener = Listen.to(@watchdir, listener_options).change(&listener_callback)
+    end
+
     # Sets up traps to catch signals used to control Guard.
     #
     # Currently two signals are caught:
@@ -131,23 +143,14 @@ module Guard
       end
     end
 
-    # Initializes the listener and registers a callback for changes.
-    #
-    def setup_listener
-      listener_callback = lambda do |modified, added, removed|
-        ::Guard::Dsl.reevaluate_guardfile if ::Guard::Watcher.match_guardfile?(modified)
-
-        ::Guard.within_preserved_state do
-          runner.run_on_changes(modified, added, removed)
-        end
-      end
-
-      listener_options = { :relative_paths => true }
-      %w[latency force_polling].each do |option|
-        listener_options[option.to_sym] = options[option] if options.key?(option)
-      end
+    def setup_from_guardfile
+      ::Guard::Dsl.evaluate_guardfile(options)
+      ::Guard::UI.error 'No guards found in Guardfile, please add at least one.' if @guards.empty?
+    end
 
-      @listener = Listen.to(@watchdir, listener_options).change(&listener_callback)
+    def setup_scopes
+      scope[:groups]  = options[:group].map { |g| ::Guard.groups(g) } if options[:group]
+      scope[:plugins] = options[:plugin].map { |p| ::Guard.guards(p) } if options[:plugin]
     end
 
     # Enables or disables the notifier based on user's configurations.
@@ -188,7 +191,7 @@ module Guard
         ::Guard::UI.debug 'Guard starts all plugins'
         runner.run(:start)
         ::Guard::UI.info "Guard is now watching at '#{ @watchdir }'"
-        listener.start(false)
+        listener.start
       end
     end
 
@@ -201,7 +204,7 @@ module Guard
         ::Guard::Notifier.turn_off
         ::Guard::UI.info 'Bye bye...', :reset => true
         listener.stop
-        ::Guard.running = false
+        @running = false
       end
     end
 
@@ -397,11 +400,11 @@ module Guard
         require "guard/#{ name.downcase }" if try_require
         self.const_get(self.constants.find { |c| c.to_s == const_name } || self.constants.find { |c| c.to_s.downcase == const_name.downcase })
       rescue TypeError
-        unless try_require
+        if try_require
+          ::Guard::UI.error "Could not find class Guard::#{ const_name.capitalize }"
+        else
           try_require = true
           retry
-        else
-          ::Guard::UI.error "Could not find class Guard::#{ const_name.capitalize }"
         end
       rescue LoadError => loadError
         unless fail_gracefully

data/lib/guard/cli.rb

@@ -163,7 +163,7 @@ module Guard
       return if options[:bare]
 
       if guard_names.empty?
-        ::Guard::Guardfile::initialize_all_templates
+        ::Guard::Guardfile.initialize_all_templates
       else
         guard_names.each do |guard_name|
           ::Guard::Guardfile.initialize_template(guard_name)

data/lib/guard/dsl.rb

@@ -45,10 +45,10 @@ module Guard
       Starting with Guard v1.1 the use of the 'ignore_paths' Guardfile DSL method is deprecated.
 
       Please replace that method with the better 'ignore' or/and 'filter' methods.
-      Documentation on the README: https://github.com/guard/guard#guardfile-dsl-ignore
+      Documentation on the README: https://github.com/guard/guard#ignore
     EOS
 
-    # Deprecation message for the `ignore_paths` method
+    # Deprecation message for the `interactor` method
     INTERACTOR_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
       Starting with Guard v1.4 the use of the 'interactor' Guardfile DSL method is only used to
       disable or pass options to the Pry interactor. All other usages are deprecated.

data/lib/guard/interactor.rb

@@ -103,6 +103,7 @@ module Guard
     # Add Pry hooks:
     #
     # * Load `~/.guardrc` within each new Pry session.
+    # * Load project's `.guardrc` within each new Pry session.
     # * Restore prompt after each evaluation.
     #
     def add_hooks
@@ -112,6 +113,11 @@ module Guard
         end
       end
 
+      Pry.config.hooks.add_hook :when_started, :load_project_guard_rc do
+        project_guard_rc = Dir.pwd + '/.guardrc'
+        load project_guard_rc if File.exist?(project_guard_rc)
+      end
+
       if stty_exists?
         Pry.config.hooks.add_hook :after_eval, :restore_visibility do
           system('stty echo 2>/dev/null')

data/lib/guard/notifiers/file_notifier.rb

@@ -16,9 +16,6 @@ module Guard
 
       # Test if the file notification option is available?
       #
-      # REVIEW: This could test if there is a path provided in options, but
-      #   we don't get options in available?.
-      #
       # @param [Boolean] silent true if no error messages should be shown
       # @param [Hash] options notifier options
       # @return [Boolean] the availability status
@@ -27,7 +24,7 @@ module Guard
         options.has_key?(:path)
       end
 
-      # Write the notification to a file. By default it writes type, tytle, and
+      # Write the notification to a file. By default it writes type, title, and
       # message separated by newlines.
       #
       # @param [String] type the notification type. Either 'success', 'pending', 'failed' or 'notify'

data/lib/guard/notifiers/tmux.rb

@@ -65,7 +65,7 @@ module Guard
         color = tmux_color(type, options)
         color_location = options[:color_location] || DEFAULTS[:color_location]
 
-        system("#{ DEFAULTS[:client] } set #{ color_location } #{ color }")
+        run_client "set #{ color_location } #{ color }"
 
         show_message = options[:display_message] || DEFAULTS[:display_message]
         display_message(type, title, message, options) if show_message
@@ -98,10 +98,10 @@ module Guard
           formatted_message = message.split("\n").join(separator)
           display_message = message_format % [title, formatted_message]
 
-          system("#{ DEFAULTS[:client] } set display-time #{ display_time * 1000 }")
-          system("#{ DEFAULTS[:client] } set message-fg #{ message_color }")
-          system("#{ DEFAULTS[:client] } set message-bg #{ color }")
-          system("#{ DEFAULTS[:client] } display-message '#{ display_message }'")
+          run_client "set display-time #{ display_time * 1000 }"
+          run_client "set message-fg #{ message_color }"
+          run_client "set message-bg #{ color }"
+          run_client "display-message '#{ display_message }'"
       end
 
       # Get the Tmux color for the notification type.
@@ -138,31 +138,40 @@ module Guard
           @options_stored = true
         end
 
-        system("#{ DEFAULTS[:client] } set quiet on")
+        run_client "set quiet on"
       end
 
       # Notification stopping. Restore the previous Tmux state
       # if available (existing options are restored, new options
-      # are unset) and unquite the Tmux output.
+      # are unset) and unquiet the Tmux output.
       #
       def turn_off(options = { })
         if @options_stored
           @options_store.each do |key, value|
             if value
-              system("#{ DEFAULTS[:client] } set #{ key } #{ value }")
+              run_client "set #{ key } #{ value }"
             else
-              system("#{ DEFAULTS[:client] } set -u #{ key }")
+              run_client "set -u #{ key }"
             end
           end
 
           reset_options_store
         end
 
-        system("#{ DEFAULTS[:client] } set quiet off")
+        run_client 'set quiet off'
       end
 
       private
 
+      def system(args)
+        args += " >/dev/null 2>&1" if ENV['GUARD_ENV'] == 'test'
+        super
+      end
+
+      def run_client(args)
+        system("#{ DEFAULTS[:client] } #{args}")
+      end
+
       # Reset the internal Tmux options store defaults.
       #
       def reset_options_store

data/lib/guard/runner.rb

@@ -50,8 +50,8 @@ module Guard
     #
     def run(task, scopes = {})
       Lumberjack.unit_of_work do
-       scoped_guards(scopes) do |guard|
-          run_supervised_task(guard, task)
+        scoped_guards(scopes) do |guard|
+          run_supervised_task(guard, task) if guard.respond_to?(task)
         end
       end
     end
@@ -101,8 +101,6 @@ module Guard
           result
         end
 
-      rescue NoMethodError
-        # Do nothing
       rescue Exception => ex
         ::Guard::UI.error("#{ guard.class.name } failed to achieve its <#{ task.to_s }>, exception was:" +
                  "\n#{ ex.class }: #{ ex.message }\n#{ ex.backtrace.join("\n") }")
@@ -128,7 +126,7 @@ module Guard
       return :task_has_failed if guard.group.class != Symbol
 
       group = ::Guard.groups(guard.group)
-      group.options[:halt_on_fail] ? :no_catch : :task_has_failed
+      group.options.fetch(:halt_on_fail, false) ? :no_catch : :task_has_failed
     end
 
   private
@@ -170,11 +168,17 @@ module Guard
         end
       else
         current_groups_scope(scopes).each do |group|
-          catch :task_has_failed do
+          current_plugin = nil
+          block_return = catch :task_has_failed do
             ::Guard.guards(:group => group.name).each do |guard|
+              current_plugin = guard
               yield(guard)
             end
           end
+
+          if block_return.nil?
+            ::Guard::UI.info "#{ current_plugin.class.name } has failed, other group's plugins execution has been halted."
+          end
         end
       end
     end

data/lib/guard/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +108,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.0
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.5.0
 description: Guard is a command line tool to easily handle events on file system modifications.
 email:
 - thibaud@thibaud.me
@@ -130,6 +116,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/fsevent_watch_guard
 - bin/guard
 - images/failed.png
 - images/guard.png
@@ -197,4 +184,3 @@ signing_key:
 specification_version: 4
 summary: Guard keeps an eye on your file modifications
 test_files: []
-has_rdoc: