watir-webdriver 0.0.1.dev4 → 0.0.1.dev5

data/VERSION

@@ -1 +1 @@
-0.0.1.dev4
+0.0.1.dev5

data/lib/watir-webdriver/browser.rb

@@ -94,6 +94,7 @@ module Watir
 
     def refresh
       @driver.navigate.refresh
+      run_checkers
     end
 
     def status

data/lib/watir-webdriver/collections/element_collection.rb

@@ -7,15 +7,35 @@ module Watir
       @parent, @element_class = parent, element_class
     end
 
+    #
+    # @yieldparam [Watir::BaseElement] element Iterate through the elements in this collection.
+    #
+
     def each(&blk)
       to_a.each(&blk)
     end
 
+    #
+    # @return [Fixnum] The number of elements in this collection.
+    #
+
     def length
       elements.length
     end
     alias_method :size, :length
 
+    #
+    # Get the element at the given index.
+    # Note that this is 0-indexed and not compatible with older Watir implementations.
+    #
+    # 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, 0-indexed
+    # @return [Watir::BaseElement] Returns an instance of a Watir::BaseElement subclass
+    #
+
+
     def [](idx)
       to_a[idx] || @element_class.new(@parent, :index, idx)
     end
@@ -23,7 +43,7 @@ module Watir
     #
     # First element of this collection
     #
-    # @return Watir::BaseElement
+    # @return [Watir::BaseElement] Returns an instance of a Watir::BaseElement subclass
     #
 
     def first
@@ -33,7 +53,7 @@ module Watir
     #
     # Last element of the collection
     #
-    # @return Watir::BaseElement
+    # @return [Watir::BaseElement] Returns an instance of a Watir::BaseElement subclass
     #
 
     def last

data/lib/watir-webdriver/elements/button.rb

@@ -1,13 +1,23 @@
 # encoding: utf-8
 module Watir
+
+  #
+  # Class representing button elements.
+  #
+  # This class covers both <button> and <input type="submit|reset|image|button" /> elements.
+  #
+
   class Button < HTMLElement
 
     # add the attributes from <input>
     attributes Watir::Input.typed_attributes
 
-    def locate
-      ButtonLocator.new(@parent.wd, @selector, self.class.attribute_list).locate
-    end
+    #
+    # Returns the text of the button.
+    #
+    # For input elements, returns the "value" attribute.
+    # For button elements, returns the inner text.
+    #
 
     def text
       assert_exists
@@ -21,9 +31,21 @@ module Watir
       end
     end
 
+    #
+    # Returns true if this element is enabled
+    #
+    # @return [Boolean]
+    #
+
     def enabled?
       !disabled?
     end
 
+    private
+
+    def locate
+      ButtonLocator.new(@parent.wd, @selector, self.class.attribute_list).locate
+    end
+
   end
 end

data/lib/watir-webdriver/elements/checkbox.rb

@@ -6,6 +6,18 @@ module Watir
     container_method  :checkbox
     collection_method :checkboxes
 
+    #
+    # Set this checkbox to the given value
+    #
+    # Example:
+    #
+    #   checkbox.set?        #=> false
+    #   checkbox.set
+    #   checkbox.set?        #=> true
+    #   checkbox.set(false)
+    #   checkbox.set?        #=> false
+    #
+
     def set(bool = true)
       assert_exists
       assert_enabled
@@ -17,11 +29,22 @@ module Watir
       end
     end
 
+    #
+    # returns true if the element is checked
+    # @return [Boolean]
+    #
+
     def set?
       assert_exists
       @element.selected?
     end
 
+    #
+    # Unset this checkbox.
+    #
+    # Same as +set(false)+
+    #
+
     def clear
       set false
     end

data/lib/watir-webdriver/elements/file_field.rb

@@ -6,11 +6,23 @@ module Watir
     container_method  :file_field
     collection_method :file_fields
 
+    #
+    # Set the file field to the given path
+    #
+    # @param [String] a value
+    #
+
     def set(value)
       assert_exists
       @element.send_keys value
     end
 
+    #
+    # Return the value of this field
+    #
+    # @return [String]
+    #
+
     def value
       # since 'value' is an attribute on input fields, we override this here
       assert_exists

data/lib/watir-webdriver/elements/form.rb

@@ -2,6 +2,12 @@
 module Watir
   class Form
 
+    #
+    # Submits the form.
+    #
+    # This method should be avoided - invoke the user interface element that triggers the submit instead.
+    #
+
     def submit
       assert_exists
       @element.submit

data/lib/watir-webdriver/elements/hidden.rb

@@ -5,12 +5,7 @@ module Watir
 
     container_method  :hidden
     collection_method :hiddens
-    
-    # deprecate?
-    def value=(val)
-      raise NotImplementedError
-    end
-    
+
     def visible?
       false
     end

data/lib/watir-webdriver/elements/image.rb

@@ -4,11 +4,23 @@ module Watir
 
     alias_method :loaded?, :complete?
 
+    #
+    # returns the image's width in pixels
+    #
+    # @return [Integer] width
+    #
+
     def width
       assert_exists
       driver.execute_script "return arguments[0].width", @element
     end
 
+    #
+    # returns the image's height in pixels
+    #
+    # @return [Integer] height
+    #
+
     def height
       assert_exists
       driver.execute_script "return arguments[0].height", @element

data/lib/watir-webdriver/elements/input.rb

@@ -8,6 +8,13 @@ module Watir
       !disabled?
     end
 
+    #
+    # Return the type attribute of the element, or 'text' if the attribute is invalid.
+    # TODO: discuss.
+    #
+    # @return [String]
+    #
+
     def type
       assert_exists
       value = rescue_no_match { @element.attribute("type").to_s }

data/lib/watir-webdriver/elements/option.rb

@@ -1,17 +1,34 @@
 # encoding: utf-8
 module Watir
+
+  #
+  # Represents an option in a select list.
+  #
+
   class Option < HTMLElement
 
+    #
+    # Select this option
+    #
+
     def select
       assert_exists
       @element.select
     end
-    
+
+    #
+    # Toggle the selected state of this option
+    #
+
     def toggle
       assert_exists
       @element.toggle
     end
-    
+
+    #
+    # Is this option selected?
+    #
+
     def selected?
       assert_exists
       @element.selected?

data/lib/watir-webdriver/elements/radio.rb

@@ -6,6 +6,10 @@ module Watir
     container_method  :radio
     collection_method :radios
 
+    #
+    # Select this radio button.
+    #
+
     def set
       assert_exists
       assert_enabled
@@ -13,6 +17,10 @@ module Watir
       @element.click unless set?
     end
 
+    #
+    # Is this radio set?
+    #
+
     def set?
       assert_exists
       @element.selected?

data/lib/watir-webdriver/elements/select_list.rb

@@ -6,10 +6,20 @@ module Watir
     container_method  :select_list
     collection_method :select_lists
 
+    #
+    # Returns true if this element is enabled
+    #
+    # @return [Boolean]
+    #
+
     def enabled?
       !disabled?
     end
 
+    #
+    # Clear all selected options
+    #
+
     def clear
       assert_exists
 
@@ -20,19 +30,55 @@ module Watir
       end
     end
 
-    def includes?(str_or_rx)
+    #
+    # Returns true if the select list has one or more options where text or label matches the given value.
+    #
+    # @param [String, Regexp] value A value.
+    # @return [Boolean]
+    #
+
+    def include?(str_or_rx)
       assert_exists
+      # TODO: optimize similar to selected?
       options.any? { |e| str_or_rx === e.text }
     end
+    alias_method :includes?, :include?
+
+    #
+    # Select the option(s) whose text or label matches the given string.
+    # If this is a multi-select and several options match the value given, all will be selected.
+    #
+    # @param [String, Regexp] value A value.
+    # @raise [Watir::Exception::NoValueFoundException] if the value does not exist.
+    # @return [String] The text of the option selected. If multiple options match, returns the first match.
+    #
 
     def select(str_or_rx)
         select_by :text, str_or_rx, multiple?
     end
 
+    #
+    # Selects the option(s) whose value attribute matches the given string.
+    #
+    # @see +select+
+    #
+    # @param [String, Regexp] value A value.
+    # @raise [Watir::Exception::NoValueFoundException] if the value does not exist.
+    # @return [String] The option selected. If multiple options match, returns the first match
+    #
+
     def select_value(str_or_rx)
       select_by :value, str_or_rx, multiple?
     end
 
+    #
+    # Returns true if any of the selected options' text or label match the given value.
+    #
+    # @param [String, Regexp] value A value.
+    # @raise [Watir::Exception::UnknownObjectException] if the value does not exist.
+    # @return [Boolean]
+    #
+
     def selected?(str_or_rx)
       assert_exists
       matches = @element.find_elements(:tag_name, 'option').select { |e| str_or_rx === e.text || str_or_rx === e.attribute(:label) }
@@ -44,6 +90,13 @@ module Watir
       matches.any? { |e| e.selected? }
     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
       o = options.find { |e| e.selected? }
       return if o.nil?
@@ -51,6 +104,11 @@ module Watir
       o.value
     end
 
+
+    #
+    # @return [Array<String>] An array of strings representing the text value of the currently selected options.
+    #
+
     def selected_options
       assert_exists
       options.map { |e| e.text if e.selected? }.compact
@@ -124,9 +182,9 @@ module Watir
     def option_xpath_for(how, string)
       case how
       when :text
-        "//option[normalize-space()=#{string.inspect} or @label=#{string.inspect}]"
+        "//option[normalize-space()='#{string}' or @label='#{string}']"
       when :value
-        "//option[@value=#{string.inspect}]"
+        "//option[@value='#{string}']"
       else
         raise Error, "unknown how: #{how.inspect}"
       end

data/lib/watir-webdriver/elements/table.rb

@@ -1,15 +1,27 @@
 # encoding: utf-8
 module Watir
   class Table < HTMLElement
-    
+
+    #
+    # The table as an 2D Array of strings with the text of each cell.
+    #
+    # @return [Array<Array<String>>]
+    #
+
     def to_a
       assert_exists
-      
+
       trs.inject [] do |res, row|
-        res << row.tds.map { |cell| cell.text }
+        res << row.wd.find_elements(:xpath, ".//td | .//th").map { |cell| cell.text }
       end
     end
-    
+
+    #
+    # Get the n'th row of this table.
+    #
+    # @return Watir::TableRow
+    #
+
     def [](idx)
       row(:index, idx)
     end

data/lib/watir-webdriver/elements/table_row.rb

@@ -1,10 +1,18 @@
 module Watir
   class TableRow < HTMLElement
 
+    #
+    # Get the n'th <td> of this element
+    #
+    # @return Watir::TableDataCell
+    #
+
     def [](idx)
       td(:index, idx)
     end
 
+    private
+
     def locate
       if @parent.kind_of?(Watir::Table)
         TableRowLocator.new(@parent.wd, @selector, self.class.attribute_list).locate

data/lib/watir-webdriver/elements/text_field.rb

@@ -8,28 +8,27 @@ module Watir
     container_method  :text_field
     collection_method :text_fields
 
-    def locate
-      TextFieldLocator.new(@parent.wd, @selector, self.class.attribute_list).locate
-    end
-
     def inspect
-      '#<%s:0x%x located=%s selector=%s>' % [self.class, hash*2, !!@element, selector_without_type.inspect]
+      '#<%s:0x%x located=%s selector=%s>' % [self.class, hash*2, !!@element, selector_string]
     end
 
-    def selector_string
-      selector_without_type.inspect
-    end
+    #
+    # Clear the element, the type in the given value.
+    #
 
     def set(*args)
       assert_exists
       assert_writable
 
       @element.clear
-
-      append(*args)
+      @element.send_keys(*args)
     end
     alias_method :value=, :set
 
+    #
+    # Append the given value to the text in the text field.
+    #
+
     def append(*args)
       assert_exists
       assert_writable
@@ -37,11 +36,18 @@ module Watir
       @element.send_keys(*args)
     end
 
+    #
+    # Clear the text field.
+    #
+
     def clear
       assert_exists
       @element.clear
     end
 
+    #
+    # Returns the text in the text field.
+    #
 
     def value
       # since 'value' is an attribute on input fields, we override this here
@@ -51,6 +57,14 @@ module Watir
 
     private
 
+    def locate
+      TextFieldLocator.new(@parent.wd, @selector, self.class.attribute_list).locate
+    end
+
+    def selector_string
+      selector_without_type.inspect
+    end
+
     def selector_without_type
       s = @selector.dup
       s[:type] = '(any text type)'

data/lib/watir-webdriver/xpath_support.rb

@@ -3,6 +3,10 @@ module Watir
   module XpathSupport
     include Selenium
 
+    #
+    # Find the first element matching the given XPath
+    #
+
     def element_by_xpath(xpath)
       e = wd.find_element(:xpath, xpath)
       Watir.element_class_for(e.tag_name).new(self, :element, e)
@@ -10,6 +14,10 @@ module Watir
       BaseElement.new(self, :xpath, xpath)
     end
 
+    #
+    # Find all elements matching the given XPath
+    #
+
     def elements_by_xpath(xpath)
       # TODO: find the correct element class
       wd.find_elements(:xpath, xpath).map do |e|

data/spec/watirspec/table_cell_spec.rb

@@ -26,7 +26,7 @@ describe "TableCell" do
       browser.cell(:index, 1337).should_not exist
       browser.cell(:xpath, "//td[@id='no_such_id']").should_not exist
     end
-
+    
     it "raises TypeError when 'what' argument is invalid" do
       lambda { browser.cell(:id, 3.14).exists? }.should raise_error(TypeError)
     end

data/spec/watirspec/table_spec.rb

@@ -130,7 +130,7 @@ describe "Table" do
       lambda { browser.table(:id, 'outer').child_cell(1337) }.should raise_error(UnknownCellException)
     end
   end
-
+  
   describe "#each" do
     it "iterates through the table's rows" do
       ids = ["outer_first", "outer_second", "outer_last"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: watir-webdriver
 version: !ruby/object:Gem::Version 
-  version: 0.0.1.dev4
+  version: 0.0.1.dev5
 platform: ruby
 authors: 
 - Jari Bakken
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-27 00:00:00 +01:00
+date: 2010-02-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency