Module: ActiveModel::Naming

Included in:
Translation, ActiveRecord::Base, ActiveResource::Base
Defined in:
activemodel/lib/active_model/naming.rb

Overview

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.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.param_key(record_or_class) ⇒ Object

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



157
158
159
 
# File 'activemodel/lib/active_model/naming.rb', line 157

def self.param_key(record_or_class)
  model_name_from_record_or_class(record_or_class).param_key
end

.plural(record_or_class) ⇒ Object

Returns the plural class name of a record or class. Examples:

ActiveModel::Naming.plural(post)             # => "posts"
ActiveModel::Naming.plural(Highrise::Person) # => "highrise_people"



102
103
104
 
# File 'activemodel/lib/active_model/naming.rb', line 102

def self.plural(record_or_class)
  model_name_from_record_or_class(record_or_class).plural
end

.route_key(record_or_class) ⇒ Object

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.



145
146
147
 
# File 'activemodel/lib/active_model/naming.rb', line 145

def self.route_key(record_or_class)
  model_name_from_record_or_class(record_or_class).route_key
end

.singular(record_or_class) ⇒ Object

Returns the singular class name of a record or class. Examples:

ActiveModel::Naming.singular(post)             # => "post"
ActiveModel::Naming.singular(Highrise::Person) # => "highrise_person"



110
111
112
 
# File 'activemodel/lib/active_model/naming.rb', line 110

def self.singular(record_or_class)
  model_name_from_record_or_class(record_or_class).singular
end

.singular_route_key(record_or_class) ⇒ Object

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) #=> post

For shared engine: ActiveModel::Naming.route_key(Blog::Post) #=> blog_post



130
131
132
 
# File 'activemodel/lib/active_model/naming.rb', line 130

def self.singular_route_key(record_or_class)
  model_name_from_record_or_class(record_or_class).singular_route_key
end

.uncountable?(record_or_class) ⇒ Boolean

Identifies whether the class name of a record or class is uncountable. Examples:

ActiveModel::Naming.uncountable?(Sheep) # => true
ActiveModel::Naming.uncountable?(Post) => false

Returns:

  • (Boolean) 


118
119
120
 
# File 'activemodel/lib/active_model/naming.rb', line 118

def self.uncountable?(record_or_class)
  plural(record_or_class) == singular(record_or_class)
end

Instance Method Details

#model_name ⇒ Object

Returns an ActiveModel::Name object for module. It can be used to retrieve all kinds of naming-related information.



89
90
91
92
93
94
95
96
 
# File 'activemodel/lib/active_model/naming.rb', line 89

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