selenium-client 1.2.15 → 1.2.16

data/README.markdown

@@ -81,7 +81,7 @@ Plain API
     # Sample Ruby script using the Selenium client API
     #
     require "rubygems"
-    gem "selenium-client", ">=1.2.15"
+    gem "selenium-client", ">=1.2.16"
     require "selenium/client"
     
     begin
@@ -114,7 +114,7 @@ Writing Tests
     #
     require "test/unit"
     require "rubygems"
-    gem "selenium-client", ">=1.2.15"
+    gem "selenium-client", ">=1.2.16"
     require "selenium/client"
     
     class ExampleTest < Test::Unit::TestCase
@@ -152,7 +152,7 @@ Writing Tests
 
     require 'rubygems'
     gem "rspec", "=1.2.6"
-    gem "selenium-client", ">=1.2.15"
+    gem "selenium-client", ">=1.2.16"
     require "selenium/client"
     require "selenium/rspec/spec_helper"
     
@@ -196,10 +196,11 @@ Start/Stop a Selenium Remote Control Server
 ===========================================
  
   Selenium client comes with some convenient Rake tasks to start/stop a Remote Control server.
-  To leverage all selenium-client capabilities I recommend downloading a recent nightly build of
-  a standalone packaging of Selenium Remote Control (great for kick-ass Safari and Firefox 3 support anyway).
-  You will find the mightly build at [OpenQA.org](http://archiva.openqa.org/repository/snapshots/org/openqa/selenium/selenium-remote-control/1.0-SNAPSHOT/)
- 
+  To leverage the latest selenium-client capabilities, you may need to download 
+  a recent nightly build of a standalone packaging of Selenium Remote 
+  Control. You will find the nightly build at 
+  http://nexus.openqa.org/content/repositories/snapshots/org/seleniumhq/selenium/server/selenium-server/
+
  You typically "freeze" the Selenium Remote Control jar in your `vendor` 
  directory.
  
@@ -302,6 +303,7 @@ Contributors
    - Support for locator including single quotes in `wait_for_...` methods
    - Do not capture system state on execution errors for pending examples
      (ExamplePendingError, NotYetImplementedError)
+   - Auto-highlighting support
 
 * Rick Lee-Morlang (`rleemorlang`):
    - Fix for incremental calls to `wait_for_text`
@@ -314,4 +316,4 @@ Contributors
 * [Adam Greene](http://blog.sweetspot.dm) (`skippy`)
    - Added the ability to redirect output to a log file, when
      launching Selenium Remote Control with the Rake task
-   
+   

data/examples/rspec/google_spec.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 gem "rspec", "=1.2.6"
-gem "selenium-client", ">=1.2.15"
+gem "selenium-client", ">=1.2.16"
 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.15"
+gem "selenium-client", ">=1.2.16"
 require "selenium/client"
 
 begin

data/examples/testunit/google_test.rb

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

data/lib/nautilus/shell.rb

@@ -19,7 +19,7 @@ module Nautilus
     end
             
     def windows?
-      PLATFORM['win32']
+      RUBY_PLATFORM =~ /mswin/
     end
     
     def sh(command)

data/lib/selenium/client/base.rb

@@ -9,7 +9,9 @@ module Selenium
       include Selenium::Client::Idiomatic
 
       attr_reader :host, :port, :browser_string, :browser_url, 
-                  :default_timeout_in_seconds, :default_javascript_framework
+                  :default_timeout_in_seconds, 
+                  :default_javascript_framework,
+                  :highlight_located_element_by_default
   
       #
       # Create a new client driver
@@ -34,6 +36,15 @@ module Selenium
       #     :url => "http://localhost:3000",
       #     :javascript_framework => :jquery
       #
+      # You can also enables automatic highlighting of located elements
+      # by passing the highlight_located_element option, e.g.
+      #
+      # Selenium::Client::Driver.new \
+      #     :host => "localhost",
+      #     :port => 4444,
+      #     :browser => "*firefox",
+      #     :highlight_located_element => true
+      #
       def initialize(*args)
         if args[0].kind_of?(Hash)
           options = args[0]
@@ -43,6 +54,7 @@ module Selenium
           @browser_url = options[:url]
           @default_timeout_in_seconds = (options[:timeout_in_seconds] || 300).to_i
           @default_javascript_framework = options[:javascript_framework] || :prototype
+          @highlight_located_element_by_default = options[:highlight_located_element] || false
         else
           @host = args[0]
           @port = args[1].to_i
@@ -50,6 +62,7 @@ module Selenium
           @browser_url = args[3]
           @default_timeout_in_seconds = (args[4] || 300).to_i
           @default_javascript_framework = :prototype
+          @highlight_located_element_by_default = false
         end
 
         @extension_js = ""
@@ -73,7 +86,8 @@ module Selenium
         @session_id = result
         # Consistent timeout on the remote control and driver side.
         # Intuitive and this is what you want 90% of the time
-        self.remote_control_timeout_in_seconds = @default_timeout_in_seconds 
+        self.remote_control_timeout_in_seconds = @default_timeout_in_seconds         
+        self.highlight_located_element = true if highlight_located_element_by_default
       end
       
       def close_current_browser_session
@@ -95,11 +109,8 @@ module Selenium
 
       def javascript_extension=(new_javascript_extension)
         @extension_js = new_javascript_extension
-	    end
-	
-      def set_extension_js(new_javascript_extension)
-	      javascript_extension = new_javascript_extension
       end
+	    alias :set_extension_js :javascript_extension=
       
     end
   

data/lib/selenium/client/extensions.rb

@@ -12,7 +12,7 @@ module Selenium
 		    builder = JavascriptExpressionBuilder.new active_javascript_framework(options)
 	      wait_for_condition builder.no_pending_ajax_requests.script, 
 	                         options[:timeout_in_seconds]
-	    end
+      end
 	
 	    # Wait for all Prototype effects to be processed (the wait in happenning browser side).
 	    #

data/lib/selenium/client/idiomatic.rb

@@ -366,9 +366,9 @@ module Selenium
       # 'optionsString' is options for the cookie. Currently supported options include 'path', 'max_age' and 'domain'.
       # the optionsString's format is "path=/path/, max_age=60, domain=.foo.com". The order of options are irrelevant, the unit      of the value of 'max_age' is second.  Note that specifying a domain that isn't a subset of the current domain will      usually fail.
       def create_cookie(name_value_pair, options="")
-	      if options.kind_of? Hash
+        if options.kind_of? Hash
 		      options = options.keys.collect {|key| "#{key}=#{options[key]}" }.sort.join(", ")
-		    end
+        end
         remote_control_command "createCookie", [name_value_pair,options,]
       end
 
@@ -386,10 +386,10 @@ module Selenium
       # 'name' is the name of the cookie to be deleted
       # 'optionsString' is options for the cookie. Currently supported options include 'path', 'domain'      and 'recurse.' The optionsString's format is "path=/path/, domain=.foo.com, recurse=true".      The order of options are irrelevant. Note that specifying a domain that isn't a subset of      the current domain will usually fail.
       def delete_cookie(name, options="")
-	      if options.kind_of? Hash
+        if options.kind_of? Hash
 		      ordered_keys = options.keys.sort {|a,b| a.to_s <=> b.to_s }
 		      options = ordered_keys.collect {|key| "#{key}=#{options[key]}" }.join(", ")
-		    end
+        end
         remote_control_command "deleteCookie", [name,options,]
       end
 
@@ -442,7 +442,31 @@ module Selenium
         remote_control_command "useXpathLibrary", [library_name.to_s]
       end
 
+      #
+      # Turn on/off the automatic hightlighting of the element driven or
+      # inspected by Selenium core. Useful when recording videos
+      #
+      def highlight_located_element=(enabled)
+        boolean = (true == enabled)
+        js_eval "selenium.browserbot.shouldHighlightLocatedElement = #{boolean}"
+      end
+
+      # Get execution delay in milliseconds, i.e. a pause delay following 
+      # each selenium operation. By default, there is no such delay 
+      # (value is 0).
+      def execution_delay
+        string_command "getSpeed"
+      end
+
+      # Set the execution delay in milliseconds, i.e. a pause delay following
+      # each selenium operation. By default, there is no such delay.
+      #
+      # Setting an execution can be useful to troubleshoot of capture videos
+      def execution_delay=(delay_in_milliseconds)
+        remote_control_command "setSpeed", [delay_in_milliseconds]
+      end
+
     end
-  
+
   end
 end

data/lib/selenium/client/javascript_expression_builder.rb

@@ -7,7 +7,7 @@ module Selenium
       def initialize(javascript_framework_name=nil)
         @framework = javascript_framework_for(javascript_framework_name) if javascript_framework_name       
         @script = ""
-	    end
+      end
 	    
 	    def append(text)
 	      @script << text

data/lib/selenium/client/selenium_helper.rb

@@ -5,7 +5,7 @@
 module Selenium
   module Client
     
-  module SeleniumHelper
+    module SeleniumHelper
     
       # Overrides default open method to actually delegates to @selenium
       def open(url)

data/lib/selenium/rake/remote_control_start_task.rb

@@ -18,10 +18,10 @@ module Selenium
     # it will be "auto-discovered" in `vendor` directory using the following
     # path : `vendor/selenium-remote-control/selenium-server*-standalone.jar`
     # 
-    # To leverage all selenium-client capabilities I recommend downloading 
+    # To leverage the latest selenium-client capabilities, you may need to download 
     # a recent nightly build of a standalone packaging of Selenium Remote 
-    # Control. You will find the mightly build at 
-    # http://archiva.openqa.org/repository/snapshots/org/openqa/selenium/selenium-remote-control/1.0-SNAPSHOT/
+    # Control. You will find the nightly build at 
+    # http://nexus.openqa.org/content/repositories/snapshots/org/seleniumhq/selenium/server/selenium-server/
     class RemoteControlStartTask
       attr_accessor :port, :timeout_in_seconds, :background, 
                     :wait_until_up_and_running, :additional_args,
@@ -49,7 +49,7 @@ module Selenium
         desc "Launch Selenium Remote Control"
         task @name do
           puts "Starting Selenium Remote Control at 0.0.0.0:#{@port}..."
-          remote_control = Selenium::RemoteControl::RemoteControl.new("0.0.0.0", @port, @timeout_in_seconds)
+          remote_control = Selenium::RemoteControl::RemoteControl.new("0.0.0.0", @port, :timeout => @timeout_in_seconds)
           remote_control.jar_file = @jar_file
           remote_control.additional_args = @additional_args
           remote_control.log_to = @log_to

data/lib/selenium/rake/remote_control_stop_task.rb

@@ -10,13 +10,15 @@ module Selenium
     # end
     #    
     class RemoteControlStopTask
-      attr_accessor :host, :port, :timeout_in_seconds, :wait_until_stopped
+      attr_accessor :host, :port, :timeout_in_seconds, :wait_until_stopped,
+                    :shutdown_command
 
       def initialize(name = :'selenium:rc:stop')
         @host = "localhost"
         @name = name
         @port = 4444
-        @timeout_in_seconds = 5
+        @timeout_in_seconds = nil
+        @shutdown_command = nil
         @wait_until_stopped = true
         yield self if block_given?
         define
@@ -25,13 +27,15 @@ module Selenium
       def define
         desc "Stop Selenium Remote Control running"
         task @name do
-          puts "Stopping Selenium Remote Control running at #{@host}:#{@port}..."
-          remote_control = Selenium::RemoteControl::RemoteControl.new(@host, @port, @timeout_in_seconds)
+          puts "Stopping Selenium Remote Control running at #{host}:#{port}..."
+          remote_control = Selenium::RemoteControl::RemoteControl.new(
+              host, port, :timeout => timeout_in_seconds,
+              :shutdown_command => shutdown_command)
           remote_control.stop
           if @wait_until_stopped
-            TCPSocket.wait_for_service_termination :host => @host, :port => @port
+            TCPSocket.wait_for_service_termination :host => host, :port => port
           end
-          puts "Stopped Selenium Remote Control running at #{@host}:#{@port}"
+          puts "Stopped Selenium Remote Control running at #{host}:#{port}"
         end
       end
 

data/lib/selenium/remote_control/remote_control.rb

@@ -2,11 +2,13 @@ module Selenium
   module RemoteControl
     
     class RemoteControl
-      attr_reader :host, :port, :timeout_in_seconds
+      attr_reader :host, :port, :timeout_in_seconds, :shutdown_command
       attr_accessor :additional_args, :jar_file, :log_to
       
-      def initialize(host, port, timeout_in_seconds = 2 * 60)
-        @host, @port, @timeout_in_seconds = host, port, timeout_in_seconds
+      def initialize(host, port, options={})
+        @host, @port = host, port
+        @timeout_in_seconds = options[:timeout] || (2 * 60)
+        @shutdown_command = options[:shutdown_command] || "shutDownSeleniumServer"
         @additional_args = []
         @shell = Nautilus::Shell.new
       end
@@ -22,7 +24,7 @@ module Selenium
       end
       
       def stop
-        Net::HTTP.get(@host, '/selenium-server/driver/?cmd=shutDown', @port)
+        Net::HTTP.get(@host, "/selenium-server/driver/?cmd=#{shutdown_command}", @port)
       end
       
     end

data/test/all_unit_tests.rb

@@ -1,3 +1,3 @@
-Dir["#{File.dirname __FILE__}/unit/**/*_test.rb"].each do |test_case|
+Dir["#{File.dirname __FILE__}/unit/**/*_tests.rb"].each do |test_case|
   require test_case
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: selenium-client
 version: !ruby/object:Gem::Version 
-  version: 1.2.15
+  version: 1.2.16
 platform: ruby
 authors: 
 - OpenQA
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-12 00:00:00 -07:00
+date: 2009-06-20 00:00:00 -07:00
 default_executable: 
 dependencies: []