guard-jasmine 1.1.4 → 1.2.0

data/README.md

@@ -7,37 +7,6 @@ Tested on MRI Ruby 1.8.7, 1.9.2, 1.9.3, REE and the latest versions of JRuby and
 If you have any questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard`
 (irc.freenode.net).
 
-## Contents
-
-* [Highlights](#highlights)
-* [Installation](#installation)
-  * [Guard and Guard::Jasmine](#guard-guard-jasmine)
-  * [PhantomJS](#phantomjs)
-* [Rails with the asset pipeline](#asset-pipeline)
-  * [How it works](#asset-pipeline-works)
-  * [Jasminerice](#asset-pipeline-jasminerice)
-  * [Jasmine Stories](#asset-pipeline-jasmine-stories)
-* [Rails without the asset pipeline and plain Ruby projects](#without-asset-pipeline)
-  * [How it works](#without-asset-pipeline-works)
-  * [Jasmine Gem](#without-asset-pipeline-jasmine-gem)
-* [Usage](#usage)
-  * [Guardfile](#guardfile)
-* [Options](#options)
-  * [Server options](#server-options)
-    * [Use a custom server](#server-options-custom)
-  * [Spec runner options](#spec-runner-options)
-  * [Specdoc options](#specdoc-options)
-    * [Console logs](#console-logs)
-  * [System notifications options](#system-notifications-options)
-* [Mapping file changes to the spec filter](#file-mapping)
-* [Guard::Jasmine outside of Guard](#outside-guard)
-  * [Thor command line utility](#thor)
-  * [Rake task integration](#rake)
-  * [Travis CI integration](#travis-ci)
-* [How to file an issue](#issues)
-* [Development information](#development-information)
-
-<a name="highlights" />
 ## Highlights
 
 * Continuous testing based on file modifications by [Guard][], manifold configuration by writing rules with RegExp and
@@ -56,10 +25,8 @@ various web standards: DOM handling, CSS selector, JSON, Canvas, and SVG.
 
 * Runs on Mac OS X, Linux and Windows.
 
-<a name="installation" />
 ## Installation
 
-<a name="guard-guard-jasmine" />
 ### Guard and Guard::Jasmine
 
 The simplest way to install Guard is to use [Bundler](http://gembundler.com/).
@@ -82,7 +49,6 @@ $ guard init jasmine
 Please have a look at the [CHANGELOG](https://github.com/netzpirat/guard-jasmine/blob/master/CHANGELOG.md) when
 upgrading to a newer Guard::Jasmine version.
 
-<a name="phantomjs" />
 ### PhantomJS
 
 You need the PhantomJS browser installed on your system. You can download binaries for Mac OS X and Windows from
@@ -105,7 +71,6 @@ $ sudo apt-get install phantomjs
 You can also build it from source for several other operating systems, please consult the
 [PhantomJS build instructions][].
 
-<a name="asset-pipeline" />
 ## Rails with the asset pipeline setup
 
 With Rails 3.1 and later you can write your Jasmine specs in addition to JavaScript with CoffeeScript, fully integrated
@@ -114,7 +79,6 @@ practice to fake the server response. Check out the excellent [Sinon.JS][] docum
 
 Guard::Jasmine will start a Rails Rack server to run your specs.
 
-<a name="asset-pipeline-works" />
 ### How it works
 
 ![Guard Jasmine](https://github.com/netzpirat/guard-jasmine/raw/master/resources/guard-jasmine-with-asset-pipeline.jpg)
@@ -130,7 +94,6 @@ Guard::Jasmine will start a Rails Rack server to run your specs.
 9. The PhantomJS script collects the Jasmine runner results and returns a JSON report.
 10. Guard::Jasmine reports the results to the console and system notifications.
 
-<a name="asset-pipeline-jasminerice" />
 ### Jasminerice
 
 Please read the detailed installation and configuration instructions at [Jasminerice][].
@@ -163,7 +126,6 @@ It also creates an empty `spec/javascripts/spec.css` file as it is always reques
 
 Now you can access `/jasmine` when you start your Rails server normally.
 
-<a name="asset-pipeline-jasmine-stories" />
 ### Jasmine Stories acceptance tests
 
 [Jasmine Stories](https://github.com/DominikGuzei/jasmine-stories) is a Jasminerice clone and that serves
@@ -196,7 +158,6 @@ guard :jasmine, :jasmine_url => 'http://127.0.0.1:8888/jasmine-stories' do
 end
 ```
 
-<a name="without-asset-pipeline" />
 ## Rails without the asset pipeline and plain Ruby projects
 
 With Rails without the asset pipeline or a plain Ruby project, you can use [the Jasmine Gem][] to configure your Jasmine
@@ -205,7 +166,6 @@ practice to fake the server response. Check out the excellent [Sinon.JS][] docum
 
 Guard::Jasmine will start a Jasmine Gem Rack server to run your specs.
 
-<a name="without-asset-pipeline-works" />
 ### How it works
 
 ![Guard Jasmine](https://github.com/netzpirat/guard-jasmine/raw/master/resources/guard-jasmine-without-asset-pipeline.jpg)
@@ -219,7 +179,6 @@ Guard::Jasmine will start a Jasmine Gem Rack server to run your specs.
 7. The PhantomJS script collects the Jasmine runner results and returns a JSON report.
 8. Guard::Jasmine reports the results to the console and system notifications.
 
-<a name="without-asset-pipeline-jasmine-gem" />
 ### Jasmine Gem
 
 Please read the detailed installation and configuration instructions at [the Jasmine Gem][].
@@ -248,9 +207,9 @@ Install the Jasmine gem in your Rails 3 app with:
 $ rails g jasmine:install
 ```
 
-#### Rails 2 and plain Ruby project
+#### Rails 2
 
-Install the Jasmine gem in your Rails 2 app or a plain Ruby project with:
+Install the Jasmine gem in your Rails 2 app with:
 
 ```bash
 $ script/generate jasmine
@@ -268,12 +227,77 @@ guard 'coffeescript', :input => 'app/coffeescripts',  :output => 'public/javascr
 guard 'coffeescript', :input => 'spec/coffeescripts', :output => 'spec/javascripts'
 ```
 
-<a name="usage" />
+## Ruby projects
+
+If you like to use Guard::Jasmine with a plain Ruby project, you can create a Rack configuration file
+that starts a Rails instance with the asset pipeline and Jasminerice, having the full Rails testing
+comfort for non-Rails projects. Please have a look at the Rails with the asset pipeline section above
+to see how the setup works.
+
+First you have the add the needed Gems to your `Gemfile`:
+
+```Ruby
+group :assets do
+  gem 'coffee-script'
+end
+
+group :development, :test do
+  gem 'actionpack', '~> 3.2'
+  gem 'railties',   '~> 3.2'
+  gem 'tzinfo'
+
+  gem 'thin'
+    
+  gem 'jasminerice'
+  gem 'jquery-rails'
+  gem 'guard-jasmine'
+end
+```
+
+We add support for CoffeeScript specs, using Thin as spec server and adding Jasminerice and jQuery
+(which is needed by Jasminerice) to the Gems. After installing the gems with `bundle`, we can
+create a Rack configuration to spin up a mini-Rails app for testing:
+
+```Ruby
+require 'rails'
+require 'rails/all'
+require 'jasminerice'
+require 'sprockets/railtie'
+require 'jquery-rails'
+
+class JasmineTest < Rails::Application
+  routes.append do
+    mount Jasminerice::Engine => '/jasmine'
+  end
+
+  config.cache_classes = true
+  config.active_support.deprecation = :log
+  config.assets.enabled = true
+  config.assets.version = '1.0'
+  config.secret_token = '9696be98e32a5f213730cb7ed6161c79'
+end
+
+JasmineTest.initialize!
+run JasmineTest
+```
+
+The mini Rails app is now ready to start and serve the Jasmine specs. You only have to create
+`spec/javascripts/spec.js.coffee`, the Jasminerice asset pipeline manifest, and configure the
+assets:
+
+```CoffeeScript
+#= require jquery
+#= require_tree .
+```
+
+Start the test server manually with `bundle exec rackup -p 3000` and visit `http://localhost:3000/jasmine`
+to verify it works. If everything is fine, you can continue with adding Guard::Jasmine to your `Guardfile`
+and have your non-Rails app comfortably tested in a headless environment.
+
 ## Usage
 
 Please read the [Guard usage documentation](https://github.com/guard/guard#readme).
 
-<a name="guardfile" />
 ## Guardfile
 
 Guard::Jasmine can be adapted to all kind of projects. Please read the
@@ -287,7 +311,6 @@ guard 'jasmine' do
 end
 ```
 
-<a name="options" />
 ## Options
 
 There are many options that can customize Guard::Jasmine to your needs. Options are simply supplied as hash when
@@ -299,7 +322,6 @@ guard 'jasmine', :all_on_start => false, :specdoc => :always do
 end
 ```
 
-<a name="server-options" />
 ### Server options
 
 The server options configures the server environment that is needed to run Guard::Jasmine:
@@ -337,7 +359,6 @@ The reason why the Server environment is set to `development` by default is that
 the asset pipeline doesn't concatenate the JavaScripts and you'll see the line number in the real file,
 instead of a ridiculous high line number in a single, very large JavaScript.
 
-<a name="server-options-custom" />
 #### Use a custom server
 
 If you supply an unknown server name as the `:server` option, then Guard::Jasmine will execute
@@ -346,7 +367,6 @@ a `rake` task with the given server name as task in a child process. For example
 you have to make sure the server starts on the port that you can get from the `JASMINE_PORT`
 environment variable.
 
-<a name="spec-runner-options" />
 ### Spec runner options
 
 The spec runner options configures the behavior driven development (or BDD) cycle:
@@ -377,7 +397,6 @@ In general you want to leave the `:clean` flag on, which ensures that only Jasmi
 `_spec.coffee` and `_spec.js.coffee` inside your project are passed to the runner. If you have a custom project
 structure or spec naming convention, you can set `:clean` to false to skip that file filter.
 
-<a name="specdoc-options" />
 ### Specdoc options
 
 Guard::Jasmine can generate an RSpec like specdoc in the console after running the specs and you can set when it will
@@ -411,7 +430,6 @@ The `:errors` option is partially working when using at least PhantomJS version
 [Issue #166](http://code.google.com/p/phantomjs/issues/detail?id=166) for the actual status of retreiving the JavaScript
 stack trace.
 
-<a name="console-logs" />
 #### Console logs
 
 The `:console` options adds captured console logs from the spec runner and adds them to the specdoc. Guard:Jasmine
@@ -439,7 +457,6 @@ You can further customize the log output by implement one of these methods:
 In addition, the console can log jQuery collections and outputs the HTML representation of the element by using the
 jQuery `html()` method.
 
-<a name="system-notifications-options" />
 ### System notifications options
 
 These options affects what system notifications (growl, libnotify or notifu) are shown after a spec run:
@@ -455,7 +472,6 @@ These options affects what system notifications (growl, libnotify or notifu) are
                                               # default: 3
 ```
 
-<a name="file-mapping" />
 ## Mapping file changes to the spec filter
 
 Jasmine doesn't know anything about your test files, it only knows the name of your specs that you specify in the
@@ -470,10 +486,8 @@ So if you want to have a precise spec detection, you should:
 To get a feeling how your naming strategy works, play with the web based Jasmine runner and modify the `spec` query
 parameter.
 
-<a name="outside-guard" />
 ## Guard::Jasmine outside of Guard
 
-<a name="thor" />
 ### Thor command line utility
 
 Guard::Jasmine includes a little command line utility to run your specs once and output the specdoc to the console.
@@ -521,7 +535,6 @@ By default all specs are run, but you can supply multiple paths to your specs to
 $ guard-jasmine spec/javascripts/a_spec.js.coffee spec/javascripts/another_spec.js.coffee
 ```
 
-<a name="rake" />
 ### Rake task integration
 
 Guard::Jasmine provides a Rake task wrapper around the Thor command line utility. Simply create a JasmineTask within
@@ -559,7 +572,6 @@ the task:
 $ rake guard:jasmine
 ```
 
-<a name="travis-ci" />
 ### Travis CI integration
 
 With the given `guard-jasmine` script you're able to configure [Travis CI](http://travis-ci.org/) to run Guard::Jasmine.
@@ -584,6 +596,25 @@ before_script:
   - "sh -e /etc/init.d/xvfb start"
 ```
 
+## How to test a Rails engine with Jasmine Gem
+
+When building an engine, your code lives at the root but the dummy Rails app is in another folder (like `test/dummy` or `spec/dummy`).
+
+So you have to import the Jasmine task in your `Rakefile`: 
+
+```bash
+$ echo "import 'lib/tasks/jasmine.rake'" > Rakefile
+$ bundle exec rake -T jasmine
+rake jasmine     # Run specs via server
+rake jasmine:ci  # Run continuous integration tests
+```
+
+Given your configuration, you could also need to set:
+
+* `jasmine_url` in your `Guardfile` as explained above
+
+* the server url in the command line: `bundle exec guard-jasmine -u http://localhost:8888/`
+
 ## Alternatives
 
 There are many ways to get your Jasmine specs run within a headless environment. If Guard::Jasmine isn't for you,
@@ -601,7 +632,6 @@ I recommend to check out these other brilliant Jasmine runners:
 * [Jezebel][] a Node.js REPL and continuous test runner for [Jessie][], a Node runner for Jasmine, but has no full
 featured browser environment.
 
-<a name="issues" />
 ## How to file an issue
 
 You can report issues and feature requests to [GitHub Issues](https://github.com/netzpirat/guard-jasmine/issues). Try to figure out
@@ -617,7 +647,6 @@ When you file an issue, please try to follow to these simple rules if applicable
 * Add your `Guardfile` and `Gemfile` to the issue.
 * Make sure that the issue is reproducible with your description.
 
-<a name="development-information" />
 ## Development information
 
 - Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard-jasmine/master/frames).
@@ -726,3 +755,4 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 [Sinon.JS]: http://sinonjs.org
 [guard-jasmine-node]: https://github.com/guard/guard-jasmine-node
 [guard-jessie]: https://github.com/guard/guard-jessie
+[Rails asset pipeline]: http://guides.rubyonrails.org/asset_pipeline.html

data/lib/guard/jasmine/runner.rb

@@ -218,11 +218,11 @@ module Guard
           passed       = failures == 0
 
           if passed
-            report_specdoc(result, passed, options) if options[:specdoc] == :always
+            report_specdoc(result, passed, options)
             Formatter.success(message)
             Formatter.notify(full_message, :title => 'Jasmine suite passed') if options[:notification] && !options[:hide_success]
           else
-            report_specdoc(result, passed, options) if options[:specdoc] != :never
+            report_specdoc(result, passed, options)
             Formatter.error(message)
             notify_errors(result, options)
             Formatter.notify(full_message, :title => 'Jasmine suite failed', :image => :failed, :priority => 2) if options[:notification]
@@ -254,18 +254,22 @@ module Guard
         # @param [Number] level the indention level
         #
         def report_specdoc_suite(suite, passed, options, level = 0)
-          Formatter.suite_name((' ' * level) + suite['description']) if passed || options[:focus] && contains_failed_spec?(suite)
+          # Print the suite description when the specdoc is shown or there are logs to display
+          if (specdoc_shown?(passed, options) || console_logs_shown?(suite, passed, options) || error_logs_shown?(suite, passed, options))
+            Formatter.suite_name((' ' * level) + suite['description']) if passed || options[:focus] && contains_failed_spec?(suite)
+          end
 
           suite['specs'].each do |spec|
             if spec['passed']
-              if passed || !options[:focus]
-                Formatter.success(indent("  ✔ #{ spec['description'] }", level))
+              if passed || !options[:focus] || console_for_spec?(spec, options) || errors_for_spec?(spec, options)
+                Formatter.success(indent("  ✔ #{ spec['description'] }", level)) if description_shown?(passed, spec, options)
+                report_specdoc_errors(spec, options, level)
                 report_specdoc_logs(spec, options, level)
               end
             else
-              Formatter.spec_failed(indent("  ✘ #{ spec['description'] }", level))
+              Formatter.spec_failed(indent("  ✘ #{ spec['description'] }", level)) if description_shown?(passed, spec, options)
               spec['messages'].each do |message|
-                Formatter.spec_failed(indent("    ➤ #{ format_message(message, false) }", level))
+                Formatter.spec_failed(indent("    ➤ #{ format_message(message, false) }", level)) if specdoc_shown?(passed, options)
               end
               report_specdoc_errors(spec, options, level)
               report_specdoc_logs(spec, options, level)
@@ -275,6 +279,53 @@ module Guard
           suite['suites'].each { |suite| report_specdoc_suite(suite, passed, options, level + 2) } if suite['suites']
         end
 
+        # Is the specdoc shown for this suite?
+        def specdoc_shown?(passed, options = {})
+          (options[:specdoc] == :always || (options[:specdoc] == :failure && !passed))
+        end
+
+        # Are console logs shown for this suite?
+        def console_logs_shown?(suite, passed, options = {})
+          # Are console messages displayed?
+          console_enabled = (options[:console] == :always || (options[:console] == :failure && !passed))
+          # Are there any logs to display at all for this suite?
+          logs_for_current_options = suite['specs'].select do |spec|
+            spec['logs'] && (options[:console] == :always || (options[:console] == :failure && !spec['passed']))
+          end
+          any_logs_present = (!logs_for_current_options.empty?)
+          (console_enabled && any_logs_present)
+        end
+
+        # Are console logs shown for this spec?
+        def console_for_spec?(spec, options = {})
+          console = (spec['logs'] && ((spec['passed'] && options[:console] == :always) ||
+                                      (!spec['passed'] && options[:console] != :never)))
+        end
+
+        # Are error logs shown for this suite?
+        def error_logs_shown?(suite, passed, options = {})
+          # Are error messages displayed?
+          errors_enabled = (options[:errors] == :always || (options[:errors] == :failure && !passed))
+          # Are there any errors to display at all for this suite?
+          errors_for_current_options = suite['specs'].select do |spec|
+            spec['errors'] && (options[:errors] == :always || (options[:errors] == :failure && !spec['passed']))
+          end
+          any_errors_present = (!errors_for_current_options.empty?)
+          (errors_enabled && any_errors_present)
+        end
+
+        # Are errors shown for this spec?
+        def errors_for_spec?(spec, options = {})
+          errors = (spec['errors'] && ((spec['passed'] && options[:errors] == :always) ||
+                                       (!spec['passed'] && options[:errors] != :never)))
+        end
+
+        # Is the description shown for this spec?
+        def description_shown?(passed, spec, options = {})
+          (specdoc_shown?(passed, options) || console_for_spec?(spec, options) || errors_for_spec?(spec, options))
+        end
+
+
         # Shows the logs for a given spec.
         #
         # @param [Hash] spec the spec result

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 = '1.1.4'
+    VERSION = '1.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-jasmine
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-18 00:00:00.000000000 Z
+date: 2012-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -266,7 +266,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 979009543372736949
+      hash: -454211367523524578
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: