RubyGems - konacha - Versions diffs - 2.0.0.beta2 → 2.0.0.beta3 - Mend

konacha 2.0.0.beta2 → 2.0.0.beta3

Files changed (24) hide show

data/History.md +4 -2
data/LICENSE +25 -0
data/README.md +24 -2
data/app/assets/javascripts/konacha/parent.js +2 -1
data/app/assets/javascripts/konacha/runner.js +48 -23
data/konacha.gemspec +1 -1
data/lib/konacha.rb +2 -0
data/lib/konacha/engine.rb +1 -0
data/lib/konacha/formatter.rb +80 -0
data/lib/konacha/reporter.rb +91 -0
data/lib/konacha/reporter/example.rb +34 -0
data/lib/konacha/reporter/example_group.rb +37 -0
data/lib/konacha/reporter/metadata.rb +81 -0
data/lib/konacha/runner.rb +24 -78
data/spec/formatter_spec.rb +69 -0
data/spec/reporter/example_group_spec.rb +64 -0
data/spec/reporter/example_spec.rb +77 -0
data/spec/reporter/metadata_spec.rb +68 -0
data/spec/reporter_spec.rb +112 -0
data/spec/runner_spec.rb +88 -19
data/vendor/assets/javascripts/chai.js +121 -62
data/vendor/assets/javascripts/mocha.js +64 -17
data/vendor/assets/stylesheets/mocha.css +4 -0
metadata +21 -3

data/History.md CHANGED

@@ -1,9 +1,11 @@
 # master
-* Run tests in an iframe, with `<body id="konacha">`
+* Run tests in an iframe, with `<body id="konacha">`. Each test file is run in
+  isolation.
 * Removed support for konacha_config.js and Konacha.mochaOptions in favor of
   Mocha's own configuration methods. See the README for update instructions.
-* Update mocha (1.5.0)
+* Update mocha (1.6.0) and chai (1.3.0)
+* Adopt the RSpec reporter interface
 # 1.x-stable

data/LICENSE CHANGED

@@ -88,3 +88,28 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+Portions derived from RSpec (https://github.com/rspec/rspec-core)
+Copyright (c) 2009 Chad Humphries, David Chelimsky
+Copyright (c) 2006 David Chelimsky, The RSpec Development Team
+Copyright (c) 2005 Steven Baker
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md CHANGED

@@ -112,6 +112,23 @@ $ bundle exec rake konacha:run SPEC=foo_spec
 $ bundle exec rake konacha:run SPEC=foo_spec,bar_spec,etc_spec
 ```
+Konacha includes a default formatter modeled upon RSpec's ProgressFormatter.
+Additionally, Konacha's runner implements the same protocol as RSpec, so many
+RSpec formatters also work with Konacha.
+To specify one or more formatters, provide a comma separated list of class names
+in the `FORMAT` environment variable. For example, you can run both Ruby and JavaScript
+specs with CI integration using [ci_reporter](https://github.com/nicksieger/ci_reporter):
+```
+$ bundle exec rake ci:setup:rspec spec konacha:run FORMAT=CI::Reporter::RSpec
+```
+You will need to `require` any formatters you use. It's a good idea to do this
+within a `defined?` check in your [Konacha initializer](#configuration).
+To automatically trigger reruns when files change, try [guard-konacha](https://github.com/alexgb/guard-konacha).
 ## Spec Helper
 Since Konacha integrates with the asset pipeline, using setup helpers in your specs is
@@ -232,8 +249,13 @@ describe("templating", function() {
 As of Konacha 2.0, each test file is run inside an isolated iframe. For
 compatibility with Konacha 1.x, the iframe's `<body>` element will have
-`id="konacha"` set on it. If your specs are already self-contained, you may be
-able to upgrade without any changes to your test code.
+`id="konacha"` set on it.
+Previously, all test files would run in the same environment. Thus, if only
+one test file pulled in an external library, all tests would be able to use
+it. Now test files are run in isolation. If you encounter an undefined
+JavaScript module in your test, you may be missing an explicit `//= require`
+call somewhere.
 ### Options

data/app/assets/javascripts/konacha/parent.js CHANGED

@@ -4,7 +4,8 @@ window.onload = function () {
     if (!iframes[i].contentWindow.mocha) {
       (function (path) {
         mocha.suite.addTest(new Mocha.Test(path, function () {
-          throw new Error("Failed to load " + path + ". Perhaps it failed to compile?");
+          throw new Error("Failed to load " + path + ".\n" +
+                          "Perhaps it failed to compile? Check the rake output for errors.");
         }));
       })(iframes[i].getAttribute("data-path"));
     }

data/app/assets/javascripts/konacha/runner.js CHANGED

@@ -1,45 +1,70 @@
 Konacha = {
-  dots: "",
-  getResults: function() {
-    return JSON.stringify(Konacha.results);
+  getEvents: function() {
+    return JSON.stringify(Konacha.events);
   }
 };
 mocha.reporter(function(runner) {
+  var createTestObject = function(test, status) {
+    var obj = {
+      title:test.title,
+      fullTitle:test.fullTitle(),
+      duration:test.duration,
+      parentFullTitle:test.parent.fullTitle(),
+      status:status
+    };
+    if (status == "failed")
+      obj.error = test.err; // Contains message, expected, actual, operator, stack
+    return obj;
+  };
+  var createSuiteObject = function(suite) {
+    var obj = {
+      title:suite.title,
+      fullTitle:suite.fullTitle()
+    };
+    if (suite.parent)
+      obj.parentFullTitle = suite.parent.fullTitle();
+    return obj;
+  };
   Mocha.reporters.Base.call(this, runner);
   runner.on('start', function() {
-    Konacha.results = [];
+    Konacha.events = [];
+  });
+  runner.on('suite', function(suite) {
+    if (suite.fullTitle() && suite.fullTitle().length > 0)
+      Konacha.events.push({event:'suite', data:createSuiteObject(suite), type:'suite'});
+  });
+  runner.on('test', function(test) {
+    Konacha.events.push({event:'test', data:createTestObject(test), type:'test'});
   });
   runner.on('pass', function(test) {
-    Konacha.dots += ".";
-    Konacha.results.push({
-      name:test.title,
-      passed:true
-    });
+    Konacha.events.push({event:'pass', data:createTestObject(test, "passed"), type:'test'});
   });
   runner.on('fail', function(test) {
-    Konacha.dots += "F";
-    Konacha.results.push({
-      name:test.title,
-      passed:false,
-      message:test.err.message,
-      trace:test.err.stack
-    });
+    Konacha.events.push({event:'fail', data:createTestObject(test, "failed"), type:'test'});
   });
   runner.on('pending', function(test) {
-    Konacha.dots += "P";
-    Konacha.results.push({
-      name:test.title,
-      passed:false,
-      pending:true
-    });
+    Konacha.events.push({event:'pending', data:createTestObject(test, "pending"), type:'test'});
+  });
+  runner.on('suite end', function(suite) {
+    if (suite.fullTitle() && suite.fullTitle().length > 0)
+      Konacha.events.push({event:'suite end', data:createSuiteObject(suite), type:'suite'});
   });
   runner.on('end', function() {
-    Konacha.done = true;
+    Konacha.events.push({event:'end', data:{}});
   });
 });

data/konacha.gemspec CHANGED

@@ -17,7 +17,7 @@ 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       = "2.0.0.beta2"
+  gem.version       = "2.0.0.beta3"
   gem.add_dependency "railties", "~> 3.1"
   gem.add_dependency "actionpack", "~> 3.1"

data/lib/konacha.rb CHANGED

@@ -2,6 +2,8 @@ require "tilt"
 require "konacha/engine"
 require "konacha/runner"
 require "konacha/server"
+require "konacha/reporter"
+require "konacha/formatter"
 module Konacha
   class << self

data/lib/konacha/engine.rb CHANGED

@@ -32,6 +32,7 @@ module Konacha
       options.application ||= self.class.application(app)
       options.driver      ||= :selenium
       options.stylesheets ||= %w(application)
+      options.verbose     ||= false
       app.config.assets.paths << app.root.join(options.spec_dir).to_s
     end

data/lib/konacha/formatter.rb ADDED

@@ -0,0 +1,80 @@
+require "colorize"
+module Konacha
+  class Formatter
+    attr_reader :io, :examples
+    def initialize(io)
+      @io = io
+      @examples = []
+    end
+    def start(expected_example_count=nil); end
+    def example_group_started(group); end
+    def example_started(example); end
+    def example_passed(example)
+      @examples << example
+      io.write(".".green)
+    end
+    def example_failed(example)
+      @examples << example
+      io.write("F".red)
+    end
+    def example_pending(example)
+      @examples << example
+      io.write("P".yellow)
+    end
+    def example_group_finished(group); end
+    def stop; end
+    def start_dump
+      io.puts ""
+    end
+    def dump_pending
+      pending_examples = examples.select(&:pending?)
+      if pending_examples.present?
+        io.puts ""
+        io.puts(pending_examples.map {|example| pending_message(example)}.join("\n\n"))
+      end
+    end
+    def dump_failures
+      failed_examples = examples.select(&:failed?)
+      if failed_examples.present?
+        io.puts ""
+        io.puts(failed_examples.map {|example| failure_message(example)}.join("\n\n"))
+      end
+    end
+    def dump_summary(duration, example_count, failure_count, pending_count)
+      seconds = "%.2f" % duration
+      io.puts ""
+      io.puts "Finished in #{seconds} seconds"
+      io.puts "#{example_count} examples, #{failure_count} failed, #{pending_count} pending"
+    end
+    def seed(seed); end
+    def close
+      io.close if IO === io && io != $stdout
+    end
+    private
+    def failure_message(example)
+      msg = []
+      msg << "  Failed: #{example.full_description}"
+      msg << "    #{example.exception.message}"
+      msg << "    in #{example.exception.backtrace.first}" if example.exception.backtrace.present?
+      msg.join("\n").red
+    end
+    def pending_message(example)
+      "  Pending: #{example.full_description}".yellow
+    end
+  end
+end

data/lib/konacha/reporter.rb ADDED

@@ -0,0 +1,91 @@
+require "konacha/reporter/example"
+require "konacha/reporter/example_group"
+# The Konacha Reporter implements the same protocol as the RSpec Reporter.
+# More details on the RSpec Reporter protocol are available in the rspec-core
+# repository: https://github.com/rspec/rspec-core/blob/1852a7f4221c5731e108484cb2debfbaca60b283/lib/rspec/core/formatters/base_formatter.rb#L8-L25
+module Konacha
+  class Reporter
+    EVENT_CONVERSIONS = {
+      'suite'     => :example_group_started,
+      'test'      => :example_started,
+      'pass'      => :example_passed,
+      'fail'      => :example_failed,
+      'pending'   => :example_pending,
+      'suite end' => :example_group_finished,
+    }
+    attr_reader :start_time, :duration, :example_count, :failure_count, :pending_count
+    def initialize(*formatters)
+      @formatters = formatters
+      @example_count = @failure_count = @pending_count = 0
+      @duration = @start_time = nil
+      @examples, @groups = {}, {}
+    end
+    def start(expected_example_count=nil)
+      @start_time = Time.now
+      process_event :start, expected_example_count
+    end
+    def finish(seed=nil)
+      begin
+        stop
+        process_event :start_dump
+        process_event :dump_pending
+        process_event :dump_failures
+        process_event :dump_summary, @duration, @example_count, @failure_count, @pending_count
+        process_event :seed, seed if seed
+      ensure
+        process_event :close
+      end
+    end
+    def stop
+      @duration = Time.now - @start_time if @start_time
+      process_event :stop
+    end
+    def passed?
+      @examples.values.all? { |example| example.passed? || example.pending? }
+    end
+    def process_mocha_event(event)
+      if event['type']
+        object = update_or_create_object(event['data'], event['type'])
+        process_event EVENT_CONVERSIONS[event['event']], object
+      end
+    end
+    def process_event(method, *args, &block)
+      case method
+        when :example_started
+          @example_count += 1
+        when :example_failed
+          @failure_count += 1
+        when :example_pending
+          @pending_count += 1
+      end
+      @formatters.each do |formatter|
+        formatter.send method, *args, &block
+      end
+    end
+    def update_or_create_object(data, type)
+      collection = type == 'test' ? @examples : @groups
+      object = collection[data['fullTitle']]
+      if object
+        object.update_metadata(data)
+      else
+        klass  = type == 'test' ? Example : ExampleGroup
+        parent = @groups[data['parentFullTitle']]
+        object = collection[data['fullTitle']] = klass.new(data, parent)
+      end
+      object
+    end
+  end
+end

data/lib/konacha/reporter/example.rb ADDED

@@ -0,0 +1,34 @@
+require "konacha/reporter/metadata"
+# The Example class mimics the public interface of RSpec::Core::Example.
+module Konacha
+  class Reporter
+    class Example
+      attr_reader :metadata, :parent
+      def initialize(data, parent)
+        @metadata = Metadata.new(data)
+        @parent = parent
+      end
+      delegate :full_description, :description, :location, :file_path, :line_number, :pending, :pending_message, :exception, :execution_result, :to => :metadata
+      alias_method :pending?, :pending
+      alias_method :options, :metadata
+      alias_method :example_group, :parent
+      def passed?
+        execution_result[:status] == "passed"
+      end
+      def failed?
+        execution_result[:status] == "failed"
+      end
+      def update_metadata(data)
+        metadata.update(data)
+      end
+    end
+  end
+end

data/lib/konacha/reporter/example_group.rb ADDED

@@ -0,0 +1,37 @@
+require "konacha/reporter/metadata"
+# The ExampleGroup class mimics the public interface of RSpec::Core::ExampleGroup.
+module Konacha
+  class Reporter
+    class ExampleGroup
+      attr_reader :metadata, :parent
+      def initialize(data, parent)
+        @metadata = Metadata.new(data)
+        @parent = parent
+      end
+      delegate :full_description, :description, :file_path, :described_class, :to => :metadata
+      alias_method :display_name, :description
+      def parent_groups
+        ancestor = parent
+        groups = []
+        while ancestor
+          groups << ancestor
+          ancestor = ancestor.parent
+        end
+        groups
+      end
+      alias_method :ancestors, :parent_groups
+      def update_metadata(data)
+        metadata.update(data)
+      end
+    end
+  end
+end