jarib-celerity 0.0.6.7 → 0.0.6.8

data/README.txt

@@ -50,6 +50,10 @@ The source code is available at http://github.com/jarib/celerity/tree/master
 
 * http://github.com/jarib/celerity/wikis
 
+== BUG TRACKER:
+
+* http://github.com/jarib/celerity/issues
+
 == LICENSE:
 
 Celerity - JRuby wrapper for HtmlUnit

data/lib/celerity/browser.rb

@@ -3,7 +3,7 @@ module Celerity
     include Container
 
     attr_accessor :page, :object, :charset
-    attr_reader :webclient, :viewer
+    attr_reader :webclient, :viewer, :options
 
     #
     # Initialize a browser and go to the given URL
@@ -27,7 +27,7 @@ module Celerity
     end
 
     def inspect
-      short_inspect :exclude => %w[@webclient @browser @object]
+      short_inspect :exclude => %w[@webclient @browser @object @options]
     end
 
     #
@@ -43,7 +43,7 @@ module Celerity
     # @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 :charset [String] ("UTF-8") Specify the charset that webclient will use 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
     #
@@ -61,6 +61,8 @@ module Celerity
         raise ArgumentError, "expected one of #{render_types.inspect} for key :render"
       end
 
+      @options = opts.dup # for ClickableElement#click_and_attach
+
       @render_type   = opts.delete(:render)    || :html
       @charset       = opts.delete(:charset)   || "UTF-8"
       self.log_level = opts.delete(:log_level) || :warning
@@ -142,7 +144,7 @@ module Celerity
     #
 
     def html
-      @page ? @page.getWebResponse.getContentAsString : ''
+      @page ? @page.getWebResponse.getContentAsString(@charset) : ''
     end
 
     #
@@ -164,8 +166,10 @@ module Celerity
 
       if @page.respond_to?("getContent")
         string = @page.getContent.strip
-      else
+      elsif @page.documentElement
         string = @page.documentElement.asText.strip
+      else
+        string = ''
       end
 
       # Celerity::Util.normalize_text(string)
@@ -421,7 +425,8 @@ module Celerity
     end
 
     #
-    # Allows you to temporarily switch to HtmlUnit's NicelyResynchronizingAjaxController to resynchronize ajax calls.
+    # Allows you to temporarily switch to HtmlUnit's NicelyResynchronizingAjaxController
+    # to resynchronize ajax calls.
     #
     #   @browser.resynchronized do |b|
     #     b.link(:id, 'trigger_ajax_call').click
@@ -439,8 +444,9 @@ module Celerity
     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.
+    # 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
@@ -485,6 +491,16 @@ module Celerity
     #   :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.
@@ -551,18 +567,18 @@ module Celerity
     end
 
     #
-    # Set Java log level (default is :warning)
+    # Set Java log level (default is :warning, can be any of :all, :finest, :finer, :fine, :config, :info, :warning, :severe, :off)
     #
-    # @param [Symbol] level :finest, :finer, :fine, :config, :info, :warning, :severe, or :off, :all
+    # @param [Symbol] level The new log level.
     #
 
     def log_level=(level)
       log_level = java.util.logging.Level.const_get(level.to_s.upcase)
 
-      [ logger_for('com.gargoylesoftware.htmlunit'),
-        logger_for("org.apache.commons.htmlunit.html"),
-        logger_for("org.apache.commons.httpclient")
-      ].each { |logger| logger.level = log_level }
+      [ 'com.gargoylesoftware.htmlunit',
+        'com.gargoylesoftware.htmlunit.html',
+        'org.apache.commons.httpclient'
+      ].each { |package| logger_for(package).level = log_level }
 
       level
     end
@@ -707,8 +723,7 @@ module Celerity
 
       if ua = opts.delete(:user_agent)
         browser_version.setUserAgent(ua)
-      end 
-
+      end
 
       if proxy = opts.delete(:proxy)
         phost, pport = proxy.split(":")
@@ -757,6 +772,9 @@ module Celerity
     #
 
     def find_viewer
+      # needed to avoid DRb raising and rescuing lots exceptions
+      DRb.start_service unless DRb.primary_server
+      
       viewer = DRbObject.new_with_uri("druby://127.0.0.1:6429")
       if viewer.respond_to?(:render_html)
         @viewer = viewer
@@ -772,11 +790,8 @@ module Celerity
     #
 
     def element_from_dom_node(obj)
-      if element_class = Celerity::Util.htmlunit2celerity(obj.class)
-        element_class.new(self, :object, obj)
-      else
-        Element.new(self, :object, obj)
-      end
+      element_class = Celerity::Util.htmlunit2celerity(obj.class) || Element
+      element_class.new(self, :object, obj)
     end
 
     def logger_for(class_string)

data/lib/celerity/clickable_element.rb

@@ -37,12 +37,27 @@ module Celerity
 
     def click_and_attach
       assert_exists_and_enabled
-      browser = Browser.new(:log_level => @browser.log_level)
+      browser = Browser.new(@browser.options.dup)
+      browser.webclient.set_cookie_manager(
+        @browser.webclient.get_cookie_manager
+      ) # hirobumi: we do want cookies as well.
+
       rescue_status_code_exception { browser.update_page(@object.click) }
 
       browser
     end
 
+    #
+    # Click the element and just return the content as IO. Current page stays unchanged.
+    #
+    # @return [IO]
+    #
+
+    def download
+      assert_exists_and_enabled
+      @object.click.getWebResponse.getContentAsStream.to_io
+    end
+
     private
 
     def assert_exists_and_enabled

data/lib/celerity/collections.rb

@@ -51,7 +51,7 @@ module Celerity
   class Dts < ElementCollection
     def element_class; Dt; end
   end
-  
+
   class Ems < ElementCollection
     def element_class; Em; end
   end
@@ -113,7 +113,7 @@ module Celerity
   class Spans < ElementCollection
     def element_class; Span; end
   end
-  
+
   class Strongs < ElementCollection
     def element_class; Strong; end
   end

data/lib/celerity/default_viewer.rb

@@ -1,7 +1,7 @@
 module Celerity
   class DefaultViewer
     IMAGE = "#{Celerity::DIR}/resources/no_viewer.png"
-    
+
     def self.save(path = nil)
       return unless path
       FileUtils.copy(IMAGE, path)

data/lib/celerity/disabled_element.rb

@@ -1,12 +1,12 @@
 module Celerity
-  
+
   #
   # Mixed in to all elements that can have the 'disabled' attribute.
   #
 
   module DisabledElement
     include Celerity::Exception
-    
+
     #
     # Returns false if the element is disabled.
     #
@@ -17,14 +17,14 @@ module Celerity
 
     #
     # Returns true if the element is disabled.
-    # 
-    
+    #
+
     def disabled?
       assert_exists unless defined?(@object) && @object
       @object.isDisabled
     end
     alias_method :disabled, :disabled?
-    
+
     #
     # Used internally.
     # @api private

data/lib/celerity/element.rb

@@ -1,9 +1,9 @@
 module Celerity
-  
+
   #
   # Superclass for all HTML elements.
-  # 
-  
+  #
+
   class Element
     include Exception
     include Container
@@ -57,7 +57,7 @@ module Celerity
     #
     # Get the parent element
     # @return [Celerity::Element, nil] subclass of Celerity::Element, or nil if no parent was found
-    # 
+    #
 
     def parent
       assert_exists
@@ -73,13 +73,13 @@ module Celerity
 
     #
     # Sets the focus to this element.
-    # 
+    #
 
     def focus
       assert_exists
       @object.focus
     end
-    
+
     #
     # Fires the given event for this element
     #
@@ -92,12 +92,16 @@ module Celerity
     #
     # Used internally. Find the element on the page.
     # @api private
-    # 
+    #
 
     def locate
       @object = ElementLocator.new(@container, self.class).find_by_conditions(@conditions)
     end
     
+    # 
+    # Returns the HtmlUnit object backing this element
+    # 
+
     def object
       @object || locate
     end
@@ -114,7 +118,7 @@ module Celerity
     #
     # @param [String, #to_s] The attribute.
     # @return [String] The value of the given attribute.
-    # 
+    #
 
     def attribute_value(attribute)
       assert_exists
@@ -127,7 +131,7 @@ module Celerity
     # its parents) into account - styles from applied CSS is not considered.
     #
     # @return [boolean]
-    # 
+    #
 
     def visible?
       assert_exists
@@ -139,7 +143,7 @@ module Celerity
     #
     # @raise [Celerity::Exception::UnknownObjectException] if the element can't be found.
     # @api private
-    # 
+    #
 
     def assert_exists
       locate
@@ -147,11 +151,11 @@ module Celerity
         raise UnknownObjectException, "Unable to locate #{self.class.name[/::(.*)$/, 1]}, using #{identifier_string}"
       end
     end
-    
+
     #
     # Checks if the element exists.
     # @return [true, false]
-    # 
+    #
 
     def exists?
       assert_exists
@@ -160,13 +164,13 @@ module Celerity
       false
     end
     alias_method :exist?, :exists?
-    
+
     #
     # Return a text representation of the element as it would appear in a browser.
     #
     # @see inner_text
     # @return [String]
-    # 
+    #
 
     def text
       assert_exists
@@ -180,7 +184,7 @@ module Celerity
     #
     # @see text
     # @return [String]
-    # 
+    #
 
     def inner_text
       assert_exists
@@ -189,7 +193,7 @@ module Celerity
 
     #
     # @return [String] The normative XML representation of the element (including children).
-    # 
+    #
 
     def to_xml
       assert_exists
@@ -201,7 +205,7 @@ module Celerity
 
     #
     # @return [String] A string representation of the element's attributes.
-    # 
+    #
 
     def attribute_string
       assert_exists
@@ -216,7 +220,7 @@ module Celerity
 
     #
     # return the canonical xpath for this element (Celerity-specific)
-    # 
+    #
 
     def xpath
       assert_exists
@@ -230,7 +234,7 @@ module Celerity
     #
     # @return [String] The resulting attribute.
     # @raise  [NoMethodError] if the element doesn't support this attribute.
-    # 
+    #
 
     def method_missing(meth, *args, &blk)
       assert_exists
@@ -243,9 +247,9 @@ module Celerity
       Log.warn "Element\#method_missing calling super with #{meth.inspect}"
       super
     end
-    
+
     def methods(*args)
-      ms = super 
+      ms = super
       ms += self.class::ATTRIBUTES.map { |e| e.to_s }
       ms.sort
     end

data/lib/celerity/element_collection.rb

@@ -1,13 +1,13 @@
 module Celerity
-  
+
   #
   # This class is the superclass for the iterator classes (Buttons, Links, Spans etc.)
   # It would normally only be accessed by the iterator methods (Browser#spans, Browser#links, ...).
-  # 
-  
+  #
+
   class ElementCollection
     include Enumerable
-    
+
     #
     # @api private
     #
@@ -17,10 +17,10 @@ module Celerity
       @object = (how == :object ? what : nil)
       @length = length
     end
-    
+
     #
     # @return [Fixnum] The number of elements in this collection.
-    # 
+    #
 
     def length
       if @object
@@ -45,7 +45,7 @@ module Celerity
 
       @length
     end
-    
+
     #
     # Get the element at the given index.
     # This is 1-indexed to keep compatibility with Watir - subject to change.
@@ -54,7 +54,7 @@ module Celerity
     #
     # @param [Fixnum] n Index of wanted element, 1-indexed.
     # @return [Celerity::Element] Returns a subclass of Celerity::Element
-    # 
+    #
 
     def [](n)
       if @elements && @elements[n - INDEX_OFFSET]
@@ -68,8 +68,8 @@ module Celerity
     # Get the first element in this collection. (Celerity-specific)
     #
     # @return [Celerity::Element] Returns a subclass of Celerity::Element
-    # 
-    
+    #
+
     def first
       self[INDEX_OFFSET]
     end
@@ -78,8 +78,8 @@ module Celerity
     # Get the last element in this collection. (Celerity-specific)
     #
     # @return [Celerity::Element] Returns a subclass of Celerity::Element
-    # 
-    
+    #
+
     def last
       self[INDEX_OFFSET - 1]
     end
@@ -90,8 +90,8 @@ module Celerity
     #   puts browser.text_fields
     #
     # @return [String] A string representation of all elements in this collection.
-    # 
-    
+    #
+
     def to_s
       map { |e| e.to_s }.join("\n")
     end