danieldkim-evergreen 0.4.0.5

data/README.rdoc

@@ -0,0 +1,155 @@
+= Evergreen
+
+"Because green is the new Blue(Ridge)"
+
+Evergreen is a tool to run javascript unit tests for client side JavaScript. It combines a server which allows you to serve up and run your specs in a browser, as well as a runner which uses Capybara and any of its drivers to run your specs. Evergreen uses the Jasmine unit testing framework for JavaScript.
+
+http://github.com/jnicklas/evergreen
+
+== Philosophy
+
+Evergreen is a unit testing tool. Its 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 serve
+
+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. 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
+
+== Integrating with Rails 2
+
+Add the following line to your Rakefile:
+
+    require 'evergreen/tasks'
+
+This will give you the `spec:javascripts` rake task. Note that mounting is not possible under Rails 2 and that `require 'evergreen/rails'` will fail.
+
+== Configuration
+
+By default, Evergreen uses Selenium to run your specs and assumes a certain directory structure. If this standard is fine for you, then you don't need to do anything else. If you need to configure Evergreen to suit your needs, Evergreen will automatically look for and load the following files:
+
+    config/evergreen.rb
+    .evergreen
+    ~/.evergreen
+
+The content of these files could look like this:
+
+    require 'capybara/envjs'
+
+    Evergreen.configure do |config|
+      config.driver = :envjs
+      config.public_dir = 'public_html'
+      config.template_dir = 'templates'
+      config.spec_dir = 'spec'
+    end
+
+== 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. Put the templates in their own folder like this:
+
+    spec/javascripts/templates/one_template.html
+    spec/javascripts/templates/another_template.html
+
+You can then load the template into the test div, by calling the template function in your specs:
+
+    describe('transactions', function() {
+      template('one_template.html')
+
+      it("should load the template in this test", function() {
+        ...
+      });
+    });
+
+== Spec Helper
+
+If you add a spec_helper file like so:
+
+    spec/javascripts/spec_helper.js
+
+It will automatically be loaded. This is a great place for adding custom matchers and the like.
+
+== CoffeeScript
+
+Evergreen supports specs written in {CoffeeScript}[http://github.com/jashkenas/coffee-script]. Just name your spec file _spec.coffee and it will automatically be translated for you.
+
+You can also add a CoffeeScript spec helper, but remember that CoffeeScript encloses individual files in a closure, if you need something you define in the spec helper to be available in your spec files, attach it to the window object:
+
+    # spec/javascripts/spec_helper.coffee
+
+    MyThing: "foo"          # local to spec helper
+    window.MyThing: "foo"   # global
+
+== 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

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'evergreen'
+
+begin
+  # The dup is to keep ARGV intact, so that tools like ruby-debug can respawn.
+  success = Evergreen::Cli.execute(ARGV.dup)
+  Kernel.exit(success ? 0 : 1)
+rescue SystemExit => e
+  Kernel.exit(e.status)
+rescue Exception => e
+  STDERR.puts("#{e.message} (#{e.class})")
+  STDERR.puts(e.backtrace.join("\n"))
+  Kernel.exit(1)
+end
+

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  mount Evergreen.rails, :at => '/evergreen'
+end

data/lib/evergreen/application.rb

@@ -0,0 +1,46 @@
+module Evergreen
+  def self.application(suite)
+    Rack::Builder.new do
+      map "/jasmine" do
+        use Rack::Static, :urls => ["/"], :root => File.expand_path('../jasmine/lib', File.dirname(__FILE__))
+        run lambda { |env| [404, {}, "No such file"]}
+      end
+
+      map "/resources" do
+        use Rack::Static, :urls => ["/"], :root => File.expand_path('resources', File.dirname(__FILE__))
+        run lambda { |env| [404, {}, "No such file"]}
+      end
+
+      map "/" do
+        app = Class.new(Sinatra::Base).tap do |app|
+          app.reset!
+          app.class_eval do
+            set :static, true
+            set :root, File.expand_path('.', File.dirname(__FILE__))
+            set :public, File.expand_path(File.join(suite.root, Evergreen.public_dir), File.dirname(__FILE__))
+
+            helpers do
+              def url(path)
+                request.env['SCRIPT_NAME'].to_s + path.to_s
+              end
+            end
+
+            get '/' do
+              @suite = suite
+              erb :list
+            end
+
+            get '/run/*' do |name|
+              @suite = suite
+              @spec = suite.get_spec(name)
+              @js_spec_helper = suite.get_spec('spec_helper.js')
+              @coffee_spec_helper = suite.get_spec('spec_helper.coffee')
+              erb :spec
+            end
+          end
+        end
+        run app
+      end
+    end
+  end
+end

data/lib/evergreen/cli.rb

@@ -0,0 +1,23 @@
+module Evergreen
+  class Cli
+    def self.execute(argv)
+      new.execute(argv)
+    end
+
+    def execute(argv)
+      command = argv.shift
+      root    = File.expand_path(argv.shift || '.', Dir.pwd)
+
+      case command
+      when "serve"
+        Evergreen::Suite.new(root).serve
+        return true
+      when "run"
+        return Evergreen::Suite.new(root).run
+      else
+        puts "no such command '#{command}'"
+        return false
+      end
+    end
+  end
+end

data/lib/evergreen/rails.rb

@@ -0,0 +1,12 @@
+require 'evergreen'
+require 'rails'
+
+module Evergreen
+  def self.rails
+    Evergreen::Suite.new(Rails.root).application
+  end
+
+  class Railtie < Rails::Engine
+  end
+end
+

data/lib/evergreen/resources/evergreen.css

@@ -0,0 +1,64 @@
+body {
+  font-family: 'Lucida grande', 'sans-serif';
+  background: #f0f0f0;
+}
+
+a {
+  color: #00A500;
+}
+
+#page, #test, .jasmine_reporter {
+  width: 800px;
+  background: white;
+  -moz-border-radius: 3px;
+  padding: 20px;
+  margin: 50px auto 30px;
+  border: 1px solid #ddd
+}
+
+#test {
+  min-height: 50px;
+  max-height: 300px;
+  overflow: auto;
+  margin: 30px auto 30px;
+}
+
+.jasmine_reporter {
+  margin: 30px auto 30px;
+}
+
+#page h1 {
+  font-size: 24px;
+  margin: 0 0 15px;
+}
+
+#page a.back {
+  font-size: 12px;
+}
+
+#page ul {
+  margin: 0;
+  padding: 0;
+}
+
+#page ul li {
+  list-style: none;
+  border: 1px solid #ddd;
+  -moz-border-radius: 3px;
+  margin: 10px 0;
+  background: #f5f5f5;
+}
+
+#page ul li a {
+  padding: 7px 10px;
+  display: block;
+  text-decoration: none;
+}
+
+#footer {
+  margin: 0 auto 30px;
+  width: 600px;
+  text-align: center;
+  font-size: 13px;
+  color: #aaa;
+}

data/lib/evergreen/resources/evergreen.js

@@ -0,0 +1,80 @@
+if(!this.JSON){this.JSON={};}
+
+var Evergreen = {};
+
+Evergreen.dots = ""
+
+Evergreen.ReflectiveReporter = function() {
+  this.reportRunnerStarting = function(runner) {
+    Evergreen.results = [];
+  };
+  this.reportSpecResults = function(spec) {
+    var results = spec.results();
+    var item = results.getItems()[0] || {};
+    Evergreen.results.push({
+      name: spec.getFullName(),
+      passed: results.failedCount === 0,
+      message: item.message,
+      trace: item.trace
+    });
+    Evergreen.dots += (results.failedCount === 0) ? "." : "F";
+  };
+  this.reportRunnerResults = function(runner) {
+    Evergreen.done = true;
+  };
+};
+
+Evergreen.templates = {};
+
+Evergreen.getResults = function() {
+  return JSON.stringify(Evergreen.results);
+};
+
+beforeEach(function() {
+  document.getElementById('test').innerHTML = "";
+});
+
+var template = function(name) {
+  beforeEach(function() {
+    document.getElementById('test').innerHTML = Evergreen.templates[name]
+  });
+};
+
+var require = function(file) {
+  document.write('<script type="text/javascript" src="' + file + '"></script>');
+};
+
+var stylesheet = function(file) {
+  document.write('<link rel="stylesheet" type="text/css" href="' + file + '"/>');
+};
+
+// === JSON ===
+
+(function(){function f(n){return n<10?'0'+n:n;}
+if(typeof Date.prototype.toJSON!=='function'){Date.prototype.toJSON=function(key){return isFinite(this.valueOf())?this.getUTCFullYear()+'-'+
+f(this.getUTCMonth()+1)+'-'+
+f(this.getUTCDate())+'T'+
+f(this.getUTCHours())+':'+
+f(this.getUTCMinutes())+':'+
+f(this.getUTCSeconds())+'Z':null;};String.prototype.toJSON=Number.prototype.toJSON=Boolean.prototype.toJSON=function(key){return this.valueOf();};}
+var cx=/[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,escapable=/[\\\"\x00-\x1f\x7f-\x9f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,gap,indent,meta={'\b':'\\b','\t':'\\t','\n':'\\n','\f':'\\f','\r':'\\r','"':'\\"','\\':'\\\\'},rep;function quote(string){escapable.lastIndex=0;return escapable.test(string)?'"'+string.replace(escapable,function(a){var c=meta[a];return typeof c==='string'?c:'\\u'+('0000'+a.charCodeAt(0).toString(16)).slice(-4);})+'"':'"'+string+'"';}
+function str(key,holder){var i,k,v,length,mind=gap,partial,value=holder[key];if(value&&typeof value==='object'&&typeof value.toJSON==='function'){value=value.toJSON(key);}
+if(typeof rep==='function'){value=rep.call(holder,key,value);}
+switch(typeof value){case'string':return quote(value);case'number':return isFinite(value)?String(value):'null';case'boolean':case'null':return String(value);case'object':if(!value){return'null';}
+gap+=indent;partial=[];if(Object.prototype.toString.apply(value)==='[object Array]'){length=value.length;for(i=0;i<length;i+=1){partial[i]=str(i,value)||'null';}
+v=partial.length===0?'[]':gap?'[\n'+gap+
+partial.join(',\n'+gap)+'\n'+
+mind+']':'['+partial.join(',')+']';gap=mind;return v;}
+if(rep&&typeof rep==='object'){length=rep.length;for(i=0;i<length;i+=1){k=rep[i];if(typeof k==='string'){v=str(k,value);if(v){partial.push(quote(k)+(gap?': ':':')+v);}}}}else{for(k in value){if(Object.hasOwnProperty.call(value,k)){v=str(k,value);if(v){partial.push(quote(k)+(gap?': ':':')+v);}}}}
+v=partial.length===0?'{}':gap?'{\n'+gap+partial.join(',\n'+gap)+'\n'+
+mind+'}':'{'+partial.join(',')+'}';gap=mind;return v;}}
+if(typeof JSON.stringify!=='function'){JSON.stringify=function(value,replacer,space){var i;gap='';indent='';if(typeof space==='number'){for(i=0;i<space;i+=1){indent+=' ';}}else if(typeof space==='string'){indent=space;}
+rep=replacer;if(replacer&&typeof replacer!=='function'&&(typeof replacer!=='object'||typeof replacer.length!=='number')){throw new Error('JSON.stringify');}
+return str('',{'':value});};}
+if(typeof JSON.parse!=='function'){JSON.parse=function(text,reviver){var j;function walk(holder,key){var k,v,value=holder[key];if(value&&typeof value==='object'){for(k in value){if(Object.hasOwnProperty.call(value,k)){v=walk(value,k);if(v!==undefined){value[k]=v;}else{delete value[k];}}}}
+return reviver.call(holder,key,value);}
+text=String(text);cx.lastIndex=0;if(cx.test(text)){text=text.replace(cx,function(a){return'\\u'+
+('0000'+a.charCodeAt(0).toString(16)).slice(-4);});}
+if(/^[\],:{}\s]*$/.test(text.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,'@').replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,']').replace(/(?:^|:|,)(?:\s*\[)+/g,''))){j=eval('('+text+')');return typeof reviver==='function'?walk({'':j},''):j;}
+throw new SyntaxError('JSON.parse');};}}());
+

data/lib/evergreen/runner.rb

@@ -0,0 +1,151 @@
+module Evergreen
+  class Runner
+    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']}"
+          if @row['trace']['stack']
+            match_data = @row['trace']['stack'].match(/\/run\/(.*\.js)/)
+            msg << "    in #{match_data[1]}" if match_data[1]
+          end
+          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(180) do
+            dots = session.evaluate_script('Evergreen.dots')
+            io.print dots.sub(/^#{Regexp.escape(previous_results)}/, '')
+            io.flush
+            previous_results = dots
+            session.evaluate_script('Evergreen.done')
+          end
+
+          dots = session.evaluate_script('Evergreen.dots')
+          io.print dots.sub(/^#{Regexp.escape(previous_results)}/, '')
+
+          JSON.parse(session.evaluate_script('Evergreen.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
+
+    def initialize(suite, io=STDOUT)
+      @suite = suite
+      @io = io
+    end
+
+    def spec_runner(spec)
+      SpecRunner.new(self, spec)
+    end
+
+    def run
+      before = Time.now
+
+      io.puts ""
+      io.puts dots.to_s
+      io.puts ""
+      if failure_messages
+        io.puts failure_messages
+        io.puts ""
+      end
+
+      seconds = "%.2f" % (Time.now - before)
+      io.puts "Finished in #{seconds} seconds"
+      io.puts "#{examples.size} examples, #{failed_examples.size} failures"
+      passed?
+    end
+
+    def examples
+      spec_runners.map { |spec_runner| spec_runner.examples }.flatten
+    end
+
+    def failed_examples
+      examples.select { |example| not example.passed? }
+    end
+
+    def passed?
+      spec_runners.all? { |spec_runner| spec_runner.passed? }
+    end
+
+    def dots
+      spec_runners.map { |spec_runner| spec_runner.dots }.join
+    end
+
+    def failure_messages
+      unless passed?
+        spec_runners.map { |spec_runner| spec_runner.failure_messages }.compact.join("\n\n")
+      end
+    end
+
+    def session
+      @session ||= Capybara::Session.new(Evergreen.driver, suite.application)
+    end
+
+  protected
+
+    def spec_runners
+      @spec_runners ||= suite.specs.map { |spec| SpecRunner.new(self, spec) }
+    end
+  end
+end

data/lib/evergreen/server.rb

@@ -0,0 +1,22 @@
+module Evergreen
+  class Server
+    attr_reader :suite
+
+    def initialize(suite)
+      @suite = suite
+    end
+
+    def serve
+      server.boot
+      Launchy.open(server.url('/'))
+      sleep
+    end
+
+  protected
+
+    def server
+      @server ||= Capybara::Server.new(suite.application)
+    end
+  end
+end
+

data/lib/evergreen/spec.rb

@@ -0,0 +1,55 @@
+require 'open3'
+
+module Evergreen
+  class Spec
+    class CoffeeScriptError < StandardError; end
+
+    attr_reader :name, :suite
+
+    def initialize(suite, name)
+      @suite = suite
+      @name = name
+    end
+
+    def root
+      suite.root
+    end
+
+    def full_path
+      File.join(root, Evergreen.spec_dir, name)
+    end
+
+    def read
+      if full_path =~ /\.coffee$/
+        stdout, stderr = Open3.popen3("coffee -p #{full_path}")[1,2].map { |b| b.read }
+        raise CoffeeScriptError, stderr unless stderr.empty?
+        stdout
+      else
+        File.read(full_path)
+      end
+    end
+    alias_method :contents, :read
+
+    def url
+      "/run/#{name}"
+    end
+
+    def passed?
+      runner.passed?
+    end
+
+    def failure_messages
+      runner.failure_messages
+    end
+
+    def exist?
+      File.exist?(full_path)
+    end
+
+  protected
+
+    def runner
+      @runner ||= suite.runner.spec_runner(self)
+    end
+  end
+end

data/lib/evergreen/suite.rb

@@ -0,0 +1,44 @@
+module Evergreen
+  class Suite
+    attr_reader :root, :runner, :server, :driver, :application
+
+    def initialize(root)
+      @root = root
+
+      paths = [
+        File.expand_path("config/evergreen.rb", root),
+        File.expand_path(".evergreen", root),
+        "#{ENV["HOME"]}/.evergreen"
+      ]
+      paths.each { |path| load(path) if File.exist?(path) }
+
+      @runner = Runner.new(self)
+      @server = Server.new(self)
+      @application = Evergreen.application(self)
+    end
+
+    def run
+      runner.run
+    end
+
+    def serve
+      server.serve
+    end
+
+    def get_spec(name)
+      Spec.new(self, name)
+    end
+
+    def specs
+      Dir.glob(File.join(root, Evergreen.spec_dir, '*_spec.{js,coffee}')).map do |path|
+        Spec.new(self, File.basename(path))
+      end
+    end
+
+    def templates
+      Dir.glob(File.join(root, Evergreen.template_dir, '*')).map do |path|
+        Template.new(self, File.basename(path))
+      end
+    end
+  end
+end

data/lib/evergreen/tasks.rb

@@ -0,0 +1,6 @@
+require 'evergreen'
+
+Dir[File.join(File.dirname(__FILE__), '..', 'tasks', '*.rake')].each do |f|
+  load f
+end
+