Active Model – Rails 的模型介面

Active Model 提供一組已知的介面，供模型類別使用。例如，它們允許 Action Pack 輔助程式與非 Active Record 模型互動。Active Model 也有助於建立自訂 ORM，供 Rails 架構外部使用。

您可以在 Active Model 基礎指南中閱讀更多關於 Active Model 的資訊。

在 Rails 3.0 之前，如果外掛程式或 gem 開發人員希望物件與 Action Pack 輔助程式互動，則必須從 Rails 中複製程式碼區塊，或修改整個輔助程式，使其處理不完全符合 Active Record 介面的物件。這將導致程式碼重複和容易損毀的應用程式，在升級時會中斷。Active Model 透過定義明確的 API 來解決此問題。您可以在 ActiveModel::Lint::Tests 中閱讀更多關於 API 的資訊。

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

了解更多

特定操作的回呼

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

了解更多

模型名稱內省

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

了解更多