ghostbuster 0.2.3 → 0.2.4

data/README.md

@@ -16,53 +16,37 @@ Once installed, you can simply use `ghostbuster [path/to/Ghostfile]` to run your
 
 As well, you can install Ghostbuster to run as a rake task. To do this, add this to your `Rakefile`:
 
-~~~~
     require 'ghostbuster/install_rake'
-~~~~
 
 ### Configuration via Ghostfile
 
 Your `Ghostfile` handles your configuration. To set the pattern use:
 
-~~~~
     ghost.pattern = "test_*.{js,coffee}" # this is the default
-~~~~
 
 To enable (or disable) screenshots use:
 
-~~~~
     ghost.take_screenshots! # or #do_not_takescreenshots! defaults to take_screenshots!
-~~~~
 
 To set the directory your screenshots will save to use:
 
-~~~~
     ghost.screenshot_dir = '.'
-~~~~
 
 To set the dimensions for the screenshots use:
 
-~~~~
-    ghost.screenshot_dimensions 800, 2000 # x, y
-~~~~
+    ghost.screenshot_dimensions 800, 2000 # width, height
 
 To set the command for starting your server use:
 
-~~~~
     ghost.start_command "./start.sh"
-~~~~
 
 To set the command for stopping your server use:
 
-~~~~
     ghost.stop_command "./stop.sh"
-~~~~
 
 To set the location of your phantomjs binary, use:
 
-~~~~
     ghost.phantom_bin = File.join(ENV['HOME'], '.ghostbuster', 'phantomjs')
-~~~~
 
 If no Ghostfile is found, it will simply use the defaults.
 
@@ -70,8 +54,6 @@ If no Ghostfile is found, it will simply use the defaults.
 
 You should get some output that looks something like this.
 
-~~~~
-
     GhostBuster
     For /Users/joshbuddy/Development/ghostbuster/ghost/test_ghost.coffee
       ✓ Simple index
@@ -86,8 +68,6 @@ You should get some output that looks something like this.
       ✓ Simple form
       ◐ Form should do more things
 
-~~~~
-
 Your test directory should look something like this:
 
     ghost_tests/start.sh       # Used to start your web application
@@ -98,8 +78,6 @@ Look inside `ghost` to see some examples of what actual tests would look like. L
 
 Here is one in Coffeescript.
 
-~~~~
-
     phantom.test.root = "http://127.0.0.1:4567" # you must specify your root.
 
     phantom.test.add "Simple index", ->         # this adds a test
@@ -110,12 +88,8 @@ Here is one in Coffeescript.
           li.innerHTML == "List item #{idx + 1}"
         @succeed()                              # all tests must succeed
 
-~~~~
-
 Here is the same test in Javascript.
 
-~~~~
-
     phantom.test.root = "http://127.0.0.1:4567";  // you must specify your root.
 
     phantom.test.add("Simple index", function() { // this adds a test
@@ -127,33 +101,82 @@ Here is the same test in Javascript.
         this.succeed();
       });                                         
     });
-~~~~
+
+## Page Controls
+
+The following methods are available within your test.
+
+### get
+
+*Arguments*: location, [options], callback
+
+This location will be relative to your root if it doesn't start with "http". Your callback will be called when the document is ready.
+
+### click
+
+*Arguments*: selector, [index]
+
+This will click the nth element matching the selector. If no index is specified it uses the first one found.
+
+### input
+
+*Arguments*: selector, text
+
+This will fill in the matching form elements with the text given.
+
+### wait
+
+*Arguments*: seconds, callback
+
+This will wait `seconds` secs and then call your callback.
 
 ## Assertions
 
 Assertions are run in order, and only one assertion at a time can run. An assertion will have at most one second to complete. If you want to change the total amount of time an assertion will take, you can supply that time.
 
-~~~~
     @body.assertFirst 'p', total: 3, (p) ->           # this asserts the first paragraph's inner text
-~~~~
 
-The available assertions are:
+The options for all assertions currently accepts `total`, which is the total amount of time this assertion will run for in seconds.
+
+The available assertion function are available on `body`:
+
+### assertFirst
+
+*Arguments*: selector, [options], callback
+
+The callback will be called with the first matching DOM element for the selector. The callback must return `true` if this assertion is met.
+
+### assertAll
+
+*Arguments*: selector, [options], callback
+
+The callback will be called for each matching DOM element for the selector. The arguments supplied to the callback is the DOM element and the index (starting at 0). The callback must return `true` if this assertion is met.
+
+### assertLocation
+
+*Arguments*: location, [options]
+
+This assertion will attempt to match the current browser location. If your location does not start with `http`, it will be considered relative to the root of your test.
+
+### assertCount
+
+*Arguments*: selector, [options], callback
+
+This callback will be called with the number of matching DOM elements for this selector. The callback must return `true` if this assertion is met.
+
+### assertCountAndAll
 
-* _assertFirst_ : This asserts for the first matching DOM element
-* _assertAll_ : This asserts for the each matching DOM element
-* _assertLocation_ : This asserts the current browser location
+*Arguments*: selector, count, [options], callback
 
-The closures passed for matching have access to the real DOM node, however, they do not have any access to the outside context. They must return true if the assertion is passed, anything else will be interpreted as failure.
+The callback will be called for each matching DOM element for the selector. It will only be called if the number of matching elements is equal to `count`. The arguments supplied to the callback is the DOM element and the index (starting at 0). The callback must return `true` if this assertion is met.
 
-## Before and after
+## Before and After
 
 You can add an arbitrary number of before and after blocks to be run within the context of your test. Simply call `before` and `after` on your test to add them. You have to call @succeed in the before block to continue processing your test.
 
-~~~~
     phantom.test.before ->
       # do some setup
       @succeed()
 
     phantom.test.after ->
       # do some teardown
-~~~~

data/ghost/config.ru

@@ -13,6 +13,11 @@ class App < Sinatra::Base
   get "/slow" do
     erb :slow
   end
+
+  get "/slow-index" do
+    sleep 2
+    erb :index
+  end
 end
 
 run App

data/ghost/test_ghost.coffee

@@ -6,6 +6,12 @@ phantom.test.add "Simple index", ->
       p.innerHTML == 'This is my paragraph'
     @body.assertAll 'ul li', (li, idx) ->
       li.innerHTML == "List item #{idx + 1}"
+    @body.assertCountAndAll 'a', 1, (a, idx) ->
+      a.href == 'http://127.0.0.1:4567/form'
+    @succeed()
+
+phantom.test.add "Simple slow index", ->
+  @get '/slow-index', total: 3, ->
     @succeed()
 
 phantom.test.add "Form input", ->
@@ -35,4 +41,3 @@ phantom.test.add "Form input not equal", ->
     @body.assertFirst '#out', (out) ->
       out.innerHTML == 'this is NOT my input'
     @succeed()
-

data/lib/ghostbuster.coffee

@@ -41,10 +41,17 @@ class Test
     ), 5000
   runWithFunction: (fn, @callback) ->
     fn.call(this)
-  get: (path, getCallback) ->
+  get: (path, opts, getCallback) ->
+    unless getCallback?
+      getCallback = opts
+      opts = {}
     @waitForAssertions ->
       test = this
+      fatalCallback = ->
+        test.fail("The request for #{@runner.normalizePath(path)} failed")
+      fatal = setTimeout fatalCallback, if opts.total then opts.total * 1000 else 1000
       loadedCallback = (status) ->
+        clearTimeout fatal
         return if test.seenCallbacks.indexOf(getCallback) != -1
         test.seenCallbacks.push getCallback # traversing links causes this to get re-fired.
         switch status
@@ -112,17 +119,16 @@ class Body
     "
     @test.page.evaluate(input)
 
-  click: (selector) ->
+  click: (selector, idx) ->
+    idx ||= 0
     eval "
       var fn = function() {
         var targets = document.querySelectorAll('#{selector}'),
-            evt = document.createEvent('MouseEvents'), 
-            i, len; 
+            evt = document.createEvent('MouseEvents'),
+            idx = #{idx};
         evt.initMouseEvent('click', true, true, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null); 
-
-        for ( i = 0, len = targets.length; i < len; ++i ) { 
-            targets[i].dispatchEvent(evt);     
-        } 
+        if (idx < targets.length) targets[idx].dispatchEvent(evt);
+        else throw('Couldnt find element #{idx} for selector #{selector}');
       };
     "
     @test.page.evaluate(fn)
@@ -229,6 +235,10 @@ class Body
       "
       withValue @page.evaluate(evaluator)
 
+  assertCountAndAll: (selector, count, opts, assertionCallback) ->
+    @assertCount selector, opts, (c) -> c == count
+    @assertAll selector, opts, assertionCallback
+
 class PendingTest
   constructor: (@runner, @name) ->
   run: (callback) -> callback('pending')

data/lib/ghostbuster/version.rb

@@ -1,3 +1,3 @@
 class Ghostbuster
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/test/output

@@ -3,6 +3,7 @@ Starting server
 GhostBuster
 For test_ghost.coffee
   ✓ Simple index
+  ✓ Simple slow index
   ✓ Form input
   ✓ Link traversal
   ✗ Bad link traversal
@@ -26,5 +27,5 @@ For test_injs.js
 
 For test_withoutroot.js
   ✗ No root is defined
-8 success, 5 failure, 1 pending
+9 success, 5 failure, 1 pending
 Stopping server

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ghostbuster
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Josh Hull