module Sequel::Plugins::XmlSerializer::ClassMethods

  1. lib/sequel/plugins/xml_serializer.rb
Parent: XmlSerializer

Constants

CAMELIZE = proc{|s| s.camelize}  

Proc that camelizes the input string, used for the :camelize option
DASHERIZE = proc{|s| s.dasherize}  

Proc that dasherizes the input string, used for the :dasherize option
IDENTITY = proc{|s| s}  

Proc that returns the input string as is, used if no :name_proc, :dasherize, or :camelize option is used.
UNDERSCORE = proc{|s| s.underscore}  

Proc that underscores the input string, used for the :underscore option

Public Instance methods

array_from_xml (xml, opts=OPTS)

Return an array of instances of this class based on the provided XML.

[show source] 
# File lib/sequel/plugins/xml_serializer.rb, line 130
def array_from_xml(xml, opts=OPTS)
  node = Nokogiri::XML(xml).children.first
  unless node 
    raise Error, "Malformed XML used"
  end
  node.children.reject{|c| c.is_a?(Nokogiri::XML::Text)}.map{|c| from_xml_node(c, opts)}
end
from_xml (xml, opts=OPTS)

Return an instance of this class based on the provided XML.

[show source] 
# File lib/sequel/plugins/xml_serializer.rb, line 140
def from_xml(xml, opts=OPTS)
  from_xml_node(Nokogiri::XML(xml).children.first, opts)
end
from_xml_node (parent, opts=OPTS)

Return an instance of this class based on the given XML node, which should be Nokogiri::XML::Node instance. This should probably not be used directly by user code.

[show source] 
# File lib/sequel/plugins/xml_serializer.rb, line 147
def from_xml_node(parent, opts=OPTS)
  new.from_xml_node(parent, opts)
end
xml_builder (opts=OPTS)

Return an appropriate Nokogiri::XML::Builder instance used to create the XML. This should probably not be used directly by user code.

[show source] 
# File lib/sequel/plugins/xml_serializer.rb, line 154
def xml_builder(opts=OPTS)
  if opts[:builder]
    opts[:builder]
  else
    builder_opts = if opts[:builder_opts]
      opts[:builder_opts]
    else
      {}
    end
    builder_opts[:encoding] = opts[:encoding] if opts.has_key?(:encoding)
    Nokogiri::XML::Builder.new(builder_opts)
  end
end
xml_deserialize_name_proc (opts=OPTS)

Return a proc (or any other object that responds to []), used for formatting XML tag names when serializing to XML. This should probably not be used directly by user code.

[show source] 
# File lib/sequel/plugins/xml_serializer.rb, line 171
def xml_deserialize_name_proc(opts=OPTS)
  if opts[:name_proc]
    opts[:name_proc]
  elsif opts[:underscore]
    UNDERSCORE
  else
    IDENTITY
  end
end
xml_serialize_name_proc (opts=OPTS)

Return a proc (or any other object that responds to []), used for formatting XML tag names when serializing to XML. This should probably not be used directly by user code.

[show source] 
# File lib/sequel/plugins/xml_serializer.rb, line 184
def xml_serialize_name_proc(opts=OPTS)
  pr = if opts[:name_proc]
    opts[:name_proc]
  elsif opts[:dasherize]
    DASHERIZE
  elsif opts[:camelize]
    CAMELIZE
  else
    IDENTITY
  end
  proc{|s| "#{pr[s]}_"}
end