Skip to Content Skip to Search

module ActiveSupport::XmlMini

XmlMini

To use the much faster libxml parser:

gem "libxml-ruby"
XmlMini.backend = 'LibXML'

Constants

DEFAULT_ENCODINGS

{
"binary" => "base64"
} unless defined?(DEFAULT_ENCODINGS)

FORMATTING

{
"symbol"   => Proc.new { |symbol| symbol.to_s },
"date"     => Proc.new { |date| date.to_fs(:db) },
"dateTime" => Proc.new { |time| time.xmlschema },
"binary"   => Proc.new { |binary| ::Base64.encode64(binary) },
"yaml"     => Proc.new { |yaml| yaml.to_yaml }
} unless defined?(FORMATTING)

PARSING

{
"symbol"       => Proc.new { |symbol|  symbol.to_s.to_sym },
"date"         => Proc.new { |date|    ::Date.parse(date) },
"datetime"     => Proc.new { |time|    Time.xmlschema(time).utc rescue ::DateTime.parse(time).utc },
"integer"      => Proc.new { |integer| integer.to_i },
"float"        => Proc.new { |float|   float.to_f },
"decimal"      => Proc.new do |number|
if String === number
number.to_d
else
BigDecimal(number)
end
end,
"boolean"      => Proc.new { |boolean| %w(1 true).include?(boolean.to_s.strip) },
"string"       => Proc.new { |string|  string.to_s },
"yaml"         => Proc.new { |yaml|    YAML.load(yaml) rescue yaml },
"base64Binary" => Proc.new { |bin|     ::Base64.decode64(bin) },
"binary"       => Proc.new { |bin, entity| _parse_binary(bin, entity) },
"file"         => Proc.new { |file, entity| _parse_file(file, entity) }
}

TYPE_NAMES

{
"Symbol"     => "symbol",
"Integer"    => "integer",
"BigDecimal" => "decimal",
"Float"      => "float",
"TrueClass"  => "boolean",
"FalseClass" => "boolean",
"Date"       => "date",
"DateTime"   => "dateTime",
"Time"       => "dateTime",
"Array"      => "array",
"Hash"       => "hash"
}

Attributes

[RW] depth

Public instance methods

backend()

Source code GitHub 
# File activesupport/lib/active_support/xml_mini.rb, line 97
def backend
  current_thread_backend || @backend
end

backend=(name)

Source code GitHub 
# File activesupport/lib/active_support/xml_mini.rb, line 101
def backend=(name)
  backend = name && cast_backend_name_to_module(name)
  self.current_thread_backend = backend if current_thread_backend
  @backend = backend
end

rename_key(key, options = {})

Source code GitHub 
# File activesupport/lib/active_support/xml_mini.rb, line 148
def rename_key(key, options = {})
  camelize  = options[:camelize]
  dasherize = !options.has_key?(:dasherize) || options[:dasherize]
  if camelize
    key = true == camelize ? key.camelize : key.camelize(camelize)
  end
  key = _dasherize(key) if dasherize
  key
end

to_tag(key, value, options)

Source code GitHub 
# File activesupport/lib/active_support/xml_mini.rb, line 115
def to_tag(key, value, options)
  type_name = options.delete(:type)
  merged_options = options.merge(root: key, skip_instruct: true)

  if value.is_a?(::Method) || value.is_a?(::Proc)
    if value.arity == 1
      value.call(merged_options)
    else
      value.call(merged_options, key.to_s.singularize)
    end
  elsif value.respond_to?(:to_xml)
    value.to_xml(merged_options)
  else
    type_name ||= TYPE_NAMES[value.class.name]
    type_name ||= value.class.name if value && !value.respond_to?(:to_str)
    type_name   = type_name.to_s   if type_name
    type_name   = "dateTime" if type_name == "datetime"

    key = rename_key(key.to_s, options)

    attributes = options[:skip_types] || type_name.nil? ? {} : { type: type_name }
    attributes[:nil] = true if value.nil?

    encoding = options[:encoding] || DEFAULT_ENCODINGS[type_name]
    attributes[:encoding] = encoding if encoding

    formatted_value = FORMATTING[type_name] && !value.nil? ?
      FORMATTING[type_name].call(value) : value

    options[:builder].tag!(key, formatted_value, attributes)
  end
end

with_backend(name)

Source code GitHub 
# File activesupport/lib/active_support/xml_mini.rb, line 107
def with_backend(name)
  old_backend = current_thread_backend
  self.current_thread_backend = name && cast_backend_name_to_module(name)
  yield
ensure
  self.current_thread_backend = old_backend
end

Definition files