jarib-celerity 0.0.5.5 → 0.0.5.6

data/lib/celerity/disabled_element.rb

@@ -1,22 +1,35 @@
 module Celerity
-  # Module mixed in to all elements that can have the 'disabled' attribute.
+  
+  #
+  # Mixed in to all elements that can have the 'disabled' attribute.
+  #
+
   module DisabledElement
     include Celerity::Exception
-
+    
+    #
     # Returns false if the element is disabled.
+    #
+
     def enabled?
       !disabled?
     end
 
+    #
     # 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
+    #
+
     def assert_enabled
       if disabled?
         raise ObjectDisabledException, "Object #{identifier_string} is disabled"

data/lib/celerity/element.rb

@@ -1,6 +1,9 @@
 module Celerity
-
+  
+  #
   # Superclass for all HTML elements.
+  # 
+  
   class Element
     include Exception
     include Container
@@ -51,8 +54,11 @@ module Celerity
       @conditions.freeze
     end
 
+    #
     # Get the parent element
     # @return [Celerity::Element, nil] subclass of Celerity::Element, or nil if no parent was found
+    # 
+
     def parent
       assert_exists
 
@@ -65,36 +71,51 @@ module Celerity
       element_class.new(@container, :object, obj)
     end
 
+    #
     # Sets the focus to this element.
+    # 
+
     def focus
       assert_exists
       @object.focus
     end
 
+    #
     # Used internally. Find the element on the page.
     # @api private
+    # 
+
     def locate
       @object = ElementLocator.new(@container, self.class).find_by_conditions(@conditions)
     end
 
+    #
     # @return [String] A string representation of the element.
+    #
+
     def to_s
       assert_exists
       create_string(@object)
     end
 
+    #
     # @param [String, #to_s] The attribute.
     # @return [String] The value of the given attribute.
+    # 
+
     def attribute_value(attribute)
       assert_exists
       @object.getAttribute(attribute.to_s)
     end
 
+    #
     # Check if the element is visible to the user or not.
     # Note that this only takes the _style attribute_ of the element (and
     # its parents) into account - styles from applied CSS is not considered.
     #
     # @return [boolean]
+    # 
+
     def visible?
       obj = self
       while obj
@@ -106,19 +127,25 @@ module Celerity
       return true
     end
 
+    #
     # Used internally to ensure the element actually exists.
     #
     # @raise [Celerity::Exception::UnknownObjectException] if the element can't be found.
     # @api private
+    # 
+
     def assert_exists
       locate
       unless @object
         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
       true
@@ -126,28 +153,37 @@ 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
       @object.asText.strip # this must behave like ElementLocator
     end
 
+    #
     # Return the text content of this DOM node, disregarding its visibility.
     #
     # (Celerity-specific?)
     #
     # @see text
     # @return [String]
+    # 
+
     def inner_text
       assert_exists
       Celerity::Util.normalize_text @object.getTextContent
     end
 
+    #
     # @return [String] The normative XML representation of the element (including children).
+    # 
+
     def to_xml
       assert_exists
       @object.asXml
@@ -156,7 +192,10 @@ module Celerity
     alias_method :as_xml, :to_xml
     alias_method :html,   :to_xml
 
+    #
     # @return [String] A string representation of the element's attributes.
+    # 
+
     def attribute_string
       assert_exists
 
@@ -168,18 +207,24 @@ module Celerity
       result
     end
 
+    #
     # return the canonical xpath for this element (Celerity-specific)
+    # 
+
     def xpath
       assert_exists
       @object.getCanonicalXPath
     end
 
+    #
     # Dynamically get element attributes.
     #
     # @see ATTRIBUTES constant for a list of valid methods for a given element.
     #
     # @return [String] The resulting attribute.
     # @raise  [NoMethodError] if the element doesn't support this attribute.
+    # 
+
     def method_missing(meth, *args, &blk)
       assert_exists
 

data/lib/celerity/element_locator.rb

@@ -1,6 +1,9 @@
 module Celerity
 
+  #
   # Used internally to locate elements on the page.
+  # 
+  
   class ElementLocator
     include Celerity::Exception
     attr_accessor :idents

data/lib/celerity/elements/button.rb

@@ -1,26 +1,36 @@
 module Celerity
+  
   #
   # Input: Button
   #
   # Class representing button elements
   #
+  
   class Button < InputElement
     TAGS = [ Identifier.new('button'),
              Identifier.new('input', :type => %w[submit reset image button]) ]
-    # A little wierd attribute list due to button being both <button> and <input type="submit|reset|image|button" />
+             
+    # Attribute list is a little weird due to this class covering both <button>
+    # and <input type="submit|reset|image|button" />
     ATTRIBUTES = BASE_ATTRIBUTES | [:type, :disabled, :tabindex, :accesskey, :onfocus, :onblur] | [:src, :usemap, :ismap]
     DEFAULT_HOW = :value
 
+    #
     # @api private
+    #
+    
     def locate
-      # ugly..
-      # this is done to make <button> and <input>-buttons look similar
+      # We want the :value attribute to point to the inner HTML for <button> elements, 
+      # and to the value attribute for <input type="button"> elements. 
+      
       if (val = @conditions[:value])
-        locator = ElementLocator.new(@container, self.class)
-        button_ident = Identifier.new('button')
+        button_ident      = Identifier.new('button')
         button_ident.text = val
-        input_ident = Identifier.new('input', :type => %w[submit reset image button], :value => [val])
+        input_ident       = Identifier.new('input', :type => %w[submit reset image button], :value => [val])
+        
+        locator        = ElementLocator.new(@container, self.class)
         locator.idents = [button_ident, input_ident]
+        
         conditions = @conditions.dup
         conditions.delete(:value)
         @object = locator.find_by_conditions(conditions)

data/lib/celerity/elements/file_field.rb

@@ -1,10 +1,17 @@
 module Celerity
+  
+  #
   # For fields that accept file uploads
+  #
+
   class FileField < InputElement
     TAGS = [ Identifier.new('input', :type => %w[file]) ]
     DEFAULT_HOW = :name
 
+    #
     # Set the file field to the given path
+    # 
+
     def set(path)
       assert_exists
       path = path.to_s
@@ -13,5 +20,6 @@ module Celerity
         @object.setContentType(Celerity::Util.content_type_for(path))
       end
     end
-  end
-end
+    
+  end # FileField
+end # Celerity

data/lib/celerity/elements/form.rb

@@ -1,16 +1,21 @@
 module Celerity
   class Form < Element
     include Container
+    
     TAGS = [Identifier.new('form')]
+    
     # HTML 4.01 Transitional DTD
     ATTRIBUTES = BASE_ATTRIBUTES | [:action, :method, :enctype, :accept, :name, :onsubmit, :onreset, :target, :'accept-charset']
     DEFAULT_HOW = :name
 
+    #
     # Submits the form.
+    # 
+    
     def submit
       assert_exists
       @container.update_page @object.submit(nil)
     end
 
-  end
-end
+  end # Form
+end # Celerity

data/lib/celerity/elements/frame.rb

@@ -7,8 +7,11 @@ module Celerity
     ATTRIBUTES = BASE_ATTRIBUTES | [:longdesc, :name, :src, :frameborder, :marginwidth, :marginheight, :noresize, :scrolling]
     DEFAULT_HOW = :name
 
+    #
     # Override the default locate to handle frame and inline frames.
     # @api private
+    # 
+
     def locate
       super
       if @object
@@ -19,9 +22,12 @@ module Celerity
         end
       end
     end
-
+    
+    #
     # Override assert_exists to raise UnknownFrameException (for Watir compatibility)
     # @api private
+    #
+
     def assert_exists
       locate
       unless @object
@@ -29,6 +35,22 @@ module Celerity
       end
     end
 
+    #
+    # Executes the given JavaScript string in this frame. (Celerity only)
+    #
+
+    def execute_script(source)
+      assert_exists
+      @page.executeJavaScript(source.to_s).getJavaScriptResult
+    end
+
+    #
+    # Updates the brwoser page with the page from this frame's top window.
+    # Used internally.
+    #
+    # @api private
+    #
+
     def update_page(value)
       @browser.page = value.getEnclosingWindow.getTopWindow.getEnclosedPage
     end
@@ -49,6 +71,5 @@ module Celerity
       end
     end
 
-  end
-
-end
+  end # Frame
+end # Celerity

data/lib/celerity/elements/image.rb

@@ -4,36 +4,52 @@ module Celerity
     include ClickableElement
 
     TAGS = [ Identifier.new('img') ]
+    
     ATTRIBUTES = BASE_ATTRIBUTES | [:src, :alt, :longdesc, :name, :height, :width, :usemap, :ismap, :align, :border, :hspace, :vspace]
     DEFAULT_HOW = :src
 
+    #
     # returns the file created date of the image
+    #
+
     def file_created_date
       assert_exists
       web_response = @object.getWebResponse(true)
       Time.parse(web_response.getResponseHeaderValue("Last-Modified").to_s)
     end
 
+    #
     # returns the filesize of the image
+    #
+
     def file_size
       assert_exists
       web_response = @object.getWebResponse(true)
       web_response.getResponseBody.length
     end
 
+    #
     # returns the width in pixels of the image, as a string
+    #
+
     def width
       assert_exists
       @object.getWidth
     end
 
+    #
     # returns the height in pixels of the image, as a string
+    #
+
     def height
       assert_exists
       @object.getHeight
     end
 
+    #
     # returns true if the image is loaded
+    #
+
     def loaded?
       assert_exists
       begin
@@ -44,7 +60,10 @@ module Celerity
       end
     end
 
+    #
     # Saves the image to the given file
+    #
+
     def save(filename)
       assert_exists
       image_reader = @object.getImageReader
@@ -52,6 +71,6 @@ module Celerity
       buffered_image = image_reader.read(0);
       javax.imageio.ImageIO.write(buffered_image, image_reader.getFormatName(), file);
     end
-  end
-
-end
+    
+  end # Image
+end # Celerity

data/lib/celerity/elements/non_control_elements.rb

@@ -1,6 +1,9 @@
 module Celerity
-
+  
+  #
   # Superclass for for Span, Pre, Div, H1, ...
+  #
+  
   class NonControlElement < Element
     include Exception
     include ClickableElement
@@ -10,7 +13,9 @@ module Celerity
   end
 
   #
+  #--
   #  classes ordered alphabetically
+  #++
   #
 
   class Area < NonControlElement

data/lib/celerity/elements/option.rb

@@ -1,5 +1,9 @@
 module Celerity
-  # Represents a select list option.
+  
+  #
+  # Represents an option in a select list.
+  #
+
   class Option < Element
     include ClickableElement
     include DisabledElement
@@ -10,6 +14,10 @@ module Celerity
 
     alias_method :select, :click
 
+    # 
+    # Is this option selected?
+    # 
+    
     def selected?
       assert_exists
       @object.isSelected

data/lib/celerity/elements/radio_check.rb

@@ -1,10 +1,16 @@
 module Celerity
+  
+  #
   # Common superclass for radios and check boxes.
+  #
+  
   class RadioCheckCommon < InputElement
     DEFAULT_HOW = :name
-
-    # these can optionally take a value parameter as a third arg, so needs
-    # to be special-handled.
+    
+    #
+    # Can optionally take a value parameter as a third arg, so we override initialize 
+    #
+    
     def initialize(container, type, *args)
       @type = type
       case args.size
@@ -16,36 +22,52 @@ module Celerity
         super(container, *args)
       end
     end
-
+    
+    #
     # returns true if the element is checked
     # @return [true, false]
+    #
+    
     def set?
       assert_exists
       @object.isChecked
     end
     alias_method :checked?, :set?
 
+    #
+    # Unset this element.
+    #
+    
     def clear
       set(false)
     end
   end
 
-  # This class is the celerity representation of a radio button.
+  #
+  # This class is the representation of a radio button.
+  #
+  
   class Radio < RadioCheckCommon
     TAGS = [Identifier.new('input', :type => %w[radio])]
-
+    
+    #
     # @api private
+    #
+    
     def initialize(container, *args)
       super(container, %w[radio], *args)
     end
 
+    #
     # Set the radio button to the given value.
     #
-    #   radio.set? # => false
+    #   radio.set?        #=> false
     #   radio.set
-    #   radio.set? # => true
+    #   radio.set?        #=> true
     #   radio.set(false)
-    #   radio.set? # => false
+    #   radio.set?        #=> false
+    #
+    
     def set(value = true)
       assert_exists
       assert_enabled
@@ -53,24 +75,32 @@ module Celerity
     end
 
   end
-
-  # This class is the celerity representation of a check box.
+  
   #
+  # This class is the representation of a check box.
+  #
+  
   class CheckBox < RadioCheckCommon
     TAGS = [Identifier.new('input', :type => %w[checkbox])]
 
+    #
     # @api private
+    #
+    
     def initialize(container, *args)
       super(container, %w[checkbox], *args)
     end
 
+    #
     # Set the checkbox to the given value.
     #
-    #   checkbox.set? # => false
+    #   checkbox.set?         #=> false
     #   checkbox.set
-    #   checkbox.set? # => true
+    #   checkbox.set?         #=> true
     #   checkbox.set(false)
-    #   checkbox.set? # => false
+    #   checkbox.set?         #=> false
+    #
+    
     def set(value = true)
       assert_exists
       assert_enabled