Skip to content
A Rake task gem that helps you find the unused routes and controller actions for your Rails 3+ app
Ruby
Latest commit 0017add Mar 22, 2016 @amatsuda MIT-LICENSE
closes #23
Failed to load latest commit information.
lib ignore redirects Apr 16, 2015
test :nailcare: Feb 25, 2015
.gitignore Ignore logs Sep 13, 2014
Gemfile Bundle from more secure source Feb 22, 2013
MIT-LICENSE MIT-LICENSE Mar 22, 2016
README.rdoc MIT-LICENSE Mar 21, 2016
Rakefile Add test task to Rakefile Sep 24, 2014
traceroute.gemspec Version 0.5.0 Apr 17, 2015

README.rdoc

Traceroute

A Rake task that helps you find dead routes and unused actions in your Rails 3+ app.

Features

This Rake task investigates your Rails application's routes definition, then shows you the unused routes and unreachable action methods.

Supported versions

  • Ruby 1.8.7, 1.9.2, 1.9.3, 2.0, 2.1, 2.2 (trunk)

  • Rails 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1.x

Install

Put this line in your Gemfile:

gem 'traceroute'

Then bundle:

% bundle

Usage

Just run the following command in your Rails app directory.

% rake traceroute

If you want the rake task to fail when errors are found.

% FAIL_ON_ERROR=1 rake traceroute

What's gonna happen then?

Consider you have the following routes.rb and a controller:

# config/routes.rb
YourRailsApp::Application.routes.draw do
  resources :users, :only => [:index, :show, :new, :create]
  match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
end

# app/controllers/users_controller.rb
class UsersController < ApplicationController
  def index
    @users = User.page(params[:page])
  end

  def index2
  end

  def show
    @user = User.find(params[:id])
  end
end

Running the Rake task will print something like this for you:

Unused routes (3):
  users#create
  users#new
  catalog#purchase
Unreachable action methods (1):
  users#index2

OMG super helpful, isn't it?

FAQ

Q: It makes a fuss over the default route at the very bottom. WTF?
A: Please do not use that. Did you read the comment in your routes.rb? Actually this task will help you a lot to remove that evil route.

Q: "command not found: traceroute" Did you mean: tracert
A: I'm afraid you're using the wrong operating system.

Notes

Routes prefix with `rails/` are ignored. These are generated by rails in development mode. We don't want to fail the build on these.

Questions, Feedback

Feel free to message me on Github (amatsuda) or Twitter (@a_matsuda) ☇3☇3☇3

Contributing to Traceroute

  • Fork, patch, then send me a pull request.

Copyright

Copyright © 2011 Akira Matsuda. See MIT-LICENSE file for further details.

Something went wrong with that request. Please try again.