Rspec: Stub method that is in the controller
May I know how to stub method that is in the controller create method? I need to write the spec for this but I got these errors. I need to check the create method in controller must execute validate_fbid method before create a new company record in model.
Error:
1) Companies new company create with valid information#validate_fbid should have correct parameters and return value
Failure/Error: CompaniesController.create.should_receive(:validates_fbid).with(company)
NoMethodError:
undefined method `create' for CompaniesController:Class
# ./spec/requests/companies_spec.rb:38:in `block (5 levels) in <top (required)>'
2) Companies new company create with valid information#validate_fbid should fbid validation passed
Failure/Error: CompaniesController.create.stub(:validates_fbid).and_return('companyid')
NoMethodError:
undefined method `create' for CompaniesController:Class
# ./spec/requests/companies_spec.rb:43:in `block (5 levels) in <top (required)>'
CompaniesController
def create
company = Company.new(params[:company])
verifyfbid = validate_fbid(company)
if verifyfbid != false
if company.fbid.downcase == verifyfbid.downcase
if company.save
@message = "New company created."
redirect_to root_path
else
@message = "Company create attempt failed. Please try again."
render 'new'
end
else
@message = "Company create attempt failed. Invalid facebook id."
render 'new'
end
else
@message = "Company create attempt failed. No such facebook id."
render 'new'
end
end
private
def validate_fbid(company)
uri = URI("http://graph.facebook.com/" + company.fbid)
data = Net::HTTP.get(uri)
username = JSON.parse(data)['username']
if username.nil?
return false
else
"#{username}"
end
end
Requests/companies_spec.rb
context "#validate_fbid" do
#validate fbid
let(:company){ Company.new(name:'Example Company', url: 'www.company.com', fbid: 'companyid', desc: 'Company desc' )}
it "should have correct parameters and return value" do
CompaniesController.create.should_receive(:validates_fbid).with(company)
.and_return('companyid')
end
it "should fbid validation passed" do
CompaniesController.create.stub(:validates_fbid).and_return('companyid')
company.fbid.should_not be_nil
company.fbid.should == 'companyid'
company.save
expect { click_button submit }.to change(Company, :count).by(1)
end
end
You don't want to stub the method, when it is the subject of your test case
context "#validate_fbid" do
#test the function here
#don't stub
end
when you test the create action in the controller, you can stub "validate_fbid"
describe "post create" do
...
CompaniesController.any_instance.stub(:validates_fbid).and_return('companyid')
...
end
Hope it helps.
If you are testing controller, you can access controller directly:
controller.stub(:message) { 'this is the value to return' }
When code is hard to test, it is usually because it is complex.
You should refactor this code this way:
- move the verification logic into new 'service class' which has a single responsibility of company verification on facebook
- this will make verification functionality independent of web layer and much easier to test
- make spec for service class which will test this code in isolation (no controllers)
- cleanup the controller of logic - you don't want to have logic inside your controllers (rule of thumb: one level of nesting max)
- spec for controller will be easier as well
The controller code can look something like this:
def create
company = Company.new(params[:company])
verified = FbCompanyVerifier.new.verify(company)
if verified and company.save
# success logic
else
# fail logic
end
end
Here's the recommended syntax for Rspec 3 (3.3):
allow_any_instance_of(CompaniesController).to receive(:validates_fbid).and_return("companyid")
or
expect_any_instance_of(CompaniesController).to receive(:validates_fbid).and_return("companyid")
source: https://relishapp.com/rspec/rspec-mocks/docs/working-with-legacy-code/any-instance
You can stub a controller
method:
allow(controller).to receive(...).with(...).and_return(...)