page-object 0.0.4 → 0.0.5

data/ChangeLog

@@ -1,3 +1,18 @@
+=== Version 0.0.5 / 2011-06-15
+* Enhancements
+  * Added rows method to Table to return number or rows
+  * Added columns method to TableRow to return the number of columns
+  * Table now supports Enumerable to iterate over the TableRows
+  * TableRow now supports Enumerable to iterate over TableCells
+  * Added items method to UnorderedList to return number of ListItems
+  * Added items method to OrderedList to return number of ListItems
+  * UnorderedList now supports Enumerable to iterate over the ListItems
+  * OrderedList now supports Enumerable to iterate over the ListItems
+  * All element methods now take an optional block that can be executed passing a browser
+  * Created PageFactory module to add factory methods to your step definitions
+    * Thanks Alister Scott for the idea
+  
+
 === Version 0.0.4 / 2011-06-13
 * Enhancements
   * Added support for the following elements
@@ -12,16 +27,13 @@
   * Added support for the following elements
     * span
     * image
-    
   * Added the following methods to Element
     * value
     * ==
     * tag_name
     * attribute
     * click
-  
   * Updated to use selenium-webdriver 0.2.1
-  
   * Updated to use watir-webdriver 0.2.4
 
 === Version 0.0.2 / 2011-05-30
@@ -32,7 +44,6 @@
     * table
     * table row
     * table cell
-    
   * Added text method to element
 
 === Version 0.0.1 / 2011-05-22
@@ -43,7 +54,6 @@
     * radio button
     * select list
     * text field
-  
   * Support for the following page level functions
     * text
     * html

data/features/ordered_list.feature

@@ -11,6 +11,8 @@ Feature: Ordered list
     When I search for the ordered list by "<search_by>"
     And I get the first item from the list
     Then the list item's text should be "Number One"
+    And the list should contain 3 items
+    And each item should contain "Number"
   
   Scenarios:
     | search_by |

data/features/select_list.feature

@@ -31,8 +31,6 @@ Feature: Select List
     Scenarios:
       | search_by |
       | index     |
-#      | value     |
-#      | text      |
 
   Scenario: Retrieve a select list
     When I retrieve a select list

data/features/span.feature

@@ -28,7 +28,7 @@ Feature: Span
     
     
   @selenium_only
-  Scenario Outline: Locating span on Watir only
+  Scenario Outline: Locating span on Selenium only
     When I search for the span by "<search_by>"
     Then the text should be "My alert"
 

data/features/step_definitions/accessor_steps.rb

@@ -220,3 +220,32 @@ end
 When /^I search for the ordered list by "([^"]*)"$/ do |how|
   @list = @page.send "ol_#{how}_ordered_list"
 end
+
+Then /^the table should have "([^"]*)" rows$/ do |rows|
+  @element.rows.should == rows.to_i
+end
+
+Then /^each row should contain "([^"]*)"$/ do |text|
+  @element.each do |row|
+    row.text.should include text
+  end
+end
+
+Then /^row "([^"]*)" should have "([^"]*)" columns$/ do |row, cols|
+  @element[row.to_i - 1].columns.should == cols.to_i
+end
+
+Then /^each column should contain "([^"]*)"$/ do |text|
+  row = @element[0]
+  row.each do |column|
+    column.text.should include text
+  end
+end
+
+Then /^the list should contain (\d+) items$/ do |items|
+  @list.items.should == items.to_i
+end
+
+Then /^each item should contain "([^"]*)"$/ do |text|
+  @list.each { |item| item.text.should include text }
+end

data/features/table.feature

@@ -19,7 +19,10 @@ Feature: Table
     When I retrieve a table element
     Then the data for row "1" should be "Data1" and "Data2"
     And the data for row "2" should be "Data3" and "Data4"
-  
+    And the table should have "2" rows
+    And each row should contain "Data"
+    And row "1" should have "2" columns
+    And each column should contain "Data"
   
   Scenario Outline: Locating table cells on the Page
     When I retrieve a table element by "<search_by>"

data/features/unordered_list.feature

@@ -11,6 +11,8 @@ Feature: Unordered list
     When I search for the unordered list by "<search_by>"
     And I get the first item from the list
     Then the list item's text should be "Item One"
+    And the list should contain 3 items
+    And each item should contain "Item"
   
   Scenarios:
     | search_by |

data/lib/page-object.rb

@@ -41,9 +41,10 @@ module PageObject
   #
   # @param [Watir::Browser or Selenium::WebDriver::Driver] the platform browser to use
   #
-  def initialize(browser)
+  def initialize(browser, visit=false)
     @browser = browser
     include_platform_driver(browser)
+    goto if visit && respond_to?(:goto)
   end
 
   # @private

data/lib/page-object/accessors.rb

@@ -9,6 +9,19 @@ module PageObject
   # @see PageObject::SeleniumPageObject for the selenium implementation of the platform delegate
   #
   module Accessors
+    
+    #
+    # Specify the url for the page.  A call to this method will generate a
+    # 'goto' method to take you to the page.
+    #
+    # @param [String] the url for the page.
+    #
+    def page_url(url)
+      define_method("goto") do
+        platform.navigate_to url
+      end
+    end
+    
     #
     # adds three methods to the page object - one to set text in a text field,
     # another to retrieve text from a text field and another to return the text
@@ -29,8 +42,9 @@ module PageObject
     #   * :text => Watir only
     #   * :value => Watir only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def text_field(name, identifier)
+    def text_field(name, identifier=nil, &block)
       define_method(name) do
         platform.text_field_value_for identifier
       end
@@ -38,7 +52,7 @@ module PageObject
         platform.text_field_value_set(identifier, value)
       end
       define_method("#{name}_text_field") do
-        platform.text_field_for identifier
+        block ? block.call(browser) : platform.text_field_for(identifier)
       end
     end
     
@@ -60,13 +74,14 @@ module PageObject
     #   * :tag_name => Watir and Selenium
     #   * :text => Watir only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def hidden_field(name, identifier)
+    def hidden_field(name, identifier=nil, &block)
       define_method(name) do
         platform.hidden_field_value_for identifier
       end
       define_method("#{name}_hidden_field") do
-        platform.hidden_field_for identifier
+        block ? block.call(browser) : platform.hidden_field_for(identifier)
       end
     end
     
@@ -88,8 +103,9 @@ module PageObject
     #   * :name => Watir and Selenium
     #   * :tag_name => Watir and Selenium
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def text_area(name, identifier)
+    def text_area(name, identifier=nil, &block)
       define_method(name) do
         platform.text_area_value_for identifier
       end
@@ -97,7 +113,7 @@ module PageObject
         platform.text_area_value_set(identifier, value)
       end
       define_method("#{name}_text_area") do
-        platform.text_area_for identifier
+        block ? block.call(browser) : platform.text_area_for(identifier)
       end
     end
 
@@ -119,8 +135,9 @@ module PageObject
     #   * :text => Watir only
     #   * :value => Watir only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def select_list(name, identifier)
+    def select_list(name, identifier=nil, &block)
       define_method(name) do
         platform.select_list_value_for identifier
       end
@@ -128,7 +145,7 @@ module PageObject
         platform.select_list_value_set(identifier, value)
       end
       define_method("#{name}_select_list") do
-        platform.select_list_for identifier
+        block ? block.call(browser) : platform.select_list_for(identifier)
       end
     end
 
@@ -152,13 +169,14 @@ module PageObject
     #   * :name => Watir and Selenium
     #   * :text => Watir and Selenium
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def link(name, identifier)
+    def link(name, identifier=nil, &block)
       define_method(name) do
         platform.click_link_for identifier
       end
       define_method("#{name}_link") do
-        platform.link_for identifier
+        block ? block.call(browser) : platform.link_for(identifier)
       end
     end
     
@@ -178,8 +196,9 @@ module PageObject
     #   * :index => Watir only
     #   * :name => Watir and Selenium
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def checkbox(name, identifier)
+    def checkbox(name, identifier=nil, &block)
       define_method("check_#{name}") do
         platform.check_checkbox(identifier)
       end
@@ -190,7 +209,7 @@ module PageObject
         platform.checkbox_checked?(identifier)
       end
       define_method("#{name}_checkbox") do
-        platform.checkbox_for identifier
+        block ? block.call(browser) : platform.checkbox_for(identifier)
       end
     end
     
@@ -211,8 +230,9 @@ module PageObject
     #   * :index => Watir only
     #   * :name => Watir and Selenium
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def radio_button(name, identifier)
+    def radio_button(name, identifier=nil, &block)
       define_method("select_#{name}") do
         platform.select_radio(identifier)
       end
@@ -223,7 +243,7 @@ module PageObject
         platform.radio_selected?(identifier)
       end
       define_method("#{name}_radio_button") do
-        platform.radio_button_for identifier
+        block ? block.call(browser) : platform.radio_button_for(identifier)
       end
     end
 
@@ -243,13 +263,14 @@ module PageObject
     #   * :name => Watir and Selenium
     #   * :text => Watir only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def button(name, identifier)
+    def button(name, identifier=nil, &block)
       define_method(name) do
         platform.click_button_for identifier
       end
       define_method("#{name}_button") do
-        platform.button_for identifier
+        block ? block.call(browser) : platform.button_for(identifier)
       end
     end
     
@@ -268,13 +289,14 @@ module PageObject
     #   * :index => Watir only
     #   * :name => Selenium only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def div(name, identifier) 
+    def div(name, identifier=nil, &block)
       define_method(name) do
         platform.div_text_for identifier
       end
       define_method("#{name}_div") do
-        platform.div_for identifier
+        block ? block.call(browser) : platform.div_for(identifier)
       end
     end
 
@@ -293,13 +315,14 @@ module PageObject
     #   * :index => Watir only
     #   * :name => Selenium only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def span(name, identifier)
+    def span(name, identifier=nil, &block)
       define_method(name) do
         platform.span_text_for identifier
       end
       define_method("#{name}_span") do
-        platform.span_for identifier
+        block ? block.call(browser) : platform.span_for(identifier)
       end
     end
 
@@ -317,10 +340,11 @@ module PageObject
     #   * :index => Watir only
     #   * :name => Selenium only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def table(name, identifier)
+    def table(name, identifier=nil, &block)
       define_method("#{name}_table") do
-        platform.table_for identifier
+        block ? block.call(browser) : platform.table_for(identifier)
       end
     end
     
@@ -339,13 +363,14 @@ module PageObject
     #   * :index => Watir only
     #   * :name => Selenium only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def cell(name, identifier)
+    def cell(name, identifier=nil, &block)
       define_method("#{name}") do
         platform.cell_text_for identifier
       end
       define_method("#{name}_cell") do
-        platform.cell_for identifier
+        block ? block.call(browser) : platform.cell_for(identifier)
       end
     end
     
@@ -363,10 +388,11 @@ module PageObject
     #   * :index => Watir only
     #   * :name => Watir and Selenium
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def image(name, identifier)
+    def image(name, identifier=nil, &block)
       define_method("#{name}_image") do
-        platform.image_for identifier
+        block ? block.call(browser) : platform.image_for(identifier)
       end
     end
     
@@ -383,10 +409,11 @@ module PageObject
     #   * :id => Watir and Selenium
     #   * :index => Watir only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def form(name, identifier)
+    def form(name, identifier=nil, &block)
       define_method("#{name}_form") do
-        platform.form_for identifier
+        block ? block.call(browser) : platform.form_for(identifier)
       end
     end
     
@@ -405,13 +432,14 @@ module PageObject
     #   * :index => Watir only
     #   * :name => Selenium only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def list_item(name, identifier)
+    def list_item(name, identifier=nil, &block)
       define_method(name) do
         platform.list_item_text_for identifier
       end
       define_method("#{name}_list_item") do
-        platform.list_item_for identifier
+        block ? block.call(browser) : platform.list_item_for(identifier)
       end
     end
     
@@ -429,10 +457,11 @@ module PageObject
     #   * :index => Watir only
     #   * :name => Selenium only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def unordered_list(name, identifier)
+    def unordered_list(name, identifier=nil, &block)
       define_method("#{name}_unordered_list") do
-        platform.unordered_list_for identifier
+        block ? block.call(browser) : platform.unordered_list_for(identifier)
       end
     end
     
@@ -450,10 +479,11 @@ module PageObject
     #   * :index => Watir only
     #   * :name => Selenium only
     #   * :xpath => Watir and Selenium
+    # @param optional block to be invoked when element method is called
     #
-    def ordered_list(name, identifier)
+    def ordered_list(name, identifier=nil, &block)
       define_method("#{name}_ordered_list") do
-        platform.ordered_list_for identifier
+        block ? block.call(browser) : platform.ordered_list_for(identifier)
       end
     end
   end

data/lib/page-object/elements/ordered_list.rb

@@ -1,14 +1,30 @@
 module PageObject
   module Elements
     class OrderedList < Element
+      include Enumerable
       
       def initialize(element, platform)
         @element = element
         include_platform_for platform
       end
       
+      #
+      # iterator that yields with a PageObject::Elements::ListItem
+      #
+      # @return [PageObject::Elements::ListItem]
+      #
+      def each
+        for index in 1..self.items do
+          yield self[index-1] 
+        end
+      end      
+      
       protected
       
+      def child_xpath
+        ".//child::li"
+      end
+      
       def self.watir_finders
         [:class, :id, :index, :xpath]
       end