README.md

Rspec::RoutesCoverage

This gem is helpful on huge Rails JSON API applications: it allows to specify and track the coverage of tested API requests according to app's routes.

Installation

Add this to your application's Gemfile:

gem 'rspec-rails'
gem 'rspec-routes_coverage'

And then execute:

$ bundle

Usage

spec/requests/items_spec.rb:

require 'spec_helper'
describe ItemsController do
  describe_request :index, request_path: '/items', method: 'GET' do
    it 'lists items' do
      get '/items'
      # ...
    end
  end

  # another style:
  describe_request 'GET /items/:id' do
    it 'shows item' do
      get "/items/#{Item.first.id}"
      # ...
    end
  end
end

By default, pending routes will not be output in common spec pass. To show them you should run:

$ RAILS_ENV=test bundle exec rake spec:requests:with_coverage

TODO

0. Make "auto marking" with get/post/put/etc... methods
1. Make untested routes to be marked as pending specs
2. Gem tests :)
3. ?????

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request