qunit_for_rails 0.0.4

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.mdown

@@ -0,0 +1,103 @@
+QunitForRails
+=============
+
+QUnit for Rails provides an easy way to run JavaScript integration testing
+against production rendered HTML using the QUnit testing framework. 
+QUnit for Rails simply adds an overlay menu at the top of an app's pages, 
+allowing developers to run JavaScript tests and view the results right in the 
+browser. 
+
+To read more about QUnit:
+[http://docs.jquery.com/QUnit][]
+
+The source for this plugin is located on Github:
+[http://github.com/mkrisher/qunit_for_rails/][]
+
+The plugin can be installed using:
+`script/plugin install git@github.com:mkrisher/qunit_for_rails.git`
+
+Details
+=======
+
+QUnit for Rails provides an easy way for developers to write JavaScript tests 
+and run those tests against HTML output in the browser. QUnit for Rails does 
+not run via the command line, it is run in the browser against the real HTML 
+output. 
+
+QUnit for Rails provides some necessary JavaScript and CSS files and places 
+them in your app's public directory. These files simply create the overlay 
+menu that gets added to your pages. The plugin also provides the latest QUnit 
+file. In case you ever want to change the version of QUnit, you would simply 
+replace the file in your public/javascript directory.
+
+The overlay provides a number of things. First, all your JavaScript tests are 
+stored in /public/javascript/tests. Any JavaScript test added to the directory 
+will appear in a dropdown in the overlay. Simply selecting a test from the 
+dropdown runs it against the current page. Or there is an option to run all 
+tests against a page. 
+
+In much the same way Rails unit testing and functional testing work, you could 
+easily create a JavaScript test for each controller and action of your app.
+
+During the plugin install process, the tests directory is created and an 
+example test file is included. Follow the test file's formatting to create 
+additional tests. 
+ 
+The plugin also provides some handy keypress functionality. For example, hiding 
+the overlay you simply press 'shift+h'. All keypress options are 
+shown by press 'shift+?'.
+
+The QUnit overlay looks like this in the browser:
+
+[![](http://farm3.static.flickr.com/2603/4014493975_cfc0c2af3d_o.png)](http://farm3.static.flickr.com/2603/4014493975_cfc0c2af3d_o.png)
+
+Running a test pushes the page down and reveals the test results:
+
+[![](http://farm3.static.flickr.com/2464/4015257542_d6c759682f_o.png)](http://farm3.static.flickr.com/2464/4015257542_d6c759682f_o.png)
+
+Requirements
+=======
+
+The QUnit for Rails plugin requires jQuery at this time. You can include 
+jQuery easily by adding to the head of your document layout:
+
+    <script type="text/javascript" src="http://www.google.com/jsapi"></script>
+    <script type="text/javascript">
+        google.load("jquery", "1.3.2");
+    </script>
+
+
+Usage
+=====
+
+To include the QUnit testing overlay on your page simply add 
+`<%= include_qunit %>` to the head of your document layout.
+
+If you would like to include qunit_for_rails but not have it show on the top 
+of the page automatically, you can hide it on load using:
+`<%= include_qunit({:autohide => true}) %>`.
+
+After adding the `<%= include_qunit %>` to the head of your document layout, 
+you simply need to add some test files to the 
+`/public/javascript/tests directory`.
+
+The tests are written in JSON and follow a pattern such as:
+
+    var localtests = {
+        test_another_example : function()
+        {
+            module("Module Example Tests");
+            test("simple passing example", function() 
+            {
+                var value = "foo";
+                equals( "foo", value, "We expect value to be foo" );
+            });
+        }
+    };
+    $().extend(tests, localtests);
+
+
+Copyright (c) 2009 Michael Krisher, released under the MIT license
+
+[http://docs.jquery.com/QUnit]: http://docs.jquery.com/QUnit
+[http://github.com/mkrisher/qunit_for_rails/]: http://github.com/mkrisher/qunit_for_rails/

data/Rakefile

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+  require "bundler/gem_tasks"
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TestForRails'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/qunit_for_rails/qunit_tests_controller.rb

@@ -0,0 +1,19 @@
+module QunitForRails
+  class QunitTestsController < ApplicationController
+    skip_before_filter :authorize
+    layout "qunit_for_rails/main"
+    
+    def index
+      test_files = []
+      
+      Dir.glob(::Rails.root.to_s + "/public/javascripts/test/*").each { |file| 
+        if file.end_with?('_test.js')
+          test_files << file.split('/').last
+        end
+      }
+      
+      render :index, :locals => { :test_files => test_files, :root_url => ENV['RAILS_RELATIVE_URL_ROOT'] }
+    end
+
+  end
+end

data/app/views/layouts/qunit_for_rails/main.haml

@@ -0,0 +1,15 @@
+!!!
+%html
+  %head
+    %meta(http-equiv="Content-Type" content="text/html; charset=UTF-8")
+    = favicon_link_tag 'favicon.png'
+    
+    %title
+      = "QUnit Tests Index"
+ 
+    = yield :stylesheets
+
+    = yield :javascripts
+ 
+  %body
+    = yield :content

data/app/views/qunit_for_rails/qunit_tests/index.html.haml

@@ -0,0 +1,15 @@
+= content_for(:stylesheets) do
+  %link(rel="stylesheet" type="text/css" href="#{root_url}/stylesheets/qunit.css")
+  %link(rel="stylesheet" type="text/css" href="#{root_url}/stylesheets/qunit_for_rails.css")
+
+= content_for(:javascripts) do
+  %script{:type => "text/javascript", :src  => "#{root_url}/javascripts/qunit_for_rails/jquery-1.6.4.min.js"}
+  %script{:type => "text/javascript", :src  => "#{root_url}/javascripts/qunit_for_rails/qunit.js"}
+  %script{:type => "text/javascript", :src  => "#{root_url}/javascripts/qunit_for_rails/qunit.test_loader.js"}
+  %script{:type => "text/javascript", :src  => "#{root_url}/javascripts/qunit_for_rails/qunit_for_rails.js"}
+
+  :javascript
+    var QFR = {};
+    var test_list = #{test_files.to_json};
+    
+    QFR.root_url = "#{root_url}";

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get "test/qunit/" => "qunit_for_rails/qunit_tests#index", :as => "qunit_tests"
+end

data/lib/qunit_for_rails.rb

@@ -0,0 +1,15 @@
+require "active_support/core_ext/module/attribute_accessors"
+require "haml"
+
+
+module QunitForRails
+
+  mattr_accessor :app_root
+
+  def self.setup
+    yield self
+  end
+
+end
+
+require "qunit_for_rails/engine" if defined?(Rails)

data/lib/qunit_for_rails/engine.rb

@@ -0,0 +1,20 @@
+require "rails/engine"
+require "qunit_for_rails"
+
+module QunitForRails
+
+  class Engine < Rails::Engine
+
+    initializer "load_app_instance_data" do |app|
+      QunitForRails.setup do |config|
+        config.app_root = app.root
+      end
+    end
+
+    initializer "static assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+ 
+  end
+
+end

data/lib/qunit_for_rails/version.rb

@@ -0,0 +1,3 @@
+module QunitForRails
+  VERSION = "0.0.4"
+end

data/lib/tasks/qunit_for_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :qunit_for_rails do
+#   # Task goes here
+# end

data/public/javascripts/qunit_for_rails/inject.js

@@ -0,0 +1,191 @@
+(function(){
+
+	var DEBUG = false;
+        // hold each test run as row 
+        var testresults = [];
+
+	var doPost = false;
+
+	try {
+		doPost = !!window.top.postMessage;
+	} catch(e){}
+
+	var search = window.location.search,
+		url, index;
+	if( ( index = search.indexOf( "swarmURL=" ) ) != -1 )
+		url = decodeURIComponent( search.slice( index + 9 ) );
+
+	if ( !DEBUG && (!url || url.indexOf("http") !== 0) ) {
+		return;
+	}
+
+	var submitTimeout = 5;
+
+	var curHeartbeat;
+	var beatRate = 20;
+
+	// Expose the TestSwarm API
+	window.TestSwarm = {
+		submit: submit,
+		heartbeat: function(){
+			if ( curHeartbeat ) {
+				clearTimeout( curHeartbeat );
+			}
+
+			curHeartbeat = setTimeout(function(){
+				submit({ fail: -1, total: -1 });
+			}, beatRate * 1000);
+		},
+		serialize: function(){
+			return trimSerialize();
+		}
+	};
+
+	// Prevent careless things from executing
+	window.print = window.confirm = window.alert = window.open = function(){};
+
+	window.onerror = function(e){
+		document.body.appendChild( document.createTextNode( "ERROR: " + e ));
+		submit({ fail: 0, error: 1, total: 1 });
+		return false;
+	};
+
+	// QUnit callbacks - shughes 
+        if ( typeof QUnit !== "undefined" ) {
+	QUnit.done = function(results){
+	  submit({
+		  fail: results.failed,
+		  error: 0,
+                  time: results.runtime,
+		  total: results.total,
+                  results: JSON.stringify(testresults)
+		 });
+	};
+	QUnit.testDone = function(results){
+          testresults.push(results);
+	};
+
+	QUnit.log = window.TestSwarm.heartbeat;
+	window.TestSwarm.heartbeat();
+
+	window.TestSwarm.serialize = function(){
+	  // Clean up the HTML (remove any un-needed test markup)
+	  remove("nothiddendiv");
+	  remove("loadediframe");
+	  remove("dl");
+	  remove("main");
+
+		// Show any collapsed results
+		var ol = document.getElementsByTagName("ol");
+		for ( var i = 0; i < ol.length; i++ ) {
+			ol[i].style.display = "block";
+		}
+
+		return trimSerialize();
+	};
+        }
+
+	function trimSerialize(doc) {
+		doc = doc || document;
+
+		var scripts = doc.getElementsByTagName("script");
+		while ( scripts.length ) {
+			remove( scripts[0] );
+		}
+
+		var root = window.location.href.replace(/(https?:\/\/.*?)\/.*/, "$1");
+		var cur = window.location.href.replace(/[^\/]*$/, "");
+
+		var links = doc.getElementsByTagName("link");
+		for ( var i = 0; i < links.length; i++ ) {
+			var href = links[i].href;
+			if ( href.indexOf("/") === 0 ) {
+				href = root + href;
+			} else if ( !/^https?:\/\//.test( href ) ) {
+				href = cur + href;
+			}
+			links[i].href = href;
+		}
+
+		return ("<html>" + doc.documentElement.innerHTML + "</html>")
+			.replace(/\s+/g, " ");
+	}
+
+	function remove(elem){
+		if ( typeof elem === "string" ) {
+			elem = document.getElementById( elem );
+		}
+
+		if ( elem ) {
+			elem.parentNode.removeChild( elem );
+		}
+	}
+
+	function submit(params){
+		if ( curHeartbeat ) {
+			clearTimeout( curHeartbeat );
+		}
+
+		var paramItems = (url.split("?")[1] || "").split("&");
+
+		for ( var i = 0; i < paramItems.length; i++ ) {
+			if ( paramItems[i] ) {
+				var parts = paramItems[i].split("=");
+				if ( !params[ parts[0] ] ) {
+					params[ parts[0] ] = parts[1];
+				}
+			}
+		}
+
+		if ( !params.state ) {
+			params.state = "saverun";
+		}
+
+		if ( !params.results ) {
+			params.results = window.TestSwarm.serialize();
+		}
+
+		if ( doPost ) {
+			// Build Query String
+			var query = "";
+
+			for ( var i in params ) {
+				query += ( query ? "&" : "" ) + i + "=" +
+					encodeURIComponent(params[i]);
+			}
+
+			if ( DEBUG ) {
+				alert( query );
+			} else {
+				window.top.postMessage( query, "*" );
+			}
+
+		} else {
+			var form = document.createElement("form");
+			form.action = url;
+			form.method = "POST";
+
+			for ( var i in params ) {
+				var input = document.createElement("input");
+				input.type = "hidden";
+				input.name = i;
+				input.value = params[i];
+				form.appendChild( input );
+			}
+
+			if ( DEBUG ) {
+				alert( form.innerHTML );
+			} else {
+
+				// Watch for the result submission timing out
+				setTimeout(function(){
+					submit( params );
+				}, submitTimeout * 1000);
+
+				document.body.appendChild( form );
+				form.submit();
+			}
+		}
+	}
+
+})();