From bf1ac82cecfb3291a9bc215974b385a1b3ccb545 Mon Sep 17 00:00:00 2001 From: Piotr Sarnacki Date: Wed, 1 Sep 2010 11:02:28 +0200 Subject: Add some documantation on new route_key and param_key in ActiveModel::Naming --- activemodel/lib/active_model/naming.rb | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'activemodel/lib/active_model/naming.rb') diff --git a/activemodel/lib/active_model/naming.rb b/activemodel/lib/active_model/naming.rb index 1eb1abdb52..dadb1882e4 100644 --- a/activemodel/lib/active_model/naming.rb +++ b/activemodel/lib/active_model/naming.rb @@ -95,10 +95,26 @@ module ActiveModel plural(record_or_class) == singular(record_or_class) end + # Returns string to use while generating route names. It differs for + # namespaced models regarding whether it's inside isolated engine. + # + # For isolated engine: + # ActiveModel::Naming.route_key(Blog::Post) #=> posts + # + # For shared engine: + # ActiveModel::Naming.route_key(Blog::Post) #=> blog_posts def self.route_key(record_or_class) model_name_from_record_or_class(record_or_class).route_key end + # Returns string to use for params names. It differs for + # namespaced models regarding whether it's inside isolated engine. + # + # For isolated engine: + # ActiveModel::Naming.route_key(Blog::Post) #=> post + # + # For shared engine: + # ActiveModel::Naming.route_key(Blog::Post) #=> blog_post def self.param_key(record_or_class) model_name_from_record_or_class(record_or_class).param_key end -- cgit v1.2.3