page-object 0.6.2 → 0.6.3

data/.travis.yml

@@ -1,2 +1,8 @@
+language: ruby
 rvm:
-    - 1.9.2
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+  - ree
+  - ruby-head

data/ChangeLog

@@ -1,3 +1,14 @@
+=== Version 0.6.3 / 2012-3-1
+* Enhancements
+  * Added #expected_title method to PageObject
+  * Added #expected_element method to PageObject
+  * Added #execute_script method to PageObject
+  * Updated to use selenium-webdriver 2.20.0
+* Fixes
+  * Udates to the README - Thanks to p0deje and ivaravko
+  WARNING:  This change breaks existing code
+  * Changed the generated getter for select_list to return the text instead of the value
+
 === Version 0.6.2 / 2012-2-12
 * Enhancements
   * Added #wait_for_ajax support for the jQuery framework

data/README.md

@@ -3,7 +3,7 @@
 [![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.
+A simple gem that assists in creating flexible page objects for testing browser based applications. 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.
 
 ## Documentation
 
@@ -22,56 +22,70 @@ To read about the motivation for this gem please read this [blog entry](http://w
 
 You define a new page object by including the PageObject module:
 
-    class LoginPage
-      include PageObject
-    end
+````ruby
+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:
+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 PageObject
+````ruby
+class LoginPage
+  include PageObject
       
-      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
+  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:
+
+````ruby
+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:
+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 PageObject
+````ruby
+class LoginPage
+  include PageObject
   
-      text_field(:username, :id => 'username')
-      text_field(:password, :id => 'password')
-      button(:login, :id => 'login')
+  text_field(:username, :id => 'username')
+  text_field(:password, :id => 'password')
+  button(:login, :id => 'login')
   
-      def login_with(username, password)
-        self.username = username
-        self.password = password
-        login
-      end
-    end
+  def login_with(username, password)
+    self.username = username
+    self.password = password
+    login
+  end
+end
+````
 
 and your usage of the page would become:
 
-    login_page.login_with 'cheezy', 'secret'
+````ruby
+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:
+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)
+````ruby
+browser = Watir::Browser.new :firefox
+my_page_object = MyPageObject.new(browser)
+````
 
 or
 
-    browser = Selenium::WebDriver.for :firefox
-    my_page_object = MyPageObject.new(browser)
+````ruby
+browser = Selenium::WebDriver.for :firefox
+my_page_object = MyPageObject.new(browser)
+````
 
 ## Known Issues
 
@@ -80,9 +94,9 @@ See [http://github.com/cheezy/page-object/issues](http://github.com/cheezy/page-
 ## 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.
+* 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.
+* 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 ChangeLog.
   (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.

data/features/javascript.feature

@@ -12,3 +12,7 @@ Feature: Handling javascript events
     When I ask to compute "2 + 2"
     Then I should be able to wait for the answer "4"
 
+  Scenario: Executing javascript in the browser
+    Given I am on the static elements page
+    Given I execute the javascript "return 2 + 2;"
+    Then I should get the answer "4"

data/features/page_level_actions.feature

@@ -14,6 +14,15 @@ Feature: Page level actions
 
   Scenario: Getting the title from a web page
     Then the page should have the title "Static Elements Page"
+    
+  Scenario: Validating the page title
+    Then the page should have the expected title
+
+  Scenario: Validating the expected element
+    Then the page should have the expected element
+    
+  Scenario: Validating that an expected element does not exist
+    Then the page should not have the expected element
 
   Scenario: Waiting for something
     Then I should be able to wait for a block to return true
@@ -48,4 +57,4 @@ Feature: Page level actions
     Then the page should contain the text "Static Elements Page"
     When I press the forward button
     Then the page should contain the text "Success"
-    
+    

data/features/select_list.feature

@@ -8,12 +8,13 @@ Feature: Select List
 
   Scenario: Selecting an element on the select list
     When I select "Test 2" from the select list
-    Then the current item should be "option2"
+    Then the current item should be "Test 2"
 
   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"
+    And the value for the selected item should be "Test 2"
+    And the value for the option should be "option2"
 
   Scenarios:
     | search_by |
@@ -26,7 +27,8 @@ Feature: Select List
   Scenario Outline: Locating a select list using multiple parameters
     When I search for the select list by "<param1>" and "<param2>"
     Then I should be able to select "Test 2"
-    And the value for the selected item should be "option2"
+    And the value for the selected item should be "Test 2"
+    And the value for the option should be "option2"
 
   Scenarios:
     | param1 | param2 |

data/features/step_definitions/javascript_steps.rb

@@ -28,3 +28,11 @@ Then /^I should be able to wait for the answer "([^\"]*)"$/ do |answer|
   @page.wait_for_ajax
   @page.results.should == answer
 end
+
+Given /^I execute the javascript "([^\"]*)"$/ do |script|
+  @answer = @page.execute_script script
+end
+
+Then /^I should get the answer "([^\"]*)"$/ do |answer|
+  @answer.should == answer.to_i
+end

data/features/step_definitions/page_level_actions_steps.rb

@@ -78,3 +78,18 @@ When /^I press the forward button$/ do
   @page.forward
 end
 
+Then /^the page should have the expected title$/ do
+  @page.should have_expected_title
+end
+
+Then /^the page should have the expected element$/ do
+  @page.should have_expected_element
+end
+
+Then /^the page should not have the expected element$/ do
+  class FakePage
+    include PageObject
+    expected_element :blah
+  end
+  FakePage.new(@browser).should_not have_expected_element
+end

data/features/step_definitions/select_list_steps.rb

@@ -43,3 +43,7 @@ Then /^the select list should know that "([^\"]*)" is selected$/ do |text|
   @page.sel_list_id_element.selected?(text).should be_true
 end
 
+Then /^the value for the option should be "([^\"]*)"$/ do |value|
+  element = @page.send "sel_list_#{@how}_element".to_sym
+  element.value.should == value
+end

data/features/support/page.rb

@@ -1,6 +1,9 @@
 class Page
   include PageObject
 
+  expected_title "Static Elements Page"
+  expected_element :hello0
+  
   link(:hello0, {:text => "Hello", :index => 0})
   link(:hello1, {:text => "Hello", :index => 1})
   link(:hello2, {:text => "Hello", :index => 2})

data/lib/page-object.rb

@@ -66,8 +66,7 @@ module PageObject
 
   #
   # Set the javascript framework to use when determining number of
-  # ajax requests.  Valid frameworks are :jquery, :prototype, and
-  # :dojo
+  # ajax requests.  Valid frameworks are :jquery and :prototype
   #
   def self.javascript_framework=(framework)
     PageObject::JavascriptFrameworkFacade.framework = framework
@@ -209,6 +208,13 @@ module PageObject
   def prompt(answer, frame=nil, &block)
     platform.prompt(answer, frame, &block)
   end
+
+  #
+  # Execute javascript on the browser
+  #
+  def execute_script(script)
+    platform.execute_script(script)
+  end
   
   #
   # Identify an element as existing within a frame or iframe.  A frame parameter

data/lib/page-object/accessors.rb

@@ -21,6 +21,42 @@ module PageObject
       end
     end
 
+    #
+    # Creates a method that compares the expected_title of a page against the actual.
+    # @param [String] expected_title the literal expected title for the page
+    # @param [Regexp] expected_title the expected title pattern for the page
+    # @return [boolean]
+    # @raise An exception if expected_title does not match actual title
+    #
+    # @example Specify 'Google' as the expected title of a page
+    #   expected_title "Google"
+    #   page.has_expected_title?
+    # 
+    def expected_title(expected_title)
+      define_method("has_expected_title?") do
+        has_expected_title = expected_title.kind_of?(Regexp) ? expected_title =~ title : expected_title == title
+        raise "Expected title '#{expected_title}' instead of '#{title}'" unless has_expected_title
+        has_expected_title
+      end
+    end
+
+    #
+    # Creates a method that provides a way to initialize a page based upon an expected element.
+    # This is useful for pages that load dynamic content.
+    # @param [Symbol] the name given to the element in the declaration
+    # @param [optional, Integer] timeout default value is 5 seconds
+    # @return [boolean]
+    #
+    # @example Specify a text box named :address expected on the page within 10 seconds
+    #   expected_element(:address, 10)
+    #   page.has_expected_element?
+    #
+    def expected_element(element_name, timeout=5)
+      define_method("has_expected_element?") do
+        self.respond_to? "#{element_name}_element" and self.send("#{element_name}_element").when_present timeout
+      end
+    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.
@@ -172,7 +208,7 @@ module PageObject
 
     #
     # adds four methods - one to select an item in a drop-down,
-    # another to fetch the currently selected item, another
+    # another to fetch the currently selected item text, another
     # to retrieve the select list element, and another to check the 
     # drop down's existence.
     #

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

@@ -95,6 +95,14 @@ module PageObject
           result && result.dup.each_key { |k| result[k.to_sym] = result.delete(k) }
           result
         end
+
+        #
+        # platform method to execute javascript on the browser
+        # See PageObject#execute_script
+        #
+        def execute_script(script)
+          @browser.execute_script script
+        end
         
         #
         # platform method to handle attaching to a running window
@@ -266,7 +274,9 @@ module PageObject
         #
         def select_list_value_for(identifier)
           process_selenium_call(identifier, Elements::SelectList, 'select') do |how, what|
-            @browser.find_element(how, what).attribute('value')
+            @browser.find_element(how, what).find_elements(:tag_name => 'option').each do |o|
+              return o.text if o.selected?
+            end
           end
         end
 

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

@@ -104,6 +104,14 @@ module PageObject
           result && result.dup.each_key { |k| result[k.to_sym] = result.delete(k) }
           result
         end
+
+        #
+        # platform method to execute javascript on the browser
+        # See PageObject#execute_script
+        #
+        def execute_script(script)
+          @browser.wd.execute_script(script)
+        end
     
         #
         # platform method to handle attaching to a running window
@@ -256,8 +264,8 @@ module PageObject
         # See PageObject::Accessors#select_list
         #
         def select_list_value_for(identifier)
-          process_watir_call("select_list(identifier).value", Elements::SelectList,
-                             identifier)
+          process_watir_call("select_list(identifier).options.each {|o| return o.text if o.selected?}",
+                             Elements::SelectList, identifier)
         end
 
         #

data/lib/page-object/version.rb

@@ -1,4 +1,4 @@
 module PageObject
   # @private
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

data/page-object.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'watir-webdriver', '>= 0.5.3'
-  s.add_dependency 'selenium-webdriver', '>= 2.19.0' 
+  s.add_dependency 'selenium-webdriver', '>= 2.20.0' 
   
   s.add_development_dependency 'rspec', '>= 2.6.0'
   s.add_development_dependency 'cucumber', '>= 1.1.0'

data/spec/page-object/accessors_spec.rb

@@ -4,6 +4,8 @@ class AccessorsTestPageObject
   include PageObject
 
   page_url "http://apple.com"
+  expected_title "Expected Title"
+  expected_element :google_search
   link(:google_search, :link => 'Google Search')
   text_field(:first_name, :id => 'first_name')
   hidden_field(:social_security_number, :id => 'ssn')
@@ -142,6 +144,34 @@ describe PageObject::Accessors do
     end
   end
 
+  describe "validating the page title" do
+    it "should validate the title" do
+      watir_browser.should_receive(:title).and_return("Expected Title")
+      watir_page_object.should have_expected_title
+    end
+
+    it "should raise error when it does not have expected title" do
+      watir_browser.should_receive(:title).twice.and_return("Not Expected")
+      expect { watir_page_object.has_expected_title? }.to raise_error
+    end
+  end
+
+  describe "validating the existence of an element" do
+    it "should validate an element exists" do
+      watir_page_object.should_receive(:google_search_element).and_return(watir_browser)
+      watir_browser.should_receive(:when_present).and_return(true)
+      watir_page_object.has_expected_element?
+    end
+
+    it "should handle non-existent elements gracefully" do
+      class FakePage
+        include PageObject
+        expected_element :foo
+      end
+      FakePage.new(watir_browser).should_not have_expected_element
+    end
+  end
+
   describe "link accessors" do
     context "when called on a page object" do
       it "should generate accessor methods" do
@@ -353,8 +383,11 @@ describe PageObject::Accessors do
 
     context "Watir implementation" do
       it "should get the current item from a select list" do
+        selected = "OH"
+        selected.should_receive(:selected?).and_return(selected)
+        selected.should_receive(:text).and_return("OH")
         watir_browser.should_receive(:select_list).and_return watir_browser
-        watir_browser.should_receive(:value).and_return("OH")
+        watir_browser.should_receive(:options).and_return([selected])
         watir_page_object.state.should == "OH"
       end
 
@@ -373,8 +406,11 @@ describe PageObject::Accessors do
 
     context "Selenium implementation" do
       it "should should get the current item from a select list" do
+        selected = "OH"
+        selected.should_receive(:selected?).and_return(selected)
+        selected.should_receive(:text).and_return("OH")
         selenium_browser.should_receive(:find_element).and_return(selenium_browser)
-        selenium_browser.should_receive(:attribute).and_return("OH")
+        selenium_browser.should_receive(:find_elements).and_return([selected])
         selenium_page_object.state.should == "OH"
       end
 

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

@@ -61,18 +61,18 @@ describe "Element" do
 
     it "should build xpath when locating basic elements by name and class" do
       all_basic_elements.each do |tag|
-        identifier = {:tag_name => tag, :name => 'foo', :class => 'bar'}
+        identifier = {:tag_name => tag, :class => 'bar', :name => 'foo'}
         how, what = PageObject::Elements::Element.selenium_identifier_for identifier
         how.should == :xpath
-        what.should == ".//#{tag}[@name='foo' and @class='bar']"
+        what.should == ".//#{tag}[@class='bar' and @name='foo']"
       end
     end
 
     it "should build xpath when locating input elements by name and class" do
       all_input_elements.each do |type|
-        identifier = {:tag_name => 'input', :type => "#{type}", :name => 'foo', :class => 'bar'}
+        identifier = {:tag_name => 'input', :type => "#{type}", :class => 'bar', :name => 'foo'}
         how, what = PageObject::Elements::Element.selenium_identifier_for identifier
-        what.should include ".//input[@type='#{type}' and @name='foo' and @class='bar']"
+        what.should include ".//input[@type='#{type}' and @class='bar' and @name='foo']"
       end
     end
   end

data/spec/page-object/page-object_spec.rb

@@ -129,6 +129,12 @@ describe PageObject do
         watir_page_object.prompt("blah") do
         end
       end
+
+      it "should execute javascript on the browser" do
+        watir_browser.should_receive(:wd).and_return(watir_browser)
+        watir_browser.should_receive(:execute_script).and_return("abc")
+        watir_page_object.execute_script("333").should == "abc"
+      end
       
       it "should convert a modal popup to a window" do
         watir_browser.should_receive(:execute_script)
@@ -236,6 +242,11 @@ describe PageObject do
         selenium_page_object.modal_dialog {}
       end
       
+      it "should execute javascript on the browser" do
+        selenium_browser.should_receive(:execute_script).and_return("abc")
+        selenium_page_object.execute_script("333").should == "abc"
+      end
+
       it "should switch to a new window with a given title" do
         selenium_browser.should_receive(:window_handles).and_return(["win1"])
         selenium_browser.should_receive(:switch_to).twice.and_return(selenium_browser)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page-object
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-12 00:00:00.000000000 Z
+date: 2012-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
-  requirement: &70155418362080 !ruby/object:Gem::Requirement
+  requirement: &70256300665480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: 0.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *70155418362080
+  version_requirements: *70256300665480
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
-  requirement: &70155418361240 !ruby/object:Gem::Requirement
+  requirement: &70256300664920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.19.0
+        version: 2.20.0
   type: :runtime
   prerelease: false
-  version_requirements: *70155418361240
+  version_requirements: *70256300664920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70155418375380 !ruby/object:Gem::Requirement
+  requirement: &70256300664440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70155418375380
+  version_requirements: *70256300664440
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70155418374700 !ruby/object:Gem::Requirement
+  requirement: &70256300663980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70155418374700
+  version_requirements: *70256300663980
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70155418374020 !ruby/object:Gem::Requirement
+  requirement: &70256300663520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *70155418374020
+  version_requirements: *70256300663520
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70155418373300 !ruby/object:Gem::Requirement
+  requirement: &70256300696740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70155418373300
+  version_requirements: *70256300696740
 description: Page Object DSL that works with both Watir and Selenium
 email:
 - jeff.morgan@leandog.com