RouteMechanic

No need to maintain Rails' routing tests manually. RouteMechanic automatically detects broken routes and missing action methods in controllers once you've finished installation.

Add this line to your application's Gemfile:

group :test do
  gem 'route_mechanic'
end

And then execute:

$ bundle install

RouteMechanic is available for both RSpec and MiniTest.

All you have to do is to add just one test case that keeps your application's routes not broken. Then, RouteMechanic will get to report 2 types of broken routes.

1. Unused actions
   • Your application has the controller and the action method but config/routes.rb doesn't have corresponding settings.
2. Unused routes
   • Your application's config/routes.rb has a routing declaration but no controller has a corresponding action method.

Just add one test file that has only one test case using have_valid_routes matcher.

RSpec.describe 'Rails.application', type: :routing do
  it "fails if application does not have valid routes" do
    expect(Rails.application).to have_valid_routes
  end
end

If you'd like to test unused actions and unused routes separately or test only one of them, there're matchers to do so.

RSpec.describe 'Rails.application', type: :routing do
  it "fails if application has unused actions" do
    expect(Rails.application).to have_no_unused_actions
  end

  it "fails if application has unused routes" do
    expect(Rails.application).to have_no_unused_routes
  end
end

Just add one test file like below.

class RoutingTest < Minitest::Test
  include ::RouteMechanic::Testing::Methods

  def test_that_application_has_correct_routes
    assert_all_routes
  end
end

If you'd like to test unused actions and unused routes separately or test only one of them, there're assertions to do so.

class RoutingTest < Minitest::Test
  include ::RouteMechanic::Testing::Methods

  def test_that_application_has_no_unused_actions
    assert_no_unused_actions
  end

  def test_that_application_has_no_unused_routes
    assert_no_unused_routes
  end
end

It tells you broken routes as follows.

  0) Rail.application fails if application does not have valid routes
     Failure/Error: expect(Rails.application.routes).to have_valid_routes

       [Route Mechanic]
         No route matches to the controllers and action methods below
           UsersController#unknown
         No controller and action matches to the routes below
           GET    /users/:user_id/friends(.:format) users#friends
           GET    /users(.:format)                  users#index
           DELETE /users/:id(.:format)              users#destroy
     # ./spec/rspec/matchers_spec.rb:8:in `block (2 levels) in <top (required)>'

1 examples, 1 failure, 0 passed

I believe most Rails developers write request specs instead of routing specs, and you might wonder what's worth to automate routing specs. Having said that, I can come up with some use-cases of this gem.

1. When your project is kinda aged and none knows which route is alive and which one is dead.
   • => You can detect dead code by using this gem.
2. When your application doesn't have enough request specs (even controller specs).
   • => This gem could be a good start point to increase tests to ensure routing is valid.
3. When you try to make a big refactor of config/routes.rb.
   • => It's a burden to run all request specs during refactoring. This could save your time.
4. When you're compelled to write routing specs by any pressure. ;-)
   • => Set you free from tedious work!

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the RouteMechanic project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the code of conduct.