Module: Spec::Rails::Matchers

Included in:
ActiveSupport::TestCase
Defined in:
lib/spec/rails/matchers.rb,
lib/spec/rails/matchers/have_text.rb,
lib/spec/rails/matchers/ar_be_valid.rb,
lib/spec/rails/matchers/redirect_to.rb,
lib/spec/rails/matchers/include_text.rb,
lib/spec/rails/matchers/assert_select.rb,
lib/spec/rails/matchers/render_template.rb

Overview

Spec::Rails::Expectations::Matchers provides several expectation matchers intended to work with Rails components like models and responses. For example:

response.should redirect_to("some/url") #redirect_to(url) is the matcher.

In addition to those you see below, the arbitrary predicate feature of RSpec makes the following available as well:

response.should be_success #passes if response.success?
response.should be_redirect #passes if response.redirect?

Note that many of these matchers are part of a wrapper of assert_select, so the documentation comes straight from that with some slight modifications. assert_select is a Test::Unit extension originally contributed to the Rails community as a plugin by Assaf Arkin and eventually shipped as part of Rails.

For more info on assert_select, see the relevant Rails documentation.

Defined Under Namespace

Classes: ArBeValid, AssertSelect, HaveText, IncludeText, RedirectTo, RenderTemplate

Instance Method Summary collapse

Instance Method Details

#be_valid ⇒ Object

:call-seq:

response.should be_valid
response.should_not be_valid



38
39
40
 
# File 'lib/spec/rails/matchers/ar_be_valid.rb', line 38

def be_valid
  ArBeValid.new
end

#have_rjs(*args, &block) ⇒ Object

:call-seq:

response.should have_rjs(*args, &block)

wrapper for assert_select_rjs

see documentation for assert_select_rjs at api.rubyonrails.org/



124
125
126
 
# File 'lib/spec/rails/matchers/assert_select.rb', line 124

def have_rjs(*args, &block)
  AssertSelect.new(:assert_select_rjs, self, *args, &block)
end

#have_tag(*args, &block) ⇒ Object

:call-seq:

response.should have_tag(*args, &block)
string.should have_tag(*args, &block)

wrapper for assert_select with additional support for using css selectors to set expectation on Strings. Use this in helper specs, for example, to set expectations on the results of helper methods.

Examples

# in a controller spec
response.should have_tag("div", "some text")

# in a helper spec (person_address_tag is a method in the helper)
person_address_tag.should have_tag("input#person_address")

see documentation for assert_select at api.rubyonrails.org/



92
93
94
 
# File 'lib/spec/rails/matchers/assert_select.rb', line 92

def have_tag(*args, &block)
  @__current_scope_for_assert_select = AssertSelect.new(:assert_select, self, *args, &block)
end

#have_text(text) ⇒ Object

:call-seq:

response.should have_text(expected)
response.should_not have_text(expected)

Accepts a String or a Regexp, matching a String using == and a Regexp using =~.

If response_or_text has a #body, then that is used as to match against else it uses response_or_text

Use this instead of response.should have_tag() when you want to match the whole string or whole body

Examples

response.should have_text("This is the expected text")



51
52
53
 
# File 'lib/spec/rails/matchers/have_text.rb', line 51

def have_text(text)
  HaveText.new(text)
end

#include_text(text) ⇒ Object

:call-seq:

response.should include_text(expected)
response.should_not include_text(expected)

Accepts a String, matching using include?

Use this instead of response.should have_text() when you either don’t know or don’t care where on the page this text appears.

Examples

response.should include_text("This text will be in the actual string")



48
49
50
 
# File 'lib/spec/rails/matchers/include_text.rb', line 48

def include_text(text)
  IncludeText.new(text)
end

#redirect_to(opts) ⇒ Object

:call-seq:

response.should redirect_to(url)
response.should redirect_to(:action => action_name)
response.should redirect_to(:controller => controller_name, :action => action_name)
response.should_not redirect_to(url)
response.should_not redirect_to(:action => action_name)
response.should_not redirect_to(:controller => controller_name, :action => action_name)

Passes if the response is a redirect to the url, action or controller/action. Useful in controller specs (integration or isolation mode).

Examples

response.should redirect_to("path/to/action")
response.should redirect_to("http://test.host/path/to/action")
response.should redirect_to(:action => 'list')



120
121
122
 
# File 'lib/spec/rails/matchers/redirect_to.rb', line 120

def redirect_to(opts)
  RedirectTo.new(request, opts)
end

#render_template(path) ⇒ Object

:call-seq:

response.should render_template(template)
response.should_not render_template(template)

For use in controller code examples (integration or isolation mode).

Passes if the specified template (view file) is rendered by the response. This file can be any view file, including a partial. However if it is a partial it must be rendered directly i.e. you can’t detect that a partial has been rendered as part of a view using render_template. For that you should use a message expectation (mock) instead:

controller.should_receive(:render).with(:partial => 'path/to/partial')

template can include the controller path. It can also include an optional extension, which you only need to use when there is ambiguity.

Note that partials must be spelled with the preceding underscore.

Examples

response.should render_template('list')
response.should render_template('same_controller/list')
response.should render_template('other_controller/list')

# with extensions
response.should render_template('list.rjs')
response.should render_template('list.haml')
response.should render_template('same_controller/list.rjs')
response.should render_template('other_controller/list.rjs')

# partials
response.should render_template('_a_partial')
response.should render_template('same_controller/_a_partial')
response.should render_template('other_controller/_a_partial')



108
109
110
 
# File 'lib/spec/rails/matchers/render_template.rb', line 108

def render_template(path)
  RenderTemplate.new(path.to_s, @controller)
end

#send_email(*args, &block) ⇒ Object

:call-seq:

response.should send_email(*args, &block)

wrapper for assert_select_email

see documentation for assert_select_email at api.rubyonrails.org/



134
135
136
 
# File 'lib/spec/rails/matchers/assert_select.rb', line 134

def send_email(*args, &block)
  AssertSelect.new(:assert_select_email, self, *args, &block)
end

#with_encoded(*args, &block) ⇒ Object

wrapper for assert_select_encoded

see documentation for assert_select_encoded at api.rubyonrails.org/



141
142
143
 
# File 'lib/spec/rails/matchers/assert_select.rb', line 141

def with_encoded(*args, &block)
  should AssertSelect.new(:assert_select_encoded, self, *args, &block)
end

#with_tag(*args, &block) ⇒ Object

wrapper for a nested assert_select

response.should have_tag("div#form") do
  with_tag("input#person_name[name=?]", "person[name]")
end

see documentation for assert_select at api.rubyonrails.org/



103
104
105
 
# File 'lib/spec/rails/matchers/assert_select.rb', line 103

def with_tag(*args, &block)
  @__current_scope_for_assert_select.should have_tag(*args, &block)
end

#without_tag(*args, &block) ⇒ Object

wrapper for a nested assert_select with false

response.should have_tag("div#1") do
  without_tag("span", "some text that shouldn't be there")
end

see documentation for assert_select at api.rubyonrails.org/



114
115
116
 
# File 'lib/spec/rails/matchers/assert_select.rb', line 114

def without_tag(*args, &block)
  @__current_scope_for_assert_select.should_not have_tag(*args, &block)
end