page-object 0.0.3 → 0.0.4

data/lib/page-object/version.rb

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

data/lib/page-object/watir_page_object.rb

@@ -1,6 +1,11 @@
 require 'page-object/elements'
 
 module PageObject
+  #
+  # Watir 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 WatirPageObject
     def initialize(browser)
       @browser = browser      
@@ -66,6 +71,53 @@ module PageObject
       Elements::TextField.new(element, :platform => :watir)
     end
     
+    #
+    # platform method to get the value stored in a hidden field
+    # See PageObject::Accessors#hidden_field
+    #
+    def hidden_field_value_for(identifier)
+      identifier = Elements::HiddenField.watir_identifier_for identifier
+      @browser.hidden(identifier).value
+    end
+    
+    #
+    # platform method to retrieve a hidden field element
+    # See PageObject::Accessors#hidden_field
+    #
+    def hidden_field_for(identifier)
+      identifier = Elements::HiddenField.watir_identifier_for identifier
+      element = @browser.hidden(identifier)
+      Elements::HiddenField.new(element, :platform => :watir)
+    end    
+    
+    #
+    # platform method to set text in a textarea
+    # See PageObject::Accessors#text_area
+    #
+    def text_area_value_set(identifier, value)
+      identifier = Elements::TextArea.watir_identifier_for identifier
+      @browser.textarea(identifier).send_keys(value)
+    end
+    
+    #
+    # platform method to get the text from a textarea
+    # See PageObject::Accessors#text_area
+    #
+    def text_area_value_for(identifier)
+      identifier = Elements::TextArea.watir_identifier_for identifier
+      @browser.textarea(identifier).value
+    end
+    
+    #
+    # platform method to get the text area element
+    # See PageObject::Accessors#text_area
+    #
+    def text_area_for(identifier)
+      identifier = Elements::TextArea.watir_identifier_for identifier
+      element = @browser.textarea(identifier)
+      Elements::TextArea.new(element, :platform => :watir)
+    end
+    
     #
     # platform method to get the currently selected value from a select list
     # See PageObject::Accessors#select_list
@@ -259,7 +311,7 @@ module PageObject
     # See PageObject::Accessors#cell
     #
     def cell_text_for(identifier)
-      identifier = Elements::Table.watir_identifier_for identifier
+      identifier = Elements::TableCell.watir_identifier_for identifier
       @browser.td(identifier).text
     end
     
@@ -268,7 +320,7 @@ module PageObject
     # See PageObject::Accessors#cell
     #
     def cell_for(identifier)
-      identifier = Elements::Table.watir_identifier_for identifier
+      identifier = Elements::TableCell.watir_identifier_for identifier
       element = @browser.td(identifier)
       PageObject::Elements::TableCell.new(element, :platform => :watir)
     end
@@ -282,5 +334,54 @@ module PageObject
       element = @browser.image(identifier)
       PageObject::Elements::Image.new(element, :platform => :watir)
     end
+    
+    #
+    # platform method to retrieve a form element
+    # See PageObject::Accessors#form
+    #
+    def form_for(identifier)
+      identifier = Elements::Form.watir_identifier_for identifier
+      element = @browser.form(identifier)
+      PageObject::Elements::Form.new(element, :platform => :watir)
+    end
+    
+    #
+    # platform method to retrieve the text from a list item
+    # See PageObject::Accessors#list_item
+    #
+    def list_item_text_for(identifier)
+      identifier = Elements::ListItem.watir_identifier_for identifier
+      @browser.li(identifier).text
+    end
+    
+    #
+    # platform method to retrieve a list item element
+    # See PageObject::Accessors#list_item
+    #
+    def list_item_for(identifier)
+      identifier = Elements::ListItem.watir_identifier_for identifier
+      element = @browser.li(identifier)
+      PageObject::Elements::ListItem.new(element, :platform => :watir)
+    end
+
+    #
+    # platform method to retrieve an unordered list element
+    # See PageObject::Accessors#unordered_list
+    #
+    def unordered_list_for(identifier)
+      identifier = Elements::UnorderedList.watir_identifier_for identifier
+      element = @browser.ul(identifier)
+      PageObject::Elements::UnorderedList.new(element, :platform => :watir)
+    end
+    
+    #
+    # platform method to retrieve an ordered list element
+    # See PageObject::Accessors#ordered_list
+    #
+    def ordered_list_for(identifier)
+      identifier = Elements::OrderedList.watir_identifier_for identifier
+      element = @browser.ol(identifier)
+      PageObject::Elements::OrderedList.new(element, :platform => :watir)
+    end
   end
 end

data/spec/page-object/accessors_spec.rb

@@ -5,6 +5,8 @@ class TestPageObject
 
   link(:google_search, :link => 'Google Search')
   text_field(:first_name, :id => 'first_name')
+  hidden_field(:social_security_number, :id => 'ssn')
+  text_area(:address, :id => 'address')
   select_list(:state, :id => 'state')
   checkbox(:active, :id => 'is_active_id')
   radio_button(:first, :id => 'first_choice')
@@ -14,6 +16,10 @@ class TestPageObject
   cell(:total, :id => 'total')
   span(:alert, :id => 'alert_id')
   image(:logo, :id => 'logo')
+  form(:login, :id => 'login')
+  list_item(:item_one, :id => 'one')
+  unordered_list(:menu, :id => 'main_menu')
+  ordered_list(:top_five, :id => 'top')
 end
 
 describe PageObject::Accessors do
@@ -100,7 +106,7 @@ describe PageObject::Accessors do
         selenium_page_object.first_name = 'Katie'
       end
       
-      it "should should retrieve a text field element" do
+      it "should retrieve a text field element" do
         selenium_browser.should_receive(:find_element).and_return(selenium_browser)
         element = selenium_page_object.first_name_text_field
         element.should be_instance_of PageObject::Elements::TextField
@@ -109,6 +115,93 @@ describe PageObject::Accessors do
   end
   
   
+  describe "hidden field accessors" do
+    context "when called on a page object" do
+      it "should generate accessor methods" do
+        watir_page_object.should respond_to(:social_security_number)
+        watir_page_object.should respond_to(:social_security_number_hidden_field)
+      end
+    end
+    
+    context "watir implementation" do
+      it "should get the text from a hidden field" do
+        watir_browser.should_receive(:hidden).and_return(watir_browser)
+        watir_browser.should_receive(:value).and_return("value")
+        watir_page_object.social_security_number.should == "value"
+      end
+
+      it "should retrieve a hidden field element" do
+        watir_browser.should_receive(:hidden).and_return(watir_browser)
+        element = watir_page_object.social_security_number_hidden_field
+        element.should be_instance_of(PageObject::Elements::HiddenField)
+      end
+    end
+    
+    context "selenium implementation" do
+      it "should get the text from a hidden field" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        selenium_browser.should_receive(:attribute).with('value').and_return("12345")
+        selenium_page_object.social_security_number.should == "12345"
+      end
+      
+      it "should retrieve a hidden field element" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        element = selenium_page_object.social_security_number_hidden_field
+        element.should be_instance_of PageObject::Elements::HiddenField
+      end
+    end
+  end
+  
+  describe "text area accessors" do
+    context "when called on a page object" do
+      it "should generate accessor methods" do
+        watir_page_object.should respond_to(:address)
+        watir_page_object.should respond_to(:address=)
+        watir_page_object.should respond_to(:address_text_area)
+      end
+    end
+    
+    context "watir implementation" do
+      it "should set some text on the text area" do
+        watir_browser.should_receive(:textarea).and_return(watir_browser)
+        watir_browser.should_receive(:send_keys).with("123 main street")
+        watir_page_object.address = "123 main street"
+      end
+      
+      it "should get the text from the text area" do
+        watir_browser.should_receive(:textarea).and_return(watir_browser)
+        watir_browser.should_receive(:value).and_return("123 main street")
+        watir_page_object.address.should == "123 main street"
+      end
+      
+      it "should retrieve a text area element" do
+        watir_browser.should_receive(:textarea).and_return(watir_browser)
+        element = watir_page_object.address_text_area
+        element.should be_instance_of PageObject::Elements::TextArea
+      end
+    end
+    
+    context "selenium implementation" do
+      it "should set some text on the text area" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        selenium_browser.should_receive(:send_keys).with("123 main street")
+        selenium_page_object.address = "123 main street"
+      end
+      
+      it "should get the text from the text area" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        selenium_browser.should_receive(:attribute).with('value').and_return("123 main street")
+        selenium_page_object.address.should == "123 main street"
+      end
+      
+      it "should retrieve a text area element" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        element = selenium_page_object.address_text_area
+        element.should be_instance_of PageObject::Elements::TextArea
+      end
+    end
+  end
+
   describe "select_list accessors" do
     context "when called on a page object" do
       it "should generate accessor methods" do
@@ -426,7 +519,6 @@ describe PageObject::Accessors do
         selenium_browser.should_receive(:find_element).and_return(selenium_browser)
         element = selenium_page_object.cart_table
         element.should be_instance_of(PageObject::Elements::Table)
-        
       end
     end
   end
@@ -485,4 +577,113 @@ describe PageObject::Accessors do
       end
     end
   end
+  
+  describe "form accessors" do
+    context "when called on a page object" do
+      it "should generate accessor methods" do
+        watir_page_object.should respond_to(:login_form)
+      end
+    end
+    
+    context "watir implementation" do
+      it "should retrieve the form element from the page" do
+        watir_browser.should_receive(:form).and_return(watir_browser)
+        element = watir_page_object.login_form
+        element.should be_instance_of PageObject::Elements::Form
+      end
+    end
+    
+    context "selenium implementation" do
+      it "should retrieve the form element from the page" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        element = selenium_page_object.login_form
+        element.should be_instance_of PageObject::Elements::Form
+      end
+    end
+  end
+  
+  describe "list item accessors" do
+    context "when called on a page object" do
+      it "should generate accessor methods" do
+        watir_page_object.should respond_to(:item_one)
+        watir_page_object.should respond_to(:item_one_list_item)
+      end
+    end
+    
+    context "watir implementation" do
+      it "should retrieve the text from the list item" do
+        watir_browser.should_receive(:li).and_return(watir_browser)
+        watir_browser.should_receive(:text).and_return("value")
+        watir_page_object.item_one.should == "value"
+      end
+      
+      it "should retrieve the list item element from the page" do
+        watir_browser.should_receive(:li).and_return(watir_browser)
+        element = watir_page_object.item_one_list_item
+        element.should be_instance_of PageObject::Elements::ListItem
+      end
+    end
+    
+    context "selenium implementation" do
+      it "should retrieve the text from the list item" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        selenium_browser.should_receive(:text).and_return("value")
+        selenium_page_object.item_one.should == "value"
+      end
+      
+      it "should retrieve the list item from the page" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        element = selenium_page_object.item_one_list_item
+        element.should be_instance_of PageObject::Elements::ListItem
+      end
+    end
+  end
+  
+  describe "unordered list accessors" do
+    context "when called on a page object" do
+      it "should generate accessor methods" do
+        watir_page_object.should respond_to(:menu_unordered_list)
+      end
+    end
+    
+    context "watir implementation" do
+      it "should retrieve the element from the page" do
+        watir_browser.should_receive(:ul).and_return(watir_browser)
+        element = watir_page_object.menu_unordered_list
+        element.should be_instance_of PageObject::Elements::UnorderedList
+      end
+    end
+    
+    context "selenium implementation" do
+      it "should retrieve the element from the page" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        element = selenium_page_object.menu_unordered_list
+        element.should be_instance_of PageObject::Elements::UnorderedList
+      end
+    end
+  end
+  
+  describe "ordered list accessors" do
+    context "when called on a page object" do
+      it "should generate accessor methods" do
+        watir_page_object.should respond_to(:top_five_ordered_list)
+      end
+    end
+    
+    context "watir implementation" do
+      it "should retrieve the element from the page" do
+        watir_browser.should_receive(:ol).and_return(watir_browser)
+        element = watir_page_object.top_five_ordered_list
+        element.should be_instance_of PageObject::Elements::OrderedList
+      end
+    end
+    
+    context "selenium implementation" do
+      it "should retrieve the element from the page" do
+        selenium_browser.should_receive(:find_element).and_return(selenium_browser)
+        element = selenium_page_object.top_five_ordered_list
+        element.should be_instance_of PageObject::Elements::OrderedList
+      end
+    end
+  end
 end

data/spec/page-object/elements/form_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'page-object/elements'
+
+describe PageObject::Elements::Form do
+  describe "interface" do
+    let(:form_element) { double('form_element') }
+    
+    context "for watir" do
+      it "should submit a form" do
+        form = PageObject::Elements::Form.new(form_element, :platform => :watir)
+        form_element.should_receive(:submit)
+        form.submit
+      end
+    end
+    
+    context "for selenium" do
+      it "should submit a form" do
+        form = PageObject::Elements::Form.new(form_element, :platform => :selenium)
+        form_element.should_receive(:submit)
+        form.submit
+      end      
+    end
+  end
+end

data/spec/page-object/elements/hidden_field_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'page-object/elements'
+
+describe PageObject::Elements::HiddenField do
+  let(:hiddenfield) { PageObject::Elements::HiddenField }
+  
+  describe "when mapping how to find an element" do
+    it "should map watir types to same" do
+      [:class, :id, :index, :name, :tag_name, :text, :xpath].each do |t|
+        identifier = hiddenfield.watir_identifier_for t => 'value'
+        identifier.keys.first.should == t
+      end
+    end
+
+    it "should map selenium types to watir" do
+      identifier = hiddenfield.watir_identifier_for :css => 'value'
+      identifier.keys.first.should == :tag_name
+    end
+    
+    it "should map selenium types to same" do
+      [:class, :css, :id, :name, :xpath].each do |t|
+        key, value = hiddenfield.selenium_identifier_for t => 'value'
+        key.should == t
+      end
+    end
+    
+    it "should map watir types to selenium" do
+      key, value = hiddenfield.selenium_identifier_for :tag_name => 'value'
+      key.should == :css
+    end
+  end
+end

data/spec/page-object/elements/list_item_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'page-object/elements'
+
+describe PageObject::Elements::ListItem do
+  let(:list_item) { PageObject::Elements::ListItem }
+  
+  describe "when mapping how to find an element" do
+    it "should map watir types to same" do
+      [:class, :id, :index, :xpath].each do |t|
+        identifier = list_item.watir_identifier_for t => 'value'
+        identifier.keys.first.should == t
+      end
+    end
+
+    it "should map selenium types to same" do
+      [:class, :id, :name, :xpath].each do |t|
+        key, value = list_item.selenium_identifier_for t => 'value'
+        key.should == t
+      end
+    end
+  end
+end