page-object 0.0.5 → 0.1

data/lib/page-object/elements.rb

@@ -18,3 +18,4 @@ require 'page-object/elements/text_area'
 require 'page-object/elements/list_item'
 require 'page-object/elements/unordered_list'
 require 'page-object/elements/ordered_list'
+require 'page-object/elements/option'

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

@@ -17,16 +17,86 @@ module PageObject
       
       # @private
       def self.watir_identifier_for identifier
-        identifier_for identifier, watir_finders, watir_mapping
+        if should_build_watir_xpath(identifier)
+          how = :xpath
+          what = build_xpath_for(identifier)
+          return how => what
+        end
+        all_identities = {}
+        identifier.each do |key, value|
+          each = {key => value}
+          ident = identifier_for each, watir_finders, watir_mapping
+          all_identities[ident.keys.first] = ident.values.first
+        end
+        all_identities
+      end
+      
+      def self.should_build_watir_xpath identifier
+        ['table', 'span', 'div', 'td', 'li', 'ul', 'ol'].include? identifier[:tag_name] and identifier[:name]
       end
 
       # @private
       def self.selenium_identifier_for identifier
-        identifier = identifier_for identifier, selenium_finders, selenium_mapping
-        return identifier.keys.first, identifier.values.first
+        if identifier.length == 1
+          identifier = identifier_for identifier, selenium_finders, selenium_mapping
+          return identifier.keys.first, identifier.values.first
+        elsif identifier.length > 1
+          how = :xpath
+          what = build_xpath_for identifier
+          return how, what
+        end
       end
-      
+
       protected
+      
+      def self.build_xpath_for identifier
+        tag_locator = identifier.delete(:tag_name)
+        idx = identifier.delete(:index)
+        identifier.delete(:tag_name)
+        xpath = ".//#{tag_locator}"
+        xpath << "[#{attribute_expression(identifier)}]" unless identifier.empty?
+        xpath << "[#{idx+1}]" if idx
+        xpath
+      end
+      
+      def self.attribute_expression(identifier)
+        identifier.map do |key, value|
+          if value.kind_of?(Array)
+            "(" + value.map { |v| equal_pair(key, v) }.join(" or ") + ")"
+          else
+            equal_pair(key, value)
+          end
+        end.join(" and ")
+      end
+      
+      def self.equal_pair(key, value)
+        if key == :label
+          "@id=//label[normalize-space()=#{xpath_string(value)}]/@for"
+        else
+          "#{lhs_for(key)}=#{xpath_string(value)}"
+        end
+      end
+      
+      def self.lhs_for(key)
+        case key
+        when :text, 'text'
+          'normalize-space()'
+        when :href
+          'normalize-space(@href)'
+        else
+          "@#{key.to_s.gsub("_", "-")}"
+        end
+      end
+
+      def self.xpath_string(value)
+        if value.include? "'"
+          parts = value.split("'", -1).map { |part| "'#{part}'" }
+          string = parts.join(%{,"'",})
+          "concat(#{string})"
+        else
+          "'#{value}'"
+        end
+      end
 
       def self.identifier_for identifier, find_by, find_by_mapping
         how, what = identifier.keys.first, identifier.values.first
@@ -44,7 +114,7 @@ module PageObject
       end
       
       def self.selenium_finders
-        [:class, :id, :name, :xpath]
+        [:class, :id, :name, :xpath, :index]
       end
       
       def self.selenium_mapping 
@@ -64,4 +134,4 @@ module PageObject
       end
     end
   end
-end
+end

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

@@ -0,0 +1,7 @@
+module PageObject
+  module Elements
+    class Option < Element
+  
+    end
+  end
+end

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

@@ -2,11 +2,34 @@ module PageObject
   module Elements
     class SelectList < Element
 
+      def initialize(element, platform)
+        @element = element
+        include_platform_for platform
+      end
+
       protected
+
+      def child_xpath
+        ".//child::option"
+      end
       
       def self.watir_finders
         super + [:text, :value]
       end
+
+      def include_platform_for platform
+        super
+        if platform[:platform] == :watir
+          require 'page-object/platforms/watir_select_list'
+          self.class.send :include, PageObject::Platforms::WatirSelectList
+        elsif platform[:platform] == :selenium
+          require 'page-object/platforms/selenium_select_list'
+          self.class.send :include, PageObject::Platforms::SeleniumSelectList
+        else
+          raise ArgumentError, "expect platform to be :watir or :selenium"          
+        end
+      end
+
     end
   end
-end
+end

data/lib/page-object/page_factory.rb

@@ -35,9 +35,9 @@ module PageObject
     #
     # Create a page object.
     #
-    # @param [PageObject] a class that has included the PageObject module
-    # @param [Bool] should the page be visited?  default is false.
-    # @param an optional block to be called
+    # @param [PageObject]  a class that has included the PageObject module
+    # @param [Boolean]  a boolean indicating if the page should be visited?  default is false.
+    # @param [block]  an optional block to be called
     # @return [PageObject] the newly created page object
     #
     def on_page(page_class, visit=false, &block)

data/lib/page-object/platforms/selenium_select_list.rb

@@ -0,0 +1,29 @@
+module PageObject
+  module Platforms
+    module SeleniumSelectList
+      
+      #
+      # Return the PageObject::Elements::Option for the index provided.  Index
+      # is zero based.
+      #
+      # @return [PageObject::Elements::Option]
+      #
+      def [](idx)
+        options[idx]
+      end
+      
+      #
+      # Return an array of Options contained in the select lit.
+      #
+      # @return [array of PageObject::Elements::Option]
+      def options
+        options = @element.find_elements(:xpath, child_xpath)
+        elements = []
+        options.each do |opt|
+          elements << PageObject::Elements::Option.new(opt, :platform => :selenium)
+        end
+        elements
+      end
+    end
+  end
+end

data/lib/page-object/platforms/watir_select_list.rb

@@ -0,0 +1,30 @@
+module PageObject
+  module Platforms
+    module WatirSelectList
+      
+      #
+      # Return the PageObject::Elements::Option for the index provided.  Index
+      # is zero based.
+      #
+      # @return [PageObject::Elements::Option]
+      #
+      def [](idx)
+        PageObject::Elements::Option.new(options[idx], :platform => :watir)
+      end
+
+      #
+      # Return an array of Options contained in the select lit.
+      #
+      # @return [array of PageObject::Elements::Option]
+      #
+      def options
+        elements = []
+        options = @element.wd.find_elements(:xpath, child_xpath)
+        options.each do |opt|
+          elements << PageObject::Elements::Option.new(opt, :platform => :watir)
+        end
+        elements
+      end
+    end
+  end
+end

data/lib/page-object/selenium_page_object.rb

@@ -48,6 +48,7 @@ module PageObject
     # See PageObject::Accessors#text_field
     #
     def text_field_value_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'text'
       how, what = Elements::TextField.selenium_identifier_for identifier
       @browser.find_element(how, what).attribute('value')
     end
@@ -57,6 +58,7 @@ module PageObject
     # See PageObject::Accessors#text_field
     #
     def text_field_value_set(identifier, value)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'text'
       how, what = Elements::TextField.selenium_identifier_for identifier
       @browser.find_element(how, what).send_keys(value)
     end
@@ -66,6 +68,7 @@ module PageObject
     # See PageObject::Accessors#text_field
     #
     def text_field_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'text'
       how, what = Elements::TextField.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::TextField.new(element, :platform => :selenium)
@@ -76,6 +79,7 @@ module PageObject
     # See PageObject::Accessors#hidden_field
     #
     def hidden_field_value_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'hidden'
       how, what = Elements::HiddenField.selenium_identifier_for identifier
       @browser.find_element(how, what).attribute('value')
     end
@@ -85,6 +89,7 @@ module PageObject
     # See PageObject::Accessors#hidden_field
     #
     def hidden_field_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'hidden'
       how, what = Elements::HiddenField.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       Elements::HiddenField.new(element, :platform => :selenium)
@@ -95,6 +100,7 @@ module PageObject
     # See PageObject::Accessors#text_area
     #
     def text_area_value_set(identifier, value)
+      identifier = add_tagname_if_needed identifier, 'textarea'
       how, what = Elements::TextArea.selenium_identifier_for identifier
       @browser.find_element(how, what).send_keys(value)
     end
@@ -104,6 +110,7 @@ module PageObject
     # See PageObject::Accessors#text_area
     #
     def text_area_value_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'textarea'
       how, what = Elements::TextArea.selenium_identifier_for identifier
       @browser.find_element(how, what).attribute('value')
     end
@@ -113,6 +120,7 @@ module PageObject
     # See PageObject::Accessors#text_area
     #
     def text_area_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'textarea'
       how, what = Elements::TextArea.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       Elements::TextArea.new(element, :platform => :selenium)
@@ -123,6 +131,7 @@ module PageObject
     # See PageObject::Accessors#select_list
     #
     def select_list_value_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'select'
       how, what = Elements::SelectList.selenium_identifier_for identifier
       @browser.find_element(how, what).attribute('value')
     end
@@ -132,6 +141,7 @@ module PageObject
     # See PageObject::Accessors#select_list
     #
     def select_list_value_set(identifier, value)
+      identifier = add_tagname_if_needed identifier, 'select'
       how, what = Elements::SelectList.selenium_identifier_for identifier
       @browser.find_element(how, what).send_keys(value)
     end
@@ -141,6 +151,7 @@ module PageObject
     # See PageObject::Accessors#select_list
     #
     def select_list_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'select'
       how, what = Elements::SelectList.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       Elements::SelectList.new(element, :platform => :selenium)
@@ -151,6 +162,7 @@ module PageObject
     # See PageObject::Accessors#link
     #
     def click_link_for(identifier)
+      identifier = add_tagname_if_needed identifier, "a"
       how, what = Elements::Link.selenium_identifier_for identifier
       @browser.find_element(how, what).click
     end
@@ -160,6 +172,7 @@ module PageObject
     # see PageObject::Accessors#link
     #
     def link_for(identifier)
+      identifier = add_tagname_if_needed identifier, "a"
       how, what = Elements::Link.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       Elements::Link.new(element, :platform => :selenium)
@@ -170,8 +183,9 @@ module PageObject
     # See PageObject::Accessors#checkbox
     #
     def check_checkbox(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'checkbox'
       how, what = Elements::CheckBox.selenium_identifier_for identifier
-      @browser.find_element(how, what).toggle unless checkbox_checked?(identifier)
+      @browser.find_element(how, what).click unless @browser.find_element(how, what).selected?
     end
 
     #
@@ -179,8 +193,9 @@ module PageObject
     # See PageObject::Accessors#checkbox
     #
     def uncheck_checkbox(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'checkbox'
       how, what = Elements::CheckBox.selenium_identifier_for identifier
-      @browser.find_element(how, what).toggle if checkbox_checked?(identifier)
+      @browser.find_element(how, what).click if @browser.find_element(how, what).selected?
     end
 
     #
@@ -188,6 +203,7 @@ module PageObject
     # See PageObject::Accessors#checkbox
     #
     def checkbox_checked?(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'checkbox'
       how, what = Elements::CheckBox.selenium_identifier_for identifier
       @browser.find_element(how, what).selected?
     end
@@ -197,6 +213,7 @@ module PageObject
     # See PageObject::Accessors#checkbox
     #
     def checkbox_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'checkbox'
       how, what = Elements::CheckBox.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       Elements::CheckBox.new(element, :platform => :selenium)
@@ -207,6 +224,7 @@ module PageObject
     # See PageObject::Accessors#radio_button
     #
     def select_radio(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'radio'
       how, what = Elements::RadioButton.selenium_identifier_for identifier
       @browser.find_element(how, what).click unless @browser.find_element(how, what).selected?
     end
@@ -216,6 +234,7 @@ module PageObject
     # See PageObject::Accessors#radio_button
     #
     def clear_radio(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'radio'
       how, what = Elements::RadioButton.selenium_identifier_for identifier
       @browser.find_element(how, what).click if @browser.find_element(how, what).selected?
     end
@@ -225,6 +244,7 @@ module PageObject
     # See PageObject::Accessors#radio_button
     #
     def radio_selected?(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'radio'
       how, what = Elements::RadioButton.selenium_identifier_for identifier
       @browser.find_element(how, what).selected?
     end
@@ -234,6 +254,7 @@ module PageObject
     # See PageObject::Accessors#radio_button
     #
     def radio_button_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'radio'
       how, what = Elements::RadioButton.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::RadioButton.new(element, :platform => :selenium)
@@ -244,6 +265,7 @@ module PageObject
     # See PageObject::Accessors#div
     #    
     def div_text_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'div'
       how, what = Elements::Div.selenium_identifier_for identifier
       @browser.find_element(how, what).text
     end
@@ -253,6 +275,7 @@ module PageObject
     # See PageObject::Accessors#div
     #
     def div_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'div'
       how, what = Elements::Div.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::Div.new(element, :platform => :selenium)
@@ -263,6 +286,7 @@ module PageObject
     # See PageObject::Accessors#span
     #
     def span_text_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'span'
       how, what = Elements::Span.selenium_identifier_for identifier
       @browser.find_element(how, what).text
     end
@@ -272,6 +296,7 @@ module PageObject
     # See PageObject::Accessors#span
     #
     def span_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'span'
       how, what = Elements::Span.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::Span.new(element, :platform => :selenium)
@@ -282,6 +307,7 @@ module PageObject
     # See PageObject::Accessors#button
     #
     def click_button_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'submit'
       how, what = Elements::Button.selenium_identifier_for identifier
       @browser.find_element(how, what).click
     end
@@ -291,6 +317,7 @@ module PageObject
     # See PageObject::Accessors#button
     #
     def button_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'input', :type => 'submit'
       how, what = Elements::Button.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::Button.new(element, :platform => :selenium)
@@ -301,6 +328,7 @@ module PageObject
     # See PageObject::Accessors#table
     #
     def table_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'table'
       how, what = Elements::Table.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::Table.new(element, :platform => :selenium)
@@ -311,6 +339,7 @@ module PageObject
     # See PageObject::Accessors#cell
     #
     def cell_text_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'td'
       how, what = Elements::TableCell.selenium_identifier_for identifier
       @browser.find_element(how, what).text
     end
@@ -320,6 +349,7 @@ module PageObject
     # See PageObject::Accessors#cell
     #
     def cell_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'td'
       how, what = Elements::TableCell.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::TableCell.new(element, :platform => :selenium)
@@ -330,6 +360,7 @@ module PageObject
     # See PageObject::Accessors#image
     #
     def image_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'img'
       how, what = Elements::Image.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::Image.new(element, :platform => :selenium)
@@ -340,6 +371,7 @@ module PageObject
     # See PageObject::Accessors#form
     #
     def form_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'form'
       how, what = Elements::Form.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::Form.new(element, :platform => :selenium)
@@ -350,6 +382,7 @@ module PageObject
     # See PageObject::Accessors#list_item
     #
     def list_item_text_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'li'
       how, what = Elements::ListItem.selenium_identifier_for identifier
       @browser.find_element(how, what).text
     end
@@ -359,7 +392,8 @@ module PageObject
     # See PageObject::Accessors#list_item
     #
     def list_item_for(identifier)
-      how, what = Elements::ListItem.selenium_identifier_for identifier
+      identifier = add_tagname_if_needed identifier, 'li'
+       how, what = Elements::ListItem.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::ListItem.new(element, :platform => :selenium)
     end
@@ -369,6 +403,7 @@ module PageObject
     # See PageObject::Accessors#unordered_list
     #
     def unordered_list_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'ul'
       how, what = Elements::UnorderedList.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::UnorderedList.new(element, :platform => :selenium)
@@ -379,9 +414,24 @@ module PageObject
     # See PageObject::Accessors#ordered_list
     #
     def ordered_list_for(identifier)
+      identifier = add_tagname_if_needed identifier, 'ol'
       how, what = Elements::OrderedList.selenium_identifier_for identifier
       element = @browser.find_element(how, what)
       PageObject::Elements::OrderedList.new(element, :platform => :selenium)
     end
+
+    private
+    
+    def add_tagname_if_needed identifier, tag, additional=nil
+      return identifier if identifier.length < 2 and identifier[:index].nil?
+      identifier[:tag_name] = tag
+      if additional
+        additional.each do |key, value|
+          identifier[key] = value
+        end
+      end
+      identifier
+    end
+        
   end
 end