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.
Returns an ActiveModel::Name object for module. It can be used to retrieve all kinds of naming-related information.
# File lib/active_model/naming.rb, line 77 def model_name @_model_name ||= begin namespace = self.parents.detect { |n| n.respond_to?(:_railtie) } ActiveModel::Name.new(self, namespace) end 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.param_key(Blog::Post) #=> post
For shared engine: ActiveModel::Naming.param_key(Blog::Post) #=> blog_post
# File lib/active_model/naming.rb, line 128 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. Examples:
ActiveModel::Naming.plural(post) # => "posts" ActiveModel::Naming.plural(Highrise::Person) # => "highrise_people"
# File lib/active_model/naming.rb, line 88 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
# File lib/active_model/naming.rb, line 116 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. Examples:
ActiveModel::Naming.singular(post) # => "post" ActiveModel::Naming.singular(Highrise::Person) # => "highrise_person"
# File lib/active_model/naming.rb, line 96 def self.singular(record_or_class) model_name_from_record_or_class(record_or_class).singular end
Identifies whether the class name of a record or class is uncountable. Examples:
ActiveModel::Naming.uncountable?(Sheep) # => true ActiveModel::Naming.uncountable?(Post) => false
# File lib/active_model/naming.rb, line 104 def self.uncountable?(record_or_class) plural(record_or_class) == singular(record_or_class) end
Generated with the Darkfish Rdoc Generator 2.