move route inspecting to an object so that we can more easily test it

4 files changed, 144 insertions, 126 deletions

diff --git a/railties/lib/rails/application/route_inspector.rb b/railties/lib/rails/application/route_inspector.rb
new file mode 100644
index 0000000000..15c6d035e5
--- /dev/null
+++ b/railties/lib/rails/application/route_inspector.rb
@@ -0,0 +1,42 @@
+module Rails
+  class Application
+    ##
+    # This class is just used for displaying route information when someone
+    # executes `rake routes`.  People should not use this class.
+    class RouteInspector # :nodoc:
+      def format all_routes, filter = nil
+        if filter
+          all_routes = all_routes.select{ |route| route.defaults[:controller] == filter }
+        end
+
+        routes = all_routes.collect do |route|
+
+          reqs = route.requirements.dup
+          rack_app = route.app unless route.app.class.name.to_s =~ /^ActionDispatch::Routing/
+
+          endpoint = rack_app ? rack_app.inspect : "#{reqs[:controller]}##{reqs[:action]}"
+          constraints = reqs.except(:controller, :action)
+
+          reqs = endpoint == '#' ? '' : endpoint
+
+          unless constraints.empty?
+            reqs = reqs.empty? ? constraints.inspect : "#{reqs} #{constraints.inspect}"
+          end
+
+          {:name => route.name.to_s, :verb => route.verb.to_s, :path => route.path, :reqs => reqs}
+        end
+
+        # Skip the route if it's internal info route
+        routes.reject! { |r| r[:path] =~ %r{/rails/info/properties|^/assets} }
+
+        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
diff --git a/railties/lib/rails/tasks/routes.rake b/railties/lib/rails/tasks/routes.rake
index 0c26bcf790..7dc54144da 100644
--- a/railties/lib/rails/tasks/routes.rake
+++ b/railties/lib/rails/tasks/routes.rake
@@ -3,35 +3,7 @@ task :routes => :environment do
   Rails.application.reload_routes!
   all_routes = Rails.application.routes.routes
 
-  if ENV['CONTROLLER']
-    all_routes = all_routes.select{ |route| route.defaults[:controller] == ENV['CONTROLLER'] }
-  end
-
-  routes = all_routes.collect do |route|
-
-    reqs = route.requirements.dup
-    rack_app = route.app unless route.app.class.name.to_s =~ /^ActionDispatch::Routing/
-
-    endpoint = rack_app ? rack_app.inspect : "#{reqs[:controller]}##{reqs[:action]}"
-    constraints = reqs.except(:controller, :action)
-
-    reqs = endpoint == '#' ? '' : endpoint
-
-    unless constraints.empty?
-      reqs = reqs.empty? ? constraints.inspect : "#{reqs} #{constraints.inspect}"
-    end
-
-    {:name => route.name.to_s, :verb => route.verb.to_s, :path => route.path, :reqs => reqs}
-  end
-
-   # Skip the route if it's internal info route
-  routes.reject! { |r| r[:path] =~ %r{/rails/info/properties|^/assets} }
-
-  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.each do |r|
-    puts "#{r[:name].rjust(name_width)} #{r[:verb].ljust(verb_width)} #{r[:path].ljust(path_width)} #{r[:reqs]}"
-  end
+  require 'rails/application/route_inspector'
+  inspector = Rails::Application::RouteInspector.new
+  puts inspector.format(all_routes, ENV['CONTROLLER']).join "\n"
 end
diff --git a/railties/test/application/rake_test.rb b/railties/test/application/rake_test.rb
index 0e03c3dc2d..3e0e3713aa 100644
--- a/railties/test/application/rake_test.rb
+++ b/railties/test/application/rake_test.rb
@@ -85,7 +85,7 @@ module ApplicationTests
       end
     end
 
-    def test_rake_routes_output_strips_anchors_from_http_verbs
+    def test_rake_routes_calls_the_route_inspector
       app_file "config/routes.rb", <<-RUBY
         AppTemplate::Application.routes.draw do
           get '/cart', :to => 'cart#show'
@@ -94,99 +94,6 @@ module ApplicationTests
       assert_equal "cart GET /cart(.:format) cart#show\n", Dir.chdir(app_path){ `rake routes` }
     end
 
-    def test_rake_routes_shows_custom_assets
-      app_file "config/routes.rb", <<-RUBY
-        AppTemplate::Application.routes.draw do
-          get '/custom/assets', :to => 'custom_assets#show'
-        end
-      RUBY
-      assert_equal "custom_assets GET /custom/assets(.:format) custom_assets#show\n",
-        Dir.chdir(app_path){ `rake routes` }
-    end
-
-    def test_rake_routes_shows_resources_route
-      app_file "config/routes.rb", <<-RUBY
-        AppTemplate::Application.routes.draw do
-          resources :articles
-        end
-      RUBY
-      expected =
-        "    articles GET    /articles(.:format)          articles#index\n" <<
-        "             POST   /articles(.:format)          articles#create\n" <<
-        " new_article GET    /articles/new(.:format)      articles#new\n" <<
-        "edit_article GET    /articles/:id/edit(.:format) articles#edit\n" <<
-        "     article GET    /articles/:id(.:format)      articles#show\n" <<
-        "             PUT    /articles/:id(.:format)      articles#update\n" <<
-        "             DELETE /articles/:id(.:format)      articles#destroy\n"
-      assert_equal expected, Dir.chdir(app_path){ `rake routes` }
-    end
-
-    def test_rake_routes_shows_root_route
-      app_file "config/routes.rb", <<-RUBY
-        AppTemplate::Application.routes.draw do
-          root :to => 'pages#main'
-        end
-      RUBY
-      assert_equal "root  / pages#main\n", Dir.chdir(app_path){ `rake routes` }
-    end
-
-    def test_rake_routes_shows_controller_and_action_only_route
-      app_file "config/routes.rb", <<-RUBY
-        AppTemplate::Application.routes.draw do
-          match ':controller/:action'
-        end
-      RUBY
-      assert_equal "  /:controller/:action(.:format) \n", Dir.chdir(app_path){ `rake routes` }
-    end
-
-    def test_rake_routes_shows_controller_and_action_route_with_constraints
-      app_file "config/routes.rb", <<-RUBY
-        AppTemplate::Application.routes.draw do
-          match ':controller(/:action(/:id))', :id => /\\d+/
-        end
-      RUBY
-      assert_equal "  /:controller(/:action(/:id))(.:format) {:id=>/\\d+/}\n", Dir.chdir(app_path){ `rake routes` }
-    end
-
-    def test_rake_routes_shows_route_with_defaults
-      app_file "config/routes.rb", <<-RUBY
-        AppTemplate::Application.routes.draw do
-          match 'photos/:id' => 'photos#show', :defaults => {:format => 'jpg'}
-        end
-      RUBY
-      assert_equal %Q[  /photos/:id(.:format) photos#show {:format=>"jpg"}\n], Dir.chdir(app_path){ `rake routes` }
-    end
-
-    def test_rake_routes_shows_route_with_constraints
-      app_file "config/routes.rb", <<-RUBY
-        AppTemplate::Application.routes.draw do
-          match 'photos/:id' => 'photos#show', :id => /[A-Z]\\d{5}/
-        end
-      RUBY
-      assert_equal "  /photos/:id(.:format) photos#show {:id=>/[A-Z]\\d{5}/}\n", Dir.chdir(app_path){ `rake routes` }
-    end
-
-    def test_rake_routes_shows_route_with_rack_app
-      app_file "lib/rack_app.rb", <<-RUBY
-        class RackApp
-          class << self
-            def call(env)
-            end
-          end
-        end
-      RUBY
-
-      app_file "config/routes.rb", <<-RUBY
-        require 'rack_app'
-
-        AppTemplate::Application.routes.draw do
-          match 'foo/:id' => RackApp, :id => /[A-Z]\\d{5}/
-        end
-      RUBY
-
-      assert_equal "  /foo/:id(.:format) RackApp {:id=>/[A-Z]\\d{5}/}\n", Dir.chdir(app_path){ `rake routes` }
-    end
-
     def test_logger_is_flushed_when_exiting_production_rake_tasks
       add_to_config <<-RUBY
         rake_tasks do
@@ -245,4 +152,4 @@ module ApplicationTests
       assert_match(/7 tests, 10 assertions, 0 failures, 0 errors/, content)
     end
   end
-end
\ No newline at end of file
+end
diff --git a/railties/test/application/route_inspect_test.rb b/railties/test/application/route_inspect_test.rb
new file mode 100644
index 0000000000..add8256b5d
--- /dev/null
+++ b/railties/test/application/route_inspect_test.rb
@@ -0,0 +1,97 @@
+require 'test/unit'
+require 'rails/application/route_inspector'
+require 'action_controller'
+
+module ApplicationTests
+  class RouteInspectTest < Test::Unit::TestCase
+    def setup
+      @set = ActionDispatch::Routing::RouteSet.new
+      @inspector = Rails::Application::RouteInspector.new
+    end
+
+    def test_cart_inspect
+      @set.draw do
+        get '/cart', :to => 'cart#show'
+      end
+      output = @inspector.format @set.routes
+      assert_equal ["cart GET /cart(.:format) cart#show"], output
+    end
+
+    def test_inspect_shows_custom_assets
+      @set.draw do
+        get '/custom/assets', :to => 'custom_assets#show'
+      end
+      output = @inspector.format @set.routes
+      assert_equal ["custom_assets GET /custom/assets(.:format) custom_assets#show"], output
+    end
+
+    def test_inspect_routes_shows_resources_route
+      @set.draw do
+        resources :articles
+      end
+      output = @inspector.format @set.routes
+      expected = [
+        "    articles GET    /articles(.:format)          articles#index",
+        "             POST   /articles(.:format)          articles#create",
+        " new_article GET    /articles/new(.:format)      articles#new",
+        "edit_article GET    /articles/:id/edit(.:format) articles#edit",
+        "     article GET    /articles/:id(.:format)      articles#show",
+        "             PUT    /articles/:id(.:format)      articles#update",
+        "             DELETE /articles/:id(.:format)      articles#destroy" ]
+      assert_equal expected, output
+    end
+
+    def test_inspect_routes_shows_root_route
+      @set.draw do
+        root :to => 'pages#main'
+      end
+      output = @inspector.format @set.routes
+      assert_equal ["root  / pages#main"], output
+    end
+
+    def test_inspect_routes_shows_controller_and_action_only_route
+      @set.draw do
+        match ':controller/:action'
+      end
+      output = @inspector.format @set.routes
+      assert_equal ["  /:controller/:action(.:format) "], output
+    end
+
+    def test_inspect_routes_shows_controller_and_action_route_with_constraints
+      @set.draw do
+        match ':controller(/:action(/:id))', :id => /\d+/
+      end
+      output = @inspector.format @set.routes
+      assert_equal ["  /:controller(/:action(/:id))(.:format) {:id=>/\\d+/}"], output
+    end
+
+    def test_rake_routes_shows_route_with_defaults
+      @set.draw do
+        match 'photos/:id' => 'photos#show', :defaults => {:format => 'jpg'}
+      end
+      output = @inspector.format @set.routes
+      assert_equal [%Q[  /photos/:id(.:format) photos#show {:format=>"jpg"}]], output
+    end
+
+    def test_rake_routes_shows_route_with_constraints
+      @set.draw do
+        match 'photos/:id' => 'photos#show', :id => /[A-Z]\d{5}/
+      end
+      output = @inspector.format @set.routes
+      assert_equal ["  /photos/:id(.:format) photos#show {:id=>/[A-Z]\\d{5}/}"], output
+    end
+
+    class RackApp
+      def self.call(env)
+      end
+    end
+
+    def test_rake_routes_shows_route_with_rack_app
+      @set.draw do
+        match 'foo/:id' => RackApp, :id => /[A-Z]\d{5}/
+      end
+      output = @inspector.format @set.routes
+      assert_equal ["  /foo/:id(.:format) #{RackApp.name} {:id=>/[A-Z]\\d{5}/}"], output
+    end
+  end
+end