guard-jasmine 0.3.0 → 0.3.1

data/README.md

@@ -12,23 +12,28 @@ If you have any questions please join us on our [Google group](http://groups.goo
 * Continuous testing based on file modifications by [Guard][], manifold configurable rules
 with RegEx and Ruby.
 
-* Fast headless testing in [PhantomJS][], a full featured WebKit browser with native support for
+* Fast headless testing on [PhantomJS][], a full featured WebKit browser with native support for
 various web standards: DOM handling, CSS selector, JSON, Canvas, and SVG.
 
-* With Rails 3.1 you can write your [Jasmine][] specs in [CoffeeScript][] also, fully integrated into the
+* You can write your [Jasmine][] specs in [CoffeeScript][], fully integrated into the
 [Rails 3.1 asset pipeline][] with [Jasminerice][].
 
 * Runs on Mac OS X, Linux and Windows.
 
 ## How it works
 
-1. Configure your Jasmine based JavaScript/CoffeeScript specs with Jasminerice in the asset pipeline, serve it over
-the normal Jasmine Spec Runner. (With Rails 2 & 3 you configure your plain JavaScript Jasmine specs with [the Jasmine Gem][].)
+![Guard Jasmine](https://github.com/netzpirat/guard-jasmine/raw/master/resources/guard-jasmine.png)
 
-2. You configure Guard to trigger certain specs based on file modifications.
-
-3. Guard uses PhantomJS to request the Jasmine Spec Runner headless and notifies you of the result in the terminal and
-optionally over system notifications like Growl, Libnotify or Notifu.
+1. Guard is triggered by a file modification.
+2. Guard::Jasmine executes the [PhantomJS script][].
+3. The PhantomJS script requests the Jasmine test runner via HTTP.
+4. Rails uses the asset pipeline to get the Jasmine runner, the code to be tested and the specs.
+5. The asset pipeline prepares the assets, compiles the CoffeeScripts if necessary.
+6. The asset pipeline has finished to prepare the needed assets.
+7. Rails returns the Jasmine runner HTML.
+8. PhantomJS requests linked assets and runs the Jasmine tests headless.
+9. The PhantomJS script extracts the result from the DOM and returns a JSON report.
+10. Guard::Jasmine reports the results to the console and system notifications.
 
 ## Install
 
@@ -58,7 +63,7 @@ Please read the detailed installation and configuration instructions at [Jasmine
 In short, you add it to your `Gemfile`:
 
     group :development, :test do
-      gem 'jasmine'
+      gem 'jasminerice'
     end
 
 and add a route for the Jasmine Test Runner to `config/routes.rb`:
@@ -72,11 +77,6 @@ asset pipeline manifest in `spec/javascripts/spec.js.coffee`:
 
     #=require_tree ./
 
-### Rails 2 & 3
-
-With Rails 3 you write your Jasmine specs in JavaScript, configured and server with the Jasmine gem. Please read the
-detailed installation and configuration instructions at [the Jasmine Gem][].
-
 ### PhantomJS
 
 You need the PhantomJS browser installed on your system. You can download binaries for Mac OS X and Windows from
@@ -112,15 +112,6 @@ Guard::Jasmine can be adapted to all kind of projects. Please read the
       watch(%r{spec/javascripts/spec\.(js\.coffee|js)})       { "spec/javascripts" }
     end
 
-### Rails 2 & 3 with the Jasmine gem
-
-    guard 'jasmine', :url => 'http://127.0.0.1:8888' do
-      watch(%r{public/javascripts/(.+)\.js})                  { |m| "spec/javascripts/#{m[1]}_spec.js" }
-      watch(%r{spec/javascripts/(.+)_spec\.js})               { |m| "spec/javascripts/#{m[1]}_spec.js" }
-      watch(%r{spec/javascripts/support/jasmine\.yml})        { "spec/javascripts" }
-      watch(%r{spec/javascripts/support/jasmine_config\.rb})  { "spec/javascripts" }
-    end
-
 ## Options
 
 There following options can be passed to Guard::Jasmine:
@@ -132,13 +123,13 @@ There following options can be passed to Guard::Jasmine:
     :phantomjs_bin => '~/bin/phantomjs'           # Path to phantomjs.
                                                   # default: '/usr/local/bin/phantomjs'
 
-    :all_on_start => false                        # Run all specs on start.
+    :all_on_start => false                        # Run all suites on start.
                                                   # default: true
 
-    :keep_failed => false                         # Keep failed specs and add them the next run again.
+    :keep_failed => false                         # Keep failed suites and add them to the next run again.
                                                   # default: true
 
-    :all_after_pass => false                      # Run all specs after a single spec has passed.
+    :all_after_pass => false                      # Run all suites after a suite has passed again after failing.
                                                   # default: true
 
     :notifications => false                       # Show success and error messages.
@@ -147,6 +138,34 @@ There following options can be passed to Guard::Jasmine:
     :hide_success => true                         # Disable successful compilation messages.
                                                   # default: false
 
+The `:keep_failed` failed option remembers failed suites and not failed specs. The reason for this decision is to
+avoid to much round trip time to request the Jasmine test runner for each single spec, which is mostly more expensive
+than running a whole suite.
+
+### A note on Rails 2 and 3
+
+This readme describes the use of Guard::Jasmine with Jasminerice through the asset pipeline. But as long as you
+serve the Jasmine test runner under a certain url, it's freely up to you how to prepare and serve the runner.
+
+You can use [the Jasmine Gem][], configure the test suite in `jasmine.yml` and start the Jasmine test runner with
+the supplied Rake task:
+
+    $ rake jasmine
+
+Next follows an example on how to configure your `Guardfile` with the Jasmine gem:
+
+    guard 'jasmine', :url => 'http://127.0.0.1:8888' do
+      watch(%r{public/javascripts/(.+)\.js})                  { |m| "spec/javascripts/#{m[1]}_spec.js" }
+      watch(%r{spec/javascripts/(.+)_spec\.js})               { |m| "spec/javascripts/#{m[1]}_spec.js" }
+      watch(%r{spec/javascripts/support/jasmine\.yml})        { "spec/javascripts" }
+      watch(%r{spec/javascripts/support/jasmine_config\.rb})  { "spec/javascripts" }
+    end
+
+It is also possible to use CoffeeScript in this setup, by using [Guard::CoffeeScript][] to compile your code and even
+specs. Just add something like this *before* Guard::Jasmine:
+
+  guard 'coffeescript', :input => 'app/coffeescripts', :output => 'public/javascripts'
+  guard 'coffeescript', :input => 'spec/coffeescripts', :output => 'spec/javascripts'
 
 ## Alternatives
 
@@ -159,8 +178,8 @@ featured browser environment.
 ## Development
 
 - Documentation hosted at [RubyDoc](http://rubydoc.info/gems/guard-jasmine/file/README.md).
-- Source hosted at [GitHub](https://github.com/netzpirat/guard-Jasmine).
-- Report issues and feature requests to [GitHub Issues](https://github.com/netzpirat/guard-Jasmine/issues).
+- Source hosted at [GitHub](https://github.com/netzpirat/guard-jasmine).
+- Report issues and feature requests to [GitHub Issues](https://github.com/netzpirat/guard-jasmine/issues).
 
 Pull requests are very welcome! Please try to follow these simple "rules", though:
 
@@ -174,11 +193,11 @@ For questions please join us on our [Google group](http://groups.google.com/grou
 
 ## Acknowledgment
 
-- [Ariya Hidayat][] for [PhantomJS][], a powerfull headless WebKit browser.
+- [Ariya Hidayat][] for [PhantomJS][], a powerful headless WebKit browser.
 - [Brad Phelan][] for [Jasminerice][], an elegant solution for [Jasmine][] in the Rails 3.1 asset pipeline.
 - [Pivotal Labs][] for their beautiful [Jasmine][] BDD testing framework that makes JavaScript testing fun.
 - [Jeremy Ashkenas][] for [CoffeeScript][], that little language that compiles into JavaScript and makes me enjoy the
-frontend.
+front-end.
 - The [Guard Team][] for giving us such a nice piece of software that is so easy to extend, one *has* to make a plugin
 for it!
 - All the authors of the numerous [Guards][] available for making the Guard ecosystem so much growing and comprehensive.
@@ -229,3 +248,5 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 [guard-jasmine-headless-webkit]: https://github.com/johnbintz/guard-jasmine-headless-webkit
 [jasmine-headless-webkit]: https://github.com/johnbintz/jasmine-headless-webkit/
 [Evergreen]: https://github.com/jnicklas/evergreen
+[PhantomJS script]: https://github.com/netzpirat/guard-jasmine/blob/master/lib/guard/jasmine/phantomjs/run-jasmine.coffee
+[Guard::CoffeeScript]: https://github.com/guard/guard-coffeescript

data/lib/guard/jasmine.rb

@@ -25,8 +25,8 @@ module Guard
     # @option options [Boolean] :notification show notifications
     # @option options [Boolean] :hide_success hide success message notification
     # @option options [Boolean] :all_on_start run all suites on start
-    # @option options [Boolean] :keep_failed keep failed specs and add them the next run again
-    # @option options [Boolean] :all_after_pass run all specs after a single spec has passed
+    # @option options [Boolean] :keep_failed keep failed suites and add them to the next run again
+    # @option options [Boolean] :all_after_pass run all suites after a suite has passed again after failing
     #
     def initialize(watchers = [], options = { })
       defaults = {

data/lib/guard/jasmine/runner.rb

@@ -110,7 +110,7 @@ module Guard
 
           File.foreach(file) do |line|
             if line =~ /describe\s*[("']+(.*?)["')]+/
-              query_string = "?spec=#{ $1 }"
+              query_string = "?#{ $1 }"
               break
             end
           end

data/lib/guard/jasmine/version.rb

@@ -1,6 +1,6 @@
 module Guard
   module JasmineVersion
     # Guard::Jasmine version that is used for the Gem specification
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard-jasmine
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Michael Kessler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-08 00:00:00 Z
+date: 2011-09-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: guard