Class: ActiveRecord::XmlSerializer::Attribute

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record/serializers/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.



268
269
270
271
272
273
 
# File 'lib/active_record/serializers/xml_serializer.rb', line 268

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.



266
267
268
 
# File 'lib/active_record/serializers/xml_serializer.rb', line 266

def name
  @name
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



266
267
268
 
# File 'lib/active_record/serializers/xml_serializer.rb', line 266

def type
  @type
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



266
267
268
 
# File 'lib/active_record/serializers/xml_serializer.rb', line 266

def value
  @value
end

Instance Method Details

#decorations(include_types = true) ⇒ Object 



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/active_record/serializers/xml_serializer.rb', line 288

def decorations(include_types = true)
  decorations = {}

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

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

  if value.nil?
    decorations[:nil] = true
  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:

  • (Boolean) 


284
285
286
 
# File 'lib/active_record/serializers/xml_serializer.rb', line 284

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