Module: CouchFoo::Serialization

Defined in:
lib/couch_foo/serialization.rb,
lib/couch_foo/serializers/xml_serializer.rb,
lib/couch_foo/serializers/json_serializer.rb

Defined Under Namespace

Modules: ClassMethods Classes: JsonSerializer, Serializer

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



3
4
5
6
 
# File 'lib/couch_foo/serializers/json_serializer.rb', line 3

def self.included(base)
  base.cattr_accessor :include_root_in_json, :instance_writer => false
  base.extend ClassMethods
end

Instance Method Details

#from_json(json) ⇒ Object 



63
64
65
66
 
# File 'lib/couch_foo/serializers/json_serializer.rb', line 63

def from_json(json)
  self.attributes = ActiveSupport::JSON.decode(json)
  self
end

#from_xml(xml) ⇒ Object 



159
160
161
162
 
# File 'lib/couch_foo/serializers/xml_serializer.rb', line 159

def from_xml(xml)
  self.attributes = Hash.from_xml(xml).values.first
  self
end

#to_json(options = {}) ⇒ Object

Returns a JSON string representing the model. Some configuration is available through options.

Without any options, the returned JSON string will include all the model’s attributes. For example:

konata = User.find(1)
konata.to_json
# => {"id": 1, "name": "Konata Izumi", "age": 16,
      "created_at": "2006/08/01", "awesome": true}

The :only and :except options can be used to limit the attributes included, and work similar to the attributes method. For example:

konata.to_json(:only => [ :id, :name ])
# => {"id": 1, "name": "Konata Izumi"}

konata.to_json(:except => [ :id, :created_at, :age ])
# => {"name": "Konata Izumi", "awesome": true}

To include any methods on the model, use :methods.

konata.to_json(:methods => :permalink)
# => {"id": 1, "name": "Konata Izumi", "age": 16,
      "created_at": "2006/08/01", "awesome": true,
      "permalink": "1-konata-izumi"}

To include associations, use :include.

konata.to_json(:include => :posts)
# => {"id": 1, "name": "Konata Izumi", "age": 16,
      "created_at": "2006/08/01", "awesome": true,
      "posts": [{"id": 1, "author_id": 1, "title": "Welcome to the weblog"},
                {"id": 2, author_id: 1, "title": "So I was thinking"}]}

2nd level and higher order associations work as well:

konata.to_json(:include => { :posts => {
                               :include => { :comments => {
                                             :only => :body } },
                               :only => :title } })
# => {"id": 1, "name": "Konata Izumi", "age": 16,
      "created_at": "2006/08/01", "awesome": true,
      "posts": [{"comments": [{"body": "1st post!"}, {"body": "Second!"}],
                 "title": "Welcome to the weblog"},
                {"comments": [{"body": "Don't think too hard"}],
                 "title": "So I was thinking"}]}



55
56
57
58
59
60
61
 
# File 'lib/couch_foo/serializers/json_serializer.rb', line 55

def to_json(options = {})
  if include_root_in_json
    "{#{self.class.json_class_name}: #{JsonSerializer.new(self, options).to_s}}"
  else
    JsonSerializer.new(self, options).to_s
  end
end

#to_xml(options = {}, &block) ⇒ Object

Builds an XML document to represent the model. Some configuration is available through options. However more complicated cases should override CouchFoo::Base#to_xml. This is a necessary step if you wish to use custom types

By default the generated XML document will include the processing instruction and all the object’s attributes. For example:

<?xml version="1.0" encoding="UTF-8"?>
<topic>
  <title>The First Topic</title>
  <author-name>David</author-name>
  <id type="integer">1</id>
  <approved type="boolean">false</approved>
  <replies-count type="integer">0</replies-count>
  <bonus-time type="datetime">2000-01-01T08:28:00+12:00</bonus-time>
  <written-on type="datetime">2003-07-16T09:28:00+1200</written-on>
  <content>Have a nice day</content>
  <author-email-address>[email protected]</author-email-address>
  <parent-id></parent-id>
  <last-read type="date">2004-04-15</last-read>
</topic>

This behavior can be controlled with :only, :except, :skip_instruct, :skip_types and :dasherize. The :only and :except options are the same as for the attributes method. The default is to dasherize all column names, but you can disable this setting :dasherize to false. To not have the column type included in the XML output set :skip_types to true.

For instance:

topic.to_xml(:skip_instruct => true, :except => [ :id, :bonus_time, :written_on, :replies_count ])

<topic>
  <title>The First Topic</title>
  <author-name>David</author-name>
  <approved type="boolean">false</approved>
  <content>Have a nice day</content>
  <author-email-address>[email protected]</author-email-address>
  <parent-id></parent-id>
  <last-read type="date">2004-04-15</last-read>
</topic>

To include first level associations use :include:

firm.to_xml :include => [ :account, :clients ]

<?xml version="1.0" encoding="UTF-8"?>
<firm>
  <id type="integer">1</id>
  <rating type="integer">1</rating>
  <name>37signals</name>
  <clients type="array">
    <client>
      <rating type="integer">1</rating>
      <name>Summit</name>
    </client>
    <client>
      <rating type="integer">1</rating>
      <name>Microsoft</name>
    </client>
  </clients>
  <account>
    <id type="integer">1</id>
    <credit-limit type="integer">50</credit-limit>
  </account>
</firm>

To include deeper levels of associations pass a hash like this:

firm.to_xml :include => {:account => {}, :clients => {:include => :address}}
<?xml version="1.0" encoding="UTF-8"?>
<firm>
  <id type="integer">1</id>
  <rating type="integer">1</rating>
  <name>37signals</name>
  <clients type="array">
    <client>
      <rating type="integer">1</rating>
      <name>Summit</name>
      <address>
        ...
      </address>
    </client>
    <client>
      <rating type="integer">1</rating>
      <name>Microsoft</name>
      <address>
        ...
      </address>
    </client>
  </clients>
  <account>
    <id type="integer">1</id>
    <credit-limit type="integer">50</credit-limit>
  </account>
</firm>

To include any methods on the model being called use :methods:

firm.to_xml :methods => [ :calculated_earnings, :real_earnings ]

<firm>
  # ... normal attributes as shown above ...
  <calculated-earnings>100000000000000000</calculated-earnings>
  <real-earnings>5</real-earnings>
</firm>

To call any additional Procs use :procs. The Procs are passed a modified version of the options hash that was given to to_xml:

proc = Proc.new { |options| options[:builder].tag!('abc', 'def') }
firm.to_xml :procs => [ proc ]

<firm>
  # ... normal attributes as shown above ...
  <abc>def</abc>
</firm>

Alternatively, you can yield the builder object as part of the to_xml call:

firm.to_xml do |xml|
  xml.creator do
    xml.first_name "David"
    xml.last_name "Heinemeier Hansson"
  end
end

<firm>
  # ... normal attributes as shown above ...
  <creator>
    <first_name>David</first_name>
    <last_name>Heinemeier Hansson</last_name>
  </creator>
</firm>

As noted above, you may override to_xml in your CouchFoo::Base subclasses to have complete control about what’s generated. The general form of doing this is:

class IHaveMyOwnXML < CouchFoo::Base
  def to_xml(options = {})
    options[:indent] ||= 2
    xml = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
    xml.instruct! unless options[:skip_instruct]
    xml.level_one do
      xml.tag!(:second_level, 'content')
    end
  end
end



154
155
156
157
 
# File 'lib/couch_foo/serializers/xml_serializer.rb', line 154

def to_xml(options = {}, &block)
  serializer = XmlSerializer.new(self, options)
  block_given? ? serializer.to_s(&block) : serializer.to_s
end