page-object 0.0.3 → 0.0.4

data/lib/page-object/elements.rb

@@ -12,3 +12,9 @@ require 'page-object/elements/table_cell'
 require 'page-object/elements/table_row'
 require 'page-object/elements/span'
 require 'page-object/elements/image'
+require 'page-object/elements/hidden_field'
+require 'page-object/elements/form'
+require 'page-object/elements/text_area'
+require 'page-object/elements/list_item'
+require 'page-object/elements/unordered_list'
+require 'page-object/elements/ordered_list'

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

@@ -1,10 +1,12 @@
 
 module PageObject
   module Elements
-
     #
     # Contains functionality that is common across all elements.
     #
+    # @see PageObject::Platforms::WatirElement for the Watir version of all common methods
+    # @see PageObject::Platforms::SeleniumElement for the Selenium version of all common methods
+    #
     class Element
       attr_reader :element
       
@@ -13,10 +15,12 @@ module PageObject
         include_platform_for platform
       end
       
+      # @private
       def self.watir_identifier_for identifier
         identifier_for identifier, watir_finders, watir_mapping
       end
 
+      # @private
       def self.selenium_identifier_for identifier
         identifier = identifier_for identifier, selenium_finders, selenium_mapping
         return identifier.keys.first, identifier.values.first

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

@@ -0,0 +1,25 @@
+module PageObject
+  module Elements
+    class Form < Element
+      def initialize(element, platform)
+        @element = element
+        include_platform_for platform
+      end
+      
+      protected
+      
+      def include_platform_for platform
+        super
+        if platform[:platform] == :watir
+          require 'page-object/platforms/watir_form'
+          self.class.send :include, PageObject::Platforms::WatirForm
+        elsif platform[:platform] == :selenium
+          require 'page-object/platforms/selenium_form'
+          self.class.send :include, PageObject::Platforms::SeleniumForm
+        else
+          raise ArgumentError, "expect platform to be :watir or :selenium"          
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module PageObject
+  module Elements
+    class HiddenField < Element
+      
+      def click
+        raise "click is not available on hidden field element with Selenium or Watir"
+      end
+
+      protected
+      
+      def self.watir_finders
+        super + [:tag_name, :text]
+      end
+      
+      def self.watir_mapping
+        super.merge({:css => :tag_name})
+      end
+      
+      def self.selenium_finders
+        super + [:css]
+      end
+      
+      def self.selenium_mapping
+        super.merge({:tag_name => :css})
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,31 @@
+module PageObject
+  module Elements
+    class OrderedList < Element
+      
+      def initialize(element, platform)
+        @element = element
+        include_platform_for platform
+      end
+      
+      protected
+      
+      def self.watir_finders
+        [:class, :id, :index, :xpath]
+      end
+
+      def include_platform_for platform
+        super
+        if platform[:platform] == :watir
+          require 'page-object/platforms/watir_ordered_list'
+          self.class.send :include, PageObject::Platforms::WatirOrderedList
+        elsif platform[:platform] == :selenium
+          require 'page-object/platforms/selenium_ordered_list'
+          self.class.send :include, PageObject::Platforms::SeleniumOrderedList
+        else
+          raise ArgumentError, "expect platform to be :watir or :selenium"          
+        end
+      end
+  
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module PageObject
+  module Elements
+    class TextArea < Element
+
+      protected
+      
+      def self.watir_finders
+        super + [:tag_name]
+      end
+      
+      def self.watir_mapping
+        super.merge({:css => :tag_name})
+      end
+      
+      def self.selenium_finders
+        super + [:css]
+      end
+      
+      def self.selenium_mapping
+        super.merge({:tag_name => :css})
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module PageObject
       protected
       
       def self.watir_finders
-        super + [:tag_name, :text, :value]
+        super + [:tag_name]
       end
       
       def self.watir_mapping

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

@@ -0,0 +1,31 @@
+module PageObject
+  module Elements
+    class UnorderedList < Element
+      
+      def initialize(element, platform)
+        @element = element
+        include_platform_for platform
+      end
+      
+      protected
+      
+      def self.watir_finders
+        [:class, :id, :index, :xpath]
+      end
+
+      def include_platform_for platform
+        super
+        if platform[:platform] == :watir
+          require 'page-object/platforms/watir_unordered_list'
+          self.class.send :include, PageObject::Platforms::WatirUnorderedList
+        elsif platform[:platform] == :selenium
+          require 'page-object/platforms/selenium_unordered_list'
+          self.class.send :include, PageObject::Platforms::SeleniumUnorderedList
+        else
+          raise ArgumentError, "expect platform to be :watir or :selenium"          
+        end
+      end
+  
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module PageObject
       # #text does not reliabably return a value in Selenium
       #
       def text
-        raise "value not available on link element with Selenium"
+        raise "text is not available on button element in Selenium"
       end
     end
   end

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

@@ -1,6 +1,9 @@
 
 module PageObject
   module Platforms
+    #
+    # Selenium implementation of the common functionality found across all elements
+    #
     module SeleniumElement
       
       #

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

@@ -0,0 +1,14 @@
+module PageObject
+  module Platforms
+    module SeleniumForm
+      
+      #
+      # Submit the form.
+      #
+      def submit
+        @element.submit
+      end
+      
+    end
+  end
+end

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

@@ -6,7 +6,6 @@ module PageObject
       # Return the width of the image.
       #
       def width
-        dimension = @element.size
         dimension.width
       end
       
@@ -14,9 +13,14 @@ module PageObject
       # Return the height of the image
       #
       def height
-        dimension = @element.size
         dimension.height
       end
+      
+      private
+      
+      def dimension
+        @element.size
+      end
     end
   end
 end

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

@@ -0,0 +1,18 @@
+module PageObject
+  module Platforms
+    module SeleniumOrderedList
+      
+      #
+      # Return the PageObject::Elements::ListItem for the index provided.  Index
+      # is zero based.
+      #
+      # @return [PageObject::Elements::ListItem]
+      #
+      def [](idx)
+        element = @element.find_element(:xpath, ".//li[#{idx+1}]")
+        PageObject::Elements::ListItem.new(element, :platform => :selenium)
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module PageObject
+  module Platforms
+    module SeleniumUnorderedList
+      
+      #
+      # Return the PageObject::Elements::ListItem for the index provided.  Index
+      # is zero based.
+      #
+      # @return [PageObject::Elements::ListItem]
+      #
+      def [](idx)
+        element = @element.find_element(:xpath, ".//li[#{idx+1}]")
+        PageObject::Elements::ListItem.new(element, :platform => :selenium)
+      end
+      
+    end
+  end
+end

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

@@ -1,6 +1,9 @@
 
 module PageObject
   module Platforms
+    #
+    # Watir implementation of the common functionality found across all elements
+    #
     module WatirElement
       
       #

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

@@ -0,0 +1,14 @@
+module PageObject
+  module Platforms
+    module WatirForm
+      
+      #
+      # Submit the form.
+      #
+      def submit
+        @element.submit
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module PageObject
+  module Platforms
+    module WatirOrderedList
+      
+      #
+      # Return the PageObject::Elements::ListItem for the index provided.  Index
+      # is zero based.
+      #
+      # @return [PageObject::Elements::ListItem]
+      #
+      def [](idx)
+        element = @element.wd.find_element(:xpath, ".//li[#{idx+1}]")
+        PageObject::Elements::ListItem.new(element, :platform => :watir)
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module PageObject
+  module Platforms
+    module WatirUnorderedList
+      
+      #
+      # Return the PageObject::Elements::ListItem for the index provided.  Index
+      # is zero based.
+      #
+      # @return [PageObject::Elements::ListItem]
+      #
+      def [](idx)
+        element = @element.wd.find_element(:xpath, ".//li[#{idx+1}]")
+        PageObject::Elements::ListItem.new(element, :platform => :watir)
+      end
+      
+    end
+  end
+end

data/lib/page-object/selenium_page_object.rb

@@ -1,6 +1,11 @@
 require 'page-object/elements'
 
 module PageObject
+  #
+  # Selenium implementation of the page object platform driver.  You should not use the
+  # class directly.  Instead you should include the PageObject module in your page object
+  # and use the methods dynamically added from the PageObject::Accessors module.
+  #
   class SeleniumPageObject
     def initialize(browser)
       @browser = browser
@@ -66,6 +71,53 @@ module PageObject
       PageObject::Elements::TextField.new(element, :platform => :selenium)
     end
     
+    #
+    # platform method to get the value stored in a hidden field
+    # See PageObject::Accessors#hidden_field
+    #
+    def hidden_field_value_for(identifier)
+      how, what = Elements::HiddenField.selenium_identifier_for identifier
+      @browser.find_element(how, what).attribute('value')
+    end
+    
+    #
+    # platform method to retrieve a hidden field element
+    # See PageObject::Accessors#hidden_field
+    #
+    def hidden_field_for(identifier)
+      how, what = Elements::HiddenField.selenium_identifier_for identifier
+      element = @browser.find_element(how, what)
+      Elements::HiddenField.new(element, :platform => :selenium)
+    end    
+
+    #
+    # platform method to set text in a textarea
+    # See PageObject::Accessors#text_area
+    #
+    def text_area_value_set(identifier, value)
+      how, what = Elements::TextArea.selenium_identifier_for identifier
+      @browser.find_element(how, what).send_keys(value)
+    end
+    
+    #
+    # platform method to get the text from a textarea
+    # See PageObject::Accessors#text_area
+    #
+    def text_area_value_for(identifier)
+      how, what = Elements::TextArea.selenium_identifier_for identifier
+      @browser.find_element(how, what).attribute('value')
+    end
+    
+    #
+    # platform method to get the text area element
+    # See PageObject::Accessors#text_area
+    #
+    def text_area_for(identifier)
+      how, what = Elements::TextArea.selenium_identifier_for identifier
+      element = @browser.find_element(how, what)
+      Elements::TextArea.new(element, :platform => :selenium)
+    end
+    
     #
     # platform method to get the currently selected value from a select list
     # See PageObject::Accessors#select_list
@@ -282,5 +334,54 @@ module PageObject
       element = @browser.find_element(how, what)
       PageObject::Elements::Image.new(element, :platform => :selenium)
     end
+    
+    #
+    # platform method to retrieve a form element
+    # See PageObject::Accessors#form
+    #
+    def form_for(identifier)
+      how, what = Elements::Form.selenium_identifier_for identifier
+      element = @browser.find_element(how, what)
+      PageObject::Elements::Form.new(element, :platform => :selenium)
+    end
+
+    #
+    # platform method to retrieve the text from a list item
+    # See PageObject::Accessors#list_item
+    #
+    def list_item_text_for(identifier)
+      how, what = Elements::ListItem.selenium_identifier_for identifier
+      @browser.find_element(how, what).text
+    end
+    
+    #
+    # platform method to retrieve a list item element
+    # See PageObject::Accessors#list_item
+    #
+    def list_item_for(identifier)
+      how, what = Elements::ListItem.selenium_identifier_for identifier
+      element = @browser.find_element(how, what)
+      PageObject::Elements::ListItem.new(element, :platform => :selenium)
+    end
+    
+    #
+    # platform method to retrieve an unordered list element
+    # See PageObject::Accessors#unordered_list
+    #
+    def unordered_list_for(identifier)
+      how, what = Elements::UnorderedList.selenium_identifier_for identifier
+      element = @browser.find_element(how, what)
+      PageObject::Elements::UnorderedList.new(element, :platform => :selenium)
+    end
+    
+    #
+    # platform method to retrieve an ordered list element
+    # See PageObject::Accessors#ordered_list
+    #
+    def ordered_list_for(identifier)
+      how, what = Elements::OrderedList.selenium_identifier_for identifier
+      element = @browser.find_element(how, what)
+      PageObject::Elements::OrderedList.new(element, :platform => :selenium)
+    end
   end
 end