Top Level Namespace

Defined Under Namespace

Modules: Capybara, XPath Classes: TestApp

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.feature(*args, &block) ⇒ Object



42
43
44
45
46
47
48
49
50
51
# File 'lib/capybara/rspec/features.rb', line 42

def self.feature(*args, &block)
  options = if args.last.is_a?(Hash) then args.pop else {} end
  options[:capybara_feature] = true
  options[:type] = :feature
  options[:caller] ||= caller
  args.push(options)

  #call describe on RSpec in case user has expose_dsl_globally set to false
  RSpec.describe(*args, &block)
end

Instance Method Details

#buttonObject

Find buttons ( input [of type submit, reset, image, button] or button elements )



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/capybara/selector.rb', line 161

Capybara.add_selector(:button) do
  xpath(:id, :value, :title, :class) do |locator, options={}|
    input_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).one_of('submit', 'reset', 'image', 'button')]
    btn_xpath = XPath.descendant(:button)
    image_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).equals('image')]

    unless locator.nil?
      locator = locator.to_s
      locator_matches = XPath.attr(:id).equals(locator) | XPath.attr(:value).is(locator) | XPath.attr(:title).is(locator)
      locator_matches |= XPath.attr(:aria-label').is(locator) if Capybara.enable_aria_label

      input_btn_xpath = input_btn_xpath[locator_matches]

      btn_xpath = btn_xpath[locator_matches | XPath.string.n.is(locator)]

      alt_matches = XPath.attr(:alt).is(locator)
      alt_matches |= XPath.attr(:aria-label').is(locator) if Capybara.enable_aria_label
      image_btn_xpath = image_btn_xpath[alt_matches]
    end

    res_xpath = input_btn_xpath + btn_xpath + image_btn_xpath

    res_xpath = expression_filters.inject(res_xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }

    res_xpath
  end

  filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| not(value ^ node.disabled?) }

  describe do |options|
    desc = String.new
    desc << " that is disabled" if options[:disabled] == true
    expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
    desc
  end
end

#checkboxObject

Find checkboxes



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'lib/capybara/selector.rb', line 260

Capybara.add_selector(:checkbox) do
  xpath(:id, :name, :class) do |locator, options|
    xpath = XPath.descendant(:input)[XPath.attr(:type).equals('checkbox')]
    locate_field(xpath, locator, options)
  end

  filter_set(:_field, [:checked, :unchecked, :disabled])

  filter(:option)  { |node, value|  node.value == value.to_s }

  describe do |options|
    desc = String.new
    desc << " with value #{options[:option].inspect}" if options[:option]
    expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
    desc
  end
end

#cssObject

Select elements by CSS selector



37
38
39
# File 'lib/capybara/selector.rb', line 37

Capybara.add_selector(:css) do
  css { |css| css }
end

#fieldObject

Select field elements (input [not of type submit, image, or hidden], textarea, select)



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/capybara/selector.rb', line 66

Capybara.add_selector(:field) do
  xpath(:id, :name, :placeholder, :type, :class) do |locator, options|
    xpath = XPath.descendant(:input, :textarea, :select)[~XPath.attr(:type).one_of('submit', 'image', 'hidden')]
    if options[:type]
      type=options[:type].to_s
      if ['textarea', 'select'].include?(type)
        xpath = XPath.descendant(type.to_sym)
      else
        xpath = xpath[XPath.attr(:type).equals(type)]
      end
    end
    xpath=locate_field(xpath, locator, options)
    xpath
  end

  filter_set(:_field) # checked/unchecked/disabled/multiple

  filter(:readonly, :boolean) { |node, value| not(value ^ node.readonly?) }
  filter(:with) do |node, with|
    with.is_a?(Regexp) ? node.value =~ with : node.value == with.to_s
  end
  describe do |options|
    desc = String.new
    (expression_filters - [:type]).each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
    desc << " of type #{options[:type].inspect}" if options[:type]
    desc << " with value #{options[:with].to_s.inspect}" if options.has_key?(:with)
    desc
  end
end

#fieldsetObject

Select fieldset elements



106
107
108
109
110
111
112
113
114
115
# File 'lib/capybara/selector.rb', line 106

Capybara.add_selector(:fieldset) do
  xpath(:id, :legend, :class) do |locator, options|
    xpath = XPath.descendant(:fieldset)
    xpath = xpath[XPath.attr(:id).equals(locator.to_s) | XPath.child(:legend)[XPath.string.n.is(locator.to_s)]] unless locator.nil?
    xpath = xpath[XPath.attr(:id).equals(options[:id])] if options[:id]
    xpath = xpath[XPath.child(:legend)[XPath.string.n.is(options[:legend])]] if options[:legend]
    xpath = xpath[find_by_attr(:class, options[:class])]
    xpath
  end
end

#file_fieldObject

Find file input elements



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
# File 'lib/capybara/selector.rb', line 347

Capybara.add_selector(:file_field) do
  label "file field"
  xpath(:id, :name, :class) do |locator, options|
    xpath = XPath.descendant(:input)[XPath.attr(:type).equals('file')]
    locate_field(xpath, locator, options)
  end

  filter_set(:_field, [:disabled, :multiple])

  describe do |options|
    desc = String.new
    expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
    desc
  end
end

#fillable_fieldObject

Find text fillable fields ( textarea, input [not of type submit, image, radio, checkbox, hidden, file] )



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/capybara/selector.rb', line 217

Capybara.add_selector(:fillable_field) do
  label "field"
  xpath(:id, :name, :placeholder, :class) do |locator, options|
    xpath = XPath.descendant(:input, :textarea)[~XPath.attr(:type).one_of('submit', 'image', 'radio', 'checkbox', 'hidden', 'file')]
    locate_field(xpath, locator, options)
  end

  filter_set(:_field, [:disabled, :multiple])

  describe do |options|
    desc = String.new
    expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
    desc
  end
end

#frameObject

Find frame/iframe elements



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
# File 'lib/capybara/selector.rb', line 419

Capybara.add_selector(:frame) do
  xpath(:id, :name, :class) do |locator, options|
    xpath = XPath.descendant(:iframe) + XPath.descendant(:frame)
    xpath = xpath[XPath.attr(:id).equals(locator.to_s) | XPath.attr(:name).equals(locator)] unless locator.nil?
    xpath = expression_filters.inject(xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }
    xpath
  end

  describe do |options|
    desc = String.new
    desc << " with id #{options[:id]}" if options[:id]
    desc << " with name #{options[:name]}" if options[:name]
    desc
  end
end

#idObject

Select element by id



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

Capybara.add_selector(:id) do
  xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] }
end

#labelObject

Find label elements



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'lib/capybara/selector.rb', line 367

Capybara.add_selector(:label) do
  label "label"
  xpath do |locator|
    xpath = XPath.descendant(:label)
    xpath = xpath[XPath.string.n.is(locator.to_s) | XPath.attr(:id).equals(locator.to_s)] unless locator.nil?
    xpath
  end

  filter(:for) do |node, field_or_value|
    if field_or_value.is_a? Capybara::Node::Element
      if field_or_value[:id] && (field_or_value[:id] == node[:for])
        true
      else
        field_or_value.find_xpath('./ancestor::label[1]').include? node.base
      end
    else
      node[:for] == field_or_value.to_s
    end
  end

  describe do |options|
    desc = String.new
    desc << " for #{options[:for]}" if options[:for]
    desc
  end
end

Find links ( <a> elements with an href attribute )



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/capybara/selector.rb', line 129

Capybara.add_selector(:link) do
  xpath(:id, :title, :alt, :class) do |locator, options={}|
    xpath = XPath.descendant(:a)[XPath.attr(:href)]
    unless locator.nil?
      locator = locator.to_s
      matchers = XPath.attr(:id).equals(locator) |
                 XPath.string.n.is(locator) |
                 XPath.attr(:title).is(locator) |
                 XPath.descendant(:img)[XPath.attr(:alt).is(locator)]
      matchers |= XPath.attr(:aria-label').is(locator) if Capybara.enable_aria_label
      xpath = xpath[matchers]
    end
    xpath = [:id, :title, :class].inject(xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }
    xpath = xpath[XPath.descendant(:img)[XPath.attr(:alt).equals(options[:alt])]] if options[:alt]
    xpath
  end

  filter(:href) do |node, href|
    if href.is_a? Regexp
      node[:href].match href
    else
      node.first(:xpath, XPath.axis(:self)[XPath.attr(:href).equals(href.to_s)], minimum: 0)
    end
  end

  describe { |options| " with href #{options[:href].inspect}" if options[:href] }
end

Find links or buttons



202
203
204
205
206
207
208
209
210
211
# File 'lib/capybara/selector.rb', line 202

Capybara.add_selector(:link_or_button) do
  label "link or button"
  xpath do |locator, options|
    self.class.all.values_at(:link, :button).map {|selector| selector.xpath.call(locator, options)}.reduce(:+)
  end

  filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| node.tag_name == "a" or not(value ^ node.disabled?) }

  describe { |options| " that is disabled" if options[:disabled] }
end

#optionObject

Find option elements



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'lib/capybara/selector.rb', line 325

Capybara.add_selector(:option) do
  xpath do |locator|
    xpath = XPath.descendant(:option)
    xpath = xpath[XPath.string.n.is(locator.to_s)] unless locator.nil?
    xpath
  end

  filter(:disabled, :boolean) { |node, value| not(value ^ node.disabled?) }
  filter(:selected, :boolean) { |node, value| not(value ^ node.selected?) }

  describe do |options|
    desc = String.new
    desc << " that is#{' not' unless options[:disabled]} disabled" if options.has_key?(:disabled)
    desc << " that is#{' not' unless options[:selected]} selected" if options.has_key?(:selected)
    desc
  end
end

#radio_buttonObject

Find radio buttons



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/capybara/selector.rb', line 237

Capybara.add_selector(:radio_button) do
  label "radio button"
  xpath(:id, :name, :class) do |locator, options|
    xpath = XPath.descendant(:input)[XPath.attr(:type).equals('radio')]
    locate_field(xpath, locator, options)
  end

  filter_set(:_field, [:checked, :unchecked, :disabled])

  filter(:option)  { |node, value|  node.value == value.to_s }

  describe do |options|
    desc = String.new
    desc << " with value #{options[:option].inspect}" if options[:option]
    expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
    desc
  end
end

#selectObject

Find select elements



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'lib/capybara/selector.rb', line 282

Capybara.add_selector(:select) do
  label "select box"
  xpath(:id, :name, :placeholder, :class) do |locator, options|
    xpath = XPath.descendant(:select)
    locate_field(xpath, locator, options)
  end

  filter_set(:_field, [:disabled, :multiple])

  filter(:options) do |node, options|
    if node.visible?
      actual = node.all(:xpath, './/option').map { |option| option.text }
    else
      actual = node.all(:xpath, './/option', visible: false).map { |option| option.text(:all) }
    end
    options.sort == actual.sort
  end
  filter(:with_options) do |node, options|
    finder_settings = { minimum: 0 }
    if !node.visible?
      finder_settings[:visible] = false
    end
    options.all? { |option| node.first(:option, option, finder_settings) }
  end
  filter(:selected) do |node, selected|
    actual = node.all(:xpath, './/option', visible: false).select { |option| option.selected? }.map { |option| option.text(:all) }
    [selected].flatten.sort == actual.sort
  end

  describe do |options|
    desc = String.new
    desc << " with options #{options[:options].inspect}" if options[:options]
    desc << " with at least options #{options[:with_options].inspect}" if options[:with_options]
    desc << " with #{options[:selected].inspect} selected" if options[:selected]
    expression_filters.each { |ef| desc << " with #{ef.to_s} #{options[ef]}" if options.has_key?(ef) }
    desc
  end
end

#tableObject

Find table elements



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
# File 'lib/capybara/selector.rb', line 398

Capybara.add_selector(:table) do
  xpath(:id, :caption, :class) do |locator, options|
    xpath = XPath.descendant(:table)
    xpath = xpath[XPath.attr(:id).equals(locator.to_s) | XPath.descendant(:caption).is(locator.to_s)] unless locator.nil?
    xpath = xpath[XPath.descendant(:caption).equals(options[:caption])] if options[:caption]
    xpath = [:id, :class].inject(xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }
    xpath
  end

  describe do |options|
    desc = String.new
    desc << " with id #{options[:id]}" if options[:id]
    desc << " with caption #{options[:caption]}" if options[:caption]
    desc
  end
end

#xpathObject

Select elements by XPath expression



27
28
29
# File 'lib/capybara/selector.rb', line 27

Capybara.add_selector(:xpath) do
  xpath { |xpath| xpath }
end