celerity 0.0.4 → 0.0.6

data/lib/celerity/elements/table_row.rb

@@ -1,7 +1,8 @@
 module Celerity
   class TableRow < Element
-    include Enumerable # specs for this?
-    
+    include Enumerable
+    include ClickableElement
+
     TAGS = [ Identifier.new('tr') ]
     DEFAULT_HOW = :id
 
@@ -10,23 +11,38 @@ module Celerity
       @cells = @object.getCells if @object
     end
 
+    #
+    # 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
-      raise UnknownCellException, "Unable to locate a cell at index #{index}" if @cells.length < index
-      
-      TableCell.new(self, :object, @cells[index-1])
+
+      if (index - INDEX_OFFSET) >= @cells.length
+        raise UnknownCellException, "Unable to locate a cell at index #{index}"
+      end
+
+      TableCell.new(self, :object, @cells[index - INDEX_OFFSET])
     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,27 +1,32 @@
 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
-    TAGS = [ Identifier.new('textarea'), 
-             Identifier.new('input', :type => ["text", "password", /^(?!(file|radio|checkbox|submit|reset|image|button|hidden)$)/])  ]
+    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
-      case @object.getTagName
-      when 'textarea'
-        @object.setText('')
-      when 'input'
-        @object.setValueAttribute('')
-      end
+      insert_string ''
     end
-  
-    # Set the text field to the given value. 
+    
+    #
+    # 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
@@ -29,23 +34,25 @@ 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
       clear
-      case @object.getTagName
-      when 'textarea'
-        @object.setText(value.to_s)
-      when 'input'
-        @object.setValueAttribute(value.to_s)
-      end
-      
+
+      insert_string value.to_s
+
       value
     end
     
+    #
     # Returns the text in the text field.
+    #
+    
     def value
       assert_exists
       case @object.getTagName
@@ -56,53 +63,102 @@ 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')
-      
-      if ['file', 'radio', 'checkbox', 'submit', 'reset', 'image', 'button', 'hidden'].include?(type)
+
+      if NON_TEXT_TYPES.include?(type)
         type
       else
         'text'
       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
       self.value = ''
       @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
+
+      case expected_text
+      when Regexp
+        value() =~ expected_text
+      when String
+        value().index(expected_text)
+      else
+        raise TypeError, "expected String or Regexp, got #{expected_text.inspect}:#{expected_text.class}"
+      end
+    end
+
+    #
+    # A boolean version of TextField#contains_text
+    # @param  [String, Regexp] expected_text The text to look for.
+    # @return [boolean]
+    #
     
-    # A boolean version of Element#contains_text :P
     def verify_contains(expected)
       # assert_exists called by contains_text
       !!contains_text(expected)
     end
-    
-    private 
+
+    private
+
     def type_string(value)
-      JavaString.new(value.to_java_bytes, @container.page.getPageEncoding).toCharArray.each do |char| 
-        @container.update_page @object.type(char) 
+      java.lang.String.new(value.to_java_bytes, @container.page.getPageEncoding).toCharArray.each do |char|
+        @container.update_page @object.type(char)
       end
     end
-  end
-  
-  # this class can be used to access hidden field objects
+
+    def insert_string(value)
+      case @object.getTagName
+      when 'textarea'
+        @object.setText(value)
+      when 'input'
+        @object.setValueAttribute(value)
+      else
+        raise "unknown tag name #{@object.getTagName.inspect} for #{self.class}"
+      end
+    end
+    
+  end # TextField
+
+  #
+  # 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)) ]
+    TAGS = [ Identifier.new('input', :type => %w[hidden]) ]
     DEFAULT_HOW = :name
+    
+    def visible?
+      false
+    end
   end
-  
-end
+
+end # Celerity

data/lib/celerity/exception.rb

@@ -1,41 +1,77 @@
-module Celerity
-  module Exception
-
-    # 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
-    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
-      
-    # 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
-  end
-end
+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
+    
+    #
+    # 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
+    
+    #
+    # 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 thrown if an unexpected content type is returned by the server.
+    #
+
+    class UnexpectedPageException < CelerityException; end
+    
+  end # Exception
+end # Celerity

data/lib/celerity/extra/method_generator.rb

@@ -16,15 +16,23 @@ class String # :nodoc:
 end
 
 module Celerity
-  # Experimental
+
+  #
+  # 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 }
     BUGGY_ELEMENTS = %w[radio checkbox].map { |e| e.to_sym }
-  
+
     def initialize(ie, opts = {})
-      @ie = ie
-      @opts = opts
+      @ie      = ie
+      @opts    = opts
       @browser = @opts[:browser] || '@ie'
 
       @docs = "  # Fills in the page at #{@ie.url}\n  #\n"
@@ -33,7 +41,7 @@ module Celerity
 
       @method = "  def #{@opts[:method_name] || 'generated_method'}(opts = {})\n\n"
     end
-  
+
     def parse
       ELEMENTS.each do |elem|
         @method << "    # buggy!\n" if BUGGY_ELEMENTS.include?(elem)
@@ -50,18 +58,19 @@ module Celerity
       @docs << "  #\n"*2
       @docs + @method
     end
-  
+
     private
-  
+
     def add_elements(symbol)
       symbol = symbol.to_sym
-      symbol_pluralized = symbol.to_s.pluralize.to_sym 
+      symbol_pluralized = symbol.to_s.pluralize.to_sym
       @ie.send(symbol_pluralized).each_with_index do |elem, idx|
         self.send("add_#{symbol}".to_sym, elem, idx)
       end
+
       @method << "\n"
     end
-  
+
     def add_text_field(elem, idx)
       how, what = find_identifier(elem) || [:index, (idx + 1).to_s]
       @method << "    #{@browser}.text_field(#{how.inspect}, #{what.inspect}).value = "
@@ -69,7 +78,7 @@ module Celerity
       @method << "opts[#{symbol}]\n"
       @doc_elements << [symbol, "value for text field #{what.inspect}"]
     end
-  
+
     def add_select_list(elem, idx)
       how, what = find_identifier(elem) || [:index, (idx + 1).to_s]
       @method << "    #{@browser}.select_list(#{how.inspect}, #{what.inspect}).select("
@@ -77,38 +86,41 @@ module Celerity
       @method << "opts[#{symbol}])\n"
       @doc_elements << [symbol, "option to select for select list #{what.inspect}"]
     end
-  
+
     def add_radio(elem, idx)
       how, what = find_identifier(elem) || [:index, (idx + 1).to_s]
       @method << "    #{@browser}.radio(#{how.inspect}, #{what.inspect}, "
+
       if (value = elem.value).empty?
         symbol = (how == :index) ? ":radio_#{what.underscore}" : ":#{what.underscore}"
       else
         symbol = ":#{what.underscore}_#{value.underscore}"
         @method << "#{value.inspect}).set if opts[#{symbol}]\n"
       end
+
       @doc_elements << [symbol, "set the radio with id/value #{what.inspect}"]
     end
-  
+
     def add_checkbox(elem, idx)
       how, what = find_identifier(elem) || [:index, (idx + 1).to_s]
       @method << "    #{@browser}.checkbox(#{how.inspect}, #{what.inspect}, "
       symbol = (how == :index) ? ":checkbox_#{what.underscore}" : ":#{what.underscore}"
       @method << "#{elem.value.inspect}).set if opts[#{symbol}]\n"
+
       @doc_elements << [symbol, "set the checkbox with id/value #{what.inspect}"]
     end
-  
+
     def add_button(elem, idx)
       how, what = find_identifier(elem) || [:index, (idx + 1).to_s]
       @method << "    #{@browser}.button(#{how.inspect}, #{what.inspect}).click\n"
     end
-  
+
     def add_link(elem, idx)
       if (href = elem.href) =~ /javascript/
         how, what = :index, (idx + 1).to_s
       else
         how = :url
-        
+
         begin
           uri = URI.parse(href)
           what = Regexp.new(Regexp.escape(uri.to_s.sub(/.*#{uri.host}\//, '')))
@@ -118,24 +130,30 @@ module Celerity
       end
       @method << "    #{@browser}.link(#{how.inspect}, #{what.inspect}).click\n"
     end
-  
+
     def find_identifier(element)
-      # could use these if they were 'weighted' ?
+      # could use ATTRIBUTES if they were 'weighted' somehow?
       attrs = element.class::ATTRIBUTES
       [:id, :name].each do |attribute|
         return [attribute, element.send(attribute)] if attrs.include?(attribute) && !element.send(attribute).empty?
       end
       nil
     end
-  
+
   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
-   
+    
+  end # Browser
 end # Celerity
 
 
@@ -144,9 +162,9 @@ end # Celerity
 #   require File.dirname(__FILE__) + "/../spec/spec_helper"
 #   $stdout.sync = true
 #   @ie = Browser.new
-#   @ie.goto(TEST_HOST + "/forms_with_input_elements.html")
-# 
+#   @ie.goto(HTML_DIR + "/forms_with_input_elements.html")
+#
 #   puts MethodGenerator.new(@ie).parse
-#   @ie.goto(TEST_HOST + "/forms3.html")
+#   @ie.goto(HTML_DIR + "/forms3.html")
 #   puts MethodGenerator.new(@ie).parse
 # end