Module: ActionController::Assertions::RoutingAssertions

Defined in:
lib/action_controller/assertions/routing_assertions.rb

Instance Method Summary collapse

Instance Method Details

#assert_generates(expected_path, options, defaults = {}, extras = {}, message = nil) ⇒ Object

Asserts that the provided options can be used to generate the provided path. This is the inverse of assert_recognizes. For example:

assert_generates("/items", :controller => "items", :action => "index")
assert_generates("/items/list", :controller => "items", :action => "list")
assert_generates("/items/list/1", { :controller => "items", :action => "list", :id => "1" })



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/action_controller/assertions/routing_assertions.rb', line 52

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

#assert_recognizes(expected_options, path, extras = {}, message = nil) ⇒ Object

Asserts that the routing of the given path was handled correctly and that the parsed options match.

assert_recognizes({:controller => 'items', :action => 'index'}, 'items') # check the default action
assert_recognizes({:controller => 'items', :action => 'list'}, 'items/list') # check a specific action
assert_recognizes({:controller => 'items', :action => 'list', :id => '1'}, 'items/list/1') # check an action with a parameter

Pass a hash in the second argument to specify the request method. This is useful for routes requiring a specific HTTP method. The hash should contain a :path with the incoming request path and a :method containing the required HTTP verb.

# assert that POSTing to /items will call the create action on ItemsController
assert_recognizes({:controller => 'items', :action => 'create'}, {:path => 'items', :method => :post})

You can also pass in “extras” with a hash containing URL parameters that would normally be in the query string. This can be used to assert that values in the query string string will end up in the params hash correctly. To test query strings you must use the extras argument, appending the query string on the path directly will not work. For example: 

# assert that a path of '/items/list/1?view=print' returns the correct options
assert_recognizes({:controller => 'items', :action => 'list', :id => '1', :view => 'print'}, 'items/list/1', { :view => "print" })



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/action_controller/assertions/routing_assertions.rb', line 23

def assert_recognizes(expected_options, path, extras={}, message=nil)
  if path.is_a? Hash
    request_method = path[:method]
    path           = path[:path]
  else
    request_method = nil
  end

  clean_backtrace do 
    ActionController::Routing::Routes.reload if ActionController::Routing::Routes.empty? 
    request = recognized_request_for(path, request_method)

    expected_options = expected_options.clone
    extras.each_key { |key| expected_options.delete key } unless extras.nil?

    expected_options.stringify_keys!
    routing_diff = expected_options.diff(request.path_parameters)
    msg = build_message(message, "The recognized options <?> did not match <?>, difference: <?>", 
        request.path_parameters, expected_options, expected_options.diff(request.path_parameters))
    assert_block(msg) { request.path_parameters == expected_options }
  end
end

#assert_routing(path, options, defaults = {}, extras = {}, message = nil) ⇒ Object

Asserts that path and options match both ways; in other words, the URL generated from options is the same as path, and also that the options recognized from path are the same as options. This essentially combines assert_recognizes and assert_generates into one step.



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/action_controller/assertions/routing_assertions.rb', line 73

def assert_routing(path, options, defaults={}, extras={}, message=nil)
  assert_recognizes(options, path, extras, message)
  
  controller, default_controller = options[:controller], defaults[:controller] 
  if controller && controller.include?(?/) && default_controller && default_controller.include?(?/)
    options[:controller] = "/#{controller}"
  end
   
  assert_generates(path, options, defaults, extras, message)
end