Агрегации Active Record

Active Record реализует агрегацию с помощью метода класса, похожего на макрос, который называется composed_of и позволяет представлять атрибуты в виде объектов-значений. Он описывает отношения вроде «Account [состоит] из Money [среди прочего]» или «Person [состоит] из [объекта] address». Каждый вызов макроса добавляет описание того, как объекты-значения создаются из атрибутов объекта-сущности (при инициализации сущности как нового объекта или при поиске уже существующего объекта) и как их можно преобразовать обратно в атрибуты (при сохранении сущности в базе данных).

class Customer < ActiveRecord::Base
  composed_of :balance, class_name: "Money", mapping: { balance: :amount }
  composed_of :address, mapping: { address_street: :street, address_city: :city }
end

Теперь у класса клиента есть следующие методы для работы с объектами-значениями:

• Customer#balance, Customer#balance=(money)

• Customer#address, Customer#address=(address)

Эти методы работают с объектами-значениями, подобными описанным ниже:

class Money
  include Comparable
  attr_reader :amount, :currency
  EXCHANGE_RATES = { "USD_TO_DKK" => 6 }

  def initialize(amount, currency = "USD")
    @amount, @currency = amount, currency
  end

  def exchange_to(other_currency)
    exchanged_amount = (amount * EXCHANGE_RATES["#{currency}_TO_#{other_currency}"]).floor
    Money.new(exchanged_amount, other_currency)
  end

  def ==(other_money)
    amount == other_money.amount && currency == other_money.currency
  end

  def <=>(other_money)
    if currency == other_money.currency
      amount <=> other_money.amount
    else
      amount <=> other_money.exchange_to(currency).amount
    end
  end
end

class Address
  attr_reader :street, :city
  def initialize(street, city)
    @street, @city = street, city
  end

  def close_to?(other_address)
    city == other_address.city
  end

  def ==(other_address)
    city == other_address.city && street == other_address.street
  end
end

Теперь вместо этого можно обращаться к атрибутам базы данных через объекты-значения. Если вы решите назвать композицию так же, как атрибут, это будет единственный способ обратиться к этому атрибуту. Именно так обстоит дело с нашим атрибутом balance. Вы работаете с объектами-значениями так же, как с любыми другими атрибутами:

customer.balance = Money.new(20)     # sets the Money value object and the attribute
customer.balance                     # => Money value object
customer.balance.exchange_to("DKK")  # => Money.new(120, "DKK")
customer.balance > Money.new(10)     # => true
customer.balance == Money.new(20)    # => true
customer.balance < Money.new(5)      # => false

Объекты-значения также могут состоять из нескольких атрибутов, как в случае с Address. Порядок сопоставлений определяет порядок параметров.

customer.address_street = "Hyancintvej"
customer.address_city   = "Copenhagen"
customer.address        # => Address.new("Hyancintvej", "Copenhagen")

customer.address = Address.new("May Street", "Chicago")
customer.address_street # => "May Street"
customer.address_city   # => "Chicago"

Создание объектов-значений

Объекты-значения — это неизменяемые и взаимозаменяемые объекты, представляющие заданное значение, например объект Money, представляющий $5. Два объекта Money, представляющие $5, должны быть равны (с помощью таких методов, как == и <=> из Comparable, если имеет смысл сравнение по порядку). Это отличается от объектов-сущностей, равенство которых определяется идентичностью. В классе-сущности, таком как Customer, легко могут существовать два разных объекта, у которых один и тот же адрес на Hyancintvej. Идентичность сущности определяется уникальными идентификаторами объекта или реляционной базы данных (например, первичными ключами). Обычные классы ActiveRecord::Base являются объектами-сущностями.

Также важно считать объекты-значения неизменяемыми. Не позволяйте менять сумму объекта Money после его создания. Вместо этого создайте новый объект Money с новым значением. Метод Money#exchange_to — пример такого подхода. Он возвращает новый объект-значение, а не изменяет собственные значения. Active Record не сохраняет объекты-значения, изменённые не с помощью метода записи.

Требование неизменяемости обеспечивается Active Record: любой объект, назначенный в качестве объекта-значения, замораживается. Попытка изменить его после этого приведёт к RuntimeError.

Подробнее об объектах-значениях см. на c2.com/cgi/wiki?ValueObject, а об опасности использования изменяемых объектов-значений — на c2.com/cgi/wiki?ValueObjectsShouldBeImmutable

Пользовательские конструкторы и преобразователи

По умолчанию объекты-значения инициализируются вызовом конструктора new класса значения, которому в качестве аргументов передаются все сопоставленные атрибуты в порядке, заданном параметром :mapping. Если класс значения не поддерживает такое соглашение, composed_of позволяет указать пользовательский конструктор.

При присваивании объекту-значению нового значения предполагается, что оно является экземпляром класса значения. Указав пользовательский преобразователь, можно автоматически преобразовать новое значение в экземпляр класса значения, если это необходимо.

Например, модель NetworkResource содержит атрибуты network_address и cidr_range, которые следует агрегировать с помощью класса значений NetAddr::CIDR (www.rubydoc.info/gems/netaddr/1.5.0/NetAddr/CIDR). Конструктор класса значений называется create и принимает в качестве параметра строку с адресом CIDR. Новые значения можно присваивать объекту-значению с помощью другого объекта NetAddr::CIDR, строки или массива. Для удовлетворения этих требований можно использовать параметры :constructor и :converter:

class NetworkResource < ActiveRecord::Base
  composed_of :cidr,
              class_name: 'NetAddr::CIDR',
              mapping: { network_address: :network, cidr_range: :bits },
              allow_nil: true,
              constructor: Proc.new { |network_address, cidr_range| NetAddr::CIDR.create("#{network_address}/#{cidr_range}") },
              converter: Proc.new { |value| NetAddr::CIDR.create(value.is_a?(Array) ? value.join('/') : value) }
end

# This calls the :constructor
network_resource = NetworkResource.new(network_address: '192.168.0.1', cidr_range: 24)

# These assignments will both use the :converter
network_resource.cidr = [ '192.168.2.1', 8 ]
network_resource.cidr = '192.168.0.1/24'

# This assignment won't use the :converter as the value is already an instance of the value class
network_resource.cidr = NetAddr::CIDR.create('192.168.2.1/8')

# Saving and then reloading will use the :constructor on reload
network_resource.save
network_resource.reload

Поиск записей по объекту-значению

После того как для модели задано отношение composed_of, записи можно загружать из базы данных, указывая экземпляр объекта-значения в хеше условий. В следующем примере выполняется поиск всех клиентов, у которых значение address_street равно «May Street», а значение address_city равно «Chicago»:

Customer.where(address: Address.new("May Street", "Chicago"))