Ticket #8558: improve_named_routes_with_nested_resources_and_actions_with_deprecation_warnings.patch

test/controller/routing_test.rb

@@ -1024 +1024 @@
-    end
-end
-
+class MapperDeprecatedRouteTest < Test::Unit::TestCase
+  def setup
+    @set = mock("set")
+    @mapper = ActionController::Routing::RouteSet::Mapper.new(@set)    
+  end
+  
+  def test_should_add_new_and_deprecated_named_routes
+    @set.expects(:add_named_route).with("new", "path", {:a => "b"})
+    @set.expects(:add_deprecated_named_route).with("new", "old", "path", {:a => "b"})
+    @mapper.deprecated_named_route("new", "old", "path", {:a => "b"})
+  end
+  
+  def test_should_not_add_deprecated_named_route_if_both_are_the_same
+    @set.expects(:add_named_route).with("new", "path", {:a => "b"})
+    @set.expects(:add_deprecated_named_route).with("new", "new", "path", {:a => "b"}).never
+    @mapper.deprecated_named_route("new", "new", "path", {:a => "b"})
+  end
+end
+
+class RouteSetDeprecatedRouteTest < Test::Unit::TestCase
+  def setup
+    @set = ActionController::Routing::RouteSet.new
+  end
+
+  def test_should_add_deprecated_route
+    @set.expects(:add_named_route).with("old", "path", {:a => "b"})
+    @set.add_deprecated_named_route("new", "old", "path", {:a => "b"})
+  end
+  
+  def test_should_fire_deprecation_warning_on_access
+    @set.add_deprecated_named_route("new_outer_inner_path", "outer_new_inner_path", "/outers/:outer_id/inners/new", :controller => :inners)
+    ActiveSupport::Deprecation.expects(:warn)
+    @set.named_routes["outer_new_inner_path"]
+  end
+end
+
-end # uses_mocha
-
-class RouteBuilderTest < Test::Unit::TestCase
@@ -1957 +1993 @@
-    assert c.ancestors.include?(h)
-  end
-  
-
+

test/controller/resources_test.rb

@@ -100 +100 @@
-    end
-  end
-
-
+p
-    with_restful_routing :messages, :comments, :path_prefix => '/thread/:thread_id' do
-      assert_simply_restful_for :messages, :path_prefix => 'thread/5/', :options => { :thread_id => '5' }
-      assert_simply_restful_for :comments, :path_prefix => 'thread/5/', :options => { :thread_id => '5' }
@@ -113 +113 @@
-    end
-  end
-
-
-
-
-
+
+
-
-{ :rss => :get }.merge(actions)
+actions
-      assert_restful_routes_for :messages do |options|
-        assert_routing rss_path, options.merge(rss_options)
-
-        actions.each do |action, method|
-          assert_recognizes(options.merge(:action => action), :path => "/messages/#{action}", :method => method)
-        end
-      end
-
-      assert_restful_named_routes_for :messages do |options|
-        assert_named_route rss_path, :rss_messages_path, rss_options
-        actions.keys.each do |action|
-          assert_named_route "/messages/#{action}", "#{action}_messages_path", :action => action
-        end
@@ -136 +131 @@
-    end
-  end
-
+  def test_with_collection_actions_and_name_prefix
+    actions = { 'a' => :get, 'b' => :put, 'c' => :post, 'd' => :delete }
+  
+    with_restful_routing :messages, :path_prefix => '/threads/:thread_id', :name_prefix => "thread_", :collection => actions do
+      assert_restful_routes_for :messages, :path_prefix => 'threads/1/', :name_prefix => 'thread_', :options => { :thread_id => '1' } do |options|
+        actions.each do |action, method|
+          assert_recognizes(options.merge(:action => action), :path => "/threads/1/messages/#{action}", :method => method)
+        end
+      end
+  
+      assert_restful_named_routes_for :messages, :path_prefix => 'threads/1/', :name_prefix => 'thread_', :options => { :thread_id => '1' } do |options|
+        # These were present before http://dev.rubyonrails.org/ticket/8251, and should
+        # be deprecated and ultimately removed.
+        actions.keys.each do |action|
+          assert_named_route "/threads/1/messages/#{action}", "thread_#{action}_messages_path", :action => action
+        end
+  
+        # These are added for http://dev.rubyonrails.org/ticket/8251, and result in supporting
+        # two possible names for each of these routes. Recommend deprecating and ultimately
+        # removing the the old names for same routes above.
+        actions.keys.each do |action|
+          assert_named_route "/threads/1/messages/#{action}", "#{action}_thread_messages_path", :action => action
+        end
+      end
+    end
+  end
+
+  def test_with_collection_action_and_name_prefix_and_formatted
+    actions = { 'a' => :get, 'b' => :put, 'c' => :post, 'd' => :delete }
+  
+    with_restful_routing :messages, :path_prefix => '/threads/:thread_id', :name_prefix => "thread_", :collection => actions do
+      assert_restful_routes_for :messages, :path_prefix => 'threads/1/', :name_prefix => 'thread_', :options => { :thread_id => '1' } do |options|
+        actions.each do |action, method|
+          assert_recognizes(options.merge(:action => action, :format => 'xml'), :path => "/threads/1/messages/#{action}.xml", :method => method)
+        end
+      end
+  
+      assert_restful_named_routes_for :messages, :path_prefix => 'threads/1/', :name_prefix => 'thread_', :options => { :thread_id => '1' } do |options|
+        # These were present before http://dev.rubyonrails.org/ticket/8251, and should
+        # be deprecated and ultimately removed.
+        (actions.keys).each do |action|
+          assert_named_route "/threads/1/messages/#{action}.xml", "formatted_thread_#{action}_messages_path", :action => action, :format => 'xml'
+        end
+  
+        # These are added for http://dev.rubyonrails.org/ticket/8251, and result in supporting
+        # two possible names for each of these routes. Recommend deprecating and ultimately
+        # removing the the old names for same routes above.
+        actions.keys.each do |action|;
+          assert_named_route "/threads/1/messages/#{action}.xml", "formatted_#{action}_thread_messages_path", :action => action, :format => 'xml'
+        end
+      end
+    end
+  end
+
-  def test_with_member_action
-    [:put, :post].each do |method|
-      with_restful_routing :messages, :member => { :mark => method } do
@@ -183 +232 @@
-      end
-    end
-  end
+  
+  def test_with_new_action_with_name_prefix
+    with_restful_routing :messages, :new => { :preview => :post }, :path_prefix => '/threads/:thread_id', :name_prefix => 'thread_' do
+      preview_options = {:action => 'preview', :thread_id => '1'}
+      preview_path    = "/threads/1/messages/new/preview"
+      assert_restful_routes_for :messages, :path_prefix => 'threads/1/', :name_prefix => 'thread_', :options => { :thread_id => '1' } do |options|
+        assert_recognizes(options.merge(preview_options), :path => preview_path, :method => :post)
+      end
-
+      assert_restful_named_routes_for :messages, :path_prefix => 'threads/1/', :name_prefix => 'thread_', :options => { :thread_id => '1' } do |options|
+
+        # These were present before http://dev.rubyonrails.org/ticket/8251, and should
+        # be deprecated and ultimately removed.
+        assert_named_route preview_path, :thread_preview_new_message_path, preview_options
+
+        # These are added for http://dev.rubyonrails.org/ticket/8251, and result in supporting
+        # two possible names for each of these routes. Recommend deprecating and ultimately
+        # removing the the old names for same routes above.
+        assert_named_route preview_path, :preview_new_thread_message_path, preview_options
+      end
+    end
+  end
+  
+  def test_with_formatted_new_action_with_name_prefix
+    with_restful_routing :messages, :new => { :preview => :post }, :path_prefix => '/threads/:thread_id', :name_prefix => 'thread_' do
+      preview_options = {:action => 'preview', :thread_id => '1', :format => 'xml'}
+      preview_path    = "/threads/1/messages/new/preview.xml"
+      assert_restful_routes_for :messages, :path_prefix => 'threads/1/', :name_prefix => 'thread_', :options => { :thread_id => '1' } do |options|
+        assert_recognizes(options.merge(preview_options), :path => preview_path, :method => :post)
+      end
+
+        # These were present before http://dev.rubyonrails.org/ticket/8251, and should
+        # be deprecated and ultimately removed.
+        assert_restful_named_routes_for :messages, :path_prefix => 'threads/1/', :name_prefix => 'thread_', :options => { :thread_id => '1' } do |options|        assert_named_route preview_path, :formatted_thread_preview_new_message_path, preview_options
+
+        # These are added for http://dev.rubyonrails.org/ticket/8251, and result in supporting
+        # two possible names for each of these routes. Recommend deprecating and ultimately
+        # removing the the old names for same routes above.
+        assert_named_route preview_path, :formatted_preview_new_thread_message_path, preview_options
+      end
+    end
+  end
+  
-  def test_override_new_method
-    with_restful_routing :messages do
-      assert_restful_routes_for :messages do |options|
@@ -244 +335 @@
-    end
-  end
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-  def test_should_create_singleton_resource_routes
-    with_singleton_resources :account do
@@ -541 +640 @@
-
-      full_prefix = "/#{options[:path_prefix]}#{controller_name}"
-      name_prefix = options[:name_prefix]
+      
+      assert_named_route "#{full_prefix}",            "#{name_prefix}#{controller_name}_path",              options[:options]
+      assert_named_route "#{full_prefix}.xml",        "formatted_#{name_prefix}#{controller_name}_path",    options[:options].merge(            :format => 'xml')
+      assert_named_route "#{full_prefix}/1",          "#{name_prefix}#{singular_name}_path",                options[:options].merge(:id => '1')
+      assert_named_route "#{full_prefix}/1.xml",      "formatted_#{name_prefix}#{singular_name}_path",      options[:options].merge(:id => '1', :format => 'xml')
-
-
+
+
-      assert_named_route "#{full_prefix}/new",        "#{name_prefix}new_#{singular_name}_path",            options[:options]
-1",          "#{name_prefix}#{singular_name}_path",                options[:options].merge(:id => '1
+new.xml",    "formatted_#{name_prefix}new_#{singular_name}_path",  options[:options].merge(            :format => 'xml
-      assert_named_route "#{full_prefix}/1/edit",     "#{name_prefix}edit_#{singular_name}_path",           options[:options].merge(:id => '1')
-      assert_named_route "#{full_prefix}.xml",        "formatted_#{name_prefix}#{controller_name}_path",    options[:options].merge(            :format => 'xml')
-      assert_named_route "#{full_prefix}/new.xml",    "formatted_#{name_prefix}new_#{singular_name}_path",  options[:options].merge(            :format => 'xml')
-      assert_named_route "#{full_prefix}/1.xml",      "formatted_#{name_prefix}#{singular_name}_path",      options[:options].merge(:id => '1', :format => 'xml')
-      assert_named_route "#{full_prefix}/1/edit.xml", "formatted_#{name_prefix}edit_#{singular_name}_path", options[:options].merge(:id => '1', :format => 'xml')
+
+      # These are added for http://dev.rubyonrails.org/ticket/8251, and result in supporting
+      # two possible names for each of these routes. Recommend deprecating and ultimately
+      # removing the the old names for same routes above.
+      assert_named_route "#{full_prefix}/new",        "new_#{name_prefix}#{singular_name}_path",            options[:options]
+      assert_named_route "#{full_prefix}/new.xml",    "formatted_new_#{name_prefix}#{singular_name}_path",  options[:options].merge(            :format => 'xml')
+      assert_named_route "#{full_prefix}/1/edit",     "edit_#{name_prefix}#{singular_name}_path",           options[:options].merge(:id => '1')
+      assert_named_route "#{full_prefix}/1/edit.xml", "formatted_edit_#{name_prefix}#{singular_name}_path", options[:options].merge(:id => '1', :format => 'xml')
+
-      yield options[:options] if block_given?
-    end
-
@@ -600 +711 @@
-      name_prefix = options[:name_prefix]
-
-      assert_named_route "#{full_path}",          "#{name_prefix}#{singleton_name}_path",                options[:options]
+      assert_named_route "#{full_path}.xml",      "formatted_#{name_prefix}#{singleton_name}_path",      options[:options].merge(:format => 'xml')
+
+      # These were present before http://dev.rubyonrails.org/ticket/8251, and should
+      # be deprecated and ultimately removed.
-      assert_named_route "#{full_path}/new",      "#{name_prefix}new_#{singleton_name}_path",            options[:options]
+      assert_named_route "#{full_path}/new.xml",  "formatted_#{name_prefix}new_#{singleton_name}_path",  options[:options].merge(:format => 'xml')
-      assert_named_route "#{full_path}/edit",     "#{name_prefix}edit_#{singleton_name}_path",           options[:options]
-      assert_named_route "#{full_path}.xml",      "formatted_#{name_prefix}#{singleton_name}_path",      options[:options].merge(:format => 'xml')
-      assert_named_route "#{full_path}/new.xml",  "formatted_#{name_prefix}new_#{singleton_name}_path",  options[:options].merge(:format => 'xml')
-      assert_named_route "#{full_path}/edit.xml", "formatted_#{name_prefix}edit_#{singleton_name}_path", options[:options].merge(:format => 'xml')
+
+      # These are added for http://dev.rubyonrails.org/ticket/8251, and result in supporting
+      # two possible names for each of these routes. Recommend deprecating and ultimately
+      # removing the the old names for same routes above.
+      assert_named_route "#{full_path}/new",      "new_#{name_prefix}#{singleton_name}_path",            options[:options]
+      assert_named_route "#{full_path}/new.xml",  "formatted_new_#{name_prefix}#{singleton_name}_path",  options[:options].merge(:format => 'xml')
+      assert_named_route "#{full_path}/edit",     "edit_#{name_prefix}#{singleton_name}_path",           options[:options]
+      assert_named_route "#{full_path}/edit.xml", "formatted_edit_#{name_prefix}#{singleton_name}_path", options[:options].merge(:format => 'xml')
-    end
-
-    def assert_named_route(expected, route, options)
@@ -628 +750 @@
-      end
-      true
-    end
-
-
+

lib/action_controller/resources.rb

@@ -426 +426 @@
-        resource.collection_methods.each do |method, actions|
-          actions.each do |action|
-            action_options = action_options_for(action, resource, method)
-
-
+
+
+
+
-          end
-        end
-      end
@@ -453 +455 @@
-          actions.each do |action|
-            action_options = action_options_for(action, resource, method)
-            if action == :new
-
-
+
+
+
-            else
-
-
+
+
+
-            end
-          end
-        end
@@ -467 +471 @@
-        resource.member_methods.each do |method, actions|
-          actions.each do |action|
-            action_options = action_options_for(action, resource, method)
-
-
+
+
+
-          end
-        end
-

lib/action_controller/routing.rb

@@ -1020 +1020 @@
-          @set.add_named_route(name, path, options)
-        end
-        
+        def deprecated_named_route(name, deprecated_name, path, options = {})
+          named_route(name, path, options)
+          @set.add_deprecated_named_route(name, deprecated_name, path, options) unless deprecated_name == name
+        end
+        
-        # Enables the use of resources in a module by setting the name_prefix, path_prefix, and namespace for the model.
-        # Example:
-        #
@@ -1052 +1057 @@
-      class NamedRouteCollection #:nodoc:
-        include Enumerable
-
-
+, :deprecated_named_routes
-
-        def initialize
-          clear!
@@ -1061 +1066 @@
-        def clear!
-          @routes = {}
-          @helpers = []
+          @deprecated_named_routes = {}
-          
-          @module ||= Module.new
-          @module.instance_methods.each do |selector|
@@ -1074 +1080 @@
-        end
-
-        def get(name)
+          if @deprecated_named_routes.has_key?(name.to_sym)
+            ActiveSupport::Deprecation.warn(
+              "The named route \"#{name}\" uses a format that has been deprecated. " +
+              "You should use \"#{@deprecated_named_routes[name]}\" instead", caller
+            )
+          end
-          routes[name.to_sym]
-        end
-
@@ -1169 +1181 @@
-        self.routes = []
-        self.named_routes = NamedRouteCollection.new
-      end
-
+
-      # Subclasses and plugins may override this method to specify a different
-      # RouteBuilder instance, so that other route DSL's can be created.
-      def builder
@@ -1222 +1234 @@
-      end
-  
-      def add_named_route(name, path, options = {})
+        # TODO - is options EVER used?
-        name = options[:name_prefix] + name.to_s if options[:name_prefix]
-        named_routes[name.to_sym] = add_route(path, options)
-      end
-  
+      def add_deprecated_named_route(name, deprecated_name, path, options = {})
+        add_named_route(deprecated_name, path, options)
+        named_routes.deprecated_named_routes[deprecated_name.to_sym] = name
+      end
+  
-      def options_as_params(options)
-        # If an explicit :controller was given, always make :action explicit
-        # too, so that action expiry works as expected for things like