Module: ActiveRecord::AttributeMethods::Serialization::ClassMethods

Defined in:
lib/active_record/attribute_methods/serialization.rb

Instance Method Summary collapse

Instance Method Details

#initialize_attributes(attributes, options = {}) ⇒ Object

:nodoc:


61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/active_record/attribute_methods/serialization.rb', line 61

def initialize_attributes(attributes, options = {}) #:nodoc:
  serialized = (options.delete(:serialized) { true }) ? :serialized : :unserialized
  super(attributes, options)

  serialized_attributes.each do |key, coder|
    if attributes.key?(key)
      attributes[key] = Attribute.new(coder, attributes[key], serialized)
    end
  end

  attributes
end

#serialize(attr_name, class_name = Object) ⇒ Object

If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object, then specify the name of that attribute using this method and it will be handled automatically. The serialization is done through YAML. If class_name is specified, the serialized object must be of that class on retrieval or SerializationTypeMismatch will be raised.

Parameters

  • attr_name - The field name that should be serialized.

  • class_name - Optional, class name that the object type should be equal to.

Example

# Serialize a preferences attribute
class User < ActiveRecord::Base
  serialize :preferences
end

49
50
51
52
53
54
55
56
57
58
59
# File 'lib/active_record/attribute_methods/serialization.rb', line 49

def serialize(attr_name, class_name = Object)
  coder = if [:load, :dump].all? { |x| class_name.respond_to?(x) }
            class_name
          else
            Coders::YAMLColumn.new(class_name)
          end

  # merge new serialized attribute and create new hash to ensure that each class in inheritance hierarchy
  # has its own hash of own serialized attributes
  self.serialized_attributes = serialized_attributes.merge(attr_name.to_s => coder)
end