bbc-selenium-webdriver 1.17.0

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

@@ -0,0 +1,46 @@
+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 = args.first.to_s
+        #        str if File.exist?(str)
+        #     end
+        #
+        #     driver.find_element(:id => "upload").send_keys "/path/to/file"
+        #
+        # By default, no file detection is performed.
+        #
+        # @api public
+        #
+
+        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

@@ -0,0 +1,262 @@
+module Selenium
+  module WebDriver
+    class Element
+      include SearchContext
+
+      #
+      # Creates a new Element
+      #
+      # @api private
+      #
+
+      def initialize(bridge, id)
+        @bridge, @id = bridge, id
+      end
+
+      def inspect
+        '#<%s:0x%x id=%s>' % [self.class, hash*2, @id.inspect]
+      end
+
+      def ==(other)
+        other.kind_of?(self.class) && bridge.elementEquals(self, other)
+      end
+      alias_method :eql?, :==
+
+      def hash
+        @id.hash ^ @bridge.hash
+      end
+
+      #
+      # Click the element
+      #
+
+      def click
+        bridge.clickElement @id
+      end
+
+      #
+      # Get the tag name of this element
+      #
+      # @return [String]
+      #
+
+      def tag_name
+        bridge.getElementTagName @id
+      end
+
+      #
+      # Get the value of a the given attribute of the element. Will return the current value, even if
+      # this has been modified after the page has been loaded. More exactly, this method will return
+      # the value of the given attribute, unless that attribute is not present, in which case the
+      # value of the property with the same name is returned. If neither value is set, nil is
+      # returned. The "style" attribute is converted as best can be to a text representation with a
+      # trailing semi-colon. The following are deemed to be "boolean" attributes, and will
+      # return either "true" or "false":
+      #
+      # async, autofocus, autoplay, checked, compact, complete, controls, declare, defaultchecked,
+      # defaultselected, defer, disabled, draggable, ended, formnovalidate, hidden, indeterminate,
+      # iscontenteditable, ismap, itemscope, loop, multiple, muted, nohref, noresize, noshade, novalidate,
+      # nowrap, open, paused, pubdate, readonly, required, reversed, scoped, seamless, seeking,
+      # selected, spellcheck, truespeed, willvalidate
+      #
+      # Finally, the following commonly mis-capitalized attribute/property names are evaluated as
+      # expected:
+      #
+      # class, readonly
+      #
+      # @param [String]
+      #   attribute name
+      # @return [String,nil]
+      #   attribute value
+      #
+
+      def attribute(name)
+        bridge.getElementAttribute @id, name
+      end
+
+      #
+      # Get the text content of this element
+      #
+      # @return [String]
+      #
+
+      def text
+        bridge.getElementText @id
+      end
+
+      #
+      # Send keystrokes to this element
+      #
+      # @param [String, Symbol, Array]
+      #
+      # Examples:
+      #
+      #     element.send_keys "foo"                     #=> value: 'foo'
+      #     element.send_keys "tet", :arrow_left, "s"   #=> value: 'test'
+      #     element.send_keys [:control, 'a'], :space   #=> value: ' '
+      #
+      # @see Keys::KEYS
+      #
+
+      def send_keys(*args)
+        bridge.sendKeysToElement @id, Keys.encode(args)
+      end
+      alias_method :send_key, :send_keys
+
+      #
+      # Clear this element
+      #
+
+      def clear
+        bridge.clearElement @id
+      end
+
+      #
+      # Is the element enabled?
+      #
+      # @return [Boolean]
+      #
+
+      def enabled?
+        bridge.isElementEnabled @id
+      end
+
+      #
+      # Is the element selected?
+      #
+      # @return [Boolean]
+      #
+
+      def selected?
+        bridge.isElementSelected @id
+      end
+
+      #
+      # Is the element displayed?
+      #
+      # @return [Boolean]
+      #
+
+      def displayed?
+        bridge.isElementDisplayed @id
+      end
+
+      #
+      # Submit this element
+      #
+
+      def submit
+        bridge.submitElement @id
+      end
+
+      #
+      # Get the value of the given CSS property
+      #
+      # Note that shorthand CSS properties (e.g. background, font, border, border-top, margin,
+      # margin-top, padding, padding-top, list-style, outline, pause, cue) are not returned,
+      # in accordance with the DOM CSS2 specification - you should directly access the longhand
+      # properties (e.g. background-color) to access the desired values. 
+      # 
+      # @see http://www.w3.org/TR/DOM-Level-2-Style/css.html#CSS-CSSStyleDeclaration
+      # 
+
+      def style(prop)
+        bridge.getElementValueOfCssProperty @id, prop
+      end
+
+      #
+      # Get the location of this element.
+      #
+      # @return [WebDriver::Point]
+      #
+
+      def location
+        bridge.getElementLocation @id
+      end
+
+      #
+      # Determine an element's location on the screen once it has been scrolled into view.
+      #
+      # @return [WebDriver::Point]
+      #
+
+      def location_once_scrolled_into_view
+        bridge.getElementLocationOnceScrolledIntoView @id
+      end
+
+      #
+      # Get the size of this element
+      #
+      # @return [WebDriver::Dimension]
+      #
+
+      def size
+        bridge.getElementSize @id
+      end
+
+      #-------------------------------- sugar  --------------------------------
+
+      #
+      #   element.first(:id, 'foo')
+      #
+
+      alias_method :first, :find_element
+
+      #
+      #   element.all(:class, 'bar')
+      #
+
+      alias_method :all, :find_elements
+
+      #
+      #   element['class'] or element[:class] #=> "someclass"
+      #
+      alias_method :[], :attribute
+
+      #
+      # for SearchContext and execute_script
+      #
+      # @api 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
+      #
+      # @api private
+      #
+
+      def to_json(*args)
+        MultiJson.encode as_json
+      end
+
+      #
+      # For Rails 3 - http://jonathanjulian.com/2010/04/rails-to_json-or-as_json/
+      #
+      # @api private
+      #
+
+      def as_json(opts = nil)
+        { :ELEMENT => @id }
+      end
+
+      private
+
+      def bridge
+        @bridge
+      end
+
+      def selectable?
+        tn = tag_name.downcase
+        type = attribute(:type).to_s.downcase
+
+        tn == "option" || (tn == "input" && %w[radio checkbox].include?(type))
+      end
+
+    end # Element
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,212 @@
+module Selenium
+  module WebDriver
+    module Error
+
+      class WebDriverError < StandardError; end
+      class UnsupportedOperationError < WebDriverError; end
+
+      class IndexOutOfBoundsError < WebDriverError; end          # 1
+      class NoCollectionError < WebDriverError; end              # 2
+      class NoStringError < WebDriverError; end                  # 3
+      class NoStringLengthError < WebDriverError; end            # 4
+      class NoStringWrapperError < WebDriverError; end           # 5
+      class NoSuchDriverError < WebDriverError; end              # 6
+
+      #
+      # An element could not be located on the page using the given search
+      # parameters.
+      #
+
+      class NoSuchElementError < WebDriverError; end             # 7
+
+      #
+      # A request to switch to a frame could not be satisfied because the
+      # frame could not be found.
+      #
+
+      class NoSuchFrameError < WebDriverError; end               # 8
+      class UnknownCommandError < WebDriverError; end            # 9
+
+
+      #
+      # Indicates that a reference to an element is now "stale" - the element
+      # no longer appears in the DOM of the page.
+      #
+
+      class StaleElementReferenceError < WebDriverError; end     # 10
+
+      #
+      # Raised to indicate that although an element is present on the DOM,
+      # it is not visible, and so is not able to be interacted with.
+      #
+
+      class ElementNotVisibleError < WebDriverError; end         # 11
+
+      #
+      # Raised when an interaction could not be performed because the element
+      # is in an invalid state (e.g. attempting to click a disabled element).
+      #
+
+      class InvalidElementStateError < WebDriverError; end       # 12
+
+      #
+      # An unknown server-side error occurred while processing the command.
+      #
+
+      class UnknownError < WebDriverError; end                   # 13
+      class ExpectedError < WebDriverError; end                  # 14
+
+      #
+      # An attempt was made to select an element that cannot be selected.
+      #
+
+      class ElementNotSelectableError < WebDriverError; end      # 15
+      class NoSuchDocumentError < WebDriverError; end            # 16
+
+      #
+      # An error occurred while executing user supplied JavaScript.
+      #
+
+      class JavascriptError < WebDriverError; end                # 17
+      class NoScriptResultError < WebDriverError; end            # 18
+
+      #
+      # An error occurred while searching for an element by XPath.
+      #
+
+      class XPathLookupError < WebDriverError; end               # 19
+      class NoSuchCollectionError < WebDriverError; end          # 20
+
+      #
+      # Raised when a command does not complete in enough time.
+      #
+
+      class TimeOutError < WebDriverError; end                   # 21
+      class NullPointerError < WebDriverError; end               # 22
+      class NoSuchWindowError < WebDriverError; end              # 23
+
+      #
+      # Raised when attempting to add a cookie under a different domain than
+      # the current URL.
+      #
+
+      class InvalidCookieDomainError < WebDriverError; end       # 24
+
+      #
+      # Raised when a driver fails to set a cookie.
+      #
+
+      class UnableToSetCookieError < WebDriverError; end         # 25
+      class UnexpectedAlertError < WebDriverError; end           # 26
+
+      #
+      # Indicates that a user has tried to access an alert when one is not present.
+      #
+
+      class NoAlertPresentError < WebDriverError; end            # 27
+
+      #
+      # A script did not complete before its timeout expired.
+      #
+
+      class ScriptTimeOutError < WebDriverError; end             # 28
+
+      #
+      # The coordinates provided to an interactions operation are invalid.
+      #
+
+      class InvalidElementCoordinatesError < WebDriverError; end # 29
+
+      #
+      # Indicates that IME support is not available. This exception is rasied
+      # for every IME-related method call if IME support is not available on
+      # the machine.
+      #
+
+      class IMENotAvailableError < WebDriverError; end           # 30
+
+      #
+      # Indicates that activating an IME engine has failed.
+      #
+
+      class IMEEngineActivationFailedError < WebDriverError; end # 31
+
+      #
+      # Argument was an invalid selector (e.g. XPath/CSS).
+      #
+
+      class InvalidSelectorError < WebDriverError; end           # 32
+                                                                 # 33
+
+      #
+      # Indicates that the target provided to the actions #move method is
+      # invalid, e.g. outside of the bounds of the window.
+      #
+
+      class MoveTargetOutOfBoundsError < WebDriverError; end     # 34
+
+      # @api private
+      Errors = [
+        IndexOutOfBoundsError,          # 1
+        NoCollectionError,              # 2
+        NoStringError,                  # 3
+        NoStringLengthError,            # 4
+        NoStringWrapperError,           # 5
+        NoSuchDriverError,              # 6
+        NoSuchElementError,             # 7
+        NoSuchFrameError,               # 8
+        UnknownCommandError,            # 9
+        StaleElementReferenceError,     # 10
+        ElementNotVisibleError,         # 11
+        InvalidElementStateError,       # 12
+        UnknownError,                   # 13
+        ExpectedError,                  # 14
+        ElementNotSelectableError,      # 15
+        NoSuchDocumentError,            # 16
+        JavascriptError,                # 17
+        NoScriptResultError,            # 18
+        XPathLookupError,               # 19
+        NoSuchCollectionError,          # 20
+        TimeOutError,                   # 21
+        NullPointerError,               # 22
+        NoSuchWindowError,              # 23
+        InvalidCookieDomainError,       # 24
+        UnableToSetCookieError,         # 25
+        UnexpectedAlertError,           # 26
+        NoAlertPresentError,            # 27
+        ScriptTimeOutError,             # 28
+        InvalidElementCoordinatesError, # 29
+        IMENotAvailableError,           # 30
+        IMEEngineActivationFailedError, # 31
+        InvalidSelectorError,           # 32
+        nil,                            # 33
+        MoveTargetOutOfBoundsError      # 34
+      ]
+
+      # aliased for backwards compatibility
+      ObsoleteElementError = StaleElementReferenceError
+
+      # aliased for backwards compatibility
+      UnhandledError = UnknownError
+
+      # aliased for backwards compatibility
+      UnexpectedJavascriptError = JavascriptError
+
+      # aliased for backwards compatibility
+      NoAlertOpenError = NoAlertPresentError
+
+      # aliased for backwards compatibility
+      ElementNotDisplayedError = ElementNotVisibleError
+
+      class << self
+        def for_code(code)
+          return if code == 0
+          return WebDriverError if code.nil?
+
+          Errors[code - 1] || WebDriverError
+        end
+      end
+
+    end # Error
+  end # WebDriver
+end # Selenium