selenium-webdriver 2.8.0 → 2.9.0

data/CHANGES

@@ -1,3 +1,17 @@
+2.9.0 (2011-10-21)
+==================
+
+* Support file uploads to the remote server (see Selenium::WebDriver::DriverExtensions::UploadsFiles)
+* New exception: Selenium::WebDriver::Error::MoveTargetOutOfBoundsError
+* Implemented Chrome::Profile#add_extension
+* Better respect for preformatted text in Element#text
+* Reduced scrolling during tests for IE and Firefox.
+* Firefox:
+  * Support for experimental page load detection.
+* IE:
+  * Better detection of where to click on links (#2675).
+  * Improve handling of modal dialogs (showModalDialog).
+
 2.8.0 (2011-10-06)
 ==================
 

data/README

@@ -1,6 +1,6 @@
 = selenium-webdriver
 
-This gem provides Ruby bindings for WebDriver and has been tested to work on MRI (1.8.6 through 1.9), JRuby and Rubinius.
+This gem provides Ruby bindings for WebDriver and has been tested to work on MRI (1.8.7 through 1.9), JRuby and Rubinius.
 
 = INSTALL
 

data/lib/selenium/client/legacy_driver.rb

@@ -1,5 +1,5 @@
 
-# Copyright 2006 ThoughtWorks, Inc
+# Copyright 2011 Software Freedom Conservatory
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.

data/lib/selenium/webdriver/chrome/bridge.rb

@@ -66,10 +66,17 @@ module Selenium
             caps.merge! 'chrome.switches' => switches.map { |e| e.to_s }
           end
 
+          if profile
+            data = profile.as_json
+
+            caps.merge! 'chrome.profile'    => data['zip'],
+                        'chrome.extensions' => data['extensions']
+          end
+
+
           caps.merge! 'chrome.binary'       => Chrome.path if Chrome.path
           caps.merge! 'chrome.nativeEvents' => true if native_events
           caps.merge! 'chrome.verbose'      => true if verbose
-          caps.merge! 'chrome.profile'      => profile.as_json['zip'] if profile
           caps.merge! 'chrome.detach'       => detach.nil? || !!detach
         end
 

data/lib/selenium/webdriver/chrome/profile.rb

@@ -10,7 +10,16 @@ module Selenium
         include ProfileHelper
 
         def initialize(model = nil)
-          @model = verify_model(model)
+          @model      = verify_model(model)
+          @extensions = []
+        end
+
+        def add_extension(path)
+          unless File.file?(path)
+            raise Error::WebDriverError, "could not find extension at #{path.inspect}"
+          end
+
+          @extensions << path
         end
 
         #
@@ -38,6 +47,14 @@ module Selenium
           dir
         end
 
+        def as_json(opts = nil)
+          extensions = @extensions.map do |crx_path|
+            Base64.strict_encode64 File.read(crx_path)
+          end
+
+          super.merge('extensions' => extensions)
+        end
+
         private
 
         def write_prefs_to(dir)

data/lib/selenium/webdriver/common/driver_extensions/uploads_files.rb

@@ -0,0 +1,43 @@
+module Selenium
+  module WebDriver
+
+    #
+    # @api private
+    #
+
+    module DriverExtensions
+      module UploadsFiles
+
+        #
+        # Set the file detector to pass local files to a remote WebDriver.
+        #
+        # The detector is an object that responds to #call, and when called
+        # will determine if the given string represents a file. If it does,
+        # the path to the file on the local file system should be returned,
+        # otherwise nil or false.
+        #
+        # Example:
+        #
+        #     driver = Selenium::WebDriver.for :remote
+        #     driver.file_detector = lambda do |args|
+        #        # args => ["/path/to/file"]
+        #        str if File.exist?(args.first.to_s)
+        #     end
+        #
+        #     driver.find_element(:id => "upload").send_keys "/path/to/file"
+        #
+        # By default, no file detection is performed.
+        #
+
+        def file_detector=(detector)
+          unless detector.nil? or detector.respond_to? :call
+            raise ArgumentError, "detector must respond to #call"
+          end
+
+          bridge.file_detector = detector
+        end
+
+      end # UploadsFiles
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/element.rb

@@ -99,21 +99,7 @@ module Selenium
       #
 
       def send_keys(*args)
-        values = args.map do |arg|
-          case arg
-          when Symbol
-            Keys[arg]
-          when Array
-            arg = arg.map { |e| e.kind_of?(Symbol) ? Keys[e] : e }.join
-            arg << Keys[:null]
-
-            arg
-          else
-            arg.to_s
-          end
-        end
-
-        bridge.sendKeysToElement @id, values
+        bridge.sendKeysToElement @id, Keys.encode(args)
       end
       alias_method :send_key, :send_keys
 

data/lib/selenium/webdriver/common/error.rb

@@ -32,9 +32,12 @@ module Selenium
       class NoAlertOpenError < WebDriverError; end               # 27
       class ScriptTimeOutError < WebDriverError; end             # 28
       class InvalidElementCoordinatesError < WebDriverError; end # 29
-                                                                 # 30
-                                                                 # 31
+      class IMENotAvailableError < WebDriverError; end           # 30
+      class IMEEngineActivationFailedError < WebDriverError; end # 31
       class InvalidSelectorError < WebDriverError; end           # 32
+                                                                 # 33
+      class MoveTargetOutOfBoundsError < WebDriverError; end     # 34
+      
       class UnsupportedOperationError < WebDriverError; end
 
       Errors = [
@@ -67,9 +70,11 @@ module Selenium
         NoAlertOpenError,               # 27
         ScriptTimeOutError,             # 28
         InvalidElementCoordinatesError, # 29
-        nil,                            # 30
-        nil,                            # 31
-        InvalidSelectorError            # 32
+        IMENotAvailableError,           # 30
+        IMEEngineActivationFailedError, # 31
+        InvalidSelectorError,           # 32
+        nil,                            # 33
+        MoveTargetOutOfBoundsError      # 34
       ]
 
       class << self

data/lib/selenium/webdriver/common/keyboard.rb

@@ -9,6 +9,7 @@ module Selenium
       end
 
       def send_keys(*keys)
+        # TODO: use sendKeysToActiveElement
         @bridge.getActiveElement.send_keys(*keys)
       end
 
@@ -20,7 +21,9 @@ module Selenium
 
       def press(key)
         assert_modifier key
-        @bridge.sendModifierKeyToActiveElement Keys[key], true
+
+        # TODO: use sendKeysToActiveElement
+        @bridge.sendModifierKeyToActiveElement Keys.encode([key]), true
       end
 
       #
@@ -31,7 +34,9 @@ module Selenium
 
       def release(key)
         assert_modifier key
-        @bridge.sendModifierKeyToActiveElement Keys[key], false
+
+        # TODO: use sendKeysToActiveElement
+        @bridge.sendModifierKeyToActiveElement Keys.encode([key]), false
       end
 
       private

data/lib/selenium/webdriver/common/keys.rb

@@ -76,8 +76,32 @@ module Selenium
         :command      => "\xEE\x80\xBD" # alias
       }
 
+      #
+      # @api private
+      #
+
       def self.[](key)
-        KEYS[key] || raise(Error::UnsupportedOperationError, "no such key #{key.inspect}")
+        KEYS[key] or raise Error::UnsupportedOperationError, "no such key #{key.inspect}"
+      end
+
+      #
+      # @api private
+      #
+
+      def self.encode(keys)
+        keys.map do |arg|
+          case arg
+          when Symbol
+            Keys[arg]
+          when Array
+            arg = arg.map { |e| e.kind_of?(Symbol) ? Keys[e] : e }.join
+            arg << Keys[:null]
+
+            arg
+          else
+            arg.to_s
+          end
+        end
       end
 
     end # Keys

data/lib/selenium/webdriver/common/profile_helper.rb

@@ -52,7 +52,7 @@ module Selenium
           # can't use Dir.mktmpdir(&blk) because of http://jira.codehaus.org/browse/JRUBY-4082
           tmp_dir = Dir.mktmpdir
           begin
-            zip_path = File.join(tmp_dir, "webdriver-profile-duplicate-#{json.hash}")
+            zip_path = File.join(tmp_dir, "webdriver-profile-duplicate-#{json.hash}.zip")
             File.open(zip_path, "wb") { |zip_file| zip_file << Base64.decode64(data) }
 
             new Zipper.unzip(zip_path)

data/lib/selenium/webdriver/common/zipper.rb

@@ -8,47 +8,71 @@ module Selenium
 
       EXTENSIONS = %w[.zip .xpi]
 
-      def self.unzip(path)
-        destination = Dir.mktmpdir("unzip")
-        FileReaper << destination
+      class << self
 
-        Zip::ZipFile.open(path) do |zip|
-          zip.each do |entry|
-            to      = File.join(destination, entry.name)
-            dirname = File.dirname(to)
+        def unzip(path)
+          destination = Dir.mktmpdir("unzip")
+          FileReaper << destination
 
-            FileUtils.mkdir_p dirname unless File.exist? dirname
-            zip.extract(entry, to)
+          Zip::ZipFile.open(path) do |zip|
+            zip.each do |entry|
+              to      = File.join(destination, entry.name)
+              dirname = File.dirname(to)
+
+              FileUtils.mkdir_p dirname unless File.exist? dirname
+              zip.extract(entry, to)
+            end
           end
+
+          destination
         end
 
-        destination
-      end
+        def zip(path)
+          with_tmp_zip do |zip|
+            ::Find.find(path) do |file|
+              unless File.directory?(file)
+                add_zip_entry zip, file, file.sub("#{path}/", '')
+              end
+            end
 
-      def self.zip(path)
-        # can't use Tempfile here since it doesn't support File::BINARY mode on 1.8
-        # can't use Dir.mktmpdir(&blk) because of http://jira.codehaus.org/browse/JRUBY-4082
-        tmp_dir = Dir.mktmpdir
-        begin
-          zip_path = File.join(tmp_dir, "webdriver-zip")
+            zip.commit
+            File.open(zip.name, "rb") { |io| Base64.strict_encode64 io.read }
+          end
+        end
 
-          Zip::ZipFile.open(zip_path, Zip::ZipFile::CREATE) { |zip|
-            ::Find.find(path) do |file|
-              next if File.directory?(file)
+        def zip_file(path)
+          with_tmp_zip do |zip|
+            add_zip_entry zip, path, File.basename(path)
 
-              entry = Zip::ZipEntry.new(zip_path, file.sub("#{path}/", ''))
-              entry.follow_symlinks = true
+            zip.commit
+            File.open(zip.name, "rb") { |io| Base64.strict_encode64 io.read }
+          end
+        end
 
-              zip.add entry, file
-            end
-          }
+        private
+
+        def with_tmp_zip(&blk)
+          # can't use Tempfile here since it doesn't support File::BINARY mode on 1.8
+          # can't use Dir.mktmpdir(&blk) because of http://jira.codehaus.org/browse/JRUBY-4082
+          tmp_dir = Dir.mktmpdir
+          zip_path = File.join(tmp_dir, "webdriver-zip")
+
+          begin
+            Zip::ZipFile.open(zip_path, Zip::ZipFile::CREATE, &blk)
+          ensure
+            FileUtils.rm_rf tmp_dir
+            FileUtils.rm_rf zip_path
+          end
+        end
+
+        def add_zip_entry(zip, file, entry_name)
+          entry = Zip::ZipEntry.new(zip.name, entry_name)
+          entry.follow_symlinks = true
 
-          File.open(zip_path, "rb") { |io| Base64.strict_encode64 io.read }
-        ensure
-          FileUtils.rm_rf tmp_dir
+          zip.add entry, file
         end
-      end
 
+      end
     end # Zipper
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common.rb

@@ -21,6 +21,7 @@ require 'selenium/webdriver/common/action_builder'
 require 'selenium/webdriver/common/driver_extensions/takes_screenshot'
 require 'selenium/webdriver/common/driver_extensions/rotatable'
 require 'selenium/webdriver/common/driver_extensions/has_input_devices'
+require 'selenium/webdriver/common/driver_extensions/uploads_files'
 require 'selenium/webdriver/common/keys'
 require 'selenium/webdriver/common/bridge_helper'
 require 'selenium/webdriver/common/profile_helper'

data/lib/selenium/webdriver/remote/bridge.rb

@@ -29,7 +29,7 @@ module Selenium
           COMMANDS[name] = [verb, url.freeze]
         end
 
-        attr_accessor :context, :http
+        attr_accessor :context, :http, :file_detector
         attr_reader :capabilities
 
         #
@@ -64,8 +64,8 @@ module Selenium
 
           http_client.server_url = uri
 
-          @http         = http_client
-          @capabilities = create_session(desired_capabilities)
+          @http          = http_client
+          @capabilities  = create_session(desired_capabilities)
         end
 
         def browser
@@ -73,7 +73,11 @@ module Selenium
         end
 
         def driver_extensions
-          [DriverExtensions::HasInputDevices, DriverExtensions::TakesScreenshot]
+          [
+            DriverExtensions::HasInputDevices,
+            DriverExtensions::UploadsFiles,
+            DriverExtensions::TakesScreenshot
+          ]
         end
 
         #
@@ -110,7 +114,7 @@ module Selenium
         #
         # alerts
         #
-        
+
         def getAlert
           execute :getAlert
         end
@@ -270,6 +274,10 @@ module Selenium
           execute :sendModifierKeyToActiveElement, {}, :value => key, :isdown => down
         end
 
+        def sendKeysToActiveElement(key)
+          execute :sendKeysToActiveElement, {}, :value => key
+        end
+
         def getElementTagName(element)
           execute :getElementTagName, :id => element
         end
@@ -305,7 +313,19 @@ module Selenium
         end
 
         def sendKeysToElement(element, keys)
-          execute :sendKeysToElement, {:id => element}, {:value => keys}
+          if @file_detector && local_file = @file_detector.call(keys)
+            keys = upload(local_file)
+          end
+
+          execute :sendKeysToElement, {:id => element}, {:value => Array(keys)}
+        end
+
+        def upload(local_file)
+          unless File.file?(local_file)
+            raise WebDriverError::Error, "you may only upload files: #{local_file.inspect}"
+          end
+
+          execute :uploadFile, {}, :file => Zipper.zip_file(local_file)
         end
 
         def clearElement(element)

data/lib/selenium/webdriver/remote/commands.rb

@@ -61,6 +61,7 @@ class Selenium::WebDriver::Remote::Bridge
   command :setVisible,                             :post,    "session/:session_id/visible"
   command :getScreenOrientation,                   :get,     "session/:session_id/orientation"
   command :setScreenOrientation,                   :post,    "session/:session_id/orientation"
+  command :uploadFile,                             :post,    "session/:session_id/file"
 
   # interactions API
   command :click,                                  :post,    "session/:session_id/click"
@@ -69,4 +70,6 @@ class Selenium::WebDriver::Remote::Bridge
   command :mouseUp,                                :post,    "session/:session_id/buttonup"
   command :mouseMoveTo,                            :post,    "session/:session_id/moveto"
   command :sendModifierKeyToActiveElement,         :post,    "session/:session_id/modifier"
+  command :sendKeysToActiveElement,                :post,    "session/:session_id/keys"
+
 end

metadata

@@ -2,7 +2,7 @@
 name: selenium-webdriver
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors: 
   - Jari Bakken
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-06 00:00:00 +02:00
+date: 2011-10-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -52,9 +52,9 @@ dependencies:
     requirement: &id004 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
-        - - ">="
+        - - "="
           - !ruby/object:Gem::Version 
-            version: 1.0.7
+            version: 1.0.9
     type: :runtime
     version_requirements: *id004
   - !ruby/object:Gem::Dependency 
@@ -168,6 +168,7 @@ files:
   - lib/selenium/webdriver/common/driver_extensions/has_input_devices.rb
   - lib/selenium/webdriver/common/driver_extensions/rotatable.rb
   - lib/selenium/webdriver/common/driver_extensions/takes_screenshot.rb
+  - lib/selenium/webdriver/common/driver_extensions/uploads_files.rb
   - lib/selenium/webdriver/firefox/binary.rb
   - lib/selenium/webdriver/firefox/bridge.rb
   - lib/selenium/webdriver/firefox/extension.rb