module Selenium::Client::Extensions

Convenience methods not explicitly part of the protocol

Public Instance Methods

active_javascript_framework(options) click to toggle source
# File lib/selenium/client/extensions.rb, line 124
def active_javascript_framework(options)
  options[:javascript_framework] || default_javascript_framework
end
wait_for_ajax(options={}) click to toggle source

These for all Ajax request to finish (Only works if you are using prototype, the wait happens in the browser)

# File lib/selenium/client/extensions.rb, line 26
def wait_for_ajax(options={})
  builder = JavascriptExpressionBuilder.new active_javascript_framework(options)
  wait_for_condition builder.no_pending_ajax_requests.script, options[:timeout_in_seconds]
end
wait_for_effects(options={}) click to toggle source

Wait for all Prototype effects to be processed (the wait happens in the browser).

Credits to github.com/brynary/webrat/tree/master

# File lib/selenium/client/extensions.rb, line 34
def wait_for_effects(options={})
  builder = JavascriptExpressionBuilder.new active_javascript_framework(options)
  wait_for_condition builder.no_pending_effects.script, options[:timeout_in_seconds]
end
wait_for_element(locator, options={}) click to toggle source

Wait for an element to be present (the wait happens in the browser).

# File lib/selenium/client/extensions.rb, line 40
def wait_for_element(locator, options={})
  builder = JavascriptExpressionBuilder.new
  builder.find_element(locator).append("element != null;")
  wait_for_condition builder.script, options[:timeout_in_seconds]
end
wait_for_field_value(locator, expected_value, options={}) click to toggle source

Wait for a field to get a specific value (the wait happens in the browser).

# File lib/selenium/client/extensions.rb, line 99
def wait_for_field_value(locator, expected_value, options={})
  builder = JavascriptExpressionBuilder.new
  builder.find_element(locator).element_value_is(expected_value)
  wait_for_condition builder.script, options[:timeout_in_seconds]
end
wait_for_no_element(locator, options={}) click to toggle source

Wait for an element to NOT be present (the wait happens in the browser).

# File lib/selenium/client/extensions.rb, line 47
def wait_for_no_element(locator, options={})
  builder = JavascriptExpressionBuilder.new
  builder.find_element(locator).append("element == null;")
  wait_for_condition builder.script, options[:timeout_in_seconds]
end
wait_for_no_field_value(locator, expected_value, options={}) click to toggle source

Wait for a field to not have a specific value (the wait happens in the browser).

# File lib/selenium/client/extensions.rb, line 106
def wait_for_no_field_value(locator, expected_value, options={})
  builder = JavascriptExpressionBuilder.new
  builder.find_element(locator).element_value_is_not(expected_value)
  wait_for_condition builder.script, options[:timeout_in_seconds]
end
wait_for_no_text(pattern, options={}) click to toggle source

Wait for some text to NOT be present (the wait happens in the browser).

See #wait_for_text for usage details.

# File lib/selenium/client/extensions.rb, line 92
def wait_for_no_text(pattern, options={})
  builder = JavascriptExpressionBuilder.new
  builder.find_text(pattern, options).append("text_match == false;")
  wait_for_condition builder.script, options[:timeout_in_seconds]
end
wait_for_not_visible(locator, options={}) click to toggle source

Wait for something to not be visible (the wait happens in the browser).

# File lib/selenium/client/extensions.rb, line 119
def wait_for_not_visible(locator, options={})
  builder = JavascriptExpressionBuilder.new
  wait_for_condition builder.not_visible(locator).script, options[:timeout_in_seconds]
end
wait_for_text(pattern, options={}) click to toggle source

Wait for some text to be present (the wait is happening browser side).

#wait_for_text will search for the given argument within the innerHTML of the current DOM. Note that this method treats a single string as a special case.

Parameters

#wait_for_text accepts an optional hash of parameters:

  • :element - a selenium locator for an element limiting the search scope.

  • :timeout_in_seconds - duration in seconds after which we time out if text cannot be found.

Regular Expressions

In addition to plain strings, #wait_for_text accepts regular expressions as the pattern specification.

Examples

The following are equivalent, and will match “some text” anywhere within the document:

wait_for_text "some text"
wait_for_text /some text/

This will match “some text” anywhere within the specified element:

wait_for_text /some text/, :element => "container"

This will match “some text” only if it exactly matches the complete innerHTML of the specified element:

wait_for_text "some text", :element => "container"
# File lib/selenium/client/extensions.rb, line 83
def wait_for_text(pattern, options={})
  builder = JavascriptExpressionBuilder.new
  builder.find_text(pattern, options).append("text_match == true;")
  wait_for_condition builder.script, options[:timeout_in_seconds]
end
wait_for_visible(locator, options={}) click to toggle source

Wait for something to be visible (the wait happens in the browser).

# File lib/selenium/client/extensions.rb, line 113
def wait_for_visible(locator, options={})
  builder = JavascriptExpressionBuilder.new
  wait_for_condition builder.visible(locator).script, options[:timeout_in_seconds]
end