Class: Capybara::Session
- Inherits:
-
Object
- Object
- Capybara::Session
- Includes:
- Minitest::Expectations, SessionMatchers
- Defined in:
- lib/capybara/session.rb,
lib/capybara/minitest/spec.rb
Overview
The Session class represents a single user’s interaction with the system. The Session can use any of the underlying drivers. A session can be initialized manually like this:
session = Capybara::Session.new(:culerity, MyRackApp)
The application given as the second argument is optional. When running Capybara against an external page, you might want to leave it out:
session = Capybara::Session.new(:culerity)
session.visit('http://www.google.com')
When Capybara.threadsafe == true the sessions options will be initially set to the current values of the global options and a configuration block can be passed to the session initializer. For available options see Capybara::SessionConfig::OPTIONS
session = Capybara::Session.new(:driver, MyRackApp) do |config|
config.app_host = "http://my_host.dev"
end
Session provides a number of methods for controlling the navigation of the page, such as visit
, +current_path, and so on. It also delegates a number of methods to a Capybara::Document, representing the current HTML document. This allows interaction:
session.fill_in('q', with: 'Capybara')
session.('Search')
expect(session).to have_content('Capybara')
When using capybara/dsl, the Session is initialized automatically for you.
Constant Summary collapse
- NODE_METHODS =
%i[ all first attach_file text check choose scroll_to scroll_by click_link_or_button click_button click_link fill_in find find_all find_button find_by_id find_field find_link has_content? has_text? has_css? has_no_content? has_no_text? has_no_css? has_no_xpath? has_xpath? select uncheck has_link? has_no_link? has_button? has_no_button? has_field? has_no_field? has_checked_field? has_unchecked_field? has_no_table? has_table? unselect has_select? has_no_select? has_selector? has_no_selector? click_on has_no_checked_field? has_no_unchecked_field? query assert_selector assert_no_selector assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors refute_selector assert_text assert_no_text ].freeze
- DOCUMENT_METHODS =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
%i[ title assert_title assert_no_title has_title? has_no_title? ].freeze
- SESSION_METHODS =
%i[ body html source current_url current_host current_path execute_script evaluate_script visit refresh go_back go_forward within within_element within_fieldset within_table within_frame switch_to_frame current_window windows open_new_window switch_to_window within_window window_opened_by save_page save_and_open_page save_screenshot save_and_open_screenshot reset_session! response_headers status_code current_scope assert_current_path assert_no_current_path has_current_path? has_no_current_path? ].freeze + DOCUMENT_METHODS
- MODAL_METHODS =
%i[ accept_alert accept_confirm dismiss_confirm accept_prompt dismiss_prompt ].freeze
- DSL_METHODS =
NODE_METHODS + SESSION_METHODS + MODAL_METHODS
Instance Attribute Summary collapse
-
#app ⇒ Object
readonly
Returns the value of attribute app.
-
#mode ⇒ Object
readonly
Returns the value of attribute mode.
-
#server ⇒ Object
readonly
Returns the value of attribute server.
-
#synchronized ⇒ Object
Returns the value of attribute synchronized.
Class Method Summary collapse
Instance Method Summary collapse
-
#accept_alert(text = nil, **options, &blk) ⇒ String
Execute the block, accepting a alert.
-
#accept_confirm(text = nil, **options, &blk) ⇒ String
Execute the block, accepting a confirm.
-
#accept_prompt(text = nil, **options, &blk) ⇒ String
Execute the block, accepting a prompt, optionally responding to the prompt.
- #config ⇒ Object
-
#configure {|config| ... } ⇒ Object
Accepts a block to set the configuration options if Capybara.threadsafe == true.
-
#current_host ⇒ String
Host of the current page.
-
#current_path ⇒ String
Path of the current page, without any domain information.
- #current_scope ⇒ Object
-
#current_url ⇒ String
Fully qualified URL of the current page.
-
#current_window ⇒ Capybara::Window
Current window.
-
#dismiss_confirm(text = nil, **options, &blk) ⇒ String
Execute the block, dismissing a confirm.
-
#dismiss_prompt(text = nil, **options, &blk) ⇒ String
Execute the block, dismissing a prompt.
- #document ⇒ Object
- #driver ⇒ Object
-
#evaluate_async_script(script, *args) ⇒ Object
Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.
-
#evaluate_script(script, *args) ⇒ Object
Evaluate the given JavaScript and return the result.
-
#execute_script(script, *args) ⇒ Object
Execute the given script, not returning a result.
-
#go_back ⇒ Object
Move back a single entry in the browser’s history.
-
#go_forward ⇒ Object
Move forward a single entry in the browser’s history.
-
#html ⇒ String
(also: #body, #source)
A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).
-
#initialize(mode, app = nil) ⇒ Session
constructor
A new instance of Session.
- #inspect ⇒ Object
-
#open_new_window ⇒ Capybara::Window
Open new window.
-
#quit ⇒ Object
Disconnect from the current driver.
-
#raise_server_error! ⇒ Object
Raise errors encountered in the server.
-
#refresh ⇒ Object
Refresh the page.
-
#reset! ⇒ Object
(also: #cleanup!, #reset_session!)
Reset the session (i.e. remove cookies and navigate to blank page).
-
#response_headers ⇒ Hash{String => String}
Returns a hash of response headers.
-
#save_and_open_page(path = nil) ⇒ Object
Save a snapshot of the page and open it in a browser for inspection.
-
#save_and_open_screenshot(path = nil, **options) ⇒ Object
Save a screenshot of the page and open it for inspection.
-
#save_page(path = nil) ⇒ String
Save a snapshot of the page.
-
#save_screenshot(path = nil, **options) ⇒ String
Save a screenshot of page.
-
#status_code ⇒ Integer
Returns the current HTTP status code as an Integer.
-
#switch_to_frame(frame) ⇒ Object
Switch to the given frame.
-
#switch_to_window(window = nil, **options, &window_locator) ⇒ Capybara::Window
Window that has been switched to.
-
#using_wait_time(seconds) ⇒ Object
Yield a block using a specific wait time.
-
#visit(visit_uri) ⇒ Object
Navigate to the given URL.
-
#window_opened_by(**options, &block) ⇒ Capybara::Window
Get the window that has been opened by the passed block.
-
#windows ⇒ Array<Capybara::Window>
Get all opened windows.
-
#within(*args) ⇒ Object
(also: #within_element)
Executes the given block within the context of a node.
-
#within_fieldset(locator) ⇒ Object
Execute the given block within the a specific fieldset given the id or legend of that fieldset.
-
#within_frame(*args) ⇒ Object
Execute the given block within the given iframe using given frame, frame name/id or index.
-
#within_table(locator) ⇒ Object
Execute the given block within the a specific table given the id or caption of that table.
-
#within_window(window_or_proc) ⇒ Object
This method does the following:.
Methods included from Minitest::Expectations
Methods included from SessionMatchers
#assert_current_path, #assert_no_current_path, #has_current_path?, #has_no_current_path?
Constructor Details
#initialize(mode, app = nil) ⇒ Session
Returns a new instance of Session.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/capybara/session.rb', line 77 def initialize(mode, app = nil) raise TypeError, 'The second parameter to Session::new should be a rack app if passed.' if app && !app.respond_to?(:call) @@instance_created = true @mode = mode @app = app if block_given? raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe yield config end @server = if config.run_server && @app && driver.needs_server? = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors } [:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation Capybara::Server.new(@app, ).boot end @touched = false end |
Instance Attribute Details
#app ⇒ Object (readonly)
Returns the value of attribute app.
74 75 76 |
# File 'lib/capybara/session.rb', line 74 def app @app end |
#mode ⇒ Object (readonly)
Returns the value of attribute mode.
74 75 76 |
# File 'lib/capybara/session.rb', line 74 def mode @mode end |
#server ⇒ Object (readonly)
Returns the value of attribute server.
74 75 76 |
# File 'lib/capybara/session.rb', line 74 def server @server end |
#synchronized ⇒ Object
Returns the value of attribute synchronized.
75 76 77 |
# File 'lib/capybara/session.rb', line 75 def synchronized @synchronized end |
Class Method Details
.instance_created? ⇒ Boolean
792 793 794 |
# File 'lib/capybara/session.rb', line 792 def self.instance_created? @@instance_created end |
Instance Method Details
#accept_alert(text, **options) { ... } ⇒ String #accept_alert(**options) { ... } ⇒ String
Execute the block, accepting a alert.
Expects a block whose actions will trigger the display modal to appear
628 629 630 |
# File 'lib/capybara/session.rb', line 628 def accept_alert(text = nil, **, &blk) accept_modal(:alert, text, , &blk) end |
#accept_confirm(text, **options) { ... } ⇒ String #accept_confirm(**options) { ... } ⇒ String
Execute the block, accepting a confirm.
Expects a block whose actions will trigger the display modal to appear
638 639 640 |
# File 'lib/capybara/session.rb', line 638 def accept_confirm(text = nil, **, &blk) accept_modal(:confirm, text, , &blk) end |
#accept_prompt(text, **options) { ... } ⇒ String #accept_prompt(**options) { ... } ⇒ String
Execute the block, accepting a prompt, optionally responding to the prompt.
Expects a block whose actions will trigger the display modal to appear
659 660 661 |
# File 'lib/capybara/session.rb', line 659 def accept_prompt(text = nil, **, &blk) accept_modal(:prompt, text, , &blk) end |
#config ⇒ Object
796 797 798 799 800 801 802 |
# File 'lib/capybara/session.rb', line 796 def config @config ||= if Capybara.threadsafe Capybara..dup else Capybara::ReadOnlySessionConfig.new(Capybara.) end end |
#configure {|config| ... } ⇒ Object
Accepts a block to set the configuration options if Capybara.threadsafe == true. Note that some options only have an effect
if set at initialization time, so look at the configuration block that can be passed to the initializer too
786 787 788 789 790 |
# File 'lib/capybara/session.rb', line 786 def configure raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe yield config end |
#current_host ⇒ String
Returns Host of the current page.
218 219 220 221 |
# File 'lib/capybara/session.rb', line 218 def current_host uri = URI.parse(current_url) "#{uri.scheme}://#{uri.host}" if uri.host end |
#current_path ⇒ String
Returns Path of the current page, without any domain information.
203 204 205 206 207 208 209 210 211 212 |
# File 'lib/capybara/session.rb', line 203 def current_path # Addressable parsing is more lenient than URI uri = ::Addressable::URI.parse(current_url) # Addressable doesn't support opaque URIs - we want nil here return nil if uri&.scheme == 'about' path = uri&.path path unless path&.empty? end |
#current_scope ⇒ Object
758 759 760 761 |
# File 'lib/capybara/session.rb', line 758 def current_scope scope = scopes.last [nil, :frame].include?(scope) ? document : scope end |
#current_url ⇒ String
Returns Fully qualified URL of the current page.
227 228 229 |
# File 'lib/capybara/session.rb', line 227 def current_url driver.current_url end |
#current_window ⇒ Capybara::Window
Returns current window.
437 438 439 |
# File 'lib/capybara/session.rb', line 437 def current_window Window.new(self, driver.current_window_handle) end |
#dismiss_confirm(text, **options) { ... } ⇒ String #dismiss_confirm(**options) { ... } ⇒ String
Execute the block, dismissing a confirm.
Expects a block whose actions will trigger the display modal to appear
648 649 650 |
# File 'lib/capybara/session.rb', line 648 def dismiss_confirm(text = nil, **, &blk) dismiss_modal(:confirm, text, , &blk) end |
#dismiss_prompt(text, **options) { ... } ⇒ String #dismiss_prompt(**options) { ... } ⇒ String
Execute the block, dismissing a prompt.
Expects a block whose actions will trigger the display modal to appear
669 670 671 |
# File 'lib/capybara/session.rb', line 669 def dismiss_prompt(text = nil, **, &blk) dismiss_modal(:prompt, text, , &blk) end |
#document ⇒ Object
737 738 739 |
# File 'lib/capybara/session.rb', line 737 def document @document ||= Capybara::Node::Document.new(self, driver) end |
#driver ⇒ Object
96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/capybara/session.rb', line 96 def driver @driver ||= begin unless Capybara.drivers.key?(mode) other_drivers = Capybara.drivers.keys.map(&:inspect) raise Capybara::DriverNotFoundError, "no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}" end driver = Capybara.drivers[mode].call(app) driver.session = self if driver.respond_to?(:session=) driver end end |
#evaluate_async_script(script, *args) ⇒ Object
Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script.
602 603 604 605 606 |
# File 'lib/capybara/session.rb', line 602 def evaluate_async_script(script, *args) @touched = true result = driver.evaluate_async_script(script, *driver_args(args)) element_script_result(result) end |
#evaluate_script(script, *args) ⇒ Object
Evaluate the given JavaScript and return the result. Be careful when using this with scripts that return complex objects, such as jQuery statements. execute_script
might be a better alternative.
589 590 591 592 593 |
# File 'lib/capybara/session.rb', line 589 def evaluate_script(script, *args) @touched = true result = driver.evaluate_script(script.strip, *driver_args(args)) element_script_result(result) end |
#execute_script(script, *args) ⇒ Object
Execute the given script, not returning a result. This is useful for scripts that return complex objects, such as jQuery statements. execute_script
should be used over evaluate_script
whenever possible.
575 576 577 578 |
# File 'lib/capybara/session.rb', line 575 def execute_script(script, *args) @touched = true driver.execute_script(script, *driver_args(args)) end |
#go_back ⇒ Object
Move back a single entry in the browser’s history.
293 294 295 |
# File 'lib/capybara/session.rb', line 293 def go_back driver.go_back end |
#go_forward ⇒ Object
Move forward a single entry in the browser’s history.
301 302 303 |
# File 'lib/capybara/session.rb', line 301 def go_forward driver.go_forward end |
#html ⇒ String Also known as: body, source
Returns A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).
193 194 195 |
# File 'lib/capybara/session.rb', line 193 def html driver.html end |
#inspect ⇒ Object
754 755 756 |
# File 'lib/capybara/session.rb', line 754 def inspect %(#<Capybara::Session>) end |
#open_new_window ⇒ Capybara::Window
Open new window. Current window doesn’t change as the result of this call. It should be switched to explicitly.
461 462 463 464 465 |
# File 'lib/capybara/session.rb', line 461 def open_new_window window_opened_by do driver.open_new_window end end |
#quit ⇒ Object
Disconnect from the current driver. A new driver will be instantiated on the next interaction
142 143 144 145 146 147 |
# File 'lib/capybara/session.rb', line 142 def quit @driver.quit if @driver.respond_to? :quit @driver = nil @touched = false @server&.reset_error! end |
#raise_server_error! ⇒ Object
Raise errors encountered in the server
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/capybara/session.rb', line 153 def raise_server_error! return unless @server&.error # Force an explanation for the error being raised as the exception cause begin if config.raise_server_errors raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true' end rescue CapybaraError # needed to get the cause set correctly in JRuby -- otherwise we could just do raise @server.error raise @server.error, @server.error., @server.error.backtrace ensure @server.reset_error! end end |
#refresh ⇒ Object
Refresh the page
284 285 286 287 |
# File 'lib/capybara/session.rb', line 284 def refresh raise_server_error! driver.refresh end |
#reset! ⇒ Object Also known as: cleanup!, reset_session!
Reset the session (i.e. remove cookies and navigate to blank page)
This method does not:
* accept modal dialogs if they are present (Selenium driver now does, others may not)
* clear browser cache/HTML 5 local storage/IndexedDB/Web SQL database/etc.
* modify state of the driver/underlying browser in any other way
as doing so will result in performance downsides and it’s not needed to do everything from the list above for most apps.
If you want to do anything from the list above on a general basis you can:
* write RSpec/Cucumber/etc. after hook
* monkeypatch this method
* use Ruby's `prepend` method
126 127 128 129 130 131 132 133 |
# File 'lib/capybara/session.rb', line 126 def reset! if @touched driver.reset! @touched = false end @server&.wait_for_pending_requests raise_server_error! end |
#response_headers ⇒ Hash{String => String}
Returns a hash of response headers. Not supported by all drivers (e.g. Selenium)
175 176 177 |
# File 'lib/capybara/session.rb', line 175 def response_headers driver.response_headers end |
#save_and_open_page(path = nil) ⇒ Object
Save a snapshot of the page and open it in a browser for inspection.
If invoked without arguments it will save file to ‘Capybara.save_path`
and file will be given randomly generated filename. If invoked with a relative path
the path will be relative to `Capybara.save_path`
701 702 703 |
# File 'lib/capybara/session.rb', line 701 def save_and_open_page(path = nil) save_page(path).tap { |s_path| open_file(s_path) } end |
#save_and_open_screenshot(path = nil, **options) ⇒ Object
Save a screenshot of the page and open it for inspection.
If invoked without arguments it will save file to ‘Capybara.save_path`
and file will be given randomly generated filename. If invoked with a relative path
the path will be relative to `Capybara.save_path`
731 732 733 734 735 |
# File 'lib/capybara/session.rb', line 731 def save_and_open_screenshot(path = nil, **) # rubocop:disable Lint/Debugger save_screenshot(path, ).tap { |s_path| open_file(s_path) } # rubocop:enable Lint/Debugger end |
#save_page(path = nil) ⇒ String
Save a snapshot of the page. If ‘Capybara.asset_host` is set it will inject `base` tag
pointing to `asset_host`.
If invoked without arguments it will save file to ‘Capybara.save_path`
and file will be given randomly generated filename. If invoked with a relative path
the path will be relative to `Capybara.save_path`
685 686 687 688 689 |
# File 'lib/capybara/session.rb', line 685 def save_page(path = nil) prepare_path(path, 'html').tap do |p_path| File.write(p_path, Capybara::Helpers.inject_asset_host(body, host: config.asset_host), mode: 'wb') end end |
#save_screenshot(path = nil, **options) ⇒ String
Save a screenshot of page.
If invoked without arguments it will save file to ‘Capybara.save_path`
and file will be given randomly generated filename. If invoked with a relative path
the path will be relative to `Capybara.save_path`
716 717 718 |
# File 'lib/capybara/session.rb', line 716 def save_screenshot(path = nil, **) prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, ) } end |
#status_code ⇒ Integer
Returns the current HTTP status code as an Integer. Not supported by all drivers (e.g. Selenium)
185 186 187 |
# File 'lib/capybara/session.rb', line 185 def status_code driver.status_code end |
#switch_to_frame(element) ⇒ Object #switch_to_frame(: parent) ⇒ Object #switch_to_frame(: top) ⇒ Object
Switch to the given frame
If you use this method you are responsible for making sure you switch back to the parent frame when done in the frame changed to. Capybara::Session#within_frame is preferred over this method and should be used when possible. May not be supported by all drivers.
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 |
# File 'lib/capybara/session.rb', line 386 def switch_to_frame(frame) case frame when Capybara::Node::Element driver.switch_to_frame(frame) scopes.push(:frame) when :parent if scopes.last != :frame raise Capybara::ScopeError, "`switch_to_frame(:parent)` cannot be called from inside a descendant frame's "\ '`within` block.' end scopes.pop driver.switch_to_frame(:parent) when :top idx = scopes.index(:frame) if idx if scopes.slice(idx..-1).any? { |scope| ![:frame, nil].include?(scope) } raise Capybara::ScopeError, "`switch_to_frame(:top)` cannot be called from inside a descendant frame's "\ '`within` block.' end scopes.slice!(idx..-1) driver.switch_to_frame(:top) end else raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame' end end |
#switch_to_window(&block) ⇒ Capybara::Window #switch_to_window(window) ⇒ Capybara::Window
Returns window that has been switched to.
483 484 485 486 487 488 489 490 491 492 493 |
# File 'lib/capybara/session.rb', line 483 def switch_to_window(window = nil, **, &window_locator) raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && block_given? raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !block_given? unless scopes.last.nil? raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from '\ '`within` or `within_frame` blocks.' end _switch_to_window(window, , &window_locator) end |
#using_wait_time(seconds) ⇒ Object
Yield a block using a specific wait time
767 768 769 770 771 772 773 774 775 776 777 778 779 |
# File 'lib/capybara/session.rb', line 767 def using_wait_time(seconds) if Capybara.threadsafe begin previous_wait_time = config.default_max_wait_time config.default_max_wait_time = seconds yield ensure config.default_max_wait_time = previous_wait_time end else Capybara.using_wait_time(seconds) { yield } end end |
#visit(visit_uri) ⇒ Object
Navigate to the given URL. The URL can either be a relative URL or an absolute URL The behaviour of either depends on the driver.
session.visit('/foo')
session.visit('http://google.com')
For drivers which can run against an external application, such as the selenium driver giving an absolute URL will navigate to that page. This allows testing applications running on remote servers. For these drivers, setting Capybara.app_host will make the remote server the default. For example:
Capybara.app_host = 'http://google.com'
session.visit('/') # visits the google homepage
If Capybara.always_include_port is set to true and this session is running against a rack application, then the port that the rack application is running on will automatically be inserted into the URL. Supposing the app is running on port ‘4567`, doing something like:
visit("http://google.com/test")
Will actually navigate to ‘google.com:4567/test`.
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/capybara/session.rb', line 257 def visit(visit_uri) raise_server_error! @touched = true visit_uri = ::Addressable::URI.parse(visit_uri.to_s) base_uri = ::Addressable::URI.parse(config.app_host || server_url) if base_uri && [nil, 'http', 'https'].include?(visit_uri.scheme) if visit_uri.relative? visit_uri_parts = visit_uri.to_hash.delete_if { |_k, value| value.nil? } # Useful to people deploying to a subdirectory # and/or single page apps where only the url fragment changes visit_uri_parts[:path] = base_uri.path + visit_uri.path visit_uri = base_uri.merge(visit_uri_parts) end adjust_server_port(visit_uri) end driver.visit(visit_uri.to_s) end |
#window_opened_by(**options, &block) ⇒ Capybara::Window
Get the window that has been opened by the passed block. It will wait for it to be opened (in the same way as other Capybara methods wait). It’s better to use this method than ‘windows.last` as order of windows isn’t defined in some drivers
552 553 554 555 556 557 558 559 560 561 562 563 564 |
# File 'lib/capybara/session.rb', line 552 def window_opened_by(**) old_handles = driver.window_handles yield synchronize_windows() do opened_handles = (driver.window_handles - old_handles) if opened_handles.size != 1 raise Capybara::WindowError, 'block passed to #window_opened_by '\ "opened #{opened_handles.size} windows instead of 1" end Window.new(self, opened_handles.first) end end |
#windows ⇒ Array<Capybara::Window>
Get all opened windows. The order of windows in returned array is not defined. The driver may sort windows by their creation time but it’s not required.
448 449 450 451 452 |
# File 'lib/capybara/session.rb', line 448 def windows driver.window_handles.map do |handle| Window.new(self, handle) end end |
#within(*find_args) ⇒ Object #within(a_node) ⇒ Object Also known as: within_element
Executes the given block within the context of a node. ‘within` takes the same options as `find`, as well as a block. For the duration of the block, any command to Capybara will be handled as though it were scoped to the given element.
within(:xpath, './/div[@id="delivery-address"]') do
fill_in('Street', with: '12 Main Street')
end
Just as with ‘find`, if multiple elements match the selector given to `within`, an error will be raised, and just as with `find`, this behaviour can be controlled through the `:match` and `:exact` options.
It is possible to omit the first parameter, in that case, the selector is assumed to be of the type set in Capybara.default_selector.
within('div#delivery-address') do
fill_in('Street', with: '12 Main Street')
end
Note that a lot of uses of ‘within` can be replaced more succinctly with chaining:
find('div#delivery-address').fill_in('Street', with: '12 Main Street')
340 341 342 343 344 345 346 347 348 |
# File 'lib/capybara/session.rb', line 340 def within(*args) new_scope = args.first.respond_to?(:to_capybara_node) ? args.first. : find(*args) begin scopes.push(new_scope) yield if block_given? ensure scopes.pop end end |
#within_fieldset(locator) ⇒ Object
Execute the given block within the a specific fieldset given the id or legend of that fieldset.
357 358 359 |
# File 'lib/capybara/session.rb', line 357 def within_fieldset(locator) within(:fieldset, locator) { yield } end |
#within_frame(element) ⇒ Object #within_frame([kind = :frame], locator, **options) ⇒ Object #within_frame(index) ⇒ Object
Execute the given block within the given iframe using given frame, frame name/id or index. May not be supported by all drivers.
425 426 427 428 429 430 431 432 |
# File 'lib/capybara/session.rb', line 425 def within_frame(*args) switch_to_frame(_find_frame(*args)) begin yield if block_given? ensure switch_to_frame(:parent) end end |
#within_table(locator) ⇒ Object
Execute the given block within the a specific table given the id or caption of that table.
367 368 369 |
# File 'lib/capybara/session.rb', line 367 def within_table(locator) within(:table, locator) { yield } end |
#within_window(window) ⇒ Object #within_window(proc_or_lambda) ⇒ Object
This method does the following:
-
Switches to the given window (it can be located by window instance/lambda/string).
-
Executes the given block (within window located at previous step).
-
Switches back (this step will be invoked even if exception will happen at second step)
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 |
# File 'lib/capybara/session.rb', line 516 def within_window(window_or_proc) original = current_window scopes << nil begin case window_or_proc when Capybara::Window _switch_to_window(window_or_proc) unless original == window_or_proc when Proc _switch_to_window { window_or_proc.call } else raise ArgumentError('`#within_window` requires a `Capybara::Window` instance or a lambda') end begin yield if block_given? ensure _switch_to_window(original) unless original == window_or_proc end ensure scopes.pop end end |