Module: ActiveModel::Naming

Included in:
Translation
Defined in:
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

.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"



73
74
75
 
# File 'lib/active_model/naming.rb', line 73

def self.plural(record_or_class)
  model_name_from_record_or_class(record_or_class).plural
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"



81
82
83
 
# File 'lib/active_model/naming.rb', line 81

def self.singular(record_or_class)
  model_name_from_record_or_class(record_or_class).singular
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) 


89
90
91
 
# File 'lib/active_model/naming.rb', line 89

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.



65
66
67
 
# File 'lib/active_model/naming.rb', line 65

def model_name
  @_model_name ||= ActiveModel::Name.new(self)
end