Merge pull request #2034 from Casecommons/to_path

Allow ActiveModel-compatible instances to define their own partial paths

6 files changed, 62 insertions, 10 deletions

diff --git a/activemodel/lib/active_model/conversion.rb b/activemodel/lib/active_model/conversion.rb
index 1405b1bfe3..dca1c1aa44 100644
--- a/activemodel/lib/active_model/conversion.rb
+++ b/activemodel/lib/active_model/conversion.rb
@@ -1,9 +1,12 @@
+require 'active_support/concern'
+require 'active_support/inflector'
+
 module ActiveModel
   # == Active Model Conversions
   #
-  # Handles default conversions: to_model, to_key and to_param.
+  # Handles default conversions: to_model, to_key, to_param, and to_path.
   #
-  # Let's take for example this non persisted object.
+  # Let's take for example this non-persisted object.
   #
   #   class ContactMessage
   #     include ActiveModel::Conversion
@@ -18,8 +21,11 @@ module ActiveModel
   #   cm.to_model == self # => true
   #   cm.to_key           # => nil
   #   cm.to_param         # => nil
+  #   cm.to_path          # => "contact_messages/contact_message"
   #
   module Conversion
+    extend ActiveSupport::Concern
+
     # If your object is already designed to implement all of the Active Model
     # you can use the default <tt>:to_model</tt> implementation, which simply
     # returns self.
@@ -45,5 +51,21 @@ module ActiveModel
     def to_param
       persisted? ? to_key.join('-') : nil
     end
+
+    # Returns a string identifying the path associated with the object.
+    # ActionPack uses this to find a suitable partial to represent the object.
+    def to_path
+      self.class.to_path
+    end
+
+    module ClassMethods
+      def to_path
+        @_to_path ||= begin
+          element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(self))
+          collection = ActiveSupport::Inflector.tableize(self)
+          "#{collection}/#{element}".freeze
+        end
+      end
+    end
   end
 end
diff --git a/activemodel/lib/active_model/lint.rb b/activemodel/lib/active_model/lint.rb
index b71ef4b22e..08c2e5fcf3 100644
--- a/activemodel/lib/active_model/lint.rb
+++ b/activemodel/lib/active_model/lint.rb
@@ -43,6 +43,16 @@ module ActiveModel
         assert model.to_param.nil?, "to_param should return nil when `persisted?` returns false"
       end
 
+      # == Responds to <tt>to_path</tt>
+      #
+      # Returns a string giving a relative path.  This is used for looking up
+      # partials. For example, a BlogPost model might return "blog_posts/blog_post"
+      #
+      def test_to_path
+        assert model.respond_to?(:to_path), "The model should respond to to_path"
+        assert_kind_of String, model.to_path
+      end
+
       # == Responds to <tt>valid?</tt>
       #
       # Returns a boolean that specifies whether the object is in a valid or invalid
@@ -66,15 +76,14 @@ module ActiveModel
 
       # == Naming
       #
-      # Model.model_name must return a string with some convenience methods as
-      # :human and :partial_path. Check ActiveModel::Naming for more information.
+      # Model.model_name must return a string with some convenience methods:
+      # :human, :singular, and :plural. Check ActiveModel::Naming for more information.
       #
       def test_model_naming
         assert model.class.respond_to?(:model_name), "The model should respond to model_name"
         model_name = model.class.model_name
         assert_kind_of String, model_name
         assert_kind_of String, model_name.human
-        assert_kind_of String, model_name.partial_path
         assert_kind_of String, model_name.singular
         assert_kind_of String, model_name.plural
       end
diff --git a/activemodel/lib/active_model/naming.rb b/activemodel/lib/active_model/naming.rb
index 4c1a82f413..26fa3062eb 100644
--- a/activemodel/lib/active_model/naming.rb
+++ b/activemodel/lib/active_model/naming.rb
@@ -1,12 +1,15 @@
 require 'active_support/inflector'
 require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/module/introspection'
+require 'active_support/core_ext/module/deprecation'
 
 module ActiveModel
   class Name < String
     attr_reader :singular, :plural, :element, :collection, :partial_path, :route_key, :param_key, :i18n_key
     alias_method :cache_key, :collection
 
+    deprecate :partial_path => "ActiveModel::Name#partial_path is deprecated. Call #to_path on model instances directly instead."
+
     def initialize(klass, namespace = nil, name = nil)
       name ||= klass.name
       super(name)
diff --git a/activemodel/test/cases/conversion_test.rb b/activemodel/test/cases/conversion_test.rb
index 7669bf5f65..2eccc4e56d 100644
--- a/activemodel/test/cases/conversion_test.rb
+++ b/activemodel/test/cases/conversion_test.rb
@@ -1,5 +1,6 @@
 require 'cases/helper'
 require 'models/contact'
+require 'models/helicopter'
 
 class ConversionTest < ActiveModel::TestCase
   test "to_model default implementation returns self" do
@@ -22,4 +23,10 @@ class ConversionTest < ActiveModel::TestCase
   test "to_param default implementation returns a string of ids for persisted records" do
     assert_equal "1", Contact.new(:id => 1).to_param
   end
-end
\ No newline at end of file
+
+  test "to_path default implementation returns a string giving a relative path" do
+    assert_equal "contacts/contact", Contact.new.to_path
+    assert_equal "helicopters/helicopter", Helicopter.new.to_path,
+      "ActiveModel::Conversion#to_path caching should be class-specific"
+  end
+end
diff --git a/activemodel/test/cases/naming_test.rb b/activemodel/test/cases/naming_test.rb
index f814fcc56c..bafe4f3c0c 100644
--- a/activemodel/test/cases/naming_test.rb
+++ b/activemodel/test/cases/naming_test.rb
@@ -26,7 +26,9 @@ class NamingTest < ActiveModel::TestCase
   end
 
   def test_partial_path
-    assert_equal 'post/track_backs/track_back', @model_name.partial_path
+    assert_deprecated(/#partial_path.*#to_path/) do
+      assert_equal 'post/track_backs/track_back', @model_name.partial_path
+    end
   end
 
   def test_human
@@ -56,7 +58,9 @@ class NamingWithNamespacedModelInIsolatedNamespaceTest < ActiveModel::TestCase
   end
 
   def test_partial_path
-    assert_equal 'blog/posts/post', @model_name.partial_path
+    assert_deprecated(/#partial_path.*#to_path/) do
+      assert_equal 'blog/posts/post', @model_name.partial_path
+    end
   end
 
   def test_human
@@ -98,7 +102,9 @@ class NamingWithNamespacedModelInSharedNamespaceTest < ActiveModel::TestCase
   end
 
   def test_partial_path
-    assert_equal 'blog/posts/post', @model_name.partial_path
+    assert_deprecated(/#partial_path.*#to_path/) do
+      assert_equal 'blog/posts/post', @model_name.partial_path
+    end
   end
 
   def test_human
@@ -136,7 +142,9 @@ class NamingWithSuppliedModelNameTest < ActiveModel::TestCase
   end
 
   def test_partial_path
-    assert_equal 'articles/article', @model_name.partial_path
+    assert_deprecated(/#partial_path.*#to_path/) do
+      assert_equal 'articles/article', @model_name.partial_path
+    end
   end
 
   def test_human
diff --git a/activemodel/test/models/helicopter.rb b/activemodel/test/models/helicopter.rb
new file mode 100644
index 0000000000..a52b6fb4dd
--- /dev/null
+++ b/activemodel/test/models/helicopter.rb
@@ -0,0 +1,3 @@
+class Helicopter
+  include ActiveModel::Conversion
+end