lib/page-object/accessors.rb in page-object-0.0.3 vs lib/page-object/accessors.rb in page-object-0.0.4

@@ -1,32 +1,36 @@
 
-#
-# Contains the class level methods that are inserted into your page objects
-# when you include the PageObject module.  These methods will generate another
-# set of methods that provide access to the elements on the web pages.
-#
 module PageObject
+  #
+  # Contains the class level methods that are inserted into your page objects
+  # when you include the PageObject module.  These methods will generate another
+  # set of methods that provide access to the elements on the web pages.
+  #
+  # @see PageObject::WatirPageObject for the watir implementation of the platform delegate
+  # @see PageObject::SeleniumPageObject for the selenium implementation of the platform delegate
+  #
   module Accessors
     #
     # 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
     # field element.
     #
-    # Example:  text_field(:first_name, {:id => "first_name"})
-    # will generate the 'first_name', 'first_name=' and 'first_name_text_field methods.
+    # @example  
+    #   text_field(:first_name, :id => "first_name") 
+    #   # will generate 'first_name', 'first_name=' and 'first_name_text_field' methods
     #
-    # @param  the name used for the generated methods
-    # @param identifier how we find a text_field.  The valid values are:
-    #   :class => Watir and Selenium
-    #   :css => Watir and Selenium
-    #   :id => Watir and Selenium
-    #   :index => Watir only
-    #   :name => Watir and Selenium
-    #   :tag_name => Watir and Selenium
-    #   :text => Watir only
-    #   :value => Watir only
-    #   :xpath => Watir and Selenium
+    # @param  [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a text_field.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :css => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Watir and Selenium
+    #   * :tag_name => Watir and Selenium
+    #   * :text => Watir only
+    #   * :value => Watir only
+    #   * :xpath => Watir and Selenium
     #
     def text_field(name, identifier)
       define_method(name) do
         platform.text_field_value_for identifier
       end
@@ -35,28 +39,88 @@
       end
       define_method("#{name}_text_field") do
         platform.text_field_for identifier
       end
     end
+    
+    #
+    # adds two methods to the page object - one to get the text from a hidden field
+    # and another to retrieve the hidden field element.
+    #
+    # @example
+    #   hidden_field(:user_id, :id => "user_identity")
+    #   # will generate 'user_id' and 'user_id_hidden_field' methods
+    #
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a hidden field.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :css => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Watir and Selenium
+    #   * :tag_name => Watir and Selenium
+    #   * :text => Watir only
+    #   * :xpath => Watir and Selenium
+    #
+    def hidden_field(name, identifier)
+      define_method(name) do
+        platform.hidden_field_value_for identifier
+      end
+      define_method("#{name}_hidden_field") do
+        platform.hidden_field_for identifier
+      end
+    end
+    
+    #
+    # adds three methods to the page object - one to set text in a text area,
+    # another to retrieve text from a text area and another to return the text
+    # area element.
+    #
+    # @example
+    #   text_area(:address, :id => "address")
+    #   # will generate 'address', 'address=' and 'address_text_area methods
+    #
+    # @param  [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a text area.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :css => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Watir and Selenium
+    #   * :tag_name => Watir and Selenium
+    #   * :xpath => Watir and Selenium
+    #
+    def text_area(name, identifier)
+      define_method(name) do
+        platform.text_area_value_for identifier
+      end
+      define_method("#{name}=") do |value|
+        platform.text_area_value_set(identifier, value)
+      end
+      define_method("#{name}_text_area") do
+        platform.text_area_for identifier
+      end
+    end
 
     #
     # adds three methods - one to select an item in a drop-down,
     # another to fetch the currently selected item and another
     # to retrieve the select list element.
     #
-    # Example:  select_list(:state, {:id => "state"})
-    # will generate the 'state', 'state=' and 'state_select_list' methods
+    # @example
+    #   select_list(:state, :id => "state")
+    #   # will generate 'state', 'state=' and 'state_select_list' methods
     #
-    # @param the name used for the generated methods
-    # @param identifier how we find a select_list.  The valid values are:
-    #   :class => Watir and Selenium
-    #   :id => Watir and Selenium
-    #   :index => Watir only
-    #   :name => Watir and Selenium
-    #   :text => Watir only
-    #   :value => Watir only
-    #   :xpath => Watir and Selenium
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a select_list.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Watir and Selenium
+    #   * :text => Watir only
+    #   * :value => Watir only
+    #   * :xpath => Watir and Selenium
     #
     def select_list(name, identifier)
       define_method(name) do
         platform.select_list_value_for identifier
       end
@@ -71,25 +135,25 @@
     #
     # adds two methods - one to select a link and another
     # to return a PageObject::Elements::Link object representing
     # the link.
     #
-    # Example:  link(:add_to_cart, {:text => "Add to Cart"})
-    # will generate the 'add_to_cart' and 'add_to_cart_link'
-    # method.
+    # @example
+    #   link(:add_to_cart, :text => "Add to Cart")
+    #   # will generate 'add_to_cart' and 'add_to_cart_link' methods
     #
-    # @param the name used for the generated methods
-    # @param identifier how we find a link.  The valid values are:
-    #   :class => Watir and Selenium
-    #   :href => Watir only
-    #   :id => Watir and Selenium
-    #   :index => Watir only
-    #   :link => Watir and Selenium
-    #   :link_text => Watir and Selenium
-    #   :name => Watir and Selenium
-    #   :text => Watir and Selenium
-    #   :xpath => Watir and Selenium
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a link.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :href => Watir only
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :link => Watir and Selenium
+    #   * :link_text => Watir and Selenium
+    #   * :name => Watir and Selenium
+    #   * :text => Watir and Selenium
+    #   * :xpath => Watir and Selenium
     #
     def link(name, identifier)
       define_method(name) do
         platform.click_link_for identifier
       end
@@ -101,21 +165,21 @@
     #
     # adds four methods - one to check, another to uncheck, another
     # to return the state of a checkbox, and a final method to return
     # a PageObject::Elements::CheckBox object representing the checkbox.
     #
-    # Example: checkbox(:active, {:name => "is_active"})
-    # will generate the 'check_active', 'uncheck_active',
-    # 'active_checked?' and 'active_checkbox' methods.
+    # @example
+    #   checkbox(:active, :name => "is_active")
+    #   # will generate 'check_active', 'uncheck_active', 'active_checked?' and 'active_checkbox' methods
     #
-    # @param the name used for the generated methods
-    # @param identifier how we find a checkbox.  The valid values are:
-    #   :class => Watir and Selenium
-    #   :id => Watir and Selenium
-    #   :index => Watir only
-    #   :name => Watir and Selenium
-    #   :xpath => Watir and Selenium
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a checkbox.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Watir and Selenium
+    #   * :xpath => Watir and Selenium
     #
     def checkbox(name, identifier)
       define_method("check_#{name}") do
         platform.check_checkbox(identifier)
       end
@@ -134,21 +198,21 @@
     # adds four methods - one to select, another to clear,
     # another to return if a radio button is selected, and
     # another method to return a PageObject::Elements::RadioButton
     # object representing the radio button element
     #
-    # Example:  radio_button(:north, {:id => "north"})
-    # will generate 'select_north', 'clear_north',
-    # 'north_selected?' and 'north_radio_button' methods
+    # @example
+    #   radio_button(:north, :id => "north")
+    #   # will generate 'select_north', 'clear_north', 'north_selected?' and 'north_radio_button' methods
     #
-    # @param the name used for the generated methods
-    # @param identifier how we find a checkbox.  The valid values are:
-    #   :class => Watir and Selenium
-    #   :id => Watir and Selenium
-    #   :index => Watir only
-    #   :name => Watir and Selenium
-    #   :xpath => Watir and Selenium
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a radio button.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Watir and Selenium
+    #   * :xpath => Watir and Selenium
     #
     def radio_button(name, identifier)
       define_method("select_#{name}") do
         platform.select_radio(identifier)
       end
@@ -165,21 +229,22 @@
 
     #
     # adds two methods - one to click a button and another to
     # return the button element.
     #
-    # Example: button(:purchase, :id => 'purchase')
-    # will generate a 'purchase' and 'purchase_button' methods.
+    # @example
+    #   button(:purchase, :id => 'purchase')
+    #   # will generate 'purchase' and 'purchase_button' methods
     #
-    # @param the name used for the generated methods
-    # @param identifier how we find a checkbox.  The valid values are:
-    #   :class => Watir and Selenium
-    #   :id => Watir and Selenium
-    #   :index => Watir only
-    #   :name => Watir and Selenium
-    #   :text => Watir only
-    #   :xpath => Watir and Selenium
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a button.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Watir and Selenium
+    #   * :text => Watir only
+    #   * :xpath => Watir and Selenium
     #
     def button(name, identifier)
       define_method(name) do
         platform.click_button_for identifier
       end
@@ -190,20 +255,21 @@
     
     #
     # adds two methods - one to retrieve the text from a div
     # and another to return the div element
     #
-    # Example:  div(:message, {:id => 'message'})
-    # will generate a 'message' and 'message_div' methods
+    # @example
+    #   div(:message, :id => 'message')
+    #   # will generate 'message' and 'message_div' methods
     #
-    # @param the name used for the generated methods
-    # @param identifier how we find a div.  The valid values are:
-    #   :class => Watir and Selenium
-    #   :id => Watir and Selenium
-    #   :index => Watir only
-    #   :name => Selenium only
-    #   :xpath => Watir and Selenium
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a div.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Selenium only
+    #   * :xpath => Watir and Selenium
     #
     def div(name, identifier) 
       define_method(name) do
         platform.div_text_for identifier
       end
@@ -214,20 +280,21 @@
 
     #
     # adds two methods - one to retrieve the text from a span
     # and another to return the span element
     #
-    # Example:  span(:alert, {:id => 'alert'})
-    # will generate a 'alert' and 'alert_div' methods
+    # @example
+    #   span(:alert, :id => 'alert')
+    #   # will generate 'alert' and 'alert_span' methods
     #
-    # @param the name used for the generated methods
-    # @param identifier how we find a span.  The valid values are:
-    #   :class => Watir and Selenium
-    #   :id => Watir and Selenium
-    #   :index => Watir only
-    #   :name => Selenium only
-    #   :xpath => Watir and Selenium
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a span.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Selenium only
+    #   * :xpath => Watir and Selenium
     #
     def span(name, identifier)
       define_method(name) do
         platform.span_text_for identifier
       end
@@ -237,20 +304,21 @@
     end
 
     #
     # adds a method to retrieve the table element
     #
-    # Example: table(:cart, :id => 'shopping_cart')
-    # will generate a 'cart_table' method.
+    # @example
+    #   table(:cart, :id => 'shopping_cart')
+    #   # will generate a 'cart_table' method
     #
-    # @param the name used for the generated methods
-    # @param identifier how we find a checkbox.  The valid values are:
-    #   :class => Watir and Selenium
-    #   :id => Watir and Selenium
-    #   :index => Watir only
-    #   :name => Selenium only
-    #   :xpath => Watir and Selenium
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a table.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Selenium only
+    #   * :xpath => Watir and Selenium
     #
     def table(name, identifier)
       define_method("#{name}_table") do
         platform.table_for identifier
       end
@@ -258,32 +326,135 @@
     
     #
     # adds two methods  one to retrieve the text from a table cell
     # and another to return the table cell element
     #
-    # Example: cell(:total, :id => 'total_cell')
-    # will generate a 'total' and 'total_cell' methods
+    # @example
+    #   cell(:total, :id => 'total_cell')
+    #   # will generate 'total' and 'total_cell' methods
     #
-    # @param the name used for the generated methods
-    # @param identifier how we find a checkbox.  The valid values are:
-    #   :class => Watir and Selenium
-    #   :id => Watir and Selenium
-    #   :index => Watir only
-    #   :name => Selenium only
-    #   :xpath => Watir and Selenium
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a cell.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Selenium only
+    #   * :xpath => Watir and Selenium
     #
     def cell(name, identifier)
       define_method("#{name}") do
         platform.cell_text_for identifier
       end
       define_method("#{name}_cell") do
         platform.cell_for identifier
       end
     end
     
+    #
+    # adds a method to retrieve the image element
+    #
+    # @example
+    #   image(:logo, :id => 'logo')
+    #   # will generate a 'logo_image' method
+    #
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find an image.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Watir and Selenium
+    #   * :xpath => Watir and Selenium
+    #
     def image(name, identifier)
       define_method("#{name}_image") do
         platform.image_for identifier
+      end
+    end
+    
+    #
+    # adds a method to retrieve the form element
+    #
+    # @example
+    #   form(:login, :id => 'login')
+    #   # will generate a 'login_form' method
+    #
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a form.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :xpath => Watir and Selenium
+    #
+    def form(name, identifier)
+      define_method("#{name}_form") do
+        platform.form_for identifier
+      end
+    end
+    
+    #
+    # adds two methods - one to retrieve the text from a list item
+    # and another to return the list item element
+    #
+    # @example
+    #   list_item(:item_one, :id => 'one')
+    #   # will generate 'item_one' and 'item_one_list_item' methods
+    #
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a list item.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Selenium only
+    #   * :xpath => Watir and Selenium
+    #
+    def list_item(name, identifier)
+      define_method(name) do
+        platform.list_item_text_for identifier
+      end
+      define_method("#{name}_list_item") do
+        platform.list_item_for identifier
+      end
+    end
+    
+    #
+    # adds a method to retrieve the unordered list element
+    #
+    # @example
+    #   unordered_list(:menu, :id => 'main_menu')
+    #   # will generate a 'menu_unordered_list' method
+    #
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find an unordered list.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Selenium only
+    #   * :xpath => Watir and Selenium
+    #
+    def unordered_list(name, identifier)
+      define_method("#{name}_unordered_list") do
+        platform.unordered_list_for identifier
+      end
+    end
+    
+    #
+    # adds a method to retrieve the ordered list element
+    #
+    # @example
+    #   ordered_list(:top_five, :id => 'top')
+    #   # will generate a 'top_five_ordered_list' method
+    #
+    # @param [String] the name used for the generated methods
+    # @param [Hash] identifier how we find an unordered list.  The valid keys are:
+    #   * :class => Watir and Selenium
+    #   * :id => Watir and Selenium
+    #   * :index => Watir only
+    #   * :name => Selenium only
+    #   * :xpath => Watir and Selenium
+    #
+    def ordered_list(name, identifier)
+      define_method("#{name}_ordered_list") do
+        platform.ordered_list_for identifier
       end
     end
   end
 end