require 'active_support/core_ext/array/wrap' require 'active_support/core_ext/class/attribute_accessors' require 'active_support/core_ext/array/conversions' require 'active_support/core_ext/hash/conversions' require 'active_support/core_ext/hash/slice' module ActiveModel # == Active Model XML Serializer module Serializers module Xml extend ActiveSupport::Concern include ActiveModel::Serialization class Serializer #:nodoc: class Attribute #:nodoc: attr_reader :name, :value, :type def initialize(name, serializable, raw_value=nil) @name, @serializable = name, serializable raw_value = raw_value.in_time_zone if raw_value.respond_to?(:in_time_zone) @value = raw_value || @serializable.send(name) @type = compute_type end def decorations decorations = {} decorations[:encoding] = 'base64' if type == :binary decorations[:type] = type unless type == :string decorations[:nil] = true if value.nil? decorations end protected def compute_type type = ActiveSupport::XmlMini::TYPE_NAMES[value.class.name] type ||= :string if value.respond_to?(:to_str) type ||= :yaml type end end class MethodAttribute < Attribute #:nodoc: end attr_reader :options def initialize(serializable, options = nil) @serializable = serializable @options = options ? options.dup : {} @options[:only] = Array.wrap(@options[:only]).map { |n| n.to_s } @options[:except] = Array.wrap(@options[:except]).map { |n| n.to_s } end # To replicate the behavior in ActiveRecord#attributes, :except # takes precedence over :only. If :only is not set # for a N level model but is set for the N+1 level models, # then because :except is set to a default value, the second # level model can have both :except and :only set. So if # :only is set, always delete :except. def attributes_hash attributes = @serializable.attributes if options[:only].any? attributes.slice(*options[:only]) elsif options[:except].any? attributes.except(*options[:except]) else attributes end end def serializable_attributes attributes_hash.map do |name, value| self.class::Attribute.new(name, @serializable, value) end end def serializable_methods Array.wrap(options[:methods]).map do |name| self.class::MethodAttribute.new(name.to_s, @serializable) if @serializable.respond_to?(name.to_s) end.compact end def serialize require 'builder' unless defined? ::Builder options[:indent] ||= 2 options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent]) @builder = options[:builder] @builder.instruct! unless options[:skip_instruct] root = (options[:root] || @serializable.class.model_name.element).to_s root = ActiveSupport::XmlMini.rename_key(root, options) args = [root] args << {:xmlns => options[:namespace]} if options[:namespace] args << {:type => options[:type]} if options[:type] && !options[:skip_types] @builder.tag!(*args) do add_attributes_and_methods add_extra_behavior add_procs yield @builder if block_given? end end private def add_extra_behavior end def add_attributes_and_methods (serializable_attributes + serializable_methods).each do |attribute| key = ActiveSupport::XmlMini.rename_key(attribute.name, options) ActiveSupport::XmlMini.to_tag(key, attribute.value, options.merge(attribute.decorations)) end end def add_procs if procs = options.delete(:procs) Array.wrap(procs).each do |proc| if proc.arity == 1 proc.call(options) else proc.call(options, @serializable) end end end end end # Returns XML representing the model. Configuration can be # passed through +options+. # # Without any +options+, the returned XML string will include all the model's # attributes. For example: # # konata = User.find(1) # konata.to_xml # # # # 1 # David # 16 # 2011-01-30T22:29:23Z # # # The :only and :except options can be used to limit the attributes # included, and work similar to the +attributes+ method. # # To include the result of some method calls on the model use :methods. # # To include associations use :include. # # For further documentation see activerecord/lib/active_record/serializers/xml_serializer.xml. def to_xml(options = {}, &block) Serializer.new(self, options).serialize(&block) end def from_xml(xml) self.attributes = Hash.from_xml(xml).values.first self end end end end