On this page
module ActiveModel::Naming
Active Model Naming
Creates a model_name
method on your object.
To implement, just extend ActiveModel::Naming in your object:
class BookCover
extend ActiveModel::Naming
end
BookCover.model_name # => "BookCover"
BookCover.model_name.human # => "Book cover"
BookCover.model_name.i18n_key # => :book_cover
BookModule::BookCover.model_name.i18n_key # => :"book_module/book_cover"
Providing the functionality that ActiveModel::Naming provides in your object is required to pass the Active Model Lint test. So either extending the provided method below, or rolling your own is required.
Public Class Methods
Returns string to use for params names. It differs for namespaced models regarding whether it's inside isolated engine.
# For isolated engine:
ActiveModel::Naming.param_key(Blog::Post) # => "post"
# For shared engine:
ActiveModel::Naming.param_key(Blog::Post) # => "blog_post"
# File activemodel/lib/active_model/naming.rb, line 296
def self.param_key(record_or_class)
model_name_from_record_or_class(record_or_class).param_key
end
Returns the plural class name of a record or class.
ActiveModel::Naming.plural(post) # => "posts"
ActiveModel::Naming.plural(Highrise::Person) # => "highrise_people"
# File activemodel/lib/active_model/naming.rb, line 241
def self.plural(record_or_class)
model_name_from_record_or_class(record_or_class).plural
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"
The route key also considers if the noun is uncountable and, in such cases, automatically appends _index.
# File activemodel/lib/active_model/naming.rb, line 284
def self.route_key(record_or_class)
model_name_from_record_or_class(record_or_class).route_key
end
Returns the singular class name of a record or class.
ActiveModel::Naming.singular(post) # => "post"
ActiveModel::Naming.singular(Highrise::Person) # => "highrise_person"
# File activemodel/lib/active_model/naming.rb, line 249
def self.singular(record_or_class)
model_name_from_record_or_class(record_or_class).singular
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.singular_route_key(Blog::Post) # => "post"
# For shared engine:
ActiveModel::Naming.singular_route_key(Blog::Post) # => "blog_post"
# File activemodel/lib/active_model/naming.rb, line 269
def self.singular_route_key(record_or_class)
model_name_from_record_or_class(record_or_class).singular_route_key
end
Identifies whether the class name of a record or class is uncountable.
ActiveModel::Naming.uncountable?(Sheep) # => true
ActiveModel::Naming.uncountable?(Post) # => false
# File activemodel/lib/active_model/naming.rb, line 257
def self.uncountable?(record_or_class)
plural(record_or_class) == singular(record_or_class)
end
Public Instance Methods
Returns an ActiveModel::Name object for module. It can be used to retrieve all kinds of naming-related information (See ActiveModel::Name for more information).
class Person < ActiveModel::Model
end
Person.model_name # => Person
Person.model_name.class # => ActiveModel::Name
Person.model_name.singular # => "person"
Person.model_name.plural # => "people"
# File activemodel/lib/active_model/naming.rb, line 228
def model_name
@_model_name ||= begin
namespace = self.parents.detect do |n|
n.respond_to?(:use_relative_model_naming?) && n.use_relative_model_naming?
end
ActiveModel::Name.new(self, namespace)
end
end
© 2004–2016 David Heinemeier Hansson
Licensed under the MIT License.