konacha 1.4.1 → 1.4.2

data/History.md

@@ -1,5 +1,12 @@
 # master
 
+# 1.4.2
+
+* Update chai (1.1.1)
+* Improved error messaging (rake konacha:run)
+* Show pending specs in `konacha:run` output
+* Colored console output
+
 # 1.4.1
 
 * Fix performance regression in projects which have many assets

data/README.md

@@ -25,7 +25,7 @@ Add konacha to the `:test` and `:development` groups in the Gemfile and `bundle
 
 ```ruby
 group :test, :development do
-  gem "konacha"
+  gem 'konacha'
 end
 ```
 
@@ -70,23 +70,37 @@ describe "Array#sum", ->
 
 ## Running (Rake Tasks)
 
-### `rake konacha:serve`
+### In the Browser
 
-The `konacha:serve` rake task starts a server for your tests. You can go to the root
-page to run all specs (e.g. `http://localhost:3500/`), a sub page to run an individual
-spec file (e.g. `http://localhost:3500/array_sum_spec`), or a path to a subdirectory to
-run a subset of specs (e.g. `http://localhost:3500/models`).
+To start a server for your tests, type:
 
-### `rake konacha:run`
+```
+$ bundle exec rake konacha:serve
+```
+
+Then open [http://localhost:3500](http://localhost:3500) in your browser, and
+you will see all your tests running. You can also go to a sub-page to run an
+individual spec file (e.g. `http://localhost:3500/array_sum_spec`), or a path
+to a subdirectory to run a subset of specs (e.g.
+`http://localhost:3500/models`).
+
+This is the recommended mode for development, since you can simply hit refresh
+to reload all your test and asset files.
 
-The `konacha:run` rake task will let you run your tests from the command line.
+### Command-Line Runner
+
+To run your tests from the command line, type:
+
+```
+$ bundle exec rake konacha:run
+```
 
-To run individual specs, pass a comma seperated list of spec file names via the
-`SPEC` environment variable.
+To run individual specs, pass a comma seperated list of spec file names via
+the `SPEC` environment variable.
 
 ```
-$ rake konacha:run SPEC=foo_spec
-$ rake konacha:run SPEC=foo_spec,bar_spec,etc_spec
+$ bundle exec rake konacha:run SPEC=foo_spec
+$ bundle exec rake konacha:run SPEC=foo_spec,bar_spec,etc_spec
 ```
 
 ## Spec Helper

data/config/routes.rb

@@ -1,4 +1,4 @@
 Konacha::Engine.routes.draw do
-  match "/"     => "konacha/specs#specs"
-  match "*path" => "konacha/specs#specs"
+  match "/"     => "specs#specs"
+  match "*path" => "specs#specs"
 end

data/konacha.gemspec

@@ -17,12 +17,13 @@ the asset pipeline and engines.}
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "konacha"
   gem.require_paths = ["lib"]
-  gem.version       = "1.4.1"
+  gem.version       = "1.4.2"
 
   gem.add_dependency "railties", "~> 3.1"
   gem.add_dependency "actionpack", "~> 3.1"
   gem.add_dependency "sprockets"
   gem.add_dependency "capybara"
+  gem.add_dependency "colorize"
 
   gem.add_development_dependency "jquery-rails"
   gem.add_development_dependency "rspec-rails"

data/lib/assets/javascripts/konacha/runner.js

@@ -29,6 +29,15 @@ window.Konacha = {
         });
       });
 
+      runner.on('pending', function (test) {
+        Konacha.dots += "P";
+        Konacha.results.push({
+          name:test.title,
+          passed:false,
+          pending:true
+        });
+      });
+
       runner.on('end', function () {
         Konacha.done = true;
       });

data/lib/konacha/engine.rb

@@ -1,5 +1,9 @@
 module Konacha
   class Engine < Rails::Engine
+    # Do not mess up the application's namespace.
+    # http://api.rubyonrails.org/classes/Rails/Engine.html#label-Isolated+Engine
+    isolate_namespace Konacha
+
     config.konacha = ActiveSupport::OrderedOptions.new
 
     def self.application(app)
@@ -11,7 +15,7 @@ module Konacha
         end
 
         map "/" do
-          run Konacha::Engine
+          run Engine
         end
       end
     end

data/lib/konacha/runner.rb

@@ -1,4 +1,5 @@
 require "capybara"
+require "colorize"
 
 module Konacha
   class Runner
@@ -22,7 +23,7 @@ module Konacha
 
       seconds = "%.2f" % (Time.now - before)
       io.puts "Finished in #{seconds} seconds"
-      io.puts "#{examples.size} examples, #{failed_examples.size} failures"
+      io.puts "#{examples.size} examples, #{failed_examples.size} failures, #{pending_examples.size} pending"
       passed?
     end
 
@@ -30,8 +31,12 @@ module Konacha
       spec_runners.map { |spec_runner| spec_runner.examples }.flatten
     end
 
+    def pending_examples
+      examples.select { |example| example.pending? }
+    end
+
     def failed_examples
-      examples.select { |example| not example.passed? }
+      examples.select { |example| example.failed? }
     end
 
     def passed?
@@ -67,6 +72,18 @@ module Konacha
       runner.io
     end
 
+    def colorize_dots(dots)
+      dots = dots.chars.map do |d|
+        case d
+        when 'E', 'F'; d.red
+        when 'P'; d.yellow
+        when '.'; d.green
+        else;     d
+        end
+      end
+      dots.join ''
+    end
+
     def run
       session.visit(spec.url)
 
@@ -75,7 +92,7 @@ module Konacha
         sleep 0.1
         done, dots = session.evaluate_script('[Konacha.done, Konacha.dots]')
         if dots
-          io.write dots[dots_printed..-1]
+          io.write colorize_dots(dots[dots_printed..-1])
           io.flush
           dots_printed = dots.length
         end
@@ -85,7 +102,9 @@ module Konacha
         Example.new(row)
       end
     rescue => e
-      raise Konacha::Error, "Error communicating with browser process: #{e.inspect}"
+      msg = [e.inspect]
+      msg << e.message unless e.message.blank?
+      raise Konacha::Error, "Error communicating with browser process:\n#{msg.join("\n")}"
     end
   end
 
@@ -98,13 +117,23 @@ module Konacha
       @row['passed']
     end
 
+    def pending?
+      @row['pending']
+    end
+
+    def failed?
+      !(@row['passed'] || @row['pending'])
+    end
+
     def failure_message
-      unless passed?
+      if failed?
         msg = []
         msg << "  Failed: #{@row['name']}"
         msg << "    #{@row['message']}"
         msg << "    in #{@row['trace']['fileName']}:#{@row['trace']['lineNumber']}" if @row['trace']
-        msg.join("\n")
+        msg.join("\n").red
+      elsif pending?
+        "  Pending: #{@row['name']}".yellow
       end
     end
   end

data/spec/dummy/spec/javascripts/pending_spec.js

@@ -0,0 +1,3 @@
+describe("pending test", function(){
+  it("is pending");
+});

data/spec/runner_spec.rb

@@ -15,12 +15,17 @@ describe Konacha::Runner do
     it "prints results to the output" do
       buffer.rewind
       results = buffer.read
+      # Strip colors
+      results.gsub!(/\e\[([0-9]{1,2}(;[0-9]{1,2})*)?[m|K]/, '')
       # Failure output present?
       results.should include 'F'
       results.should include 'expected 4 to equal 5'
+      # Pending output present?
+      results.should include 'P'
+      results.should include 'is pending'
       # Summary and dots
-      results.should include "#{runner.examples.length} examples, 1 failure"
-      results.should match /^[.F]{#{runner.examples.length}}$/
+      results.should include "#{runner.examples.length} examples, 1 failures, 1 pending"
+      results.should match /^[.FP]{#{runner.examples.length}}$/
     end
   end
 end