Module: ActionController::Assertions::ResponseAssertions

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

Instance Method Summary collapse

Instance Method Details

#assert_redirected_to(options = {}, message = nil) ⇒ Object

Assert that the redirection options passed in match those of the redirect called in the latest action. This match can be partial, such that assert_redirected_to(:controller => “weblog”) will also match the redirection of redirect_to(:controller => “weblog”, :action => “show”) and so on.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/action_controller/assertions/response_assertions.rb', line 34

def assert_redirected_to(options = {}, message=nil)
  clean_backtrace do
    assert_response(:redirect, message)
    return true if options == @response.redirected_to
    ActionController::Routing::Routes.reload if ActionController::Routing::Routes.empty?

    begin
      url  = {}
      original = { :expected => options, :actual => @response.redirected_to.is_a?(Symbol) ? @response.redirected_to : @response.redirected_to.dup }
      original.each do |key, value|
        if value.is_a?(Symbol)
          value = @controller.respond_to?(value, true) ? @controller.send(value) : @controller.send("hash_for_#{value}_url")
        end

        unless value.is_a?(Hash)
          request = case value
            when NilClass    then nil
            when /^\w+:\/\// then recognized_request_for(%r{^(\w+://.*?(/|$|\?))(.*)$} =~ value ? $3 : nil)
            else                  recognized_request_for(value)
          end
          value = request.path_parameters if request
        end

        if value.is_a?(Hash) # stringify 2 levels of hash keys
          if name = value.delete(:use_route)
            route = ActionController::Routing::Routes.named_routes[name]
            value.update(route.parameter_shell)
          end

          value.stringify_keys!
          value.values.select { |v| v.is_a?(Hash) }.collect { |v| v.stringify_keys! }
          if key == :expected && value['controller'] == @controller.controller_name && original[:actual].is_a?(Hash)
            original[:actual].stringify_keys!
            value.delete('controller') if original[:actual]['controller'].nil? || original[:actual]['controller'] == value['controller']
          end
        end

        if value.respond_to?(:[]) && value['controller']
          if key == :actual && value['controller'].first != '/' && !value['controller'].include?('/')
            new_controller_path = ActionController::Routing.controller_relative_to(value['controller'], @controller.class.controller_path)
            value['controller'] = new_controller_path if value['controller'] != new_controller_path && ActionController::Routing.possible_controllers.include?(new_controller_path)
          end
          value['controller'] = value['controller'][1..-1] if value['controller'].first == '/' # strip leading hash
        end
        url[key] = value
      end


      @response_diff = url[:expected].diff(url[:actual]) if url[:actual]
      msg = build_message(message, "response is not a redirection to all of the options supplied (redirection is <?>), difference: <?>",
                          url[:actual], @response_diff)

      assert_block(msg) do
        url[:expected].keys.all? do |k|
          if k == :controller then url[:expected][k] == ActionController::Routing.controller_relative_to(url[:actual][k], @controller.class.controller_path)
          else parameterize(url[:expected][k]) == parameterize(url[:actual][k])
          end
        end
      end
    rescue ActionController::RoutingError # routing failed us, so match the strings only.
      msg = build_message(message, "expected a redirect to <?>, found one to <?>", options, @response.redirect_url)
      url_regexp = %r{^(\w+://.*?(/|$|\?))(.*)$}
      eurl, epath, url, path = [options, @response.redirect_url].collect do |url|
        u, p = (url_regexp =~ url) ? [$1, $3] : [nil, url]
        [u, (p.first == '/') ? p : '/' + p]
      end.flatten

      assert_equal(eurl, url, msg) if eurl && url
      assert_equal(epath, path, msg) if epath && path
    end
  end
end

#assert_response(type, message = nil) ⇒ Object

Asserts that the response is one of the following types:

  • :success: Status code was 200

  • :redirect: Status code was in the 300-399 range

  • :missing: Status code was 404

  • :error: Status code was in the 500-599 range

You can also pass an explicit status number like assert_response(501) or its symbolic equivalent assert_response(:not_implemented). See ActionController::StatusCodes for a full list.



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/action_controller/assertions/response_assertions.rb', line 17

def assert_response(type, message = nil)
  clean_backtrace do
    if [ :success, :missing, :redirect, :error ].include?(type) && @response.send("#{type}?")
      assert_block("") { true } # to count the assertion
    elsif type.is_a?(Fixnum) && @response.response_code == type
      assert_block("") { true } # to count the assertion
    elsif type.is_a?(Symbol) && @response.response_code == ActionController::StatusCodes::SYMBOL_TO_STATUS_CODE[type]
      assert_block("") { true } # to count the assertion
    else
      assert_block(build_message(message, "Expected response to be a <?>, but was <?>", type, @response.response_code)) { false }
    end
  end
end

#assert_template(expected = nil, message = nil) ⇒ Object

Asserts that the request was rendered with the appropriate template file.



108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/action_controller/assertions/response_assertions.rb', line 108

def assert_template(expected = nil, message=nil)
  clean_backtrace do
    rendered = expected ? @response.rendered_file(!expected.include?('/')) : @response.rendered_file
    msg = build_message(message, "expecting <?> but rendering with <?>", expected, rendered)
    assert_block(msg) do
      if expected.nil?
        !@response.rendered_with_file?
      else
        expected == rendered
      end
    end
  end
end