Spec-Zone.ru › Ruby on Rails 6.1

модуль ActiveRecord::Store

Store предоставляет тонкий обертка вокруг serialize для хранения хэшей в одном столбце. Это как простая база данных ключ/значение, встроенная в вашу запись, когда вам не нужно иметь возможность запросить эту базу данных вне контекста одной записи.

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

Каждый аксессор поставляется с методами отслеживания изменений (key_changed?, key_was и key_change) и методами доступа к изменениям, внесённым во время последней сохранения (saved_change_to_key?, saved_change_to_key и key_before_last_save).

ПРИМЕЧАНИЕ: Нет метода key_will_change! для аксессоров, используйте store_will_change! вместо него.

Убедитесь, что вы объявляете столбец базы данных, используемый для сериализованного хранилища, как текстовый, чтобы было достаточно места.

Вы можете установить пользовательский кодировщик для кодирования/декодирования ваших сериализованных атрибутов в различные форматы. JSON, YAML, Marshal поддерживаются по умолчанию. В целом это может быть любой обертка, которая предоставляет load и dump.

ПРИМЕЧАНИЕ: Если вы используете структурированные типы данных базы данных (например, PostgreSQL hstore/json, или MySQL 5.7+ json) вам не нужно сериализация, предоставляемая .store. Просто используйте .store_accessor вместо этого, чтобы сгенерировать методы аксессоров. Обратите внимание, что эти столбцы используют хеш с ключами-строками и не позволяют доступа с использованием символов.

ПРИМЕЧАНИЕ: По умолчанию валидации, за исключением uniqueness, будут работать. Например, если вы хотите проверить uniqueness с помощью hstore, вам нужно будет использовать пользовательскую валидацию для обработки этого.

Примеры:

class User < ActiveRecord::Base
  store :settings, accessors: [ :color, :homepage ], coder: JSON
  store :parent, accessors: [ :name ], coder: JSON, prefix: true
  store :spouse, accessors: [ :name ], coder: JSON, prefix: :partner
  store :settings, accessors: [ :two_factor_auth ], suffix: true
  store :settings, accessors: [ :login_retry ], suffix: :config
end

u = User.new(color: 'black', homepage: '37signals.com', parent_name: 'Mary', partner_name: 'Lily')
u.color                          # Accessor stored attribute
u.parent_name                    # Accessor stored attribute with prefix
u.partner_name                   # Accessor stored attribute with custom prefix
u.two_factor_auth_settings       # Accessor stored attribute with suffix
u.login_retry_config             # Accessor stored attribute with custom suffix
u.settings[:country] = 'Denmark' # Any attribute, even if not specified with an accessor

# There is no difference between strings and symbols for accessing custom attributes
u.settings[:country]  # => 'Denmark'
u.settings['country'] # => 'Denmark'

# Dirty tracking
u.color = 'green'
u.color_changed? # => true
u.color_was # => 'black'
u.color_change # => ['black', 'red']

# Add additional accessors to an existing store through store_accessor
class SuperUser < User
  store_accessor :settings, :privileges, :servants
  store_accessor :parent, :birthday, prefix: true
  store_accessor :settings, :secret_question, suffix: :config
end

Имена хранимых атрибутов можно получить с помощью .stored_attributes.

User.stored_attributes[:settings] # [:color, :homepage, :two_factor_auth, :login_retry]

Переопределение аксессоров по умолчанию

Все сохранённые значения автоматически доступны через аксессоры объекта Active Record, но иногда вам нужно специализировать это поведение. Это можно сделать, переопределив аксессоры по умолчанию (используя то же имя, что и атрибут) и вызвав super для фактического изменения.

class Song < ActiveRecord::Base
  # Uses a stored integer to hold the volume adjustment of the song
  store :settings, accessors: [:volume_adjustment]

  def volume_adjustment=(decibels)
    super(decibels.to_i)
  end

  def volume_adjustment
    super.to_i
  end
end

Атрибуты

local_stored_attributes[RW]

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

read_store_attribute(store_attribute, key) Показать исходный код
# File activerecord/lib/active_record/store.rb, line 206
def read_store_attribute(store_attribute, key) # :doc:
  accessor = store_accessor_for(store_attribute)
  accessor.read(self, store_attribute, key)
end
write_store_attribute(store_attribute, key, value) Показать исходный код
# File activerecord/lib/active_record/store.rb, line 211
def write_store_attribute(store_attribute, key, value) # :doc:
  accessor = store_accessor_for(store_attribute)
  accessor.write(self, store_attribute, key, value)
end

© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API