celerity 0.0.6 → 0.0.7

data/lib/celerity/element.rb

@@ -1,14 +1,14 @@
 module Celerity
-  
+
   #
   # Superclass for all HTML elements.
-  # 
-  
+  #
+
   class Element
     include Exception
     include Container
 
-    attr_reader :container, :object
+    attr_reader :container
 
     # number of spaces that separate the property from the value in the create_string method
     TO_S_SIZE = 14
@@ -52,12 +52,13 @@ module Celerity
       end
 
       @conditions.freeze
+      @object = nil
     end
 
     #
     # Get the parent element
     # @return [Celerity::Element, nil] subclass of Celerity::Element, or nil if no parent was found
-    # 
+    #
 
     def parent
       assert_exists
@@ -73,22 +74,50 @@ module Celerity
 
     #
     # Sets the focus to this element.
-    # 
+    #
 
     def focus
       assert_exists
       @object.focus
     end
 
+    #
+    # Fires the given event for this element
+    #
+
+    def fire_event(event_name)
+      assert_exists
+      @object.fireEvent(event_name.sub(/^on/, ''))
+    end
+
     #
     # 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
+
+    #
+    # Returns a JavaScript object representing the receiver
+    #
+    # @api internal - subject to change
+    #
+
+    def javascript_object
+      assert_exists
+      @object.getScriptObject
+    end
+
     #
     # @return [String] A string representation of the element.
     #
@@ -101,7 +130,7 @@ module Celerity
     #
     # @param [String, #to_s] The attribute.
     # @return [String] The value of the given attribute.
-    # 
+    #
 
     def attribute_value(attribute)
       assert_exists
@@ -114,17 +143,11 @@ module Celerity
     # its parents) into account - styles from applied CSS is not considered.
     #
     # @return [boolean]
-    # 
+    #
 
     def visible?
-      obj = self
-      while obj
-        return false if obj.respond_to?(:type) && obj.type == 'hidden'
-        return false if obj.style =~ /display\s*:\s*none|visibility\s*:\s*hidden/
-        obj = obj.parent
-      end
-
-      return true
+      assert_exists
+      @object.isDisplayed
     end
 
     #
@@ -132,19 +155,19 @@ module Celerity
     #
     # @raise [Celerity::Exception::UnknownObjectException] if the element can't be found.
     # @api private
-    # 
+    #
 
     def assert_exists
-      locate
+      locate unless @object
       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
@@ -153,13 +176,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
@@ -173,7 +196,7 @@ module Celerity
     #
     # @see text
     # @return [String]
-    # 
+    #
 
     def inner_text
       assert_exists
@@ -182,7 +205,7 @@ module Celerity
 
     #
     # @return [String] The normative XML representation of the element (including children).
-    # 
+    #
 
     def to_xml
       assert_exists
@@ -194,14 +217,14 @@ module Celerity
 
     #
     # @return [String] A string representation of the element's attributes.
-    # 
+    #
 
     def attribute_string
       assert_exists
 
       result = ''
       @object.getAttributes.each do |attribute|
-        result << %Q{#{attribute.getName}="#{attribute.getHtmlValue}"}
+        result << %Q{#{attribute.getName}="#{attribute.getValue}"}
       end
 
       result
@@ -209,7 +232,7 @@ module Celerity
 
     #
     # return the canonical xpath for this element (Celerity-specific)
-    # 
+    #
 
     def xpath
       assert_exists
@@ -223,23 +246,22 @@ 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
 
       meth = selector_to_attribute(meth)
 
-      if self.class::ATTRIBUTES.include?(meth)
-        return @object.getAttributeValue(meth.to_s)
+      if self.class::ATTRIBUTES.include?(meth) || (self.class == Element && @object.hasAttribute(meth.to_s))
+        return @object.getAttribute(meth.to_s)
       end
-
       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
@@ -260,7 +282,7 @@ module Celerity
       end
 
       element.getAttributes.each do |attribute|
-        ret << "  #{attribute.getName}:".ljust(TO_S_SIZE+2) + attribute.getHtmlValue.to_s
+        ret << "  #{attribute.getName}:".ljust(TO_S_SIZE+2) + attribute.getValue.to_s
       end
 
       unless (text = element.asText).empty?

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,22 +45,23 @@ module Celerity
 
       @length
     end
-    
+
     #
     # Get the element at the given index.
-    # This is 1-indexed to keep compatibility with Watir - subject to change.
+    # By default, this is 1-indexed to keep compatibility with Watir.
+    #
     # Also note that because of Watir's lazy loading, this will return an Element
     # instance even if the index is out of bounds.
     #
-    # @param [Fixnum] n Index of wanted element, 1-indexed.
+    # @param [Fixnum] n Index of wanted element, 1-indexed unless Celerity.index_offset is changed.
     # @return [Celerity::Element] Returns a subclass of Celerity::Element
-    # 
+    #
 
     def [](n)
-      if @elements && @elements[n - INDEX_OFFSET]
-        element_class.new(@container, :object, @elements[n - INDEX_OFFSET])
+      if @elements && @elements[n - Celerity.index_offset]
+        element_class.new(@container, :object, @elements[n - Celerity.index_offset])
       else
-        iterator_object(n - INDEX_OFFSET)
+        iterator_object(n - Celerity.index_offset)
       end
     end
 
@@ -68,20 +69,20 @@ 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]
+      self[Celerity.index_offset]
     end
 
     #
     # Get the last element in this collection. (Celerity-specific)
     #
     # @return [Celerity::Element] Returns a subclass of Celerity::Element
-    # 
-    
+    #
+
     def last
-      self[INDEX_OFFSET - 1]
+      self[Celerity.index_offset - 1]
     end
 
     #
@@ -90,8 +91,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

data/lib/celerity/element_locator.rb

@@ -2,8 +2,8 @@ module Celerity
 
   #
   # Used internally to locate elements on the page.
-  # 
-  
+  #
+
   class ElementLocator
     include Celerity::Exception
     attr_accessor :idents
@@ -35,8 +35,6 @@ module Celerity
             raise ArgumentError, "expected an HtmlUnit::Html::HtmlElement subclass, got #{what.inspect}:#{what.class}"
           end
           return what
-        when :id
-          return find_by_id(what)
         when :xpath
           return find_by_xpath(what)
         when :label
@@ -49,10 +47,12 @@ module Celerity
           how = :text
         end
 
-        if @attributes.include?(how = how.to_sym)
+        if how == :id && conditions.size == 1
+          return find_by_id(what)
+        elsif @attributes.include?(how = how.to_sym)
           attributes[how] << what
         elsif how == :index
-          index = what.to_i - INDEX_OFFSET
+          index = what.to_i - Celerity.index_offset
         elsif how == :text
           text = what
         else
@@ -82,7 +82,7 @@ module Celerity
       when Regexp
         elements_by_tag_names.find { |elem| elem.getId =~ what }
       when String
-        obj = @object.getHtmlElementById(what)
+        obj = @object.getElementById(what)
         return obj if @tags.include?(obj.getTagName)
 
         $stderr.puts "warning: multiple elements with identical id? (#{what.inspect})" if $VERBOSE
@@ -106,19 +106,19 @@ module Celerity
       find_by_id obj.getForAttribute
     end
 
-    def elements_by_idents(idents = nil)
-      get_by_idents(:select, idents || @idents)
+    def elements_by_idents(idents = @idents)
+      get_by_idents(:select, idents)
     end
 
-    def element_by_idents(idents = nil)
-      get_by_idents(:find, idents || @idents)
+    def element_by_idents(idents = @idents)
+      get_by_idents(:find, idents)
     end
 
     private
 
     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
@@ -129,7 +129,7 @@ module Celerity
       return false unless ident.tag == element.getTagName
 
       attr_result = ident.attributes.all? do |key, values|
-        values.any? { |val| matches?(element.getAttributeValue(key.to_s), val) }
+        values.any? { |val| matches?(element.getAttribute(key.to_s), val) }
       end
 
       if ident.text
@@ -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)
@@ -158,7 +165,7 @@ module Celerity
       raise e if tries >= max_retries
 
       tries += 1
-      $stderr.puts "warning: celerity caught #{e} - retry ##{tries}"
+      warn "warning: celerity caught #{e} - retry ##{tries}"
       retry
     end
 

data/lib/celerity/elements/button.rb

@@ -1,36 +1,38 @@
 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
     TAGS = [ Identifier.new('button'),
              Identifier.new('input', :type => %w[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]
+    ATTRIBUTES = ATTRIBUTES | [:type, :disabled, :tabindex, :accesskey, :onfocus, :onblur] | [:src, :usemap, :ismap]
     DEFAULT_HOW = :value
 
     #
     # @api private
     #
-    
+
     def locate
-      # We want the :value attribute to point to the inner HTML for <button> elements, 
-      # and to the value attribute for <input type="button"> elements. 
-      
+      # 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])
         button_ident      = Identifier.new('button')
         button_ident.text = 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)