Class: MongoMapper::Plugins::Serialization::XmlSerializer::Attribute

Inherits:
Object
  • Object
show all
Defined in:
lib/mongo_mapper/plugins/serialization/xml_serializer.rb

Overview

:nodoc:

Direct Known Subclasses

MethodAttribute

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, record) ⇒ Attribute

Returns a new instance of Attribute.



157
158
159
160
161
162
 
# File 'lib/mongo_mapper/plugins/serialization/xml_serializer.rb', line 157

def initialize(name, record)
  @name, @record = name, record

  @type = compute_type
  @value = compute_value
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



155
156
157
 
# File 'lib/mongo_mapper/plugins/serialization/xml_serializer.rb', line 155

def name
  @name
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



155
156
157
 
# File 'lib/mongo_mapper/plugins/serialization/xml_serializer.rb', line 155

def type
  @type
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



155
156
157
 
# File 'lib/mongo_mapper/plugins/serialization/xml_serializer.rb', line 155

def value
  @value
end

Instance Method Details

#decorations(include_types = true) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/mongo_mapper/plugins/serialization/xml_serializer.rb', line 177

def decorations(include_types = true)
  decorations = {}

  if type == :binary
    decorations[:encoding] = 'base64'
  end

  if include_types && type != :string
    decorations[:type] = type
  end

  decorations
end

#needs_encoding? ⇒ Boolean

There is a significant speed improvement if the value does not need to be escaped, as #tag! escapes all values to ensure that valid XML is generated. For known binary 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 encoded value to the #tag! method. It definitely makes no sense to Base64 encode the value and then give it to #tag!, since that just adds additional overhead.

Returns:



173
174
175
 
# File 'lib/mongo_mapper/plugins/serialization/xml_serializer.rb', line 173

def needs_encoding?
  ![ :binary, :date, :datetime, :boolean, :float, :integer ].include?(type)
end