Installation

Add the following to your Gemfile, under the test group

gem 'rspec_controller_helpers', require: false

And add the following in the top of your spec_helper.rb:

require 'rspec_controller_helpers'

Usage

Resourceful Controller

Pre-requisite: You must have a factory set up with the right attributes

This shared example can be used to test the default resourceful rails endpoints.

it_behaves_like 'a resourceful controller', User

By default, it will test all of the following:

You can disable endpoint tests the same way you would in routes.rb:

# Tests new, create, show, edit, update, and delete
it_behaves_like 'a resourceful controller', User, except: [:index]
# Tests new, create
it_behaves_like 'a resourceful controller', User, only: [:new, :create]

This shared example will also infer your factory name from your model, so if your model is User, it will try create(:user). You can override that with the factory option

it_behaves_like 'a resourceful controller', User, factory: :admin

JSON

By default, the shared example assumes html format for all views, but you can override that for each view, to test json endpoints:

it_behaves_like 'a resourceful controller', User, formats: { index: [:html, :json] }

That will test the following:

You can also provide the json key value if your data is nested under that controller name:

it_behaves_like 'a resourceful controller', User, formats: { index: [:html, :json] }, json_key: :users

"users":
[
  { ... }
]