Asserts that the provided options can be used to generate the provided path. This is the inverse of #assert_recognizes. The extras parameter is used to tell the request the names and values of additional request parameters that would be in a query string. The message parameter allows you to specify a custom error message for assertion failures.

The defaults parameter is unused.

Examples

# Asserts that the default action is generated for a route with no action
assert_generates("/items", :controller => "items", :action => "index")

# Tests that the list action is properly routed
assert_generates("/items/list", :controller => "items", :action => "list")

# Tests the generation of a route with a parameter
assert_generates("/items/list/1", { :controller => "items", :action => "list", :id => "1" })

# Asserts that the generated route gives us our custom route
assert_generates "changesets/12", { :controller => 'scm', :action => 'show_diff', :revision => "12" }

Source Code

# File action_controller/assertions/routing_assertions.rb, line 80
def assert_generates(expected_path, options, defaults={}, extras = {}, message=nil)
  clean_backtrace do 
    expected_path = "/#{expected_path}" unless expected_path[0] == ?/
    # Load routes.rb if it hasn't been loaded.
    ActionController::Routing::Routes.reload if ActionController::Routing::Routes.empty? 

    generated_path, extra_keys = ActionController::Routing::Routes.generate_extras(options, defaults)
    found_extras = options.reject {|k, v| ! extra_keys.include? k}

    msg = build_message(message, "found extras <?>, not <?>", found_extras, extras)
    assert_block(msg) { found_extras == extras }

    msg = build_message(message, "The generated path <?> did not match <?>", generated_path, 
        expected_path)
    assert_block(msg) { expected_path == generated_path }
  end
end