Module | Sequel::Plugins::XmlSerializer::InstanceMethods |
In: |
lib/sequel/plugins/xml_serializer.rb
|
Update the contents of this instance based on the given XML. Accepts the following options:
:name_proc : | Proc or Hash that accepts a string and returns a string, used to convert tag names to column or association names. |
:underscore : | Sets the :name_proc option to one that calls underscore on the input string. Requires that you load the inflector extension or another library that adds String#underscore. |
# File lib/sequel/plugins/xml_serializer.rb, line 185 185: def from_xml(xml, opts={}) 186: from_xml_node(Nokogiri::XML(xml).children.first, opts) 187: end
Update the contents of this instance based on the given XML node, which should be a Nokogiri::XML::Node instance.
# File lib/sequel/plugins/xml_serializer.rb, line 191 191: def from_xml_node(parent, opts={}) 192: cols = model.columns.map{|x| x.to_s} 193: assocs = {} 194: model.associations.map{|x| assocs[x.to_s] = model.association_reflection(x)} 195: meths = send(:setter_methods, nil, nil) 196: name_proc = model.xml_deserialize_name_proc(opts) 197: parent.children.each do |node| 198: next if node.is_a?(Nokogiri::XML::Text) 199: k = name_proc[node.name] 200: if ar = assocs[k] 201: klass = ar.associated_class 202: associations[k.to_sym] = if ar.returns_array? 203: node.children.reject{|c| c.is_a?(Nokogiri::XML::Text)}.map{|c| klass.from_xml_node(c)} 204: else 205: klass.from_xml_node(node) 206: end 207: elsif cols.include?(k) 208: self[k.to_sym] = node[:nil] ? nil : node.children.first.to_s 209: elsif meths.include?("#{k}=") 210: send("#{k}=", node[:nil] ? nil : node.children.first.to_s) 211: else 212: raise Error, "Entry in XML not an association or column and no setter method exists: #{k}" 213: end 214: end 215: self 216: end
Return a string in XML format. If a block is given, yields the XML builder object so you can add additional XML tags. Accepts the following options:
:builder : | The builder instance used to build the XML, which should be an instance of Nokogiri::XML::Node. This is necessary if you are serializing entire object graphs, like associated objects. |
:builder_opts : | Options to pass to the Nokogiri::XML::Builder initializer, if the :builder option is not provided. |
:camelize: | Sets the :name_proc option to one that calls camelize on the input string. Requires that you load the inflector extension or another library that adds String#camelize. |
:dasherize : | Sets the :name_proc option to one that calls dasherize on the input string. Requires that you load the inflector extension or another library that adds String#dasherize. |
:encoding : | The encoding to use for the XML output, passed to the Nokogiri::XML::Builder initializer. |
:except : | Symbol or Array of Symbols of columns not to include in the XML output. |
:include : | Symbol, Array of Symbols, or a Hash with Symbol keys and Hash values specifying associations or other non-column attributes to include in the XML output. Using a nested hash, you can pass options to associations to affect the XML used for associated objects. |
:name_proc : | Proc or Hash that accepts a string and returns a string, used to format tag names. |
:only : | Symbol or Array of Symbols of columns to only include in the JSON output, ignoring all other columns. |
:root_name : | The base name to use for the XML tag that contains the data for this instance. This will be the name of the root node if you are only serializing a single object, but not if you are serializing an array of objects using Model.to_xml or Dataset#to_xml. |
:types : | Set to true to include type information for all of the columns, pulled from the db_schema. |
# File lib/sequel/plugins/xml_serializer.rb, line 256 256: def to_xml(opts={}) 257: vals = values 258: types = opts[:types] 259: inc = opts[:include] 260: 261: cols = if only = opts[:only] 262: Array(only) 263: else 264: vals.keys - Array(opts[:except]) 265: end 266: 267: name_proc = model.xml_serialize_name_proc(opts) 268: x = model.xml_builder(opts) 269: x.send(name_proc[opts.fetch(:root_name, model.send(:underscore, model.name)).to_s]) do |x1| 270: cols.each do |c| 271: attrs = {} 272: if types 273: attrs[:type] = db_schema.fetch(c, {})[:type] 274: end 275: v = vals[c] 276: if v.nil? 277: attrs[:nil] = '' 278: end 279: x1.send(name_proc[c.to_s], v, attrs) 280: end 281: if inc.is_a?(Hash) 282: inc.each{|k, v| to_xml_include(x1, k, v)} 283: else 284: Array(inc).each{|i| to_xml_include(x1, i)} 285: end 286: yield x1 if block_given? 287: end 288: x.to_xml 289: end