ghostbuster 0.1.0 → 0.2.0

data/README.md

@@ -8,7 +8,37 @@ To install first `gem install ghostbuster`. Once you've done that, you can run `
 
 ## Usage
 
-Once installed, you can simply use `ghostbuster path/to/tests` to run your tests. You should get some output that looks something like this.
+Once installed, you can simply use `ghostbuster [path/to/Ghostfile]` to run your tests.
+
+## `Ghostfile`
+
+Your `Ghostfile` handles your configuration. To set the pattern use:
+
+~~~~
+    ghost.pattern = "test_*.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
+~~~~
+
+If no Ghostfile is found, it will simply use the defaults.
+
+You should get some output that looks something like this.
 
 ~~~~
 

data/Rakefile

@@ -1,3 +1,30 @@
 require 'bundler/gem_tasks'
 $: << 'lib'
-require 'ghostbuster/install_rake'
+require 'ghostbuster/install_rake'
+
+def test_output
+  out = `bundle exec rake test:ghostbuster`
+  $?.success? ? out.gsub(/server .*?\n/m, "server\n") : raise("there was a problem")
+end
+
+desc "Run tests"
+task :test do
+  out = test_output
+  if File.read(File.join(File.dirname(__FILE__), 'test', 'output')) == out
+    puts "Everything is great!"
+  else
+    puts out
+    raise "Things aren't great."
+  end
+end
+
+desc "Update tests"
+task :'test:update' do
+  File.open(File.join(File.dirname(__FILE__), 'test', 'output'), 'w') {|f| f << test_output}
+  puts "Test output updated"
+end
+
+desc "Show output"
+task :"test:output" do
+  puts test_output
+end

data/ghost/Ghostfile

@@ -0,0 +1,4 @@
+ghost.pattern = "test_*.coffee"
+ghost.do_not_take_screenshots! # or do_not_takescreenshots! defaults to true
+ghost.screenshot_dir = '.'
+ghost.screenshot_dimensions 800, 2000

data/lib/ghostbuster.coffee

@@ -1,12 +1,16 @@
 class Test
   constructor: (@runner, @name, @testBody) ->
     @page = new WebPage()
+    if @runner.useScreenshots()
+      @page.viewportSize = @runner.viewportDimensions()
     @page.onConsoleMessage = (msg) ->
       console.log "PAGE CONSOLE: #{msg}"
     @page.onAlert = (msg) => @setLastError(msg)
     @lastError = null
     @assertions = []
     @seenCallbacks = []
+    @assertionIndex = 0
+  nameForRender: -> "#{@runner.suite.screenshot_dir}/#{@runner.nameForRender()}-#{@name.toLowerCase()}".replace(///\s///g, '_').replace(///'///g, '')
   getLastError: -> @runner.lastErrors[@name]
   resetLastError: -> delete @runner.lastErrors[@name]
   setLastError: (error) ->
@@ -43,17 +47,18 @@ class Test
   fail: (msg) ->
     @callback(false, msg)
   assert: (opts, valueFetcher) ->
-    @assertions.push(new Assertion(this, opts, valueFetcher))
+    @assertions.push(new Assertion(this, ++@assertionIndex, opts, valueFetcher))
     @assertions[0].start() if @assertions.length == 1
   wait: (time, callback) ->
     test = this
     setTimeout (-> callback.call(test)), time * 1000
 
 class Assertion
-  constructor: (@test, @opts, @fetcher) ->
+  constructor: (@test, @idx, @opts, @fetcher) ->
     @count = 0
     @totalTime = if @opts['total'] then @opts['total'] * 1000 else 1000
     @everyTime = if @opts['every'] then @opts['every'] else 75
+  nameForRender: -> "#{@test.nameForRender()}-#{@idx}.png"
   start: ->
     test              = @test
     assertion         = this
@@ -69,6 +74,8 @@ class Assertion
         test.resetLastError()
         test.assertions.splice(test.assertions.indexOf(assertion), 1)
         clearTimeout assertion.fatal
+        if test.runner.useScreenshots()
+          test.page.render assertion.nameForRender()
         if test.assertions.length > 0
           test.assertions[0].start()
       else
@@ -180,12 +187,16 @@ class PendingTest
   constructor: (@runner, @name) ->
   run: (callback) -> callback('pending')
   actuallyRun: -> false
+
 class TestFile
   constructor: (@suite, @name) ->
     @tests = []
     @lastErrors = {}
     @befores = []
     @afters = []
+  nameForRender: -> @name.toLowerCase()
+  useScreenshots: -> @suite.screenshots
+  viewportDimensions: -> width: @suite.screenshot_x, height: @suite.screenshot_y
   normalizePath: (path) -> if path.match(/^http/) then path else "#{@root}#{path}"
   addPending: (name, body) -> @tests.push new PendingTest(this, name)
   before: (body) -> @befores.push(body)
@@ -257,7 +268,11 @@ class TestSuite
     @failure += failure
     @pending += pending
   run: ->
-    count = 0
+    @screenshots    = @args[0] == 'true'
+    @screenshot_x   = @args[1]
+    @screenshot_y   = @args[2]
+    @screenshot_dir = @args[3]
+    count = 4
     suite = this
     runNextTest = ->
       if suite.args.length == count

data/lib/ghostbuster.rb

@@ -1,22 +1,23 @@
 require 'ghostbuster/version'
 require 'ghostbuster/shell'
+require 'ghostbuster/config'
 
 class Ghostbuster
   include Shell
   autoload :Rake,  'ghostbuster/rake'
   autoload :Runner, 'ghostbuster/runner'
 
-  def initialize(*paths)
-    @paths = paths
-    @paths.flatten!
-    @dir = File.directory?(@paths[0]) ? @paths[0] : File.dirname(@paths[0])
+  def initialize(path)
+    @path = File.exist?(path) ? path : '.'
+    @dir = File.directory?(@path) ? @path : File.basename(@path)
+    @file = File.directory?(@dir) ? File.join(@dir, 'Ghostfile') : @dir
     @ghost_lib = File.expand_path(File.join(File.dirname(__FILE__), "ghostbuster.coffee"))
     @phantom_bin = File.join(ENV['HOME'], '.ghostbuster', 'phantomjs')
+    @config = Config.new(@file)
     STDOUT.sync = true
   end
 
   def run
-    files = Array(@paths).map{|path| Dir[path].to_a}.flatten.map{|f| File.expand_path(f)}
     status = 1
     Dir.chdir(@dir) do
       spinner "Starting server" do
@@ -24,7 +25,7 @@ class Ghostbuster
         sleep 2
       end
       begin
-        _, status = Process.waitpid2 fork { exec("#{@phantom_bin} #{@ghost_lib} #{files.join(' ')}") }
+        _, status = Process.waitpid2 fork { exec("#{@phantom_bin} #{@ghost_lib} #{@config.screenshots?} #{@config.screenshot_x} #{@config.screenshot_y} #{File.expand_path(@config.screenshot_dir)} #{Dir[@config.pattern].to_a.join(' ')}") }
       ensure
         spinner "Stopping server" do
           sh "./stop.sh"

data/lib/ghostbuster/config.rb

@@ -0,0 +1,38 @@
+class Ghostbuster
+  class Config
+
+    attr_accessor :pattern, :screenshot_dir
+    attr_reader :screenshot_x, :screenshot_y
+    def initialize(path_to_file = nil)
+      @config_file = path_to_file || './Ghostfile'
+      @screenshot_x, @screenshot_y = 800, 2000
+      @pattern = "./test_*.coffee"
+      @screenshot_dir = "."
+      @screenshots = true
+      if File.exist?(@config_file)
+        instance_eval File.read(@config_file), @config_file, 1
+      end
+    end
+
+    def ghost
+      self
+    end
+
+    def screenshot_dimensions(x, y)
+      @screenshot_x, @screenshot_y = x, y
+    end
+
+    def do_not_take_screenshots!
+      @screenshots = false
+    end
+
+    def take_screenshots!
+      @screenshots = true
+    end
+
+    def screenshots?
+      @screenshots
+    end
+  end
+end
+    

data/lib/ghostbuster/rake.rb

@@ -7,11 +7,11 @@ class Ghostbuster
       end
     end
     def self.include_rake_tasks(opts = {})
+      opts[:path]      ||= './ghost'
       opts[:task_name] ||= :"test:ghostbuster"
-      opts[:file_pattern] ||= "ghost/test_*.{coffee,js}"
       desc "Run ghostbuster tasks"
       task opts[:task_name] do
-        Ghostbuster.new(opts[:file_pattern]).run
+        Ghostbuster.new(opts[:path]).run
       end
     end
   end

data/lib/ghostbuster/runner.rb

@@ -5,12 +5,12 @@ class Ghostbuster
     end
 
     def run
-      if @args.size == 0
-        puts "ghostbuster <path/to/tests>"
+      if @args.size == 1 && @args.first == /^--?[\?h](|elp)$/i or @args.size > 1
+        puts "ghostbuster [path/to/Ghostfile]"
         puts "  Version #{VERSION}"
-        exit(1)
+        exit(0)
       else
-        Ghostbuster.new(@args).run
+        Ghostbuster.new(@args.first).run
       end
     end
   end

data/lib/ghostbuster/version.rb

@@ -1,3 +1,3 @@
 class Ghostbuster
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/test/output

@@ -0,0 +1,23 @@
+(in /Users/joshbuddy/Development/ghostbuster)
+Starting server
+GhostBuster
+For test_ghost.coffee
+  ✓ Simple index
+  ✓ Form input
+  ✓ Link traversal
+  ✗ Bad link traversal
+    Assert location failed: Excepted http://127.0.0.1:4567/not-correct, got http://127.0.0.1:4567/
+  ✗ Form input not equal
+    Assert first for selector #out did not meet expectations
+
+For test_ghostmore.coffee
+  ✓ Simple form
+  ◐ Form should do more things
+  ✓ Simple form with wait
+  ✓ Slow form
+  ✓ Before block var
+  ✗ This test will explode!
+    I hate you!
+
+7 success, 3 failure, 1 pending
+Stopping server

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ghostbuster
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Josh Hull
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-29 00:00:00 -07:00
+date: 2011-08-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,6 +97,7 @@ files:
 - Rakefile
 - bin/ghostbuster
 - bin/setup-ghostbuster
+- ghost/Ghostfile
 - ghost/config.ru
 - ghost/start.sh
 - ghost/stop.sh
@@ -108,12 +109,14 @@ files:
 - ghostbuster.gemspec
 - lib/ghostbuster.coffee
 - lib/ghostbuster.rb
+- lib/ghostbuster/config.rb
 - lib/ghostbuster/install_rake.rb
 - lib/ghostbuster/rake.rb
 - lib/ghostbuster/runner.rb
 - lib/ghostbuster/shell.rb
 - lib/ghostbuster/version.rb
 - log/thin.log
+- test/output
 has_rdoc: true
 homepage: https://github.com/joshbuddy/ghostbuster
 licenses: []
@@ -148,5 +151,5 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Integration testing ftw
-test_files: []
-
+test_files: 
+- test/output