aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails/tasks/routes.rake
blob: 65cf79a0a23446e5a6cb02cbe1bd024a7ea337ea (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
desc 'Print out all defined routes in match order, with names. Target specific controller with CONTROLLER=x.'
task :routes => :environment do
  Rails.application.reload_routes!

  all_routes   = Rails.application.routes.routes
  named_routes = Rails.application.routes.named_routes.routes

  if ENV['CONTROLLER']
    all_routes = all_routes.select{ |route| route.defaults[:controller] == ENV['CONTROLLER'] }
  end

  routes = all_routes.collect do |route|
    # TODO: The :index method is deprecated in 1.9 in favor of :key
    # but we don't have :key in 1.8.7. We can remove this check when
    # stop supporting 1.8.x
    key  = Hash.method_defined?('key') ? 'key' : 'index'
    name = named_routes.send(key, route).to_s

    reqs = route.requirements.dup
    reqs[:to] = route.app unless route.app.class.name.to_s =~ /^ActionDispatch::Routing/
    reqs = reqs.empty? ? "" : reqs.inspect

    {:name => name, :verb => route.verb.to_s, :path => route.path, :reqs => reqs}
  end

  routes.reject! { |r| r[:path] == "/rails/info/properties" } # Skip the route if it's internal info route

  name_width = routes.map{ |r| r[:name] }.map(&:length).max
  verb_width = routes.map{ |r| r[:verb] }.map(&:length).max
  path_width = routes.map{ |r| r[:path] }.map(&:length).max

  routes.each do |r|
    puts "#{r[:name].rjust(name_width)} #{r[:verb].ljust(verb_width)} #{r[:path].ljust(path_width)} #{r[:reqs]}"
  end
end