jarib-celerity 0.0.5 → 0.0.5.1

data/README.txt

@@ -2,14 +2,11 @@
 
 * http://celerity.rubyforge.org/
 
-== TUTORIAL:
-
-* http://celerity.rubyforge.org/wiki/wiki.pl?GettingStarted
-
 == DESCRIPTION:
 
-Celerity is a JRuby library for easy and fast functional test automation for web applications.
-It is a wrapper around the HtmlUnit Java library and is currently aimed at providing the same API and functionality as Watir.
+Celerity 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.
 
 == FEATURES:
 
@@ -28,6 +25,10 @@ It is a wrapper around the HtmlUnit Java library and is currently aimed at provi
 
   `jruby -S gem install celerity`
   
+  or from GitHub
+  
+  `jruby -S gem install jarib-celerity`
+  
   
 == EXAMPLE:
 
@@ -41,9 +42,13 @@ It is a wrapper around the HtmlUnit Java library and is currently aimed at provi
 
   puts "yay" if browser.text.include? 'celerity.rubyforge.org'
   
-== GIT
+== SOURCE
+
+The source code is available at http://github.com/jarib/celerity/tree/master 
+
+== WIKI:
 
-The project is manually mirrored @ http://github.com/jarib/celerity/tree/master 
+* http://github.com/jarib/celerity/wikis
 
 == LICENSE:
 

data/lib/celerity/browser.rb

@@ -2,7 +2,7 @@ module Celerity
   class Browser
     include Container
 
-    attr_accessor :page, :object
+    attr_accessor :page, :object, :charset
     attr_reader :webclient, :viewer
 
     # Initialize a browser and goto the given URL
@@ -14,45 +14,54 @@ module Celerity
       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.
     #
-    # @option opts :log_level [Symbol] (:warning) @see log_level= 
+    # @option opts :log_level [Symbol] (:warning) @see log_level=
     # @option opts :browser [:firefox, :internet_explorer] (:internet_explorer) Set the BrowserVersion used by HtmlUnit. Defaults to Internet Explorer.
     # @option opts :css [Boolean] (false) Enable CSS.  Disabled by default.
     # @option opts :secure_ssl [Boolean] (true)  Disable secure SSL. 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 :render [:html, :xml](:html) What DOM representation to send to connected viewers.
+    # @option opts :render [:html, :xml] (:html) What DOM representation to send to connected viewers.
+    # @option opts :charset [String] ("UTF-8") Specify the charset that webclient will use by default.
+    # @option opts :proxy [String] (nil) Proxy server to use, in address:port format.
     #
     # @return [Celerity::Browser]     An instance of the browser.
     # @see Celerity::Container for a small introduction to the API.
     # @api public
     def initialize(opts = {})
-      raise TypeError, "bad argument: #{opts.inspect}" unless opts.is_a? Hash
-      unless [:html, :xml, nil].include?(opts[:render])
-        raise ArgumentError, "bad argument :render => #{opts[:render].inspect}"
+      unless opts.is_a?(Hash)
+        raise TypeError, "wrong argument type #{opts.class}, expected Hash"
       end
 
-      opts[:render] = opts[:render] || :html
+      unless (render_types = [:html, :xml, nil]).include?(opts[:render])
+        raise ArgumentError, "expected one of #{render_types.inspect} for key :render"
+      end
+
+      @render_type   = opts.delete(:render)    || :html
+      @charset       = opts.delete(:charset)   || "UTF-8"
+      @proxy         = opts.delete(:proxy)     || nil
+      self.log_level = opts.delete(:log_level) || :warning
 
-      @opts            = opts
       @last_url, @page = nil
       @error_checkers  = []
       @browser         = self # for Container#browser
 
-      self.log_level = @opts[:log_level] || :warning
-
-      browser = @opts[:browser] == :firefox ?
-          ::HtmlUnit::BrowserVersion::FIREFOX_2 : ::HtmlUnit::BrowserVersion::INTERNET_EXPLORER_7_0
+      browser = case opts.delete(:browser)
+                when :firefox then ::HtmlUnit::BrowserVersion::FIREFOX_2
+                else               ::HtmlUnit::BrowserVersion::INTERNET_EXPLORER_7_0
+                end
 
       @webclient = ::HtmlUnit::WebClient.new(browser)
-      
-      configure_webclient
+
+      configure_webclient(opts)
+      raise ArgumentError, "unknown option #{opts.inspect}" unless opts.empty?
       find_viewer
     end
 
@@ -62,7 +71,11 @@ module Celerity
     # @return [String] The url.
     def goto(uri)
       uri = "http://#{uri}" unless uri =~ %r{://}
-      self.page = @webclient.getPage(uri)
+
+      request = HtmlUnit::WebRequestSettings.new(::Java::JavaNet::URL.new(uri))
+      request.setCharset(@charset)
+
+      self.page = @webclient.getPage(request)
 
       url()
     end
@@ -110,6 +123,27 @@ module Celerity
       # 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 [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.
     #
@@ -152,6 +186,12 @@ module Celerity
       goto(@last_url) if @last_url
     end
 
+    # Wait for ajax calls to finish
+    def join_threads
+      assert_exists
+      @page.getEnclosingWindow.getThreadManager.joinAll(10000)
+    end
+
     # Refresh the current page
     def refresh
       assert_exists
@@ -234,12 +274,13 @@ module Celerity
     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
       java.util.logging.Logger.getLogger('com.gargoylesoftware.htmlunit').level.to_s.downcase.to_sym
     end
-    
+
     # Set Java log level (default is :warning)
     #
     # @param [Symbol] level :finest, :finer, :fine, :config, :info, :warning, :severe, or :off, :all
@@ -313,14 +354,14 @@ module Celerity
 
       value
     end
-    
-    # Start or stop HtmlUnit's DebuggingWebConnection. 
+
+    # Start or stop HtmlUnit's DebuggingWebConnection.
     # The output will go to /tmp/«name»
-    # 
+    #
     # @param [Boolean] bool start or stop
     # @param [String]  name required if bool is true
     def debug_web_connection(bool, name = nil)
-      if bool 
+      if bool
         raise "no name given" unless name
         @old_webconnection = @webclient.getWebConnection
         dwc = HtmlUnit::Util::DebuggingWebConnection.new(@old_webconnection, name)
@@ -355,13 +396,18 @@ module Celerity
 
     # Configure the webclient according to the options given to #new.
     # @see initialize
-    def configure_webclient
-      @webclient.throwExceptionOnScriptError = false unless @opts[:javascript_exceptions]
-      @webclient.throwExceptionOnFailingStatusCode = false unless @opts[:status_code_exceptions]
-      @webclient.cssEnabled = false unless @opts[:css]
-      @webclient.useInsecureSSL = @opts[:secure_ssl] == false
-      @webclient.setAjaxController(::HtmlUnit::NicelyResynchronizingAjaxController.new) if @opts[:resynchronize]
-      
+    def configure_webclient(opts)
+      @webclient.throwExceptionOnScriptError = false unless opts.delete(:javascript_exceptions)
+      @webclient.throwExceptionOnFailingStatusCode = false unless opts.delete(:status_code_exceptions)
+      @webclient.cssEnabled = false unless opts.delete(:css)
+      @webclient.useInsecureSSL = opts.delete(:secure_ssl) == false
+
+      if @proxy
+        phost, pport = @proxy.split(":")
+        @webclient.proxyHost = phost
+        @webclient.proxyPort = pport.to_i
+      end
+      @webclient.setAjaxController(::HtmlUnit::NicelyResynchronizingAjaxController.new) if opts.delete(:resynchronize)
     end
 
     # This *should* be unneccessary, but sometimes the page we get from the
@@ -380,7 +426,7 @@ module Celerity
     # Render the current page on the viewer.
     # @api private
     def render
-      @viewer.render_html(self.send(@opts[:render]), url)
+      @viewer.render_html(self.send(@render_type), url)
     rescue DRb::DRbConnError, Errno::ECONNREFUSED => e
       @viewer = DefaultViewer
     end
@@ -390,7 +436,7 @@ module Celerity
     def find_viewer
       viewer = DRbObject.new_with_uri("druby://127.0.0.1:6429")
       if viewer.respond_to?(:render_html)
-        @viewer = viewer 
+        @viewer = viewer
       else
         @viewer = DefaultViewer
       end

data/lib/celerity/clickable_element.rb

@@ -17,7 +17,7 @@ module Celerity
       assert_exists
       assert_enabled if respond_to?(:assert_enabled)
 
-      browser = Browser.new
+      browser = Browser.new(:log_level => @browser.log_level)
       browser.update_page(@object.click)
 
       browser

data/lib/celerity/collections.rb

@@ -109,6 +109,10 @@ module Celerity
   class Spans < ElementCollections
     def element_class; Span; end
   end
+  
+  class Strongs < ElementCollections
+    def element_class; Strong; end
+  end
 
   class Divs < ElementCollections
     def element_class; Div; end

data/lib/celerity/container.rb

@@ -409,6 +409,16 @@ module Celerity
       Spans.new(self)
     end
 
+    # @return [Celerity::Spans]
+    def strong(*args)
+      Strong.new(self, *args)
+    end
+
+    # @return [Celerity::Strongs]
+    def strongs
+      Strongs.new(self)
+    end
+
     # @return [Celerity::Table]
     def table(*args)
       Table.new(self, *args)

data/lib/celerity/element.rb

@@ -162,7 +162,7 @@ module Celerity
 
       result = ''
       @object.getAttributes.each do |attribute|
-        result << %Q{#{attribute.getName}="#{attribute.getHtmlValue.to_s}"}
+        result << %Q{#{attribute.getName}="#{attribute.getHtmlValue}"}
       end
 
       result

data/lib/celerity/elements/button.rb

@@ -29,6 +29,5 @@ module Celerity
       end
     end
 
-  end
-
-end
+  end # Button
+end # Celerity

data/lib/celerity/elements/frame.rb

@@ -13,7 +13,8 @@ module Celerity
       super
       if @object
         @inline_frame_object = @object.getEnclosedWindow.getFrameElement
-        if (frame = @object.getEnclosedPage.getDocumentElement)
+        self.page            = @object.getEnclosedPage
+        if (frame = self.page.getDocumentElement)
           @object = frame
         end
       end

data/lib/celerity/elements/non_control_elements.rb

@@ -81,6 +81,10 @@ module Celerity
   class Span < NonControlElement
     TAGS = [ Identifier.new('span') ]
   end
+  
+  class Strong < NonControlElement
+    TAGS = [ Identifier.new('strong') ]
+  end
 
   # class Title < NonControlElement
   #   TAGS = [ Identifier.new('title') ]

data/lib/celerity/extra/method_generator.rb

@@ -150,9 +150,9 @@ end # Celerity
 #   require File.dirname(__FILE__) + "/../spec/spec_helper"
 #   $stdout.sync = true
 #   @ie = Browser.new
-#   @ie.goto(TEST_HOST + "/forms_with_input_elements.html")
+#   @ie.goto(HTML_DIR + "/forms_with_input_elements.html")
 #
 #   puts MethodGenerator.new(@ie).parse
-#   @ie.goto(TEST_HOST + "/forms3.html")
+#   @ie.goto(HTML_DIR + "/forms3.html")
 #   puts MethodGenerator.new(@ie).parse
 # end

data/lib/celerity.rb

@@ -10,6 +10,7 @@ require "timeout"
 require "time"
 require 'drb'
 require "fileutils"
+require "thread"
 
 module Celerity
   Log = Logger.new($DEBUG ? $stderr : nil)

data/tasks/rspec.rake

@@ -19,6 +19,7 @@ desc "Run the specs under spec/"
 Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "spec/spec.opts"]
   t.spec_files = FileList['spec/**/*_spec.rb']
+  # t.ruby_opts = %w[--headless] if RUBY_PLATFORM =~ /java/
   
   begin 
     require 'rcov'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jarib-celerity
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.5.1
 platform: ruby
 authors: 
 - Jari Bakken