Module: RSpec::Rails::Matchers::RoutingMatchers

Relationships & Source Files
Namespace Children
Modules: `RouteHelpers`
Classes: `BeRoutableMatcher`, `RouteToMatcher`
Extension / Inclusion / Inheritance Descendants
Included In: `::RSpec::Rails::ControllerExampleGroup`, `::RSpec::Rails::RoutingExampleGroup`
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::RSpec::Matchers::DSL`
Defined in:	rspec-rails/lib/rspec/rails/matchers/routing_matchers.rb

Overview

::RSpec::Rails::Matchers to help with specs for routing code.

Class Method Summary

`::RSpec::Matchers::DSL` - Extended

alias_matcher	Defines a matcher alias.
define	Defines a custom matcher.
define_negated_matcher	Defines a negated matcher.
matcher	Alias for Matchers::DSL#define.
warn_about_block_args	:nocov:

Instance Method Summary

#be_routable

Passes if the route expression is recognized by the ::RSpec::Rails router based on the declarations in config/routes.rb.
#route_to(*expected)

Delegates to assert_recognizes.

Instance Method Details

#be_routable

Passes if the route expression is recognized by the ::RSpec::Rails router based on the declarations in config/routes.rb. Delegates to RouteSet#recognize_path.

Examples:

You can use route helpers provided by rspec-rails.

expect(get:  "/a/path").to be_routable
expect(post: "/another/path").to be_routable
expect(put:  "/yet/another/path").to be_routable

[ GitHub ]

# File 'rspec-rails/lib/rspec/rails/matchers/routing_matchers.rb', line 101


def be_routable
  BeRoutableMatcher.new(self)
end

#route_to(*expected)

Delegates to assert_recognizes. Supports short-hand controller/action declarations (e.g. “controller#action”).