RubyGems - rubinium - Versions diffs - 0.1.1 - Mend

rubinium 0.1.1

Files changed (161) hide show

data/CHANGES ADDED

@@ -0,0 +1,7 @@
+= Rubinium Changelog
+== Version 0.1.1
+This is the initial release. It generates Selenium HTML tests from the corresponding Rubinium tests. Rubinium tests look almost identical to Selenium tests, except they're written in Ruby. This allows the test writer to drop into ruby when they need some extra juice.
+* Initial import

data/MIT-LICENSE ADDED

@@ -0,0 +1,21 @@
+Copyright (c) 2005, 2006 Alex Garrett
+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 ADDED

@@ -0,0 +1,137 @@
+= Rubinium: The Ruby code generator for Selenium
+Rubinium is a tool that makes writing Selenium[http://www.openqa.org/selenium/] tests easier. Here's a quick comparison:
+A Selenium test:
+	<html><head><title>HelloWorld</title><head>
+	  <body>
+	    <table border="1">
+	      <tr><td colspan="3">HelloWorld Test</td></tr>
+	      <tr><td>open</td><td>/index.php</td><td>&nbsp;</td></tr>
+	      <tr><td>assertTitle</td><td>Hello World</td><td>&nbsp;</td></tr>
+	      <tr><td>assertLocation</td><td>/index.php</td><td>&nbsp;</td></tr>
+	      <tr><td>assertTextPresent</td><td>Hello World</td><td>&nbsp;</td></tr>
+	    </table>
+	  </body>
+	</html>
+And here's the corresponding Rubinium test:
+	class HelloWorld < Rubinium::TestBase
+	  open "/index.php"
+	  assertTitle  "Hello World"
+	  assertLocation "/index.php"
+	  assertTextPresent "Hello World"
+	end
+The added immediate benefit is that the Rubinium test can be executed and if the actions/assertions aren't valid the test will raise an exception. If the actions/assertions are valid, the test will exit without generating any output.
+== Download
+The latest version of Rubinium can be found at
+* http://rubyforge.org/project/showfiles.php?group_id=1179
+== GEM Installation
+Download and install rubinium with the following.
+   gem install --remote rubinium
+== Simple Example
+Here's a simple example that shows a mixture of Selenium and ruby:
+	require 'rubygems'
+	require_gem 'rubinium'
+	class SiteLive < Rubinium::TestBase
+	  HOST = "http://localhost:8080"
+	  MAIN_PAGE = "/index.html"
+	  open HOST
+	  assertLocation MAIN_PAGE
+	end
+Notice that the host and main page are represented as ruby constants and the constants are used in the test, rather than storing the value directly in the test. This helps keep your tests DRY[http://c2.com/cgi/wiki?DontRepeatYourself].
+Here's the Selenium test that gets generated:
+  <html><head><title>SiteLive</title></head>
+    <body>
+      <table border="1">
+        <tbody>
+          <tr><td colspan="3">SiteLive Test</td></tr>
+          <tr><td>open</td><td>http://localhost:8080</td><td>&nbsp;</td></tr>
+          <tr><td>assertLocation</td><td>/index.html</td><td>&nbsp;</td></tr>
+        </tbody>
+      </table>
+    </body>
+  </html>
+Test cases get aggregated into test suites. Here's a simple test suite that contains the test case from above:
+	require 'rubygems'
+	require_gem 'rubinium'
+	Rubinium::TestSuite.new do |suite|
+	  suite.name = "MainSuite"
+	  suite.filename = "main-suite.html"
+	  suite.basedir = File.dirname(__FILE__)
+	  suite << SiteLive
+	end.generate
+The easiest way to create a test suite is to use the (probably familiar) block syntax. Individual tests are appended to the suite using the <tt>&lt;&lt;</tt> operator. After the suite has been initialized, you should invoke the <tt>generate</tt> method to generate the actual Selenium tests.
+A test suite has three attributes, all optional: <tt>name</tt>, <tt>filename</tt>, and <tt>basedir</tt>. The first two allow you to set the name that will be displayed in the Selenium test and the filename of the generated Selenium suite. The <tt>basedir</tt> attribute is the directory where the files will be generated. While you can set the <tt>basedir</tt> directly in the suite, a  more common way of setting it is by passing it as a command line parameter. E.g.,
+  ruby rts_main.rb tests/generated-tests
+This usage is particularly amenable to Rake[http://rake.rubyforge.org] tasks:
+	TEST_PATH = "test/tests"
+	GENERATED_TEST_PATH = "test/generated-tests"
+	ACCEPTANCE_TESTS = %w(
+	  rts_main.rb
+	).map {|test| File.join(TEST_PATH, test)}
+	desc "Generate selenium tests from rubinium tests"
+	task :rubinium => [:clean, :environment] do
+	  ACCEPTANCE_TESTS.each do |test|
+	        ruby "#{test} #{GENERATED_TEST_PATH}"
+	  end
+	end
+NB: If <tt>basedir</tt> is supplied both as a command line parameter and as an explicit attribute in the suite, the command line parameter will be ignored.
+More examples of Rubinium tests and suites are provided in the doc/examples directory.
+== Credits
+[<b>The Folks at Thoughtworks</b>] For creating Selenium.
+[<b>Jim Weirich</b>] For creating Rake[http://rake.rubyforge.org] and writing extensively and clearly about DSLs and metaprogramming in Ruby.
+[<b>why_the_lucky_stiff</b>] For inspiring me with Dwemthy's Array
+[<b>Stephen Baker</b>] For the RSpec[http://rspec.rubyforge.org] Rakefile I liberally pillaged from.
+== License
+Rubinium is available under an MIT-style license.
+:include: MIT-LICENSE
+== Support
+The Rubinium homepage is http://rubinium.thinkpig.org.  You can find the Rubinium
+RubyForge page at http://rubyforge.org/projects/rubinium.
+Feel free to submit commits or feature requests.  If you send a patch,
+remember to update the corresponding unit tests.  Patches are much less likely to be adopted if I have to write the tests.
+For other information, feel free to contact mailto:ljagged@thinkpig.org.
+----

data/Rakefile ADDED

@@ -0,0 +1,139 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'meta_project'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/contrib/xforge'
+require 'rake/contrib/rubyforgepublisher'
+PKG_NAME = 'rubinium'
+PKG_VERSION = "0.1.1"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_FILES = FileList.new
+PKG_FILES.add %w{ Rakefile README CHANGES MIT-LICENSE TODO }
+PKG_FILES.add %w{ lib/**/*.rb }
+PKG_FILES.add %w{ test/**/*.rb }
+PKG_FILES.add %w{ doc/**/* }
+PKG_FILES.add %w{ vendor/**/* }
+CLEAN.add %w{ pkg html }
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.summary = "Code generator for Selenium with test validation"
+  s.email = 'ljagged(at)thinkpig.org'
+  s.author = 'Alex Garrett'
+  s.homepage = 'http://rubinium.thinkpig.org'
+  s.rubyforge_project = "rubinium"
+  s.platform = Gem::Platform::RUBY
+  s.version = PKG_VERSION
+  s.files = PKG_FILES
+  s.requirements << 'none'
+  s.require_path = 'lib'
+  s.autorequire = 'rubinium'
+  s.test_file = 'test/ts_rubinium.rb'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README', "CHANGES", "TODO", "MIT-LICENSE"]
+  s.description = <<EOF
+Rubinium is a FIT-style code generator for Selenium. It supports validation and allows the user to
+include arbitrary ruby in the test.
+EOF
+end
+task :default => [:test]
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = ['ts_rubinium.rb']
+  t.verbose = true
+end
+task :test => [:clean]
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.title = "Rubinium"
+  rd.options << '--line-numbers' << '--inline-source'
+  rd.rdoc_files.include("README", "CHANGES", "TODO", "lib/**/*.rb")
+end
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+def egrep(pattern)
+  Dir['**/*.rb'].each do |fn|
+    count = 0
+    open(fn) do |f|
+      while line = f.gets
+        count += 1
+        if line =~ pattern
+          puts "#{fn}:#{count}:#{line}"
+        end
+      end
+    end
+  end
+end
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  egrep /#.*(FIXME|TODO|TBD)/
+end
+desc "Generate agiledox-like documentation for tests"
+task :agiledox do
+  tests = FileList['test/**/tc_*.rb']
+  tests.each do |file|
+    m = %r".*/tc_([^/].*).rb".match(file)
+    puts m[1]+" should:\n"
+    test_definitions = File::readlines(file).select {|line| line =~ /.*def test.*/}
+    test_definitions.each do |definition|
+      m = %r"test_(should_)?(.*)".match(definition)
+      puts " - "+m[2].gsub(/_/," ")
+    end
+  puts "\n"
+ end
+end
+task :release => [:verify_env_vars, :release_files, :publish_doc, :publish_news]
+task :verify_env_vars do
+  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
+  raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
+end
+desc "Release gem to RubyForge. MAKE SURE PKG_VERSION is aligned with the CHANGELOG file"
+task :release_files => [:gem] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new(PKG_NAME)) do |xf|
+    # Never hardcode user name and password in the Rakefile!
+    xf.user_name = ENV['RUBYFORGE_USER']
+    xf.password = ENV['RUBYFORGE_PASSWORD']
+    xf.files = release_files.to_a
+    xf.release_name = "Rubinium #{PKG_VERSION}"
+  end
+end
+desc "Publish documentation"
+task :publish_doc => [:rdoc] do
+  Rake::RubyForgePublisher.new(PKG_NAME, ENV['RUBYFORGE_USER']).upload
+end
+desc "Publish news on RubyForge"
+task :publish_news => [:gem] do
+  release_files = FileList[
+    "pkg/#{PKG_FILE_NAME}.gem"
+  ]
+  Rake::XForge::NewsPublisher.new(MetaProject::Project::XForge::RubyForge.new(PKG_NAME)) do |news|
+    # Never hardcode user name and password in the Rakefile!
+    news.user_name = ENV['RUBYFORGE_USER']
+    news.password = ENV['RUBYFORGE_PASSWORD']
+  end
+end

data/TODO ADDED

@@ -0,0 +1,7 @@
+= Rubinium Project -- To Do List
+Send suggestions for this list to mailto:ljagged@thinkpig.org.
+=== To Do
+* Add validation to Rubinium::TestBase
+* Allow loading of test fixtures that contain common or shared data

data/doc/examples/rtc_site_live.rb ADDED

@@ -0,0 +1,12 @@
+require 'rubygems'
+require_gem 'rubinium'
+class SiteLiveTest < Rubinium::TestBase
+  HOST = "http://localhost:8080"
+  MAIN_PAGE = "/index.html"
+  open HOST
+  assertLocation MAIN_PAGE
+end
+puts SiteLiveTest.generate

data/doc/examples/rts_main.rb ADDED

@@ -0,0 +1,9 @@
+require 'rubygems'
+require_gem 'rubinium'
+Rubinium::TestSuite.new() do |suite|
+  suite.name = "MainSuite"
+  suite.filename = "main-suite.html"
+  suite.basedir = File.dirname(__FILE__)
+  suite << SiteLive
+end.generate

data/doc/examples/rts_shared_code.rb ADDED

@@ -0,0 +1,25 @@
+require 'rubygems'
+require_gem 'rubinium'
+class FeatureSpecTest < Rubinium::TestBase
+  def self.addFeature
+    open 'index.jsp'
+  end
+end
+class HappyPath < FeatureSpecTest
+  addFeature
+  assertTextPresent "Added successfully"
+end
+class SadPath < FeatureSpecTest
+  addFeature
+  assertTextPresent "Feature already added"
+end
+Rubinium::TestSuite.new do |suite|
+  suite.name = "TestSuite"
+  suite.filename = "test-suite.html"
+  suite << HappyPath
+  suite << SadPath
+end.generate

data/lib/rubinium.rb ADDED

@@ -0,0 +1,9 @@
+require 'rubygems'
+RUBINIUM_ROOT = File.dirname(__FILE__)
+SELENIUM_ROOT = ENV['SELENIUM_ROOT'] || File.join(RUBINIUM_ROOT, "../vendor/selenium-0.6.0")
+SELENIUM_API = File.join(SELENIUM_ROOT, 'selenium/selenium-api.js')
+require RUBINIUM_ROOT + '/rubinium/validator'
+require RUBINIUM_ROOT + '/rubinium/test_base'
+require RUBINIUM_ROOT + '/rubinium/test_suite'

data/lib/rubinium/string.rb ADDED

@@ -0,0 +1,3 @@
+class String
+  def down_first; self.gsub(/^(.)/, $1.downcase) if self =~ /^(.)/; end
+end

data/lib/rubinium/test_base.rb ADDED

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/string'
+module Rubinium
+  class TestBase
+    def self.metaclass; class << self; self; end; end
+    metaclass.class_eval do
+      include Validator
+      attr_accessor :filename
+    end
+    # TODO: Add cattr_accessor, etc.
+    methods = File.open(SELENIUM_API) do |f|
+      api = f.read
+      actions = api.grep(/^Selenium\.prototype\.do(\w+)/) { |match| $1.down_first }.inject([]) do |acc, elem|
+        acc << elem
+        acc << "#{elem}AndWait"
+      end << "pause" # special case
+      asserts = api.grep(/^Selenium\.prototype\.assert(\w+)/) { |match| $1 }.inject([]) do |acc, elem|
+        acc << "assert#{elem}"
+        acc << "verify#{elem}"
+        acc
+      end
+      accessors = api.grep(/^Selenium.prototype.get(\w+)/) { |match| $1 }.inject([]) do |acc, elem|
+        acc << "get#{elem}"
+        acc << "verify#{elem}"
+        acc << "assert#{elem}"
+        acc << "verifyNot#{elem}"
+        acc << "assertNot#{elem}"
+      end
+      actions + asserts + accessors
+    end
+    methods.each do |verb|
+      metaclass.class_eval do
+        define_method(verb) do |*object|
+          @test_actions ||= []
+          @test_actions << [verb, object]
+          if @validators and validator = @validators[verb]
+            self.send(validator, self, object)
+          end
+        end
+      end
+    end
+    def self.validate(*actions)
+      actions.each do |action|
+        @validators ||= {}
+        @validators[action] = :validateOpen
+      end
+    end
+    def self.generate(io = "")
+      script = @test_actions.map do |line|
+        verb, object = line
+        target = object[0]
+        value = object[1] || "&nbsp;"
+        "#{" " * 6}<tr><td>#{verb}</td><td>#{target}</td><td>#{value}</td></tr>"
+      end.join("\n")
+      fullscript = <<EOF
+<html><head><title>#{self.name.to_s}</title></head>
+<body>
+  <table border="1">
+    <tbody>
+    <tr><td colspan="3">#{self.to_s} Test</td></tr>
+#{script}
+    </tbody>
+  </table>
+</body>
+</html>
+EOF
+      io << fullscript
+      io
+    end
+    def self.filename
+      @filename || self.to_s + ".html"
+    end
+    def self.errors
+      @errors ||= []
+    end
+  end
+end