Class: Capybara::Session

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Searchable
Defined in:
lib/capybara/session.rb

Constant Summary collapse

DSL_METHODS = 
[
  :all, :attach_file, :body, :check, :choose, :click, :click_button, :click_link, :current_url, :drag, :evaluate_script,
  :field_labeled, :fill_in, :find, :find_button, :find_by_id, :find_field, :find_link, :has_content?, :has_css?,
  :has_no_content?, :has_no_css?, :has_no_xpath?, :has_xpath?, :locate, :save_and_open_page, :select, :source, :uncheck,
  :visit, :wait_until, :within, :within_fieldset, :within_table, :within_frame, :has_link?, :has_no_link?, :has_button?,
  :has_no_button?,    :has_field?, :has_no_field?, :has_checked_field?, :has_unchecked_field?, :has_no_table?, :has_table?,
  :unselect, :has_select?, :has_no_select?
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Searchable

#all, #find, #find_button, #find_by_id, #find_field, #find_link

Constructor Details

#initialize(mode, app = nil) ⇒ Session

Returns a new instance of Session.



20
21
22
23
 
# File 'lib/capybara/session.rb', line 20

def initialize(mode, app=nil)
  @mode = mode
  @app = app
end

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app.



18
19
20
 
# File 'lib/capybara/session.rb', line 18

def app
  @app
end

#mode ⇒ Object (readonly)

Returns the value of attribute mode.



18
19
20
 
# File 'lib/capybara/session.rb', line 18

def mode
  @mode
end

Instance Method Details

#attach_file(locator, path) ⇒ Object 



94
95
96
97
 
# File 'lib/capybara/session.rb', line 94

def attach_file(locator, path)
  msg = "cannot attach file, no file field with id, name, or label '#{locator}' found"
  locate(:xpath, XPath.file_field(locator), msg).set(path)
end

#check(locator) ⇒ Object 



74
75
76
77
 
# File 'lib/capybara/session.rb', line 74

def check(locator)
  msg = "cannot check field, no checkbox with id, name, or label '#{locator}' found"
  locate(:xpath, XPath.checkbox(locator), msg).set(true)
end

#choose(locator) ⇒ Object 



69
70
71
72
 
# File 'lib/capybara/session.rb', line 69

def choose(locator)
  msg = "cannot choose field, no radio button with id, name, or label '#{locator}' found"
  locate(:xpath, XPath.radio_button(locator), msg).set(true)
end

#click(locator) ⇒ Object 



42
43
44
45
 
# File 'lib/capybara/session.rb', line 42

def click(locator)
  msg = "no link or button '#{locator}' found"
  locate(:xpath, XPath.link(locator).button(locator), msg).click
end

#click_button(locator) ⇒ Object 



52
53
54
55
 
# File 'lib/capybara/session.rb', line 52

def click_button(locator)
  msg = "no button with value or id or text '#{locator}' found"
  locate(:xpath, XPath.button(locator), msg).click
end

#click_link(locator) ⇒ Object 



47
48
49
50
 
# File 'lib/capybara/session.rb', line 47

def click_link(locator)
  msg = "no link with title, id or text '#{locator}' found"
  locate(:xpath, XPath.link(locator), msg).click
end

#drag(source_locator, target_locator) ⇒ Object 



57
58
59
60
61
 
# File 'lib/capybara/session.rb', line 57

def drag(source_locator, target_locator)
  source = locate(:xpath, source_locator, "drag source '#{source_locator}' not found on page")
  target = locate(:xpath, target_locator, "drag target '#{target_locator}' not found on page")
  source.drag_to(target)
end

#driver ⇒ Object 



25
26
27
28
29
30
31
32
33
 
# File 'lib/capybara/session.rb', line 25

def driver
  @driver ||= begin                    
    string = mode.to_s
    string.gsub!(%r{(^.)|(_.)}) { |m| m[m.length-1,1].upcase }
    Capybara::Driver.const_get(string.to_sym).new(app)
  rescue NameError
    raise Capybara::DriverNotFoundError, "no driver called #{mode} was found"
  end
end

#evaluate_script(script) ⇒ Object 



238
239
240
 
# File 'lib/capybara/session.rb', line 238

def evaluate_script(script)
  driver.evaluate_script(script)
end

#fill_in(locator, options = {}) ⇒ Object 



63
64
65
66
67
 
# File 'lib/capybara/session.rb', line 63

def fill_in(locator, options={})
  msg = "cannot fill in, no text field, text area or password field with id, name, or label '#{locator}' found"
  raise "Must pass a hash containing 'with'" if not options.is_a?(Hash) or not options.has_key?(:with)
  locate(:xpath, XPath.fillable_field(locator), msg).set(options[:with])
end

#has_button?(locator) ⇒ Boolean

Returns:

  • (Boolean) 


181
182
183
 
# File 'lib/capybara/session.rb', line 181

def has_button?(locator)
  has_xpath?(XPath.button(locator))
end

#has_checked_field?(locator) ⇒ Boolean

Returns:

  • (Boolean) 


197
198
199
 
# File 'lib/capybara/session.rb', line 197

def has_checked_field?(locator)
  has_xpath?(XPath.field(locator, :checked => true))
end

#has_content?(content) ⇒ Boolean

Returns:

  • (Boolean) 


165
166
167
 
# File 'lib/capybara/session.rb', line 165

def has_content?(content)
  has_xpath?(XPath.content(content))
end

#has_css?(path, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
 
# File 'lib/capybara/session.rb', line 157

def has_css?(path, options={})
  has_xpath?(XPath.from_css(path), options)
end

#has_field?(locator, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


189
190
191
 
# File 'lib/capybara/session.rb', line 189

def has_field?(locator, options={})
  has_xpath?(XPath.field(locator, options))
end

#has_link?(locator) ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/capybara/session.rb', line 173

def has_link?(locator)
  has_xpath?(XPath.link(locator))
end

#has_no_button?(locator) ⇒ Boolean

Returns:

  • (Boolean) 


185
186
187
 
# File 'lib/capybara/session.rb', line 185

def has_no_button?(locator)
  has_no_xpath?(XPath.button(locator))
end

#has_no_content?(content) ⇒ Boolean

Returns:

  • (Boolean) 


169
170
171
 
# File 'lib/capybara/session.rb', line 169

def has_no_content?(content)
  has_no_xpath?(XPath.content(content))
end

#has_no_css?(path, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/capybara/session.rb', line 161

def has_no_css?(path, options={})
  has_no_xpath?(XPath.from_css(path), options)
end

#has_no_field?(locator, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/capybara/session.rb', line 193

def has_no_field?(locator, options={})
  has_no_xpath?(XPath.field(locator, options))
end

#has_no_link?(locator) ⇒ Boolean

Returns:

  • (Boolean) 


177
178
179
 
# File 'lib/capybara/session.rb', line 177

def has_no_link?(locator)
  has_no_xpath?(XPath.link(locator))
end

#has_no_select?(locator, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


209
210
211
 
# File 'lib/capybara/session.rb', line 209

def has_no_select?(locator, options={})
  has_no_xpath?(XPath.select(locator, options))
end

#has_no_table?(locator, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


217
218
219
 
# File 'lib/capybara/session.rb', line 217

def has_no_table?(locator, options={})
  has_no_xpath?(XPath.table(locator, options))
end

#has_no_xpath?(path, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/capybara/session.rb', line 143

def has_no_xpath?(path, options={})
  wait_conditionally_until do
    results = all(:xpath, path, options)

    if options[:count]
      results.size != options[:count]
    else
      results.empty?
    end
  end
rescue Capybara::TimeoutError
  return false
end

#has_select?(locator, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


205
206
207
 
# File 'lib/capybara/session.rb', line 205

def has_select?(locator, options={})
  has_xpath?(XPath.select(locator, options))
end

#has_table?(locator, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


213
214
215
 
# File 'lib/capybara/session.rb', line 213

def has_table?(locator, options={})
  has_xpath?(XPath.table(locator, options))
end

#has_unchecked_field?(locator) ⇒ Boolean

Returns:

  • (Boolean) 


201
202
203
 
# File 'lib/capybara/session.rb', line 201

def has_unchecked_field?(locator)
  has_xpath?(XPath.field(locator, :unchecked => true))
end

#has_xpath?(path, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/capybara/session.rb', line 129

def has_xpath?(path, options={})
  wait_conditionally_until do
    results = all(:xpath, path, options)

    if options[:count]
      results.size == options[:count]
    else
      results.size > 0
    end
  end
rescue Capybara::TimeoutError
  return false
end

#locate(kind_or_locator, locator = nil, fail_msg = nil) ⇒ Object

return node identified by locator or raise ElementNotFound(using desc)



227
228
229
230
231
232
 
# File 'lib/capybara/session.rb', line 227

def locate(kind_or_locator, locator=nil, fail_msg = nil)
  node = wait_conditionally_until { find(kind_or_locator, locator) }
ensure
  raise Capybara::ElementNotFound, fail_msg || "Unable to locate '#{kind_or_locator}'" unless node
  return node
end

#save_and_open_page ⇒ Object 



221
222
223
224
 
# File 'lib/capybara/session.rb', line 221

def save_and_open_page
  require 'capybara/save_and_open_page'
  Capybara::SaveAndOpenPage.save_and_open_page(body)
end

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



84
85
86
87
 
# File 'lib/capybara/session.rb', line 84

def select(value, options={})
  msg = "cannot select option, no select box with id, name, or label '#{options[:from]}' found"
  locate(:xpath, XPath.select(options[:from]), msg).select(value)
end

#uncheck(locator) ⇒ Object 



79
80
81
82
 
# File 'lib/capybara/session.rb', line 79

def uncheck(locator)
  msg = "cannot uncheck field, no checkbox with id, name, or label '#{locator}' found"
  locate(:xpath, XPath.checkbox(locator), msg).set(false)
end

#unselect(value, options = {}) ⇒ Object 



89
90
91
92
 
# File 'lib/capybara/session.rb', line 89

def unselect(value, options={})
  msg = "cannot unselect option, no select box with id, name, or label '#{options[:from]}' found"
  locate(:xpath, XPath.select(options[:from]), msg).unselect(value)
end

#wait_until(timeout = Capybara.default_wait_time) ⇒ Object 



234
235
236
 
# File 'lib/capybara/session.rb', line 234

def wait_until(timeout = Capybara.default_wait_time)
  WaitUntil.timeout(timeout,driver) { yield }
end

#within(kind, scope = nil) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/capybara/session.rb', line 99

def within(kind, scope=nil)
  kind, scope = Capybara.default_selector, kind unless scope
  scope = XPath.from_css(scope) if kind == :css
  locate(:xpath, scope, "scope '#{scope}' not found on page")
  begin
    scopes.push(scope)
    yield
  ensure
    scopes.pop
  end
end

#within_fieldset(locator) ⇒ Object 



111
112
113
114
115
 
# File 'lib/capybara/session.rb', line 111

def within_fieldset(locator)
  within :xpath, XPath.fieldset(locator) do
    yield
  end
end

#within_frame(frame_id) ⇒ Object 



123
124
125
126
127
 
# File 'lib/capybara/session.rb', line 123

def within_frame(frame_id)
  driver.within_frame(frame_id) do
    yield
  end
end

#within_table(locator) ⇒ Object 



117
118
119
120
121
 
# File 'lib/capybara/session.rb', line 117

def within_table(locator)
  within :xpath, XPath.table(locator) do
    yield
  end
end