guard-test 0.8.0 → 1.0.0

data/CHANGELOG.md

@@ -1,115 +1,129 @@
+## git master
+
+Nothing here.
+
+## 1.0.0 - May 8, 2013
+
+### New feature
+
+- [#40][] & [#41][]: Add support for running tests via `spring`. ([@pgaertig][])
+
+### Improvements
+
+* Get rid of `autoload`. ([@rymai][])
+
 ## 0.8.0 - March 24, 2013
 
-### New feature:
+### New feature
 
 - [#38][]: Add support for running tests via `zeus`. ([@djmaze][])
 
 ## 0.7.0 - November 6, 2012
 
-### New feature:
+### New feature
 
 - [#35][]: Support `include:` option to extend the load path of the test runner. ([@amiel][])
 
 ## 0.6.0 - November 3, 2012
 
-### New feature:
+### New feature
 
 - [#34][]: Support for `*_tests.rb`. ([@pastorius][])
 
 ## 0.5.0 - June 2, 2012
 
-### Bug fix:
+### Bug fix
 
 - [#24][]: Add note for Rails projects using profile/benchmark tests in README. ([@coderjoe][])
 
-### Changes:
+### Changes
 
-- Updated for Guard 1.1. ([@rymai][])
+- Updat for Guard 1.1. ([@rymai][])
 
-### New feature:
+### New feature
 
 - [#20][]: Add the `:rubygems` options for projects that don't use Bundler. ([@rymai][])
 
 ## 0.4.3 - December 19, 2011
 
-### Bug fix:
+### Bug fix
 
-- [#21][]: Guard::Test::Notifier.notify - did not use :failed image if test results included errors but NO failures. ([@carlost][])
+- [#21][]: `Guard::Test::Notifier.notify` did not use :failed image if test results included errors but NO failures. ([@carlost][])
 
 ## 0.4.2 - November 19, 2011
 
-### Bug fix:
+### Bug fix
 
-- [#19][]: Fixed "superclass mismatch for class Test (TypeError)" thanks to [@gertas][]. ([@rymai][])
+- [#19][]: Fix "superclass mismatch for class Test (TypeError)" thanks to [@gertas][]. ([@rymai][])
 
 ## 0.4.1 - November 3, 2011
 
-### Bugs fixes:
+### Bugs fixes
 
-- [#18][]: Fixed a conflict with test_benchmark that was preventing guard-test from running. ([@rymai][])
-- [#11][]: Fixed a "No such file to load -- guard/notifier" when running guard without bundler. ([@rymai][])
+- [#18][]: Fix a conflict with test_benchmark that was preventing guard-test from running. ([@rymai][])
+- [#11][]: Fix a "No such file to load -- guard/notifier" when running guard without bundler. ([@rymai][])
 
 ## 0.4.0 - September 29, 2011
 
-### Regression:
+### Regression
 
-- Removed support of [turn](https://github.com/guard/guard-spork) gem since "Turn is no longer compatible with TestUnit 2.0+. TestUnit and MiniTest are deverging and after some consideration it was decided that Turn's goal is to support Ruby's native test framework, whatever it may be." quoted from Turn's [release.txt](https://github.com/TwP/turn/blob/master/Release.txt). ([@rymai][])
+- Remove support of [turn](https://github.com/guard/guard-spork) gem since "Turn is no longer compatible with TestUnit 2.0+. TestUnit and MiniTest are deverging and after some consideration it was decided that Turn's goal is to support Ruby's native test framework, whatever it may be." quoted from Turn's [release.txt](https://github.com/TwP/turn/blob/master/Release.txt). ([@rymai][])
 
-### New feature:
+### New feature
 
 - New `:drb` option enabling the use of [`spork-testunit`](https://github.com/timcharper/spork-testunit) gem (be sure to use [guard-spork](https://github.com/guard/guard-spork) as well). ([@rymai][])
 
 ## 0.3.1 - September 11, 2011
 
-### New feature:
+### New feature
 
 - [#13][]: New `test_paths` option to look for test files under other paths than `test`. ([@Ask11][])
 
-### Improvement:
+### Improvement
 
 - [#15][]: Simplify some checks. ([@dasch][])
 
 ## 0.3.0 - June 14, 2011
 
-### Improvement:
+### Improvement
 
 - Internal cleaning. ([@rymai][])
 
 ## 0.3.0.rc5 - June 9, 2011
 
-### Bugs fixes:
+### Bugs fixes
 
-- Fixed bug that was preventing tests from running. ([@rymai][])
-- Fixed the `fastfail` runner that was displaying a green dot even for a failing test. ([@rymai][])
-- Removed the `:notification` option. Use the new Guard method instead. ([@rymai][])
+- Fix bug that was preventing tests from running. ([@rymai][])
+- Fix the `fastfail` runner that was displaying a green dot even for a failing test. ([@rymai][])
+- Remove the `:notification` option. Use the new Guard method instead. ([@rymai][])
 
-### New feature:
+### New feature
 
 - Turn seems to work fine now... ([@rymai][])
 
-### Improvement:
+### Improvement
 
-- Consider 'test_*.rb' as test files as well. ([@uk-ar][])
+- Consider `test_*.rb` as test files as well. ([@uk-ar][])
 
 ## 0.3.0.rc4 - June 3, 2011
 
-### Bugs fix:
+### Bugs fix
 
 - Add a require that was making the guard be fired by Guard! :'( ([@rymai][])
 
 ## 0.3.0.rc3 - June 3, 2011
 
-### Bugs fix:
+### Bugs fix
 
 - Actually make the tests run. ([@rymai][])
 
-### Regression:
+### Regression
 
 - Turn doesn't want to run, so remove sentences that say that it is supported for now. Note: The code is still here, only the command line doesn't seem to output anything... ([@rymai][])
 
 ## 0.3.0.rc2 - June 2, 2011
 
-### New features:
+### New features
 
 - New `:cli` option (nil by default) to pass arbitrary CLI arguments to the Ruby/Turn command that runs the tests. ([@rymai][])
 - New `:notification` option (true by default) to disable notification (Growl/Inotify). ([@rymai][])
@@ -117,24 +131,24 @@
 - New `:all_after_pass` option (true by default) to run all tests after changed tests pass. ([@rymai][])
 - New `:keep_failed` option (true by default) to keep failed tests until them pass. ([@rymai][])
 
-### Improvements:
+### Improvements
 
-- Added compatibility with 1.8.6, 1.8.7, 1.9.2, REE, Rubinius and JRuby. ([@rymai][])
+- Add compatibility with 1.8.6, 1.8.7, 1.9.2, REE, Rubinius and JRuby. ([@rymai][])
 - Internal changes inspired by [guard-minitest](https://github.com/guard/guard-minitest). ([@rymai][])
 
 ## 0.1.6 - January 24, 2011
 
-### Bugs fix:
+### Bugs fix
 
 - [#2][]: Fixed a bug introduced in 0.1.5 where test/ was not added to the $LOAD_PATH. ([@rymai][])
 
 ## 0.1.5 - January 21, 2011
 
-- Updated gem dependencies. ([@rymai][])
+- Update gem dependencies. ([@rymai][])
 
 ## 0.1.4 - December 15, 2010
 
-### Bugs fix:
+### Bugs fix
 
 - [#1][]: Include errors count to determine the "flag" to display in notification. ([@gregorymostizky][])
 
@@ -152,6 +166,8 @@
 [#34]: https://github.com/guard/guard/issues/34
 [#35]: https://github.com/guard/guard/issues/35
 [#38]: https://github.com/guard/guard/issues/38
+[#40]: https://github.com/guard/guard/issues/40
+[#41]: https://github.com/guard/guard/issues/41
 [@Ask11]: https://github.com/Ask11
 [@amiel]: https://github.com/amiel
 [@carlost]: https://github.com/carlost
@@ -162,5 +178,6 @@
 [@gregorymostizky]: https://github.com/gregorymostizky
 [@jgrau]: https://github.com/jgrau
 [@pastorius]: https://github.com/pastorius
+[@pgaertig]: https://github.com/pgaertig
 [@rymai]: https://github.com/rymai
 [@uk-ar]: https://github.com/uk-ar

data/README.md

@@ -1,43 +1,26 @@
-# Guard::Test [![Build Status](https://secure.travis-ci.org/guard/guard-test.png?branch=master)](http://travis-ci.org/guard/guard-test)
+# Guard::Test
+[![Gem Version](https://badge.fury.io/rb/guard-test.png)](http://badge.fury.io/rb/guard-test) [![Build Status](https://travis-ci.org/guard/guard-test.png?branch=master)](https://travis-ci.org/guard/guard-test) [![Dependency Status](https://gemnasium.com/guard/guard-test.png)](https://gemnasium.com/guard/guard-test) [![Code Climate](https://codeclimate.com/github/guard/guard-test.png)](https://codeclimate.com/github/guard/guard-test) [![Coverage Status](https://coveralls.io/repos/guard/guard-test/badge.png?branch=master)](https://coveralls.io/r/guard/guard-test)
 
 Test::Unit guard allows to automatically & intelligently launch tests when files are modified or created.
 
-If you have any questions about Guard or Guard::Test, please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
-
-## Features
-
-- Compatible with test-unit 2.
-- Tested on Ruby 1.8.7, 1.9.2, REE, Rubinius and JRuby.
+* Compatible with Test::Unit 2.
+* Tested against Ruby 1.8.7, 1.9.3, REE, Rubinius & JRuby.
 
 ## Install
 
-Please be sure to have [Guard](https://github.com/guard/guard) installed before continue.
+Please be sure to have [Guard](https://github.com/guard/guard) installed before continuing.
 
-If you're using Bundler, add it to your `Gemfile`:
+Add the gem to your Gemfile (inside the `:development` or `:tool` group):
 
-```ruby
-group :tools do
+``` ruby
+group :development do
   gem 'guard-test'
 end
 ```
 
-Note for Rails users: you should add it inside a `:tools` group (or at least not the `:development` nor `:test` group) to avoid the loading of the gem on Rails boot.
-
-and run:
-
-```bash
-$ bundle install
-```
-
-or manually install the gem:
-
-```bash
-$ gem install guard-test
-```
+Add guard definition to your Guardfile by running this command:
 
-Add Guard definition to your `Guardfile` by running this command:
-
-```bash
+``` bash
 $ guard init test
 ```
 
@@ -57,7 +40,7 @@ Specify ruby-prof as application's dependency in Gemfile to run benchmarks.
 Rails automatically generates a performance test stub in the `test/performance` directory which can trigger this error.
 Either add `ruby-prof` to your `Gemfile` (inside the `test` group):
 
-```ruby
+``` ruby
 group :test do
    gem 'ruby-prof'
 end
@@ -69,9 +52,9 @@ Or remove the test if it isn't necessary.
 
 Please read the [Guard usage doc](https://github.com/guard/guard#readme).
 
-## Guardfile
+By default, Guard::Test watch for files matching `test_*.rb` or `*_test{s,}.rb` in the `test` directory (this directory can be changed with the `test_paths` option, see below).
 
-Guard::Test can be adapted to any kind of projects.
+## Guardfile
 
 See the [template Guardfile](https://github.com/guard/guard-test/blob/master/lib/guard/test/templates/Guardfile) for some examples.
 
@@ -83,17 +66,20 @@ Please read the [Guard documentation](https://github.com/guard/guard#readme) for
 
 ### Available options
 
-* `bundler` (`Boolean`)          - Whether or not to use `bundle exec` to run tests. Default to `true` if a you have a Gemfile in the current directory.
-* `rubygems` (`Boolean`)         - Whether or not to require rubygems (if bundler isn't used) when running the tests. Default to `false`.
-* `rvm` (`Array<String>`)        - Directly run your specs against multiple Rubies. Default to `nil`.
-* `drb` (`Boolean`)              - Run your tests with [`spork-testunit`](https://github.com/timcharper/spork-testunit). Default to `false`.
-* `zeus` (`Boolean`)             - Run your tests with [`zeus`](https://github.com/burke/zeus). Default to `false`.
-* `include` (`Array<String>`)    - Pass arbitrary include paths to the command that runs the tests. Default to `['test']`.
-* `cli` (`String`)               - Pass arbitrary CLI arguments to the command that runs the tests. Default to `nil`.
-* `all_on_start` (`Boolean`)     - Run all tests on Guard startup. Default to `true`.
-* `all_after_pass` (`Boolean`)   - Run all tests after the current run tests pass. Default to `true`.
-* `keep_failed` (`Boolean`)      - Re-run failing tests until they pass. Default to `true`.
-* `test_paths` (`Array<String>`) - Array of paths that where are located the test files. Default to `['test']`.
+``` ruby
+:bundler => false          # Whether or not to use `bundle exec` to run tests, default: true (if a you have a Gemfile in the current directory)
+:rubygems => true          # Whether or not to require rubygems (if bundler isn't used) when running the tests, default: false
+:rvm => ['1.9.3', 'jruby'] # Directly run your specs against multiple Rubies, default: nil
+:drb => true               # Run your tests with [`spork-testunit`](https://github.com/timcharper/spork-testunit), default: false
+:zeus => true              # Run your tests with [`zeus`](https://github.com/burke/zeus), default: false
+:spring => true            # Run your tests with [`spring`](https://github.com/jonleighton/spring), default: false
+:include => ['foo', 'bar'] # Pass arbitrary include paths to the command that runs the tests, default: ['test']
+:cli => 'color'            # Pass arbitrary CLI arguments to the command that runs the tests, default: nil
+:all_on_start => false     # Run all tests on Guard startup, default: true.
+:all_after_pass => false   # Run all tests after the current run tests pass, default: true
+:keep_failed => false      # Re-run failing tests until they pass, default: true
+:test_paths => ['spec']    # Array of paths that where are located the test files, default: ['test']
+```
 
 #### `drb` option
 
@@ -101,43 +87,31 @@ When true, notifications are disabled. This might be fixed in future releases.
 
 #### `zeus` option
 
-When true, the `include` option is disregarded, as it does not work with `zeus`' test runner. 
-
-The zeus server process (`zeus start`) must already be running in another terminal.
+When true, the `include` option is disregarded, as it does not work with `zeus`' test runner.
 
-#### `test_paths` option
-
-By default, guard-test will only look for test files within `test/` in your project root. You can add any paths using the `:test_paths` option:
-
-```ruby
-guard :test, :test_paths => ['test', 'vendor/plugins/recaptcha/test', 'any/path/test'] do
-  # ...
-end
-```
+The zeus server process (`zeus start`) must already be running in another terminal (you can use [guard-zeus](http://rubygems.org/gems/guard-zeus) for that).
 
 ## Development
 
-- Source hosted on GitHub: https://github.com/guard/guard-test
-- Report issues and feature requests to GitHub Issues: https://github.com/guard/guard-test/issues
+* Documentation hosted at [RubyDoc](http://rubydoc.info/gems/guard-test/frames).
+* Source hosted at [GitHub](https://github.com/guard/guard-test).
 
-Pull requests are very welcome! Please try to follow these simple "rules", though:
+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;
-- Update the [README](https://github.com/guard/guard-test/blob/master/README.md) (if applicable);
-- Update the [CHANGELOG](https://github.com/guard/guard-test/blob/master/CHANGELOG.md) and add yourself to the list of contributors (see at the bottom of the CHANGELOG for examples);
-- Please do not change the version number.
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested. All specs must pass on [Travis CI](https://travis-ci.org/guard/guard-test).
+* Update the [Yard](http://yardoc.org/) documentation.
+* Update the [README](https://github.com/guard/guard-test/blob/master/README.md).
+* Update the [CHANGELOG](https://github.com/guard/guard-test/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 on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
+For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).
 
 ## Author
 
-[Rémy Coutable](https://github.com/rymai)
+[Rémy Coutable](https://github.com/rymai) ([@rymai](http://twitter.com/rymai), [rymai.me](http://rymai.me))
 
 ## Contributors
 
 https://github.com/guard/guard-test/contributors
-
-## Kudos
-
-Many thanks to [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) for creating the excellent [Guard](https://github.com/guard/guard) gem.

data/lib/guard/test.rb

@@ -7,8 +7,8 @@ require 'test/unit/version'
 module Guard
   class Test < Guard
 
-    autoload :Runner,    'guard/test/runner'
-    autoload :Inspector, 'guard/test/inspector'
+    require 'guard/test/runner'
+    require 'guard/test/inspector'
 
     def initialize(watchers = [], options = {})
       super
@@ -25,7 +25,8 @@ module Guard
     end
 
     def start
-      ::Guard::UI.info("Guard::Test #{TestVersion::VERSION} is running, with Test::Unit #{::Test::Unit::VERSION}!", :reset => true)
+      ::Guard::UI.info("Guard::Test #{TestVersion::VERSION} is running, " +
+                       "with Test::Unit #{::Test::Unit::VERSION}!", :reset => true)
       run_all if @options[:all_on_start]
     end
 

data/lib/guard/test/runner.rb

@@ -1,10 +1,11 @@
 # encoding: utf-8
-
 module Guard
   class Test
     class Runner
 
-      def initialize(options = {})
+      attr_reader :options
+
+      def initialize(opts = {})
         @options = {
           :bundler  => File.exist?("#{Dir.pwd}/Gemfile"),
           :rubygems => false,
@@ -12,32 +13,33 @@ module Guard
           :include  => ['test'],
           :drb      => false,
           :zeus     => false,
+          :spring   => false,
           :cli      => ''
-        }.merge(options)
+        }.merge(opts)
       end
 
-      def run(paths, options = {})
+      def run(paths, opts = {})
         return true if paths.empty?
 
-        ::Guard::UI.info(options[:message] || "Running: #{paths.join(' ')}", :reset => true)
+        ::Guard::UI.info(opts[:message] || "Running: #{paths.join(' ')}", :reset => true)
 
         system(test_unit_command(paths))
       end
 
       def bundler?
         if @bundler.nil?
-          @bundler = @options[:bundler] && !drb? && !zeus?
+          @bundler = options[:bundler] && !drb? && !zeus? && !spring?
         end
         @bundler
       end
 
       def rubygems?
-        !bundler? && !zeus? && @options[:rubygems]
+        !bundler? && !zeus? && !spring? && options[:rubygems]
       end
 
       def drb?
         if @drb.nil?
-          @drb = @options[:drb]
+          @drb = options[:drb]
           begin
             require 'spork-testunit'
           rescue LoadError
@@ -49,45 +51,66 @@ module Guard
 
       def zeus?
         if @zeus.nil?
-          @zeus = @options[:zeus]
+          @zeus = options[:zeus]
           ::Guard::UI.info('Using zeus to run the tests') if @zeus
         end
         @zeus
       end
-      
+
+      def spring?
+        if @spring.nil?
+          @spring = options[:spring]
+          ::Guard::UI.info('Using spring to run the tests') if @spring
+        end
+        @spring
+      end
+
     private
 
       def test_unit_command(paths)
-        cmd_parts = []
-        cmd_parts << "rvm #{@options[:rvm].join(',')} exec" unless @options[:rvm].empty?
-        cmd_parts << 'bundle exec' if bundler?
-        cmd_parts << case true
-                     when drb?
-                       'testdrb'
-                     when zeus?
-                       'zeus test'
-                     else
-                       'ruby'
-                     end
-        cmd_parts << Array(@options[:include]).map { |path| "-I#{path}" } unless zeus?
-        cmd_parts << '-r bundler/setup' if bundler?
-        cmd_parts << '-rubygems' if rubygems?
-
-        unless drb? || zeus?
-          cmd_parts << "-r #{File.expand_path("../guard_test_runner", __FILE__)}"
-          cmd_parts << "-e \"%w[#{paths.join(' ')}].each { |p| load p }\""
-        end
+        cmd_parts = executables
+        cmd_parts.concat(includes_and_requires(paths))
+        cmd_parts.concat(test_files_list(paths))
+        cmd_parts.concat(command_options)
+        cmd_parts << options[:cli]
+
+        cmd_parts.compact.join(' ').strip
+      end
 
-        paths.each { |path| cmd_parts << "\"./#{path}\"" }
+      def executables
+        parts = []
+        parts << "rvm #{options[:rvm].join(',')} exec" unless options[:rvm].empty?
+        parts << 'bundle exec' if bundler?
+        parts << case true
+                 when drb? then 'testdrb'
+                 when zeus? then 'zeus test'
+                 when spring? then 'spring testunit'
+                 else 'ruby'; end
+      end
 
-        unless drb? || zeus?
-          cmd_parts << '--use-color'
-          cmd_parts << '--runner=guard'
+      def includes_and_requires(paths)
+        parts = []
+        parts << Array(options[:include]).map { |path| "-I#{path}" } unless zeus? || spring?
+        parts << '-r bundler/setup' if bundler?
+        parts << '-rubygems' if rubygems?
+        unless drb? || zeus? || spring?
+          parts << "-r #{File.expand_path("../guard_test_runner", __FILE__)}"
+          parts << "-e \"%w[#{paths.join(' ')}].each { |p| load p }\""
         end
 
-        cmd_parts << @options[:cli]
+        parts
+      end
+
+      def test_files_list(paths)
+        paths.map { |path| "\"./#{path}\"" }
+      end
 
-        cmd_parts.compact.join(' ').strip
+      def command_options
+        if drb? || zeus? || spring?
+          []
+        else
+          ['--use-color', '--runner=guard']
+        end
       end
 
     end