holygrail 0.5

data/.gitignore

@@ -0,0 +1,3 @@
+doc/
+.yardoc/
+*.gem

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2009 Martin Aumont (mynyml)
+
+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/Manifest

@@ -0,0 +1,12 @@
+.gitignore
+LICENSE
+Manifest
+README.md
+Rakefile
+docs.watchr
+holygrail.gemspec
+lib/holygrail.rb
+rails/init.rb
+specs.watchr
+test/holygrail_test.rb
+test/test_helper.rb

data/README.md

@@ -0,0 +1,90 @@
+HolyGrail
+=========
+
+Summary
+-------
+
+The Holy Grail of testing for front-end development; execute browser-less,
+console-based, javascript + DOM code right from within your Rails test suite.
+
+HolyGrail is a [Harmony][20] plugin for Ruby on Rails.
+
+Examples
+--------
+
+Use the `js` method in your functional tests to execute javascript within the
+context of a view (the last response body). `js` returns the value of the last
+javascript statement, cast to an equivalent ruby object.
+
+    class PeopleControllerTest < ActionController::TestCase
+
+      test "executes simple js" do
+        assert_equal 2, js('1+1')
+      end
+
+      test "accesses the DOM" do
+        get :foo
+        assert_equal 'Foo', js("document.title")
+        assert_equal  2,    js("document.getElementsByTagName('div').length")
+      end
+    end
+
+Install
+-------
+
+Install the gem
+
+    # Note: there's a gem dependency bug in rubygems currently, so we'll have
+    # to install some dependencies manually. This will be fixed soon.
+    gem install stackdeck
+    gem install johnson -v "2.0.0.pre0" #exact version matters
+
+    gem install holygrail
+
+and add it to your environment
+
+    config.gem "holygrail"
+
+Acknowledgement
+---------------
+
+HolyGrail is based on [Harmony][20], which in turn is a thin DSL wrapper around
+three **amazing** libs, [Johnson][1], [env.js][30] and [Envjs][2] . The authors
+of those libs have been doing a huge amount of great work for quite a while, so
+please go recommend them on WorkingWithRails right now and/or follow them on
+github:
+
+  [jbarnette][3], [tenderlove][4], [smparkes][5], [wycats][6], [matthewd][7], [thatcher][8], [jeresig][9]
+
+Special thanks go to [smparkes][10] for his patient help, and for providing the
+last puzzle pieces that made [everything][12] [work][11] [together][13].
+
+TODO
+----
+* Support integration tests
+* Support Rails3
+
+Links
+-----
+* code: <http://github.com/mynyml/holygrail>
+* docs: <http://yardoc.org/docs/mynyml-holygrail>
+* wiki: <http://wiki.github.com/mynyml/holygrail>
+* bugs: <http://github.com/mynyml/holygrail/issues>
+
+
+
+[1]:  http://github.com/jbarnette/johnson/
+[2]:  http://env-js.appspot.com/
+[3]:  http://www.workingwithrails.com/person/10668-john-barnette
+[4]:  http://github.com/tenderlove/
+[5]:  http://www.workingwithrails.com/person/11739-steven-parkes
+[6]:  http://www.workingwithrails.com/person/1805-yehuda-katz
+[7]:  http://www.workingwithrails.com/person/6221-matthew-draper
+[8]:  http://github.com/thatcher/
+[9]:  http://ejohn.org/
+[10]: http://github.com/smparkes/
+[11]: http://github.com/smparkes/env-js/commit/49abe259813a505b0761e6d31dde671344b5bc87#L0R279
+[12]: http://groups.google.com/group/envjs/msg/4ac719f7db7912f5
+[13]: http://gemcutter.org/gems/envjs
+[20]: http://github.com/mynyml/harmony
+[30]: http://github.com/thatcher/env-js

data/Rakefile

@@ -0,0 +1,39 @@
+def gem_opt
+  defined?(Gem) ? "-rubygems" : ""
+end
+
+# --------------------------------------------------
+# Tests
+# --------------------------------------------------
+task(:default => "test:all")
+
+namespace(:test) do
+
+  desc "Run all tests"
+  task(:all) do
+    exit system("ruby #{gem_opt} -I.:lib:test -e'%w( #{Dir['test/**/*_test.rb'].join(' ')} ).each {|p| require p }'")
+  end
+
+  desc "Run all tests on multiple ruby versions (requires rvm)"
+  task(:portability) do
+    versions = %w(  1.8.6  1.8.7  1.9  1.9.2  )
+    versions.each do |version|
+      system <<-BASH
+        bash -c 'source ~/.rvm/scripts/rvm;
+                 rvm use #{version};
+                 echo "--------- #{version} ----------";
+                 rake -s test:all'
+      BASH
+    end
+  end
+end
+
+# --------------------------------------------------
+# Docs
+# --------------------------------------------------
+desc "Generate YARD Documentation"
+task :yardoc do
+  require 'yard'
+  YARD::CLI::Yardoc.run *%w( --no-private -o doc/yard --readme README.md - LICENSE )
+end
+

data/docs.watchr

@@ -0,0 +1,25 @@
+# Run me with:
+#   $ watchr docs.watchr
+
+require 'yard'
+# --------------------------------------------------
+# Rules
+# --------------------------------------------------
+watch( 'lib/.*\.rb' ) { yard }
+watch( 'README.md'  ) { yard }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+Signal.trap('QUIT') { yard        } # Ctrl-\
+Signal.trap('INT' ) { abort("\n") } # Ctrl-C
+
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+def yard
+  print "Updating yardocs... "; STDOUT.flush
+  YARD::CLI::Yardoc.run *%w( --no-private -o doc/yard --readme README.md - LICENSE )
+  print "done\n"
+end
+

data/holygrail.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name                = "holygrail"
+  s.version             = "0.5"
+  s.summary             = "Harmony plugin for Ruby on Rails tests"
+  s.description         = "The Holy Grail of testing for front-end development; execute browser-less, console-based, javascript + DOM code right from within your Rails test suite."
+  s.author              = "mynyml"
+  s.email               = "mynyml@gmail.com"
+  s.homepage            = "http://github.com/mynyml/holygrail"
+  s.rubyforge_project   = "holygrail"
+  s.require_path        = "lib"
+  s.files               =  File.read("Manifest").strip.split("\n")
+
+  s.add_dependency 'harmony'
+  s.add_development_dependency 'action_controller'
+end

data/lib/holygrail.rb

@@ -0,0 +1,50 @@
+require 'harmony'
+
+module ActionController
+  module Assertions
+    module HolyGrail
+
+      # Clear harmony page on every request.
+      # Prevents changes to context from bleeding into the next one.
+      #
+      # @example
+      #
+      #     get :index
+      #     js("foo = 'bar'")
+      #     js('foo') #=> "bar"
+      #
+      #     get :index
+      #     js('foo') #=> "Error: foo is not defined"
+      #
+      # @private
+      def process(*args) #:nodoc:
+        @__page = nil
+        super
+      end
+
+      # Execute javascript within the context of a view.
+      #
+      # @example
+      #
+      #     class PeopleControllerTest < ActionController::TestCase
+      #       get :index
+      #       assert_equal 'People: index', js('document.title')
+      #     end
+      #
+      # @param [String]
+      #   code javascript code to evaluate
+      #
+      # @return [Object]
+      #   value of last javascript statement, cast to an equivalent ruby object
+      #
+      # @raise [Johnson::Error]
+      #   javascript code exception
+      #
+      def js(code)
+        @__page ||= Harmony::Page.new(@response.body.to_s)
+        @__page.execute_js(code)
+      end
+      alias :execute_javascript :js
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,6 @@
+require 'pathname'
+require  Pathname(__FILE__).dirname.parent + 'lib/holygrail'
+
+class ActionController::TestCase
+  include ActionController::Assertions::HolyGrail
+end

data/specs.watchr

@@ -0,0 +1,36 @@
+# Run me with:
+#   $ watchr specs.watchr
+
+# --------------------------------------------------
+# Rules
+# --------------------------------------------------
+watch( '^test.*/.*_test\.rb'   )  {|m| ruby m[0] }
+watch( '^lib/(.*)\.rb'         )  {|m| ruby "test/#{m[1]}_test.rb" }
+watch( '^rails/init\.rb'       )  { ruby tests }
+watch( '^test/test_helper\.rb' )  { ruby tests }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+Signal.trap('QUIT') { ruby tests  } # Ctrl-\
+Signal.trap('INT' ) { abort("\n") } # Ctrl-C
+
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+def ruby(*paths)
+  run "ruby #{gem_opt} -I.:lib:test -e'%w( #{paths.flatten.join(' ')} ).each {|p| require p }'"
+end
+
+def tests
+  Dir['test/**/*_test.rb']
+end
+
+def run( cmd )
+  puts   cmd
+  system cmd
+end
+
+def gem_opt
+  defined?(Gem) ? "-rubygems" : ""
+end

data/test/holygrail_test.rb

@@ -0,0 +1,56 @@
+require 'test/test_helper'
+
+ActionController::Routing::Routes.draw do |map|
+  map.root :controller => 'holy_grails', :action => 'foo'
+end
+
+class HolyGrailsController < ActionController::Base
+  def foo
+    render :text => <<-HTML
+      <html>
+        <head>
+          <title>Foo</title>
+        </head>
+        <body>
+          <div></div>
+          <div></div>
+        </body>
+      </html>
+    HTML
+  end
+end
+
+class HolyGrailsControllerTest < ActionController::TestCase
+  test "api" do
+    assert_respond_to self, :execute_javascript
+    assert_respond_to self, :js
+  end
+
+  test "parses simple js" do
+    assert_equal 2, js('1+1')
+  end
+
+  test "every test is a different context" do
+    js("foo = 'bar'")
+    assert_equal 'bar', js('foo')
+  end
+  test "every test is a different context 2" do
+    assert_raises(Johnson::Error) { js('foo') }
+  end
+
+  test "response context doesn't bleed into next response" do
+    get :foo
+    js("foo = 'bar'")
+    assert_equal 'bar', js('foo')
+
+    get :foo
+    assert_raises(Johnson::Error) { js('foo') }
+  end
+
+  test "DOM" do
+    get :foo
+    assert_equal 'Foo', js("document.title")
+    assert_equal  2,    js("document.getElementsByTagName('div').length")
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'action_controller'
+
+begin require 'ruby-debug'; rescue LoadError; end
+begin require 'redgreen';   rescue LoadError; end
+begin require 'phocus';     rescue LoadError; end
+
+require 'rails/init'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: holygrail
+version: !ruby/object:Gem::Version 
+  version: "0.5"
+platform: ruby
+authors: 
+- mynyml
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: harmony
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: action_controller
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: The Holy Grail of testing for front-end development; execute browser-less, console-based, javascript + DOM code right from within your Rails test suite.
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- Manifest
+- README.md
+- Rakefile
+- docs.watchr
+- holygrail.gemspec
+- lib/holygrail.rb
+- rails/init.rb
+- specs.watchr
+- test/holygrail_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mynyml/holygrail
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: holygrail
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Harmony plugin for Ruby on Rails tests
+test_files: []
+