модуль ActiveModel::Naming

Именование ActiveModel

Создаёт метод model_name в вашем объекте.

Для реализации просто расширьте ActiveModel::Naming в вашем объекте:

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"

Предоставление функциональности, которую предоставляет ActiveModel::Naming в вашем объекте, необходимо для прохождения теста Active Model Lint. Поэтому требуется либо расширить предоставленный ниже метод, либо реализовать свой.

Публичные методы класса

param_key(record_or_class) Показать исходный код

Возвращает строку для использования в именах параметров. Она отличается для именованных моделей в зависимости от того, находится ли она внутри изолированного движка.

# 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

plural(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

route_key(record_or_class) Показать исходный код

Возвращает строку для использования при генерации имён маршрутов. Она отличается для именованных моделей в зависимости от того, находится ли она внутри изолированного движка.

# For isolated engine:
ActiveModel::Naming.route_key(Blog::Post) # => "posts"

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

Ключ маршрута также учитывает, является ли существительное несчётным, и в таких случаях автоматически добавляет _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

singular(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

singular_route_key(record_or_class) Показать исходный код

# 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

uncountable?(record_or_class) Показать исходный код

Определяет, является ли имя класса записи или класса несчётным.

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

Публичные методы экземпляра

model_name() Показать исходный код

Возвращает объект ActiveModel::Name для модуля. Он может быть использован для получения всякой информации, связанной с именованием (см. ActiveModel::Name для дополнительной информации).

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