page-object 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jeff Morgan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# page-object
+
+[![Build Status](http://travis-ci.org/cheezy/page-object.png)](http://travis-ci.org/cheezy/page-object)
+
+
+A simple gem that assists in creating flexible page objects for testing browser based appications.  The goal is to facilitate creating abstraction layers in your tests to decouple the tests from the item they are testing and to provide a simple interface to the elements on a page.  It works with both watir-webdriver and selenium-webdriver.
+
+### Defining your page object
+
+You define a new page object by including the PageObject module:
+
+    class LoginPage
+      include PageObject
+    end
+    
+When you include this module numerous methods are added to your class that allow you to easily define your page.  For the login page you might add the following:
+
+    class LoginPage
+      include Page Object
+      
+      text_field(:username, :id => 'username')
+      text_field(:password, :id => 'password')
+      button(:login, :id => 'login')
+    end
+
+Calling the _text_field_ and _button_ methods adds several methods to our page object that allow us to interact with the items on the page.  To login using this page we could simply write the following code:
+
+    login_page.username = 'cheezy'
+    login_page.password = 'secret'
+    login_page.login
+    
+Another approach might be to create higher level methods on our page object that hide the implementation details even further.  Our page object might look like this:
+
+    class LoginPage
+      include Page Object
+  
+      text_field(:username, :id => 'username')
+      text_field(:password, :id => 'password')
+      button(:login, :id => 'login')
+  
+      def login_with(username, password) do
+        self.username = username
+        self.password = password
+        login
+      end
+    end
+
+and your usage of the page would become:
+
+    login_page.login_with 'cheezy', 'secret'
+
+### Creating your page object
+page-object supports both [watir-webdriver](https://github.com/jarib/watir-webdriver) and [selenium-webdriver](http://seleniumhq.org/docs/03_webdriver.html).  The one used will be determined by which driver you pass into the constructor of your page object.  The page object can be create like this:
+
+    browser = Watir::Browser.new :firefox
+    my_page_object = MyPageObject.new(browser)
+
+or
+
+    browser = Selenium::WebDriver.for :firefox
+    my_page_object = MyPageObject.new(browser)
+
+## Documentation
+
+The project [wiki](https://github.com/cheezy/page-object/wiki/page-object) is the first place to go to learn about how to use page-object.
+
+The rdocs for this project can be found at [rubydoc.info](http://rubydoc.info/github/cheezy/page-object/master/frames).
+
+If you wish to view the current tracker board you can view it on [Pivotal Tracker](https://www.pivotaltracker.com/projects/289099)
+
+## Known Issues
+
+See [http://github.com/cheezy/page-object/issues](http://github.com/cheezy/page-object/issues)
+
+## Contribute
+ 
+* Fork the project.
+* Test drive your feature addition or bug fix.  Adding specs is important and I will not accept a pull request that does not have tests.
+* Make sure you describe your new feature with a cucumber scenario.
+* Make sure you provide RDoc comments for any new public method you add.  Remember, others will be using this gem.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Jeffrey S. Morgan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.ruby_opts = "-I lib:spec"
+  spec.pattern   = 'spec/**/*_spec.rb'
+end
+task :spec
+
+namespace :features do
+  Cucumber::Rake::Task.new(:watir, "Run features with Watir") do |t|
+    t.profile = "watir"
+  end
+  
+  Cucumber::Rake::Task.new(:selenium, "Run features with Selenium") do |t|
+    t.profile = "selenium"
+  end
+  
+  desc 'Run all features'
+  task :all => [:watir, :selenium]
+end
+
+desc 'Run all specs and cukes'
+task :test => ['spec', 'features:all']
+
+task :lib do
+  $LOAD_PATH.unshift(File.expand_path("lib", File.dirname(__FILE__)))
+end
+
+task :default => :spec
+
+
+begin
+  require 'yard'
+  Rake::Task[:lib].invoke
+  require "yard/handlers/page-object"
+  YARD::Rake::YardocTask.new do |task|
+    task.options = %w[--debug] # this is pretty slow, so nice with some output
+  end
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+

data/cucumber.yml

@@ -0,0 +1,5 @@
+default: DRIVER=WATIR --no-source --color --format pretty --tags ~@selenium_only
+watir: DRIVER=WATIR --no-source --color --format pretty --tags ~@selenium_only
+selenium: DRIVER=SELENIUM --no-source --color --format pretty --tags ~@watir_only
+autotest: DRIVER=WATIR --no-source --color --format pretty --tags ~@selenium_only
+

data/features/check_box.feature

@@ -0,0 +1,39 @@
+Feature: Check Box
+  In order to interact with check boxes
+  Testers will need access and interrogation ability
+
+  
+  Background:
+    Given I am on the static elements page
+  
+  Scenario: Selecting an element on the select list
+    When I select the First check box
+    Then the First check box should be selected
+    When I unselect the First check box
+    Then the First check box should not be selected
+
+  Scenario Outline: Locating check boxes on the page
+    When I search for the check box by "<search_by>"
+    Then I should be able to check the check box
+    
+  Scenarios:
+    | search_by |
+    | id        |
+    | class     |
+    | name      |
+    | xpath     |  
+
+  @watir_only
+  Scenario Outline: Locating check boxes on Watir only
+    When I search for the check box by "<search_by>"
+    Then I should be able to check the check box
+
+  Scenarios:
+    | search_by |
+    | index     |
+   
+  Scenario: Retrieve a CheckBox
+    When I retrieve a check box element
+    Then I should know it exists
+    And I should know it is visible
+      

data/features/html/static_elements.html

@@ -0,0 +1,34 @@
+<html>
+  <head>
+    <title>Static Elements Page</title>
+  </head>
+  <body>
+    <h2>Static Elements Page</h2>
+    
+
+    <h3>Text Field</h3>
+    <input id="text_field_id" name="text_field_name" class="text_field_class" 
+           size="40" type="text" />
+
+    <h3>Select List</h3>
+    <select name="sel_list_name" id="sel_list_id", class="sel_list_class">
+      <option value="option1">Test 1</option>
+      <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>
+    
+    <h3>Check Boxes</h3>
+    <input id="cb_id" name="cb_name" class="cb_class" type="checkbox" value="1" />
+    
+    <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
+  </body>
+</html>
+
+

data/features/link.feature

@@ -0,0 +1,42 @@
+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"
+
+  Scenario Outline: Locating links on the Page
+    When I search for the link by "<search_by>"
+    Then I should be able to select the link
+
+  Scenarios:
+    | search_by |
+    | id        |
+    | class     |
+    | name      |
+    | xpath     |
+    | link      |
+    | link_text |
+    | text      |
+
+  @watir_only
+  Scenario Outline: Locating links on Watir only
+    When I search for the link by "<search_by>"
+    Then I should be able to select the link
+  
+  Scenarios:
+    | search_by |
+    | href      |
+    | index     |
+    
+  Scenario: Retrieve a Link
+    When I retrieve a link element
+    Then I should know it exists
+    And I should know it is visible

data/features/page_level_actions.feature

@@ -0,0 +1,19 @@
+Feature: Page level actions
+  In order to act on pages from a web site
+  Testers will need to use the page object to encapsulate access
+
+
+  Scenario: Getting the text from a web page
+    Given I am on the static elements page
+    Then the page should contain the text "Static Elements Page"
+
+  Scenario: Getting the html from a web page
+    Given I am on the static elements page
+    Then the page should contain the html "<title>Static Elements Page</title>"
+
+  Scenario: Getting the title from a web page
+    Given I am on the static elements page
+    Then the page should have the title "Static Elements Page"
+
+  
+  

data/features/radio_button.feature

@@ -0,0 +1,40 @@
+Feature: Radio Buttons
+  In order to interact with radio buttons
+  Testers will need access and interrogation ability
+
+  
+  Background:
+    Given I am on the static elements page
+  
+  Scenario: Selecting and clearing a radio button
+    When I select the "Milk" radio button
+    Then the "Milk" radio button should be selected
+    When I select the "Butter" radio button
+    Then the "Butter" radio button should be selected
+
+  Scenario Outline: Locating radio buttons on the Page
+    When I search for the radio button by "<search_by>"
+    And I select the radio button
+    Then the "Milk" radio button should be selected
+
+    Scenarios:
+      | search_by |
+      | id        |
+      | class     |
+      | name      |
+      | xpath     |  
+
+  @watir_only
+  Scenario Outline: Locating radio buttons on Watir only
+    When I search for the radio button by "<search_by>"
+    And I select the radio button
+    Then the "Milk" radio button should be selected
+
+    Scenarios:
+      | search_by |
+      | index     |
+
+  Scenario: Retrieve a radio button
+    When I retrieve a radio button
+    Then I should know it exists
+    And I should know it is visible

data/features/select_list.feature

@@ -0,0 +1,40 @@
+Feature: Select List
+  In order to interact with select lists
+  Testers will need access and interrogation ability
+
+  
+  Background:
+    Given I am on the static elements page
+  
+  Scenario: Selecting an element on the select list
+    When I select "Test 2" from the select list
+    Then the current item should be "option2"
+
+  Scenario Outline: Locating select lists on the Page
+    When I search for the select list by "<search_by>"
+    Then I should be able to select "Test 2"
+    And the value for the selected item should be "option2"
+
+    Scenarios:
+      | search_by |
+      | id        |
+      | class     |
+      | name      |
+      | xpath     |  
+
+  @watir_only
+  Scenario Outline: Locating select lists on Watir only
+    When I search for the select list by "<search_by>"
+    Then I should be able to select "Test 2"
+    And the value for the selected item should be "option2"
+
+    Scenarios:
+      | search_by |
+      | index     |
+#      | value     |
+#      | text      |
+
+  Scenario: Retrieve a select list
+    When I retrieve a select list
+    Then I should know it exists
+    And I should know it is visible

data/features/step_definitions/accessor_steps.rb

@@ -0,0 +1,88 @@
+When /^I type "([^\"]*)" into the text field$/ do |text|
+  @page.text_field_id = text
+end
+
+Then /^the text field should contain "([^\"]*)"$/ do |expected_text|
+  @page.text_field_id.should == expected_text
+end
+
+When /^I search for the text field by "([^\"]*)"$/ do |how|
+  @how = how
+end
+
+Then /^I should be able to type "([^\"]*)" into the field$/ do |value|
+  @page.send "text_field_#{@how}=".to_sym, value
+end
+
+When /^I select the link labeled "([^\"]*)"$/ do |text|
+  @page.google_search_id
+end
+
+When /^I search for the link by "([^\"]*)"$/ do |how|
+  @how = how
+end
+
+Then /^I should be able to select the link$/ do
+  @page.send "google_search_#{@how}".to_sym
+end
+
+When /^I select "([^\"]*)" from the select list$/ do |text|
+  @page.sel_list_id = text
+end
+
+Then /^the current item should be "([^\"]*)"$/ do |expected_text|
+  @page.sel_list_id.should == expected_text
+end
+
+When /^I search for the select list by "([^\"]*)"$/ do |how|
+  @how = how
+end
+
+Then /^I should be able to select "([^\"]*)"$/ do |value|
+  @page.send "sel_list_#{@how}=".to_sym, value
+end
+
+Then /^the value for the selected item should be "([^\"]*)"$/ do |value|
+  result = @page.send "sel_list_#{@how}".to_sym
+  result.should == value
+end
+
+When /^I select the First check box$/ do
+  @page.check_cb_id
+end
+
+Then /^the First check box should be selected$/ do
+  @page.cb_id_checked?.should be_true
+end
+
+When /^I unselect the First check box$/ do
+  @page.uncheck_cb_id
+end
+
+Then /^the First check box should not be selected$/ do
+  @page.cb_id_checked?.should be_false
+end
+
+When /^I search for the check box by "([^\"]*)"$/ do |how|
+  @how = how
+end
+
+Then /^I should be able to check the check box$/ do
+  @page.send "check_cb_#{@how}".to_sym
+end
+
+When /^I select the "([^\"]*)" radio button$/ do |how|
+  @page.send "select_#{how.downcase}_id".to_sym
+end
+
+Then /^the "([^\"]*)" radio button should be selected$/ do |how|
+  @page.send "#{how.downcase}_id_selected?".to_sym
+end
+
+When /^I search for the radio button by "([^\"]*)"$/ do |how|
+  @how = how
+end
+
+When /^I select the radio button$/ do 
+  @page.send "select_milk_#{@how}".to_sym
+end