Module: ActionController::Assertions

Included in:
Integration::Session, Test::Unit::TestCase
Defined in:
lib/action_controller/assertions.rb,
lib/action_controller/assertions/dom_assertions.rb,
lib/action_controller/assertions/tag_assertions.rb,
lib/action_controller/assertions/model_assertions.rb,
lib/action_controller/assertions/routing_assertions.rb,
lib/action_controller/assertions/response_assertions.rb,
lib/action_controller/assertions/selector_assertions.rb

Overview

In addition to these specific assertions, you also have easy access to various collections that the regular test/unit assertions can be used against. These collections are:

  • assigns: Instance variables assigned in the action that are available for the view.

  • session: Objects being saved in the session.

  • flash: The flash objects currently in the session.

  • cookies: Cookies being sent to the user on this request.

These collections can be used just like any other hash:

assert_not_nil assigns(:person) # makes sure that a @person instance variable was set
assert_equal "Dave", cookies[:name] # makes sure that a cookie called :name was set as "Dave"
assert flash.empty? # makes sure that there's nothing in the flash

For historic reasons, the assigns hash uses string-based keys. So assigns won’t work, but assigns will. To appease our yearning for symbols, though, an alternative accessor has been devised using a method call instead of index referencing. So assigns(:person) will work just like assigns, but again, assigns will not work.

On top of the collections, you have the complete url that a given action redirected to available in redirect_to_url.

For redirects within the same controller, you can even call follow_redirect and the redirect will be followed, triggering another action call which can then be asserted against.

Manipulating the request collections

The collections described above link to the response, so you can test if what the actions were expected to do happened. But sometimes you also want to manipulate these collections in the incoming request. This is really only relevant for sessions and cookies, though. For sessions, you just do:

@request.session[:key] = "value"

For cookies, you need to manually create the cookie, like this:

@request.cookies["key"] = CGI::Cookie.new("key", "value")

Testing named routes

If you’re using named routes, they can be easily tested using the original named routes’ methods straight in the test case. Example:

assert_redirected_to page_url(:title => 'foo')

Defined Under Namespace

Modules: DomAssertions, ModelAssertions, ResponseAssertions, RoutingAssertions, SelectorAssertions, TagAssertions

Constant Summary collapse

NO_STRIP = 
%w{pre script style textarea}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(klass) ⇒ Object 



46
47
48
49
50
51
 
# File 'lib/action_controller/assertions.rb', line 46

def self.included(klass)
  %w(response selector tag dom routing model).each do |kind|
    require "action_controller/assertions/#{kind}_assertions"
    klass.module_eval { include const_get("#{kind.camelize}Assertions") }
  end
end

Instance Method Details

#clean_backtrace(&block) ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/action_controller/assertions.rb', line 53

def clean_backtrace(&block)
  yield
rescue Test::Unit::AssertionFailedError => error
  framework_path = Regexp.new(File.expand_path("#{File.dirname(__FILE__)}/assertions"))
  error.backtrace.reject! { |line| File.expand_path(line) =~ framework_path }
  raise
end