selenium-webdriver 0.0.17 → 0.0.18

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

@@ -1,21 +1,25 @@
 require "tmpdir"
 require "fileutils"
 
-def have_yajl?
-  require "yajl/json_gem"
-  true
-rescue LoadError
-  false
-end
+have_yajl = lambda {
+  begin
+    require "yajl/json_gem"
+    true
+  rescue LoadError
+    false
+  end
+}
 
-def have_json?
-  require "json"
-  true
-rescue LoadError
-  false
-end
+have_json = lambda {
+  begin
+    require "json"
+    true
+  rescue LoadError
+    false
+  end
+}
 
-unless have_yajl? || have_json?
+unless have_yajl.call || have_json.call
   raise LoadError, <<-END
 
        You need to require rubygems or install one of these gems:
@@ -30,6 +34,7 @@ end
 
 
 require "selenium/webdriver/core_ext/dir"
+require "selenium/webdriver/core_ext/string"
 require "selenium/webdriver/error"
 require "selenium/webdriver/platform"
 require "selenium/webdriver/child_process"
@@ -46,7 +51,7 @@ require "selenium/webdriver/element"
 module Selenium
   module WebDriver
     Point     = Struct.new(:x, :y)
-    Dimension = Struct.new(:width, :heigth)
+    Dimension = Struct.new(:width, :height)
 
     autoload :IE,      'selenium/webdriver/ie'
     autoload :Remote,  'selenium/webdriver/remote'
@@ -57,6 +62,10 @@ module Selenium
       @root ||= File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "..", ".."))
     end
 
+    #
+    # @see Selenium::WebDriver::Driver.for
+    #
+
     def self.for(*args)
       WebDriver::Driver.for(*args)
     end

data/common/src/rb/lib/selenium/webdriver/bridge_helper.rb

@@ -4,52 +4,25 @@ module Selenium
     #
     # Shared across bridges
     #
+    # @private
+    #
 
     module BridgeHelper
 
-      def wrap_script_argument(arg)
-        case arg
-        when Integer, Float
-          { :type => "NUMBER", :value => arg }
-        when TrueClass, FalseClass, NilClass
-          { :type => "BOOLEAN", :value => !!arg }
-        when Element
-          { :type => "ELEMENT", :value => arg.ref }
-        when String
-          { :type => "STRING", :value => arg.to_s }
-        when Array # Enumerable?
-          arg.map { |e| wrap_script_argument(e) }
-        else
-          raise TypeError, "Parameter is not of recognized type: #{arg.inspect}:#{arg.class}"
-        end
-      end
-
-      def unwrap_script_argument(arg)
+      def unwrap_script_result(arg)
         if arg.kind_of?(Array)
-          arg.map { |e| unwrap_script_argument(e) }
+          arg.map { |e| unwrap_script_result(e) }
         else
-          case arg["type"]
-          when "NULL"
-            nil
-          when "ELEMENT"
-            Element.new self, element_id_from(arg["value"])
-          when "POINT"
-            Point.new arg['x'], arg['y']
-          when "DIMENSION"
-            Dimension.new arg['width'], arg['height']
-          when "COOKIE"
-            {:name => arg['name'], :value => arg['value']}
+          if arg.kind_of?(Hash) && arg.member?("ELEMENT")
+            Element.new self, element_id_from(arg)
           else
-            arg["value"]
+            arg
           end
         end
       end
 
       def element_id_from(id)
-        str = id.kind_of?(Array) ? id.first : id
-        after = str.split("/").last
-
-        after
+        id['ELEMENT']
       end
 
       def parse_cookie_string(str)

data/common/src/rb/lib/selenium/webdriver/child_process.rb

@@ -4,6 +4,8 @@ module Selenium
     #
     # Cross platform child process launcher
     #
+    # @private
+    #
 
     class ChildProcess
       attr_reader :pid

data/common/src/rb/lib/selenium/webdriver/core_ext/dir.rb

@@ -1,4 +1,5 @@
 class Dir
+  # @private
   def self.mktmpdir(prefix_suffix=nil, tmpdir=nil)
     case prefix_suffix
     when nil

data/common/src/rb/lib/selenium/webdriver/core_ext/string.rb

@@ -0,0 +1,5 @@
+unless '1.9'.respond_to?(:bytesize)
+  class String
+    alias :bytesize :size
+  end
+end

data/common/src/rb/lib/selenium/webdriver/driver.rb

@@ -20,46 +20,51 @@ module Selenium
         #
         # Create a new Driver instance with the correct bridge for the given browser
         #
-        # @param browser [Symbol]
+        # @param browser [:ie, :internet_explorer, :remote, :chrome, :firefox, :ff]
         #   the driver type to use
         # @param *rest
-        #   arguments passed to the Bridge.new
+        #   arguments passed to Bridge.new
         #
         # @return [Driver]
         #
+        # @example
+        #
+        #   Driver.for :firefox, :profile => "some-profile"
+        #   Driver.for :firefox, :profile => Profile.new
+        #   Driver.for :remote,  :url => "http://localhost:4444/wd/hub", :desired_capabilities => caps
+        #
 
         def for(browser, *args)
           bridge = case browser
                    when :ie, :internet_explorer
-                     WebDriver::IE::Bridge.new(*args)
+                     IE::Bridge.new(*args)
                    when :remote
-                     WebDriver::Remote::Bridge.new(*args)
+                     Remote::Bridge.new(*args)
                    when :chrome
-                     WebDriver::Chrome::Bridge.new(*args)
+                     Chrome::Bridge.new(*args)
                    when :firefox, :ff
-                     WebDriver::Firefox::Bridge.new(*args)
+                     Firefox::Bridge.new(*args)
                    else
                      raise ArgumentError, "unknown driver: #{browser.inspect}"
                    end
 
-           driver = new(bridge)
-
-           unless bridge.driver_extensions.empty?
-             driver.extend(*bridge.driver_extensions)
-           end
-
-           driver
+           new(bridge)
         end
       end
 
       #
-      # A new Driver instance
+      # A new Driver instance with the given bridge
       #
       # @api private
       #
 
       def initialize(bridge)
         @bridge = bridge
+
+        # TODO: refactor this away
+        unless @bridge.driver_extensions.empty?
+          extend(*@bridge.driver_extensions)
+        end
       end
 
       def inspect
@@ -240,7 +245,7 @@ module Selenium
       #
       # for Find
       #
-      # @api private
+      # @private
       #
 
       def ref

data/common/src/rb/lib/selenium/webdriver/driver_extensions/takes_screenshot.rb

@@ -1,5 +1,10 @@
 module Selenium
   module WebDriver
+
+    #
+    # @private
+    #
+
     module DriverExtensions
       module TakesScreenshot
 
@@ -10,9 +15,9 @@ module Selenium
         def screenshot_as(format)
           case format
           when :base64
-            bridge.getScreenshotAsBase64
+            bridge.getScreenshot
           when :png
-            bridge.getScreenshotAsBase64.unpack("m")[0]
+            bridge.getScreenshot.unpack("m")[0]
           else
             raise Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
           end

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

@@ -8,7 +8,7 @@ module Selenium
       #
       # Creates a new Element
       #
-      # @api private
+      # @private
       #
 
       def initialize(bridge, id)
@@ -248,14 +248,23 @@ module Selenium
       #
       # for Find and execute_script
       #
-      # @api private
+      # @private
       #
 
       def ref
         @id
       end
 
+      #
+      # Convert to a WebElement JSON Object for transmission over the wire.
+      # @see http://code.google.com/p/selenium/wiki/JsonWireProtocol#Basic_Concepts_And_Terms
+      #
+      # @private
+      #
 
+      def to_json(*args)
+        { :ELEMENT => @id }.to_json(*args)
+      end
 
     end # Element
   end # WebDriver

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

@@ -11,13 +11,13 @@ module Selenium
       class NoSuchDriverError < WebDriverError; end            # 6
       class NoSuchElementError < WebDriverError; end           # 7
       class NoSuchFrameError < WebDriverError; end             # 8
-      # NotImplementedError                                    # 9 - just use Ruby's
+      class UnknownCommandError < WebDriverError; end          # 9
       class ObsoleteElementError < WebDriverError; end         # 10
       class ElementNotDisplayedError < WebDriverError; end     # 11
       class ElementNotEnabledError < WebDriverError; end       # 12
       class UnhandledError < WebDriverError; end               # 13
       class ExpectedError < WebDriverError; end                # 14
-      class ElementNotSelectedError < WebDriverError; end      # 15
+      class ElementNotSelectableError < WebDriverError; end    # 15
       class NoSuchDocumentError < WebDriverError; end          # 16
       class UnexpectedJavascriptError < WebDriverError; end    # 17
       class NoScriptResultError < WebDriverError; end          # 18
@@ -26,6 +26,8 @@ module Selenium
       class TimeOutError < WebDriverError; end                 # 21
       class NullPointerError < WebDriverError; end             # 22
       class NoSuchWindowError < WebDriverError; end            # 23
+      class InvalidCookieDomainError < WebDriverError; end     # 24
+      class UnableToSetCookieError < WebDriverError; end       # 25
       class UnsupportedOperationError < WebDriverError; end
 
       Errors = [
@@ -37,13 +39,13 @@ module Selenium
         NoSuchDriverError,
         NoSuchElementError,
         NoSuchFrameError,
-        NotImplementedError,
+        UnknownCommandError,
         ObsoleteElementError,
         ElementNotDisplayedError,
         ElementNotEnabledError,
         UnhandledError,
         ExpectedError,
-        ElementNotSelectedError,
+        ElementNotSelectableError,
         NoSuchDocumentError,
         UnexpectedJavascriptError,
         NoScriptResultError,
@@ -51,7 +53,9 @@ module Selenium
         NoSuchCollectionError,
         TimeOutError,
         NullPointerError,
-        NoSuchWindowError
+        NoSuchWindowError,
+        InvalidCookieDomainError,
+        UnableToSetCookieError
       ]
 
       class << self

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

@@ -6,8 +6,7 @@ module Selenium
 
       #
       # @see Element#send_keys
-      #
-      # http://www.google.com.au/search?&q=unicode+pua&btnG=Search
+      # @see http://www.google.com.au/search?&q=unicode+pua&btnG=Search
       #
 
       KEYS = {

data/common/src/rb/lib/selenium/webdriver/navigation.rb

@@ -6,18 +6,34 @@ module Selenium
         @bridge = driver.bridge
       end
 
+      #
+      # Navigate to the given URL
+      #
+
       def to(url)
         @bridge.get url
       end
 
+      #
+      # Move back a single entry in the browser's history.
+      #
+
       def back
         @bridge.goBack
       end
 
+      #
+      # Move forward a single entry in the browser's history.
+      #
+
       def forward
         @bridge.goForward
       end
 
+      #
+      # Refresh the current page.
+      #
+
       def refresh
         @bridge.refresh
       end

data/common/src/rb/lib/selenium/webdriver/options.rb

@@ -2,10 +2,26 @@ module Selenium
   module WebDriver
     class Options
 
+      #
+      # @private
+      #
+
       def initialize(driver)
         @bridge = driver.bridge
       end
 
+      #
+      # Add a cookie to the browser
+      #
+      # @param [Hash] opts the options to create a cookie with.
+      # @option opts [String] :name A name
+      # @option opts [String] :value A value
+      # @option opts [String] :path ('/') A path
+      # @option opts [String] :secure (false) A boolean
+      #
+      # @raise [ArgumentError] if :name or :value is not specified
+      #
+
       def add_cookie(opts = {})
         raise ArgumentError, "name is required" unless opts[:name]
         raise ArgumentError, "value is required" unless opts[:value]
@@ -16,14 +32,30 @@ module Selenium
         @bridge.addCookie opts
       end
 
+      #
+      # Delete the cookie with the given name
+      #
+      # @param [String] name the name of the cookie to delete
+      #
+
       def delete_cookie(name)
         @bridge.deleteCookie name
       end
 
+      #
+      # Delete all cookies
+      #
+
       def delete_all_cookies
         @bridge.deleteAllCookies
       end
 
+      #
+      # Get all cookies
+      #
+      # @return [Array<Hash>] list of cookies
+      #
+
       def all_cookies
         @bridge.getAllCookies.map do |cookie|
           {

data/common/src/rb/lib/selenium/webdriver/platform.rb

@@ -2,13 +2,15 @@ require "rbconfig"
 
 module Selenium
   module WebDriver
+
+    # @private
     module Platform
 
       module_function
 
       def home
         # jruby has an issue with ENV['HOME'] on Windows
-        @home ||= Platform.jruby? ? java.lang.System.getProperty('user.home') : ENV['HOME']
+        @home ||= Platform.jruby? ? Java.java.lang.System.getProperty('user.home') : ENV['HOME']
       end
 
       def platform
@@ -71,6 +73,20 @@ module Selenium
         File.chmod 0766, file
       end
 
+      def find_binary(*binary_names)
+        paths = ENV['PATH'].split(File::PATH_SEPARATOR)
+        binary_names.map! { |n| "#{n}.exe" } if win?
+
+        binary_names.each do |binary_name|
+          paths.each do |path|
+            exe = File.join(path, binary_name)
+            return exe if File.executable?(exe)
+          end
+        end
+
+        nil
+      end
+
     end # Platform
   end # WebDriver
 end # Selenium