Active Model – интерфейсы моделей для Rails

Active Model предоставляет известный набор интерфейсов для использования в классах моделей. Например, они позволяют помощникам Action Pack взаимодействовать с моделями, не являющимися Active Record. Active Model также помогает создавать пользовательские ORM для использования вне фреймворка Rails.

Подробнее об Active Model можно прочитать в руководстве Основы Active Model.

До Rails 3.0 разработчику плагина или гем-пакета, желавшему, чтобы объект взаимодействовал с помощниками Action Pack, приходилось либо копировать фрагменты кода из Rails, либо обезьянить целые помощники, чтобы они могли работать с объектами, которые не полностью соответствовали интерфейсу Active Record. Это приводило к дублированию кода и ненадёжным приложениям, которые переставали работать после обновлений. Active Model решает эту проблему, определяя явный API. Подробнее о API можно прочитать в разделе ActiveModel::Lint::Tests.

Active Model предоставляет модуль по умолчанию, реализующий базовый API, необходимый для взаимодействия с Action Pack «из коробки»: ActiveModel::API.

class Person
  include ActiveModel::API

  attr_accessor :name, :age
  validates_presence_of :name
end

person = Person.new(name: 'bob', age: '18')
person.name   # => 'bob'
person.age    # => '18'
person.valid? # => true

Он включает интроспекцию имён моделей, преобразования, переводы и валидации, в результате чего получается класс, подходящий для использования с Action Pack. Дополнительные примеры см. в разделе ActiveModel::API.

Active Model также предоставляет следующие возможности, обеспечивающие поведение ORM «из коробки»:

• Добавление в объекты магии атрибутов

  class Person
    include ActiveModel::AttributeMethods
  
    attribute_method_prefix 'clear_'
    define_attribute_methods :name, :age
  
    attr_accessor :name, :age
  
    def clear_attribute(attr)
      send("#{attr}=", nil)
    end
  end
  
  person = Person.new
  person.clear_name
  person.clear_age
  

  Подробнее

• Callbacks для определённых операций

  class Person
    extend ActiveModel::Callbacks
    define_model_callbacks :create
  
    def create
      run_callbacks :create do
        # Your create action methods here
      end
    end
  end
  

  Это создаёт методы класса before_create, around_create и after_create, оборачивающие ваш метод создания.

  Подробнее

• Отслеживание изменений значений

  class Person
    include ActiveModel::Dirty
  
    define_attribute_methods :name
  
    def name
      @name
    end
  
    def name=(val)
      name_will_change! unless val == @name
      @name = val
    end
  
    def save
      # do persistence work
      changes_applied
    end
  end
  
  person = Person.new
  person.name             # => nil
  person.changed?         # => false
  person.name = 'bob'
  person.changed?         # => true
  person.changed          # => ['name']
  person.changes          # => { 'name' => [nil, 'bob'] }
  person.save
  person.name = 'robert'
  person.save
  person.previous_changes # => {'name' => ['bob, 'robert']}
  

  Подробнее

• Добавление интерфейса errors к объектам

  Предоставление сообщений об ошибках позволяет объектам беспрепятственно взаимодействовать с помощниками Action Pack.

  class Person
  
    def initialize
      @errors = ActiveModel::Errors.new(self)
    end
  
    attr_accessor :name
    attr_reader   :errors
  
    def validate!
      errors.add(:name, "cannot be nil") if name.nil?
    end
  
    def self.human_attribute_name(attr, options = {})
      "Name"
    end
  end
  
  person = Person.new
  person.name = nil
  person.validate!
  person.errors.full_messages
  # => ["Name cannot be nil"]
  

  Подробнее

• Интроспекция имён Model

  class NamedPerson
    extend ActiveModel::Naming
  end
  
  NamedPerson.model_name.name   # => "NamedPerson"
  NamedPerson.model_name.human  # => "Named person"
  

  Подробнее

• Сериализация объектов

  ActiveModel::Serialization предоставляет стандартный интерфейс, позволяющий объекту выполнять сериализацию to_json.

  class SerialPerson
    include ActiveModel::Serialization
  
    attr_accessor :name
  
    def attributes
      {'name' => name}
    end
  end
  
  s = SerialPerson.new
  s.serializable_hash   # => {"name"=>nil}
  
  class SerialPerson
    include ActiveModel::Serializers::JSON
  end
  
  s = SerialPerson.new
  s.to_json             # => "{\"name\":null}"
  

  Подробнее

• Поддержка интернационализации (i18n)

  class Person
    extend ActiveModel::Translation
  end
  
  Person.human_attribute_name('my_attribute')
  # => "My attribute"
  

  Подробнее

• Поддержка валидации

  class Person
    include ActiveModel::Validations
  
    attr_accessor :first_name, :last_name
  
    validates_each :first_name, :last_name do |record, attr, value|
      record.errors.add attr, "starts with z." if value.start_with?("z")
    end
  end
  
  person = Person.new
  person.first_name = 'zoolander'
  person.valid?  # => false
  

  Подробнее

• Пользовательские валидаторы

  class HasNameValidator < ActiveModel::Validator
    def validate(record)
      record.errors.add(:name, "must exist") if record.name.blank?
    end
  end
  
  class ValidatorPerson
    include ActiveModel::Validations
    validates_with HasNameValidator
    attr_accessor :name
  end
  
  p = ValidatorPerson.new
  p.valid?                  # =>  false
  p.errors.full_messages    # => ["Name must exist"]
  p.name = "Bob"
  p.valid?                  # =>  true
  

  Подробнее

Загрузка и установка

Последнюю версию Active Model можно установить с помощью RubyGems:

$ gem install activemodel

Исходный код можно скачать в составе проекта Rails на GitHub

• github.com/rails/rails/tree/main/activemodel

Лицензия

Active Model распространяется по лицензии MIT:

• opensource.org/licenses/MIT

Поддержка

Документация API находится по адресу:

• api.rubyonrails.org

Сообщить об ошибках в проекте Ruby on Rails можно здесь:

• github.com/rails/rails/issues

Предложения по новым функциям следует обсуждать на форуме rubyonrails-core здесь:

• discuss.rubyonrails.org/c/rubyonrails-core