page-object 0.7.6 → 0.8

data/features/step_definitions/ordered_list_steps.rb

@@ -17,3 +17,7 @@ end
 Then /^I should see that the ordered list exists$/ do
   @page.ol_id?.should == true
 end
+
+Then /^the text for the ordered list should contain "(.*)"$/ do |text|
+  @page.send("ol_id").should include text
+end

data/features/step_definitions/table_steps.rb

@@ -55,3 +55,7 @@ end
 Then /^the data for row "([^\"]*)" and column "([^\"]*)" should be nil$/ do |row, column|
   @element[row][column].should be_nil
 end
+
+Then /^I should see the text includes "([^"]*)" when I retrieve it by "([^"]*)"$/ do |text, how|
+  @page.send("table_#{how}").should include text
+end

data/features/step_definitions/unordered_list_steps.rb

@@ -16,4 +16,8 @@ end
 
 Then /^I should see that the unordered list exists$/ do
   @page.ul_id?.should == true
-end
+end
+
+Then /^the text for the unordered list should contain "(.*)"$/ do |text|
+  @page.send("ul_id").should include text
+end

data/features/table.feature

@@ -111,3 +111,7 @@ Feature: Table
   @watir_only
   Scenario: Finding an existing table
     Then I should see that the table exists
+    
+  Scenario: Getting the text from a table
+    Then I should see the text includes "Data1" when I retrieve it by "id"
+    And I should see the text includes "Data2" when I retrieve it by "id"

data/features/unordered_list.feature

@@ -49,3 +49,8 @@ Feature: Unordered list
     Then I should see that the unordered list exists
     When I get the first item from the list
     Then the list items text should be "Item One"
+
+  Scenario: Getting the text from an unordered list
+    Then the text for the unordered list should contain "Item One"
+    And the text for the unordered list should contain "Item Two"
+    And the text for the unordered list should contain "Item Three"

data/lib/page-object.rb

@@ -7,6 +7,7 @@ require 'page-object/page_factory'
 require 'page-object/page_populator'
 require 'page-object/javascript_framework_facade'
 require 'page-object/indexed_properties'
+require 'page-object/widgets'
 
 require 'selenium/webdriver/common/error'
 #
@@ -41,7 +42,7 @@ module PageObject
   include LoadsPlatform
   include ElementLocators
   include PagePopulator
-  
+
   # @return [Watir::Browser or Selenium::WebDriver::Driver] the platform browser passed to the constructor
   attr_reader :browser
   # @return [PageObject::WatirPageObject or PageObject::SeleniumPageObject] the platform page object
@@ -251,7 +252,7 @@ module PageObject
   def execute_script(script)
     platform.execute_script(script)
   end
-  
+
   #
   # Identify an element as existing within a frame or iframe.  A frame parameter
   # is passed to the block and must be passed to the other calls to PageObject.
@@ -287,7 +288,7 @@ module PageObject
   #
   def modal_dialog(&block)
     script =
-    %Q{
+        %Q{
       window.showModalDialog = function(sURL, vArguments, sFeatures) {
         window.dialogArguments = vArguments;
         modalWin = window.open(sURL, 'modal', sFeatures);
@@ -297,7 +298,7 @@ module PageObject
     browser.execute_script script
     yield if block_given?
   end
-  
+
   #
   # Attach to a running window.  You can locate the window using either
   # the window's title or url.  If it failes to connect to a window it will
@@ -326,35 +327,35 @@ module PageObject
   def element_with_focus
     platform.element_with_focus
   end
-  
+
   #
   # Refresh to current page
   #
   def refresh
     platform.refresh
   end
-  
+
   #
   # Go back to the previous page
   #
   def back
     platform.back
   end
-  
+
   #
   # Go forward to the next page
   #
   def forward
     platform.forward
   end
-  
+
   #
   # Clear the cookies from the browser
   #
   def clear_cookies
     platform.clear_cookies
   end
-  
+
   #
   # Save the current screenshot to the provided url.  File
   # is saved as a png file.
@@ -363,13 +364,17 @@ module PageObject
     platform.save_screenshot file_name
   end
 
+  def self.register_widget(widget_tag, widget_class, base_element_tag)
+    Widgets.register_widget(widget_tag, widget_class, base_element_tag)
+  end
+
   private
 
   def include_platform_driver(browser)
     @platform = load_platform(browser, PageObject::Platforms.get)
   end
-  
+
   def call_block(&block)
-    block.arity == 1 ? block.call(self) : self.instance_eval(&block)      
+    block.arity == 1 ? block.call(self) : self.instance_eval(&block)
   end
 end

data/lib/page-object/accessors.rb

@@ -528,13 +528,14 @@ module PageObject
     end
 
     #
-    # adds two methods - one to retrieve the table element, and another to
+    # adds three methods - one to return the text for the table, one
+    # to  retrieve the table element, and another to
     # check the table's existence.  The existence method does not work
     # on Selenium so it should not be called.
     #
     # @example
     #   table(:cart, :id => 'shopping_cart')
-    #   # will generate a 'cart_element' and 'cart?' method
+    #   # will generate a 'cart', 'cart_element' and 'cart?' method
     #
     # @param [Symbol] the name used for the generated methods
     # @param [Hash] identifier how we find a table.  You can use a multiple paramaters
@@ -548,6 +549,10 @@ module PageObject
     # @param optional block to be invoked when element method is called
     #
     def table(name, identifier={:index => 0}, &block)
+      define_method(name) do
+        return platform.table_text_for identifier.clone unless block_given?
+        self.send("#{name}_element").text
+      end
       define_method("#{name}_element") do
         return call_block(&block) if block_given?
         platform.table_for(identifier.clone)
@@ -701,12 +706,13 @@ module PageObject
     alias_method :li, :list_item
 
     #
-    # adds two methods - one to retrieve the unordered list element, and another to
+    # adds three methods - one to return the text within the unorderd
+    # list, one to retrieve the unordered list element, and another to
     # check it's existence.
     #
     # @example
     #   unordered_list(:menu, :id => 'main_menu')
-    #   # will generate 'menu_element' and 'menu?' methods
+    #   # will generate 'menu', 'menu_element' and 'menu?' methods
     #
     # @param [Symbol] the name used for the generated methods
     # @param [Hash] identifier how we find an unordered list.  You can use a multiple paramaters
@@ -720,6 +726,10 @@ module PageObject
     # @param optional block to be invoked when element method is called
     #
     def unordered_list(name, identifier={:index => 0}, &block)
+      define_method(name) do
+        return platform.unordered_list_text_for identifier.clone unless block_given?
+        self.send("#{name}_element").text
+      end
       define_method("#{name}_element") do
         return call_block(&block) if block_given?
         platform.unordered_list_for(identifier.clone)
@@ -733,12 +743,13 @@ module PageObject
     alias_method :ul, :unordered_list
 
     #
-    # adds two methods - one to retrieve the ordered list element, and another to
+    # adds three methods - one to return the text withing the ordered
+    # list, one to retrieve the ordered list element, and another to
     # test it's existence.
     #
     # @example
     #   ordered_list(:top_five, :id => 'top')
-    #   # will generate 'top_five_element' and 'top_five?' methods
+    #   # will generate 'top_five', 'top_five_element' and 'top_five?' methods
     #
     # @param [Symbol] the name used for the generated methods
     # @param [Hash] identifier how we find an ordered list.  You can use a multiple paramaters
@@ -752,6 +763,10 @@ module PageObject
     # @param optional block to be invoked when element method is called
     #
     def ordered_list(name, identifier={:index => 0}, &block)
+      define_method(name) do
+        return platform.ordered_list_text_for identifier.clone unless block_given?
+        self.send("#{name}_element").text
+      end
       define_method("#{name}_element") do
         return call_block(&block) if block_given?
         platform.ordered_list_for(identifier.clone)
@@ -1981,5 +1996,55 @@ module PageObject
         IndexedProperties::TableOfElements.new(@browser, identifier_list)
       end
     end
+
+    #
+    # methods to fetch multiple elements of the same type
+    #
+    # adds a method to the page object to retrun all of the matching elements
+    #
+    # @example
+    #   text_fields(:first_name, :id => "first_name")
+    #   # will generate 'first_name_elements'
+    #
+    # @param  [String] the name used for the generated methods
+    # @param [Hash] identifier how we find a text field.  You can use a multiple paramaters
+    #   by combining of any of the following except xpath.  The valid
+    #   keys are the same ones supported by the standard methods.
+    # @param optional block to be invoked when element method is called
+    #
+    [:text_fields,
+     :hidden_fields,
+     :text_areas,
+     :select_lists,
+     :links,
+     :checkboxes,
+     :radio_buttons,
+     :buttons,
+     :divs,
+     :spans,
+     :tables,
+     :cells,
+     :images,
+     :forms,
+     :list_items,
+     :unordered_lists,
+     :ordered_lists,
+     :h1s,
+     :h2s,
+     :h3s,
+     :h4s,
+     :h5s,
+     :h6s,
+     :paragraphs,
+     :labels,
+     :file_fields].each do |method_name|
+      define_method(method_name) do |name, identifier, &block|
+        define_method("#{name}_elements") do
+          return call_block(&block) if block_given?
+          platform.send "#{method_name.to_s}_for", identifier.clone
+        end
+      end
+    end
+    
   end
 end

data/lib/page-object/platforms/selenium_webdriver/element.rb

@@ -44,6 +44,16 @@ module PageObject
           element.text
         end
 
+        #
+        # Get the html for the element
+        #
+        # @return [String]
+        #
+        def html
+          script = "return (%s).apply(null, arguments)" % ATOMS.fetch(:getOuterHtml)
+          bridge.executeScript(script, element).strip
+        end
+
         #
         # Get the value of this element
         #

data/lib/page-object/platforms/selenium_webdriver/page_object.rb

@@ -525,6 +525,16 @@ module PageObject
           find_selenium_elements(identifier, Elements::Button, 'input', :type => 'submit')
         end
         
+        #
+        # platform method to return the text for a table
+        # See PageObject::Accessors#table
+        #
+        def table_text_for(identifier)
+          process_selenium_call(identifier, Elements::Table, 'table') do |how, what|
+            @browser.find_element(how, what).text
+          end
+        end
+
         #
         # platform method to retrieve a table element
         # See PageObject::Accessors#table
@@ -620,6 +630,16 @@ module PageObject
           find_selenium_elements(identifier, Elements::ListItem, 'li')
         end
 
+        #
+        # platform method to retrieve the text from an unordered list
+        # See PageObject::Accessors#unordered_list
+        #
+        def unordered_list_text_for(identifier)
+          process_selenium_call(identifier, Elements::UnorderedList, 'ul') do |how, what|
+            @browser.find_element(how, what).text
+          end
+        end
+
         #
         # platform method to retrieve an unordered list element
         # See PageObject::Accessors#unordered_list
@@ -635,6 +655,16 @@ module PageObject
           find_selenium_elements(identifier, Elements::UnorderedList, 'ul')
         end
 
+        #
+        # platform method to retrieve the text from an ordered list
+        # See PageObject::Accessors#ordered_list
+        #
+        def ordered_list_text_for(identifier)
+          process_selenium_call(identifier, Elements::OrderedList, 'ol') do |how, what|
+            @browser.find_element(how, what).text
+          end
+        end
+
         #
         # platform method to retrieve an ordered list element
         # See PageObject::Accessors#ordered_list

data/lib/page-object/platforms/watir_webdriver/element.rb

@@ -36,6 +36,15 @@ module PageObject
           element.text
         end
 
+        #
+        # Get the html for the element
+        #
+        # @return [String]
+        #
+        def html
+          element.html
+        end
+
         #
         # Get the value of this element
         #

data/lib/page-object/platforms/watir_webdriver/page_object.rb

@@ -481,6 +481,14 @@ module PageObject
           find_watir_elements(call, Elements::Button, identifier)
         end
 
+        #
+        # platform method to return the text for a table
+        # See PageObject::Accessors#table
+        #
+        def table_text_for(identifier)
+          process_watir_call("table(identifier).text", Elements::Table, identifier, nil, 'table')
+        end
+
         #
         # platform method to retrieve a table element
         # See PageObject::Accessors#table
@@ -573,6 +581,14 @@ module PageObject
           find_watir_elements("lis(identifier)", Elements::ListItem, identifier, 'li')
         end
 
+        #
+        # platform method to retrieve the text from an unordered list
+        # See PageObject::Accessors#unordered_list
+        #
+        def unordered_list_text_for(identifier)
+          process_watir_call("ul(identifier).text", Elements::UnorderedList, identifier, nil, 'ul')
+        end
+
         #
         # platform method to retrieve an unordered list element
         # See PageObject::Accessors#unordered_list
@@ -588,6 +604,14 @@ module PageObject
           find_watir_elements("uls(identifier)", Elements::UnorderedList, identifier, 'ul')
         end
 
+       #
+        # platform method to retrieve the text from an ordered list
+        # See PageObject::Accessors#ordered_list
+        #
+        def ordered_list_text_for(identifier)
+          process_watir_call("ol(identifier).text", Elements::OrderedList, identifier, nil, 'ol')
+        end
+
         #
         # platform method to retrieve an ordered list element
         # See PageObject::Accessors#ordered_list

data/lib/page-object/version.rb

@@ -1,4 +1,4 @@
 module PageObject
   # @private
-  VERSION = "0.7.6"
+  VERSION = "0.8"
 end

data/lib/page-object/widgets.rb

@@ -0,0 +1,120 @@
+require 'page-object/elements'
+require 'page-object/platforms/selenium_webdriver/page_object'
+require 'page-object/platforms/watir_webdriver/page_object'
+
+module PageObject
+  module Widgets
+
+    #
+    # Module that allows for the registration of widget classes which extend the functionality of PageObject
+    # Allows any classes which extend PageObject::Element to be used as PageObject elements.
+    # This allows such widgets to be created using the defined tags.
+    #
+    # @param [Symbol] defines the symbol which will be used as an accessor name.
+    # @param [Class] the widget class extending PageObject::Elements::Element
+    # @param [Symbol] the symbol of the html element used when searching for this widget.
+    #
+    #
+    def self.register_widget(widget_tag, widget_class, base_element_tag)
+      if widget_class.ancestors.include? Elements::Element
+        define_accessors(Accessors, widget_tag)
+        define_nested_elements(Elements::Element, widget_tag)
+        define_locators(PageObject, widget_tag)
+        define_selenium_accessors(Platforms::SeleniumWebDriver::PageObject, widget_tag, widget_class, base_element_tag)
+        define_watir_accessors(Platforms::WatirWebDriver::PageObject, widget_tag, widget_class, base_element_tag)
+      end
+    end
+
+    @private
+
+    def self.define_accessors(base, widget_tag)
+      accessors_module = Module.new do
+        class_eval "def #{widget_tag}(name, identifier={}, &block)
+          identifier={:index=>0} if identifier.empty?
+          define_method(\"\#{name}_element\") do
+            return call_block(&block) if block_given?
+            platform.#{widget_tag}_for(identifier.clone)
+          end
+          define_method(\"\#{name}?\") do
+            return call_block(&block).exists? if block_given?
+            platform.#{widget_tag}_for(identifier.clone).exists?
+          end
+        end"
+      end
+
+      base.send(:include, accessors_module)
+    end
+
+    def self.define_watir_accessors(base, widget_tag, widget_class, base_element_tag)
+      define_singular_watir_accessor(base, base_element_tag, widget_class, widget_tag)
+      define_multiple_watir_accessor(base, base_element_tag, widget_class, widget_tag)
+    end
+
+    def self.define_multiple_watir_accessor(base, base_element_tag, widget_class, widget_tag)
+      base.send(:define_method, "#{widget_tag}s_for") do |identifier|
+        find_watir_elements("#{base_element_tag}(identifier)", widget_class, identifier, base_element_tag)
+      end
+    end
+
+    def self.define_singular_watir_accessor(base, base_element_tag, widget_class, widget_tag)
+      base.send(:define_method, "#{widget_tag}_for") do |identifier|
+        find_watir_element("#{base_element_tag}(identifier)", widget_class, identifier, base_element_tag)
+      end
+    end
+
+    def self.define_selenium_accessors(base, widget_tag, widget_class, base_element_tag)
+      define_singular_selenium_accessor(base, base_element_tag, widget_class, widget_tag)
+      define_multiple_selenium_accessor(base, base_element_tag, widget_class, widget_tag)
+    end
+
+    def self.define_multiple_selenium_accessor(base, base_element_tag, widget_class, widget_tag)
+      base.send(:define_method, "#{widget_tag}s_for") do |identifier|
+        find_selenium_elements(identifier, widget_class, base_element_tag)
+      end
+    end
+
+    def self.define_singular_selenium_accessor(base, base_element_tag, widget_class, widget_tag)
+      base.send(:define_method, "#{widget_tag}_for") do |identifier|
+        find_selenium_element(identifier, widget_class, base_element_tag)
+      end
+    end
+
+    def self.define_nested_elements(base, widget_tag)
+      define_singular_nested_accessor(base, widget_tag)
+      define_multiple_nested_accessor(base, widget_tag)
+    end
+
+    def self.define_multiple_nested_accessor(base, widget_tag)
+      base.send(:define_method, "#{widget_tag}_elements") do |*args|
+        identifier = args[0] ? args[0] : {:index => 0}
+        @platform.send("#{widget_tag}s_for", identifier.clone)
+      end
+    end
+
+    def self.define_singular_nested_accessor(base, widget_tag)
+      base.send(:define_method, "#{widget_tag}_element") do |*args|
+        identifier = args[0] ? args[0] : {:index => 0}
+        @platform.send("#{widget_tag}_for", identifier.clone)
+      end
+    end
+
+    def self.define_locators(base, widget_tag)
+      define_singular_locator(base, widget_tag)
+      define_multiple_locator(base, widget_tag)
+    end
+
+    def self.define_multiple_locator(base, widget_tag)
+      base.send(:define_method, "#{widget_tag}_elements") do |*args|
+        identifier = args[0] ? args[0] : {}
+        platform.send("#{widget_tag}s_for", identifier.clone)
+      end
+    end
+
+    def self.define_singular_locator(base, widget_tag)
+      base.send(:define_method, "#{widget_tag}_element") do |*args|
+        identifier = args[0] ? args[0] : {:index => 0}
+        platform.send("#{widget_tag}_for", identifier.clone)
+      end
+    end
+  end
+end