2007-02-10 00:12:31 +01:00
|
|
|
module ActiveRecord #:nodoc:
|
2007-12-21 08:48:59 +01:00
|
|
|
module Serialization
|
2008-05-18 06:22:34 +02:00
|
|
|
# Builds an XML document to represent the model. Some configuration is
|
|
|
|
# available through +options+. However more complicated cases should
|
|
|
|
# override ActiveRecord::Base#to_xml.
|
2007-02-10 00:12:31 +01:00
|
|
|
#
|
2007-12-21 08:48:59 +01:00
|
|
|
# By default the generated XML document will include the processing
|
2008-05-18 06:22:34 +02:00
|
|
|
# instruction and all the object's attributes. For example:
|
2007-12-21 08:48:59 +01:00
|
|
|
#
|
2007-02-10 00:12:31 +01:00
|
|
|
# <?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>david@loudthinking.com</author-email-address>
|
|
|
|
# <parent-id></parent-id>
|
|
|
|
# <last-read type="date">2004-04-15</last-read>
|
|
|
|
# </topic>
|
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# This behavior can be controlled with <tt>:only</tt>, <tt>:except</tt>,
|
2009-02-04 21:26:08 +01:00
|
|
|
# <tt>:skip_instruct</tt>, <tt>:skip_types</tt>, <tt>:dasherize</tt> and <tt>:camelize</tt> .
|
2008-05-18 06:22:34 +02:00
|
|
|
# The <tt>:only</tt> and <tt>:except</tt> options are the same as for the
|
|
|
|
# +attributes+ method. The default is to dasherize all column names, but you
|
2009-02-04 21:26:08 +01:00
|
|
|
# can disable this setting <tt>:dasherize</tt> to +false+. Setting <tt>:camelize</tt>
|
|
|
|
# to +true+ will camelize all column names - this also overrides <tt>:dasherize</tt>.
|
|
|
|
# To not have the column type included in the XML output set <tt>:skip_types</tt> to +true+.
|
2007-02-10 00:12:31 +01:00
|
|
|
#
|
|
|
|
# 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>david@loudthinking.com</author-email-address>
|
|
|
|
# <parent-id></parent-id>
|
|
|
|
# <last-read type="date">2004-04-15</last-read>
|
|
|
|
# </topic>
|
2007-12-21 08:48:59 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# To include first level associations use <tt>:include</tt>:
|
2007-02-10 00:12:31 +01:00
|
|
|
#
|
|
|
|
# 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>
|
2007-12-21 08:48:59 +01:00
|
|
|
# <clients type="array">
|
2007-02-10 00:12:31 +01:00
|
|
|
# <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>
|
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# 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 <tt>:methods</tt>:
|
2007-02-10 00:12:31 +01:00
|
|
|
#
|
|
|
|
# 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>
|
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# To call any additional Procs use <tt>:procs</tt>. The Procs are passed a
|
|
|
|
# modified version of the options hash that was given to +to_xml+:
|
2007-02-10 00:12:31 +01:00
|
|
|
#
|
|
|
|
# proc = Proc.new { |options| options[:builder].tag!('abc', 'def') }
|
|
|
|
# firm.to_xml :procs => [ proc ]
|
|
|
|
#
|
|
|
|
# <firm>
|
|
|
|
# # ... normal attributes as shown above ...
|
|
|
|
# <abc>def</abc>
|
|
|
|
# </firm>
|
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# Alternatively, you can yield the builder object as part of the +to_xml+ call:
|
2007-12-21 08:48:59 +01:00
|
|
|
#
|
|
|
|
# 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>
|
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# As noted above, you may override +to_xml+ in your ActiveRecord::Base
|
|
|
|
# subclasses to have complete control about what's generated. The general
|
|
|
|
# form of doing this is:
|
2007-02-10 00:12:31 +01:00
|
|
|
#
|
|
|
|
# class IHaveMyOwnXML < ActiveRecord::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
|
2007-12-21 08:48:59 +01:00
|
|
|
def to_xml(options = {}, &block)
|
|
|
|
serializer = XmlSerializer.new(self, options)
|
|
|
|
block_given? ? serializer.to_s(&block) : serializer.to_s
|
2007-02-10 00:12:31 +01:00
|
|
|
end
|
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
def from_xml(xml)
|
|
|
|
self.attributes = Hash.from_xml(xml).values.first
|
|
|
|
self
|
2007-02-10 00:12:31 +01:00
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
end
|
|
|
|
|
|
|
|
class XmlSerializer < ActiveRecord::Serialization::Serializer #:nodoc:
|
2007-02-10 00:12:31 +01:00
|
|
|
def builder
|
|
|
|
@builder ||= begin
|
|
|
|
options[:indent] ||= 2
|
|
|
|
builder = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
|
|
|
|
|
|
|
|
unless options[:skip_instruct]
|
|
|
|
builder.instruct!
|
|
|
|
options[:skip_instruct] = true
|
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
builder
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def root
|
2009-09-05 09:01:46 +02:00
|
|
|
root = (options[:root] || @record.class.model_name.singular).to_s
|
2009-02-04 21:26:08 +01:00
|
|
|
reformat_name(root)
|
2007-02-10 00:12:31 +01:00
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
def dasherize?
|
|
|
|
!options.has_key?(:dasherize) || options[:dasherize]
|
|
|
|
end
|
|
|
|
|
2009-02-04 21:26:08 +01:00
|
|
|
def camelize?
|
|
|
|
options.has_key?(:camelize) && options[:camelize]
|
|
|
|
end
|
|
|
|
|
|
|
|
def reformat_name(name)
|
|
|
|
name = name.camelize if camelize?
|
|
|
|
dasherize? ? name.dasherize : name
|
|
|
|
end
|
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
def serializable_attributes
|
2007-12-21 08:48:59 +01:00
|
|
|
serializable_attribute_names.collect { |name| Attribute.new(name, @record) }
|
2007-02-10 00:12:31 +01:00
|
|
|
end
|
|
|
|
|
|
|
|
def serializable_method_attributes
|
2007-12-21 08:48:59 +01:00
|
|
|
Array(options[:methods]).inject([]) do |method_attributes, name|
|
|
|
|
method_attributes << MethodAttribute.new(name.to_s, @record) if @record.respond_to?(name.to_s)
|
|
|
|
method_attributes
|
|
|
|
end
|
2007-02-10 00:12:31 +01:00
|
|
|
end
|
|
|
|
|
|
|
|
def add_attributes
|
|
|
|
(serializable_attributes + serializable_method_attributes).each do |attribute|
|
|
|
|
add_tag(attribute)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def add_procs
|
|
|
|
if procs = options.delete(:procs)
|
|
|
|
[ *procs ].each do |proc|
|
|
|
|
proc.call(options)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def add_tag(attribute)
|
|
|
|
builder.tag!(
|
2009-02-04 21:26:08 +01:00
|
|
|
reformat_name(attribute.name),
|
2007-12-21 08:48:59 +01:00
|
|
|
attribute.value.to_s,
|
2007-02-10 00:12:31 +01:00
|
|
|
attribute.decorations(!options[:skip_types])
|
|
|
|
)
|
|
|
|
end
|
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
def add_associations(association, records, opts)
|
|
|
|
if records.is_a?(Enumerable)
|
2009-02-04 21:26:08 +01:00
|
|
|
tag = reformat_name(association.to_s)
|
2009-03-16 15:55:30 +01:00
|
|
|
type = options[:skip_types] ? {} : {:type => "array"}
|
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
if records.empty?
|
2009-03-16 15:55:30 +01:00
|
|
|
builder.tag!(tag, type)
|
2007-12-21 08:48:59 +01:00
|
|
|
else
|
2009-03-16 15:55:30 +01:00
|
|
|
builder.tag!(tag, type) do
|
2007-12-21 08:48:59 +01:00
|
|
|
association_name = association.to_s.singularize
|
|
|
|
records.each do |record|
|
2009-03-16 15:55:30 +01:00
|
|
|
if options[:skip_types]
|
|
|
|
record_type = {}
|
|
|
|
else
|
|
|
|
record_class = (record.class.to_s.underscore == association_name) ? nil : record.class.name
|
|
|
|
record_type = {:type => record_class}
|
|
|
|
end
|
|
|
|
|
|
|
|
record.to_xml opts.merge(:root => association_name).merge(record_type)
|
2007-12-21 08:48:59 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
else
|
|
|
|
if record = @record.send(association)
|
|
|
|
record.to_xml(opts.merge(:root => association))
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
def serialize
|
|
|
|
args = [root]
|
|
|
|
if options[:namespace]
|
|
|
|
args << {:xmlns=>options[:namespace]}
|
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
|
|
|
|
if options[:type]
|
|
|
|
args << {:type=>options[:type]}
|
|
|
|
end
|
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
builder.tag!(*args) do
|
|
|
|
add_attributes
|
2007-12-21 08:48:59 +01:00
|
|
|
procs = options.delete(:procs)
|
|
|
|
add_includes { |association, records, opts| add_associations(association, records, opts) }
|
|
|
|
options[:procs] = procs
|
2007-02-10 00:12:31 +01:00
|
|
|
add_procs
|
2007-12-21 08:48:59 +01:00
|
|
|
yield builder if block_given?
|
2007-02-10 00:12:31 +01:00
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
end
|
2007-02-10 00:12:31 +01:00
|
|
|
|
|
|
|
class Attribute #:nodoc:
|
|
|
|
attr_reader :name, :value, :type
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
def initialize(name, record)
|
|
|
|
@name, @record = name, record
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
@type = compute_type
|
|
|
|
@value = compute_value
|
|
|
|
end
|
|
|
|
|
|
|
|
# There is a significant speed improvement if the value
|
2008-06-02 08:35:38 +02:00
|
|
|
# does not need to be escaped, as <tt>tag!</tt> escapes all values
|
2008-05-18 06:22:34 +02:00
|
|
|
# to ensure that valid XML is generated. For known binary
|
2007-02-10 00:12:31 +01:00
|
|
|
# values, it is at least an order of magnitude faster to
|
|
|
|
# Base64 encode binary values and directly put them in the
|
|
|
|
# output XML than to pass the original value or the Base64
|
2008-06-02 08:35:38 +02:00
|
|
|
# encoded value to the <tt>tag!</tt> method. It definitely makes
|
2007-02-10 00:12:31 +01:00
|
|
|
# no sense to Base64 encode the value and then give it to
|
2008-06-02 08:35:38 +02:00
|
|
|
# <tt>tag!</tt>, since that just adds additional overhead.
|
2007-02-10 00:12:31 +01:00
|
|
|
def needs_encoding?
|
|
|
|
![ :binary, :date, :datetime, :boolean, :float, :integer ].include?(type)
|
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
def decorations(include_types = true)
|
|
|
|
decorations = {}
|
|
|
|
|
|
|
|
if type == :binary
|
|
|
|
decorations[:encoding] = 'base64'
|
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
if include_types && type != :string
|
|
|
|
decorations[:type] = type
|
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
|
|
|
|
if value.nil?
|
|
|
|
decorations[:nil] = true
|
|
|
|
end
|
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
decorations
|
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
protected
|
|
|
|
def compute_type
|
2009-09-05 09:01:46 +02:00
|
|
|
type = if @record.class.serialized_attributes.has_key?(name)
|
|
|
|
:yaml
|
|
|
|
else
|
|
|
|
@record.class.columns_hash[name].try(:type)
|
|
|
|
end
|
2007-02-10 00:12:31 +01:00
|
|
|
|
|
|
|
case type
|
|
|
|
when :text
|
|
|
|
:string
|
|
|
|
when :time
|
|
|
|
:datetime
|
|
|
|
else
|
|
|
|
type
|
|
|
|
end
|
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
def compute_value
|
|
|
|
value = @record.send(name)
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2007-02-10 00:12:31 +01:00
|
|
|
if formatter = Hash::XML_FORMATTING[type.to_s]
|
|
|
|
value ? formatter.call(value) : nil
|
|
|
|
else
|
|
|
|
value
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
class MethodAttribute < Attribute #:nodoc:
|
|
|
|
protected
|
|
|
|
def compute_type
|
|
|
|
Hash::XML_TYPE_NAMES[@record.send(name).class.name] || :string
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|