RubyGems - page-object - Versions diffs - 0.6.1 → 0.6.2 - Mend

page-object 0.6.1 → 0.6.2

Files changed (31) hide show

data/ChangeLog +11 -0
data/features/html/nested_elements.html +20 -0
data/features/javascript.feature +14 -0
data/features/nested_elements.feature +11 -0
data/features/sample-app/public/jquery-1.3.2.js +4376 -0
data/features/sample-app/public/jquery.html +30 -0
data/features/sample-app/public/prototype-1.6.0.3.js +4320 -0
data/features/sample-app/public/prototype.html +34 -0
data/features/sample-app/sample_app.rb +36 -0
data/features/step_definitions/javascript_steps.rb +30 -0
data/features/step_definitions/nested_elements_steps.rb +15 -0
data/features/support/ajax_text_environment.rb +26 -0
data/lib/page-object.rb +45 -1
data/lib/page-object/javascript/jquery.rb +14 -0
data/lib/page-object/javascript/prototype.rb +14 -0
data/lib/page-object/javascript_framework_facade.rb +76 -0
data/lib/page-object/platforms/selenium_webdriver/ordered_list.rb +10 -4
data/lib/page-object/platforms/selenium_webdriver/unordered_list.rb +10 -4
data/lib/page-object/platforms/watir_webdriver/ordered_list.rb +8 -5
data/lib/page-object/platforms/watir_webdriver/page_object.rb +1 -1
data/lib/page-object/platforms/watir_webdriver/select_list.rb +1 -1
data/lib/page-object/platforms/watir_webdriver/text_area.rb +1 -1
data/lib/page-object/platforms/watir_webdriver/unordered_list.rb +8 -5
data/lib/page-object/version.rb +1 -1
data/page-object.gemspec +3 -2
data/spec/page-object/elements/ordered_list_spec.rb +26 -15
data/spec/page-object/elements/select_list_spec.rb +1 -0
data/spec/page-object/elements/unordered_list_spec.rb +22 -10
data/spec/page-object/javascript_framework_facade_spec.rb +61 -0
data/spec/page-object/page-object_spec.rb +26 -1
metadata +46 -14

data/features/sample-app/public/prototype.html ADDED

@@ -0,0 +1,34 @@
+<htmL>
+<head>
+  <title>Prototype - Sample App</title>
+  <script type="application/x-javascript" src="/prototype-1.6.0.3.js"></script>
+</head>
+<body>
+  <div id="ajax-demo">
+    <h2>AJAX Calculator</h2>
+    <form id="calculator-form" action="#" method="post" onSubmit="return false;">
+      <input id="calculator-expression" name="calculator-expression"/>
+      <input type="submit" id="calculator-button" value="Compute" />
+      <br/><br/>
+      <div>Result: <input id="calculator-result" disabled /></div>
+    </form>
+    <script type="text/javascript" language="javascript">
+      Event.observe(window, 'load', function() {
+        Event.observe('calculator-button', 'click', function (event) {
+          new Ajax.Request('/compute', {
+              method: 'post',
+              parameters: $('calculator-form').serialize(true),
+              onSuccess: function(transport) {
+                $('calculator-result').value = transport.responseText;
+              },
+          });
+          return false;
+        });
+      });
+    </script>
+  </div>
+</body>

data/features/sample-app/sample_app.rb ADDED

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rack'
+require 'webrick'
+class SampleApp
+  def self.start(host, port)
+    Rack::Handler::WEBrick.run(new,
+                               :Host => host,
+                               :Port => port,
+                               :Logger => ::WEBrick::Log.new('/dev/null'),
+                               :AccessLog => [nil, nil],)
+  end
+  def initialize
+    @public = Rack::File.new(File.expand_path("../public", __FILE__))
+  end
+  def call(env)
+    req = Rack::Request.new(env)
+    case req.path
+    when "/"
+      [200, {}, ["Sample Application"]]
+    when "/compute"
+      sleep 3
+      resp = eval(req.params['calculator-expression']).to_s
+      [200, {}, [resp]]
+    else
+      @public.call(env)
+    end
+  end
+end

data/features/step_definitions/javascript_steps.rb ADDED

@@ -0,0 +1,30 @@
+class JavascriptPage
+  include PageObject
+  text_field(:expression, :id => 'calculator-expression')
+  text_field(:results, :id => 'calculator-result')
+  button(:compute, :value => 'Compute')
+end
+Given /^I am on jQuery example page$/ do
+  PageObject.javascript_framework = :jquery
+  @page = JavascriptPage.new(@browser)
+  @page.navigate_to "http://localhost:4567/jquery.html"
+end
+Given /^I am on the Prototype example page$/ do
+  PageObject.javascript_framework = :prototype
+  @page = JavascriptPage.new(@browser)
+  @page.navigate_to "http://localhost:4567/prototype.html"
+end
+When /^I ask to compute "([^\"]*)"$/ do |expression|
+  @page.expression = expression
+  @page.compute
+end
+Then /^I should be able to wait for the answer "([^\"]*)"$/ do |answer|
+  @page.wait_for_ajax
+  @page.results.should == answer
+end

data/features/step_definitions/nested_elements_steps.rb CHANGED

@@ -27,6 +27,9 @@ class NestedElementsPage
   h6(:nested_h6) { |page| page.outer_div_element.h6_element }
   paragraph(:nested_paragraph) { |page| page.outer_div_element.paragraph_element }
   file_field(:nested_file_field) { |page| page.outer_div_element.file_field_element }
+  unordered_list(:outer_list, :id => 'outer')
+  ordered_list(:ordered_outer, :id => 'ol-outer')
 end
 Given /^I am on the nested elements page$/ do
@@ -195,3 +198,15 @@ end
 Then /^I should be able to set the nested file field$/ do
   @ff.value = __FILE__
 end
+When /^I get the outter unordered list$/ do
+  @list = @page.outer_list_element
+end
+When /^I get the outter ordered list$/ do
+  @list = @page.ordered_outer_element
+end
+Then /^I should see "([^\"]*)" for list item (\d+)$/ do |text, item_number|
+  @list[item_number.to_i - 1].text.should == text
+end

data/features/support/ajax_text_environment.rb ADDED

@@ -0,0 +1,26 @@
+require_relative "../sample-app/sample_app"
+class AjaxTestEnvironment
+  def run
+    Thread.abort_on_exception = true
+    @example_app = Thread.new { SampleApp.start("127.0.0.1", 4567) }
+    poller = Selenium::WebDriver::SocketPoller.new("127.0.0.1", 4567, 60)
+    unless poller.connected?
+      raise "timed out waiting for SampleApp to launch"
+    end
+    self
+  end
+  def stop
+    @example_app.kill
+  end
+end
+@server = AjaxTestEnvironment.new
+@server.run
+at_exit do
+  @server.stop
+end

data/lib/page-object.rb CHANGED

@@ -4,7 +4,9 @@ require 'page-object/platforms'
 require 'page-object/element_locators'
 require 'page-object/nested_elements'
 require 'page-object/page_populator'
+require 'page-object/javascript_framework_facade'
+require 'selenium/webdriver/common/error'
 #
 # 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
@@ -62,6 +64,29 @@ module PageObject
     cls.extend PageObject::Accessors
   end
+  #
+  # Set the javascript framework to use when determining number of
+  # ajax requests.  Valid frameworks are :jquery, :prototype, and
+  # :dojo
+  #
+  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
   #
@@ -115,6 +140,25 @@ module PageObject
     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 occurr.
   #
@@ -277,6 +321,6 @@ module PageObject
   end
   def call_block(&block)
-      block.arity == 1 ? block.call(self) : self.instance_eval(&block)
+    block.arity == 1 ? block.call(self) : self.instance_eval(&block)
   end
 end

data/lib/page-object/javascript/jquery.rb ADDED

@@ -0,0 +1,14 @@
+module PageObject
+  module Javascript
+    module JQuery
+      #
+      # return the number of pending ajax requests
+      #
+      def self.pending_requests
+        'return jQuery.active'
+      end
+    end
+  end
+end

data/lib/page-object/javascript/prototype.rb ADDED

@@ -0,0 +1,14 @@
+module PageObject
+  module Javascript
+    module Prototype
+      #
+      # return the number of pending ajax requests
+      #
+      def self.pending_requests
+        'return Ajax.activeRequestCount'
+      end
+    end
+  end
+end

data/lib/page-object/javascript_framework_facade.rb ADDED

@@ -0,0 +1,76 @@
+require 'page-object/javascript/jquery'
+require 'page-object/javascript/prototype'
+module PageObject
+  #
+  # Provide hooks into different common Javascript Frameworks.
+  # Currently this module only supports jQuery and Prototype but it
+  # has the ability for you to plug your own framework into it and
+  # therefore have it work with this gem.  You do this by calling the
+  # #add_framework method.  The module you provide must implement the
+  # necessary methods.  Please look at the jQuery or Prototype
+  # implementations to determine the necessary methods
+  #
+  module JavascriptFrameworkFacade
+    class << self
+      #
+      # Set the framework to use.
+      #
+      # @param[Symbol] the framework to use.  :jquery and :prototype
+      # are supported
+      #
+      def framework=(framework)
+        initialize_script_builder unless @builder
+        raise unknown_framework(framework) unless @builder[framework]
+        @framework = framework
+      end
+      #
+      # Get the framework that will be used
+      #
+      def framework
+        @framework
+      end
+      #
+      # Add a framework and make it available to the system.
+      #
+      def add_framework(key, value)
+        raise invalid_framework unless value.respond_to? :pending_requests
+        initialize_script_builder unless @builder
+        @builder[key] = value
+      end
+      #
+      # get the javascript to determine number of pending requests
+      #
+      def pending_requests
+        script_builder.pending_requests
+      end
+      def script_builder
+        initialize_script_builder unless @builder
+        @builder[@framework]
+      end
+      private
+      def initialize_script_builder
+        @builder = {
+          :jquery => ::PageObject::Javascript::JQuery,
+          :prototype => ::PageObject::Javascript::Prototype,
+        }
+      end
+      def unknown_framework(framework)
+        "You specified the Javascript framework #{framework} and it is unknow to the system"
+      end
+      def invalid_framework
+        "The Javascript framework you provided does not implement the necessary methods"
+      end
+    end
+  end
+end

data/lib/page-object/platforms/selenium_webdriver/ordered_list.rb CHANGED

@@ -10,19 +10,25 @@ module PageObject
         # @return [PageObject::Elements::ListItem]
         #
         def [](idx)
-          eles = list_items
-          Object::PageObject::Elements::ListItem.new(eles[idx], :platform => :selenium_webdriver)
+          children[idx]
         end
         #
         # Return the number of items contained in the ordered list
         #
         def items
-          list_items.size
+          children.size
         end
         private
+        def children
+          items = list_items.map do |item|
+            ::PageObject::Elements::ListItem.new(item, :platform => :selenium_webdriver)
+          end
+          items.find_all { |item| item.parent.element == element }
+        end
         def list_items
           element.find_elements(:xpath, child_xpath)
         end
@@ -30,4 +36,4 @@ module PageObject
       end
     end
   end
-end
+end

data/lib/page-object/platforms/selenium_webdriver/unordered_list.rb CHANGED

@@ -10,19 +10,25 @@ module PageObject
         # @return [PageObject::Elements::ListItem]
         #
         def [](idx)
-          eles = list_items
-          Object::PageObject::Elements::ListItem.new(eles[idx], :platform => :selenium_webdriver)
+          children[idx]
         end
         #
         # Return the number of items contained in the unordered list
         #
         def items
-          list_items.size
+          children.size
         end
         private
+        def children
+          items = list_items.map do |item|
+            ::PageObject::Elements::ListItem.new(item, :platform => :selenium_webdriver)
+          end
+          items.find_all { |item| item.parent.element == element }
+        end
         def list_items
           element.find_elements(:xpath, child_xpath)
         end
@@ -30,4 +36,4 @@ module PageObject
       end
     end
   end
-end
+end

data/lib/page-object/platforms/watir_webdriver/ordered_list.rb CHANGED

@@ -10,23 +10,26 @@ module PageObject
         # @return [PageObject::Elements::ListItem]
         #
         def [](idx)
-          eles = list_items
-          Object::PageObject::Elements::ListItem.new(eles[idx], :platform => :watir_webdriver)
+          Object::PageObject::Elements::ListItem.new(children[idx], :platform => :watir_webdriver)
         end
         #
         # Return the number of items contained in the ordered list
         #
         def items
-          list_items.size
+          children.size
         end
         private
+        def children
+          list_items.find_all { |item| item.parent == element }
+        end
         def list_items
-          element.wd.find_elements(:xpath, child_xpath)
+          element.ols(:xpath => child_xpath)
         end
       end
     end
   end
-end
+end

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

@@ -154,7 +154,7 @@ module PageObject
         # See PageObject#clear_cookies
         #
         def clear_cookies
-          @browser.clear_cookies
+          @browser.cookies.clear
         end
         #