guard-jasmine 0.2.0 → 0.2.1

data/README.md

@@ -152,11 +152,16 @@ 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)
+- 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).
 
-Pull requests are very welcome! Make sure your patches are well tested.
+Pull requests are very welcome! Please try to follow these simple "rules", though:
+
+- Please create a topic branch for every separate change you make.
+- Make sure your patches are well tested.
+- Update the README (if applicable).
+- 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).

data/lib/guard/jasmine/formatter.rb

@@ -1,32 +1,73 @@
 module Guard
   class Jasmine
+
+    # The Guard::Jasmine formatter collects console and
+    # system notification methods and enhances them with
+    # some color information.
+    #
     module Formatter
       class << self
 
+        # Print an info message to the console.
+        #
+        # @param [String] message the message to print
+        # @param [Hash] options the output options
+        # @option options [Boolean] :reset reset the UI
+        #
         def info(message, options = { })
           ::Guard::UI.info(message, options)
         end
 
+        # Print a debug message to the console.
+        #
+        # @param [String] message the message to print
+        # @param [Hash] options the output options
+        # @option options [Boolean] :reset reset the UI
+        #
         def debug(message, options = { })
           ::Guard::UI.debug(message, options)
         end
 
+        # Print a red error message to the console.
+        #
+        # @param [String] message the message to print
+        # @param [Hash] options the output options
+        # @option options [Boolean] :reset reset the UI
+        #
         def error(message, options = { })
           ::Guard::UI.error(color(message, ';31'), options)
         end
 
+        # Print a green success message to the console.
+        #
+        # @param [String] message the message to print
+        # @param [Hash] options the output options
+        # @option options [Boolean] :reset reset the UI
+        #
         def success(message, options = { })
           ::Guard::UI.info(color(message, ';32'), options)
         end
 
+        # Outputs a system notification.
+        #
+        # @param [String] message the message to print
+        # @param [Hash] options the output options
+        # @option options [Symbol, String] :image the image to use, either :failed, :pending or :success, or an image path
+        # @option options [String] :title the title of the system notification
+        #
         def notify(message, options = { })
           ::Guard::Notifier.notify(message, options)
         end
 
         private
 
+        # Print a info message to the console.
+        #
+        # @param [String] test the text to colorize
+        # @param [String] color_code the color code
+        #
         def color(text, color_code)
-          ::Guard::UI.send(:color_enabled?) ? "\e[0#{color_code}m#{text}\e[0m" : text
+          ::Guard::UI.send(:color_enabled?) ? "\e[0#{ color_code }m#{ text }\e[0m" : text
         end
 
       end

data/lib/guard/jasmine/phantomjs/run-jasmine.coffee

@@ -1,60 +1,65 @@
-##
-# Wait until the test condition is true or a timeout occurs. Useful for waiting
-# on a server response or for a ui change (fadeIn, etc.) to occur.
+# Wait until the test condition is true or a timeout occurs.
+#
+# @param [Function] testFx the condition that evaluates to a boolean
+# @param [Function] onReady the action when the condition is fulfilled
+# @param [Number] timeOutMillis the max amount of time to wait
 #
-# @param testFx javascript condition that evaluates to a boolean,
-# it can be passed in as a string (e.g.: "1 == 1" or "$('#bar').is(':visible')" or
-# as a callback function.
-# @param onReady what to do when testFx condition is fulfilled,
-# it can be passed in as a string (e.g.: "1 == 1" or "$('#bar').is(':visible')" or
-# as a callback function.
-# @param timeOutMillis the max amount of time to wait. If not specified, 3 sec is used.
-##
 waitFor = (testFx, onReady, timeOutMillis=3000) ->
   start = new Date().getTime()
   condition = false
-  f = ->
+  wait = ->
     if (new Date().getTime() - start < timeOutMillis) and not condition
-      # If not time-out yet and condition not yet fulfilled
-      condition = (if typeof testFx is 'string' then eval testFx else testFx()) #< defensive code
+      condition = (if typeof testFx is 'string' then eval testFx else testFx())
     else
       if not condition
-        # If condition still not fulfilled (timeout but condition is 'false')
-        console.log JSON.stringify { error: "Timeout requesting Jasmine test runner!" }
+        console.log "JasmineResult: #{ JSON.stringify { error: "Timeout requesting Jasmine test runner!" } }"
         phantom.exit(1)
       else
-        # Condition fulfilled (timeout and/or condition is 'true')
-        if typeof onReady is 'string' then eval onReady else onReady() #< Do what it's supposed to do once the condition is fulfilled
-        clearInterval interval #< Stop this interval
+        if typeof onReady is 'string' then eval onReady else onReady()
+        clearInterval interval
 
-  interval = setInterval f, 100 #< repeat check every 100ms
+  interval = setInterval wait, 100
 
+# Check arguments of the script.
+#
 if phantom.args.length isnt 1
-  console.log JSON.stringify { error: "Wrong usage of PhantomJS script!" }
+  console.log "JasmineResult: #{ JSON.stringify { error: "Wrong usage of PhantomJS script!" } }"
   phantom.exit()
+else
+  url = phantom.args[0]
 
 page = new WebPage()
-page.onConsoleMessage = (msg) -> console.log msg
 
-url = phantom.args[0]
+# Output the Jasmine test runner result as JSON object.
+# Ignore all other calls to console.log
+#
+page.onConsoleMessage = (msg) -> console.log(RegExp.$1) if /^JasmineResult: (.*)$/.test(msg)
 
+# Open web page and run the Jasmine test runner
+#
 page.open url, (status) ->
+
   if status isnt 'success'
-    console.log JSON.stringify { error: "Unable to access Jasmine specs at #{ url }" }
+
+    console.log "JasmineResult: #{ JSON.stringify { error: "Unable to access Jasmine specs at #{ url }" } }"
     phantom.exit()
 
   else
-    waitFor ->
-      page.evaluate ->
-        if document.body.querySelector '.finished-at' then true else false
+    # Wait until the Jasmine test is run
+    waitFor -> page.evaluate -> if document.body.querySelector '.finished-at' then true else false
     , ->
+        # Jasmine test runner has finished, extract the result from the DOM
         page.evaluate ->
+
+          # JSON response to Guard::Jasmine
           result = {
             suites: []
           }
 
           # Extract runner stats from the HTML
           stats = /(\d+) specs, (\d+) failures? in (\d+.\d+)s/.exec document.body.querySelector('.description').innerText
+
+          # Add stats to the result
           result['stats'] = {
             specs: parseInt stats[1]
             failures: parseInt stats[2]
@@ -64,12 +69,15 @@ page.open url, (status) ->
           # Extract failed suites
           for failedSuite in document.body.querySelectorAll 'div.jasmine_reporter > div.suite.failed'
             description = failedSuite.querySelector('a.description')
+
+            # Add suite information to the result
             suite = {
               description: description.innerText
               filter: description.getAttribute('href')
               specs: []
             }
 
+            # Collect information about each **failing** spec
             for failedSpec in failedSuite.querySelectorAll 'div.spec.failed'
               spec = {
                 description: failedSpec.querySelector('a.description').getAttribute 'title'
@@ -79,6 +87,7 @@ page.open url, (status) ->
 
             result['suites'].push suite
 
-          console.log JSON.stringify result, undefined, 2
+          # Write result as JSON string that is parsed by Guard::Jasmine
+          console.log "JasmineResult: #{ JSON.stringify result, undefined, 2 }"
 
         phantom.exit()

data/lib/guard/jasmine/version.rb

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

metadata

@@ -1,168 +1,135 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: guard-jasmine
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Michael Kessler
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2011-09-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-08 00:00:00.000000000 +02:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
   name: guard
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &2422 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.4'
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 4
-        version: "0.4"
+  requirement: *2422
+  prerelease: false
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+- !ruby/object:Gem::Dependency
   name: multi_json
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: &2440 !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 1
-        - 0
-        - 3
+      - !ruby/object:Gem::Version
         version: 1.0.3
+    none: false
+  requirement: *2440
+  prerelease: false
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: &2456 !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    none: false
+  requirement: *2456
+  prerelease: false
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+- !ruby/object:Gem::Dependency
   name: guard-rspec
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: &2474 !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 4
-        version: "0.4"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    none: false
+  requirement: *2474
+  prerelease: false
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: &2490 !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 6
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    none: false
+  requirement: *2490
+  prerelease: false
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+- !ruby/object:Gem::Dependency
   name: yard
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: &2506 !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 7
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.7.2
+    none: false
+  requirement: *2506
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  version_requirements: &2522 !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+    none: false
+  requirement: *2522
+  prerelease: false
   type: :development
-  version_requirements: *id006
 description: Guard::Jasmine automatically tests your Jasmine specs on PhantomJS
-email: 
+email:
 - michi@netzpiraten.ch
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- lib/guard/jasmine.rb
 - lib/guard/jasmine/formatter.rb
 - lib/guard/jasmine/inspector.rb
-- lib/guard/jasmine/phantomjs/run-jasmine.coffee
 - lib/guard/jasmine/runner.rb
-- lib/guard/jasmine/templates/Guardfile
 - lib/guard/jasmine/version.rb
-- lib/guard/jasmine.rb
+- lib/guard/jasmine/phantomjs/run-jasmine.coffee
+- lib/guard/jasmine/templates/Guardfile
 - LICENSE.MIT
 - LICENSE.BSD
 - README.md
+has_rdoc: true
 homepage: http://github.com/netzpirat/guard-jasmine
 licenses: []
-
-post_install_message: 
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
+  none: false
 requirements: []
-
 rubyforge_project: guard-jasmine
-rubygems_version: 1.8.6
-signing_key: 
+rubygems_version: 1.5.1
+signing_key:
 specification_version: 3
 summary: Guard gem for headless testing with Jasmine
 test_files: []
-
+...