jarib-celerity 0.0.5.5 → 0.0.5.6

data/lib/celerity/elements/select_list.rb

@@ -3,30 +3,42 @@ module Celerity
     TAGS = [ Identifier.new('select') ]
     DEFAULT_HOW = :name
 
+    #
     # @return [Array<String>] An array of strings representing the text value of the select list's options.
+    #
+    
     def options
       assert_exists
       @object.getOptions.map { |e| e.asText }
     end
-
+    
+    #
     # @return [Array<String>] An array of strings representing the text value of the currently selected options.
+    #
+    
     def selected_options
       assert_exists
       @object.getSelectedOptions.map { |e| e.asText }
     end
-
+    
+    #
     # Clear all selected options
-    # TODO: should update page for each option changed?
+    #
+    
     def clear
       # assert_exists called by SelectList#type here
+      # TODO: should update page for each option changed?
       @object.getSelectedOptions.each { |e| e.setSelected(false) } unless type() == 'select-one'
     end
 
+    #
     # Select the option(s) matching the given value.
     # If several options match the value given, all will be selected.
     #
     # @param [String, Regexp] value A value.
     # @raise [Celerity::Exception::NoValueFoundException] if the value does not exist.
+    #
+    
     def select(value)
       assert_exists
       raise NoValueFoundException, "unknown option with value #{value.inspect} for select_list #{@conditions.inspect}" unless include?(value)
@@ -36,40 +48,52 @@ module Celerity
     end
     alias_method :set, :select
 
+    #
     # Returns true if the select list has one or more options matching the given value.
     #
     # @param [String, Regexp] value A value.
     # @return [true, false]
+    #
+    
     def include?(value)
       assert_exists
       !!@object.getOptions.find { |e| matches?(e.asText, value) }
     end
 
+    #
     # Returns true if any of the selected options match the given value.
     #
     # @param [String, Regexp] value A value.
     # @raise [Celerity::Exception::UnknownObjectException] if the value does not exist.
     # @return [true, false]
+    #
+    
     def selected?(value)
       assert_exists
       raise UnknownObjectException, "unknown option with value #{value.inspect} for select_list #{@conditions.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, otherwise 'select-one'.
     #
     # @return [String]
     # 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.
     #
     # @return [String, nil]
+    #
+
     def value
       assert_exists
       if (optn = @object.getSelectedOptions.to_a.first)
@@ -77,5 +101,5 @@ module Celerity
       end
     end
 
-  end
-end
+  end # SelectList
+end # Celerity

data/lib/celerity/elements/table.rb

@@ -22,26 +22,36 @@ module Celerity
         end
       end
     end
-
+    
+    #
     # @return [Celerity::TableRows]
+    #
+    
     def rows
       assert_exists
       TableRows.new(self, :object, @rows)
     end
-
+    
+    #
     # @return [Celerity::TableCells]
+    #
+    
     def cells
       assert_exists
       TableCells.new(self, :object, @cells)
     end
-
+    
+    #
     # Iterates through each row in the table.
     # @yieldparam [Celerity::TableRow] row A row.
+    #
+    
     def each
       assert_exists
       @rows.each { |row| yield TableRow.new(self, :object, row)  }
     end
 
+    #
     # Returns the TableRow at the given index (1-indexed).
     #
     #   browser.table(:foo, 'bar')[1] # => #<TableRow...>
@@ -50,6 +60,8 @@ module Celerity
     # @param [Fixnum] index The index of the wanted row, 1-indexed.
     # @raise [Celerity::Exception::UnknownRowException]
     # @return [Celerity::TableRow]
+    #
+    
     def child_row(index)
       assert_exists
 
@@ -61,6 +73,7 @@ module Celerity
     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.
@@ -68,6 +81,8 @@ module Celerity
     # @param [Fixnum] index The index of the wanted cell, 1-indexed.
     # @raise [Celerity::Exception::UnknownCellException]
     # @return [Celerity::TableCell]
+    #
+    
     def child_cell(index)
       assert_exists
 
@@ -77,24 +92,33 @@ module Celerity
       TableCell.new(self, :object, @cells[index - INDEX_OFFSET])
     end
 
+    #
     # The number of rows in the table
     # @return [Fixnum]
+    #
+    
     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
     # @param [Fixnum] index An index, 1-indexed (optional).
     # @return [Fixnum]
+    #
+    
     def column_count(index = INDEX_OFFSET)
       assert_exists
       @object.getRow(index - INDEX_OFFSET).getCells.length
     end
 
+    #
     # Returns the text of each cell in the the table as a two-dimensional array.
     # @return [Array<Array<String>>]
+    #
+    
     def to_a
       assert_exists
       # @object.getRows.map do |table_row|
@@ -113,6 +137,5 @@ module Celerity
       (1..column_count(row_number)).map { |index| self[row_number][index].text }
     end
 
-  end
-
-end
+  end # Table
+end # Celerity

data/lib/celerity/elements/table_cell.rb

@@ -1,8 +1,8 @@
 module Celerity
 
   class TableCell < Element
-    include ClickableElement
     include Celerity::Exception
+    include ClickableElement
     include Container
 
     TAGS = [ Identifier.new('td') ]
@@ -21,7 +21,7 @@ module Celerity
 
   end
 
-  # needs code review regarding attributes/correctness of this
+  #-- needs code review regarding attributes/correctness of this
   class Th < TableCell
     TAGS = [ Identifier.new('th')]
   end

data/lib/celerity/elements/table_row.rb

@@ -11,12 +11,19 @@ module Celerity
       @cells = @object.getCells if @object
     end
 
-    # Yields each TableCell in this row cell to the given block.
+    #
+    # Yields each TableCell in this row to the given block.
+    #
+    
     def each
       assert_exists
       @cells.each { |cell| yield TableCell.new(self, :object, cell) }
     end
 
+    #
+    # Get the child cell at the given index
+    #
+    
     def child_cell(index)
       assert_exists
 
@@ -28,10 +35,14 @@ module Celerity
     end
     alias_method :[], :child_cell
 
+    #
+    # Number of cells in this row.
+    #
+    
     def column_count
       assert_exists
       @cells.length
     end
 
-  end
-end
+  end # TableRow
+end # Celerity

data/lib/celerity/elements/text_field.rb

@@ -1,32 +1,44 @@
 module Celerity
+  
   #
   # Class representing text field elements
   #
   # This class is the main class for Text Fields
   # Normally a user would not need to create this object as it is returned by the Watir::Container#text_field method
+  #
+  
   class TextField < InputElement
     NON_TEXT_TYPES = %w[file radio checkbox submit reset image button hidden]
     TAGS = [ Identifier.new('textarea'),
              Identifier.new('input', :type => ["text", "password", /^(?!(#{ Regexp.union(*NON_TEXT_TYPES) })$)/])  ]
     DEFAULT_HOW = :name
-
+    
+    #
     # Clear the text field.
+    #
+    
     def clear
       assert_exists
       insert_string ''
     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
       clear
       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 +48,11 @@ module Celerity
 
       value
     end
-
+    
+    #
     # Returns the text in the text field.
+    #
+    
     def value
       assert_exists
       case @object.getTagName
@@ -48,14 +63,18 @@ module Celerity
       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
       type_string(value)
     end
 
+    
     def type
       assert_exists
       type = @object.getAttributeValue('type')
@@ -67,8 +86,11 @@ module Celerity
       end
     end
 
+    #
     # This bascially just moves the text to the other text field using TextField#append
-    # Should check if the HtmlUnit API supports some kind of dragging.
+    # TODO: check if HtmlUnit supports some kind of dragging.
+    #
+    
     def drag_contents_to(how, what)
       assert_exists # assert_enabled?
       val = self.value
@@ -76,6 +98,10 @@ module Celerity
       @container.text_field(how, what).append(val)
     end
 
+    #
+    # Check if the given text fields contains the given String or Regexp.
+    #
+    
     def contains_text(expected_text)
       assert_exists
 
@@ -89,9 +115,12 @@ module Celerity
       end
     end
 
+    #
     # A boolean version of TextField#contains_text
     # @param  [String, Regexp] expected_text The text to look for.
     # @return [boolean]
+    #
+    
     def verify_contains(expected)
       # assert_exists called by contains_text
       !!contains_text(expected)
@@ -115,13 +144,21 @@ module Celerity
         raise "unknown tag name #{@object.getTagName.inspect} for #{self.class}"
       end
     end
-  end
+    
+  end # TextField
 
-  # this class can be used to access hidden field objects
+  #
+  # 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 Celerity::Container#hidden method
+  #
+  
   class Hidden < TextField
     TAGS = [ Identifier.new('input', :type => %w[hidden]) ]
     DEFAULT_HOW = :name
+    
+    def visible?
+      false
+    end
   end
 
-end
+end # Celerity

data/lib/celerity/exception.rb

@@ -1,40 +1,77 @@
 module Celerity
   module Exception
-
+    
+    #
     # Superclass for all Celerity exceptions.
+    #
+
     class CelerityException < StandardError; end
 
+    #
     # This exception is thrown if an attempt is made to access an object that doesn't exist
-    class UnknownObjectException < CelerityException; end
+    #
 
+    class UnknownObjectException < CelerityException; end
+    
+    #
     # This exception is thrown if an attempt is made to access an object that is in a disabled state
+    #
+
     class ObjectDisabledException < CelerityException; end
 
+    #
     # This exception is thrown if an attempt is made to access a frame that cannot be found
+    #
+
     class UnknownFrameException < CelerityException; end
 
+    #
     # 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
+    #
+
     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 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
+    #
 
+    class UnknownRowException < CelerityException; end
+    
+    #
     # 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
+    #
 
+    class NavigationException < CelerityException; end
+    
+    #
     # This exception is thrown if an unexpected content type is returned by the server.
+    #
+
     class UnexpectedPageException < CelerityException; end
-  end
-end
+    
+  end # Exception
+end # Celerity

data/lib/celerity/extra/method_generator.rb

@@ -16,7 +16,15 @@ class String # :nodoc:
 end
 
 module Celerity
+
+  #
   # Experimental - generate a method definition for accessing elements on the current page.
+  #
+  # Usage:
+  #
+  #    MethodGenerator.new(browser, opts).parse
+  #
+  #
   class MethodGenerator
 
     ELEMENTS = %w[text_field select_list radio checkbox button].map { |e| e.to_sym }
@@ -135,13 +143,17 @@ module Celerity
   end # MethodGenerator
 
   class Browser
+    
+    #
     # Experimental - generate a method definition for accessing elements on the current page
     # Not loaded by default - need to require 'celerity/extra/method_generator'
+    #
+    
     def generate_method(opts = {})
       MethodGenerator.new(self, opts).parse
     end
+    
   end # Browser
-
 end # Celerity
 
 

data/lib/celerity/htmlunit.rb

@@ -27,7 +27,6 @@ module Java::OrgW3cDom::NamedNodeMap
   end
 end
 
-# this will be added in JRuby 1.1.6
 module Java::JavaLang::Iterable
   include Enumerable
 
@@ -39,3 +38,9 @@ module Java::JavaLang::Iterable
 end
 
 
+class Java::ComGargoylesoftwareHtmlunitHtml::HtmlPage
+  def inspect
+    '#<HtmlPage:0x%s(%s)>' % [self.hash.to_s(16), getWebResponse.getUrl.toString]
+  end
+end
+

data/lib/celerity/listener.rb

@@ -1,7 +1,9 @@
 module Celerity
 
-  # This class is used to wrap some of the various listeners available
-  # from HtmlUnit's WebClient.
+  #
+  # This class is used to wrap some of the listeners available from HtmlUnit's WebClient.
+  #
+  
   class Listener
     include com.gargoylesoftware.htmlunit.AlertHandler
     include com.gargoylesoftware.htmlunit.ConfirmHandler
@@ -16,9 +18,12 @@ module Celerity
       @webclient = webclient
       @procs = Hash.new { |h, k| h[k] = [] }
     end
-
+    
+    #
     # Add a listener block for one of the available types.
     # @see Celerity::Browser#add_listener
+    #
+    
     def add_listener(type, &block)
       case type
       when :status
@@ -58,46 +63,70 @@ module Celerity
         raise TypeError, "must give proc or index"
       end
     end
-
+    
+    #
     # interface StatusHandler
+    #
+    
     def statusMessageChanged(page, message)
       @procs[:status].each { |h| h.call(page, message) }
     end
-
+    
+    #
     # interface AlertHandler
+    #
+    
     def handleAlert(page, message)
       @procs[:alert].each { |h| h.call(page, message) }
     end
-
+    
+    #
     # interface ConfirmHandler
+    #
+    
     def handleConfirm(page, message)
       @procs[:confirm].each { |h| h.call(page, message) }
     end
 
+    #
     # interface AttachmentHandler
+    #
+    
     def handleAttachment(page)
       @procs[:attachment].each { |h| h.call(page) }
     end
-
+    
+    #
     # interface PromptHandler
+    #
+    
     def handlePrompt(page, message)
       @procs[:prompt].each { |h| h.call(page, message) }
     end
-
+    
+    #
     # interface WebWindowListener
+    #
+    
     def webWindowClosed(web_window_event)
       @procs[:web_window_event].each { |h| h.call(web_window_event) }
     end
     alias_method :webWindowOpened, :webWindowClosed
     alias_method :webWindowContentChanged, :webWindowClosed
 
+    #
     # interface HTMLParserListener
+    #
+    
     def error(message, url, line, column, key)
       @procs[:html_parser].each { |h| h.call(message, url, line, column, key) }
     end
     alias_method :warning, :error
 
+    #
     # interface IncorrectnessListener
+    #
+    
     def notify(message, origin)
       @procs[:incorrectness].each { |h| h.call(message, origin) }
     end

data/lib/celerity/util.rb

@@ -51,8 +51,11 @@ module Celerity
       HtmlUnit2CelerityElement[klass]
     end
 
+    #
     # HtmlUnit will recognize most common file types, but custom ones can be added here.
     # Used for FileField uploads.
+    #
+    
     ContentTypes = {
       ".bmp" => "image/x-ms-bmp",
       ".doc" => "application/msword",

data/lib/celerity/version.rb

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