page-object 0.0.4 → 0.0.5

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

@@ -1,14 +1,30 @@
 module PageObject
   module Elements
     class Table < Element
+      include Enumerable
       
       def initialize(element, platform)
         @element = element
         include_platform_for platform
       end
       
+      #
+      # iterator that yields with a PageObject::Elements::TableRow
+      #
+      # @return [PageObject::Elements::TableRow]
+      #
+      def each
+        for index in 1..self.rows do
+          yield self[index-1] 
+        end
+      end
+      
       protected
       
+      def child_xpath
+        ".//child::tr"
+      end
+      
       def include_platform_for platform
         super
         if platform[:platform] == :watir

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

@@ -1,14 +1,30 @@
 module PageObject
   module Elements
     class TableRow < Element
+      include Enumerable
 
       def initialize(element, platform)
         @element = element
         include_platform_for platform
       end
       
+      #
+      # iterator that yields with a PageObject::Elements::TableCell
+      #
+      # @return [PageObject::Elements::TableCell]
+      #
+      def each
+        for index in 1..self.columns do
+          yield self[index-1] 
+        end
+      end
+
       protected
       
+      def child_xpath
+        ".//child::td|th"
+      end
+      
       def include_platform_for platform
         super
         if platform[:platform] == :watir

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

@@ -1,14 +1,31 @@
 module PageObject
   module Elements
     class UnorderedList < 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

data/lib/page-object/page_factory.rb

@@ -0,0 +1,50 @@
+module PageObject
+  #
+  # Module to facilitate to creating of page objects in step definitions.  You
+  # can make the methods below available to all of your step definitions by adding
+  # this module to World.  This idea was first discussed in Alister Scott's blog
+  # entry http://watirmelon.com/2011/06/07/removing-local-page-references-from-cucumber-steps/.
+  #
+  # @example Making the PageFactory available to your step definitions
+  #   World PageObject::PageFactory
+  #
+  # @example Visiting a page for the first time in a Scenario
+  #   visit_page MyPageObject do |page|
+  #     page.name = 'Cheezy'
+  #   end
+  #
+  # @example using a page that has already been visited in a Scenario
+  #   on_page MyPageObject do |page|
+  #     page.name.should == 'Cheezy'
+  #   end
+  #
+  module PageFactory
+    
+    #
+    # Create and navigate to a page object.  The navigation will only work if the
+    # 'page_url' method was call on the page object.
+    #
+    # @param [PageObject] a class that has included the PageObject module
+    # @param an optional block to be called
+    # @return [PageObject] the newly created page object
+    #
+    def visit_page(page_class, &block)
+      on_page page_class, true, &block
+    end
+    
+    #
+    # 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
+    # @return [PageObject] the newly created page object
+    #
+    def on_page(page_class, visit=false, &block)
+      page = page_class.new(@browser, visit)
+      block.call page if block
+      page
+    end
+    
+  end
+end

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

@@ -9,8 +9,21 @@ module PageObject
       # @return [PageObject::Elements::ListItem]
       #
       def [](idx)
-        element = @element.find_element(:xpath, ".//li[#{idx+1}]")
-        PageObject::Elements::ListItem.new(element, :platform => :selenium)
+        eles = list_items
+        PageObject::Elements::ListItem.new(eles[idx], :platform => :selenium)
+      end
+      
+      #
+      # Return the number of items contained in the ordered list
+      #
+      def items
+        list_items.size
+      end
+      
+      private
+      
+      def list_items
+        element.find_elements(:xpath, child_xpath)
       end
       
     end

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

@@ -6,11 +6,20 @@ module PageObject
       # Return the PageObject::Elements::TableRow for the index provided.  Index
       # is zero based.
       #
+      # @return [PageObject::Elements::TableRow]
+      #
       def [](idx)
-        element = @element.find_element(:xpath, ".//tr[#{idx+1}]")
-        PageObject::Elements::TableRow.new(element, :platform => :selenium)
+        eles = table_rows
+        PageObject::Elements::TableRow.new(eles[idx], :platform => :selenium)
       end
 
+      #
+      # Returns the number of rows in the table.
+      #
+      def rows
+        table_rows.size
+      end
+ 
       #
       # override PageObject::Platforms::SeleniumElement because exists? is not
       # available on a table element in Selenium.
@@ -19,6 +28,11 @@ module PageObject
         raise "exists? not available on table element"
       end
       
+      private
+      
+      def table_rows
+        @element.find_elements(:xpath, child_xpath)
+      end
     end
   end
 end

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

@@ -7,8 +7,21 @@ module PageObject
       # is zero based.
       #
       def [](idx)
-        element = @element.find_element(:xpath, "./th|td[#{idx+1}]")
-        PageObject::Elements::TableCell.new(element, :platform => :selenium)
+        els = table_cells
+        PageObject::Elements::TableCell.new(els[idx], :platform => :selenium)
+      end
+      
+      #
+      # Returns the number of columns in the table.
+      #
+      def columns
+        table_cells.size
+      end
+      
+      private
+      
+      def table_cells
+        element.find_elements(:xpath, child_xpath)
       end
       
     end

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

@@ -9,8 +9,21 @@ module PageObject
       # @return [PageObject::Elements::ListItem]
       #
       def [](idx)
-        element = @element.find_element(:xpath, ".//li[#{idx+1}]")
-        PageObject::Elements::ListItem.new(element, :platform => :selenium)
+        eles = list_items
+        PageObject::Elements::ListItem.new(eles[idx], :platform => :selenium)
+      end
+      
+      #
+      # Return the number of items contained in the unordered list
+      #
+      def items
+        list_items.size
+      end
+      
+      private
+      
+      def list_items
+        element.find_elements(:xpath, child_xpath)
       end
       
     end

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

@@ -9,10 +9,22 @@ module PageObject
       # @return [PageObject::Elements::ListItem]
       #
       def [](idx)
-        element = @element.wd.find_element(:xpath, ".//li[#{idx+1}]")
-        PageObject::Elements::ListItem.new(element, :platform => :watir)
+        eles = list_items
+        PageObject::Elements::ListItem.new(eles[idx], :platform => :watir)
       end
       
+      #
+      # Return the number of items contained in the ordered list
+      #
+      def items
+        list_items.size
+      end
+      
+      private
+      
+      def list_items
+        element.wd.find_elements(:xpath, child_xpath)
+      end
     end
   end
 end

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

@@ -6,10 +6,19 @@ module PageObject
       # Return the PageObject::Elements::TableRow for the index provided.  Index
       # is zero based.
       #
+      # @return [PageObject::Elements::TableRow]
+      #
       def [](idx)
         PageObject::Elements::TableRow.new(@element[idx], :platform => :watir)
       end
       
+      #
+      # Returns the number of rows in the table.
+      #
+      def rows
+        element.wd.find_elements(:xpath, child_xpath).size
+      end
+      
     end
   end
 end

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

@@ -7,7 +7,14 @@ module PageObject
       # is zero based.
       #
       def [](idx)
-        PageObject::Elements::TableCell.new(@element[idx], :platform => :watir)
+        PageObject::Elements::TableCell.new(element[idx], :platform => :watir)
+      end
+      
+      #
+      # Returns the number of columns in the table.
+      #
+      def columns
+        element.wd.find_elements(:xpath, child_xpath).size
       end
       
     end

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

@@ -9,8 +9,21 @@ module PageObject
       # @return [PageObject::Elements::ListItem]
       #
       def [](idx)
-        element = @element.wd.find_element(:xpath, ".//li[#{idx+1}]")
-        PageObject::Elements::ListItem.new(element, :platform => :watir)
+        eles = list_items
+        PageObject::Elements::ListItem.new(eles[idx], :platform => :watir)
+      end
+      
+      #
+      # Return the number of items contained in the unordered list
+      #
+      def items
+        list_items.size
+      end
+      
+      private
+      
+      def list_items
+        element.wd.find_elements(:xpath, child_xpath)
       end
       
     end

data/lib/page-object/version.rb

@@ -1,4 +1,4 @@
 module PageObject
   # @private
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/page-object/accessors_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 class TestPageObject
   include PageObject
 
+  page_url "http://apple.com"
   link(:google_search, :link => 'Google Search')
   text_field(:first_name, :id => 'first_name')
   hidden_field(:social_security_number, :id => 'ssn')
@@ -22,11 +23,53 @@ class TestPageObject
   ordered_list(:top_five, :id => 'top')
 end
 
+class BlockPageObject
+  include PageObject
+  
+  attr_reader :value  
+  
+  text_field :first_name do |browser| "text_field" end
+  hidden_field :secret do |browser| "hidden_field" end
+  text_area :address do |browser| "text_area" end
+  select_list :state do |browser| "select_list" end
+  link :continue do |browser| "link" end
+  checkbox :active do |browser| "checkbox" end
+  radio_button :first do |browser| "radio_button" end
+  button :click_me do |browser| "button" end
+  div :footer do |browser| "div" end
+  span :alert do |browser| "span" end
+  table :cart do |browser| "table" end
+  cell :total do |browser| "cell" end
+  image :logo do |browser| "image" end
+  form :login do |browser| "form" end
+  list_item :item_one do |browser| "list_item" end
+  unordered_list :menu do |browser| "unordered_list" end
+  ordered_list :top_five do |browser| "ordered_list" end
+end
+
 describe PageObject::Accessors do
   let(:watir_browser) { mock_watir_browser }
   let(:selenium_browser) { mock_selenium_browser }
   let(:watir_page_object) { TestPageObject.new(watir_browser) }
   let(:selenium_page_object) { TestPageObject.new(selenium_browser) }
+  let(:block_page_object) { BlockPageObject.new(watir_browser) }
+  
+  describe "goto a page" do
+    it "should navigate to a page when requested" do
+      watir_browser.should_receive(:goto)
+      page = TestPageObject.new(watir_browser, true)
+    end
+    
+    it "should not navigate to a page when not requested" do
+      watir_browser.should_not_receive(:goto)
+      page = TestPageObject.new(watir_browser)
+    end
+    
+    it "should not navigate to a page when 'page_url' not specified" do
+      watir_browser.should_not_receive(:goto)
+      page = BlockPageObject.new(watir_browser, true)
+    end
+  end
   
   describe "link accessors" do
     context "when called on a page object" do
@@ -34,6 +77,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to(:google_search)
         watir_page_object.should respond_to(:google_search_link)
       end
+      
+      it "should call a block on the element method when present" do
+        block_page_object.continue_link.should == "link"
+      end
     end
 
     context "Watir implementation" do
@@ -71,6 +118,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to(:first_name=)
         watir_page_object.should respond_to(:first_name_text_field)
       end
+      
+      it "should call a block on the element method when present" do
+        block_page_object.first_name_text_field.should == "text_field"
+      end
     end
 
     context "Watir implementation" do
@@ -121,6 +172,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to(:social_security_number)
         watir_page_object.should respond_to(:social_security_number_hidden_field)
       end
+  
+      it "should call a block on the element method when present" do
+        block_page_object.secret_hidden_field.should == "hidden_field"
+      end
     end
     
     context "watir implementation" do
@@ -159,6 +214,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to(:address=)
         watir_page_object.should respond_to(:address_text_area)
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.address_text_area.should == "text_area"
+      end
     end
     
     context "watir implementation" do
@@ -209,6 +268,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to :state=
         watir_page_object.should respond_to(:state_select_list)
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.state_select_list.should == "select_list"
+      end
     end
   
     context "Watir implementation" do
@@ -261,6 +324,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to :active_checked?
         watir_page_object.should respond_to(:active_checkbox)
       end
+      
+      it "should call a block on the element method when present" do
+        block_page_object.active_checkbox.should == "checkbox"
+      end
     end
 
     context "Watir implementation" do
@@ -327,6 +394,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to :first_selected?
         watir_page_object.should respond_to(:first_radio_button)
       end
+      
+      it "should call a block on the element method when present" do
+        block_page_object.first_radio_button.should == "radio_button"
+      end
     end
 
     context "Watir implementation" do
@@ -390,6 +461,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to :click_me
         watir_page_object.should respond_to :click_me_button
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.click_me_button.should == "button"
+      end
     end
     
     context "watir implementation" do
@@ -428,6 +503,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to(:message)
         watir_page_object.should respond_to(:message_div)
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.footer_div.should == "div"
+      end
     end
     
     context "watir implementation" do
@@ -467,6 +546,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to(:alert)
         watir_page_object.should respond_to(:alert_span)
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.alert_span.should == "span"
+      end
     end
     
     context "watir implementation" do
@@ -504,6 +587,10 @@ describe PageObject::Accessors do
       it "should generate accessor methods" do
         watir_page_object.should respond_to(:cart_table)
       end
+      
+      it "should call a block on the element method when present" do
+        block_page_object.cart_table.should == "table"
+      end
     end
     
     context "watir implementation" do
@@ -529,6 +616,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to(:total)
         watir_page_object.should respond_to(:total_cell)
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.total_cell.should == "cell"
+      end
     end
     
     context "watir implementation" do
@@ -559,6 +650,10 @@ describe PageObject::Accessors do
       it "should generate accessor methods" do
         watir_page_object.should respond_to(:logo_image)
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.logo_image.should == "image"
+      end
     end
     
     context "watir implementation" do
@@ -583,6 +678,10 @@ describe PageObject::Accessors do
       it "should generate accessor methods" do
         watir_page_object.should respond_to(:login_form)
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.login_form.should == "form"
+      end
     end
     
     context "watir implementation" do
@@ -608,6 +707,10 @@ describe PageObject::Accessors do
         watir_page_object.should respond_to(:item_one)
         watir_page_object.should respond_to(:item_one_list_item)
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.item_one_list_item.should == "list_item"
+      end
     end
     
     context "watir implementation" do
@@ -644,6 +747,10 @@ describe PageObject::Accessors do
       it "should generate accessor methods" do
         watir_page_object.should respond_to(:menu_unordered_list)
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.menu_unordered_list.should == "unordered_list"
+      end
     end
     
     context "watir implementation" do
@@ -668,6 +775,10 @@ describe PageObject::Accessors do
       it "should generate accessor methods" do
         watir_page_object.should respond_to(:top_five_ordered_list)
       end
+
+      it "should call a block on the element method when present" do
+        block_page_object.top_five_ordered_list.should == "ordered_list"
+      end
     end
     
     context "watir implementation" do