page-object 0.0.1 → 0.0.2

data/.gitignore

@@ -1,6 +1,4 @@
 Gemfile.lock
 .bundle
-.rspec
-.rvmrc
 .idea/
 pkg

data/.rspec

@@ -0,0 +1 @@
+--color --format doc

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2

data/ChangeLog

@@ -0,0 +1,23 @@
+=== Version 0.0.2
+* Enhancements
+  * Added support for the following elements
+    * div
+    * button
+    * table
+    * table row
+    * table cell
+    * added #text to element
+
+=== Version 0.0.1 / 2011-05-22
+* Enhancements
+  * Support for the following elements
+    * check box
+    * link
+    * radio button
+    * select list
+    * text field
+  
+  * Support for the following page level functions
+    * text
+    * html
+    * title

data/README.md

@@ -68,6 +68,8 @@ The rdocs for this project can be found at [rubydoc.info](http://rubydoc.info/gi
 
 If you wish to view the current tracker board you can view it on [Pivotal Tracker](https://www.pivotaltracker.com/projects/289099)
 
+To read about the motivation for this gem please read this [blog entry](http://www.cheezyworld.com/2010/11/19/ui-tests-introducing-a-simple-dsl/)
+
 ## Known Issues
 
 See [http://github.com/cheezy/page-object/issues](http://github.com/cheezy/page-object/issues)

data/features/button.feature

@@ -0,0 +1,37 @@
+Feature: Button
+  In order to interact with buttons
+  Testers will need access and interrogation ability
+
+  
+  Background:
+    Given I am on the static elements page
+  
+  Scenario: Getting the text from a div
+    When I click the button
+    Then I should be on the success page
+    
+  Scenario: Retrieve a button element
+    When I retrieve a button element
+    Then I should know it exists
+    And I should know it is visible
+
+  Scenario Outline: Locating buttons on the page
+    When I search for the button by "<search_by>"
+    Then I should be able to click the button
+
+  Scenarios:
+    | search_by |
+    | id        |
+    | class     |
+    | name      |
+    | xpath     |  
+
+  @watir_only
+  Scenario Outline: Locating check boxes on Watir only
+    When I search for the button by "<search_by>"
+    Then I should be able to click the button
+
+  Scenarios:
+    | search_by |
+    | index     |
+    | text      |

data/features/div.feature

@@ -0,0 +1,45 @@
+Feature: Div
+  In order to interact with divs
+  Testers will need access and interrogation ability
+
+  
+  Background:
+    Given I am on the static elements page
+  
+  Scenario: Getting the text from a div
+    When I get the text from the div
+    Then the text should be "page-object rocks!"
+
+  Scenario: Getting the div element
+    When I retrieve the div element
+    Then I should know it exists
+    And I should know it is visible
+
+  Scenario Outline: Locating divs on the page
+    When I search for the div by "<search_by>"
+    Then the text should be "page-object rocks!"
+
+  Scenarios:
+    | search_by |
+    | id        |
+    | class     |
+    | xpath     |  
+
+  @watir_only
+  Scenario Outline: Locating divs on Watir only
+    When I search for the div by "<search_by>"
+    Then the text should be "page-object rocks!"
+
+  Scenarios:
+    | search_by |
+    | index     |
+    
+    
+  @selenium_only
+  Scenario Outline: Locating divs on Watir only
+    When I search for the div by "<search_by>"
+    Then the text should be "page-object rocks!"
+
+  Scenarios:
+    | search_by |
+    | name      |

data/features/html/static_elements.html

@@ -16,11 +16,9 @@
       <option value="option2">Test 2</option>
     </select>
 
-    <h3>Button</h3>
-    <button id="test_button" onclick="javascript:window.location='http://www.google.com'">Click Me!!</button>
 
     <h3>Link</h3>
-    <a href="http://www.google.com" id="link_id" name="link_name" class="link_class" >Google Search</a>
+    <a href="success.html" id="link_id" name="link_name" class="link_class" >Google Search</a>
     
     <h3>Check Boxes</h3>
     <input id="cb_id" name="cb_name" class="cb_class" type="checkbox" value="1" />
@@ -28,6 +26,26 @@
     <h3>Radio Buttons</h3>
     <input type="radio" id="milk_id" name="milk_name" class="milk_class" value="Milk"> Milk <br />
     <input type="radio" id="butter_id" name="butter_name" class="butter_class" value="Butter">Butter
+    
+    <h3>Div</h3>
+    <div id="div_id" name="div_name" class="div_class">
+      page-object rocks!
+    </div>
+    
+    <h3>Table</h3>
+    <table id='table_id' name='table_name' class='table_class' border='1'>
+      <tr>
+        <td>Data1</td><td>Data2</td>
+      </tr>
+      <tr>
+        <td>Data3</td><td id='cell_id', name='cell_name' class='cell_class'>Data4</td>
+      </tr>
+    </table>
+    
+    <h3>Button</h3>
+    <form method="get" action="success.html">
+      <input id='button_id' name='button_name' class='button_class' type="submit" value="Click Me">
+    </form>
   </body>
 </html>
 

data/features/html/success.html

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>Success</title>
+  </head>
+  <body>
+    <h1>Success</h1>
+  </body>
+</html>

data/features/link.feature

@@ -2,15 +2,12 @@ Feature: Links
   In order to interact with links
   Testers will need access and interrogation ability
 
-  Note:
-    Watir supports href
-
   Background:
     Given I am on the static elements page
   
   Scenario: Selecting a link
     When I select the link labeled "Google Search"
-    Then the page should contain the text "Google"
+    Then the page should contain the text "Success"
 
   Scenario Outline: Locating links on the Page
     When I search for the link by "<search_by>"

data/features/step_definitions/accessor_steps.rb

@@ -86,3 +86,40 @@ end
 When /^I select the radio button$/ do 
   @page.send "select_milk_#{@how}".to_sym
 end
+
+When /^I get the text from the div$/ do
+  @div_text = @page.div_id
+end
+
+Then /^the text should be "([^"]*)"$/ do |expected_text|
+  @div_text.should == expected_text
+end
+
+When /^I search for the div by "([^"]*)"$/ do |how|
+  @div_text = @page.send "div_#{how}".to_sym
+end
+
+When /^I click the button$/ do
+  @page.button_id
+end
+
+Then /^I should be on the success page$/ do
+  @page.text.should include 'Success'
+  @page.title.should == 'Success'
+end
+
+When /^I search for the button by "([^"]*)"$/ do |how|
+  @how = how
+end
+
+Then /^I should be able to click the button$/ do
+  @page.send "button_#{@how}"
+end
+
+When /^I search for the table cell by "([^"]*)"$/ do |how|
+  @cell_data = @page.send "cell_#{how}"
+end
+
+When /^I retrieve a table element by "([^"]*)"$/ do |how|
+  @element = @page.send "table_#{how}_table"
+end

data/features/step_definitions/element_steps.rb

@@ -18,6 +18,24 @@ When /^I retrieve a text field$/ do
   @element = @page.text_field_id_text_field
 end
 
+When /^I retrieve the div element$/ do
+  @element = @page.div_id_div
+end
+
+When /^I retrieve a table element$/ do
+  @element = @page.table_id_table
+end
+
+When /^I retrieve a button element$/ do
+  @element = @page.button_id_button
+end
+
+When /^I retrieve table cell$/ do
+  @element = @page.cell_id_cell
+end
+  
+
+
 Then /^I should know it exists$/ do
   @element.should exist
 end

data/features/step_definitions/table_steps.rb

@@ -0,0 +1,14 @@
+Then /^the data for row "([^"]*)" should be "([^"]*)" and "([^"]*)"$/ do |row, col1, col2|
+  table_row = @element[row.to_i - 1]
+  table_row[0].text.should == col1
+  table_row[1].text.should == col2
+end
+
+
+When /^I retrieve the data from the table cell$/ do
+  @cell_data = @page.cell_id
+end
+
+Then /^the cell data should be '([^"]*)'$/ do |expected|
+  @cell_data.should == expected
+end

data/features/support/page.rb

@@ -17,7 +17,7 @@ class Page
   link(:google_search_xpath, :xpath => "//a[text()='Google Search']")
   link(:google_search_link, :link => "Google Search")
   link(:google_search_link_text, :link_text => "Google Search")
-  link(:google_search_href, :href => "http://www.google.com")
+  link(:google_search_href, :href => "success.html")
   link(:google_search_text, :text => "Google Search")
   link(:google_search_index, :index => 0)
   
@@ -42,4 +42,29 @@ class Page
   radio_button(:milk_xpath, :xpath => "//input[@type='radio']")
   
   radio_button(:butter_id, :id => 'butter_id')
+  
+  div(:div_id, :id => 'div_id')
+  div(:div_name, :name => 'div_name')
+  div(:div_class, :class => 'div_class')
+  div(:div_index, :index => 0)
+  div(:div_xpath, :xpath => '//div')
+  
+  table(:table_id, :id => 'table_id')
+  table(:table_name, :name => 'table_name')
+  table(:table_class, :class => 'table_class')
+  table(:table_index, :index => 0)
+  table(:table_xpath, :xpath => '//table')
+  
+  cell(:cell_id, :id => 'cell_id')
+  cell(:cell_name, :name => 'cell_name')
+  cell(:cell_class, :class => 'cell_class')
+  cell(:cell_index, :index => 3)
+  cell(:cell_xpath, :xpath => '//table//tr[2]//td[2]')
+  
+  button(:button_id, :id => 'button_id')
+  button(:button_name, :name => 'button_name')
+  button(:button_class, :class => 'button_class')
+  button(:button_index, :index => 0)
+  button(:button_xpath, :xpath=> "//input[@type='submit']")
+  button(:button_text, :text => 'Click Me')
 end

data/features/table.feature

@@ -0,0 +1,52 @@
+Feature: Table
+  In order to interact with tables
+  Testers will need access and interrogation ability
+
+  
+  Background:
+    Given I am on the static elements page
+  
+  Scenario: Retrieve a table
+    When I retrieve a table element
+    Then I should know it is visible
+    
+  @watir_only
+  Scenario: Determine if a table exists
+    When I retrieve a table element
+    Then I should know it exists
+    
+  Scenario: Retrieve the data from a table
+    When I retrieve a table element
+    Then the data for row "1" should be "Data1" and "Data2"
+    And the data for row "2" should be "Data3" and "Data4"
+  
+  
+  Scenario Outline: Locating table cells on the Page
+    When I retrieve a table element by "<search_by>"
+    Then the data for row "1" should be "Data1" and "Data2"
+
+  Scenarios:
+    | search_by |
+    | id        |
+    | class     |
+    | xpath     |  
+  
+  
+  @watir_only
+  Scenario Outline: Locating table cells on the Page with watir
+    When I retrieve a table element by "<search_by>"
+    Then the data for row "1" should be "Data1" and "Data2"
+
+  Scenarios:
+    | search_by |
+    | index     |
+
+
+  @selenium_only
+  Scenario Outline: Locating table cells on the Page with selenium
+    When I retrieve a table element by "<search_by>"
+    Then the data for row "1" should be "Data1" and "Data2"
+
+  Scenarios:
+    | search_by |
+    | name      |

data/features/table_cell.feature

@@ -0,0 +1,45 @@
+Feature: Table Cell
+
+
+  Background:
+    Given I am on the static elements page
+
+  Scenario: Retrieving the text from a table cell
+    When I retrieve the data from the table cell
+    Then the cell data should be 'Data4'
+  
+  Scenario Outline: Locating table cells on the Page
+    When I search for the table cell by "<search_by>"
+    Then the cell data should be 'Data4'
+
+  Scenarios:
+    | search_by |
+    | id        |
+    | class     |
+    | xpath     |  
+  
+
+  @watir_only
+  Scenario Outline: Locating table cells on the Page with watir
+    When I search for the table cell by "<search_by>"
+    Then the cell data should be 'Data4'
+
+  Scenarios:
+    | search_by |
+    | index     |
+
+  @selenium_only
+  Scenario Outline: Locating table cells on the Page with watir
+    When I search for the table cell by "<search_by>"
+    Then the cell data should be 'Data4'
+
+  Scenarios:
+    | search_by |
+    | name      |
+
+  Scenario: Retrieve a cell from a table by id
+    When I retrieve table cell
+    Then I should know it exists
+    And I should know it is visible
+
+

data/lib/page-object/accessors.rb

@@ -163,8 +163,96 @@ module PageObject
       end
     end
 
+    #
+    # adds two methods - one to click a button and another to
+    # return the button element.
+    #
+    # Example: button(:purchase, :id => 'purchase')
+    # will generate a 'purchase' and 'purchase_button' methods.
+    #
+    # @param the name used for the generated methods
+    # @param identifier how we find a checkbox.  The valid values are:
+    #   :class => Watir and Selenium
+    #   :id => Watir and Selenium
+    #   :index => Watir only
+    #   :name => Watir and Selenium
+    #   :text => Watir only
+    #   :xpath => Watir and Selenium
+    #
     def button(name, identifier)
       define_method(name) do
+        platform.click_button_for identifier
+      end
+      define_method("#{name}_button") do
+        platform.button_for identifier
+      end
+    end
+    
+    #
+    # adds two methods - one to retrieve the text from a div
+    # and another to return the div element
+    #
+    # Example:  div(:message, {:id => 'message'})
+    # will generate a 'message' and 'message_div' methods
+    #
+    # @param the name used for the generated methods
+    # @param identifier how we find a checkbox.  The valid values are:
+    #   :class => Watir and Selenium
+    #   :id => Watir and Selenium
+    #   :index => Watir only
+    #   :name => Selenium only
+    #   :xpath => Watir and Selenium
+    #
+    def div(name, identifier) 
+      define_method("#{name}") do
+        platform.div_text_for identifier
+      end
+      define_method("#{name}_div") do
+        platform.div_for identifier
+      end
+    end
+
+    #
+    # adds a method to retrieve the table element
+    #
+    # Example: table(:cart, :id => 'shopping_cart')
+    # will generate a 'cart_table' method.
+    #
+    # @param the name used for the generated methods
+    # @param identifier how we find a checkbox.  The valid values are:
+    #   :class => Watir and Selenium
+    #   :id => Watir and Selenium
+    #   :index => Watir only
+    #   :name => Selenium only
+    #   :xpath => Watir and Selenium
+    #
+    def table(name, identifier)
+      define_method("#{name}_table") do
+        platform.table_for identifier
+      end
+    end
+    
+    #
+    # adds two methods  one to retrieve the text from a table cell
+    # and another to return the table cell element
+    #
+    # Example: cell(:total, :id => 'total_cell')
+    # will generate a 'total' and 'total_cell' methods
+    #
+    # @param the name used for the generated methods
+    # @param identifier how we find a checkbox.  The valid values are:
+    #   :class => Watir and Selenium
+    #   :id => Watir and Selenium
+    #   :index => Watir only
+    #   :name => Selenium only
+    #   :xpath => Watir and Selenium
+    #
+    def cell(name, identifier)
+      define_method("#{name}") do
+        platform.cell_text_for identifier
+      end
+      define_method("#{name}_cell") do
+        platform.cell_for identifier
       end
     end
   end