After a few years of continuous development, your rails application becomes larger and itâs good practice to do some cleanup. One of the most obvious cleanups is cleaning up unused routes.
As your rails application grows, at the time of adding a route for new action, developers sometimes addÂ
resources :objectsconfig/routes.rbFor example,
Rails.application.routes.draw do
resources :users
endWriting above code will create the following routes -
But, it might be possible that we are not using all of the above methods, or we need onlyÂ
users#newusers#createusers#showclass UsersController < ApplicationController
def new
end
def create
end
def show
end
endSo, itâs the most obvious process to inspect yourÂ
routes.rbInspecting each route and its corresponding action took so much time and itâs next to impossible thing when the application is so large đ
Now, there are few ruby gems available in the market which can do it for you, but again adding additional gem requires extra load in your gemfile of your large application.
Another solution is to make a simple script which compares routes and associated actions available in controllers and list down all possible unused routes of our large application so that we can cleanÂ
routes.rbHave a look at following a small ruby script -
Rails.application.eager_load!
unused_routes = {}
# Iterating over all non-empty routes from RouteSet
Rails.application.routes.routes.map(&:requirements).reject(&:empty?).each do |route|
name = route[:controller].camelcase
next if name.start_with?("Rails")
controller = "#{name}Controller"
if Object.const_defined?(controller) && !controller.constantize.new.respond_to?(route[:action])
# Get route for which associated action is not present and add it in final results
unless Dir.glob(Rails.root.join("app", "views", name.downcase, "#{route[:action]}.*")).any?
unused_routes[controller] = [] if unused_routes[controller].nil?
unused_routes[controller] << route[:action]
end
end
end
puts unused_routes
# {"UsersController"=>["edit", "update", "update", "destroy"]}For getting unused routes for your rails app, all you need to do is to copy above code in your rails console or you can paste above code in single fileÂ
get-unused-routes.rb$> ruby get-unused-routes.rb Using above small script weâre able to get all unused routes of our large rails application, we donât use any Gem/Plugin to achieve this đĽł
References -
- Rails Routing from the Outside in
- RouteSet
- A deep dive into Routing & Controller Dispatch in Rails
- TraceRoute
- Reference to my Gists