celerity 0.0.3 → 0.0.4

data/lib/celerity/elements/select_list.rb

@@ -8,21 +8,29 @@ module Celerity
     TAGS = [ Identifier.new('select') ]
     DEFAULT_HOW = :name
   
+    # Returns an array strings representing the text value of the select list's options.
     def get_all_contents
       assert_exists
       @object.getOptions.map { |e| e.asText }
     end
-  
+
+    # Returns an array strings representing the text value of the currently selected options.  
     def get_selected_items
       assert_exists
       @object.getSelectedOptions.map { |e| e.asText }
     end
   
+    # Clear all selected options
+    # FIXME: should update page for each option changed?
     def clear_selection
       # assert_exists called by SelectList#type here
       @object.getSelectedOptions.each { |e| e.setSelected(false) } unless type() == 'select-one'
     end
   
+    # Select the option(s) matching the given value.
+    # value can be a String or Regexp.
+    # 
+    # If several options match the value given, all will be selected.
     def select(value)
       assert_exists
       raise NoValueFoundException, "unknown option with value #{value.inspect}" unless include?(value)
@@ -32,24 +40,31 @@ module Celerity
     end
     alias_method :set, :select
   
+    # Returns true if the select list has one or more options matching the given value.
+    # value can be a String or Regexp.
     def include?(value)
       assert_exists
       !!@object.getOptions.find { |e| matches?(e.asText, value) }
     end
-    alias_method :includes?, :include?
   
+    # Returns true if any of the selected options match the given value.
+    # value can be a String or Regexp.
     def selected?(value)
       assert_exists
       raise UnknownObjectException, "unknown option with value #{value.inspect}" unless include?(value)
       !!@object.getOptions.find { |e| matches?(e.asText, value) && e.isSelected }
     end
 
+    # Returns 'select-multiple' if the select list has the 'multiple' attribute defined.
+    # Retunrs 'select-one' otherwise.
     # TODO: Move to watir_compatibility or delete it 2008-05-23 Alexander
     def type
       assert_exists
       'select-' + (@object.isAttributeDefined('multiple') ? 'multiple' : 'one')
     end
   
+    # Returns the value of the first selected option in the select list.
+    # Returns nil if no option is selected.
     def value
       assert_exists
       if (optn = @object.getSelectedOptions.to_a.first)

data/lib/celerity/elements/table.rb

@@ -5,7 +5,8 @@ module Celerity
     include Container
     
     TAGS = [ Identifier.new('table') ]
-    ATTRIBUTES = BASE_ATTRIBUTES | [:summary, :width, :border, :frame, :rules, :cellspacing, :cellpadding, :align, :bgcolor]
+    ATTRIBUTES = BASE_ATTRIBUTES | [:summary, :width, :border, :frame, :rules, 
+                                    :cellspacing, :cellpadding, :align, :bgcolor]
     DEFAULT_HOW = :id
     
     def locate
@@ -21,58 +22,71 @@ module Celerity
       end
     end
     
+    # Returns a TableRows object.
     def rows
       assert_exists
-      return TableRows.new(self, :object, @rows)
+      TableRows.new(self, :object, @rows)
     end
     
+    # Returns a TableCells object.
     def cells
       assert_exists
-      return TableCells.new(self, :object, @cells)
+      TableCells.new(self, :object, @cells)
     end
     
+    # Iterates through each row in the table, passing TableRow objects to the given block.
     def each
       assert_exists
       @rows.each { |row| yield TableRow.new(self, :object, row)  }
     end
     
-    def [](index)
+    # Returns the TableRow at the given index (1-indexed).
+    #
+    #   browser.table(:foo, 'bar')[1] # => #<TableRow...>
+    #   browser.table(:foo, 'bar').child_row[1] # => #<TableRow...>
+    def child_row(index)
       assert_exists
-      return TableRow.new(self, :object, @rows[index-1])
+      raise UnknownRowException, "Unable to locate a row at index #{index}" if @cells.length < index
+      TableRow.new(self, :object, @rows[index-1])
     end
+    alias_method :[], :child_row
     
+    # Returns the TableCell at the given index (1-indexed).
+    #
+    # In a 10-column row, table.child_cell[11] will return the first cell on the second row.
+    def child_cell(index)
+      assert_exists
+      raise UnknownCellException, "Unable to locate a cell at index #{index}" if @cells.length < index
+      TableCell.new(self, :object, @cells[index-1])
+    end
+    
+    # The number of rows in the table
     def row_count
       assert_exists
       @object.getRowCount
     end
     
+    # Returns the number of columns on the row at the given index. (1-indexed)
+    # Default is the number of columns on the first row
     def column_count(index = 1)
       assert_exists
       @object.getRow(index-1).getCells.length
     end
     
-    # This method returns the table as a 2 dimensional array.
-    # Raises an UnknownObjectException if the table doesn't exist.
+    # Returns the text of each cell in the the table as a two-dimensional array.
     def to_a
       assert_exists
-      y = []
-      table_rows = @object.getRows
-      for table_row in table_rows
-        x = []
-        for td in table_row.getCells
-          x << td.asText
-        end
-        y << x
+      @object.getRows.map do |table_row|
+        table_row.getCells.map { |td| td.asText }
       end
-      return y
     end
     
-    def column_values(columnnumber)
-      (1..row_count).collect { |index| self[index][columnnumber].text }
+    def column_values(column_number)
+      (1..row_count).map { |index| self[index][column_number].text }
     end
     
-    def row_values(rownumber)
-      (1..column_count(rownumber)).collect { |index| self[rownumber][index].text }
+    def row_values(row_number)
+      (1..column_count(row_number)).map { |index| self[row_number][index].text }
     end
 
   end

data/lib/celerity/elements/table_body.rb

@@ -13,12 +13,12 @@ module Celerity
 
     def [](index)
       assert_exists
-      return TableRow.new(self, :object, @rows[index-1])
+      TableRow.new(self, :object, @rows[index-1])
     end
 
     def length
       assert_exists
-      return @object.getRows.length
+      @object.getRows.length
     end
     
     def each

data/lib/celerity/elements/table_cell.rb

@@ -5,7 +5,9 @@ module Celerity
     include Container
 
     TAGS = [ Identifier.new('td') ]
-    ATTRIBUTES = BASE_ATTRIBUTES | [:abbr, :axis, :headers, :scope, :rowspan, :colspan] | CELLHALIGN_ATTRIBUTES | CELLVALIGN_ATTRIBUTES
+    ATTRIBUTES = BASE_ATTRIBUTES | CELLHALIGN_ATTRIBUTES | CELLVALIGN_ATTRIBUTES |
+                         [:abbr, :axis, :headers, :scope, :rowspan, :colspan] 
+                                
     DEFAULT_HOW = :id
     
     alias_method :to_s, :text

data/lib/celerity/elements/table_footer.rb

@@ -13,12 +13,12 @@ module Celerity
 
     def [](index)
       assert_exists
-      return TableRow.new(self, :object, @rows[index-1])
+      TableRow.new(self, :object, @rows[index-1])
     end
 
     def length
       assert_exists
-      return @object.getRows.length
+      @object.getRows.length
     end
     
     def each

data/lib/celerity/elements/table_header.rb

@@ -13,12 +13,12 @@ module Celerity
 
     def [](index)
       assert_exists
-      return TableRow.new(self, :object, @rows[index-1])
+      TableRow.new(self, :object, @rows[index-1])
     end
 
     def length
       assert_exists
-      return @object.getRows.length
+      @object.getRows.length
     end
     
     def each

data/lib/celerity/elements/table_row.rb

@@ -15,11 +15,13 @@ module Celerity
       @cells.each { |cell| yield TableCell.new(self, :object, cell) }
     end
 
-    def [](index)
+    def child_cell(index)
       assert_exists
       raise UnknownCellException, "Unable to locate a cell at index #{index}" if @cells.length < index
-      return TableCell.new(self, :object, @cells[index-1])
+      
+      TableCell.new(self, :object, @cells[index-1])
     end
+    alias_method :[], :child_cell
 
     def column_count
       assert_exists

data/lib/celerity/elements/text_field.rb

@@ -9,6 +9,7 @@ module Celerity
              Identifier.new('input', :type => ["text", "password", /^(?!(file|radio|checkbox|submit|reset|image|button|hidden)$)/])  ]
     DEFAULT_HOW = :name
 
+    # Clear the text field.
     def clear
       assert_exists
       case @object.getTagName
@@ -19,6 +20,8 @@ module Celerity
       end
     end
   
+    # Set the text field to the given value. 
+    # This ensures execution of JavaScript events (onkeypress etc.), but is slower than +value=+
     def set(value)
       assert_enabled
       assert_not_readonly
@@ -26,6 +29,8 @@ module Celerity
       type_string(value.to_s)
     end
     
+    # This directly sets the text field to the given value, skipping exectuion of JavaScript events.
+    # Use +set+ if you want to run events on text fields.
     def value=(value)
       assert_enabled
       assert_not_readonly
@@ -36,8 +41,11 @@ module Celerity
       when 'input'
         @object.setValueAttribute(value.to_s)
       end
+      
+      value
     end
     
+    # Returns the text in the text field.
     def value
       assert_exists
       case @object.getTagName
@@ -47,7 +55,9 @@ module Celerity
         @object.getValueAttribute
       end
     end
+    alias_method :get_contents, :value
 
+    # Append the given value to the text in the text field.
     def append(value)
       assert_enabled
       assert_not_readonly
@@ -57,7 +67,12 @@ module Celerity
     def type
       assert_exists
       type = @object.getAttributeValue('type')
-      return ['file', 'radio', 'checkbox', 'submit', 'reset', 'image', 'button', 'hidden'].include?(type) ? type : 'text'
+      
+      if ['file', 'radio', 'checkbox', 'submit', 'reset', 'image', 'button', 'hidden'].include?(type)
+        type
+      else
+        'text'
+      end
     end
 
     # This bascially just moves the text to the other text field using TextField#append
@@ -68,17 +83,13 @@ module Celerity
       self.value = ''
       @container.text_field(how, what).append(val)
     end
-  
-    def get_contents
-      self.value
-    end
-
+    
+    # A boolean version of Element#contains_text :P
     def verify_contains(expected)
-      assert_exists
+      # assert_exists called by contains_text
       !!contains_text(expected)
     end
     
-    
     private 
     def type_string(value)
       JavaString.new(value.to_java_bytes, @container.page.getPageEncoding).toCharArray.each do |char| 
@@ -88,7 +99,7 @@ module Celerity
   end
   
   # this class can be used to access hidden field objects
-  # Normally a user would not need to create this object as it is returned by the Watir::Container#hidden method
+  # Normally a user would not need to create this object as it is returned by the Celerity::Container#hidden method
   class Hidden < TextField
     TAGS = [ Identifier.new('input', :type => %w(hidden)) ]
     DEFAULT_HOW = :name

data/lib/celerity/exception.rb

@@ -1,11 +1,11 @@
 module Celerity
   module Exception
 
-    # Root class for all Celerity Exceptions
-    class CelerityException < RuntimeError  
-        def initialize(message="")
-            super(message)
-        end
+    # Superclass for all Celerity exceptions.
+    class CelerityException < StandardError  
+      def initialize(message="")
+          super(message)
+      end
     end
     
     # This exception is thrown if an attempt is made to access an object that doesn't exist
@@ -20,29 +20,22 @@ module Celerity
     # This exception is thrown if an attempt is made to access a form that cannot be found 
     class UnknownFormException < CelerityException; end
       
-    # This exception is thrown if an attempt is made to access an object that is in a read only state
+    # This exception is thrown if an attempt is made to access an object that is in a read-only state
     class ObjectReadOnlyException < CelerityException; end
       
     # This exception is thrown if an attempt is made to access an object when the specified value cannot be found
     class NoValueFoundException < CelerityException; end
       
-    # This exception gets raised if part of finding an object is missing
+    # This exception gets raised if the how argument is wrong.
     class MissingWayOfFindingObjectException < CelerityException; end
+    
+    # This exception is raised if an attempt is made to access a table row that doesn't exist
+    class UnknownRowException < CelerityException; end
       
-    # this exception is raised if an attempt is made to access a table cell that doesnt exist
+    # This exception is raised if an attempt is made to access a table cell that doesn't exist
     class UnknownCellException < CelerityException; end
       
     # This exception is thrown if an http error, such as a 404, 500 etc is encountered while navigating
     class NavigationException < CelerityException; end
-      
-    # # This exception is raised if a timeout is exceeded
-    # class TimeOutException < CelerityException
-    #   def initialize(duration, timeout)
-    #     @duration, @timeout = duration, timeout
-    #     super
-    #   end 
-    #   attr_reader :duration, :timeout
-    # end
-    
   end
 end

data/lib/celerity/extra/method_generator.rb

@@ -5,8 +5,7 @@ require "active_support"
 #--
 # http://api.rubyonrails.com/classes/Inflector.html#M001621
 #++
-
-class String
+class String # :nodoc:
   def underscore
      gsub(/::/, '/').
      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
@@ -17,10 +16,11 @@ class String
 end
 
 module Celerity
+  # Experimental
   class MethodGenerator
 
-    ELEMENTS = %w(text_field select_list radio checkbox button).map { |e| e.to_sym }
-    BUGGY_ELEMENTS = %w(radio checkbox).map { |e| e.to_sym }
+    ELEMENTS = %w[text_field select_list radio checkbox button].map { |e| e.to_sym }
+    BUGGY_ELEMENTS = %w[radio checkbox].map { |e| e.to_sym }
   
     def initialize(ie, opts = {})
       @ie = ie
@@ -108,8 +108,13 @@ module Celerity
         how, what = :index, (idx + 1).to_s
       else
         how = :url
-        uri = URI.parse(href)
-        what = Regexp.new(Regexp.escape(uri.to_s.sub(/.*#{uri.host}\//, '')))
+        
+        begin
+          uri = URI.parse(href)
+          what = Regexp.new(Regexp.escape(uri.to_s.sub(/.*#{uri.host}\//, '')))
+        rescue URI::InvalidURIError
+          what = href
+        end
       end
       @method << "    #{@browser}.link(#{how.inspect}, #{what.inspect}).click\n"
     end
@@ -125,7 +130,7 @@ module Celerity
   
   end # MethodGenerator
   
-  class IE
+  class Browser
     def generate_method(opts = {})
       MethodGenerator.new(self, opts).parse
     end
@@ -138,7 +143,7 @@ end # Celerity
 # if __FILE__ == $0
 #   require File.dirname(__FILE__) + "/../spec/spec_helper"
 #   $stdout.sync = true
-#   @ie = IE.new
+#   @ie = Browser.new
 #   @ie.goto(TEST_HOST + "/forms_with_input_elements.html")
 # 
 #   puts MethodGenerator.new(@ie).parse

data/lib/celerity/htmlunit/download.sh

@@ -0,0 +1,23 @@
+wget http://mirrors.sunsite.dk/maven2/commons-codec/commons-codec/1.3/commons-codec-1.3.jar 
+wget http://mirrors.sunsite.dk/maven2/commons-collections/commons-collections/3.2/commons-collections-3.2.jar
+# wget http://mirrors.sunsite.dk/maven2/commons-fileupload/commons-fileupload/1.2.1/commons-fileupload-1.2.1.jar
+wget http://mirrors.sunsite.dk/maven2/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar
+wget http://mirrors.sunsite.dk/maven2/commons-io/commons-io/1.4/commons-io-1.4.jar
+wget http://mirrors.sunsite.dk/maven2/commons-lang/commons-lang/2.4/commons-lang-2.4.jar
+wget http://mirrors.sunsite.dk/maven2/commons-logging/commons-logging/1.1.1/commons-logging-1.1.1.jar
+wget http://mirrors.sunsite.dk/maven2/net/sourceforge/cssparser/cssparser/0.9.5/cssparser-0.9.5.jar
+# wget http://mirrors.sunsite.dk/maven2/gsbase/gsbase/2.0.1/gsbase-2.0.1.jar
+wget http://mirrors.sunsite.dk/maven2/net/sourceforge/htmlunit/htmlunit-core-js/0.1-SNAPSHOT/htmlunit-core-js-0.1-SNAPSHOT.jar
+# wget http://mirrors.sunsite.dk/maven2/org/mortbay/jetty/jetty/6.1.9/jetty-6.1.9.jar
+# wget http://mirrors.sunsite.dk/maven2/org/mortbay/jetty/jetty-util/6.1.9/jetty-util-6.1.9.jar
+# wget http://mirrors.sunsite.dk/maven2/junit/junit/4.4/junit-4.4.jar
+# wget http://mirrors.sunsite.dk/maven2/junitperf/junitperf/1.8/junitperf-1.8.jar
+# wget http://mirrors.sunsite.dk/maven2/log4j/log4j/1.2.14/log4j-1.2.14.jar
+wget http://mirrors.sunsite.dk/maven2/net/sourceforge/nekohtml/nekohtml/1.9.8-SNAPSHOT/nekohtml-1.9.8-SNAPSHOT.jar
+wget http://mirrors.sunsite.dk/maven2/org/w3c/css/sac/1.3/sac-1.3.jar
+# wget http://mirrors.sunsite.dk/maven2/org/mortbay/jetty/servlet-api-2.5/6.1.9/servlet-api-2.5-6.1.9.jar
+# wget http://mirrors.sunsite.dk/maven2/org/slf4j/slf4j-api/1.4.3/slf4j-api-1.4.3.jar
+# wget http://mirrors.sunsite.dk/maven2/org/slf4j/slf4j-log4j12/1.4.3/slf4j-log4j12-1.4.3.jar
+wget http://mirrors.sunsite.dk/maven2/xalan/xalan/2.7.0/xalan-2.7.0.jar
+wget http://mirrors.sunsite.dk/maven2/xerces/xercesImpl/2.8.1/xercesImpl-2.8.1.jar
+wget http://mirrors.sunsite.dk/maven2/xml-apis/xml-apis/1.0.b2/xml-apis-1.0.b2.jar