Module: Rails::Controller::Testing::TemplateAssertions
- Extended by:
- ActiveSupport::Concern
- Defined in:
- lib/rails/controller/testing/template_assertions.rb
Constant Summary collapse
- RENDER_TEMPLATE_INSTANCE_VARIABLES =
%w{partials templates layouts files}.freeze
Instance Method Summary collapse
-
#assert_template(options = {}, message = nil) ⇒ Object
Asserts that the request was rendered with the appropriate template file or partials.
- #process(*args) ⇒ Object
- #reset_template_assertion ⇒ Object
- #setup_subscriptions ⇒ Object
- #teardown_subscriptions ⇒ Object
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 }
108 109 110 111 112 113 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 |
# File 'lib/rails/controller/testing/template_assertions.rb', line 108 def assert_template( = {}, = nil) # Force body to be read in case the template is being streamed. response.body case when NilClass, Regexp, String, Symbol = .to_s if Symbol === rendered = @_templates msg = || sprintf("expecting <%s> but rendering with <%s>", .inspect, rendered.keys) matches_template = case when String !.empty? && rendered.any? do |t, num| = .split(File::SEPARATOR) t_splited = t.split(File::SEPARATOR) t_splited.last(.size) == end when Regexp rendered.any? { |t,num| t.match() } when NilClass rendered.blank? end assert matches_template, msg when Hash .assert_valid_keys(:layout, :partial, :locals, :count, :file) if .key?(:layout) expected_layout = [:layout] msg = || 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) else raise ArgumentError, "assert_template only accepts a String, Symbol, Regexp, nil or false for :layout" end end if [:file] assert_includes @_files.keys, [:file] elsif .key?(:file) assert @_files.blank?, "expected no files but #{@_files.keys} was rendered" end if expected_partial = [:partial] if expected_locals = [: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, [:locals]), msg) else warn "the :locals option to #assert_template is only supported in a ActionView::TestCase" end elsif expected_count = [:count] actual_count = @_partials[expected_partial] msg = || 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 = || sprintf("expecting partial <%s> but action rendered <%s>", [:partial], @_partials.keys) assert_includes @_partials, expected_partial, msg end elsif .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
59 60 61 62 |
# File 'lib/rails/controller/testing/template_assertions.rb', line 59 def process(*args) reset_template_assertion super end |
#reset_template_assertion ⇒ Object
64 65 66 67 68 69 70 71 |
# File 'lib/rails/controller/testing/template_assertions.rb', line 64 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
16 17 18 19 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 |
# File 'lib/rails/controller/testing/template_assertions.rb', line 16 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
53 54 55 56 57 |
# File 'lib/rails/controller/testing/template_assertions.rb', line 53 def teardown_subscriptions @_subscribers.each do |subscriber| ActiveSupport::Notifications.unsubscribe(subscriber) end end |