Module: ActionController::TemplateAssertions

Extended by:
ActiveSupport::Concern
Included in:
ActionDispatch::IntegrationTest
Defined in:
lib/action_controller/test_case.rb

Constant Summary collapse

RENDER_TEMPLATE_INSTANCE_VARIABLES = 
%w{partials templates layouts files}.freeze

Instance Method Summary collapse

Instance Method Details

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

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

# assert that the "new" view template was rendered
assert_template "new"

# assert that the exact template "admin/posts/new" was rendered
assert_template %r{\Aadmin/posts/new\Z}

# assert that the layout 'admin' was rendered
assert_template layout: 'admin'
assert_template layout: 'layouts/admin'
assert_template layout: :admin

# assert that no layout was rendered
assert_template layout: nil
assert_template layout: false

# assert that the "_customer" partial was rendered twice
assert_template partial: '_customer', count: 2

# assert that no partials were rendered
assert_template partial: false

# assert that a file was rendered
assert_template file: "README.rdoc"

# assert that no file was rendered
assert_template file: nil
assert_template file: false

In a view test case, you can also assert that specific locals are passed to partials:

# assert that the "_customer" partial was rendered with a specific object
assert_template partial: '_customer', locals: { customer: @customer }



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/action_controller/test_case.rb', line 114

def assert_template(options = {}, message = nil)
  # Force body to be read in case the template is being streamed.
  response.body

  case options
  when NilClass, Regexp, String, Symbol
    options = options.to_s if Symbol === options
    rendered = @_templates
    msg = message || sprintf("expecting <%s> but rendering with <%s>",
            options.inspect, rendered.keys)
    matches_template =
      case options
      when String
        !options.empty? && rendered.any? do |t, num|
          options_splited = options.split(File::SEPARATOR)
          t_splited = t.split(File::SEPARATOR)
          t_splited.last(options_splited.size) == options_splited
        end
      when Regexp
        rendered.any? { |t,num| t.match(options) }
      when NilClass
        rendered.blank?
      end
    assert matches_template, msg
  when Hash
    options.assert_valid_keys(:layout, :partial, :locals, :count, :file)

    if options.key?(:layout)
      expected_layout = options[:layout]
      msg = message || sprintf("expecting layout <%s> but action rendered <%s>",
              expected_layout, @_layouts.keys)

      case expected_layout
      when String, Symbol
        assert_includes @_layouts.keys, expected_layout.to_s, msg
      when Regexp
        assert(@_layouts.keys.any? {|l| l =~ expected_layout }, msg)
      when nil, false
        assert(@_layouts.empty?, msg)
      end
    end

    if options[:file]
      assert_includes @_files.keys, options[:file]
    elsif options.key?(:file)
      assert @_files.blank?, "expected no files but #{@_files.keys} was rendered"
    end

    if expected_partial = options[:partial]
      if expected_locals = options[:locals]
        if defined?(@_rendered_views)
          view = expected_partial.to_s.sub(/^_/, '').sub(/\/_(?=[^\/]+\z)/, '/')

          partial_was_not_rendered_msg = "expected %s to be rendered but it was not." % view
          assert_includes @_rendered_views.rendered_views, view, partial_was_not_rendered_msg

          msg = 'expecting %s to be rendered with %s but was with %s' % [expected_partial,
                                                                         expected_locals,
                                                                         @_rendered_views.locals_for(view)]
          assert(@_rendered_views.view_rendered?(view, options[:locals]), msg)
        else
          warn "the :locals option to #assert_template is only supported in a ActionView::TestCase"
        end
      elsif expected_count = options[:count]
        actual_count = @_partials[expected_partial]
        msg = message || sprintf("expecting %s to be rendered %s time(s) but rendered %s time(s)",
                 expected_partial, expected_count, actual_count)
        assert(actual_count == expected_count.to_i, msg)
      else
        msg = message || sprintf("expecting partial <%s> but action rendered <%s>",
                options[:partial], @_partials.keys)
        assert_includes @_partials, expected_partial, msg
      end
    elsif options.key?(:partial)
      assert @_partials.empty?,
        "Expected no partials to be rendered"
    end
  else
    raise ArgumentError, "assert_template only accepts a String, Symbol, Hash, Regexp, or nil"
  end
end

#process(*args) ⇒ Object 



65
66
67
68
 
# File 'lib/action_controller/test_case.rb', line 65

def process(*args)
  reset_template_assertion
  super
end

#reset_template_assertion ⇒ Object 



70
71
72
73
74
75
76
77
 
# File 'lib/action_controller/test_case.rb', line 70

def reset_template_assertion
  RENDER_TEMPLATE_INSTANCE_VARIABLES.each do |instance_variable|
    ivar_name = "@_#{instance_variable}"
    if instance_variable_defined?(ivar_name)
      instance_variable_get(ivar_name).clear
    end
  end
end

#setup_subscriptions ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/action_controller/test_case.rb', line 20

def setup_subscriptions
  RENDER_TEMPLATE_INSTANCE_VARIABLES.each do |instance_variable|
    instance_variable_set("@_#{instance_variable}", Hash.new(0))
  end

  @_subscribers = []

  @_subscribers << ActiveSupport::Notifications.subscribe("render_template.action_view") do |_name, _start, _finish, _id, payload|
    path = payload[:layout]
    if path
      @_layouts[path] += 1
      if path =~ /^layouts\/(.*)/
        @_layouts[$1] += 1
      end
    end
  end

  @_subscribers << ActiveSupport::Notifications.subscribe("!render_template.action_view") do |_name, _start, _finish, _id, payload|
    if virtual_path = payload[:virtual_path]
      partial = virtual_path =~ /^.*\/_[^\/]*$/

      if partial
        @_partials[virtual_path] += 1
        @_partials[virtual_path.split("/").last] += 1
      end

      @_templates[virtual_path] += 1
    else
      path = payload[:identifier]
      if path
        @_files[path] += 1
        @_files[path.split("/").last] += 1
      end
    end
  end
end

#teardown_subscriptions ⇒ Object 



57
58
59
60
61
62
63
 
# File 'lib/action_controller/test_case.rb', line 57

def teardown_subscriptions
  return unless defined?(@_subscribers)

  @_subscribers.each do |subscriber|
    ActiveSupport::Notifications.unsubscribe(subscriber)
  end
end