Class: Webrat::SeleniumSession

Inherits:
Object
  • Object
show all
Includes:
SaveAndOpenPage
Defined in:
lib/webrat/selenium/selenium_session.rb

Instance Method Summary collapse

Methods included from SaveAndOpenPage

#doc_root, #open_in_browser, #rewrite_css_and_image_references, #save_and_open_page, #saved_page_dir

Constructor Details

#initialize(*args) ⇒ SeleniumSession

:nodoc:



26
27
 
# File 'lib/webrat/selenium/selenium_session.rb', line 26

def initialize(*args) # :nodoc:
end

Instance Method Details

#automate ⇒ Object 



32
33
34
 
# File 'lib/webrat/selenium/selenium_session.rb', line 32

def automate
  yield
end

#check(label_text) ⇒ Object Also known as: uncheck 



113
114
115
116
117
 
# File 'lib/webrat/selenium/selenium_session.rb', line 113

def check(label_text)
  locator = "webrat=#{label_text}"
  selenium.wait_for_element locator, :timeout_in_seconds => 5
  selenium.click locator
end

#choose(label_text) ⇒ Object 



105
106
107
108
109
 
# File 'lib/webrat/selenium/selenium_session.rb', line 105

def choose(label_text)
  locator = "webrat=#{label_text}"
  selenium.wait_for_element locator, :timeout_in_seconds => 5
  selenium.click locator
end

#click_button(button_text_or_regexp = nil, options = {}) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/webrat/selenium/selenium_session.rb', line 58

def click_button(button_text_or_regexp = nil, options = {})
  if button_text_or_regexp.is_a?(Hash) && options == {}
    pattern, options = nil, button_text_or_regexp
  elsif button_text_or_regexp
    pattern = adjust_if_regexp(button_text_or_regexp)
  end
  pattern ||= '*'
  locator = "button=#{pattern}"

  selenium.wait_for_element locator, :timeout_in_seconds => 5
  selenium.click locator
end

#click_link(link_text_or_regexp, options = {}) ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/webrat/selenium/selenium_session.rb', line 73

def click_link(link_text_or_regexp, options = {})
  pattern = adjust_if_regexp(link_text_or_regexp)
  locator = "webratlink=#{pattern}"
  selenium.wait_for_element locator, :timeout_in_seconds => 5
  selenium.click locator
end

#click_link_within(selector, link_text, options = {}) ⇒ Object 



82
83
84
85
86
 
# File 'lib/webrat/selenium/selenium_session.rb', line 82

def click_link_within(selector, link_text, options = {})
  locator = "webratlinkwithin=#{selector}|#{link_text}"
  selenium.wait_for_element locator, :timeout_in_seconds => 5
  selenium.click locator
end

#fill_in(field_identifier, options) ⇒ Object 



42
43
44
45
46
 
# File 'lib/webrat/selenium/selenium_session.rb', line 42

def fill_in(field_identifier, options)
  locator = "webrat=#{Regexp.escape(field_identifier)}"
  selenium.wait_for_element locator, :timeout_in_seconds => 5
  selenium.type(locator, "#{options[:with]}")
end

#fire_event(field_identifier, event) ⇒ Object 



122
123
124
125
 
# File 'lib/webrat/selenium/selenium_session.rb', line 122

def fire_event(field_identifier, event)
  locator = "webrat=#{Regexp.escape(field_identifier)}"
  selenium.fire_event(locator, "#{event}")
end

#key_down(field_identifier, key_code) ⇒ Object 



127
128
129
130
 
# File 'lib/webrat/selenium/selenium_session.rb', line 127

def key_down(field_identifier, key_code)
  locator = "webrat=#{Regexp.escape(field_identifier)}"
  selenium.key_down(locator, key_code)
end

#key_up(field_identifier, key_code) ⇒ Object 



132
133
134
135
 
# File 'lib/webrat/selenium/selenium_session.rb', line 132

def key_up(field_identifier, key_code)
  locator = "webrat=#{Regexp.escape(field_identifier)}"
  selenium.key_up(locator, key_code)
end

#response ⇒ Object 



50
51
52
 
# File 'lib/webrat/selenium/selenium_session.rb', line 50

def response
  SeleniumResponse.new(self, response_body)
end

#response_body ⇒ Object

:nodoc:



54
55
56
 
# File 'lib/webrat/selenium/selenium_session.rb', line 54

def response_body #:nodoc:
  selenium.get_html_source
end

#save_and_open_screengrab ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/webrat/selenium/selenium_session.rb', line 170

def save_and_open_screengrab
  return unless File.exist?(saved_page_dir)

  filename = "#{saved_page_dir}/webrat-#{Time.now.to_i}.png"

  if $browser.chrome_backend?
    $browser.capture_entire_page_screenshot(filename, '')
  else
    $browser.capture_screenshot(filename)
  end
    open_in_browser(filename)
end

#select(option_text, options = {}) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/webrat/selenium/selenium_session.rb', line 90

def select(option_text, options = {})
  id_or_name_or_label = options[:from]

  if id_or_name_or_label
    select_locator = "webrat=#{id_or_name_or_label}"
  else
    select_locator = "webratselectwithoption=#{option_text}"
  end

  selenium.wait_for_element select_locator, :timeout_in_seconds => 5
  selenium.select(select_locator, option_text)
end

#selenium ⇒ Object 



161
162
163
164
165
 
# File 'lib/webrat/selenium/selenium_session.rb', line 161

def selenium
  return $browser if $browser
  setup
  $browser
end

#simulate ⇒ Object 



29
30
 
# File 'lib/webrat/selenium/selenium_session.rb', line 29

def simulate
end

#visit(url) ⇒ Object 



36
37
38
 
# File 'lib/webrat/selenium/selenium_session.rb', line 36

def visit(url)
  selenium.open(url)
end

#wait_for(params = {}) ⇒ Object

Raises:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/webrat/selenium/selenium_session.rb', line 137

def wait_for(params={})
  timeout = params[:timeout] || 5
  message = params[:message] || "Timeout exceeded"

  begin_time = Time.now

  while (Time.now - begin_time) < timeout
    value = nil

    begin
      value = yield
    rescue ::Spec::Expectations::ExpectationNotMetError, ::Selenium::CommandError, Webrat::WebratError
      value = nil
    end

    return value if value

    sleep 0.25
  end

  raise Webrat::TimeoutError.new(message + " (after #{timeout} sec)")
  true
end