jarib-celerity 0.0.6.11 → 0.0.6.12

data/lib/celerity.rb

@@ -66,6 +66,7 @@ require "celerity/elements/text_field.rb"
 require "celerity/util"
 require "celerity/default_viewer"
 require "celerity/listener"
+require "celerity/ignoring_web_connection"
 require "celerity/browser"
 require "celerity/watir_compatibility"
 

data/lib/celerity/browser.rb

@@ -32,9 +32,10 @@ module Celerity
     # @see Celerity::Container for an introduction to the main API.
     #
     # @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 :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)  Disable secure SSL. Enabled 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.
@@ -42,6 +43,7 @@ module Celerity
     # @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=
     #
     # @return [Celerity::Browser]     An instance of the browser.
     #
@@ -56,7 +58,7 @@ module Celerity
       unless (render_types = [:html, :xml, nil]).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
 
@@ -64,7 +66,7 @@ module Celerity
       @charset       = opts.delete(:charset)   || "UTF-8"
       self.log_level = opts.delete(:log_level) || :warning
 
-      @last_url, @page = nil
+      @page = nil
       @error_checkers  = []
       @browser         = self # for Container#browser
 
@@ -272,13 +274,27 @@ module Celerity
     end
 
     #
-    # Goto the last url - HtmlUnit doesn't have a 'back' functionality, so we only have 1 history item :)
-    # @return [String, nil] The url of the resulting page, or nil if none was stored.
+    # Goto back one history item
+    # @return [String] The url of the resulting page.
     #
 
     def back
-      # TODO: this is naive, need capability from HtmlUnit
-      goto(@last_url) if @last_url
+      @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
 
     #
@@ -349,7 +365,7 @@ module Celerity
       max_age = opts.delete(:max_age) || (Time.now + 60*60*24) # not sure if this is correct
       secure  = opts.delete(:secure) || false
 
-      raise "unknown option: #{opts.inspect}" unless opts.empty?
+      raise(ArgumentError, "unknown option: #{opts.inspect}") unless opts.empty?
 
       cookie = Cookie.new(domain, name, value, path, max_age, secure)
       @webclient.getCookieManager.addCookie(cookie)
@@ -361,13 +377,15 @@ module Celerity
     # @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 "no cookie with domain #{domain.inspect} and name #{name.inspect}"
+        raise CookieNotFoundError, "no cookie with domain #{domain.inspect} and name #{name.inspect}"
       end
 
       cm.removeCookie(cookie)
@@ -598,6 +616,21 @@ module Celerity
       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]
@@ -664,6 +697,20 @@ module Celerity
       !@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
     #
@@ -672,11 +719,10 @@ module Celerity
     #
 
     def page=(value)
-      @last_url = url() if exist?
       @page = value
 
       if @page.respond_to?("getDocumentElement")
-        @object = @page.getDocumentElement
+        @object = @page.getDocumentElement || @object
       elsif @page.is_a? HtmlUnit::UnexpectedPage
         raise UnexpectedPageException, @page.getWebResponse.getContentType
       end
@@ -690,7 +736,7 @@ module Celerity
     #
     # Check that we have a @page object.
     #
-    # @raise [Celerity::Exception::UnknownObjectException] if no page is loaded.
+    # @raise [UnknownObjectException] if no page is loaded.
     # @api private
     #
 
@@ -727,32 +773,35 @@ module Celerity
     def setup_webclient(opts)
       browser = (opts.delete(:browser) || :firefox).to_sym
 
-      case browser
-      when :firefox, :ff, :ff2
-        browser_version = ::HtmlUnit::BrowserVersion::FIREFOX_2
-      when :firefox3, :ff3
-        browser_version = ::HtmlUnit::BrowserVersion::FIREFOX_3
-      when :internet_explorer, :ie
-        browser_version = ::HtmlUnit::BrowserVersion::INTERNET_EXPLORER_7
-      else
-        raise ArgumentError, "unknown browser: #{browser.inspect}"
-      end
+      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
 
-      if proxy = opts.delete(:proxy)
-        phost, pport = proxy.split(":")
-        @webclient = ::HtmlUnit::WebClient.new(browser_version, phost, pport.to_i)
-      else
-        @webclient = ::HtmlUnit::WebClient.new(browser_version)
-      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]
+
       @webclient.setAjaxController(::HtmlUnit::NicelyResynchronizingAjaxController.new) if opts.delete(:resynchronize)
     end
 

data/lib/celerity/element_locator.rb

@@ -118,7 +118,7 @@ module Celerity
 
     def get_by_idents(meth, idents)
       with_nullpointer_retry do
-        @object.getAllHtmlChildElements.send(meth) do |e|
+        all_elements.send(meth) do |e|
           next unless @tags.include?(e.getTagName)
           idents.any? { |id| element_matches_ident?(e, id) }
         end
@@ -142,13 +142,20 @@ module Celerity
     def elements_by_tag_names(tags = @tags)
       with_nullpointer_retry do
         # HtmlUnit's getHtmlElementsByTagNames won't get elements in the correct
-        # order (making :index fail), so we're using getAllHtmlChildElements instead.
-        @object.getAllHtmlChildElements.select do |elem|
-          tags.include?(elem.getTagName)
-        end
+        # order (making :index fail), so we're looping through all elements instead.
+        all_elements.select { |elem| tags.include?(elem.getTagName) }
       end
     end
 
+    def all_elements
+      unless @object
+        raise %{internal error in #{self.class}: @container=#{@container.inspect} @element_class=#{@element_class.inspect}
+          Please report this failure and the code/HTML that caused it at http://github.com/jarib/celerity/issues}
+      end
+
+      @object.getAllHtmlChildElements
+    end
+
     # HtmlUnit throws NPEs sometimes when we're locating elements
     # Retry seems to work fine.
     def with_nullpointer_retry(max_retries = 3)

data/lib/celerity/elements/button.rb

@@ -3,7 +3,9 @@ module Celerity
   #
   # Input: Button
   #
-  # Class representing button elements
+  # Class representing button elements.
+  #
+  # This class covers both <button> and <input type="submit|reset|image|button" /> elements.
   #
 
   class Button < InputElement

data/lib/celerity/elements/meta.rb

@@ -1,6 +1,7 @@
 module Celerity
   class Meta < Element
-    ATTRIBUTES = [:name, :id, :'http-equiv', :content, :scheme] | HTML_401_TRANSITIONAL[:i18n]
+    ATTRIBUTES  = [:name, :id, :'http-equiv', :content, :scheme] | HTML_401_TRANSITIONAL[:i18n]
+    DEFAULT_HOW = :id
     TAGS = [ Identifier.new('meta') ]
   end
 end

data/lib/celerity/elements/option.rb

@@ -8,7 +8,7 @@ module Celerity
     include ClickableElement
     include DisabledElement
 
-    TAGS = [ Identifier.new('option')]
+    TAGS = [ Identifier.new('option') ]
     ATTRIBUTES = BASE_ATTRIBUTES | [:selected, :disabled, :label, :value]
     DEFAULT_HOW = :text
 

data/lib/celerity/exception.rb

@@ -73,5 +73,11 @@ module Celerity
 
     class UnexpectedPageException < CelerityException; end
 
+    #
+    # This exception is thrown if an unexpected content type is returned by the server.
+    #
+
+    class CookieNotFoundError < CelerityException; end
+
   end # Exception
 end # Celerity

data/lib/celerity/ignoring_web_connection.rb

@@ -0,0 +1,15 @@
+module Celerity
+  class IgnoringWebConnection < HtmlUnit::Util::FalsifyingWebConnection
+
+    def initialize(web_client, pattern)
+      super(web_client)
+      @pattern = pattern
+    end
+
+    def getResponse(request_settings)
+      return super unless request_settings.getUrl.toString =~ @pattern
+      createWebResponse(request_settings, "", "text/html")
+    end
+
+  end
+end

data/lib/celerity/version.rb

@@ -3,7 +3,7 @@ module Celerity #:nodoc:
     MAJOR = 0
     MINOR = 0
     TINY  = 6
-    PATCH = 11 # Set to nil for official release
+    PATCH = 12 # Set to nil for official release
 
     STRING = [MAJOR, MINOR, TINY, PATCH].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jarib-celerity
 version: !ruby/object:Gem::Version 
-  version: 0.0.6.11
+  version: 0.0.6.12
 platform: ruby
 authors: 
 - Jari Bakken
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-26 00:00:00 -07:00
+date: 2009-07-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,7 +37,6 @@ extra_rdoc_files:
 files: 
 - History.txt
 - lib
-- lib/celerity
 - lib/celerity/browser.rb
 - lib/celerity/clickable_element.rb
 - lib/celerity/collections.rb
@@ -47,7 +46,6 @@ files:
 - lib/celerity/element.rb
 - lib/celerity/element_collection.rb
 - lib/celerity/element_locator.rb
-- lib/celerity/elements
 - lib/celerity/elements/button.rb
 - lib/celerity/elements/file_field.rb
 - lib/celerity/elements/form.rb
@@ -66,7 +64,16 @@ files:
 - lib/celerity/elements/table_row.rb
 - lib/celerity/elements/text_field.rb
 - lib/celerity/exception.rb
-- lib/celerity/htmlunit
+- lib/celerity/htmlunit.rb
+- lib/celerity/identifier.rb
+- lib/celerity/ignoring_web_connection.rb
+- lib/celerity/input_element.rb
+- lib/celerity/listener.rb
+- lib/celerity/short_inspect.rb
+- lib/celerity/util.rb
+- lib/celerity/version.rb
+- lib/celerity/watir_compatibility.rb
+- lib/celerity.rb
 - lib/celerity/htmlunit/commons-codec-1.3.jar
 - lib/celerity/htmlunit/commons-collections-3.2.1.jar
 - lib/celerity/htmlunit/commons-httpclient-3.1.jar
@@ -76,23 +83,13 @@ files:
 - 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-20090507.082850-2.jar
+- lib/celerity/htmlunit/nekohtml-1.9.13-20090714.153721-7.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.8.1.jar
 - lib/celerity/htmlunit/xml-apis-1.3.04.jar
-- lib/celerity/htmlunit.rb
-- lib/celerity/identifier.rb
-- lib/celerity/input_element.rb
-- lib/celerity/listener.rb
-- lib/celerity/resources
 - lib/celerity/resources/no_viewer.png
-- lib/celerity/short_inspect.rb
-- lib/celerity/util.rb
-- lib/celerity/version.rb
-- lib/celerity/watir_compatibility.rb
-- lib/celerity.rb
 - License.txt
 - Rakefile
 - README.txt
@@ -101,6 +98,7 @@ files:
 - tasks/rdoc.rake
 has_rdoc: false
 homepage: http://celerity.rubyforge.org
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
@@ -122,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: celerity
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Celerity is a JRuby library for easy and fast functional test automation for web applications