Method: Capybara::SessionMatchers#assert_current_path

Defined in:
lib/capybara/session/matchers.rb

#assert_current_path(string, **options) ⇒ true #assert_current_path(regexp, **options) ⇒ true

Asserts that the page has the given path. By default, if passed a full url this will compare against the full url, if passed a path only the path+query portion will be compared, if passed a regexp the comparison will depend on the :url option (path+query by default)

Overloads:

  • #assert_current_path(string, **options) ⇒ true

    Parameters:

    • string (String) —

      The string that the current 'path' should equal

  • #assert_current_path(regexp, **options) ⇒ true

    Parameters:

    • regexp (Regexp) —

      The regexp that the current 'path' should match to

Parameters:

  • options (Hash) —

    a customizable set of options

Options Hash (**options):

  • :url (Boolean) — default: true if `string` is a full url, otherwise false —

    Whether the comparison should be done against the full current url or just the path

  • :ignore_query (Boolean) — default: false —

    Whether the query portion of the current url/path should be ignored

  • :wait (Numeric) — default: Capybara.default_max_wait_time —

    Maximum time that Capybara will wait for the current url/path to eq/match given string/regexp argument

Returns:

  • (true)

Raises:



22
23
24
25
26
 
# File 'lib/capybara/session/matchers.rb', line 22

def assert_current_path(path, **options, &optional_filter_block)
  _verify_current_path(path, optional_filter_block, **options) do |query|
    raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
  end
end