Module: ActiveModel::Serialization

Included in:
ActiveModel::Serializers::JSON, ActiveModel::Serializers::Xml
Defined in:
activemodel/lib/active_model/serialization.rb

Overview

Active Model Serialization

Provides a basic serialization to a serializable_hash for your object.

A minimal implementation could be:

class Person

  include ActiveModel::Serialization

  attr_accessor :name

  def attributes
    {'name' => name}
  end

end

Which would provide you with:

person = Person.new
person.serializable_hash   # => {"name"=>nil}
person.name = "Bob"
person.serializable_hash   # => {"name"=>"Bob"}

You need to declare some sort of attributes hash which contains the attributes you want to serialize and their current value.

Most of the time though, you will want to include the JSON or XML serializations. Both of these modules automatically include the ActiveModel::Serialization module, so there is no need to explicitly include it.

So a minimal implementation including XML and JSON would be:

class Person

  include ActiveModel::Serializers::JSON
  include ActiveModel::Serializers::Xml

  attr_accessor :name

  def attributes
    {'name' => name}
  end

end

Which would provide you with:

person = Person.new
person.serializable_hash   # => {"name"=>nil}
person.as_json             # => {"name"=>nil}
person.to_json             # => "{\"name\":null}"
person.to_xml              # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<serial-person...

person.name = "Bob"
person.serializable_hash   # => {"name"=>"Bob"}
person.as_json             # => {"name"=>"Bob"}
person.to_json             # => "{\"name\":\"Bob\"}"
person.to_xml              # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<serial-person...

Valid options are :only, :except and :methods .

Instance Method Summary collapse

Instance Method Details

#serializable_hash(options = nil) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'activemodel/lib/active_model/serialization.rb', line 71

def serializable_hash(options = nil)
  options ||= {}

  attribute_names = attributes.keys.sort
  if only = options[:only]
    attribute_names &= Array.wrap(only).map(&:to_s)
  elsif except = options[:except]
    attribute_names -= Array.wrap(except).map(&:to_s)
  end

  hash = {}
  attribute_names.each { |n| hash[n] = read_attribute_for_serialization(n) }

  method_names = Array.wrap(options[:methods]).select { |n| respond_to?(n) }
  method_names.each { |n| hash[n] = send(n) }

  serializable_add_includes(options) do |association, records, opts|
    hash[association] = if records.is_a?(Enumerable)
      records.map { |a| a.serializable_hash(opts) }
    else
      records.serializable_hash(opts)
    end
  end

  hash
end