bbc-selenium-webdriver 1.17.0

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

@@ -0,0 +1,47 @@
+module Selenium
+  module WebDriver
+
+    #
+    # @api private
+    #
+
+    module FileReaper
+
+      class << self
+        def reap=(bool)
+          @reap = bool
+        end
+
+        def reap?
+          @reap = true unless defined?(@reap)
+          !!@reap
+        end
+
+        def tmp_files
+          @tmp_files ||= []
+        end
+
+        def <<(file)
+          tmp_files << file
+        end
+
+        def reap(file)
+          return unless reap?
+
+          unless tmp_files.include?(file)
+            raise Error::WebDriverError, "file not added for reaping: #{file.inspect}"
+          end
+
+          FileUtils.rm_rf tmp_files.delete(file)
+        end
+
+        def reap!
+          tmp_files.each { |file| FileUtils.rm_rf(file) } if reap?
+        end
+      end
+
+      Platform.exit_hook { reap! }
+
+    end # FileReaper
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,52 @@
+module Selenium
+  module WebDriver
+
+    # @api private
+    class Keyboard
+
+      def initialize(bridge)
+        @bridge = bridge
+      end
+
+      def send_keys(*keys)
+        @bridge.sendKeysToActiveElement Keys.encode(keys)
+      end
+
+      #
+      # Press a modifier key
+      #
+      # @see Selenium::WebDriver::Keys
+      #
+
+      def press(key)
+        assert_modifier key
+
+        @bridge.sendKeysToActiveElement Keys.encode([key])
+      end
+
+      #
+      # Release a modifier key
+      #
+      # @see Selenium::WebDriver::Keys
+      #
+
+      def release(key)
+        assert_modifier key
+
+        @bridge.sendKeysToActiveElement Keys.encode([key])
+      end
+
+      private
+
+      MODIFIERS = [:control, :shift, :alt, :command, :meta]
+
+      def assert_modifier(key)
+        unless MODIFIERS.include? key
+          raise ArgumentError,
+            "#{key.inspect} is not a modifier key, expected one of #{MODIFIERS.inspect}"
+        end
+      end
+
+    end # Keyboard
+  end # WebDriver
+end  # Selenium

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

@@ -0,0 +1,109 @@
+# encoding: utf-8
+
+module Selenium
+  module WebDriver
+    module Keys
+
+      #
+      # @see Element#send_keys
+      # @see http://www.google.com.au/search?&q=unicode+pua&btnG=Search
+      #
+
+      KEYS = {
+      # \x works on both 1.8.6/1.9
+        :null         => "\xEE\x80\x80",
+        :cancel       => "\xEE\x80\x81",
+        :help         => "\xEE\x80\x82",
+        :backspace    => "\xEE\x80\x83",
+        :tab          => "\xEE\x80\x84",
+        :clear        => "\xEE\x80\x85",
+        :return       => "\xEE\x80\x86",
+        :enter        => "\xEE\x80\x87",
+        :shift        => "\xEE\x80\x88",
+        :left_shift   => "\xEE\x80\x88",
+        :control      => "\xEE\x80\x89",
+        :left_control => "\xEE\x80\x89",
+        :alt          => "\xEE\x80\x8A",
+        :left_alt     => "\xEE\x80\x8A",
+        :pause        => "\xEE\x80\x8B",
+        :escape       => "\xEE\x80\x8C",
+        :space        => "\xEE\x80\x8D",
+        :page_up      => "\xEE\x80\x8E",
+        :page_down    => "\xEE\x80\x8F",
+        :end          => "\xEE\x80\x90",
+        :home         => "\xEE\x80\x91",
+        :left         => "\xEE\x80\x92",
+        :arrow_left   => "\xEE\x80\x92",
+        :up           => "\xEE\x80\x93",
+        :arrow_up     => "\xEE\x80\x93",
+        :right        => "\xEE\x80\x94",
+        :arrow_right  => "\xEE\x80\x94",
+        :down         => "\xEE\x80\x95",
+        :arrow_down   => "\xEE\x80\x95",
+        :insert       => "\xEE\x80\x96",
+        :delete       => "\xEE\x80\x97",
+        :semicolon    => "\xEE\x80\x98",
+        :equals       => "\xEE\x80\x99",
+        :numpad0      => "\xEE\x80\x9A",
+        :numpad1      => "\xEE\x80\x9B",
+        :numpad2      => "\xEE\x80\x9C",
+        :numpad3      => "\xEE\x80\x9D",
+        :numpad4      => "\xEE\x80\x9E",
+        :numpad5      => "\xEE\x80\x9F",
+        :numpad6      => "\xEE\x80\xA0",
+        :numpad7      => "\xEE\x80\xA1",
+        :numpad8      => "\xEE\x80\xA2",
+        :numpad9      => "\xEE\x80\xA3",
+        :multiply     => "\xEE\x80\xA4",
+        :add          => "\xEE\x80\xA5",
+        :separator    => "\xEE\x80\xA6",
+        :subtract     => "\xEE\x80\xA7",
+        :decimal      => "\xEE\x80\xA8",
+        :divide       => "\xEE\x80\xA9",
+        :f1           => "\xEE\x80\xB1",
+        :f2           => "\xEE\x80\xB2",
+        :f3           => "\xEE\x80\xB3",
+        :f4           => "\xEE\x80\xB4",
+        :f5           => "\xEE\x80\xB5",
+        :f6           => "\xEE\x80\xB6",
+        :f7           => "\xEE\x80\xB7",
+        :f8           => "\xEE\x80\xB8",
+        :f9           => "\xEE\x80\xB9",
+        :f10          => "\xEE\x80\xBA",
+        :f11          => "\xEE\x80\xBB",
+        :f12          => "\xEE\x80\xBC",
+        :meta         => "\xEE\x80\xBD",
+        :command      => "\xEE\x80\xBD" # alias
+      }
+
+      #
+      # @api private
+      #
+
+      def self.[](key)
+        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
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,65 @@
+module Selenium
+  module WebDriver
+
+    # @api private
+    class Mouse
+
+      def initialize(bridge)
+        @bridge = bridge
+      end
+
+      def click(element = nil)
+        move_if_needed element
+        @bridge.click
+      end
+
+      def double_click(element = nil)
+        move_if_needed element
+        @bridge.doubleClick
+      end
+
+      def context_click(element = nil)
+        move_if_needed element
+        @bridge.contextClick
+      end
+
+      def down(element = nil)
+        move_if_needed element
+        @bridge.mouseDown
+      end
+
+      def up(element = nil)
+        move_if_needed element
+        @bridge.mouseUp
+      end
+
+      #
+      # Move the mouse.
+      #
+      # Examples:
+      #
+      #   driver.mouse.move_to(element)
+      #   driver.mouse.move_to(element, 5, 5)
+      #
+
+      def move_to(element, right_by = nil, down_by = nil)
+        unless element.kind_of? Element
+          raise TypeError, "expected #{Element}, got #{element.inspect}:#{element.class}"
+        end
+
+        @bridge.mouseMoveTo element.ref, right_by, down_by
+      end
+
+      def move_by(right_by, down_by)
+        @bridge.mouseMoveTo nil, right_by, down_by
+      end
+
+      private
+
+      def move_if_needed(element)
+        move_to element if element
+      end
+
+    end # Mouse
+  end # WebDriver
+end  # Selenium

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

@@ -0,0 +1,43 @@
+module Selenium
+  module WebDriver
+    class Navigation
+
+      def initialize(bridge)
+        @bridge = 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
+
+    end # Navigation
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,128 @@
+module Selenium
+  module WebDriver
+    class Options
+
+      #
+      # @api private
+      #
+
+      def initialize(bridge)
+        @bridge = 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
+      # @option opts [Time,DateTime,Numeric,nil] :expires (nil) Expiry date, either as a Time, DateTime, or seconds since epoch.
+      #
+      # @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]
+
+        opts[:path] ||= "/"
+        opts[:secure] ||= false
+
+        if obj = opts.delete(:expires)
+          opts[:expiry] = seconds_from(obj)
+        end
+
+
+        @bridge.addCookie opts
+      end
+
+      #
+      # Get the cookie with the given name
+      #
+      # @param [String] name the name of the cookie
+      # @return [Hash, nil] the cookie, or nil if it wasn't found.
+      #
+
+      def cookie_named(name)
+        all_cookies.find { |c| c[:name] == name }
+      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|
+          {
+            :name    => cookie["name"],
+            :value   => cookie["value"],
+            :path    => cookie["path"],
+            :domain  => cookie["domain"] && strip_port(cookie["domain"]),
+            :expires => cookie["expiry"] && datetime_at(cookie['expiry']),
+            :secure  => cookie["secure"]
+          }
+        end
+      end
+
+      def timeouts
+        @timeouts ||= Timeouts.new(@bridge)
+      end
+
+      #
+      # @api beta This API may be changed or removed in a future release.
+      #
+
+      def window
+        @window ||= Window.new(@bridge)
+      end
+
+      private
+
+      SECONDS_PER_DAY = 86_400.0
+
+      def datetime_at(int)
+        DateTime.civil(1970) + (int / SECONDS_PER_DAY)
+      end
+
+      def seconds_from(obj)
+        case obj
+        when Time
+          obj.to_f
+        when DateTime
+          (obj - DateTime.civil(1970)) * SECONDS_PER_DAY
+        when Numeric
+          obj
+        else
+          raise ArgumentError, "invalid value for expiration date: #{obj.inspect}"
+        end
+      end
+
+      def strip_port(str)
+        str.split(":", 2).first
+      end
+
+    end # Options
+  end # WebDriver
+end # Selenium