drnic-celerity 0.0.6.17

data/benchmark/bm_input_locator.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + "/loader"
+
+browser = create_browser
+browser.goto(HTML_DIR + "/forms_with_input_elements.html")
+
+TESTS = 1000
+res = Benchmark.bmbm do |results|
+  results.report("text input by id (String)") do
+    TESTS.times { browser.text_field(:id, "new_user_first_name").exists? }
+  end
+  results.report("text input by id (Regexp)") do
+    TESTS.times { browser.text_field(:id, /first_name/).exists? }
+  end
+  results.report("text input by name (String)") do
+    TESTS.times { browser.text_field(:name, "new_user_email").exists? }
+  end
+  results.report("text input by name (Regexp)") do
+    TESTS.times { browser.text_field(:name, /user_email/).exists? }
+  end
+
+  results.report("select list by id (String)") do
+    TESTS.times { browser.select_list(:id, 'new_user_country').exists? }
+  end
+  results.report("select list by id (Regexp)") do
+    TESTS.times { browser.select_list(:id, /user_country/).exists? }
+  end
+  results.report("select list by name (String)") do
+    TESTS.times { browser.select_list(:name, 'new_user_country').exists? }
+  end
+  results.report("select list by name (Regexp)") do
+    TESTS.times { browser.select_list(:name, /user_country/).exists? }
+  end
+
+  results.report("checkbox by id (String)") do
+    TESTS.times { browser.checkbox(:id, 'new_user_interests_books').exists? }
+  end
+  results.report("checkbox by id (Regexp)") do
+    TESTS.times { browser.checkbox(:id, /interests_books/).exists? }
+  end
+
+  results.report("checkbox by name (String)") do
+    TESTS.times { browser.checkbox(:name, 'new_user_interests').exists? }
+  end
+  results.report("checkbox by name (Regexp)") do
+    TESTS.times { browser.checkbox(:name, /user_interests/).exists? }
+  end
+
+  results.report("checkbox by id (String) and value (String)") do
+    TESTS.times { browser.checkbox(:id, 'new_user_interests_books', 'cars').exists? }
+  end
+  results.report("checkbox by id (Regexp) and value (Regexp)") do
+    TESTS.times { browser.checkbox(:id, /interests_books/, /car/).exists? }
+  end
+
+  results.report("checkbox by name (String) and value (String)") do
+    TESTS.times { browser.checkbox(:name, 'new_user_interests', 'dancing').exists? }
+  end
+  results.report("checkbox by name (Regexp) and value (Regexp)") do
+    TESTS.times { browser.checkbox(:name, /user_interests/, /danc/).exists? }
+  end
+
+
+
+end
+
+puts
+total = res.inject(0.0) { |mem, bm| mem + bm.real }
+puts "total  : " + total.to_s
+puts "average: " + (total/res.size.to_f).to_s

data/benchmark/bm_text_input.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + "/loader"
+
+browser = create_browser
+browser.goto(HTML_DIR + "/forms_with_input_elements.html")
+
+TESTS = 10000
+res = Benchmark.bmbm do |results|
+  results.report("TextField#set") do
+    TESTS.times { browser.text_field(:id, "new_user_first_name").set("1234567890") }
+  end
+  results.report("TextField#value=") do
+    TESTS.times { browser.text_field(:id, "new_user_first_name").value = "1234567890" }
+  end
+end
+
+puts
+total = res.inject(0.0) { |mem, bm| mem + bm.real }
+puts "total  : " + total.to_s
+puts "average: " + (total/res.size.to_f).to_s

data/benchmark/loader.rb

@@ -0,0 +1,14 @@
+require 'benchmark'
+require File.dirname(__FILE__) + "/../spec/spec_helper"
+
+
+def create_browser
+  if RUBY_PLATFORM =~ /java/
+    browser = Celerity::Browser.new(:log_level => :off)
+  else
+    require 'watir'
+    browser = Watir::IE.new
+  end
+
+  browser
+end

data/celerity.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{celerity}
+  s.version = "0.0.6.17"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jari Bakken", "T. Alexander Lystad", "Knut Johannes Dahle"]
+  s.date = %q{2009-09-04}
+  s.description = %q{Celerity is a JRuby library for easy and fast functional test automation for web applications.
+
+It is a JRuby wrapper around HtmlUnit – a headless Java browser with 
+JavaScript support. It provides a simple API for programmatic navigation through
+web applications. Celerity aims at being API compatible with Watir.}
+  s.email = ["jari.bakken@finn.no"]
+  s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "README.rdoc", "Rakefile", "benchmark/bm_2000_spans.rb", "benchmark/bm_digg.rb", "benchmark/bm_google_images.rb", "benchmark/bm_input_locator.rb", "benchmark/bm_text_input.rb", "benchmark/loader.rb", "celerity.gemspec", "lib/celerity.rb", "lib/celerity/browser.rb", "lib/celerity/clickable_element.rb", "lib/celerity/collections.rb", "lib/celerity/container.rb", "lib/celerity/default_viewer.rb", "lib/celerity/disabled_element.rb", "lib/celerity/element.rb", "lib/celerity/element_collection.rb", "lib/celerity/element_locator.rb", "lib/celerity/elements/button.rb", "lib/celerity/elements/file_field.rb", "lib/celerity/elements/form.rb", "lib/celerity/elements/frame.rb", "lib/celerity/elements/image.rb", "lib/celerity/elements/label.rb", "lib/celerity/elements/link.rb", "lib/celerity/elements/meta.rb", "lib/celerity/elements/non_control_elements.rb", "lib/celerity/elements/option.rb", "lib/celerity/elements/radio_check.rb", "lib/celerity/elements/select_list.rb", "lib/celerity/elements/table.rb", "lib/celerity/elements/table_cell.rb", "lib/celerity/elements/table_elements.rb", "lib/celerity/elements/table_row.rb", "lib/celerity/elements/text_field.rb", "lib/celerity/exception.rb", "lib/celerity/htmlunit.rb", "lib/celerity/htmlunit/commons-codec-1.4.jar", "lib/celerity/htmlunit/commons-collections-3.2.1.jar", "lib/celerity/htmlunit/commons-httpclient-3.1.jar", "lib/celerity/htmlunit/commons-io-1.4.jar", "lib/celerity/htmlunit/commons-lang-2.4.jar", "lib/celerity/htmlunit/commons-logging-1.1.1.jar", "lib/celerity/htmlunit/cssparser-0.9.5.jar", "lib/celerity/htmlunit/htmlunit-2.6-SNAPSHOT.jar", "lib/celerity/htmlunit/htmlunit-core-js-2.6-SNAPSHOT.jar", "lib/celerity/htmlunit/nekohtml-1.9.13-20090820.100833-15.jar", "lib/celerity/htmlunit/sac-1.3.jar", "lib/celerity/htmlunit/serializer-2.7.1.jar", "lib/celerity/htmlunit/xalan-2.7.1.jar", "lib/celerity/htmlunit/xercesImpl-2.9.1.jar", "lib/celerity/htmlunit/xml-apis-1.3.04.jar", "lib/celerity/identifier.rb", "lib/celerity/ignoring_web_connection.rb", "lib/celerity/input_element.rb", "lib/celerity/listener.rb", "lib/celerity/resources/no_viewer.png", "lib/celerity/short_inspect.rb", "lib/celerity/util.rb", "lib/celerity/viewer_connection.rb", "lib/celerity/watir_compatibility.rb", "lib/celerity/xpath_support.rb", "spec/browser_authentication_spec.rb", "spec/browser_spec.rb", "spec/clickable_element_spec.rb", "spec/default_viewer_spec.rb", "spec/element_spec.rb", "spec/filefield_spec.rb", "spec/htmlunit_spec.rb", "spec/index_offset_spec.rb", "spec/listener_spec.rb", "spec/spec_helper.rb", "tasks/benchmark.rake", "tasks/deployment.rake", "tasks/environment.rake", "tasks/fix.rake", "tasks/jar.rake", "tasks/rdoc.rake", "tasks/rspec.rake", "tasks/simple_ci.rake", "tasks/snapshot.rake", "tasks/website.rake", "tasks/yard.rake", "website/benchmarks.html", "website/css/color.css", "website/css/hacks.css", "website/css/layout.css", "website/css/screen.css", "website/css/textmate.css", "website/css/typography.css", "website/gfx/body_bg.gif", "website/gfx/button_bg.jpg", "website/gfx/header_bg.jpg", "website/gfx/header_left.jpg", "website/gfx/header_right.jpg", "website/gfx/nav_bg.jpg", "website/index.html", "website/yard/Celerity.html", "website/yard/Celerity/Area.html", "website/yard/Celerity/Areas.html", "website/yard/Celerity/Browser.html", "website/yard/Celerity/Button.html", "website/yard/Celerity/Buttons.html", "website/yard/Celerity/CheckBox.html", "website/yard/Celerity/CheckBoxes.html", "website/yard/Celerity/ClickableElement.html", "website/yard/Celerity/Container.html", "website/yard/Celerity/Dd.html", "website/yard/Celerity/Dds.html", "website/yard/Celerity/DefaultViewer.html", "website/yard/Celerity/DisabledElement.html", "website/yard/Celerity/Div.html", "website/yard/Celerity/Divs.html", "website/yard/Celerity/Dl.html", "website/yard/Celerity/Dls.html", "website/yard/Celerity/Dt.html", "website/yard/Celerity/Dts.html", "website/yard/Celerity/Element.html", "website/yard/Celerity/ElementCollection.html", "website/yard/Celerity/ElementLocator.html", "website/yard/Celerity/Em.html", "website/yard/Celerity/Ems.html", "website/yard/Celerity/Exception.html", "website/yard/Celerity/Exception/CelerityException.html", "website/yard/Celerity/Exception/MissingWayOfFindingObjectException.html", "website/yard/Celerity/Exception/NavigationException.html", "website/yard/Celerity/Exception/NoValueFoundException.html", "website/yard/Celerity/Exception/ObjectDisabledException.html", "website/yard/Celerity/Exception/ObjectReadOnlyException.html", "website/yard/Celerity/Exception/UnexpectedPageException.html", "website/yard/Celerity/Exception/UnknownCellException.html", "website/yard/Celerity/Exception/UnknownFormException.html", "website/yard/Celerity/Exception/UnknownFrameException.html", "website/yard/Celerity/Exception/UnknownObjectException.html", "website/yard/Celerity/Exception/UnknownRowException.html", "website/yard/Celerity/FileField.html", "website/yard/Celerity/FileFields.html", "website/yard/Celerity/Form.html", "website/yard/Celerity/Forms.html", "website/yard/Celerity/Frame.html", "website/yard/Celerity/Frames.html", "website/yard/Celerity/H1.html", "website/yard/Celerity/H1s.html", "website/yard/Celerity/H2.html", "website/yard/Celerity/H2s.html", "website/yard/Celerity/H3.html", "website/yard/Celerity/H3s.html", "website/yard/Celerity/H4.html", "website/yard/Celerity/H4s.html", "website/yard/Celerity/H5.html", "website/yard/Celerity/H5s.html", "website/yard/Celerity/H6.html", "website/yard/Celerity/H6s.html", "website/yard/Celerity/Hidden.html", "website/yard/Celerity/Hiddens.html", "website/yard/Celerity/Image.html", "website/yard/Celerity/Images.html", "website/yard/Celerity/InputElement.html", "website/yard/Celerity/Label.html", "website/yard/Celerity/Labels.html", "website/yard/Celerity/Li.html", "website/yard/Celerity/Link.html", "website/yard/Celerity/Links.html", "website/yard/Celerity/Lis.html", "website/yard/Celerity/Listener.html", "website/yard/Celerity/Map.html", "website/yard/Celerity/Maps.html", "website/yard/Celerity/Meta.html", "website/yard/Celerity/Metas.html", "website/yard/Celerity/MethodGenerator.html", "website/yard/Celerity/NonControlElement.html", "website/yard/Celerity/Ol.html", "website/yard/Celerity/Ols.html", "website/yard/Celerity/Option.html", "website/yard/Celerity/Options.html", "website/yard/Celerity/P.html", "website/yard/Celerity/Pre.html", "website/yard/Celerity/Pres.html", "website/yard/Celerity/Ps.html", "website/yard/Celerity/Radio.html", "website/yard/Celerity/RadioCheckCommon.html", "website/yard/Celerity/Radios.html", "website/yard/Celerity/SelectList.html", "website/yard/Celerity/SelectLists.html", "website/yard/Celerity/ShortInspect.html", "website/yard/Celerity/Span.html", "website/yard/Celerity/Spans.html", "website/yard/Celerity/Strong.html", "website/yard/Celerity/Strongs.html", "website/yard/Celerity/Table.html", "website/yard/Celerity/TableBodies.html", "website/yard/Celerity/TableBody.html", "website/yard/Celerity/TableCell.html", "website/yard/Celerity/TableCells.html", "website/yard/Celerity/TableElement.html", "website/yard/Celerity/TableFooter.html", "website/yard/Celerity/TableFooters.html", "website/yard/Celerity/TableHeader.html", "website/yard/Celerity/TableHeaders.html", "website/yard/Celerity/TableRow.html", "website/yard/Celerity/TableRows.html", "website/yard/Celerity/Tables.html", "website/yard/Celerity/TextField.html", "website/yard/Celerity/TextFields.html", "website/yard/Celerity/Th.html", "website/yard/Celerity/Ul.html", "website/yard/Celerity/Uls.html", "website/yard/Celerity/Util.html", "website/yard/Celerity/VERSION.html", "website/yard/HtmlUnit.html", "website/yard/HtmlUnit/Html.html", "website/yard/HtmlUnit/Util.html", "website/yard/Java/ComGargoylesoftwareHtmlunitHtml/HtmlPage.html", "website/yard/Java/JavaLang/Iterable.html", "website/yard/Java/OrgW3cDom/NamedNodeMap.html", "website/yard/README.txt.html", "website/yard/String.html", "website/yard/all-files.html", "website/yard/all-methods.html", "website/yard/all-namespaces.html", "website/yard/app.js", "website/yard/index.html", "website/yard/jquery.js", "website/yard/style.css", "website/yard/syntax_highlight.css"]
+  s.homepage = %q{http://celerity.rubyforge.org/}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{celerity}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Celerity is a JRuby library for easy and fast functional test automation for web applications}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<sinatra>, [">= 0.9.4"])
+      s.add_development_dependency(%q<hoe>, [">= 2.3.3"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+      s.add_dependency(%q<hoe>, [">= 2.3.3"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+    s.add_dependency(%q<hoe>, [">= 2.3.3"])
+  end
+end

data/lib/celerity.rb

@@ -0,0 +1,77 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+raise "Celerity only works on JRuby at the moment." unless RUBY_PLATFORM =~ /java/
+
+require "java"
+require "logger"
+require "uri"
+require "pp"
+require "timeout"
+require "time"
+require "socket"
+require "fileutils"
+require "thread"
+
+module Celerity
+  VERSION = "0.0.6.17"
+  
+  Log = Logger.new($DEBUG ? $stderr : nil)
+  Log.level = Logger::DEBUG
+
+  @index_offset = 1
+  class << self
+
+    #
+    # This index_offset attribute controls the indexing used when locating
+    # elements by :index or fetching from Celerity::ElementCollections.
+    #
+    # By default it is set to 1 for Watir compatibility, but users who use
+    # Celerity exlusively may want it set to 0 to make Celerity more consistent with Ruby.
+    #
+    attr_accessor :index_offset
+  end
+
+  DIR = File.expand_path(File.dirname(__FILE__) + "/celerity")
+end
+
+require "celerity/htmlunit"
+require "celerity/exception"
+require "celerity/clickable_element"
+require "celerity/disabled_element"
+require "celerity/element_collection"
+require "celerity/collections"
+require "celerity/element_locator"
+require "celerity/identifier"
+require "celerity/short_inspect"
+require "celerity/container"
+require "celerity/xpath_support"
+require "celerity/element"
+require "celerity/input_element"
+require "celerity/elements/non_control_elements"
+require "celerity/elements/button"
+require "celerity/elements/file_field"
+require "celerity/elements/form"
+require "celerity/elements/frame"
+require "celerity/elements/image"
+require "celerity/elements/label"
+require "celerity/elements/link"
+require "celerity/elements/meta"
+require "celerity/elements/option"
+require "celerity/elements/radio_check"
+require "celerity/elements/select_list"
+require "celerity/elements/table"
+require "celerity/elements/table_elements"
+require "celerity/elements/table_cell"
+require "celerity/elements/table_row"
+require "celerity/elements/text_field"
+require "celerity/util"
+require "celerity/default_viewer"
+require "celerity/listener"
+require "celerity/ignoring_web_connection"
+require "celerity/viewer_connection"
+require "celerity/browser"
+require "celerity/watir_compatibility"
+
+# undefine deprecated methods to use them for Element attributes
+Object.send :undef_method, :id   if Object.method_defined? "id"
+Object.send :undef_method, :type if Object.method_defined? "type"

data/lib/celerity/browser.rb

@@ -0,0 +1,888 @@
+module Celerity
+  class Browser
+    include Container
+    include XpathSupport
+
+    attr_accessor :page, :object, :charset
+    attr_reader :webclient, :viewer, :options
+
+    #
+    # Initialize a browser and go to the given URL
+    #
+    # @param [String] uri The URL to go to.
+    # @return [Celerity::Browser] instance.
+    #
+
+    def self.start(uri)
+      browser = new
+      browser.goto(uri)
+      browser
+    end
+
+    #
+    # Not implemented. Use ClickableElement#click_and_attach instead.
+    #
+
+    def self.attach(*args)
+      raise NotImplementedError, "use ClickableElement#click_and_attach instead"
+    end
+
+    #
+    # Creates a browser object.
+    #
+    # @see Celerity::Container for an introduction to the main API.
+    #
+    # @option opts :log_level [Symbol] (:warning) @see log_level=
+    # @option opts :browser [:internet_explorer, :firefox, :firefox3] (:firefox) Set the BrowserVersion used by HtmlUnit. Defaults to Firefox 2.
+    # @option opts :css [Boolean] (false) Enable CSS.  Disabled by default.
+    # @option opts :secure_ssl [Boolean] (true)  Enable/disable secure SSL. Enabled by default.
+    # @option opts :javascript_enabled [Boolean] (true)  Enable/disable JavaScript evaluation. Enabled by default.
+    # @option opts :resynchronize [Boolean] (false) Use HtmlUnit::NicelyResynchronizingAjaxController to resynchronize Ajax calls.
+    # @option opts :javascript_exceptions [Boolean] (false) Raise exceptions on script errors. Disabled by default.
+    # @option opts :status_code_exceptions [Boolean] (false) Raise exceptions on failing status codes (404 etc.). Disabled by default.
+    # @option opts :charset [String] ("UTF-8") Specify the charset that webclient will use for requests, and those where texts are getting gibberished, like Browser#html.
+    # @option opts :proxy [String] (nil) Proxy server to use, in address:port format.
+    # @option opts :user_agent [String] Override the User-Agent set by the :browser option
+    # @option opts :ignore_pattern [Regexp] See Browser#ignore_pattern=
+    # @option opts :viewer [Boolean] (true) Connect to a CelerityViewer on port 6429 if available.
+    # @option opts :render [:html, :xml] (:html) What DOM representation to send to connected viewers.
+    # @option opts :refresh_handler [:immediat, :waiting, :threaded] (:immediate) Set HtmlUnit's refresh handler.
+    #
+    # @return [Celerity::Browser]     An instance of the browser.
+    #
+    # @api public
+    #
+
+    def initialize(opts = {})
+      unless opts.is_a?(Hash)
+        raise TypeError, "wrong argument type #{opts.class}, expected Hash"
+      end
+
+      unless (render_types = [:html, :xml, nil, 'html', 'xml']).include?(opts[:render])
+        raise ArgumentError, "expected one of #{render_types.inspect} for key :render"
+      end
+
+      opts     = opts.dup # we'll delete from opts, so dup to avoid side effects
+      @options = opts.dup # keep the unmodified version around as well
+
+      @render_type   = opts.delete(:render)    || :html
+      @charset       = opts.delete(:charset)   || "UTF-8"
+      self.log_level = opts.delete(:log_level) || :warning
+
+      @page           = nil
+      @error_checkers = []
+      @browser        = self # for Container#browser
+
+      setup_webclient opts
+      setup_viewer opts.delete(:viewer)
+
+      raise ArgumentError, "unknown option #{opts.inspect}" unless opts.empty?
+    end
+
+    def inspect
+      short_inspect :exclude => %w[@webclient @browser @object @options @listener @event_listener]
+    end
+
+    #
+    # Goto the given URL
+    #
+    # @param [String] uri The url.
+    # @return [String] The url.
+    #
+
+    def goto(uri)
+      uri = "http://#{uri}" unless uri =~ %r{://}
+
+      request = HtmlUnit::WebRequestSettings.new(::Java::JavaNet::URL.new(uri))
+      request.setCharset(@charset)
+
+      rescue_status_code_exception do
+        self.page = @webclient.getPage(request)
+      end
+
+      url()
+    end
+
+    #
+    # Set the credentials used for basic HTTP authentication. (Celerity only)
+    #
+    # Example:
+    #   browser.credentials = "username:password"
+    #
+    # @param [String] A string with username / password, separated by a colon
+    #
+
+    def credentials=(string)
+      user, pass = string.split(":")
+      dcp = HtmlUnit::DefaultCredentialsProvider.new
+      dcp.addCredentials(user, pass)
+      @webclient.setCredentialsProvider(dcp)
+    end
+
+    #
+    # Unsets the current page / closes all windows
+    #
+
+    def close
+      @page = nil
+      @webclient.closeAllWindows
+      @viewer.close
+    end
+
+    #
+    # @return [String] the URL of the current page
+    #
+
+    def url
+      assert_exists
+      @page.getWebResponse.getRequestUrl.toString
+    end
+
+    #
+    # @return [String] the title of the current page
+    #
+
+    def title
+      @page ? @page.getTitleText : ''
+    end
+
+    #
+    # @return [String] the value of window.status
+    #
+
+    def status
+      execute_script "window.status" # avoid the listener overhead
+    end
+
+    #
+    # @return [String] the HTML content of the current page
+    #
+
+    def html
+      @page ? @page.getWebResponse.getContentAsString(@charset) : ''
+    end
+
+    #
+    # @return [String] the XML representation of the DOM
+    #
+
+    def xml
+      return '' unless @page
+      return @page.asXml if @page.respond_to?(:asXml)
+      return text # fallback to text (for exampel for "plain/text" pages)
+    end
+
+    #
+    # @return [String] a text representation of the current page
+    #
+
+    def text
+      return '' unless @page
+
+      if @page.respond_to?("getContent")
+        string = @page.getContent.strip
+      elsif @page.documentElement
+        string = @page.documentElement.asText.strip
+      else
+        string = ''
+      end
+
+      # Celerity::Util.normalize_text(string)
+      string
+    end
+
+    #
+    # @return [Hash] response headers as a hash
+    #
+
+    def response_headers
+      return {} unless @page
+
+      Hash[*@page.getWebResponse.getResponseHeaders.map { |obj| [obj.name, obj.value] }.flatten]
+    end
+
+    #
+    # @return [Fixnum] status code of the last request
+    #
+
+    def status_code
+      @page.getWebResponse.getStatusCode
+    end
+
+    #
+    # @return [String] content-type as in 'text/html'
+    #
+
+    def content_type
+      return '' unless @page
+
+      @page.getWebResponse.getContentType
+    end
+
+    #
+    # @return [IO, nil] page contents as an IO, returns nil if no page is loaded.
+    #
+
+    def io
+      return nil unless @page
+
+      @page.getWebResponse.getContentAsStream.to_io
+    end
+
+    #
+    # Check if the current page contains the given text.
+    #
+    # @param  [String, Regexp] expected_text The text to look for.
+    # @return [Numeric, nil]  The index of the matched text, or nil if it isn't found.
+    # @raise  [TypeError]
+    #
+
+    def contains_text(expected_text)
+      return nil unless exist?
+      super
+    end
+
+    #
+    # @return [HtmlUnit::HtmlHtml] the underlying HtmlUnit document.
+    #
+
+    def document
+      @object
+    end
+
+    #
+    # Goto back one history item
+    # @return [String] The url of the resulting page.
+    #
+
+    def back
+      @webclient.getCurrentWindow.getHistory.back
+      refresh_page_from_window
+
+      url
+    end
+
+    #
+    # Go forward one history item
+    # @return [String] The url of the resulting page.
+    #
+
+    def forward
+      @webclient.getCurrentWindow.getHistory.forward
+      refresh_page_from_window
+
+      url
+    end
+
+    #
+    # Wait for javascript jobs to finish
+    #
+
+    def wait
+      assert_exists
+      @webclient.waitForBackgroundJavaScript(10000);
+    end
+
+    #
+    # Refresh the current page
+    #
+
+    def refresh
+      assert_exists
+      @page.refresh
+    end
+
+    #
+    # Clears all cookies. (Celerity only)
+    #
+
+    def clear_cookies
+      @webclient.getCookieManager.clearCookies
+    end
+
+    #
+    # Clears the cache of "compiled JavaScript files and parsed CSS snippets"
+    #
+
+    def clear_cache
+      @webclient.cache.clear
+    end
+
+    #
+    # Get the cookies for this session. (Celerity only)
+    #
+    # @return [Hash<domain, Hash<name, value>>]
+    #
+
+    def cookies
+      result = Hash.new { |hash, key| hash[key] = {} }
+
+      cookies = @webclient.getCookieManager.getCookies
+      cookies.each do |cookie|
+        result[cookie.getDomain][cookie.getName] = cookie.getValue
+      end
+
+      result
+    end
+
+    #
+    # Add a cookie with the given parameters (Celerity only)
+    #
+    # @param [String] domain
+    # @param [String] name
+    # @param [String] value
+    #
+    # @option opts :path    [String]  ("/") A path
+    # @option opts :max_age [Fixnum]  (??) A max age
+    # @option opts :secure  [Boolean] (false)
+    #
+
+    def add_cookie(domain, name, value, opts = {})
+      path    = opts.delete(:path) || "/"
+      max_age = opts.delete(:max_age) || (Time.now + 60*60*24) # not sure if this is correct
+      secure  = opts.delete(:secure) || false
+
+      raise(ArgumentError, "unknown option: #{opts.inspect}") unless opts.empty?
+
+      cookie = Cookie.new(domain, name, value, path, max_age, secure)
+      @webclient.getCookieManager.addCookie(cookie)
+    end
+
+    #
+    # Remove the cookie with the given domain and name (Celerity only)
+    #
+    # @param [String] domain
+    # @param [String] name
+    #
+    # @raise [CookieNotFoundError] if the cookie doesn't exist
+    #
+
+    def remove_cookie(domain, name)
+      cm = @webclient.getCookieManager
+      cookie = cm.getCookies.find { |c| c.getDomain == domain && c.getName == name }
+
+      if cookie.nil?
+        raise CookieNotFoundError, "no cookie with domain #{domain.inspect} and name #{name.inspect}"
+      end
+
+      cm.removeCookie(cookie)
+    end
+
+    #
+    # Execute the given JavaScript on the current page.
+    # @return [Object] The resulting Object
+    #
+
+    def execute_script(source)
+      assert_exists
+      @page.executeJavaScript(source.to_s).getJavaScriptResult
+    end
+
+    # experimental - should be removed?
+    def send_keys(keys)
+      keys = keys.gsub(/\s*/, '').scan(/((?:\{[A-Z]+?\})|.)/u).flatten
+      keys.each do |key|
+        element = @page.getFocusedElement
+        case key
+        when "{TAB}"
+          @page.tabToNextElement
+        when /\w/
+          element.type(key)
+        else
+          raise NotImplementedError
+        end
+      end
+    end
+
+    #
+    # Wait until the given block evaluates to true (Celerity only)
+    #
+    # @param [Fixnum] timeout Number of seconds to wait before timing out (default: 30).
+    # @yieldparam [Celerity::Browser] browser The browser instance.
+    # @see Celerity::Browser#resynchronized
+    #
+
+    def wait_until(timeout = 30, &block)
+      returned = nil
+
+      Timeout.timeout(timeout) do
+        until returned = yield(self)
+          refresh_page_from_window
+          sleep 0.1
+        end
+      end
+
+      returned
+    end
+
+    #
+    # Wait while the given block evaluates to true (Celerity only)
+    #
+    # @param [Fixnum] timeout Number of seconds to wait before timing out (default: 30).
+    # @yieldparam [Celerity::Browser] browser The browser instance.
+    # @see Celerity::Browser#resynchronized
+    #
+
+    def wait_while(timeout = 30, &block)
+      returned = nil
+
+      Timeout.timeout(timeout) do
+        while returned = yield(self)
+          refresh_page_from_window
+          sleep 0.1
+        end
+      end
+
+      returned
+    end
+
+    #
+    # Allows you to temporarily switch to HtmlUnit's NicelyResynchronizingAjaxController
+    # to resynchronize ajax calls.
+    #
+    #   @browser.resynchronized do |b|
+    #     b.link(:id, 'trigger_ajax_call').click
+    #   end
+    #
+    # @yieldparam [Celerity::Browser] browser The current browser object.
+    # @see Celerity::Browser#new for how to configure the browser to always use this.
+    #
+
+    def resynchronized(&block)
+      old_controller = @webclient.ajaxController
+      @webclient.setAjaxController(::HtmlUnit::NicelyResynchronizingAjaxController.new)
+      yield self
+      @webclient.setAjaxController(old_controller)
+    end
+
+    #
+    # Allows you to temporarliy switch to HtmlUnit's default AjaxController, so
+    # ajax calls are performed asynchronously. This is useful if you have created
+    # the Browser with :resynchronize => true, but want to switch it off temporarily.
+    #
+    # @yieldparam [Celerity::Browser] browser The current browser object.
+    # @see Celerity::Browser#new
+    #
+
+    def asynchronized(&block)
+      old_controller = @webclient.ajaxController
+      @webclient.setAjaxController(::HtmlUnit::AjaxController.new)
+      yield self
+      @webclient.setAjaxController(old_controller)
+    end
+
+    #
+    # Start or stop HtmlUnit's DebuggingWebConnection. (Celerity only)
+    # The output will go to /tmp/«name»
+    #
+    # @param [String]  name directory name
+    # @param [block]   blk block to execute
+    #
+
+    def debug_web_connection(name, &blk)
+      old_wc = @webclient.getWebConnection
+
+      @webclient.setWebConnection HtmlUnit::Util::DebuggingWebConnection.new(old_wc, name)
+      res = yield
+      @webclient.setWebConnection old_wc
+
+      res
+    end
+
+    #
+    # Add a listener block for one of the available types. (Celerity only)
+    # Types map to HtmlUnit interfaces like this:
+    #
+    #   :status           => StatusHandler
+    #   :alert            => AlertHandler  ( window.alert() )
+    #   :web_window_event => WebWindowListener
+    #   :html_parser      => HTMLParserListener
+    #   :incorrectness    => IncorrectnessListener
+    #   :confirm          => ConfirmHandler ( window.confirm() )
+    #   :prompt           => PromptHandler ( window.prompt() )
+    #
+    # Examples:
+    #
+    #   browser.add_listener(:status) { |page, message| ... }
+    #   browser.add_listener(:alert) { |page, message| ... }
+    #   browser.add_listener(:web_window_event) { |web_window_event| ... }
+    #   browser.add_listener(:html_parser) { |message, url, line, column, key| ... }
+    #   browser.add_listener(:incorrectness) { |message, origin| ... }
+    #   browser.add_listener(:confirm) { |page, message| ...; true }
+    #   browser.add_listener(:prompt) { |page, message| ... }
+    #
+    #
+    # @param [Symbol] type One of the above symbols.
+    # @param [Proc] block A block to be executed for events of this type.
+    #
+
+    def add_listener(type, &block)
+      listener.add_listener(type, &block)
+    end
+
+    def remove_listener(type, &block)
+      listener.remove_listener(type, &block)
+    end
+
+    #
+    # Specify a boolean value to click either 'OK' or 'Cancel' in any confirm
+    # dialogs that might show up during the duration of the given block.
+    #
+    # (Celerity only)
+    #
+    # @param [Boolean] bool true to click 'OK', false to click 'cancel'
+    # @param [Proc] block A block that will trigger the confirm() call(s).
+    #
+
+    def confirm(bool, &block)
+      blk = lambda { bool }
+
+      listener.add_listener(:confirm, &blk)
+      yield
+      listener.remove_listener(:confirm, blk)
+    end
+
+    #
+    # Add a 'checker' proc that will be run on every page load
+    #
+    # @param [Proc] checker The proc to be run (can also be given as a block)
+    # @yieldparam [Celerity::Browser] browser The current browser object.
+    # @raise [ArgumentError] if no Proc or block was given.
+    #
+
+    def add_checker(checker = nil, &block)
+      if block_given?
+        @error_checkers << block
+      elsif Proc === checker
+        @error_checkers << checker
+      else
+        raise ArgumentError, "argument must be a Proc or block"
+      end
+    end
+
+    #
+    # Remove the given checker from the list of checkers
+    # @param [Proc] checker The Proc to disable.
+    #
+
+    def disable_checker(checker)
+      @error_checkers.delete(checker)
+    end
+
+    #
+    # :finest, :finer, :fine, :config, :info, :warning, :severe, or :off, :all
+    #
+    # @return [Symbol] the current log level
+    #
+
+    def log_level
+      Celerity::Util.logger_for('com.gargoylesoftware.htmlunit').level.to_s.downcase.to_sym
+    end
+
+    #
+    # Set Java log level (default is :warning, can be any of :all, :finest, :finer, :fine, :config, :info, :warning, :severe, :off)
+    #
+    # @param [Symbol] level The new log level.
+    #
+
+    def log_level=(level)
+      log_level = java.util.logging.Level.const_get(level.to_s.upcase)
+
+      [ 'com.gargoylesoftware.htmlunit',
+        'com.gargoylesoftware.htmlunit.html',
+        'com.gargoylesoftware.htmlunit.javascript',
+        'org.apache.commons.httpclient'
+      ].each { |package| Celerity::Util.logger_for(package).level = log_level }
+
+      level
+    end
+
+    #
+    # If a request is made to an URL that matches the pattern set here, Celerity
+    # will ignore the request and return an empty page with content type "text/html" instead.
+    #
+    # This is useful to block unwanted requests (like ads/banners).
+    #
+
+    def ignore_pattern=(regexp)
+      unless regexp.kind_of?(Regexp)
+        raise TypeError, "expected Regexp, got #{regexp.inspect}:#{regexp.class}"
+      end
+
+      Celerity::IgnoringWebConnection.new(@webclient, regexp)
+    end
+
+    #
+    # Checks if we have a page currently loaded.
+    # @return [true, false]
+    #
+
+    def exist?
+      !!@page
+    end
+    alias_method :exists?, :exist?
+
+    #
+    # Turn on/off javascript exceptions
+    #
+    # @param [Bool]
+    #
+
+    def javascript_exceptions=(bool)
+      @webclient.throwExceptionOnScriptError = bool
+    end
+
+    def javascript_exceptions
+      @webclient.throwExceptionOnScriptError
+    end
+
+    #
+    # Turn on/off status code exceptions
+    #
+    # @param [Bool]
+    #
+
+    def status_code_exceptions=(bool)
+      @webclient.throwExceptionOnFailingStatusCode = bool
+    end
+
+    def status_code_exceptions
+      @webclient.throwExceptionOnFailingStatusCode
+    end
+
+    #
+    # Turn on/off CSS loading
+    #
+    # @param [Bool]
+    #
+
+    def css=(bool)
+      @webclient.cssEnabled = bool
+    end
+
+    def css
+      @webclient.cssEnabled
+    end
+
+    def refresh_handler=(symbol)
+      handler = case symbol
+                when :waiting
+                  HtmlUnit::WaitingRefreshHandler.new
+                when :threaded
+                  HtmlUnit::ThreadedRefreshHandler.new
+                when :immediate
+                  HtmlUnit::ImmediateRefreshHandler.new
+                else
+                  raise ArgumentError, "expected :waiting, :threaded or :immediate"
+                end
+
+      @webclient.setRefreshHandler handler
+    end
+
+    #
+    # Turn on/off secure SSL
+    #
+    # @param [Bool]
+    #
+
+    def secure_ssl=(bool)
+      @webclient.useInsecureSSL = !bool
+    end
+
+    def secure_ssl
+      !@webclient.useInsecureSSL
+    end
+
+    #
+    # Turn on/off JavaScript execution
+    #
+    # @param [Bool]
+    #
+
+    def javascript_enabled=(bool)
+      @webclient.setJavaScriptEnabled(bool)
+    end
+
+    def javascript_enabled
+      @webclient.isJavaScriptEnabled
+    end
+
+    #
+    # Sets the current page object for the browser
+    #
+    # @param [HtmlUnit::HtmlPage] value The page to set.
+    # @api private
+    #
+
+    def page=(value)
+      return if @page == value
+      @page = value
+
+      if @page.respond_to?("getDocumentElement")
+        @object = @page.getDocumentElement || @object
+      elsif @page.is_a? HtmlUnit::UnexpectedPage
+        raise UnexpectedPageException, @page.getWebResponse.getContentType
+      end
+
+      render unless @viewer == DefaultViewer
+      run_error_checks
+
+      value
+    end
+
+    #
+    # Check that we have a @page object.
+    #
+    # @raise [UnknownObjectException] if no page is loaded.
+    # @api private
+    #
+
+    def assert_exists
+      raise UnknownObjectException, "no page loaded" unless exist?
+    end
+
+    #
+    # Returns the element that currently has the focus (Celerity only)
+    #
+
+    def focused_element
+      element_from_dom_node(page.getFocusedElement())
+    end
+
+    #
+    # Enable Celerity's internal WebWindowEventListener
+    #
+    # @api private
+    #
+
+    def enable_event_listener
+      @event_listener ||= lambda do |event|
+        self.page = @page ? @page.getEnclosingWindow.getEnclosedPage : event.getNewPage
+      end
+
+      listener.add_listener(:web_window_event, &@event_listener)
+    end
+
+    #
+    # Disable Celerity's internal WebWindowEventListener
+    #
+    # @api private
+    #
+
+    def disable_event_listener
+      listener.remove_listener(:web_window_event, @event_listener)
+
+      if block_given?
+        result = yield
+        enable_event_listener
+
+        result
+      end
+    end
+
+    private
+
+    #
+    # Runs the all the checker procs added by +add_checker+
+    #
+    # @see add_checker
+    # @api private
+    #
+
+    def run_error_checks
+      @error_checkers.each { |e| e[self] }
+    end
+
+    #
+    # Configure the webclient according to the options given to #new.
+    # @see initialize
+    #
+
+    def setup_webclient(opts)
+      browser = (opts.delete(:browser) || :firefox).to_sym
+
+      browser_version = case browser
+                        when :firefox, :ff, :ff2
+                          ::HtmlUnit::BrowserVersion::FIREFOX_2
+                        when :firefox3, :ff3
+                          ::HtmlUnit::BrowserVersion::FIREFOX_3
+                        when :internet_explorer, :ie
+                          ::HtmlUnit::BrowserVersion::INTERNET_EXPLORER_7
+                        else
+                          raise ArgumentError, "unknown browser: #{browser.inspect}"
+                        end
+
+      if ua = opts.delete(:user_agent)
+        browser_version.setUserAgent(ua)
+      end
+
+      @webclient = if proxy = opts.delete(:proxy)
+                     phost, pport = proxy.split(":")
+                     ::HtmlUnit::WebClient.new(browser_version, phost, pport.to_i)
+                   else
+                     ::HtmlUnit::WebClient.new(browser_version)
+                   end
+
+      self.javascript_exceptions  = false unless opts.delete(:javascript_exceptions)
+      self.status_code_exceptions = false unless opts.delete(:status_code_exceptions)
+      self.css                    = false unless opts.delete(:css)
+      self.javascript_enabled     = opts.delete(:javascript_enabled) != false
+      self.secure_ssl             = opts.delete(:secure_ssl) == false
+      self.ignore_pattern         = opts.delete(:ignore_pattern) if opts[:ignore_pattern]
+      self.refresh_handler        = opts.delete(:refresh_handler) if opts[:refresh_handler]
+
+      if opts.delete(:resynchronize)
+        controller = ::HtmlUnit::NicelyResynchronizingAjaxController.new
+        @webclient.setAjaxController controller
+      end
+
+      enable_event_listener
+    end
+
+    def setup_viewer(option)
+      @viewer = DefaultViewer
+      return if option == false
+
+      host_string = option.kind_of?(String) ? option : "127.0.0.1:6429"
+      host, port  = host_string.split(":")
+
+      if viewer = ViewerConnection.create(host, port.to_i)
+        @viewer = viewer
+      end
+    rescue Errno::ECONNREFUSED => e
+      nil
+    end
+
+    #
+    # This *should* be unneccessary, but sometimes the page we get from the
+    # window is different (ie. a different object) from our current @page
+    # (Used by #wait_while and #wait_until)
+    #
+
+    def refresh_page_from_window
+      new_page = @page.getEnclosingWindow.getEnclosedPage
+
+      if new_page && (new_page != @page)
+        self.page = new_page
+      else
+        Log.debug "unneccessary refresh"
+      end
+    end
+
+    #
+    # Render the current page on the connected viewer.
+    # @api private
+    #
+
+    def render
+      @viewer.render_html(self.send(@render_type), url)
+    rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::EPIPE
+      @viewer = DefaultViewer
+    end
+
+    def listener
+      @listener ||= Celerity::Listener.new(@webclient)
+    end
+
+  end # Browser
+end # Celerity