Merge pull request #8658 from senny/8649_unify_routes_output_for_console_and_web

Unify routes output for console and web, ensure engine routes are shown in html routes table.

Closes #8649.

3 files changed, 65 insertions, 28 deletions

diff --git a/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb b/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
index ac8f6af7fe..5c50f9ec6a 100644
--- a/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+++ b/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
@@ -2,7 +2,6 @@ require 'action_dispatch/http/request'
 require 'action_dispatch/middleware/exception_wrapper'
 require 'action_dispatch/routing/inspector'
 
-
 module ActionDispatch
   # This middleware is responsible for logging exceptions and
   # showing a debugging page in case the request is local.
@@ -42,12 +41,11 @@ module ActionDispatch
           :application_trace => wrapper.application_trace,
           :framework_trace => wrapper.framework_trace,
           :full_trace => wrapper.full_trace,
-          :routes => formatted_routes(exception),
+          :routes_inspector => routes_inspector(exception),
           :source_extract => wrapper.source_extract,
           :line_number => wrapper.line_number,
           :file => wrapper.file
         )
-
         file = "rescues/#{wrapper.rescue_template}"
         body = template.render(:template => file, :layout => 'rescues/layout')
         render(wrapper.status_code, body)
@@ -85,11 +83,28 @@ module ActionDispatch
       @stderr_logger ||= ActiveSupport::Logger.new($stderr)
     end
 
-    def formatted_routes(exception)
+    def routes_inspector(exception)
       return false unless @routes_app.respond_to?(:routes)
       if exception.is_a?(ActionController::RoutingError) || exception.is_a?(ActionView::Template::Error)
-        inspector = ActionDispatch::Routing::RoutesInspector.new
-        inspector.collect_routes(@routes_app.routes.routes)
+        ActionDispatch::Routing::RoutesInspector.new(@routes_app.routes.routes)
+      end
+    end
+
+    class TableRoutesFormatter
+      def initialize(view)
+        @view = view
+        @buffer = []
+      end
+
+      def section(type, title, routes)
+        @buffer << %(<tr><th colspan="4">#{title}</th></tr>)
+        @buffer << @view.render(partial: "routes/route", collection: routes)
+      end
+
+      def result
+        @view.raw @view.render(layout: "routes/route_wrapper") {
+          @view.raw @buffer.join("\n")
+        }
       end
     end
   end
diff --git a/actionpack/lib/action_dispatch/middleware/templates/rescues/routing_error.erb b/actionpack/lib/action_dispatch/middleware/templates/rescues/routing_error.erb
index 77804a8cbb..9463da520b 100644
--- a/actionpack/lib/action_dispatch/middleware/templates/rescues/routing_error.erb
+++ b/actionpack/lib/action_dispatch/middleware/templates/rescues/routing_error.erb
@@ -15,6 +15,7 @@
   <% end %>
   <%= render template: "rescues/_trace" %>
 
+<% if @routes_inspector %>
   <h2>
     Routes
   </h2>
@@ -23,6 +24,5 @@
     Routes match in priority from top to bottom
   </p>
 
-<%= render layout: "routes/route_wrapper" do %>
-  <%= render partial: "routes/route", collection: @routes %>
+  <%= @routes_inspector.format(ActionDispatch::DebugExceptions::TableRoutesFormatter.new(self)) %>
 <% end %>
diff --git a/actionpack/lib/action_dispatch/routing/inspector.rb b/actionpack/lib/action_dispatch/routing/inspector.rb
index 73b2b4ac1d..7ae1d2a0ee 100644
--- a/actionpack/lib/action_dispatch/routing/inspector.rb
+++ b/actionpack/lib/action_dispatch/routing/inspector.rb
@@ -61,21 +61,33 @@ module ActionDispatch
 
     ##
     # This class is just used for displaying route information when someone
-    # executes `rake routes`.  People should not use this class.
+    # executes `rake routes` or looks at the RoutingError page.
+    # People should not use this class.
     class RoutesInspector # :nodoc:
-      def initialize
-        @engines = Hash.new
+      def initialize(routes)
+        @engines = {}
+        @routes = routes
       end
 
-      def format(all_routes, filter = nil)
-        if filter
-          all_routes = all_routes.select{ |route| route.defaults[:controller] == filter }
+      def format(formatter, filter = nil)
+        routes_to_display = filter_routes(filter)
+
+        routes = collect_routes(routes_to_display)
+        formatter.section :application, 'Application routes', routes
+
+        @engines.each do |name, routes|
+          formatter.section :engine, "Routes for #{name}", routes
         end
 
-        routes = collect_routes(all_routes)
+        formatter.result
+      end
 
-        formatted_routes(routes) +
-          formatted_routes_for_engines
+      def filter_routes(filter)
+        if filter
+          @routes.select { |route| route.defaults[:controller] == filter }
+        else
+          @routes
+        end
       end
 
       def collect_routes(routes)
@@ -100,22 +112,32 @@ module ActionDispatch
           @engines[name] = collect_routes(routes.routes)
         end
       end
+    end
 
-      def formatted_routes_for_engines
-        @engines.map do |name, routes|
-          ["\nRoutes for #{name}:"] + formatted_routes(routes)
-        end.flatten
+    class ConsoleFormatter
+      def initialize
+        @buffer = []
       end
 
-      def formatted_routes(routes)
-        name_width = routes.map{ |r| r[:name].length }.max
-        verb_width = routes.map{ |r| r[:verb].length }.max
-        path_width = routes.map{ |r| r[:path].length }.max
+      def result
+        @buffer.join("\n")
+      end
 
-        routes.map do |r|
-          "#{r[:name].rjust(name_width)} #{r[:verb].ljust(verb_width)} #{r[:path].ljust(path_width)} #{r[:reqs]}"
-        end
+      def section(type, title, routes)
+        @buffer << "\n#{title}:" unless type == :application
+        @buffer << draw_section(routes)
       end
+
+      private
+        def draw_section(routes)
+          name_width = routes.map { |r| r[:name].length }.max
+          verb_width = routes.map { |r| r[:verb].length }.max
+          path_width = routes.map { |r| r[:path].length }.max
+
+          routes.map do |r|
+            "#{r[:name].rjust(name_width)} #{r[:verb].ljust(verb_width)} #{r[:path].ljust(path_width)} #{r[:reqs]}"
+          end
+        end
     end
   end
 end