evergreen 0.1 → 0.2.0

data/README.rdoc

@@ -1,4 +1,102 @@
-Evergreen
-=========
+= Evergreen
 
-Evergreen glues together some pieces to simplify JavaScript unit testing in Rails3 applications.
+"Because green is the new Blue(Ridge)"
+
+Evergreen is a tool to run javascript unit tests for client side JavaScript. It combines a runner which allows you to serve up and run your specs in a browser, as well as a headless runner based on envjs. Evergreen uses the Jasmine unit testing framework for JavaScript.
+
+http://github.com/jnicklas/evergreen
+
+== Philosophy
+
+Evergreen is a unit testing tool. It's purpose is to test JavaScript in isolation from your application. If you need a tool that tests how your JavaScript integrates with your application you should use an integration testing framework, such as {Capybara}[http://github.com/jnicklas/capybara].
+
+== Installation
+
+Install as a Ruby gem:
+
+    gem install evergreen
+
+== Usage
+
+Evergreen assumes a file and directory structure, place all your javascript code inside ./public and all spec files inside ./spec/javascripts. All spec files should end in _spec.js. For example:
+
+    public/widget.js
+    spec/javascripts/widget_spec.js
+
+You can require files from the public directory inside your spec file:
+
+    require('/widget.js')
+
+    describe('a widget', function() {
+      ...
+    });
+
+You can now look at your spec files inside a browser by starting up the Evergreen server:
+
+    evergreen server
+
+Alternatively you can run the specs headlessly by running:
+
+    evergreen run
+
+
+== Integrating with Rails 3
+
+Add Evergreen to your Gemfile:
+
+    gem 'evergreen', :require => 'evergreen/rails'
+
+Start your rails application and navigate to /evergreen/list. You should now see a list of all spec files, click on one to run it.
+
+There's a rake task provided for you that you can use to run your specs:
+
+    rake spec:javascripts
+
+== Transactions
+
+One problem often faced when writing unit tests for client side code is that changes to the page are not reverted for the next example, so that successive examples become dependent on each other. Evergreen adds a special div to your page with an id of test. This div is automatically emptied before each example. You should avoid appending markup to the page body and instead append it to this test div:
+
+    describe('transactions', function() {
+      it("should add stuff in one test...", function() {
+        $('#test').append('<h1 id="added">New Stuff</h1>');
+        expect($('#test h1#added').length).toEqual(1);
+      });
+
+      it("... should have been removed before the next starts", function() {
+        expect($('#test h1#added').length).toEqual(0);
+      });
+    });
+
+== Templates
+
+Even more powerful than that, Evergreen allows you to create HTML templates to go along with your specs. Simply name the template the same as the spec, only with an html extension. For example:
+
+      spec/javascripts/widget_spec.js
+      spec/javascripts/widget_spec.html
+
+The template will be placed inside the test div, so that means it should not include html, head, body or similar tags. The template will be restored for each example, so that at the start of each example, the markup inside the test div is identical.
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2009 Jonas Nicklas
+
+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/bin/evergreen

@@ -6,8 +6,8 @@ require 'evergreen'
 
 begin
   # The dup is to keep ARGV intact, so that tools like ruby-debug can respawn.
-  failure = Evergreen::Cli.execute(ARGV.dup)
-  Kernel.exit(failure ? 1 : 0)
+  success = Evergreen::Cli.execute(ARGV.dup)
+  Kernel.exit(success ? 0 : 1)
 rescue SystemExit => e
   Kernel.exit(e.status)
 rescue Exception => e

data/lib/evergreen.rb

@@ -5,6 +5,7 @@ require 'capybara/envjs'
 require 'capybara/wait_until'
 require 'launchy'
 require 'evergreen/version'
+require 'json'
 
 module Evergreen
   autoload :Cli, 'evergreen/cli'
@@ -24,17 +25,28 @@ module Evergreen
           use Rack::Static, :urls => ["/lib"], :root => File.expand_path('jasmine', File.dirname(__FILE__))
           use Rack::Static, :urls => ["/evergreen"], :root => File.dirname(__FILE__)
 
+          helpers do
+            def url(path)
+              request.env['SCRIPT_NAME'].to_s + path.to_s
+            end
+          end
+
           get '/' do
             @specs = Spec.all(root)
             erb :list
           end
 
-          get '/run/:name' do |name|
+          get '/list' do
+            @specs = Spec.all(root)
+            erb :list
+          end
+
+          get '/run/*' do |name|
             @spec = Spec.new(root, name)
             erb :spec
           end
 
-          get '/spec/:name.js' do |name|
+          get '/spec/*' do |name|
             Spec.new(root, name).read
           end
         end

data/lib/evergreen/evergreen.js

@@ -1,3 +1,26 @@
+var Evergreen = {};
+
+Evergreen.ReflectiveReporter = function() {
+  this.reportRunnerStarting = function(runner) {
+    jasmine.results = [];
+  };
+  this.reportSpecResults = function(spec) {
+    var results = spec.results();
+    var item = results.getItems()[0] || {};
+    jasmine.results.push({
+      name: spec.getFullName(),
+      passed: results.failedCount === 0,
+      message: item.message,
+      trace: item.trace
+    });
+  };
+}
+
+beforeEach(function() {
+  var test = document.getElementById('test');
+  test.innerHTML = Evergreen.template;
+});
+
 var require = function(file) {
   document.write('<script type="text/javascript" src="' + file + '"></script>');
 };

data/lib/evergreen/rails.rb

@@ -0,0 +1,8 @@
+require 'evergreen'
+require 'rails'
+
+module Evergreen
+  class Railtie < Rails::Engine
+  end
+end
+

data/lib/evergreen/runner.rb

@@ -2,44 +2,51 @@ module Evergreen
   class Runner
     attr_reader :spec
 
-    def self.run(root)
+    def self.run(root, io=STDOUT)
       runners = Spec.all(root).map { |spec| new(spec) }
       runners.each do |runner|
         if runner.passed?
-          print '.'
+          io.print '.'
         else
-          print 'F'
+          io.print 'F'
         end
       end
-      puts ""
+      io.puts ""
 
       runners.each do |runner|
-        puts runner.failure_message unless runner.passed?
+        io.puts runner.failure_message unless runner.passed?
       end
+      runners.all? { |runner| runner.passed? }
     end
 
     def initialize(spec)
       @spec = spec
     end
 
-    def passed?
-      failed_examples.empty?
+    def name
+      spec.name
     end
 
-    def failed_examples
-      results.select { |row| !row.passed }
+    def passed?
+      failed_examples.empty?
     end
 
     def failure_message
       failed_examples.map do |row|
-        <<-ERROR
-  Failed: #{row.name}
-      #{row.message}
-      in #{row.trace.fileName}:#{row.trace.lineNumber}
-        ERROR
+        msg = []
+        msg << "  Failed: #{row.name}"
+        msg << "    #{row.message}"
+        msg << "    in #{row.trace.fileName}:#{row.trace.lineNumber}" if row.trace.respond_to?(:fileName)
+        msg.join("\n")
       end.join("\n\n")
     end
 
+  protected
+
+    def failed_examples
+      results.select { |row| !row.passed }
+    end
+
     def results
       @results ||= begin
         session = Capybara::Session.new(:envjs, Evergreen.application(spec.root))

data/lib/evergreen/spec.rb

@@ -3,7 +3,7 @@ module Evergreen
 
     def self.all(root)
       Dir.glob(File.join(root, 'spec/javascripts', '*_spec.js')).map do |path|
-        new(root, File.basename(path).sub(/_spec\.js$/, ''))
+        new(root, File.basename(path))
       end
     end
 
@@ -14,47 +14,26 @@ module Evergreen
       @name = name
     end
 
-    def path
-      File.join(root, 'spec/javascripts', name + '_spec.js')
+    def full_path
+      File.join(root, 'spec/javascripts', name)
     end
 
-    def read
-      File.read(path)
+    def template_path
+      full_path.sub(/\..+$/, '.html')
     end
 
-    def url
-      "/run/#{name}"
+    def template
+      if File.exist?(template_path) then File.read(template_path) else "" end
     end
 
-    def passed?
-      run unless has_run?
-      results.all? { |row| row.passed }
-    end
-
-    def failure_message
-      run unless has_run?
-      results.each do |row|
-        puts "Failed: #{row.name}"
-        puts "    #{row.message}"
-        puts "    in #{row.trace.fileName}:#{row.trace.lineNumber}"
-        puts ""
-        puts ""
-      end
-    end
-
-  protected
-
-    def run
-      session.visit(url)
-      @results = session.evaluate_script('jasmine.results')
+    def read
+      File.read(full_path)
     end
+    alias_method :contents, :read
 
-    def has_run?
-      @results
+    def url
+      "/run/#{name}"
     end
 
-    def session
-      @session ||= Capybara::Session.new(:envjs, Evergreen.applications(root))
-    end
   end
 end

data/lib/evergreen/version.rb

@@ -1,3 +1,3 @@
 module Evergreen
-  VERSION = '0.1'
+  VERSION = '0.2.0'
 end

data/lib/evergreen/views/list.erb

@@ -1,6 +1,6 @@
 <h1>JS Specs</h1>
 
 <% @specs.each do |spec| %>
-  <p><a href="<%= spec.url %>"><%= spec.name %></a></p>
+  <p><a href="<%= url(spec.url) %>"><%= spec.name %></a></p>
 <% end %>
 

data/lib/evergreen/views/spec.erb

@@ -2,34 +2,21 @@
 
 <html>
   <head>
-    <link rel="stylesheet" type="text/css" href="/lib/jasmine.css">
-    <script src="/lib/jasmine-0.10.4.js" type="text/javascript"></script>
-    <script type="text/javascript" src="/lib/TrivialReporter.js"></script>
-    <script type="text/javascript" src="/lib/consolex.js"></script>
-    <script type="text/javascript" src="/evergreen/evergreen.js"></script>
-    <script src="/spec/<%= @spec.name %>.js" type="text/javascript"></script>
+    <link rel="stylesheet" type="text/css" href="<%= url('/lib/jasmine.css') %>">
+    <script type="text/javascript" src="<%= url("/lib/jasmine.js") %>"></script>
+    <script type="text/javascript" src="<%= url("/lib/jasmine-html.js") %>"></script>
+    <script type="text/javascript" src="<%= url("/evergreen/evergreen.js") %>"></script>
+    <script type="text/javascript" src="<%= url("/spec/#{@spec.name}") %>"></script>
   </head>
   <body>
+    <div id="test">
+    </div>
     <script type="text/javascript">
       (function() {
+        Evergreen.template = <%= @spec.template.to_json %>;
         var jasmineEnv = jasmine.getEnv();
         jasmineEnv.addReporter(new jasmine.TrivialReporter());
-        jasmineEnv.addReporter({
-          reportRunnerStarting: function(runner) {
-            jasmine.results = []
-          }, 
-          reportSpecResults: function(spec) {
-            var results = spec.results();
-            var item = results.getItems()[0] || {};
-            jasmine.results.push({
-              name: spec.getFullName(),
-              passed: results.failedCount === 0,
-              message: item.message,
-              trace: item.trace
-            });
-          }
-        });
-
+        jasmineEnv.addReporter(new Evergreen.ReflectiveReporter());
         jasmineEnv.execute();
       })();
     </script>

data/lib/jasmine/README.markdown

@@ -1,4 +1,4 @@
-Jasmine
+[Jasmine](http://pivotal.github.com/jasmine)
 =======
 **A JavaScript Testing Framework**
 
@@ -6,27 +6,14 @@ Quick Start
 ----------
 
 1. Get the latest release from the [downloads page](http://github.com/pivotal/jasmine/downloads).
-2. Open `example/example_runner.html` in your favorite browser.
+2. Open `SpecRunner.html` in your favorite browser.
 
 For running within a Ruby environment, including automated execution with Selenium, please use
-the [jasmine-ruby gem](http://github.com/pivotal/jasmine-ruby).
-
-Releases
-----------
-0.10.0 [[download]](http://cloud.github.com/downloads/pivotal/jasmine/jasmine-0.10.0.zip)
-
-0.9.0 [[download]](http://github.com/pivotal/jasmine/zipball/0.9.0)
-
-0.8.0 [[download]](http://github.com/pivotal/jasmine/zipball/0.8.0)
+the [jasmine gem](http://github.com/pivotal/jasmine-gem).
 
 ### Which Release Should I Use?
 
-Please use the latest version unless you have a good reason not to. Some of this documentation may not be applicable to older versions.
-
-Pull Requests
-----------
-We welcome your contributions! Jasmine is currently maintained by Davis Frank ([infews](http://github.com/infews)), Rajan Agaskar ([ragaskar](http://github.com/ragaskar)), and Christian Williams ([Xian](http://github.com/Xian)). You can help us by removing all other recipients from your pull request.
-
+Please use the latest version unless you have a good reason not to. Some of this documentation may not be applicable to older versions. Please see [[Release Notes]](http://wiki.github.com/pivotal/jasmine/release-notes) for change information.
 
 Why Another JavaScript TDD/BDD Framework?
 -----------
@@ -304,14 +291,14 @@ Here are a few examples:
       spyOn(Klass, 'method');
       Klass.method('foo argument');
 
-      expect(Klass.method).wasCalledWith('foo argument');
+      expect(Klass.method).toHaveBeenCalledWith('foo argument');
     });
 
     it('should spy on Klass#methodWithCallback') {
       var callback = Jasmine.createSpy();
       Klass.methodWithCallback(callback);
 
-      expect(callback).wasCalledWith('foo');
+      expect(callback).toHaveBeenCalledWith('foo');
     });
 
 
@@ -331,23 +318,25 @@ Spies can be very useful for testing AJAX or other asynchronous behaviors that t
       var callback = Jasmine.createSpy();
 
       Klass.asyncMethod(callback);
-      expect(callback).wasNotCalled();
+      expect(callback).not.toHaveBeenCalled();
 
       var someResponseData = 'foo';
       Klass.asyncMethod.mostRecentCall.args[0](someResponseData);
-      expect(callback).wasCalledWith(someResponseData);
+      expect(callback).toHaveBeenCalledWith(someResponseData);
 
     });
 
 There are spy-specfic matchers that are very handy.
 
-`expect(x).wasCalled()` passes if `x` is a spy and was called
+`expect(x).toHaveBeenCalled()` passes if `x` is a spy and was called
+
+`expect(x).toHaveBeenCalledWith(arguments)` passes if `x` is a spy and was called with the specified arguments
 
-`expect(x).wasCalledWith(arguments)` passes if `x` is a spy and was called with the specified arguments
+`expect(x).not.toHaveBeenCalled()` passes if `x` is a spy and was not called
 
-`expect(x).wasNotCalled()` passes if `x` is a spy and was not called
+`expect(x).not.toHaveBeenCalledWith(arguments)` passes if `x` is a spy and was not called with the specified arguments
 
-`expect(x).wasNotCalledWith(arguments)` passes if `x` is a spy and was not called with the specified arguments
+The old matchers `wasCalled`, `wasNotCalled`, `wasCalledWith`, and `wasNotCalledWith` have been deprecated and will be removed in a future release. Please change your specs to use `toHaveBeenCalled`, `not.toHaveBeenCalled`, `toHaveBeenCalledWith`, and `not.toHaveBeenCalledWith` respectively.
 
 Spies can be trained to respond in a variety of ways when invoked:
 
@@ -473,17 +462,21 @@ What's happening here?
 ## Support
 We now have a Google Group for support & discussion.
 
-* Homepage:  [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js)
+* Discussion: [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js)
 * Group email: [jasmine-js@googlegroups.com](jasmine-js@googlegroups.com)
 * Current build status of Jasmine is visible at [ci.pivotallabs.com](http://ci.pivotallabs.com)
+* Pivotal Tracker project: [http://www.pivotaltracker.com/projects/10606](http://www.pivotaltracker.com/projects/10606)
+* Twitter: [@JasmineBDD](http://twitter.com/JasmineBDD)
 
 ## Maintainers
-
 * [Davis W. Frank](mailto:dwfrank@pivotallabs.com), Pivotal Labs
 * [Rajan Agaskar](mailto:rajan@pivotallabs.com), Pivotal Labs
 * [Christian Williams](mailto:xian@pivotallabs.com), Pivotal Labs
 
+## Developers
+We welcome your contributions! Jasmine is currently maintained by Davis Frank ([infews](http://github.com/infews)), Rajan Agaskar ([ragaskar](http://github.com/ragaskar)), and Christian Williams ([Xian](http://github.com/Xian)). You can help us by removing all other recipients from your pull request.
+
 ## Acknowledgments
 * A big shout out to the various JavaScript test framework authors, especially TJ for [JSpec](http://github.com/visionmedia/jspec/tree/master) - we played with it a bit before deciding that we really needed to roll our own.
 * Thanks to Pivot [Jessica Miller](http://www.jessicamillerworks.com/) for our fancy pass/fail/pending icons
-* Huge contributions have been made by [Erik Hanson](mailto:erik@pivotallabs.com), [Adam Abrons](mailto:adam@pivotallabs.com) and [Carl Jackson](mailto:carl@pivotallabs.com), and many other Pivots.
+* Huge contributions have been made by [Adam Abrons](mailto:adam@pivotallabs.com), [Lee Byrd](mailto:lee@pivotallabs.com), [Erik Hanson](mailto:erik@pivotallabs.com), [Carl Jackson](mailto:carl@pivotallabs.com), and many other Pivots.