serialize(attr_name, class_name = Object) public

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
    serialize :preferences
  end
Show source
Register or log in to add new notes.
November 12, 2008
0 thanks

Another Example

Do not mistakenly pass class_name as a key/value pair (Hash form). You will get an error including the text ‘class or module needed’. It should look like this: 

  serialize :some_array, Array

Or, perhaps clearer would be: 

  serialize(:some_array, Array)

That may seem obvious, but it is common to be in the habit of passing things as a key/value pair.