capybara 2.15.1 → 3.35.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (298) hide show
  1. checksums.yaml +5 -5
  2. data/.yardopts +1 -1
  3. data/History.md +871 -9
  4. data/License.txt +1 -1
  5. data/README.md +99 -75
  6. data/lib/capybara/config.rb +20 -59
  7. data/lib/capybara/cucumber.rb +2 -3
  8. data/lib/capybara/driver/base.rb +35 -18
  9. data/lib/capybara/driver/node.rb +35 -9
  10. data/lib/capybara/dsl.rb +15 -6
  11. data/lib/capybara/helpers.rb +72 -28
  12. data/lib/capybara/minitest/spec.rb +173 -81
  13. data/lib/capybara/minitest.rb +220 -111
  14. data/lib/capybara/node/actions.rb +270 -172
  15. data/lib/capybara/node/base.rb +41 -34
  16. data/lib/capybara/node/document.rb +15 -3
  17. data/lib/capybara/node/document_matchers.rb +19 -21
  18. data/lib/capybara/node/element.rb +353 -137
  19. data/lib/capybara/node/finders.rb +144 -138
  20. data/lib/capybara/node/matchers.rb +369 -209
  21. data/lib/capybara/node/simple.rb +55 -26
  22. data/lib/capybara/queries/ancestor_query.rb +11 -9
  23. data/lib/capybara/queries/base_query.rb +39 -28
  24. data/lib/capybara/queries/current_path_query.rb +22 -25
  25. data/lib/capybara/queries/match_query.rb +14 -7
  26. data/lib/capybara/queries/selector_query.rb +633 -145
  27. data/lib/capybara/queries/sibling_query.rb +10 -9
  28. data/lib/capybara/queries/style_query.rb +45 -0
  29. data/lib/capybara/queries/text_query.rb +56 -38
  30. data/lib/capybara/queries/title_query.rb +8 -11
  31. data/lib/capybara/rack_test/browser.rb +57 -41
  32. data/lib/capybara/rack_test/css_handlers.rb +6 -4
  33. data/lib/capybara/rack_test/driver.rb +18 -13
  34. data/lib/capybara/rack_test/errors.rb +6 -0
  35. data/lib/capybara/rack_test/form.rb +73 -58
  36. data/lib/capybara/rack_test/node.rb +182 -78
  37. data/lib/capybara/rails.rb +3 -7
  38. data/lib/capybara/registration_container.rb +44 -0
  39. data/lib/capybara/registrations/drivers.rb +42 -0
  40. data/lib/capybara/registrations/patches/puma_ssl.rb +29 -0
  41. data/lib/capybara/registrations/servers.rb +45 -0
  42. data/lib/capybara/result.rb +96 -62
  43. data/lib/capybara/rspec/features.rb +17 -50
  44. data/lib/capybara/rspec/matcher_proxies.rb +51 -14
  45. data/lib/capybara/rspec/matchers/base.rb +111 -0
  46. data/lib/capybara/rspec/matchers/become_closed.rb +33 -0
  47. data/lib/capybara/rspec/matchers/compound.rb +88 -0
  48. data/lib/capybara/rspec/matchers/count_sugar.rb +37 -0
  49. data/lib/capybara/rspec/matchers/have_ancestor.rb +28 -0
  50. data/lib/capybara/rspec/matchers/have_current_path.rb +29 -0
  51. data/lib/capybara/rspec/matchers/have_selector.rb +77 -0
  52. data/lib/capybara/rspec/matchers/have_sibling.rb +27 -0
  53. data/lib/capybara/rspec/matchers/have_text.rb +33 -0
  54. data/lib/capybara/rspec/matchers/have_title.rb +29 -0
  55. data/lib/capybara/rspec/matchers/match_selector.rb +27 -0
  56. data/lib/capybara/rspec/matchers/match_style.rb +43 -0
  57. data/lib/capybara/rspec/matchers/spatial_sugar.rb +39 -0
  58. data/lib/capybara/rspec/matchers.rb +144 -264
  59. data/lib/capybara/rspec.rb +7 -11
  60. data/lib/capybara/selector/builders/css_builder.rb +84 -0
  61. data/lib/capybara/selector/builders/xpath_builder.rb +71 -0
  62. data/lib/capybara/selector/css.rb +89 -17
  63. data/lib/capybara/selector/definition/button.rb +63 -0
  64. data/lib/capybara/selector/definition/checkbox.rb +26 -0
  65. data/lib/capybara/selector/definition/css.rb +10 -0
  66. data/lib/capybara/selector/definition/datalist_input.rb +35 -0
  67. data/lib/capybara/selector/definition/datalist_option.rb +25 -0
  68. data/lib/capybara/selector/definition/element.rb +28 -0
  69. data/lib/capybara/selector/definition/field.rb +40 -0
  70. data/lib/capybara/selector/definition/fieldset.rb +14 -0
  71. data/lib/capybara/selector/definition/file_field.rb +13 -0
  72. data/lib/capybara/selector/definition/fillable_field.rb +33 -0
  73. data/lib/capybara/selector/definition/frame.rb +17 -0
  74. data/lib/capybara/selector/definition/id.rb +6 -0
  75. data/lib/capybara/selector/definition/label.rb +62 -0
  76. data/lib/capybara/selector/definition/link.rb +54 -0
  77. data/lib/capybara/selector/definition/link_or_button.rb +16 -0
  78. data/lib/capybara/selector/definition/option.rb +27 -0
  79. data/lib/capybara/selector/definition/radio_button.rb +27 -0
  80. data/lib/capybara/selector/definition/select.rb +81 -0
  81. data/lib/capybara/selector/definition/table.rb +109 -0
  82. data/lib/capybara/selector/definition/table_row.rb +21 -0
  83. data/lib/capybara/selector/definition/xpath.rb +5 -0
  84. data/lib/capybara/selector/definition.rb +278 -0
  85. data/lib/capybara/selector/filter.rb +2 -17
  86. data/lib/capybara/selector/filter_set.rb +83 -33
  87. data/lib/capybara/selector/filters/base.rb +50 -6
  88. data/lib/capybara/selector/filters/expression_filter.rb +8 -26
  89. data/lib/capybara/selector/filters/locator_filter.rb +29 -0
  90. data/lib/capybara/selector/filters/node_filter.rb +16 -12
  91. data/lib/capybara/selector/regexp_disassembler.rb +214 -0
  92. data/lib/capybara/selector/selector.rb +89 -210
  93. data/lib/capybara/selector/xpath_extensions.rb +17 -0
  94. data/lib/capybara/selector.rb +226 -526
  95. data/lib/capybara/selenium/atoms/getAttribute.min.js +1 -0
  96. data/lib/capybara/selenium/atoms/isDisplayed.min.js +1 -0
  97. data/lib/capybara/selenium/atoms/src/getAttribute.js +161 -0
  98. data/lib/capybara/selenium/atoms/src/isDisplayed.js +454 -0
  99. data/lib/capybara/selenium/driver.rb +334 -277
  100. data/lib/capybara/selenium/driver_specializations/chrome_driver.rb +117 -0
  101. data/lib/capybara/selenium/driver_specializations/edge_driver.rb +124 -0
  102. data/lib/capybara/selenium/driver_specializations/firefox_driver.rb +89 -0
  103. data/lib/capybara/selenium/driver_specializations/internet_explorer_driver.rb +26 -0
  104. data/lib/capybara/selenium/driver_specializations/safari_driver.rb +24 -0
  105. data/lib/capybara/selenium/extensions/file_input_click_emulation.rb +34 -0
  106. data/lib/capybara/selenium/extensions/find.rb +110 -0
  107. data/lib/capybara/selenium/extensions/html5_drag.rb +228 -0
  108. data/lib/capybara/selenium/extensions/modifier_keys_stack.rb +28 -0
  109. data/lib/capybara/selenium/extensions/scroll.rb +76 -0
  110. data/lib/capybara/selenium/logger_suppressor.rb +40 -0
  111. data/lib/capybara/selenium/node.rb +506 -124
  112. data/lib/capybara/selenium/nodes/chrome_node.rb +137 -0
  113. data/lib/capybara/selenium/nodes/edge_node.rb +104 -0
  114. data/lib/capybara/selenium/nodes/firefox_node.rb +136 -0
  115. data/lib/capybara/selenium/nodes/ie_node.rb +22 -0
  116. data/lib/capybara/selenium/nodes/safari_node.rb +118 -0
  117. data/lib/capybara/selenium/patches/action_pauser.rb +26 -0
  118. data/lib/capybara/selenium/patches/atoms.rb +18 -0
  119. data/lib/capybara/selenium/patches/is_displayed.rb +16 -0
  120. data/lib/capybara/selenium/patches/logs.rb +45 -0
  121. data/lib/capybara/selenium/patches/pause_duration_fix.rb +9 -0
  122. data/lib/capybara/selenium/patches/persistent_client.rb +20 -0
  123. data/lib/capybara/server/animation_disabler.rb +63 -0
  124. data/lib/capybara/server/checker.rb +44 -0
  125. data/lib/capybara/server/middleware.rb +71 -0
  126. data/lib/capybara/server.rb +59 -67
  127. data/lib/capybara/session/config.rb +79 -59
  128. data/lib/capybara/session/matchers.rb +41 -25
  129. data/lib/capybara/session.rb +360 -356
  130. data/lib/capybara/spec/public/jquery.js +5 -5
  131. data/lib/capybara/spec/public/offset.js +6 -0
  132. data/lib/capybara/spec/public/test.js +159 -13
  133. data/lib/capybara/spec/session/accept_alert_spec.rb +12 -11
  134. data/lib/capybara/spec/session/accept_confirm_spec.rb +6 -5
  135. data/lib/capybara/spec/session/accept_prompt_spec.rb +34 -6
  136. data/lib/capybara/spec/session/all_spec.rb +163 -55
  137. data/lib/capybara/spec/session/ancestor_spec.rb +27 -24
  138. data/lib/capybara/spec/session/assert_all_of_selectors_spec.rb +68 -38
  139. data/lib/capybara/spec/session/assert_current_path_spec.rb +75 -0
  140. data/lib/capybara/spec/session/assert_selector_spec.rb +143 -0
  141. data/lib/capybara/spec/session/assert_style_spec.rb +26 -0
  142. data/lib/capybara/spec/session/{assert_text.rb → assert_text_spec.rb} +91 -59
  143. data/lib/capybara/spec/session/{assert_title.rb → assert_title_spec.rb} +22 -12
  144. data/lib/capybara/spec/session/attach_file_spec.rb +138 -69
  145. data/lib/capybara/spec/session/body_spec.rb +12 -13
  146. data/lib/capybara/spec/session/check_spec.rb +107 -55
  147. data/lib/capybara/spec/session/choose_spec.rb +58 -31
  148. data/lib/capybara/spec/session/click_button_spec.rb +231 -173
  149. data/lib/capybara/spec/session/click_link_or_button_spec.rb +55 -35
  150. data/lib/capybara/spec/session/click_link_spec.rb +82 -58
  151. data/lib/capybara/spec/session/current_scope_spec.rb +11 -10
  152. data/lib/capybara/spec/session/current_url_spec.rb +57 -39
  153. data/lib/capybara/spec/session/dismiss_confirm_spec.rb +4 -4
  154. data/lib/capybara/spec/session/dismiss_prompt_spec.rb +3 -2
  155. data/lib/capybara/spec/session/element/{assert_match_selector.rb → assert_match_selector_spec.rb} +11 -9
  156. data/lib/capybara/spec/session/element/match_css_spec.rb +18 -10
  157. data/lib/capybara/spec/session/element/match_xpath_spec.rb +9 -7
  158. data/lib/capybara/spec/session/element/matches_selector_spec.rb +71 -57
  159. data/lib/capybara/spec/session/evaluate_async_script_spec.rb +23 -0
  160. data/lib/capybara/spec/session/evaluate_script_spec.rb +30 -9
  161. data/lib/capybara/spec/session/execute_script_spec.rb +10 -8
  162. data/lib/capybara/spec/session/fill_in_spec.rb +128 -43
  163. data/lib/capybara/spec/session/find_button_spec.rb +25 -24
  164. data/lib/capybara/spec/session/find_by_id_spec.rb +10 -9
  165. data/lib/capybara/spec/session/find_field_spec.rb +37 -41
  166. data/lib/capybara/spec/session/find_link_spec.rb +36 -17
  167. data/lib/capybara/spec/session/find_spec.rb +245 -144
  168. data/lib/capybara/spec/session/first_spec.rb +79 -51
  169. data/lib/capybara/spec/session/frame/frame_title_spec.rb +23 -0
  170. data/lib/capybara/spec/session/frame/frame_url_spec.rb +23 -0
  171. data/lib/capybara/spec/session/frame/switch_to_frame_spec.rb +33 -20
  172. data/lib/capybara/spec/session/frame/within_frame_spec.rb +50 -32
  173. data/lib/capybara/spec/session/go_back_spec.rb +2 -1
  174. data/lib/capybara/spec/session/go_forward_spec.rb +2 -1
  175. data/lib/capybara/spec/session/has_all_selectors_spec.rb +69 -0
  176. data/lib/capybara/spec/session/has_ancestor_spec.rb +46 -0
  177. data/lib/capybara/spec/session/has_any_selectors_spec.rb +25 -0
  178. data/lib/capybara/spec/session/has_button_spec.rb +70 -13
  179. data/lib/capybara/spec/session/has_css_spec.rb +272 -137
  180. data/lib/capybara/spec/session/has_current_path_spec.rb +87 -45
  181. data/lib/capybara/spec/session/has_field_spec.rb +115 -59
  182. data/lib/capybara/spec/session/has_link_spec.rb +10 -9
  183. data/lib/capybara/spec/session/has_none_selectors_spec.rb +78 -0
  184. data/lib/capybara/spec/session/has_select_spec.rb +103 -74
  185. data/lib/capybara/spec/session/has_selector_spec.rb +105 -71
  186. data/lib/capybara/spec/session/has_sibling_spec.rb +50 -0
  187. data/lib/capybara/spec/session/has_table_spec.rb +172 -5
  188. data/lib/capybara/spec/session/has_text_spec.rb +113 -61
  189. data/lib/capybara/spec/session/has_title_spec.rb +20 -14
  190. data/lib/capybara/spec/session/has_xpath_spec.rb +57 -38
  191. data/lib/capybara/spec/session/{headers.rb → headers_spec.rb} +3 -2
  192. data/lib/capybara/spec/session/html_spec.rb +14 -6
  193. data/lib/capybara/spec/session/matches_style_spec.rb +35 -0
  194. data/lib/capybara/spec/session/node_spec.rb +950 -152
  195. data/lib/capybara/spec/session/node_wrapper_spec.rb +39 -0
  196. data/lib/capybara/spec/session/refresh_spec.rb +12 -6
  197. data/lib/capybara/spec/session/reset_session_spec.rb +69 -35
  198. data/lib/capybara/spec/session/{response_code.rb → response_code_spec.rb} +2 -1
  199. data/lib/capybara/spec/session/save_and_open_page_spec.rb +3 -2
  200. data/lib/capybara/spec/session/save_and_open_screenshot_spec.rb +8 -12
  201. data/lib/capybara/spec/session/save_page_spec.rb +42 -55
  202. data/lib/capybara/spec/session/save_screenshot_spec.rb +16 -14
  203. data/lib/capybara/spec/session/screenshot_spec.rb +2 -2
  204. data/lib/capybara/spec/session/scroll_spec.rb +117 -0
  205. data/lib/capybara/spec/session/select_spec.rb +107 -80
  206. data/lib/capybara/spec/session/selectors_spec.rb +52 -19
  207. data/lib/capybara/spec/session/sibling_spec.rb +10 -10
  208. data/lib/capybara/spec/session/text_spec.rb +37 -21
  209. data/lib/capybara/spec/session/title_spec.rb +17 -5
  210. data/lib/capybara/spec/session/uncheck_spec.rb +42 -22
  211. data/lib/capybara/spec/session/unselect_spec.rb +39 -38
  212. data/lib/capybara/spec/session/visit_spec.rb +99 -32
  213. data/lib/capybara/spec/session/window/become_closed_spec.rb +24 -20
  214. data/lib/capybara/spec/session/window/current_window_spec.rb +5 -3
  215. data/lib/capybara/spec/session/window/open_new_window_spec.rb +5 -3
  216. data/lib/capybara/spec/session/window/switch_to_window_spec.rb +27 -22
  217. data/lib/capybara/spec/session/window/window_opened_by_spec.rb +12 -6
  218. data/lib/capybara/spec/session/window/window_spec.rb +97 -63
  219. data/lib/capybara/spec/session/window/windows_spec.rb +12 -10
  220. data/lib/capybara/spec/session/window/within_window_spec.rb +31 -86
  221. data/lib/capybara/spec/session/within_spec.rb +70 -44
  222. data/lib/capybara/spec/spec_helper.rb +48 -43
  223. data/lib/capybara/spec/test_app.rb +78 -40
  224. data/lib/capybara/spec/views/animated.erb +49 -0
  225. data/lib/capybara/spec/views/form.erb +130 -39
  226. data/lib/capybara/spec/views/frame_child.erb +3 -2
  227. data/lib/capybara/spec/views/frame_one.erb +1 -0
  228. data/lib/capybara/spec/views/initial_alert.erb +10 -0
  229. data/lib/capybara/spec/views/obscured.erb +47 -0
  230. data/lib/capybara/spec/views/offset.erb +32 -0
  231. data/lib/capybara/spec/views/react.erb +45 -0
  232. data/lib/capybara/spec/views/scroll.erb +20 -0
  233. data/lib/capybara/spec/views/spatial.erb +31 -0
  234. data/lib/capybara/spec/views/tables.erb +68 -1
  235. data/lib/capybara/spec/views/with_animation.erb +82 -0
  236. data/lib/capybara/spec/views/with_dragula.erb +24 -0
  237. data/lib/capybara/spec/views/with_fixed_header_footer.erb +17 -0
  238. data/lib/capybara/spec/views/with_hover.erb +6 -0
  239. data/lib/capybara/spec/views/with_hover1.erb +10 -0
  240. data/lib/capybara/spec/views/with_html.erb +69 -10
  241. data/lib/capybara/spec/views/with_html5_svg.erb +20 -0
  242. data/lib/capybara/spec/views/with_jquery_animation.erb +24 -0
  243. data/lib/capybara/spec/views/with_js.erb +37 -0
  244. data/lib/capybara/spec/views/with_jstree.erb +26 -0
  245. data/lib/capybara/spec/views/with_namespace.erb +20 -0
  246. data/lib/capybara/spec/views/with_scope_other.erb +6 -0
  247. data/lib/capybara/spec/views/with_sortable_js.erb +21 -0
  248. data/lib/capybara/spec/views/within_frames.erb +4 -1
  249. data/lib/capybara/version.rb +2 -1
  250. data/lib/capybara/window.rb +35 -33
  251. data/lib/capybara.rb +131 -104
  252. data/spec/basic_node_spec.rb +47 -34
  253. data/spec/capybara_spec.rb +53 -104
  254. data/spec/css_builder_spec.rb +101 -0
  255. data/spec/css_splitter_spec.rb +38 -0
  256. data/spec/dsl_spec.rb +81 -62
  257. data/spec/filter_set_spec.rb +27 -9
  258. data/spec/fixtures/certificate.pem +25 -0
  259. data/spec/fixtures/key.pem +27 -0
  260. data/spec/fixtures/selenium_driver_rspec_failure.rb +5 -4
  261. data/spec/fixtures/selenium_driver_rspec_success.rb +5 -4
  262. data/spec/minitest_spec.rb +49 -7
  263. data/spec/minitest_spec_spec.rb +94 -59
  264. data/spec/per_session_config_spec.rb +14 -13
  265. data/spec/rack_test_spec.rb +176 -125
  266. data/spec/regexp_dissassembler_spec.rb +250 -0
  267. data/spec/result_spec.rb +101 -46
  268. data/spec/rspec/features_spec.rb +37 -31
  269. data/spec/rspec/scenarios_spec.rb +9 -7
  270. data/spec/rspec/shared_spec_matchers.rb +448 -421
  271. data/spec/rspec/views_spec.rb +5 -3
  272. data/spec/rspec_matchers_spec.rb +27 -11
  273. data/spec/rspec_spec.rb +109 -89
  274. data/spec/sauce_spec_chrome.rb +43 -0
  275. data/spec/selector_spec.rb +396 -67
  276. data/spec/selenium_spec_chrome.rb +184 -35
  277. data/spec/selenium_spec_chrome_remote.rb +100 -0
  278. data/spec/selenium_spec_edge.rb +47 -0
  279. data/spec/selenium_spec_firefox.rb +183 -41
  280. data/spec/selenium_spec_firefox_remote.rb +80 -0
  281. data/spec/selenium_spec_ie.rb +150 -0
  282. data/spec/selenium_spec_safari.rb +148 -0
  283. data/spec/server_spec.rb +198 -99
  284. data/spec/session_spec.rb +53 -16
  285. data/spec/shared_selenium_node.rb +83 -0
  286. data/spec/shared_selenium_session.rb +486 -97
  287. data/spec/spec_helper.rb +93 -7
  288. data/spec/xpath_builder_spec.rb +93 -0
  289. metadata +338 -64
  290. data/.yard/templates_custom/default/class/html/selectors.erb +0 -38
  291. data/.yard/templates_custom/default/class/html/setup.rb +0 -17
  292. data/.yard/yard_extensions.rb +0 -78
  293. data/lib/capybara/query.rb +0 -7
  294. data/lib/capybara/rspec/compound.rb +0 -95
  295. data/lib/capybara/spec/session/assert_current_path.rb +0 -72
  296. data/lib/capybara/spec/session/assert_selector.rb +0 -148
  297. data/lib/capybara/spec/session/source_spec.rb +0 -0
  298. data/spec/selenium_spec_marionette.rb +0 -117
@@ -1,107 +1,110 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Capybara
3
4
  module Node
4
5
  module Finders
5
-
6
6
  ##
7
7
  #
8
- # Find an {Capybara::Node::Element} based on the given arguments. +find+ will raise an error if the element
8
+ # Find an {Capybara::Node::Element} based on the given arguments. {#find} will raise an error if the element
9
9
  # is not found.
10
10
  #
11
- # @!macro waiting_behavior
12
- # If the driver is capable of executing JavaScript, +$0+ will wait for a set amount of time
13
- # and continuously retry finding the element until either the element is found or the time
14
- # expires. The length of time +find+ will wait is controlled through {Capybara.default_max_wait_time}
15
- # and defaults to 2 seconds.
16
- # @option options [false, Numeric] wait (Capybara.default_max_wait_time) Maximum time to wait for matching element to appear.
17
- #
18
- # +find+ takes the same options as +all+.
19
- #
20
11
  # page.find('#foo').find('.bar')
21
12
  # page.find(:xpath, './/div[contains(., "bar")]')
22
13
  # page.find('li', text: 'Quox').click_link('Delete')
23
14
  #
24
- # @param (see Capybara::Node::Finders#all)
15
+ # @param (see #all)
16
+ #
17
+ # @macro waiting_behavior
25
18
  #
26
- # @option options [Boolean] match The matching strategy to use.
19
+ # @!macro system_filters
20
+ # @option options [String, Regexp] text Only find elements which contain this text or match this regexp
21
+ # @option options [String, Boolean] exact_text
22
+ # When String the elements contained text must match exactly, when Boolean controls whether the `text` option must match exactly.
23
+ # Defaults to {Capybara.configure exact_text}.
24
+ # @option options [Boolean] normalize_ws
25
+ # Whether the `text`/`exact_text` options are compared against elment text with whitespace normalized or as returned by the driver.
26
+ # Defaults to {Capybara.configure default_normalize_ws}.
27
+ # @option options [Boolean, Symbol] visible
28
+ # Only find elements with the specified visibility. Defaults to behavior indicated by {Capybara.configure ignore_hidden_elements}.
29
+ # * true - only finds visible elements.
30
+ # * false - finds invisible _and_ visible elements.
31
+ # * :all - same as false; finds visible and invisible elements.
32
+ # * :hidden - only finds invisible elements.
33
+ # * :visible - same as true; only finds visible elements.
34
+ # @option options [Boolean] obscured Only find elements with the specified obscured state:
35
+ # * true - only find elements whose centerpoint is not in the viewport or is obscured by another non-descendant element.
36
+ # * false - only find elements whose centerpoint is in the viewport and is not obscured by other non-descendant elements.
37
+ # @option options [String, Regexp] id Only find elements with an id that matches the value passed
38
+ # @option options [String, Array<String>, Regexp] class Only find elements with matching class/classes.
39
+ # * Absence of a class can be checked by prefixing the class name with `!`
40
+ # * If you need to check for existence of a class name that starts with `!` then prefix with `!!`
41
+ #
42
+ # class:['a', '!b', '!!!c'] # limit to elements with class 'a' and '!c' but not class 'b'
43
+ #
44
+ # @option options [String, Regexp, Hash] style Only find elements with matching style. String and Regexp will be checked against text of the elements `style` attribute, while a Hash will be compared against the elements full style
45
+ # @option options [Boolean] exact Control whether `is` expressions in the given XPath match exactly or partially. Defaults to {Capybara.configure exact}.
46
+ # @option options [Symbol] match The matching strategy to use. Defaults to {Capybara.configure match}.
27
47
  #
28
48
  # @return [Capybara::Node::Element] The found element
29
49
  # @raise [Capybara::ElementNotFound] If the element can't be found before time expires
30
50
  #
31
- def find(*args, &optional_filter_block)
32
- if args.last.is_a? Hash
33
- args.last[:session_options] = session_options
34
- else
35
- args.push(session_options: session_options)
36
- end
37
- synced_resolve Capybara::Queries::SelectorQuery.new(*args, &optional_filter_block)
51
+ def find(*args, **options, &optional_filter_block)
52
+ options[:session_options] = session_options
53
+ synced_resolve Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)
38
54
  end
39
55
 
40
56
  ##
41
57
  #
42
- # Find an {Capybara::Node::Element} based on the given arguments that is also an ancestor of the element called on. +ancestor+ will raise an error if the element
43
- # is not found.
58
+ # Find an {Capybara::Node::Element} based on the given arguments that is also an ancestor of the element called on.
59
+ # {#ancestor} will raise an error if the element is not found.
44
60
  #
45
- # +ancestor+ takes the same options as +find+.
61
+ # {#ancestor} takes the same options as {#find}.
46
62
  #
47
63
  # element.ancestor('#foo').find('.bar')
48
64
  # element.ancestor(:xpath, './/div[contains(., "bar")]')
49
65
  # element.ancestor('ul', text: 'Quox').click_link('Delete')
50
66
  #
51
- # @param (see Capybara::Node::Finders#find)
67
+ # @param (see #find)
52
68
  #
53
- # @!macro waiting_behavior
54
- #
55
- # @option options [Boolean] match The matching strategy to use.
69
+ # @macro waiting_behavior
56
70
  #
57
71
  # @return [Capybara::Node::Element] The found element
58
72
  # @raise [Capybara::ElementNotFound] If the element can't be found before time expires
59
73
  #
60
- def ancestor(*args, &optional_filter_block)
61
- if args.last.is_a? Hash
62
- args.last[:session_options] = session_options
63
- else
64
- args.push(session_options: session_options)
65
- end
66
- synced_resolve Capybara::Queries::AncestorQuery.new(*args, &optional_filter_block)
74
+ def ancestor(*args, **options, &optional_filter_block)
75
+ options[:session_options] = session_options
76
+ synced_resolve Capybara::Queries::AncestorQuery.new(*args, **options, &optional_filter_block)
67
77
  end
68
78
 
69
79
  ##
70
80
  #
71
- # Find an {Capybara::Node::Element} based on the given arguments that is also a sibling of the element called on. +sibling+ will raise an error if the element
72
- # is not found.
73
- #
81
+ # Find an {Capybara::Node::Element} based on the given arguments that is also a sibling of the element called on.
82
+ # {#sibling} will raise an error if the element is not found.
74
83
  #
75
- # +sibling+ takes the same options as +find+.
84
+ # {#sibling} takes the same options as {#find}.
76
85
  #
77
86
  # element.sibling('#foo').find('.bar')
78
87
  # element.sibling(:xpath, './/div[contains(., "bar")]')
79
88
  # element.sibling('ul', text: 'Quox').click_link('Delete')
80
89
  #
81
- # @param (see Capybara::Node::Finders#find)
90
+ # @param (see #find)
82
91
  #
83
92
  # @macro waiting_behavior
84
93
  #
85
- # @option options [Boolean] match The matching strategy to use.
86
- #
87
94
  # @return [Capybara::Node::Element] The found element
88
95
  # @raise [Capybara::ElementNotFound] If the element can't be found before time expires
89
96
  #
90
- def sibling(*args, &optional_filter_block)
91
- if args.last.is_a? Hash
92
- args.last[:session_options] = session_options
93
- else
94
- args.push(session_options: session_options)
95
- end
96
- synced_resolve Capybara::Queries::SiblingQuery.new(*args, &optional_filter_block)
97
+ def sibling(*args, **options, &optional_filter_block)
98
+ options[:session_options] = session_options
99
+ synced_resolve Capybara::Queries::SiblingQuery.new(*args, **options, &optional_filter_block)
97
100
  end
98
101
 
99
102
  ##
100
103
  #
101
104
  # Find a form field on the page. The field can be found by its name, id or label text.
102
105
  #
103
- # @overload find_field([locator], options={})
104
- # @param [String] locator name, id, placeholder or text of associated label element
106
+ # @overload find_field([locator], **options)
107
+ # @param [String] locator name, id, {Capybara.configure test_id} attribute, placeholder or text of associated label element
105
108
  #
106
109
  # @macro waiting_behavior
107
110
  #
@@ -116,51 +119,45 @@ module Capybara
116
119
  # @option options [String, Regexp] with Value of field to match on
117
120
  # @option options [String] type Type of field to match on
118
121
  # @option options [Boolean] multiple Match fields that can have multiple values?
119
- # @option options [String] id Match fields that match the id attribute
122
+ # @option options [String, Regexp] id Match fields that match the id attribute
120
123
  # @option options [String] name Match fields that match the name attribute
121
124
  # @option options [String] placeholder Match fields that match the placeholder attribute
122
- # @option options [String, Array<String>] Match fields that match the class(es) passed
125
+ # @option options [String, Array<String>, Regexp] class Match fields that match the class(es) passed
123
126
  # @return [Capybara::Node::Element] The found element
124
127
  #
125
-
126
- def find_field(locator=nil, options={}, &optional_filter_block)
127
- locator, options = nil, locator if locator.is_a? Hash
128
- find(:field, locator, options, &optional_filter_block)
128
+ def find_field(locator = nil, **options, &optional_filter_block)
129
+ find(:field, locator, **options, &optional_filter_block)
129
130
  end
130
- alias_method :field_labeled, :find_field
131
131
 
132
132
  ##
133
133
  #
134
134
  # Find a link on the page. The link can be found by its id or text.
135
135
  #
136
- # @overload find_link([locator], options={})
137
- # @param [String] locator id, title, text, or alt of enclosed img element
136
+ # @overload find_link([locator], **options)
137
+ # @param [String] locator id, {Capybara.configure test_id} attribute, title, text, or alt of enclosed img element
138
138
  #
139
139
  # @macro waiting_behavior
140
140
  #
141
- # @option options [String,Regexp,nil] href Value to match against the links href, if nil finds link placeholders (<a> elements with no href attribute)
142
- # @option options [String] id Match links with the id provided
141
+ # @option options [String,Regexp,nil] href Value to match against the links href, if `nil` finds link placeholders (`<a>` elements with no href attribute), if `false` ignores the href
142
+ # @option options [String, Regexp] id Match links with the id provided
143
143
  # @option options [String] title Match links with the title provided
144
144
  # @option options [String] alt Match links with a contained img element whose alt matches
145
- # @option options [String, Array<String>] class Match links that match the class(es) provided
145
+ # @option options [String, Array<String>, Regexp] class Match links that match the class(es) provided
146
146
  # @return [Capybara::Node::Element] The found element
147
147
  #
148
- def find_link(locator=nil, options={}, &optional_filter_block)
149
- locator, options = nil, locator if locator.is_a? Hash
150
- find(:link, locator, options, &optional_filter_block)
148
+ def find_link(locator = nil, **options, &optional_filter_block)
149
+ find(:link, locator, **options, &optional_filter_block)
151
150
  end
152
151
 
153
152
  ##
154
153
  #
155
154
  # Find a button on the page.
156
- # This can be any \<input> element of type submit, reset, image, button or it can be a
157
- # \<button> element. All buttons can be found by their id, value, or title. \<button> elements can also be found
158
- # by their text content, and image \<input> elements by their alt attribute
159
- #
160
- # @overload find_button([locator], options={})
161
- # @param [String] locator id, value, title, text content, alt of image
155
+ # This can be any `<input>` element of type submit, reset, image, button or it can be a
156
+ # `<button>` element. All buttons can be found by their id, name, {Capybara.configure test_id} attribute, value, or title.
157
+ # `<button>` elements can also be found by their text content, and image `<input>` elements by their alt attribute.
162
158
  #
163
- # @overload find_button(options={})
159
+ # @overload find_button([locator], **options)
160
+ # @param [String] locator id, name, {Capybara.configure test_id} attribute, value, title, text content, alt of image
164
161
  #
165
162
  # @macro waiting_behavior
166
163
  #
@@ -168,15 +165,15 @@ module Capybara
168
165
  # * true - only finds a disabled button
169
166
  # * false - only finds an enabled button
170
167
  # * :all - finds either an enabled or disabled button
171
- # @option options [String] id Match buttons with the id provided
172
- # @option options [String] title Match buttons with the title provided
173
- # @option options [String] value Match buttons with the value provided
174
- # @option options [String, Array<String>] class Match links that match the class(es) provided
168
+ # @option options [String, Regexp] id Match buttons with the id provided
169
+ # @option options [String] name Match buttons with the name provided
170
+ # @option options [String] title Match buttons with the title provided
171
+ # @option options [String] value Match buttons with the value provided
172
+ # @option options [String, Array<String>, Regexp] class Match buttons that match the class(es) provided
175
173
  # @return [Capybara::Node::Element] The found element
176
174
  #
177
- def find_button(locator=nil, options={}, &optional_filter_block)
178
- locator, options = nil, locator if locator.is_a? Hash
179
- find(:button, locator, options, &optional_filter_block)
175
+ def find_button(locator = nil, **options, &optional_filter_block)
176
+ find(:button, locator, **options, &optional_filter_block)
180
177
  end
181
178
 
182
179
  ##
@@ -189,12 +186,12 @@ module Capybara
189
186
  #
190
187
  # @return [Capybara::Node::Element] The found element
191
188
  #
192
- def find_by_id(id, options={}, &optional_filter_block)
193
- find(:id, id, options, &optional_filter_block)
189
+ def find_by_id(id, **options, &optional_filter_block)
190
+ find(:id, id, **options, &optional_filter_block)
194
191
  end
195
192
 
196
193
  ##
197
- # @!method all([kind = Capybara.default_selector], locator = nil, options = {})
194
+ # @!method all([kind = Capybara.default_selector], locator = nil, **options)
198
195
  #
199
196
  # Find all elements on the page matching the given selector
200
197
  # and options.
@@ -206,9 +203,8 @@ module Capybara
206
203
  # page.all(:css, 'a#person_123')
207
204
  # page.all(:xpath, './/a[@id="person_123"]')
208
205
  #
209
- #
210
206
  # If the type of selector is left out, Capybara uses
211
- # {Capybara.default_selector}. It's set to :css by default.
207
+ # {Capybara.configure default_selector}. It's set to `:css` by default.
212
208
  #
213
209
  # page.all("a#person_123")
214
210
  #
@@ -221,52 +217,52 @@ module Capybara
221
217
  # page.all('a', text: 'Home')
222
218
  # page.all('#menu li', visible: true)
223
219
  #
224
- # By default if no elements are found, an empty array is returned;
225
- # however, expectations can be set on the number of elements to be found which
226
- # will trigger Capybara's waiting behavior for the expectations to match.The
227
- # expectations can be set using
220
+ # By default Capybara's waiting behavior will wait up to {Capybara.configure default_max_wait_time}
221
+ # seconds for matching elements to be available and then return an empty result if none
222
+ # are available. It is possible to set expectations on the number of results located and
223
+ # Capybara will raise an exception if the number of elements located don't satisfy the
224
+ # specified conditions. The expectations can be set using:
228
225
  #
229
226
  # page.assert_selector('p#foo', count: 4)
230
227
  # page.assert_selector('p#foo', maximum: 10)
231
228
  # page.assert_selector('p#foo', minimum: 1)
232
229
  # page.assert_selector('p#foo', between: 1..10)
233
230
  #
234
- # See {Capybara::Helpers#matches_count?} for additional information about
235
- # count matching.
236
- #
237
- # @param [Symbol] kind Optional selector type (:css, :xpath, :field, etc.) - Defaults to Capybara.default_selector
238
- # @param [String] locator The selector
239
- # @option options [String, Regexp] text Only find elements which contain this text or match this regexp
240
- # @option options [String, Boolean] exact_text (Capybara.exact_text) When String the string the elements contained text must match exactly, when Boolean controls whether the :text option must match exactly
241
- # @option options [Boolean, Symbol] visible Only find elements with the specified visibility:
242
- # * true - only finds visible elements.
243
- # * false - finds invisible _and_ visible elements.
244
- # * :all - same as false; finds visible and invisible elements.
245
- # * :hidden - only finds invisible elements.
246
- # * :visible - same as true; only finds visible elements.
231
+ # @param [Symbol] kind Optional selector type (:css, :xpath, :field, etc.). Defaults to {Capybara.configure default_selector}.
232
+ # @param [String] locator The locator for the specified selector
233
+ # @macro system_filters
234
+ # @macro waiting_behavior
247
235
  # @option options [Integer] count Exact number of matches that are expected to be found
248
236
  # @option options [Integer] maximum Maximum number of matches that are expected to be found
249
237
  # @option options [Integer] minimum Minimum number of matches that are expected to be found
250
238
  # @option options [Range] between Number of matches found must be within the given range
251
- # @option options [Boolean] exact Control whether `is` expressions in the given XPath match exactly or partially
252
- # @option options [Integer] wait (Capybara.default_max_wait_time) The time to wait for element count expectations to become true
253
- # @overload all([kind = Capybara.default_selector], locator = nil, options = {})
254
- # @overload all([kind = Capybara.default_selector], locator = nil, options = {}, &filter_block)
239
+ # @option options [Boolean] allow_reload Beta feature - May be removed in any version.
240
+ # When `true` allows elements to be reloaded if they become stale. This is an advanced behavior and should only be used
241
+ # if you fully understand the potential ramifications. The results can be confusing on dynamic pages. Defaults to `false`
242
+ # @overload all([kind = Capybara.default_selector], locator = nil, **options)
243
+ # @overload all([kind = Capybara.default_selector], locator = nil, **options, &filter_block)
255
244
  # @yieldparam element [Capybara::Node::Element] The element being considered for inclusion in the results
256
245
  # @yieldreturn [Boolean] Should the element be considered in the results?
257
246
  # @return [Capybara::Result] A collection of found elements
258
- #
259
- def all(*args, &optional_filter_block)
260
- if args.last.is_a? Hash
261
- args.last[:session_options] = session_options
262
- else
263
- args.push(session_options: session_options)
264
- end
265
- query = Capybara::Queries::SelectorQuery.new(*args, &optional_filter_block)
266
- synchronize(query.wait) do
267
- result = query.resolve_for(self)
268
- raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?
269
- result
247
+ # @raise [Capybara::ExpectationNotMet] The number of elements found doesn't match the specified conditions
248
+ def all(*args, allow_reload: false, **options, &optional_filter_block)
249
+ minimum_specified = options_include_minimum?(options)
250
+ options = { minimum: 1 }.merge(options) unless minimum_specified
251
+ options[:session_options] = session_options
252
+ query = Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)
253
+ result = nil
254
+ begin
255
+ synchronize(query.wait) do
256
+ result = query.resolve_for(self)
257
+ result.allow_reload! if allow_reload
258
+ raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?
259
+
260
+ result
261
+ end
262
+ rescue Capybara::ExpectationNotMet
263
+ raise if minimum_specified || (result.compare_count == 1)
264
+
265
+ Result.new([], nil)
270
266
  end
271
267
  end
272
268
  alias_method :find_all, :all
@@ -274,47 +270,57 @@ module Capybara
274
270
  ##
275
271
  #
276
272
  # Find the first element on the page matching the given selector
277
- # and options, or nil if no element matches. By default no waiting
278
- # behavior occurs, however if {Capybara.wait_on_first_by_default} is set to true
279
- # it will trigger Capybara's waiting behavior for a minimum of 1 matching element to be found and
280
- # return the first. Waiting behavior can also be triggered by passing in any of the count
281
- # expectation options.
273
+ # and options. By default {#first} will wait up to {Capybara.configure default_max_wait_time}
274
+ # seconds for matching elements to appear and then raise an error if no matching
275
+ # element is found, or `nil` if the provided count options allow for empty results.
282
276
  #
283
277
  # @overload first([kind], locator, options)
284
- # @param [:css, :xpath] kind The type of selector
278
+ # @param [Symbol] kind The type of selector
285
279
  # @param [String] locator The selector
286
280
  # @param [Hash] options Additional options; see {#all}
287
281
  # @return [Capybara::Node::Element] The found element or nil
282
+ # @raise [Capybara::ElementNotFound] If element(s) matching the provided options can't be found before time expires
288
283
  #
289
- def first(*args, &optional_filter_block)
290
- if session_options.wait_on_first_by_default
291
- options = if args.last.is_a?(Hash) then args.pop.dup else {} end
292
- args.push({minimum: 1}.merge(options))
293
- end
294
- all(*args, &optional_filter_block).first
295
- rescue Capybara::ExpectationNotMet
296
- nil
284
+ def first(*args, **options, &optional_filter_block)
285
+ options = { minimum: 1 }.merge(options) unless options_include_minimum?(options)
286
+ all(*args, **options, &optional_filter_block).first
297
287
  end
298
288
 
299
- private
289
+ private
300
290
 
301
291
  def synced_resolve(query)
302
292
  synchronize(query.wait) do
303
- if (query.match == :smart or query.match == :prefer_exact)
293
+ if prefer_exact?(query)
304
294
  result = query.resolve_for(self, true)
305
295
  result = query.resolve_for(self, false) if result.empty? && query.supports_exact? && !query.exact?
306
296
  else
307
297
  result = query.resolve_for(self)
308
298
  end
309
- if query.match == :one or query.match == :smart and result.size > 1
310
- raise Capybara::Ambiguous.new("Ambiguous match, found #{result.size} elements matching #{query.description}")
311
- end
312
- if result.empty?
313
- raise Capybara::ElementNotFound.new("Unable to find #{query.description}")
299
+
300
+ if ambiguous?(query, result)
301
+ raise Capybara::Ambiguous, "Ambiguous match, found #{result.size} elements matching #{query.applied_description}"
314
302
  end
303
+ raise Capybara::ElementNotFound, "Unable to find #{query.applied_description}" if result.empty?
304
+
315
305
  result.first
316
306
  end.tap(&:allow_reload!)
317
307
  end
308
+
309
+ def ambiguous?(query, result)
310
+ %i[one smart].include?(query.match) && (result.size > 1)
311
+ end
312
+
313
+ def prefer_exact?(query)
314
+ %i[smart prefer_exact].include?(query.match)
315
+ end
316
+
317
+ def options_include_minimum?(opts)
318
+ %i[count minimum between].any? { |key| opts.key?(key) }
319
+ end
320
+
321
+ def parent
322
+ first(:xpath, './parent::*', minimum: 0)
323
+ end
318
324
  end
319
325
  end
320
326
  end
@@ -1,8 +1,8 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Capybara
3
4
  module Node
4
5
  module Matchers
5
-
6
6
  ##
7
7
  #
8
8
  # Checks if a given selector is on the page or a descendant of the current node.
@@ -19,41 +19,58 @@ module Capybara
19
19
  # This will check if the expression occurs exactly 4 times.
20
20
  #
21
21
  # It also accepts all options that {Capybara::Node::Finders#all} accepts,
22
- # such as :text and :visible.
22
+ # such as `:text` and `:visible`.
23
23
  #
24
24
  # page.has_selector?('li', text: 'Horse', visible: true)
25
25
  #
26
- # has_selector? can also accept XPath expressions generated by the
26
+ # {#has_selector?} can also accept XPath expressions generated by the
27
27
  # XPath gem:
28
28
  #
29
29
  # page.has_selector?(:xpath, XPath.descendant(:p))
30
30
  #
31
31
  # @param (see Capybara::Node::Finders#all)
32
- # @param args
33
- # @option args [Integer] :count (nil) Number of times the text should occur
34
- # @option args [Integer] :minimum (nil) Minimum number of times the text should occur
35
- # @option args [Integer] :maximum (nil) Maximum number of times the text should occur
36
- # @option args [Range] :between (nil) Range of times that should contain number of times text occurs
32
+ # @option options [Integer] :count (nil) Number of matching elements that should exist
33
+ # @option options [Integer] :minimum (nil) Minimum number of matching elements that should exist
34
+ # @option options [Integer] :maximum (nil) Maximum number of matching elements that should exist
35
+ # @option options [Range] :between (nil) Range of number of matching elements that should exist
37
36
  # @return [Boolean] If the expression exists
38
37
  #
39
- def has_selector?(*args, &optional_filter_block)
40
- assert_selector(*args, &optional_filter_block)
41
- rescue Capybara::ExpectationNotMet
42
- return false
38
+ def has_selector?(*args, **options, &optional_filter_block)
39
+ make_predicate(options) { assert_selector(*args, options, &optional_filter_block) }
43
40
  end
44
41
 
45
42
  ##
46
43
  #
47
44
  # Checks if a given selector is not on the page or a descendant of the current node.
48
- # Usage is identical to Capybara::Node::Matchers#has_selector?
45
+ # Usage is identical to {#has_selector?}.
49
46
  #
50
- # @param (see Capybara::Node::Finders#has_selector?)
47
+ # @param (see #has_selector?)
51
48
  # @return [Boolean]
52
49
  #
53
- def has_no_selector?(*args, &optional_filter_block)
54
- assert_no_selector(*args, &optional_filter_block)
55
- rescue Capybara::ExpectationNotMet
56
- return false
50
+ def has_no_selector?(*args, **options, &optional_filter_block)
51
+ make_predicate(options) { assert_no_selector(*args, options, &optional_filter_block) }
52
+ end
53
+
54
+ ##
55
+ #
56
+ # Checks if a an element has the specified CSS styles.
57
+ #
58
+ # element.matches_style?( 'color' => 'rgb(0,0,255)', 'font-size' => /px/ )
59
+ #
60
+ # @param styles [Hash]
61
+ # @return [Boolean] If the styles match
62
+ #
63
+ def matches_style?(styles = nil, **options)
64
+ styles, options = options, {} if styles.nil?
65
+ make_predicate(options) { assert_matches_style(styles, **options) }
66
+ end
67
+
68
+ ##
69
+ # @deprecated Use {#matches_style?} instead.
70
+ #
71
+ def has_style?(styles = nil, **options)
72
+ Capybara::Helpers.warn "DEPRECATED: has_style? is deprecated, please use matches_style? : #{Capybara::Helpers.filter_backtrace(caller)}"
73
+ matches_style?(styles, **options)
57
74
  end
58
75
 
59
76
  ##
@@ -72,15 +89,15 @@ module Capybara
72
89
  # This will check if the expression occurs exactly 4 times. See
73
90
  # {Capybara::Node::Finders#all} for other available result size options.
74
91
  #
75
- # If a :count of 0 is specified, it will behave like {#assert_no_selector};
92
+ # If a `:count` of 0 is specified, it will behave like {#assert_no_selector};
76
93
  # however, use of that method is preferred over this one.
77
94
  #
78
95
  # It also accepts all options that {Capybara::Node::Finders#all} accepts,
79
- # such as :text and :visible.
96
+ # such as `:text` and `:visible`.
80
97
  #
81
98
  # page.assert_selector('li', text: 'Horse', visible: true)
82
99
  #
83
- # `assert_selector` can also accept XPath expressions generated by the
100
+ # {#assert_selector} can also accept XPath expressions generated by the
84
101
  # XPath gem:
85
102
  #
86
103
  # page.assert_selector(:xpath, XPath.descendant(:p))
@@ -91,88 +108,135 @@ module Capybara
91
108
  #
92
109
  def assert_selector(*args, &optional_filter_block)
93
110
  _verify_selector_result(args, optional_filter_block) do |result, query|
94
- unless result.matches_count? && ((!result.empty?) || query.expects_none?)
111
+ unless result.matches_count? && (result.any? || query.expects_none?)
95
112
  raise Capybara::ExpectationNotMet, result.failure_message
96
113
  end
97
114
  end
98
115
  end
99
116
 
117
+ ##
118
+ #
119
+ # Asserts that an element has the specified CSS styles.
120
+ #
121
+ # element.assert_matches_style( 'color' => 'rgb(0,0,255)', 'font-size' => /px/ )
122
+ #
123
+ # @param styles [Hash]
124
+ # @raise [Capybara::ExpectationNotMet] If the element doesn't have the specified styles
125
+ #
126
+ def assert_matches_style(styles = nil, **options)
127
+ styles, options = options, {} if styles.nil?
128
+ query_args, query_opts = _set_query_session_options(styles, options)
129
+ query = Capybara::Queries::StyleQuery.new(*query_args, **query_opts)
130
+ synchronize(query.wait) do
131
+ raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
132
+ end
133
+ true
134
+ end
135
+
136
+ ##
137
+ # @deprecated Use {#assert_matches_style} instead.
138
+ #
139
+ def assert_style(styles = nil, **options)
140
+ warn 'assert_style is deprecated, please use assert_matches_style instead'
141
+ assert_matches_style(styles, **options)
142
+ end
143
+
100
144
  # Asserts that all of the provided selectors are present on the given page
101
145
  # or descendants of the current node. If options are provided, the assertion
102
- # will check that each locator is present with those options as well (other than :wait).
146
+ # will check that each locator is present with those options as well (other than `:wait`).
103
147
  #
104
- # page.assert_all_of_selectors(:custom, 'Tom', 'Joe', visible: all)
105
- # page.assert_all_of_selectors(:css, '#my_div', 'a.not_clicked')
148
+ # page.assert_all_of_selectors(:custom, 'Tom', 'Joe', visible: all)
149
+ # page.assert_all_of_selectors(:css, '#my_div', 'a.not_clicked')
106
150
  #
107
151
  # It accepts all options that {Capybara::Node::Finders#all} accepts,
108
- # such as :text and :visible.
152
+ # such as `:text` and `:visible`.
109
153
  #
110
- # The :wait option applies to all of the selectors as a group, so all of the locators must be present
111
- # within :wait (Defaults to Capybara.default_max_wait_time) seconds.
154
+ # The `:wait` option applies to all of the selectors as a group, so all of the locators must be present
155
+ # within `:wait` (defaults to {Capybara.configure default_max_wait_time}) seconds.
112
156
  #
113
- # @overload assert_all_of_selectors([kind = Capybara.default_selector], *locators, options = {})
157
+ # @overload assert_all_of_selectors([kind = Capybara.default_selector], *locators, **options)
114
158
  #
115
- def assert_all_of_selectors(*args, &optional_filter_block)
116
- options = if args.last.is_a?(Hash) then args.pop.dup else {} end
117
- selector = if args.first.is_a?(Symbol) then args.shift else session_options.default_selector end
118
- wait = options.fetch(:wait, session_options.default_max_wait_time)
119
- synchronize(wait) do
120
- args.each do |locator|
121
- assert_selector(selector, locator, options, &optional_filter_block)
122
- end
159
+ def assert_all_of_selectors(*args, **options, &optional_filter_block)
160
+ _verify_multiple(*args, **options) do |selector, locator, opts|
161
+ assert_selector(selector, locator, opts, &optional_filter_block)
123
162
  end
124
163
  end
125
164
 
126
165
  # Asserts that none of the provided selectors are present on the given page
127
166
  # or descendants of the current node. If options are provided, the assertion
128
- # will check that each locator is present with those options as well (other than :wait).
167
+ # will check that each locator is not present with those options as well (other than `:wait`).
129
168
  #
130
- # page.assert_none_of_selectors(:custom, 'Tom', 'Joe', visible: all)
131
- # page.assert_none_of_selectors(:css, '#my_div', 'a.not_clicked')
169
+ # page.assert_none_of_selectors(:custom, 'Tom', 'Joe', visible: all)
170
+ # page.assert_none_of_selectors(:css, '#my_div', 'a.not_clicked')
132
171
  #
133
172
  # It accepts all options that {Capybara::Node::Finders#all} accepts,
134
- # such as :text and :visible.
173
+ # such as `:text` and `:visible`.
174
+ #
175
+ # The `:wait` option applies to all of the selectors as a group, so none of the locators must be present
176
+ # within `:wait` (defaults to {Capybara.configure default_max_wait_time}) seconds.
135
177
  #
136
- # The :wait option applies to all of the selectors as a group, so none of the locators must be present
137
- # within :wait (Defaults to Capybara.default_max_wait_time) seconds.
178
+ # @overload assert_none_of_selectors([kind = Capybara.default_selector], *locators, **options)
179
+ #
180
+ def assert_none_of_selectors(*args, **options, &optional_filter_block)
181
+ _verify_multiple(*args, **options) do |selector, locator, opts|
182
+ assert_no_selector(selector, locator, opts, &optional_filter_block)
183
+ end
184
+ end
185
+
186
+ # Asserts that any of the provided selectors are present on the given page
187
+ # or descendants of the current node. If options are provided, the assertion
188
+ # will check that each locator is present with those options as well (other than `:wait`).
138
189
  #
139
- # @overload assert_none_of_selectors([kind = Capybara.default_selector], *locators, options = {})
190
+ # page.assert_any_of_selectors(:custom, 'Tom', 'Joe', visible: all)
191
+ # page.assert_any_of_selectors(:css, '#my_div', 'a.not_clicked')
140
192
  #
141
- def assert_none_of_selectors(*args, &optional_filter_block)
142
- options = if args.last.is_a?(Hash) then args.pop.dup else {} end
143
- selector = if args.first.is_a?(Symbol) then args.shift else session_options.default_selector end
144
- wait = options.fetch(:wait, session_options.default_max_wait_time)
193
+ # It accepts all options that {Capybara::Node::Finders#all} accepts,
194
+ # such as `:text` and `:visible`.
195
+ #
196
+ # The `:wait` option applies to all of the selectors as a group, so any of the locators must be present
197
+ # within `:wait` (defaults to {Capybara.configure default_max_wait_time}) seconds.
198
+ #
199
+ # @overload assert_any_of_selectors([kind = Capybara.default_selector], *locators, **options)
200
+ #
201
+ def assert_any_of_selectors(*args, wait: nil, **options, &optional_filter_block)
202
+ wait = session_options.default_max_wait_time if wait.nil?
203
+ selector = extract_selector(args)
145
204
  synchronize(wait) do
146
- args.each do |locator|
147
- assert_no_selector(selector, locator, options, &optional_filter_block)
205
+ res = args.map do |locator|
206
+ assert_selector(selector, locator, options, &optional_filter_block)
207
+ break nil
208
+ rescue Capybara::ExpectationNotMet => e
209
+ e.message
148
210
  end
211
+ raise Capybara::ExpectationNotMet, res.join(' or ') if res
212
+
213
+ true
149
214
  end
150
215
  end
151
216
 
152
217
  ##
153
218
  #
154
219
  # Asserts that a given selector is not on the page or a descendant of the current node.
155
- # Usage is identical to Capybara::Node::Matchers#assert_selector
220
+ # Usage is identical to {#assert_selector}.
156
221
  #
157
- # Query options such as :count, :minimum, :maximum, and :between are
222
+ # Query options such as `:count`, `:minimum`, `:maximum`, and `:between` are
158
223
  # considered to be an integral part of the selector. This will return
159
- # true, for example, if a page contains 4 anchors but the query expects 5:
224
+ # `true`, for example, if a page contains 4 anchors but the query expects 5:
160
225
  #
161
226
  # page.assert_no_selector('a', minimum: 1) # Found, raises Capybara::ExpectationNotMet
162
227
  # page.assert_no_selector('a', count: 4) # Found, raises Capybara::ExpectationNotMet
163
228
  # page.assert_no_selector('a', count: 5) # Not Found, returns true
164
229
  #
165
- # @param (see Capybara::Node::Finders#assert_selector)
230
+ # @param (see #assert_selector)
166
231
  # @raise [Capybara::ExpectationNotMet] If the selector exists
167
232
  #
168
233
  def assert_no_selector(*args, &optional_filter_block)
169
234
  _verify_selector_result(args, optional_filter_block) do |result, query|
170
- if result.matches_count? && ((!result.empty?) || query.expects_none?)
235
+ if result.matches_count? && (!result.empty? || query.expects_none?)
171
236
  raise Capybara::ExpectationNotMet, result.negative_failure_message
172
237
  end
173
238
  end
174
239
  end
175
- alias_method :refute_selector, :assert_no_selector
176
240
 
177
241
  ##
178
242
  #
@@ -188,11 +252,11 @@ module Capybara
188
252
  # This will check if the expression occurs exactly 4 times.
189
253
  #
190
254
  # It also accepts all options that {Capybara::Node::Finders#all} accepts,
191
- # such as :text and :visible.
255
+ # such as `:text` and `:visible`.
192
256
  #
193
257
  # page.has_xpath?('.//li', text: 'Horse', visible: true)
194
258
  #
195
- # has_xpath? can also accept XPath expressions generate by the
259
+ # {#has_xpath?} can also accept XPath expressions generated by the
196
260
  # XPath gem:
197
261
  #
198
262
  # xpath = XPath.generate { |x| x.descendant(:p) }
@@ -203,20 +267,20 @@ module Capybara
203
267
  # @option options [Integer] :count (nil) Number of times the expression should occur
204
268
  # @return [Boolean] If the expression exists
205
269
  #
206
- def has_xpath?(path, options={}, &optional_filter_block)
207
- has_selector?(:xpath, path, options, &optional_filter_block)
270
+ def has_xpath?(path, **options, &optional_filter_block)
271
+ has_selector?(:xpath, path, **options, &optional_filter_block)
208
272
  end
209
273
 
210
274
  ##
211
275
  #
212
276
  # Checks if a given XPath expression is not on the page or a descendant of the current node.
213
- # Usage is identical to Capybara::Node::Matchers#has_xpath?
277
+ # Usage is identical to {#has_xpath?}.
214
278
  #
215
- # @param (see Capybara::Node::Finders#has_xpath?)
279
+ # @param (see #has_xpath?)
216
280
  # @return [Boolean]
217
281
  #
218
- def has_no_xpath?(path, options={}, &optional_filter_block)
219
- has_no_selector?(:xpath, path, options, &optional_filter_block)
282
+ def has_no_xpath?(path, **options, &optional_filter_block)
283
+ has_no_selector?(:xpath, path, **options, &optional_filter_block)
220
284
  end
221
285
 
222
286
  ##
@@ -233,7 +297,7 @@ module Capybara
233
297
  # This will check if the selector occurs exactly 4 times.
234
298
  #
235
299
  # It also accepts all options that {Capybara::Node::Finders#all} accepts,
236
- # such as :text and :visible.
300
+ # such as `:text` and `:visible`.
237
301
  #
238
302
  # page.has_css?('li', text: 'Horse', visible: true)
239
303
  #
@@ -242,20 +306,20 @@ module Capybara
242
306
  # @option options [Integer] :count (nil) Number of times the selector should occur
243
307
  # @return [Boolean] If the selector exists
244
308
  #
245
- def has_css?(path, options={}, &optional_filter_block)
246
- has_selector?(:css, path, options, &optional_filter_block)
309
+ def has_css?(path, **options, &optional_filter_block)
310
+ has_selector?(:css, path, **options, &optional_filter_block)
247
311
  end
248
312
 
249
313
  ##
250
314
  #
251
315
  # Checks if a given CSS selector is not on the page or a descendant of the current node.
252
- # Usage is identical to Capybara::Node::Matchers#has_css?
316
+ # Usage is identical to {#has_css?}.
253
317
  #
254
- # @param (see Capybara::Node::Finders#has_css?)
318
+ # @param (see #has_css?)
255
319
  # @return [Boolean]
256
320
  #
257
- def has_no_css?(path, options={}, &optional_filter_block)
258
- has_no_selector?(:css, path, options, &optional_filter_block)
321
+ def has_no_css?(path, **options, &optional_filter_block)
322
+ has_no_selector?(:css, path, **options, &optional_filter_block)
259
323
  end
260
324
 
261
325
  ##
@@ -264,13 +328,11 @@ module Capybara
264
328
  # text or id.
265
329
  #
266
330
  # @param [String] locator The text or id of a link to check for
267
- # @param options
268
331
  # @option options [String, Regexp] :href The value the href attribute must be
269
332
  # @return [Boolean] Whether it exists
270
333
  #
271
- def has_link?(locator=nil, options={}, &optional_filter_block)
272
- locator, options = nil, locator if locator.is_a? Hash
273
- has_selector?(:link, locator, options, &optional_filter_block)
334
+ def has_link?(locator = nil, **options, &optional_filter_block)
335
+ has_selector?(:link, locator, **options, &optional_filter_block)
274
336
  end
275
337
 
276
338
  ##
@@ -278,12 +340,11 @@ module Capybara
278
340
  # Checks if the page or current node has no link with the given
279
341
  # text or id.
280
342
  #
281
- # @param (see Capybara::Node::Finders#has_link?)
343
+ # @param (see #has_link?)
282
344
  # @return [Boolean] Whether it doesn't exist
283
345
  #
284
- def has_no_link?(locator=nil, options={}, &optional_filter_block)
285
- locator, options = nil, locator if locator.is_a? Hash
286
- has_no_selector?(:link, locator, options, &optional_filter_block)
346
+ def has_no_link?(locator = nil, **options, &optional_filter_block)
347
+ has_no_selector?(:link, locator, **options, &optional_filter_block)
287
348
  end
288
349
 
289
350
  ##
@@ -294,9 +355,8 @@ module Capybara
294
355
  # @param [String] locator The text, value or id of a button to check for
295
356
  # @return [Boolean] Whether it exists
296
357
  #
297
- def has_button?(locator=nil, options={}, &optional_filter_block)
298
- locator, options = nil, locator if locator.is_a? Hash
299
- has_selector?(:button, locator, options, &optional_filter_block)
358
+ def has_button?(locator = nil, **options, &optional_filter_block)
359
+ has_selector?(:button, locator, **options, &optional_filter_block)
300
360
  end
301
361
 
302
362
  ##
@@ -307,9 +367,8 @@ module Capybara
307
367
  # @param [String] locator The text, value or id of a button to check for
308
368
  # @return [Boolean] Whether it doesn't exist
309
369
  #
310
- def has_no_button?(locator=nil, options={}, &optional_filter_block)
311
- locator, options = nil, locator if locator.is_a? Hash
312
- has_no_selector?(:button, locator, options, &optional_filter_block)
370
+ def has_no_button?(locator = nil, **options, &optional_filter_block)
371
+ has_no_selector?(:button, locator, **options, &optional_filter_block)
313
372
  end
314
373
 
315
374
  ##
@@ -318,7 +377,7 @@ module Capybara
318
377
  # label, name or id.
319
378
  #
320
379
  # For text fields and other textual fields, such as textareas and
321
- # HTML5 email/url/etc. fields, it's possible to specify a :with
380
+ # HTML5 email/url/etc. fields, it's possible to specify a `:with`
322
381
  # option to specify the text the field should contain:
323
382
  #
324
383
  # page.has_field?('Name', with: 'Jonas')
@@ -327,87 +386,81 @@ module Capybara
327
386
  #
328
387
  # page.has_field?('Email', type: 'email')
329
388
  #
330
- # Note: 'textarea' and 'select' are valid type values, matching the associated tag names.
389
+ # NOTE: 'textarea' and 'select' are valid type values, matching the associated tag names.
331
390
  #
332
391
  # @param [String] locator The label, name or id of a field to check for
333
392
  # @option options [String, Regexp] :with The text content of the field or a Regexp to match
334
393
  # @option options [String] :type The type attribute of the field
335
394
  # @return [Boolean] Whether it exists
336
395
  #
337
- def has_field?(locator=nil, options={}, &optional_filter_block)
338
- locator, options = nil, locator if locator.is_a? Hash
339
- has_selector?(:field, locator, options, &optional_filter_block)
396
+ def has_field?(locator = nil, **options, &optional_filter_block)
397
+ has_selector?(:field, locator, **options, &optional_filter_block)
340
398
  end
341
399
 
342
400
  ##
343
401
  #
344
402
  # Checks if the page or current node has no form field with the given
345
- # label, name or id. See {Capybara::Node::Matchers#has_field?}.
403
+ # label, name or id. See {#has_field?}.
346
404
  #
347
405
  # @param [String] locator The label, name or id of a field to check for
348
406
  # @option options [String, Regexp] :with The text content of the field or a Regexp to match
349
407
  # @option options [String] :type The type attribute of the field
350
408
  # @return [Boolean] Whether it doesn't exist
351
409
  #
352
- def has_no_field?(locator=nil, options={}, &optional_filter_block)
353
- locator, options = nil, locator if locator.is_a? Hash
354
- has_no_selector?(:field, locator, options, &optional_filter_block)
410
+ def has_no_field?(locator = nil, **options, &optional_filter_block)
411
+ has_no_selector?(:field, locator, **options, &optional_filter_block)
355
412
  end
356
413
 
357
414
  ##
358
415
  #
359
416
  # Checks if the page or current node has a radio button or
360
- # checkbox with the given label, value or id, that is currently
417
+ # checkbox with the given label, value, id, or {Capybara.configure test_id} attribute that is currently
361
418
  # checked.
362
419
  #
363
420
  # @param [String] locator The label, name or id of a checked field
364
421
  # @return [Boolean] Whether it exists
365
422
  #
366
- def has_checked_field?(locator=nil, options={}, &optional_filter_block)
367
- locator, options = nil, locator if locator.is_a? Hash
368
- has_selector?(:field, locator, options.merge(checked: true), &optional_filter_block)
423
+ def has_checked_field?(locator = nil, **options, &optional_filter_block)
424
+ has_selector?(:field, locator, **options.merge(checked: true), &optional_filter_block)
369
425
  end
370
426
 
371
427
  ##
372
428
  #
373
429
  # Checks if the page or current node has no radio button or
374
- # checkbox with the given label, value or id, that is currently
430
+ # checkbox with the given label, value or id, or {Capybara.configure test_id} attribute that is currently
375
431
  # checked.
376
432
  #
377
433
  # @param [String] locator The label, name or id of a checked field
378
434
  # @return [Boolean] Whether it doesn't exist
379
435
  #
380
- def has_no_checked_field?(locator=nil, options={}, &optional_filter_block)
381
- locator, options = nil, locator if locator.is_a? Hash
382
- has_no_selector?(:field, locator, options.merge(checked: true), &optional_filter_block)
436
+ def has_no_checked_field?(locator = nil, **options, &optional_filter_block)
437
+ has_no_selector?(:field, locator, **options.merge(checked: true), &optional_filter_block)
383
438
  end
384
439
 
385
440
  ##
386
441
  #
387
442
  # Checks if the page or current node has a radio button or
388
- # checkbox with the given label, value or id, that is currently
443
+ # checkbox with the given label, value or id, or {Capybara.configure test_id} attribute that is currently
389
444
  # unchecked.
390
445
  #
391
446
  # @param [String] locator The label, name or id of an unchecked field
392
447
  # @return [Boolean] Whether it exists
393
448
  #
394
- def has_unchecked_field?(locator=nil, options={}, &optional_filter_block)
395
- locator, options = nil, locator if locator.is_a? Hash
396
- has_selector?(:field, locator, options.merge(unchecked: true), &optional_filter_block)
449
+ def has_unchecked_field?(locator = nil, **options, &optional_filter_block)
450
+ has_selector?(:field, locator, **options.merge(unchecked: true), &optional_filter_block)
397
451
  end
398
452
 
399
453
  ##
400
454
  #
401
455
  # Checks if the page or current node has no radio button or
402
- # checkbox with the given label, value or id, that is currently
456
+ # checkbox with the given label, value or id, or {Capybara.configure test_id} attribute that is currently
403
457
  # unchecked.
404
458
  #
405
459
  # @param [String] locator The label, name or id of an unchecked field
406
460
  # @return [Boolean] Whether it doesn't exist
407
461
  #
408
- def has_no_unchecked_field?(locator=nil, options={}, &optional_filter_block)
409
- locator, options = nil, locator if locator.is_a? Hash
410
- has_no_selector?(:field, locator, options.merge(unchecked: true), &optional_filter_block)
462
+ def has_no_unchecked_field?(locator = nil, **options, &optional_filter_block)
463
+ has_no_selector?(:field, locator, **options.merge(unchecked: true), &optional_filter_block)
411
464
  end
412
465
 
413
466
  ##
@@ -439,22 +492,20 @@ module Capybara
439
492
  # @option options [String, Array] :with_selected Partial set of options which should minimally be selected
440
493
  # @return [Boolean] Whether it exists
441
494
  #
442
- def has_select?(locator=nil, options={}, &optional_filter_block)
443
- locator, options = nil, locator if locator.is_a? Hash
444
- has_selector?(:select, locator, options, &optional_filter_block)
495
+ def has_select?(locator = nil, **options, &optional_filter_block)
496
+ has_selector?(:select, locator, **options, &optional_filter_block)
445
497
  end
446
498
 
447
499
  ##
448
500
  #
449
501
  # Checks if the page or current node has no select field with the
450
- # given label, name or id. See {Capybara::Node::Matchers#has_select?}.
502
+ # given label, name or id. See {#has_select?}.
451
503
  #
452
- # @param (see Capybara::Node::Matchers#has_select?)
504
+ # @param (see #has_select?)
453
505
  # @return [Boolean] Whether it doesn't exist
454
506
  #
455
- def has_no_select?(locator=nil, options={}, &optional_filter_block)
456
- locator, options = nil, locator if locator.is_a? Hash
457
- has_no_selector?(:select, locator, options, &optional_filter_block)
507
+ def has_no_select?(locator = nil, **options, &optional_filter_block)
508
+ has_no_selector?(:select, locator, **options, &optional_filter_block)
458
509
  end
459
510
 
460
511
  ##
@@ -464,37 +515,43 @@ module Capybara
464
515
  #
465
516
  # page.has_table?('People')
466
517
  #
467
- # @param [String] locator The id or caption of a table
468
- # @return [Boolean] Whether it exist
518
+ # @param [String] locator The id or caption of a table
519
+ # @option options [Array<Array<String>>] :rows
520
+ # Text which should be contained in the tables `<td>` elements organized by row (`<td>` visibility is not considered)
521
+ # @option options [Array<Array<String>>, Array<Hash<String,String>>] :with_rows
522
+ # Partial set of text which should be contained in the tables `<td>` elements organized by row (`<td>` visibility is not considered)
523
+ # @option options [Array<Array<String>>] :cols
524
+ # Text which should be contained in the tables `<td>` elements organized by column (`<td>` visibility is not considered)
525
+ # @option options [Array<Array<String>>, Array<Hash<String,String>>] :with_cols
526
+ # Partial set of text which should be contained in the tables `<td>` elements organized by column (`<td>` visibility is not considered)
527
+ # @return [Boolean] Whether it exists
469
528
  #
470
- def has_table?(locator=nil, options={}, &optional_filter_block)
471
- locator, options = nil, locator if locator.is_a? Hash
472
- has_selector?(:table, locator, options, &optional_filter_block)
529
+ def has_table?(locator = nil, **options, &optional_filter_block)
530
+ has_selector?(:table, locator, **options, &optional_filter_block)
473
531
  end
474
532
 
475
533
  ##
476
534
  #
477
535
  # Checks if the page or current node has no table with the given id
478
- # or caption. See {Capybara::Node::Matchers#has_table?}.
536
+ # or caption. See {#has_table?}.
479
537
  #
480
- # @param (see Capybara::Node::Matchers#has_table?)
538
+ # @param (see #has_table?)
481
539
  # @return [Boolean] Whether it doesn't exist
482
540
  #
483
- def has_no_table?(locator=nil, options={}, &optional_filter_block)
484
- locator, options = nil, locator if locator.is_a? Hash
485
- has_no_selector?(:table, locator, options, &optional_filter_block)
541
+ def has_no_table?(locator = nil, **options, &optional_filter_block)
542
+ has_no_selector?(:table, locator, **options, &optional_filter_block)
486
543
  end
487
544
 
488
545
  ##
489
546
  #
490
- # Asserts that the current_node matches a given selector
547
+ # Asserts that the current node matches a given selector.
491
548
  #
492
549
  # node.assert_matches_selector('p#foo')
493
550
  # node.assert_matches_selector(:xpath, '//p[@id="foo"]')
494
551
  # node.assert_matches_selector(:foo)
495
552
  #
496
553
  # It also accepts all options that {Capybara::Node::Finders#all} accepts,
497
- # such as :text and :visible.
554
+ # such as `:text` and `:visible`.
498
555
  #
499
556
  # node.assert_matches_selector('li', text: 'Horse', visible: true)
500
557
  #
@@ -503,117 +560,121 @@ module Capybara
503
560
  #
504
561
  def assert_matches_selector(*args, &optional_filter_block)
505
562
  _verify_match_result(args, optional_filter_block) do |result|
506
- raise Capybara::ExpectationNotMet, "Item does not match the provided selector" unless result.include? self
563
+ raise Capybara::ExpectationNotMet, 'Item does not match the provided selector' unless result.include? self
507
564
  end
508
565
  end
509
566
 
567
+ ##
568
+ #
569
+ # Asserts that the current node does not match a given selector.
570
+ # Usage is identical to {#assert_matches_selector}.
571
+ #
572
+ # @param (see #assert_matches_selector)
573
+ # @raise [Capybara::ExpectationNotMet] If the selector matches
574
+ #
510
575
  def assert_not_matches_selector(*args, &optional_filter_block)
511
576
  _verify_match_result(args, optional_filter_block) do |result|
512
577
  raise Capybara::ExpectationNotMet, 'Item matched the provided selector' if result.include? self
513
578
  end
514
579
  end
515
- alias_method :refute_matches_selector, :assert_not_matches_selector
516
580
 
517
581
  ##
518
582
  #
519
- # Checks if the current node matches given selector
583
+ # Checks if the current node matches given selector.
520
584
  #
521
- # @param (see Capybara::Node::Finders#has_selector?)
585
+ # @param (see #has_selector?)
522
586
  # @return [Boolean]
523
587
  #
524
- def matches_selector?(*args, &optional_filter_block)
525
- assert_matches_selector(*args, &optional_filter_block)
526
- rescue Capybara::ExpectationNotMet
527
- return false
588
+ def matches_selector?(*args, **options, &optional_filter_block)
589
+ make_predicate(options) { assert_matches_selector(*args, options, &optional_filter_block) }
528
590
  end
529
591
 
530
592
  ##
531
593
  #
532
- # Checks if the current node matches given XPath expression
594
+ # Checks if the current node matches given XPath expression.
533
595
  #
534
596
  # @param [String, XPath::Expression] xpath The XPath expression to match against the current code
535
597
  # @return [Boolean]
536
598
  #
537
- def matches_xpath?(xpath, options={}, &optional_filter_block)
538
- matches_selector?(:xpath, xpath, options, &optional_filter_block)
599
+ def matches_xpath?(xpath, **options, &optional_filter_block)
600
+ matches_selector?(:xpath, xpath, **options, &optional_filter_block)
539
601
  end
540
602
 
541
603
  ##
542
604
  #
543
- # Checks if the current node matches given CSS selector
605
+ # Checks if the current node matches given CSS selector.
544
606
  #
545
607
  # @param [String] css The CSS selector to match against the current code
546
608
  # @return [Boolean]
547
609
  #
548
- def matches_css?(css, options={}, &optional_filter_block)
549
- matches_selector?(:css, css, options, &optional_filter_block)
610
+ def matches_css?(css, **options, &optional_filter_block)
611
+ matches_selector?(:css, css, **options, &optional_filter_block)
550
612
  end
551
613
 
552
614
  ##
553
615
  #
554
- # Checks if the current node does not match given selector
555
- # Usage is identical to Capybara::Node::Matchers#has_selector?
616
+ # Checks if the current node does not match given selector.
617
+ # Usage is identical to {#has_selector?}.
556
618
  #
557
- # @param (see Capybara::Node::Finders#has_selector?)
619
+ # @param (see #has_selector?)
558
620
  # @return [Boolean]
559
621
  #
560
- def not_matches_selector?(*args, &optional_filter_block)
561
- assert_not_matches_selector(*args, &optional_filter_block)
562
- rescue Capybara::ExpectationNotMet
563
- return false
622
+ def not_matches_selector?(*args, **options, &optional_filter_block)
623
+ make_predicate(options) { assert_not_matches_selector(*args, options, &optional_filter_block) }
564
624
  end
565
625
 
566
626
  ##
567
627
  #
568
- # Checks if the current node does not match given XPath expression
628
+ # Checks if the current node does not match given XPath expression.
569
629
  #
570
630
  # @param [String, XPath::Expression] xpath The XPath expression to match against the current code
571
631
  # @return [Boolean]
572
632
  #
573
- def not_matches_xpath?(xpath, options={}, &optional_filter_block)
574
- not_matches_selector?(:xpath, xpath, options, &optional_filter_block)
633
+ def not_matches_xpath?(xpath, **options, &optional_filter_block)
634
+ not_matches_selector?(:xpath, xpath, **options, &optional_filter_block)
575
635
  end
576
636
 
577
637
  ##
578
638
  #
579
- # Checks if the current node does not match given CSS selector
639
+ # Checks if the current node does not match given CSS selector.
580
640
  #
581
641
  # @param [String] css The CSS selector to match against the current code
582
642
  # @return [Boolean]
583
643
  #
584
- def not_matches_css?(css, options={}, &optional_filter_block)
585
- not_matches_selector?(:css, css, options, &optional_filter_block)
644
+ def not_matches_css?(css, **options, &optional_filter_block)
645
+ not_matches_selector?(:css, css, **options, &optional_filter_block)
586
646
  end
587
647
 
588
-
589
648
  ##
590
649
  # Asserts that the page or current node has the given text content,
591
650
  # ignoring any HTML tags.
592
651
  #
593
652
  # @!macro text_query_params
594
- # @overload $0(type, text, options = {})
595
- # @param [:all, :visible] type Whether to check for only visible or all text. If this parameter is missing or nil then we use the value of `Capybara.ignore_hidden_elements`, which defaults to `true`, corresponding to `:visible`.
653
+ # @overload $0(type, text, **options)
654
+ # @param [:all, :visible] type Whether to check for only visible or all text. If this parameter is missing or nil then we use the value of {Capybara.configure ignore_hidden_elements}, which defaults to `true`, corresponding to `:visible`.
596
655
  # @param [String, Regexp] text The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.
597
656
  # @option options [Integer] :count (nil) Number of times the text is expected to occur
598
657
  # @option options [Integer] :minimum (nil) Minimum number of times the text is expected to occur
599
658
  # @option options [Integer] :maximum (nil) Maximum number of times the text is expected to occur
600
659
  # @option options [Range] :between (nil) Range of times that is expected to contain number of times text occurs
601
- # @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time that Capybara will wait for text to eq/match given string/regexp argument
602
- # @option options [Boolean] :exact (Capybara.exact_text) Whether text must be an exact match or just substring
603
- # @overload $0(text, options = {})
660
+ # @option options [Numeric] :wait Maximum time that Capybara will wait for text to eq/match given string/regexp argument. Defaults to {Capybara.configure default_max_wait_time}.
661
+ # @option options [Boolean] :exact Whether text must be an exact match or just substring. Defaults to {Capybara.configure exact_text}.
662
+ # @option options [Boolean] :normalize_ws (false) When `true` replace all whitespace with standard spaces and collapse consecutive whitespace to a single space
663
+ # @overload $0(text, **options)
604
664
  # @param [String, Regexp] text The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.
605
665
  # @option options [Integer] :count (nil) Number of times the text is expected to occur
606
666
  # @option options [Integer] :minimum (nil) Minimum number of times the text is expected to occur
607
667
  # @option options [Integer] :maximum (nil) Maximum number of times the text is expected to occur
608
668
  # @option options [Range] :between (nil) Range of times that is expected to contain number of times text occurs
609
- # @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time that Capybara will wait for text to eq/match given string/regexp argument
610
- # @option options [Boolean] :exact (Capybara.exact_text) Whether text must be an exact match or just substring
669
+ # @option options [Numeric] :wait Maximum time that Capybara will wait for text to eq/match given string/regexp argument. Defaults to {Capybara.configure default_max_wait_time}.
670
+ # @option options [Boolean] :exact Whether text must be an exact match or just substring. Defaults to {Capybara.configure exact_text}.
671
+ # @option options [Boolean] :normalize_ws (false) When `true` replace all whitespace with standard spaces and collapse consecutive whitespace to a single space
611
672
  # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
612
673
  # @return [true]
613
674
  #
614
- def assert_text(*args)
615
- _verify_text(args) do |count, query|
616
- unless query.matches_count?(count) && ((count > 0) || query.expects_none?)
675
+ def assert_text(type_or_text, *args, **opts)
676
+ _verify_text(type_or_text, *args, **opts) do |count, query|
677
+ unless query.matches_count?(count) && (count.positive? || query.expects_none?)
617
678
  raise Capybara::ExpectationNotMet, query.failure_message
618
679
  end
619
680
  end
@@ -627,9 +688,9 @@ module Capybara
627
688
  # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
628
689
  # @return [true]
629
690
  #
630
- def assert_no_text(*args)
631
- _verify_text(args) do |count, query|
632
- if query.matches_count?(count) && ((count > 0) || query.expects_none?)
691
+ def assert_no_text(type_or_text, *args, **opts)
692
+ _verify_text(type_or_text, *args, **opts) do |count, query|
693
+ if query.matches_count?(count) && (count.positive? || query.expects_none?)
633
694
  raise Capybara::ExpectationNotMet, query.negative_failure_message
634
695
  end
635
696
  end
@@ -639,10 +700,6 @@ module Capybara
639
700
  # Checks if the page or current node has the given text content,
640
701
  # ignoring any HTML tags.
641
702
  #
642
- # Whitespaces are normalized in both node's text and passed text parameter.
643
- # Note that whitespace isn't normalized in passed regexp as normalizing whitespace
644
- # in regexp isn't easy and doesn't seem to be worth it.
645
- #
646
703
  # By default it will check if the text occurs at least once,
647
704
  # but a different number can be specified.
648
705
  #
@@ -653,10 +710,8 @@ module Capybara
653
710
  # @macro text_query_params
654
711
  # @return [Boolean] Whether it exists
655
712
  #
656
- def has_text?(*args)
657
- assert_text(*args)
658
- rescue Capybara::ExpectationNotMet
659
- return false
713
+ def has_text?(*args, **options)
714
+ make_predicate(options) { assert_text(*args, **options) }
660
715
  end
661
716
  alias_method :has_content?, :has_text?
662
717
 
@@ -667,56 +722,161 @@ module Capybara
667
722
  # @macro text_query_params
668
723
  # @return [Boolean] Whether it doesn't exist
669
724
  #
670
- def has_no_text?(*args)
671
- assert_no_text(*args)
672
- rescue Capybara::ExpectationNotMet
673
- return false
725
+ def has_no_text?(*args, **options)
726
+ make_predicate(options) { assert_no_text(*args, **options) }
674
727
  end
675
728
  alias_method :has_no_content?, :has_no_text?
676
729
 
730
+ ##
731
+ #
732
+ # Asserts that a given selector matches an ancestor of the current node.
733
+ #
734
+ # element.assert_ancestor('p#foo')
735
+ #
736
+ # Accepts the same options as {#assert_selector}
737
+ #
738
+ # @param (see Capybara::Node::Finders#find)
739
+ # @raise [Capybara::ExpectationNotMet] If the selector does not exist
740
+ #
741
+ def assert_ancestor(*args, &optional_filter_block)
742
+ _verify_selector_result(args, optional_filter_block, Capybara::Queries::AncestorQuery) do |result, query|
743
+ unless result.matches_count? && (result.any? || query.expects_none?)
744
+ raise Capybara::ExpectationNotMet, result.failure_message
745
+ end
746
+ end
747
+ end
748
+
749
+ def assert_no_ancestor(*args, &optional_filter_block)
750
+ _verify_selector_result(args, optional_filter_block, Capybara::Queries::AncestorQuery) do |result, query|
751
+ if result.matches_count? && (!result.empty? || query.expects_none?)
752
+ raise Capybara::ExpectationNotMet, result.negative_failure_message
753
+ end
754
+ end
755
+ end
756
+
757
+ ##
758
+ #
759
+ # Predicate version of {#assert_ancestor}
760
+ #
761
+ def has_ancestor?(*args, **options, &optional_filter_block)
762
+ make_predicate(options) { assert_ancestor(*args, options, &optional_filter_block) }
763
+ end
764
+
765
+ ##
766
+ #
767
+ # Predicate version of {#assert_no_ancestor}
768
+ #
769
+ def has_no_ancestor?(*args, **options, &optional_filter_block)
770
+ make_predicate(options) { assert_no_ancestor(*args, options, &optional_filter_block) }
771
+ end
772
+
773
+ ##
774
+ #
775
+ # Asserts that a given selector matches a sibling of the current node.
776
+ #
777
+ # element.assert_sibling('p#foo')
778
+ #
779
+ # Accepts the same options as {#assert_selector}
780
+ #
781
+ # @param (see Capybara::Node::Finders#find)
782
+ # @raise [Capybara::ExpectationNotMet] If the selector does not exist
783
+ #
784
+ def assert_sibling(*args, &optional_filter_block)
785
+ _verify_selector_result(args, optional_filter_block, Capybara::Queries::SiblingQuery) do |result, query|
786
+ unless result.matches_count? && (result.any? || query.expects_none?)
787
+ raise Capybara::ExpectationNotMet, result.failure_message
788
+ end
789
+ end
790
+ end
791
+
792
+ def assert_no_sibling(*args, &optional_filter_block)
793
+ _verify_selector_result(args, optional_filter_block, Capybara::Queries::SiblingQuery) do |result, query|
794
+ if result.matches_count? && (!result.empty? || query.expects_none?)
795
+ raise Capybara::ExpectationNotMet, result.negative_failure_message
796
+ end
797
+ end
798
+ end
799
+
800
+ ##
801
+ #
802
+ # Predicate version of {#assert_sibling}
803
+ #
804
+ def has_sibling?(*args, **options, &optional_filter_block)
805
+ make_predicate(options) { assert_sibling(*args, options, &optional_filter_block) }
806
+ end
807
+
808
+ ##
809
+ #
810
+ # Predicate version of {#assert_no_sibling}
811
+ #
812
+ def has_no_sibling?(*args, **options, &optional_filter_block)
813
+ make_predicate(options) { assert_no_sibling(*args, options, &optional_filter_block) }
814
+ end
815
+
677
816
  def ==(other)
678
- self.eql?(other) || (other.respond_to?(:base) && base == other.base)
817
+ eql?(other) || (other.respond_to?(:base) && base == other.base)
679
818
  end
680
819
 
681
820
  private
682
821
 
683
- def _verify_selector_result(query_args, optional_filter_block, &result_block)
684
- _set_query_session_options(query_args)
685
- query = Capybara::Queries::SelectorQuery.new(*query_args, &optional_filter_block)
686
- synchronize(query.wait) do
687
- result = query.resolve_for(self)
688
- result_block.call(result, query)
822
+ def extract_selector(args)
823
+ args.first.is_a?(Symbol) ? args.shift : session_options.default_selector
824
+ end
825
+
826
+ def _verify_multiple(*args, wait: nil, **options)
827
+ wait = session_options.default_max_wait_time if wait.nil?
828
+ selector = extract_selector(args)
829
+ synchronize(wait) do
830
+ args.each { |locator| yield(selector, locator, options) }
689
831
  end
690
- return true
691
832
  end
692
833
 
693
- def _verify_match_result(query_args, optional_filter_block, &result_block)
694
- _set_query_session_options(query_args)
695
- query = Capybara::Queries::MatchQuery.new(*query_args, &optional_filter_block)
834
+ def _verify_selector_result(query_args, optional_filter_block, query_type = Capybara::Queries::SelectorQuery)
835
+ # query_args, query_opts = if query_args[0].is_a? Symbol
836
+ # a,o = _set_query_session_options(*query_args.slice(2..))
837
+ # [query_args.slice(0..1).concat(a), o]
838
+ # else
839
+ # _set_query_session_options(*query_args)
840
+ # end
841
+ query_args, query_opts = _set_query_session_options(*query_args)
842
+ query = query_type.new(*query_args, **query_opts, &optional_filter_block)
696
843
  synchronize(query.wait) do
697
- result = query.resolve_for(self.query_scope)
698
- result_block.call(result)
844
+ yield query.resolve_for(self), query
699
845
  end
700
- return true
846
+ true
701
847
  end
702
848
 
703
- def _verify_text(query_args)
704
- _set_query_session_options(query_args)
705
- query = Capybara::Queries::TextQuery.new(*query_args)
849
+ def _verify_match_result(query_args, optional_filter_block)
850
+ query_args, query_opts = _set_query_session_options(*query_args)
851
+ query = Capybara::Queries::MatchQuery.new(*query_args, **query_opts, &optional_filter_block)
706
852
  synchronize(query.wait) do
707
- count = query.resolve_for(self)
708
- yield(count, query)
853
+ yield query.resolve_for(parent || session&.document || query_scope)
709
854
  end
710
- return true
855
+ true
711
856
  end
712
857
 
713
- def _set_query_session_options(query_args)
714
- if query_args.last.is_a? Hash
715
- query_args.last[:session_options] = session_options
716
- else
717
- query_args.push(session_options: session_options)
858
+ def _verify_text(type = nil, expected_text, **query_options) # rubocop:disable Style/OptionalArguments
859
+ query_options[:session_options] = session_options
860
+ query = Capybara::Queries::TextQuery.new(type, expected_text, **query_options)
861
+ synchronize(query.wait) do
862
+ yield query.resolve_for(self), query
718
863
  end
719
- query_args
864
+ true
865
+ end
866
+
867
+ def _set_query_session_options(*query_args)
868
+ query_args, query_options = query_args.dup, {}
869
+ # query_options = query_args.pop if query_options.empty? && query_args.last.is_a?(Hash)
870
+ query_options = query_args.pop if query_args.last.is_a?(Hash)
871
+ query_options[:session_options] = session_options
872
+ [query_args, query_options]
873
+ end
874
+
875
+ def make_predicate(options)
876
+ options[:wait] = 0 unless options.key?(:wait) || session_options.predicates_wait
877
+ yield
878
+ rescue Capybara::ExpectationNotMet
879
+ false
720
880
  end
721
881
  end
722
882
  end