method

assert_template

Ruby on Rails latest stable (v7.1.3.2) - 2 notes - Class: ActionController::Assertions::ResponseAssertions

1.0.0
1.1.6
1.2.6 (0)
2.0.3 (8)
2.1.0 (0)
2.2.1 (0)
2.3.8 (24)
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2
7.1.3.4
What's this?

Method deprecated or moved

This method is deprecated or moved on the latest stable version. The last existing version (v2.3.8) is shown here.

These similar methods exist in v7.1.3.2:

ActionController::TemplateAssertions#assert_template

assert_template(options = {}, message = nil) public

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

Examples

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

  # assert that the "new" view template was rendered with Symbol
  assert_template :new

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

  # assert that no partials were rendered
  assert_template :partial => false

Show source

# File actionpack/lib/action_controller/assertions/response_assertions.rb, line 99
      def assert_template(options = {}, message = nil)
        clean_backtrace do
          case options
           when NilClass, String, Symbol
            rendered = @response.rendered[:template].to_s
            msg = build_message(message,
                    "expecting <?> but rendering with <?>",
                    options, rendered)
            assert_block(msg) do
              if options.nil?
                @response.rendered[:template].blank?
              else
                rendered.to_s.match(options.to_s)
              end
            end
          when Hash
            if expected_partial = options[:partial]
              partials = @response.rendered[:partials]
              if expected_count = options[:count]
                found = partials.detect { |p, _| p.to_s.match(expected_partial) }
                actual_count = found.nil? ? 0 : found.second
                msg = build_message(message,
                        "expecting ? to be rendered ? time(s) but rendered ? time(s)",
                         expected_partial, expected_count, actual_count)
                assert(actual_count == expected_count.to_i, msg)
              else
                msg = build_message(message,
                        "expecting partial <?> but action rendered <?>",
                        options[:partial], partials.keys)
                assert(partials.keys.any? { |p| p.to_s.match(expected_partial) }, msg)
              end
            else
              assert @response.rendered[:partials].empty?,
                "Expected no partials to be rendered"
            end
          else
            raise ArgumentError  
          end
        end
      end

February 1, 2009 - (v2.2.1)

3 thanks

You can't use Symbols, but you can use Regexps

You can’t use Symbol (although Symbol is accepted with render :action => :new), like:

assert_template :new # WON'T WORK!

But you can use Regexp, e.g.:

assert_template /new/ # WORKS OK

Note that the String matched with your Regexp is the full path to the template relative to the view/ directory of your app, so this will not work:

assert_template /^new$/ # WON'T WORK!

However this might:

assert_template /^employees\/new.html.haml$/

November 4, 2009

1 thank

As of v2.3.4 you can use Symbols

This commit fixes using a Symbol with assert_template

http://github.com/rails/rails/commit/f383a4aa333cd8a99003eb1bdbb27b6fdea1056c

assert_template :new # works in 2.3.4

assert_template

Related methods

Method deprecated or moved

Examples

You can't use Symbols, but you can use Regexps

As of v2.3.4 you can use Symbols