selenium-client 1.2.12 → 1.2.13

data/README.markdown

@@ -38,8 +38,10 @@ Features
   * `click 'the_button_id', :wait_for => :element, :element => 'new_element_id'`
   * `click 'the_button_id', :wait_for => :no_element, :element => 'disappearing_element_id'`
   * `click 'the_button_id', :wait_for => :text, :text => 'New Text'`
+  * `click 'the_button_id', :wait_for => :text, :text => /A Regexp/`
   * `click 'the_button_id', :wait_for => :text, :element => 'notification_box', :text => 'New Text'`
   * `click 'the_button_id', :wait_for => :no_text, :text => 'Disappearing Text'`
+  * `click 'the_button_id', :wait_for => :no_text, :text => /A Regexp/`
   * `click 'the_button_id', :wait_for => :no_text, :element => 'notification_box', :text => 'Disappearing Text'`
   * `click 'the_button_id', :wait_for => :effects`
   * `click 'the_button_id', :wait_for => :value, :element => 'a_locator', :value => 'some value'`
@@ -78,7 +80,7 @@ Plain API
     # Sample Ruby script using the Selenium client API
     #
     require "rubygems"
-    gem "selenium-client", ">=1.2.11"
+    gem "selenium-client", ">=1.2.13"
     require "selenium/client"
     
     begin
@@ -111,7 +113,7 @@ Writing Tests
     #
     require "test/unit"
     require "rubygems"
-    gem "selenium-client", ">=1.2.11"
+    gem "selenium-client", ">=1.2.13"
     require "selenium/client"
     
     class ExampleTest < Test::Unit::TestCase
@@ -149,7 +151,7 @@ Writing Tests
 
     require 'rubygems'
     gem "rspec", "=1.1.12"
-    gem "selenium-client", ">=1.2.11"
+    gem "selenium-client", ">=1.2.13"
     require "selenium/client"
     require "selenium/rspec/spec_helper"
     
@@ -260,14 +262,29 @@ Contribute and Join the Fun!
   envision!
   
 * I recommend cloning the selenium-client [reference repository](http://github.com/ph7/selenium-client/tree/master)
-  I you are more of a SVN guy, the same code also lives at [OpenQA](http://svn.openqa.org/svn/selenium-rc/trunk/clients/ruby)
   
 * You can also check out the [RubyForge page](http://rubyforge.org/projects/selenium-client) and the [RDoc](http://selenium-client.rubyforge.org)
   
 * We also have a [continuous integration server](http://xserve.openqa.org:8080/view/Ruby%20Client)
 
+* Stories live in [Pivotal Tracker](https://www.pivotaltracker.com/projects/6280)
 
+Core Team
+=========
+
+* Philippe Hanrigou (`ph7`): Current Maintainer and main contributor
+* Aslak Hellesoy and Darren Hobbs : Original version of the Selenium Ruby driver
+
+Contributors
+============
   
+* Aaron Tinio (`aptinio`):
+   - Patch for more robust Selenium RC shutdown
+   - Patch to support locator including single quotes in `wait_for_...` methods
+
+* Rick Lee-Morlang (`rleemorlang`):
+   - Patch for incremental calls to `wait_for_text`
+   - Regex support in `wait_for_text`
+
   
  
- 

data/examples/rspec/google_spec.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 gem "rspec", "=1.1.12"
-gem "selenium-client", ">=1.2.12"
+gem "selenium-client", ">=1.2.13"
 require "selenium/client"
 require "selenium/rspec/spec_helper"
 

data/examples/script/google.rb

@@ -3,7 +3,7 @@
 # Sample Ruby script using the Selenium client API
 #
 require "rubygems"
-gem "selenium-client", ">=1.2.12"
+gem "selenium-client", ">=1.2.13"
 require "selenium/client"
 
 begin

data/examples/testunit/google_test.rb

@@ -4,7 +4,7 @@
 #
 require "test/unit"
 require "rubygems"
-gem "selenium-client", ">=1.2.12"
+gem "selenium-client", ">=1.2.13"
 require "selenium/client"
 
 class ExampleTest < Test::Unit::TestCase

data/lib/selenium/client.rb

@@ -13,8 +13,9 @@ require File.expand_path(File.dirname(__FILE__) + '/command_error')
 require File.expand_path(File.dirname(__FILE__) + '/protocol_error')
 require File.expand_path(File.dirname(__FILE__) + '/client/protocol')
 require File.expand_path(File.dirname(__FILE__) + '/client/generated_driver')
-require File.expand_path(File.dirname(__FILE__) + '/client/javascript_frameworks/jquery')
+require File.expand_path(File.dirname(__FILE__) + '/client/javascript_expression_builder')
 require File.expand_path(File.dirname(__FILE__) + '/client/javascript_frameworks/prototype')
+require File.expand_path(File.dirname(__FILE__) + '/client/javascript_frameworks/jquery')
 require File.expand_path(File.dirname(__FILE__) + '/client/extensions')
 require File.expand_path(File.dirname(__FILE__) + '/client/idiomatic')
 require File.expand_path(File.dirname(__FILE__) + '/client/base')

data/lib/selenium/client/extensions.rb

@@ -9,8 +9,8 @@ module Selenium
 	    # See http://davidvollbracht.com/2008/6/4/30-days-of-tech-day-3-waitforajax for
 	    # more background.
       def wait_for_ajax(options={})
-        framework = javascript_framework_for(options[:javascript_framework] || default_javascript_framework)
-	      wait_for_condition window_script("#{framework.ajax_request_tracker} == 0"), 
+		    builder = JavascriptExpressionBuilder.new active_javascript_framework(options)
+	      wait_for_condition builder.no_pending_ajax_requests.script, 
 	                         options[:timeout_in_seconds]
 	    end
 	
@@ -18,111 +18,88 @@ module Selenium
 	    #
 	    # Credits to http://github.com/brynary/webrat/tree/master
 			def wait_for_effects(options={})
-			  wait_for_condition window_script("Effect.Queue.size() == 0"), 
+		    builder = JavascriptExpressionBuilder.new active_javascript_framework(options)
+			  wait_for_condition builder.no_pending_effects.script,
 			                     options[:timeout_in_seconds]
 			end
 			
 			# Wait for an element to be present (the wait in happenning browser side).
 		  def wait_for_element(locator, options={})
-		    wait_for_condition find_element_script(locator, "element != null"), 
-		                       options[:timeout_in_seconds]
+		    builder = JavascriptExpressionBuilder.new 
+		    builder.find_element(locator).append("element != null;")
+		    wait_for_condition builder.script, options[:timeout_in_seconds]
 		  end
 
 			# Wait for an element to NOT be present (the wait in happenning browser side).
 		  def wait_for_no_element(locator, options={})
-		    wait_for_condition find_element_script(locator, "element == null"), 
-		                       options[:timeout_in_seconds]
+		    builder = JavascriptExpressionBuilder.new 
+		    builder.find_element(locator).append("element == null;")
+		    wait_for_condition builder.script, options[:timeout_in_seconds]
 		  end
 
-			# Wait for some text to be present (the wait in happenning browser side).
+			# Wait for some text to be present (the wait is happening browser side).
 			#
-			# If locator is nil or no locator is provided, the text will be
-			# detected anywhere in the page.
-			#
-			# If a non nil locator is provided, the text will be
-			# detected within the innerHTML of the element identified by the locator.			
-		  def wait_for_text(text, options={})
-        script = options[:element].nil? ?
-                 find_text_script(text, "text != null && text != false") :
-                 find_element_script(options[:element], 
-                    "element != null && element.innerHTML == '#{quote_escaped(text)}'")
-
-		    wait_for_condition script, options[:timeout_in_seconds]
-		  end
-
-			# Wait for some text to NOT be present (the wait in happenning browser side).
-			#
-			# If locator is nil or no locator is provided, the text will be
-			# detected anywhere in the page.
-			#
-			# If a non nil locator is provided, the text will be
-			# detected within the innerHTML of the element identified by the locator.			
-		  def wait_for_no_text(original_text, options={})
-        script = options[:element].nil? ?
-                 find_text_script(original_text, "(text == false || text == null)") :
-                 find_element_script(options[:element], 
-                    "(element == null || element.innerHTML != '#{quote_escaped(original_text)}')")
-        wait_for_condition script, options[:timeout_in_seconds]
-		  end
+      # wait_for_text will search for the given argument within the innerHTML
+      # of the current DOM. Note that this method treats a single string
+      # as a special case.
+      #
+      # ==== Parameters
+      # wait_for_text accepts an optional hash of parameters:
+      # * <tt>:element</tt> - a selenium locator for an element limiting 
+      #   the search scope.
+      # * <tt>:timeout_in_seconds</tt> - duration in seconds after  which we
+      #   time out if text cannot be found.
+      # 
+      # ==== Regular Expressions
+      # In addition to plain strings, wait_for_text accepts regular expressions
+      # as the pattern specification.
+      # 
+      # ==== Examples
+      # The following are equivalent, and will match "some text" anywhere
+      # within the document:
+      #   wait_for_text "some text"
+      #   wait_for_text /some text/
+      #
+      # This will match "some text" anywhere within the specified element:
+      #   wait_for_text /some text/, :element => "container"
+      #
+      # This will match "some text" only if it exactly matches the complete
+      # innerHTML of the specified element: 
+      #   wait_for_text "some text", :element => "container"
+      #
+      def wait_for_text(pattern, options={})
+        builder = JavascriptExpressionBuilder.new 
+		    builder.find_text(pattern, options).append("text_match == true;")
+        wait_for_condition builder.script, options[:timeout_in_seconds]
+      end
+      
+      # Wait for some text to NOT be present (the wait in happenning browser side).
+      #
+      # See wait_for_text for usage details.
+      def wait_for_no_text(pattern, options={})
+        builder = JavascriptExpressionBuilder.new 
+		    builder.find_text(pattern, options).append("text_match == false;")
+        wait_for_condition builder.script, options[:timeout_in_seconds]
+      end
 
 			# Wait for a field to get a specific value (the wait in happenning browser side).
       def wait_for_field_value(locator, expected_value, options={})
-        script = find_element_script(locator, 
-            "(element != null && element.value == '#{quote_escaped(expected_value)}')")
-        wait_for_condition script, options[:timeout_in_seconds]
+        builder = JavascriptExpressionBuilder.new 
+        builder.find_element(locator).element_value_is(expected_value)
+        wait_for_condition builder.script, options[:timeout_in_seconds]
       end
 
       def wait_for_no_field_value(locator, expected_value, options={})
-        script = find_element_script(locator, 
-            "(element == null || element.value != '#{quote_escaped(expected_value)}')")
-        wait_for_condition script, options[:timeout_in_seconds]
-      end
-
-      def javascript_framework_for(framework_name)
-        case framework_name.to_sym
-        when :prototype
-          JavascriptFrameworks::Prototype
-        when :jquery
-          JavascriptFrameworks::JQuery
-        else
-          raise "Unsupported Javascript Framework: #{framework_name}"
-        end
-      end
-
-      def find_element_script(locator, return_value)
-        script = <<-EOS
-          var element;
-
-          try {
-            element = selenium.browserbot.findElement('#{quote_escaped(locator)}');
-          } catch(e) {
-            element = null;
-          }
-          #{return_value};
-        EOS
-      end
-
-      def find_text_script(text, return_value)
-        script = <<-EOS
-          var text;
-
-          try {
-            text = selenium.browserbot.getCurrentWindow().find('#{quote_escaped(text)}');
-          } catch(e) {
-            text = null;
-          }
-          #{return_value};
-        EOS
+        builder = JavascriptExpressionBuilder.new 
+        builder.find_element(locator).element_value_is_not(expected_value)
+        wait_for_condition builder.script, options[:timeout_in_seconds]
       end
 
-      def window_script(expression)
-        "selenium.browserbot.getCurrentWindow().#{expression};"
-      end
-
-      def quote_escaped(a_string)
-        a_string.gsub(/'/, %q<\\\'>)
+      def active_javascript_framework(options)
+        options[:javascript_framework] || default_javascript_framework
       end
 
     end
+
   end
 end

data/lib/selenium/client/idiomatic.rb

@@ -67,8 +67,10 @@ module Selenium
       # * wait :wait_for => :element, :element => 'new_element_id'                     # will wait for an element to be present/appear
       # * wait :wait_for => :no_element, :element => 'new_element_id'                  # will wait for an element to be not be present/disappear
       # * wait :wait_for => :text, :text => 'some text'                                # will wait for some text to be present/appear
+      # * wait :wait_for => :text, :text => /A Regexp/                                 # will wait for some text to be present/appear
       # * wait :wait_for => :text, :element => 'a_locator', :text => 'some text'       # will wait for the content of 'a_locator' to be 'some text'
       # * wait :wait_for => :no_text, :text => 'some text'                             # will wait for the text to be not be present/disappear
+      # * wait :wait_for => :no_text, :text => /A Regexp/                              # will wait for the text to be not be present/disappear
       # * wait :wait_for => :no_text, :element => 'a_locator', :text => 'some text'    # will wait for the content of 'a_locator' to not be 'some text'
       # * wait :wait_for => :value, :element => 'a_locator', :value => 'some value'    # will wait for the field value of 'a_locator' to be 'some value'
       # * wait :wait_for => :no_value, :element => 'a_locator', :value => 'some value' # will wait for the field value of 'a_locator' to not be 'some value'
@@ -124,8 +126,10 @@ module Selenium
       # * click "a_locator", :wait_for => :element, :element => 'new_element_id'                     # will wait for an element to be present/appear
       # * click "a_locator", :wait_for => :no_element, :element => 'new_element_id'                  # will wait for an element to be not be present/disappear
       # * click "a_locator", :wait_for => :text, :text => 'some text'                                # will wait for some text to be present/appear
+      # * click "a_locator", :wait_for => :text, :text => /A Regexp/                                 # will wait for some text to be present/appear
       # * click "a_locator", :wait_for => :text, :element => 'a_locator', :text => 'some text'       # will wait for the content of 'a_locator' to be 'some text'
       # * click "a_locator", :wait_for => :no_text, :text => 'some text'                             # will wait for the text to be not be present/disappear
+      # * click "a_locator", :wait_for => :no_text, :text => /A Regexp/                              # will wait for the text to be not be present/disappear
       # * click "a_locator", :wait_for => :no_text, :element => 'a_locator', :text => 'some text'    # will wait for the content of 'a_locator' to not be 'some text'
       # * click "a_locator", :wait_for => :value, :element => 'a_locator', :value => 'some value'    # will wait for the field value of 'a_locator' to be 'some value'
       # * click "a_locator", :wait_for => :no_value, :element => 'a_locator', :value => 'some value' # will wait for the field value of 'a_locator' to not be 'some value'
@@ -320,8 +324,10 @@ module Selenium
       # * go_back :wait_for => :element, :element => 'new_element_id'                     # will wait for an element to be present/appear
       # * go_back :wait_for => :no_element, :element => 'new_element_id'                  # will wait for an element to be not be present/disappear
       # * go_back :wait_for => :text, :text => 'some text'                                # will wait for some text to be present/appear
+      # * go_back "a_locator", :wait_for => :text, :text => /A Regexp/                    # will wait for some text to be present/appear
       # * go_back :wait_for => :text, :element => 'a_locator', :text => 'some text'       # will wait for the content of 'a_locator' to be 'some text'
       # * go_back :wait_for => :no_text, :text => 'some text'                             # will wait for the text to be not be present/disappear
+      # * go_back "a_locator", :wait_for => :no_text, :text => /A Regexp/                 # will wait for the text to be not be present/disappear
       # * go_back :wait_for => :no_text, :element => 'a_locator', :text => 'some text'    # will wait for the content of 'a_locator' to not be 'some text'
       # * go_back :wait_for => :condition, :javascript => 'some expression'               # will wait for the javascript expression to be true
       # * go_back :wait_for => :value, :element => 'a_locator', :value => 'some value'    # will wait for the field value of 'a_locator' to be 'some value'

data/lib/selenium/client/javascript_expression_builder.rb

@@ -0,0 +1,108 @@
+module Selenium
+  module Client
+
+    class JavascriptExpressionBuilder
+      attr_reader :script
+	
+      def initialize(javascript_framework_name=nil)
+        @framework = javascript_framework_for(javascript_framework_name) if javascript_framework_name       
+        @script = ""
+	    end
+	    
+	    def append(text)
+	      @script << text
+	      self
+	    end
+  
+      def no_pending_ajax_requests
+        append window_script("#{@framework.ajax_request_tracker} == 0")
+      end
+
+			def no_pending_effects
+			  append window_script("Effect.Queue.size() == 0")
+			end
+
+      def find_element(locator)
+        append  <<-EOS
+          var element;
+
+          try {
+            element = selenium.browserbot.findElement('#{quote_escaped(locator)}');
+          } catch(e) {
+            element = null;
+          }
+        EOS
+      end
+   
+      def element_value_is(expected_value)
+        append "(element != null && element.value == '#{quote_escaped(expected_value)}')"
+      end
+
+      def element_value_is_not(expected_value)
+        append "(element == null || element.value != '#{quote_escaped(expected_value)}')"
+      end
+
+      def find_text(pattern, options)
+        if options[:element].nil?
+          find_text_in_document pattern, options
+        else
+          find_text_in_element pattern, options
+        end
+
+        self
+      end
+
+      def find_text_in_document(pattern, options)
+        js_regexp = case pattern
+        when Regexp
+          pattern.inspect
+        else
+          /#{pattern}/.inspect
+        end
+        append <<-EOS
+          var text_match;
+          text_match = (null != selenium.browserbot.getCurrentWindow().document.body.innerHTML.match(#{js_regexp}));
+        EOS
+        
+      end
+
+      def find_text_in_element(pattern, options)
+        find_element(options[:element])
+        append <<-EOS
+          var text_match;
+          text_match = (element != null && #{text_match(pattern)});
+        EOS
+        
+        self
+      end
+
+      def text_match(pattern)
+        case pattern
+        when Regexp
+          "null != element.innerHTML.match(#{pattern.inspect})"
+        else
+          "element.innerHTML == '#{quote_escaped(pattern)}'"
+        end
+      end
+
+      def javascript_framework_for(framework_name)
+        case framework_name.to_sym
+        when :prototype
+          JavascriptFrameworks::Prototype
+        when :jquery
+          JavascriptFrameworks::JQuery
+        else
+          raise "Unsupported Javascript Framework: #{framework_name}"
+        end
+      end
+
+      def window_script(expression)
+        "selenium.browserbot.getCurrentWindow().#{expression};"
+      end
+
+      def quote_escaped(a_string)
+        a_string.gsub(/'/, %q<\\\'>)
+      end
+    end
+  end
+end

data/lib/selenium/client/protocol.rb

@@ -83,6 +83,8 @@ module Selenium
       def http_post(data)
         # puts "Requesting ---> #{data.inspect}"
         http = Net::HTTP.new(@host, @port)
+        http.open_timeout = default_timeout_in_seconds
+        http.read_timeout = default_timeout_in_seconds
         response = http.post('/selenium-server/driver/', data, HTTP_HEADERS)
         # puts "RESULT: #{response.inspect}\n"       
         [ response.body[0..1], response.body[3..-1] ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: selenium-client
 version: !ruby/object:Gem::Version 
-  version: 1.2.12
+  version: 1.2.13
 platform: ruby
 authors: 
 - OpenQA
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-28 00:00:00 -08:00
+date: 2009-03-07 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -26,8 +26,8 @@ files:
 - lib/selenium/client/base.rb
 - lib/selenium/client/driver.rb
 - lib/selenium/client/extensions.rb
-- lib/selenium/client/generated_driver.rb
 - lib/selenium/client/idiomatic.rb
+- lib/selenium/client/javascript_expression_builder.rb
 - lib/selenium/client/javascript_frameworks/jquery.rb
 - lib/selenium/client/javascript_frameworks/prototype.rb
 - lib/selenium/client/protocol.rb