How to test instance variable was instantiated in controller with RSpec

Question

I'm trying to check that a new action in my RESTful controller set up an instance variable of the required Object type. Seems pretty typical, but having trouble executing it

Client Controller

def new
  @client = Client.new
end

Test

describe "GET 'new'" do
  it "should be successful" do
    get 'new'
    response.should be_success
  end

  it "should create a new client" do
    get 'new'
    assigns(:client).should == Client.new
  end
end

Results in...

'ClientsController GET 'new' should create a new client' FAILED
  expected: #,
       got: # (using ==)

Which is probably because it's trying to compare 2 instances of active record, which differ. So, how do I check that the controller set up an instance variable that holds a new instance of the Client model.

fakingfantastic · Accepted Answer · 2010-01-12 18:58:56Z

37

technicalpickles in #rspec helped me out...

assigns(:client).should be_kind_of(Client)

answered Jan 12, 2010 at 18:58

fakingfantastic

1,5511 gold badge12 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Luccas Over a year ago

How about if Im working with a REST and I don't use "@" in the controllers? Is there a workaround? Thanks

heyitsjhu Over a year ago

For rails 5, use expect(assigns(:client).to be_a(Client)

Huzaifa Saifuddin Over a year ago

What to do for something like @roles = UserRole.all

jawspeak · Accepted Answer · 2011-05-22 11:35:44Z

16

You can use Rails' new_record? method to check if a given instance has been saved to the database already or not:

assigns(:client).should be_a(Client)
assigns(:client).should be_new_record

(You can't use assigns[:client] for historical reasons, according to: http://guides.rubyonrails.org/testing.html#the-four-hashes-of-the-apocalypse)

edited May 22, 2011 at 11:35

jawspeak

9859 silver badges18 bronze badges

answered Jan 11, 2011 at 16:38

Attila Györffy

7597 silver badges13 bronze badges

1 Comment

Epigene Over a year ago

The link to "four-hashes-of-the-apocalypse" explains everything a Rails dev needs to know about the environment views receive from controllers!

Community · Accepted Answer · 2017-05-23 12:34:23Z

15

For that 2016 RSpec v3 syntax use:

expect(assigns(:client)).to be_a(Client)

Also, for others that may stop here because of the question title, here is how to test if an instance variable @client was set to anything

# in controller action
@client = Client.find_by(name: "John")

# spec assignment based on collection membership

expect(assigns.keys).to include('client')

See @Attila Györffy's answer about why the assigns hash must be accessed with string keys.

edited May 23, 2017 at 12:34

CommunityBot

11 silver badge

answered Apr 20, 2016 at 11:26

Epigene

3,9541 gold badge32 silver badges35 bronze badges

Collectives™ on Stack Overflow

How to test instance variable was instantiated in controller with RSpec

3 Answers 3

3 Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related