konacha 0.10.0 → 1.0.0.rc1

data/Gemfile

@@ -1,7 +1,2 @@
 source 'https://rubygems.org'
 gemspec
-
-# This is a runtime dependency in the gemspec, so it shouldn't be necessary to
-# specify it again, but bundler is buggy:
-#  https://github.com/carlhuda/bundler/issues/1041
-gem "jquery-rails"

data/History.md

@@ -1,5 +1,15 @@
 # master
 
+# 1.0.0-rc1
+
+* Do not time out after 300 seconds
+* Rename #test div to #konacha
+* Update vendored copies of mocha (1.0.0+) and chai (0.5.2+)
+* jQuery is no longer included by default
+* Fully remove and replace the #konacha element (#23)
+* Remove the `interface` configuration option. A future version will support
+  all Mocha configuration options, but configuration will be done in JS, not Ruby.
+
 # 0.10.0
 
 * Rename `konacha:ci` and `konacha:server` task to `konacha:run` and

data/README.md

@@ -7,13 +7,15 @@ assertion library.
 [![Konacha][2]][1]
 
   [1]: http://en.wikipedia.org/wiki/Konacha
-  [2]: https://github.com/jfirebaugh/konacha/raw/master/vendor/assets/images/konacha.jpg
+  [2]: https://github.com/jfirebaugh/konacha/raw/master/vendor/images/konacha.jpg
 
 It is similar to [Jasmine](https://github.com/pivotal/jasmine-gem) and
 [Evergreen](https://github.com/jnicklas/evergreen), but does not attempt to be framework
 agnostic. By sticking with Rails, Konacha can take full advantage of features such as
 the asset pipeline and engines.
 
+Photo credit: [FCartegnie](http://commons.wikimedia.org/wiki/File:Konacha.jpg), CC-BY-SA.
+
 ## Installation
 
 Add konacha to the `:test` and `:development` groups in the Gemfile and `bundle install`:
@@ -61,7 +63,7 @@ page to run all specs (e.g. `http://localhost:3500/`), a sub page to run an indi
 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`).
 
-Alternatively, you can run the specs headlessly with the `konacha:run` task.
+Alternatively, you can run the specs in your shell with the `konacha:run` task.
 
 ## Spec Helper
 
@@ -94,15 +96,13 @@ Konacha can be configured in an initializer, e.g. `config/initializers/konacha.r
 
     Konacha.configure do |config|
       config.spec_dir  = "spec/javascripts"
-      config.interface = :bdd
       config.driver    = :selenium
     end if defined?(Konacha)
 
 The `defined?` check is necessary to avoid a dependency on Konacha in the production
 environment.
 
-The `spec_dir` option tells Konacha where to find JavaScript specs. The `interface`
-option specifies the test interface used by Mocha (see below). `driver` names a
+The `spec_dir` option tells Konacha where to find JavaScript specs. `driver` names a
 Capybara driver used for the `run` task (try `:webkit`, after installing
 [capybara-webkit](https://github.com/thoughtbot/capybara-webkit)).
 
@@ -111,16 +111,8 @@ The values above are the defaults.
 ## Test Interface and Assertions
 
 Konacha includes a vendored copy of mocha.js and the [chai](http://chaijs.com/)
-assertion libraries.
-
-By default, it will assume that you want to use Mocha's "BDD" test interface, which
+assertion libraries. It configures Mocha to use the "BDD" test interface, which
 provides `describe()`, `it()`, `before()`, `after()`, `beforeEach()`, and `afterEach()`.
-If you want to use the TDD, Exports, or QUnit interfaces instead, set the `interface`
-configuration option in an initializer:
-
-    Konacha.configure do |config|
-      config.interface = :tdd # Or :exports or :qunit
-    end if defined?(Konacha)
 
 Konacha will make all three of chai's assertion styles available to you: `expect`,
 `should`, and `assert`. See the chai documentation for the details.
@@ -144,9 +136,6 @@ to the page body and instead append it to this test div:
       it "... should have been removed before the next starts", ->
         $('#test h1#added').length.should.equal(0)
 
-Note: this functionality is available only for the "BDD" (default) and "TDD" mocha interfaces,
-and not for the "exports" or "QUnit" interfaces.
-
 ## Templates / Fixtures
 
 Konacha has no template (a.k.a. HTML fixture) support of its own. Instead, we suggest you use

data/app/views/konacha/specs/specs.html.erb

@@ -5,31 +5,34 @@
     <title>Konacha Tests</title>
     <%= stylesheet_link_tag "mocha",   :debug => false %>
     <%= stylesheet_link_tag "konacha", :debug => false %>
-    <%= javascript_include_tag "jquery", "mocha", "chai", "konacha/#{Konacha.mode}", :debug => false %>
+    <%= javascript_include_tag "mocha", "chai", "konacha/#{Konacha.mode}", :debug => false %>
     <script>
-      mocha.setup(<%= raw Konacha.interface.to_json %>);
+      mocha.setup({ui: "bdd", reporter: Konacha.Reporter});
+
+      beforeEach(function () {
+        var e = document.getElementById('konacha'),
+            p = e.parentNode;
+
+        p.removeChild(e);
+
+        e = document.createElement("div");
+        e.id = "konacha";
+
+        p.appendChild(e);
+      });
+
       var expect = chai.expect,
           should = chai.should(),
           assert = chai.assert;
 
       window.onload = function () {
-        mocha.run(Konacha.Reporter);
+        mocha.run();
       };
-
-      <% if Konacha.interface == :bdd %>
-        beforeEach(function() {
-          document.getElementById('test').innerHTML = "";
-        });
-      <% elsif Konacha.interface == :tdd %>
-        setup(function() {
-          document.getElementById('test').innerHTML = "";
-        });
-      <% end %>
     </script>
     <%= spec_include_tag *@specs %>
   </head>
   <body>
     <div id="mocha"></div>
-    <div id="test"></div>
+    <div id="konacha"></div>
   </body>
 </html>

data/konacha.gemspec

@@ -17,12 +17,12 @@ 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       = "0.10.0"
+  gem.version       = "1.0.0.rc1"
 
-  gem.add_dependency "jquery-rails"
   gem.add_dependency "rails", "~> 3.1"
   gem.add_dependency "capybara"
 
+  gem.add_development_dependency "jquery-rails"
   gem.add_development_dependency "rspec-rails"
   gem.add_development_dependency "capybara-firebug", "~> 1.1"
   gem.add_development_dependency "coffee-script"

data/lib/assets/stylesheets/konacha.css

@@ -0,0 +1,5 @@
+/* Keep #konacha div visible so we can test against element visibility */
+#konacha {
+  height: 0 ! important;
+  overflow: hidden ! important;
+}

data/lib/konacha.rb

@@ -7,7 +7,7 @@ module Konacha
     attr_accessor :mode
 
     def serve
-      puts "your tests are here:"
+      puts "Your tests are here:"
       puts "  http://localhost:#{port}/"
       self.mode = :server
       Konacha::Server.start
@@ -26,7 +26,7 @@ module Konacha
       yield config
     end
 
-    delegate :port, :spec_dir, :interface, :application, :driver, :to => :config
+    delegate :port, :spec_dir, :application, :driver, :to => :config
 
     def spec_root
       File.join(Rails.root, config.spec_dir)

data/lib/konacha/engine.rb

@@ -23,7 +23,6 @@ module Konacha
 
       options.spec_dir    ||= "spec/javascripts"
       options.port        ||= 3500
-      options.interface   ||= :bdd
       options.application ||= self.class.application(app)
       options.driver      ||= :selenium
 

data/lib/konacha/runner.rb

@@ -6,111 +6,19 @@ module Konacha
       new.run
     end
 
-    class Example
-      def initialize(row)
-        @row = row
-      end
-
-      def passed?
-        @row['passed']
-      end
-
-      def failure_message
-        unless passed?
-          msg = []
-          msg << "  Failed: #{@row['name']}"
-          msg << "    #{@row['message']}"
-          msg << "    in #{@row['trace']['fileName']}:#{@row['trace']['lineNumber']}" if @row['trace']
-          msg.join("\n")
-        end
-      end
-    end
-
-    class SpecRunner
-      attr_reader :runner, :spec
-
-      def initialize(runner, spec)
-        @runner = runner
-        @spec = spec
-      end
-
-      def session
-        runner.session
-      end
-
-      def io
-        runner.io
-      end
-
-      def run
-        io.puts dots
-        io.puts failure_messages
-        io.puts "\n#{examples.size} examples, #{failed_examples.size} failures"
-        passed?
-      end
-
-      def examples
-        @results ||= begin
-          session.visit(spec.url)
-
-          previous_results = ""
-
-          session.wait_until(300) do
-            dots = session.evaluate_script('Konacha.dots')
-            io.print dots.sub(/^#{Regexp.escape(previous_results)}/, '')
-            io.flush
-            previous_results = dots
-            session.evaluate_script('Konacha.done')
-          end
-
-          dots = session.evaluate_script('Konacha.dots')
-          io.print dots.sub(/^#{Regexp.escape(previous_results)}/, '')
-
-          JSON.parse(session.evaluate_script('Konacha.getResults()')).map do |row|
-            Example.new(row)
-          end
-        end
-      end
-
-      def failed_examples
-        examples.select { |example| not example.passed? }
-      end
-
-      def passed?
-        examples.all? { |example| example.passed? }
-      end
-
-      def dots
-        examples; ""
-      end
-
-      def failure_messages
-        unless passed?
-          examples.map { |example| example.failure_message }.compact.join("\n\n")
-        end
-      end
-    end
-
-    attr_reader :suite, :io
+    attr_reader :io
 
     def initialize(options = {})
       @io = options[:output] || STDOUT
     end
 
-    def spec_runner(spec)
-      SpecRunner.new(self, spec)
-    end
-
     def run
       before = Time.now
 
+      spec_runners.each { |spec_runner| spec_runner.run } # prints dots
       io.puts ""
-      io.puts dots.to_s
       io.puts ""
-      if failure_messages
-        io.puts failure_messages
-        io.puts ""
-      end
+      failure_messages.each { |msg| io.write("#{msg}\n\n") }
 
       seconds = "%.2f" % (Time.now - before)
       io.puts "Finished in #{seconds} seconds"
@@ -127,27 +35,73 @@ module Konacha
     end
 
     def passed?
-      spec_runners.all? { |spec_runner| spec_runner.passed? }
-    end
-
-    def dots
-      spec_runners.map { |spec_runner| spec_runner.dots }.join
+      examples.all? { |example| example.passed? }
     end
 
     def failure_messages
-      unless passed?
-        spec_runners.map { |spec_runner| spec_runner.failure_messages }.compact.join("\n\n")
-      end
+      examples.map { |example| example.failure_message }.compact
     end
 
     def session
       @session ||= Capybara::Session.new(Konacha.driver, Konacha.application)
     end
 
-  protected
-
     def spec_runners
       @spec_runners ||= Konacha::Spec.all.map { |spec| SpecRunner.new(self, spec) }
     end
   end
+
+  class SpecRunner
+    attr_reader :runner, :spec, :examples
+
+    def initialize(runner, spec)
+      @runner = runner
+      @spec = spec
+    end
+
+    def session
+      runner.session
+    end
+
+    def io
+      runner.io
+    end
+
+    def run
+      session.visit(spec.url)
+
+      dots_printed = 0
+      begin
+        sleep 0.1
+        done, dots = session.evaluate_script('[Konacha.done, Konacha.dots]')
+        io.write dots[dots_printed..-1]
+        io.flush
+        dots_printed = dots.length
+      end until done
+
+      @examples = JSON.parse(session.evaluate_script('Konacha.getResults()')).map do |row|
+        Example.new(row)
+      end
+    end
+  end
+
+  class Example
+    def initialize(row)
+      @row = row
+    end
+
+    def passed?
+      @row['passed']
+    end
+
+    def failure_message
+      unless passed?
+        msg = []
+        msg << "  Failed: #{@row['name']}"
+        msg << "    #{@row['message']}"
+        msg << "    in #{@row['trace']['fileName']}:#{@row['trace']['lineNumber']}" if @row['trace']
+        msg.join("\n")
+      end
+    end
+  end
 end

data/spec/dummy/spec/javascripts/templating_spec.js

@@ -1,8 +1,9 @@
 //= require spec_helper
+//= require jquery
 
 describe("templating", function(){
   it("is built in to Sprockets", function(){
-    $('#test').html(JST['templates/hello']());
-    $('#test h1').text().should.equal('Hello Konacha!');
+    $('#konacha').html(JST['templates/hello']());
+    $('#konacha h1').text().should.equal('Hello Konacha!');
   });
 });

data/spec/dummy/spec/javascripts/test_element_spec.js.coffee

@@ -1,10 +1,18 @@
-describe "the #test element", ->
+#= require jquery
+
+describe "the #konacha element", ->
   it "can have content added in one test...", ->
-    $('#test').append('<h1 id="added">New Stuff</h1>')
-    $('#test h1#added').length.should.equal(1)
+    $('#konacha').append('<h1 id="added">New Stuff</h1>')
+    $('#konacha h1#added').length.should.equal(1)
+
+  it "... that is removed before the next starts", ->
+    $('#konacha h1#added').length.should.equal(0)
+
+  it "can have an attribute added in one test...", ->
+    $('#konacha').addClass('test')
 
   it "... that is removed before the next starts", ->
-    $('#test h1#added').length.should.equal(0)
+    $('#konacha').hasClass('test').should.be.false;
 
   it "is visible", ->
-    $('#test').is(':visible').should.be.true
+    $('#konacha').is(':visible').should.be.true

data/spec/konacha_spec.rb

@@ -4,12 +4,6 @@ describe Konacha do
   describe ".config" do
     subject { Konacha.config }
 
-    describe ".interface" do
-      it "defaults to :bdd interface" do
-        subject.interface.should == :bdd
-      end
-    end
-
     describe ".spec_dir" do
       it "defaults to 'spec/javascripts'" do
         subject.spec_dir.should == "spec/javascripts"

data/spec/runner_spec.rb

@@ -15,27 +15,12 @@ describe Konacha::Runner do
     it "prints results to the output" do
       buffer.rewind
       results = buffer.read
-      # "should include" gives us nice multi-line error messages if there is
-      # more than one failure
-      results.should include 'examples, 1 failure'
       # Failure output present?
       results.should include 'F'
       results.should include 'expected 4 to equal 5'
-      # Enough examples run?
-      results.should match /[1-9][0-9]+ examples, 1 failure/
-    end
-  end
-
-  describe "#run_spec" do
-    let(:spec) { Konacha::Spec.find("failing_spec").first }
-    before { runner.spec_runner(spec).run }
-
-    it "prints results to the output" do
-      buffer.rewind
-      results = buffer.read
-      results.should include('F')
-      results.should include("expected 4 to equal 5")
-      results.should include("1 examples, 1 failures")
+      # Summary and dots
+      results.should include "#{runner.examples.length} examples, 1 failure"
+      results.should match /^[.F]{#{runner.examples.length}}$/
     end
   end
 end