page-object 2.2.2 → 2.3.0

data/Gemfile

@@ -1,13 +1,13 @@
-source "https://rubygems.org"
-
-# adding rake so travis-ci will build properly
-gem 'rake'
-gem 'rb-fsevent', :require => false if RUBY_PLATFORM =~ /darwin/i
-gem 'growl'
-gem 'guard-rspec'
-gem 'listen', '3.0.8' #Last version that supports ruby 2.0
-gem 'guard-cucumber'
-gem 'coveralls', require: false
-
-
-gemspec
+source "https://rubygems.org"
+
+# adding rake so travis-ci will build properly
+gem 'rake'
+gem 'rb-fsevent', :require => false if RUBY_PLATFORM =~ /darwin/i
+gem 'growl'
+gem 'guard-rspec'
+gem 'listen', '3.0.8' #Last version that supports ruby 2.0
+gem 'guard-cucumber'
+gem 'coveralls', require: false
+
+
+gemspec

data/Guardfile

@@ -1,20 +1,20 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-
-guard :rspec, cmd: 'rspec --color --format documentation' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^lib/page-object/platforms/(.+)/.+\.rb$}) do |m|
-    ["spec/page-object/platforms/#{m[1]}/", "spec/page-object/page-object_spec.rb"]
-  end
-  watch('spec/spec_helper.rb')  { "spec" }
-end
-
-guard 'cucumber', notification: true, all_after_pass: false, cli: '--profile focus'  do
-  watch(%r{^features/.+\.feature$})
-  watch(%r{^features/support/.+$})          { "features" }
-  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
-  watch(%r{^lib/.+\.rb$})                   { "features" }
-  watch(%r{^cucumber.yml$})                 { "features" }
-end
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+
+guard :rspec, cmd: 'rspec --color --format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/page-object/platforms/(.+)/.+\.rb$}) do |m|
+    ["spec/page-object/platforms/#{m[1]}/", "spec/page-object/page-object_spec.rb"]
+  end
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'cucumber', notification: true, all_after_pass: false, cli: '--profile focus'  do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { "features" }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  watch(%r{^lib/.+\.rb$})                   { "features" }
+  watch(%r{^cucumber.yml$})                 { "features" }
+end

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2011-2012 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.
+Copyright (c) 2011-2012 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

@@ -1,114 +1,114 @@
-# page-object
-
-[![Gem Version](https://badge.fury.io/rb/page-object.svg)](https://rubygems.org/gems/page-object)
-[![Build Status](https://travis-ci.org/cheezy/page-object.svg)](https://travis-ci.org/cheezy/page-object)
-[![Coverage Status](https://coveralls.io/repos/cheezy/page-object/badge.svg?nocache)](https://coveralls.io/r/cheezy/page-object)
-
-
-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 and selenium-webdriver.
-
-## 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/gems/page-object/frames).
-
-To see the changes from release to release please look at the [ChangeLog](https://raw.github.com/cheezy/page-object/master/ChangeLog)
-
-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/)
-
-There is a book that describes in detail how to use this gem and others to create a complete view of testing web and other types of applications.  The book is named [Cucumber & Cheese](http://leanpub.com/cucumber_and_cheese)
-
-## Support
-
-If you need help using the page-object gem please ask your questions on [Stack Overflow](http://stackoverflow.com).  Please be sure to use the [page-object-gem](http://stackoverflow.com/questions/tagged/page-object-gem) tag.  If you wish to report an issue or request a new feature use the [github issue tracking page](http://github.com/cheezy/page-object/issues).
-
-## Basic Usage
-
-### Defining your page object
-
-You define a new page object by including the PageObject module:
-
-````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:
-
-````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:
-
-````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:
-
-````ruby
-class LoginPage
-  include PageObject
-  
-  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
-````
-
-and your usage of the page would become:
-
-````ruby
-login_page.login_with 'cheezy', 'secret'
-````
-
-### Creating your page object
-page-object supports both [watir](https://github.com/watir/watir) 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 created like this:
-
-````ruby
-browser = Watir::Browser.new :firefox
-my_page_object = MyPageObject.new(browser)
-````
-
-or
-
-````ruby
-browser = Selenium::WebDriver.for :firefox
-my_page_object = MyPageObject.new(browser)
-````
-
-
-## 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 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.
-
-## Copyright
-
-Copyright (c) 2011-2012 Jeffrey S. Morgan. See LICENSE for details.
+# page-object
+
+[![Gem Version](https://badge.fury.io/rb/page-object.svg)](https://rubygems.org/gems/page-object)
+[![Build Status](https://travis-ci.org/cheezy/page-object.svg)](https://travis-ci.org/cheezy/page-object)
+[![Coverage Status](https://coveralls.io/repos/cheezy/page-object/badge.svg?nocache)](https://coveralls.io/r/cheezy/page-object)
+
+
+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 and selenium-webdriver.
+
+## 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/gems/page-object/frames).
+
+To see the changes from release to release please look at the [ChangeLog](https://raw.github.com/cheezy/page-object/master/ChangeLog)
+
+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/)
+
+There is a book that describes in detail how to use this gem and others to create a complete view of testing web and other types of applications.  The book is named [Cucumber & Cheese](http://leanpub.com/cucumber_and_cheese)
+
+## Support
+
+If you need help using the page-object gem please ask your questions on [Stack Overflow](http://stackoverflow.com).  Please be sure to use the [page-object-gem](http://stackoverflow.com/questions/tagged/page-object-gem) tag.  If you wish to report an issue or request a new feature use the [github issue tracking page](http://github.com/cheezy/page-object/issues).
+
+## Basic Usage
+
+### Defining your page object
+
+You define a new page object by including the PageObject module:
+
+````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:
+
+````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:
+
+````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:
+
+````ruby
+class LoginPage
+  include PageObject
+  
+  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
+````
+
+and your usage of the page would become:
+
+````ruby
+login_page.login_with 'cheezy', 'secret'
+````
+
+### Creating your page object
+page-object supports both [watir](https://github.com/watir/watir) 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 created like this:
+
+````ruby
+browser = Watir::Browser.new :firefox
+my_page_object = MyPageObject.new(browser)
+````
+
+or
+
+````ruby
+browser = Selenium::WebDriver.for :firefox
+my_page_object = MyPageObject.new(browser)
+````
+
+
+## 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 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.
+
+## Copyright
+
+Copyright (c) 2011-2012 Jeffrey S. Morgan. See LICENSE for details.

data/Rakefile

@@ -1,29 +1,29 @@
-require 'rubygems'
-require 'bundler'
-require 'rspec/core/rake_task'
-require 'cucumber'
-require 'cucumber/rake/task'
-require 'coveralls/rake/task'
-
-Coveralls::RakeTask.new
-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
-
-Cucumber::Rake::Task.new(:features, "Run the cucumber features")
-
-
-desc 'Run all specs and cukes'
-task :test => ['spec', 'features']
-
-task :lib do
-  $LOAD_PATH.unshift(File.expand_path("lib", File.dirname(__FILE__)))
-end
-
-task :test_with_coveralls => [:test, 'coveralls:push']
-
-task :default => :test_with_coveralls
+require 'rubygems'
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'coveralls/rake/task'
+
+Coveralls::RakeTask.new
+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
+
+Cucumber::Rake::Task.new(:features, "Run the cucumber features")
+
+
+desc 'Run all specs and cukes'
+task :test => ['spec', 'features']
+
+task :lib do
+  $LOAD_PATH.unshift(File.expand_path("lib", File.dirname(__FILE__)))
+end
+
+task :test_with_coveralls => [:test, 'coveralls:push']
+
+task :default => :test_with_coveralls

data/cucumber.yml

@@ -1,8 +1,8 @@
-<%
-std_opts = "--no-source --color --format pretty" # Cucumber::Formatter::Fuubar"
-%>
-
-default: DRIVER=WATIR <%= std_opts %>
-selenium: DRIVER=SELENIUM <%= std_opts %>
-focus: DRIVER=WATIR <%= std_opts %> --tags ~@selenium_only --tags @focus
-
+<%
+std_opts = "--no-source --color --format pretty" # Cucumber::Formatter::Fuubar"
+%>
+
+default: DRIVER=WATIR <%= std_opts %>
+selenium: DRIVER=SELENIUM <%= std_opts %>
+focus: DRIVER=WATIR <%= std_opts %> --tags ~@selenium_only --tags @focus
+

data/lib/page-object.rb

@@ -1,420 +1,431 @@
-require 'watir'
-require 'page-object/version'
-require 'page-object/accessors'
-require 'page-object/element_locators'
-require 'page-object/nested_elements'
-require 'page-object/page_factory'
-require 'page-object/page_populator'
-require 'page-object/javascript_framework_facade'
-require 'page-object/indexed_properties'
-require 'page-object/section_collection'
-require 'page-object/widgets'
-
-require 'page-object/platforms/watir'
-require 'page-object/platforms/watir/page_object'
-
-#
-# Module that when included adds functionality to a page object.  This module
-# will add numerous class and instance methods that you use to define and
-# interact with web pages.
-#
-# If we have a login page with a username and password textfield and a login
-# button we might define our page like the one below.  We can then interact with
-# the object using the generated methods.
-#
-# @example Login page example
-#   class LoginPage
-#     include PageObject
-#
-#     text_field(:username, :id => 'user')
-#     text_field(:password, :id => 'pass')
-#     button(:login, :value => 'Login')
-#   end
-#
-#   ...
-#
-#   browser = Watir::Browser.new :firefox
-#   login_page = LoginPage.new(browser)
-#   login_page.username = 'cheezy'
-#   login_page.password = 'secret'
-#   login_page.login
-#
-# @see PageObject::Accessors to see what class level methods are added to this module at runtime.
-#
-module PageObject
-  include ElementLocators
-  include PagePopulator
-
-  def method_missing(method, *args, &block)
-    @root_element.send(method, *args, &block)
-  end
-
-  def respond_to_missing?(method, include_all = false)
-    @root_element && @root_element.respond_to?(method) || super
-  end
-
-  # @return the platform browser passed to the constructor
-  attr_reader :browser
-  # @return [PageObject::WatirPageObject] the platform page object
-  attr_reader :platform
-
-  #
-  # Construct a new page object.  Prior to browser initialization it will call
-  # a method named initialize_accessors if it exists. Upon initialization of
-  # the page it will call a method named initialize_page if it exists.
-  #
-  # @param [Watir::Browser, Watir::HTMLElement or Selenium::WebDriver::Driver, Selenium::WebDriver::Element] the platform browser/element to use
-  # @param [bool] open the page if page_url is set
-  #
-  def initialize(root, visit=false)
-    initialize_accessors if respond_to?(:initialize_accessors)
-    initialize_browser(root)
-    goto if visit && self.class.instance_methods(false).include?(:goto)
-    initialize_page if respond_to?(:initialize_page)
-  end
-
-  def initialize_browser(root)
-    @root_element = PageObject::Platforms::Watir.root_element_for root
-    @browser = root 
-    @platform = PageObject::Platforms::Watir.create_page_object @browser
-  end
-
-  # @private
-  def self.included(cls)
-    cls.extend PageObject::Accessors
-  end
-
-  #
-  # Set the default timeout for page level waits
-  #
-  def self.default_page_wait=(timeout)
-    @page_wait = timeout
-  end
-
-  #
-  # Returns the default timeout for page lavel waits
-  #
-  def self.default_page_wait
-    @page_wait ||= 30
-  end
-
-  #
-  # Sets the default timeout for element level waits
-  #
-  def self.default_element_wait=(timeout)
-    @element_wait = timeout
-  end
-
-  #
-  # Returns the default timeout for element level waits
-  #
-  def self.default_element_wait
-    @element_wait ||= 5
-  end
-
-  #
-  # Set the javascript framework to use when determining number of
-  # ajax requests.  Valid frameworks are :jquery, :prototype, :yui,
-  # and :angularjs
-  #
-  def self.javascript_framework=(framework)
-    PageObject::JavascriptFrameworkFacade.framework = framework
-  end
-
-  #
-  # Add a new javascript framework to page-object.  The module passed
-  # in must adhere to the same prototype as the JQuery and Prototype
-  # modules.
-  #
-  # @param [Symbol] the name used to reference the framework in
-  # subsequent calls
-  # @param [Module] a module that has the necessary methods to perform
-  # the required actions.
-  #
-  def self.add_framework(key, framework)
-    PageObject::JavascriptFrameworkFacade.add_framework(key, framework)
-  end
-
-  #
-  # get the current page url
-  #
-  def current_url
-    platform.current_url
-  end
-
-  #
-  # navigate to the provided url
-  #
-  # @param [String] the full url to navigate to
-  #
-  def navigate_to(url)
-    platform.navigate_to(url)
-  end
-
-  #
-  # Returns the text of the current page
-  #
-  def text
-    platform.text
-  end
-
-  #
-  # Returns the html of the current page
-  #
-  def html
-    platform.html
-  end
-
-  #
-  # Returns the title of the current page
-  #
-  def title
-    platform.title
-  end
-
-  #
-  # Wait until the block returns true or times out
-  #
-  # @example
-  #   @page.wait_until(5, 'Success not found on page') do
-  #     @page.text.include? 'Success'
-  #   end
-  #
-  # @param [Numeric] the amount of time to wait for the block to return true.
-  # @param [String] the message to include with the error if we exceed the timeout duration.
-  # @param block the block to execute.  It should return true when successful.
-  #
-  def wait_until(timeout = PageObject.default_page_wait, message = nil, &block)
-    platform.wait_until(timeout, message, &block)
-  end
-
-
-  #
-  # Wait until there are no pending ajax requests.  This requires you
-  # to set the javascript framework in advance.
-  #
-  # @param [Numeric] the amount of time to wait for the block to return true.
-  # @param [String] the message to include with the error if we exceed
-  # the timeout duration.
-  #
-  def wait_for_ajax(timeout = 30, message = nil)
-    end_time = ::Time.now + timeout
-    until ::Time.now > end_time
-      return if browser.execute_script(::PageObject::JavascriptFrameworkFacade.pending_requests) == 0
-      sleep 0.5
-    end
-    message = "Timed out waiting for ajax requests to complete" unless message
-    raise message
-  end
-
-  #
-  # Override the normal alert popup so it does not occur.
-  #
-  # @example
-  #   message = @page.alert do
-  #     @page.button_that_causes_alert
-  #   end
-  #
-  # @param frame optional parameter used when alert is nested within a frame
-  # @param block a block that has the call that will cause the alert to display
-  # @return [String] the message that was contained in the alert
-  #
-  def alert(frame=nil, &block)
-    platform.alert(frame, &block)
-  end
-
-  #
-  # Override the normal confirm popup so it does not occur.
-  #
-  # @example
-  #   message = @popup.confirm(true) do
-  #     @page.button_that_causes_confirm
-  #   end
-  #
-  # @param [bool] what response you want to return back from the confirm popup
-  # @param frame optional parameter used when the confirm is nested within a frame
-  # @param block a block that has the call that will cause the confirm to display
-  # @return [String] the message that was prompted in the confirm
-  #
-  def confirm(response, frame=nil, &block)
-    platform.confirm(response, frame, &block)
-  end
-
-  #
-  # Override the normal prompt popup so it does not occur.
-  #
-  # @example
-  #   message = @popup.prompt("Some Value") do
-  #     @page.button_that_causes_prompt
-  #   end
-  #
-  # @param [string] the value returned to the caller of the prompt
-  # @param frame optional parameter used with the prompt is nested within a frame
-  # @param block a block that has the call that will cause the prompt to display
-  # @return [Hash] A has containing two keys - :message contains the prompt message and
-  # :default_value contains the default value for the prompt if provided
-  #
-  def prompt(answer, frame=nil, &block)
-    platform.prompt(answer, frame, &block)
-  end
-
-  #
-  # Execute javascript on the browser
-  #
-  # @example Get inner HTML of element
-  #   span = @page.span_element
-  #   @page.execute_script "return arguments[0].innerHTML", span
-  #   #=> "Span innerHTML"
-  #
-  def execute_script(script, *args)
-    args.map! { |e| e.kind_of?(PageObject::Elements::Element) ? e.element : e }
-    platform.execute_script(script, *args)
-  end
-
-  #
-  # Identify an element as existing within a frame.  A frame parameter
-  # is passed to the block and must be passed to the other calls to PageObject.
-  # You can nest calls to in_frame by passing the frame to the next level.
-  #
-  # @example
-  #   in_frame(:id => 'frame_id') do |frame|
-  #     text_field_element(:id => 'fname', :frame => frame)
-  #   end
-  #
-  # @param [Hash] identifier how we find the frame.  The valid keys are:
-  #   * :id
-  #   * :index
-  #   * :name
-  #   * :class
-  # @param frame passed from a previous call to in_frame.  Used to nest calls
-  # @param block that contains the calls to elements that exist inside the frame.
-  #
-  def in_frame(identifier, frame=nil, &block)
-    platform.in_frame(identifier, frame, &block)
-  end
-
-  # Identify an element as existing within an iframe.  A frame parameter
-  # is passed to the block and must be passed to the other calls to PageObject.
-  # You can nest calls to in_iframe by passing the frame to the next level.
-  #
-  # @example
-  #   in_iframe(:id => 'iframe_id') do |iframe|
-  #     text_field_element(:id => 'ifname', :frame => iframe)
-  #   end
-  #
-  # @param [Hash] identifier how we find the iframe.  The valid keys are:
-  #   * :id
-  #   * :index
-  #   * :name
-  #   * :class
-  # @param frame passed from a previous call to in_iframe.  Used to nest calls
-  # @param block that contains the calls to elements that exist inside the iframe.
-  #
-  def in_iframe(identifier, frame=nil, &block)
-    platform.in_iframe(identifier, frame, &block)
-  end
-
-  #
-  # Override the normal showModalDialog call is it opens a window instead
-  # of a dialog.  You will need to attach to the new window in order to
-  # continue.
-  #
-  # @example
-  #   @page.modal_dialog do
-  #     @page.action_that_spawns_the_modal
-  #   end
-  #
-  # @param block a block that contains the call that will cause the modal dialog.
-  #
-  def modal_dialog(&block)
-    script =
-        %Q{
-      window.showModalDialog = function(sURL, vArguments, sFeatures) {
-        window.dialogArguments = vArguments;
-        modalWin = window.open(sURL, 'modal', sFeatures);
-        return modalWin;
-      }
-    }
-    browser.execute_script script
-    yield if block_given?
-  end
-
-  #
-  # Attach to a running window.  You can locate the window using either
-  # the window's title or url.  If it fails to connect to a window it will
-  # pause for 1 second and try again.
-  #
-  # @example
-  #     page.attach_to_window(:title => "other window's title")
-  #
-  # @param [Hash] either :title or :url of the other window.  The url does not need to
-  # be the entire url - it can just be the page name like index.html
-  # @param block if present the block is executed and then execution is returned to the
-  # calling window
-  #
-  def attach_to_window(identifier, &block)
-    begin
-      platform.attach_to_window(identifier, &block)
-    rescue
-      sleep 1
-      platform.attach_to_window(identifier, &block)
-    end
-  end
-
-  #
-  # Find the element that has focus on the page
-  #
-  def element_with_focus
-    platform.element_with_focus
-  end
-
-  #
-  # Refresh to current page
-  #
-  def refresh
-    platform.refresh
-  end
-
-  #
-  # Go back to the previous page
-  #
-  def back
-    platform.back
-  end
-
-  #
-  # Go forward to the next page
-  #
-  def forward
-    platform.forward
-  end
-
-  #
-  # Clear the cookies from the browser
-  #
-  def clear_cookies
-    platform.clear_cookies
-  end
-
-  #
-  # Save the current screenshot to the provided url.  File
-  # is saved as a png file.
-  #
-  def save_screenshot(file_name)
-    platform.save_screenshot file_name
-  end
-
-  def self.register_widget(widget_tag, widget_class, base_element_tag)
-    Widgets.register_widget(widget_tag, widget_class, base_element_tag)
-  end
-
-  private
-
-  def root
-    @root_element || PageObject::Platforms::Watir.browser_root_for(browser)
-  end
-
-  def call_block(&block)
-    block.arity == 1 ? block.call(self) : self.instance_eval(&block)
-  end
-end
+require 'watir'
+require 'page-object/version'
+require 'page-object/accessors'
+require 'page-object/element_locators'
+require 'page-object/nested_elements'
+require 'page-object/page_factory'
+require 'page-object/page_populator'
+require 'page-object/javascript_framework_facade'
+require 'page-object/indexed_properties'
+require 'page-object/section_collection'
+require 'page-object/widgets'
+
+require 'page-object/platforms/watir'
+require 'page-object/platforms/watir/page_object'
+
+#
+# Module that when included adds functionality to a page object.  This module
+# will add numerous class and instance methods that you use to define and
+# interact with web pages.
+#
+# If we have a login page with a username and password textfield and a login
+# button we might define our page like the one below.  We can then interact with
+# the object using the generated methods.
+#
+# @example Login page example
+#   class LoginPage
+#     include PageObject
+#
+#     text_field(:username, :id => 'user')
+#     text_field(:password, :id => 'pass')
+#     button(:login, :value => 'Login')
+#   end
+#
+#   ...
+#
+#   browser = Watir::Browser.new :firefox
+#   login_page = LoginPage.new(browser)
+#   login_page.username = 'cheezy'
+#   login_page.password = 'secret'
+#   login_page.login
+#
+# @see PageObject::Accessors to see what class level methods are added to this module at runtime.
+#
+module PageObject
+  include ElementLocators
+  include PagePopulator
+
+  def method_missing(method, *args, &block)
+    if @root_element.respond_to?(method)
+      @root_element.send(method, *args, &block)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method, include_all = false)
+    @root_element && @root_element.respond_to?(method) || super
+  end
+
+  # @return the platform browser passed to the constructor
+  attr_reader :browser
+  # @return [PageObject::WatirPageObject] the platform page object
+  attr_reader :platform
+
+  #
+  # Construct a new page object.  Prior to browser initialization it will call
+  # a method named initialize_accessors if it exists. Upon initialization of
+  # the page it will call a method named initialize_page if it exists.
+  #
+  # @param [Watir::Browser, Watir::HTMLElement or Selenium::WebDriver::Driver, Selenium::WebDriver::Element] the platform browser/element to use
+  # @param [bool] open the page if page_url is set
+  #
+  def initialize(root, visit=false)
+    initialize_accessors if respond_to?(:initialize_accessors)
+    initialize_browser(root)
+    goto if visit && self.class.instance_methods(false).include?(:goto)
+    initialize_page if respond_to?(:initialize_page)
+  end
+
+  def initialize_browser(root)
+    @root_element = PageObject::Platforms::Watir.root_element_for root
+    @browser = root 
+    @platform = PageObject::Platforms::Watir.create_page_object @browser
+  end
+
+  # @private
+  def self.included(cls)
+    cls.extend PageObject::Accessors
+  end
+
+  #
+  # Set the default timeout for page level waits
+  #
+  def self.default_page_wait=(timeout)
+    @page_wait = timeout
+  end
+
+  #
+  # Returns the default timeout for page lavel waits
+  #
+  def self.default_page_wait
+    @page_wait ||= 30
+  end
+
+  #
+  # Sets the default timeout for element level waits
+  #
+  def self.default_element_wait=(timeout)
+    @element_wait = timeout
+  end
+
+  #
+  # Returns the default timeout for element level waits
+  #
+  def self.default_element_wait
+    @element_wait ||= 5
+  end
+
+  #
+  # Set the javascript framework to use when determining number of
+  # ajax requests.  Valid frameworks are :jquery, :prototype, :yui,
+  # and :angularjs
+  #
+  def self.javascript_framework=(framework)
+    PageObject::JavascriptFrameworkFacade.framework = framework
+  end
+
+  #
+  # Add a new javascript framework to page-object.  The module passed
+  # in must adhere to the same prototype as the JQuery and Prototype
+  # modules.
+  #
+  # @param [Symbol] the name used to reference the framework in
+  # subsequent calls
+  # @param [Module] a module that has the necessary methods to perform
+  # the required actions.
+  #
+  def self.add_framework(key, framework)
+    PageObject::JavascriptFrameworkFacade.add_framework(key, framework)
+  end
+
+  #
+  # get the current page url
+  #
+  def current_url
+    platform.current_url
+  end
+
+  #
+  # navigate to the provided url
+  #
+  # @param [String] the full url to navigate to
+  #
+  def navigate_to(url)
+    platform.navigate_to(url)
+  end
+
+  #
+  # Returns the text of the current page
+  #
+  def text
+    platform.text
+  end
+
+  #
+  # Returns the html of the current page
+  #
+  def html
+    platform.html
+  end
+
+  #
+  # Returns the title of the current page
+  #
+  def title
+    platform.title
+  end
+
+  #
+  # Wait until the block returns true or times out
+  #
+  # @example
+  #   @page.wait_until(5, 'Success not found on page') do
+  #     @page.text.include? 'Success'
+  #   end
+  #
+  # @param [Numeric] the amount of time to wait for the block to return true.
+  # @param [String] the message to include with the error if we exceed the timeout duration.
+  # @param block the block to execute.  It should return true when successful.
+  #
+  def wait_until(timeout = PageObject.default_page_wait, message = nil, &block)
+    platform.wait_until(timeout, message, &block)
+  end
+
+
+  #
+  # Wait until there are no pending ajax requests.  This requires you
+  # to set the javascript framework in advance.
+  #
+  # @param [Numeric] the amount of time to wait for the block to return true.
+  # @param [String] the message to include with the error if we exceed
+  # the timeout duration.
+  #
+  def wait_for_ajax(timeout = 30, message = nil)
+    end_time = ::Time.now + timeout
+    until ::Time.now > end_time
+      return if browser.execute_script(::PageObject::JavascriptFrameworkFacade.pending_requests) == 0
+      sleep 0.5
+    end
+    message = "Timed out waiting for ajax requests to complete" unless message
+    raise message
+  end
+
+  #
+  # Override the normal alert popup so it does not occur.
+  #
+  # @example
+  #   message = @page.alert do
+  #     @page.button_that_causes_alert
+  #   end
+  #
+  # @param frame optional parameter used when alert is nested within a frame
+  # @param block a block that has the call that will cause the alert to display
+  # @return [String] the message that was contained in the alert
+  #
+  def alert(frame=nil, &block)
+    platform.alert(frame, &block)
+  end
+
+  #
+  # Override the normal confirm popup so it does not occur.
+  #
+  # @example
+  #   message = @popup.confirm(true) do
+  #     @page.button_that_causes_confirm
+  #   end
+  #
+  # @param [bool] what response you want to return back from the confirm popup
+  # @param frame optional parameter used when the confirm is nested within a frame
+  # @param block a block that has the call that will cause the confirm to display
+  # @return [String] the message that was prompted in the confirm
+  #
+  def confirm(response, frame=nil, &block)
+    platform.confirm(response, frame, &block)
+  end
+
+  #
+  # Override the normal prompt popup so it does not occur.
+  #
+  # @example
+  #   message = @popup.prompt("Some Value") do
+  #     @page.button_that_causes_prompt
+  #   end
+  #
+  # @param [string] the value returned to the caller of the prompt
+  # @param frame optional parameter used with the prompt is nested within a frame
+  # @param block a block that has the call that will cause the prompt to display
+  # @return [Hash] A has containing two keys - :message contains the prompt message and
+  # :default_value contains the default value for the prompt if provided
+  #
+  def prompt(answer, frame=nil, &block)
+    platform.prompt(answer, frame, &block)
+  end
+
+  #
+  # Execute javascript on the browser
+  #
+  # @example Get inner HTML of element
+  #   span = @page.span_element
+  #   @page.execute_script "return arguments[0].innerHTML", span
+  #   #=> "Span innerHTML"
+  #
+  def execute_script(script, *args)
+    args.map! { |e| e.kind_of?(PageObject::Elements::Element) ? e.element : e }
+    platform.execute_script(script, *args)
+  end
+
+  #
+  # Identify an element as existing within a frame.  A frame parameter
+  # is passed to the block and must be passed to the other calls to PageObject.
+  # You can nest calls to in_frame by passing the frame to the next level.
+  #
+  # @example
+  #   in_frame(:id => 'frame_id') do |frame|
+  #     text_field_element(:id => 'fname', :frame => frame)
+  #   end
+  #
+  # @param [Hash] identifier how we find the frame.  The valid keys are:
+  #   * :id
+  #   * :index
+  #   * :name
+  #   * :class
+  # @param frame passed from a previous call to in_frame.  Used to nest calls
+  # @param block that contains the calls to elements that exist inside the frame.
+  #
+  def in_frame(identifier, frame=nil, &block)
+    platform.in_frame(identifier, frame, &block)
+  end
+
+  # Identify an element as existing within an iframe.  A frame parameter
+  # is passed to the block and must be passed to the other calls to PageObject.
+  # You can nest calls to in_iframe by passing the frame to the next level.
+  #
+  # @example
+  #   in_iframe(:id => 'iframe_id') do |iframe|
+  #     text_field_element(:id => 'ifname', :frame => iframe)
+  #   end
+  #
+  # @param [Hash] identifier how we find the iframe.  The valid keys are:
+  #   * :id
+  #   * :index
+  #   * :name
+  #   * :class
+  # @param frame passed from a previous call to in_iframe.  Used to nest calls
+  # @param block that contains the calls to elements that exist inside the iframe.
+  #
+  def in_iframe(identifier, frame=nil, &block)
+    platform.in_iframe(identifier, frame, &block)
+  end
+
+  #
+  # Override the normal showModalDialog call is it opens a window instead
+  # of a dialog.  You will need to attach to the new window in order to
+  # continue.
+  #
+  # @example
+  #   @page.modal_dialog do
+  #     @page.action_that_spawns_the_modal
+  #   end
+  #
+  # @param block a block that contains the call that will cause the modal dialog.
+  #
+  def modal_dialog(&block)
+    script =
+        %Q{
+      window.showModalDialog = function(sURL, vArguments, sFeatures) {
+        window.dialogArguments = vArguments;
+        modalWin = window.open(sURL, 'modal', sFeatures);
+        return modalWin;
+      }
+    }
+    browser.execute_script script
+    yield if block_given?
+  end
+
+  #
+  # Attach to a running window.  You can locate the window using either
+  # the window's title or url.  If it fails to connect to a window it will
+  # pause for 1 second and try again.
+  #
+  # @example
+  #     page.attach_to_window(:title => "other window's title")
+  #
+  # @param [Hash] either :title or :url of the other window.  The url does not need to
+  # be the entire url - it can just be the page name like index.html
+  # @param block if present the block is executed and then execution is returned to the
+  # calling window
+  #
+  def attach_to_window(identifier, &block)
+    begin
+      platform.attach_to_window(identifier, &block)
+    rescue
+      sleep 1
+      platform.attach_to_window(identifier, &block)
+    end
+  end
+
+  #
+  # Find the element that has focus on the page
+  #
+  def element_with_focus
+    platform.element_with_focus
+  end
+
+  #
+  # Refresh to current page
+  #
+  def refresh
+    platform.refresh
+  end
+
+  #
+  # Go back to the previous page
+  #
+  def back
+    platform.back
+  end
+
+  #
+  # Go forward to the next page
+  #
+  def forward
+    platform.forward
+  end
+
+  #
+  # Clear the cookies from the browser
+  #
+  def clear_cookies
+    platform.clear_cookies
+  end
+
+  #
+  # Save the current screenshot to the provided url.  File
+  # is saved as a png file.
+  #
+  def save_screenshot(file_name)
+    platform.save_screenshot file_name
+  end
+
+  #
+  # Check if root element exists and is visible
+  #
+  def present?
+    root.present?
+  end
+
+  def self.register_widget(widget_tag, widget_class, base_element_tag)
+    Widgets.register_widget(widget_tag, widget_class, base_element_tag)
+  end
+
+  private
+
+  def root
+    @root_element || PageObject::Platforms::Watir.browser_root_for(browser)
+  end
+
+  def call_block(&block)
+    block.arity == 1 ? block.call(self) : self.instance_eval(&block)
+  end
+end