1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
# frozen_string_literal: true
module Axlsx
# This module allows us to define a list of symbols defining which
# attributes will be serialized for a class.
module SerializedAttributes
# Extend with class methods
def self.included(base)
base.send :extend, ClassMethods
end
# class methods applied to all includers
module ClassMethods
# This is the method to be used in inheriting classes to specify
# which of the instance values are serializable
def serializable_attributes(*symbols)
@xml_attributes = symbols
@camel_xml_attributes = nil
@ivar_xml_attributes = nil
end
# a reader for those attributes
attr_reader :xml_attributes
def camel_xml_attributes
@camel_xml_attributes ||= @xml_attributes.map { |attr| Axlsx.camel(attr, false) }
end
def ivar_xml_attributes
@ivar_xml_attributes ||= @xml_attributes.map { |attr| :"@#{attr}" }
end
# This helper registers the attributes that will be formatted as elements.
def serializable_element_attributes(*symbols)
@xml_element_attributes = symbols
end
# attr reader for element attributes
attr_reader :xml_element_attributes
end
# creates a XML tag with serialized attributes
# @see SerializedAttributes#serialized_attributes
def serialized_tag(tagname, str, additional_attributes = {})
str << '<' << tagname << ' '
serialized_attributes(str, additional_attributes)
if block_given?
str << '>'
yield
str << '</' << tagname << '>'
else
str << '/>'
end
end
# serializes the instance values of the defining object based on the
# list of serializable attributes.
# @param [String] str The string instance to append this
# serialization to.
# @param [Hash] additional_attributes An option key value hash for
# defining values that are not serializable attributes list.
# @param [Boolean] camelize_value Should the attribute values be camelized
def serialized_attributes(str = +'', additional_attributes = {}, camelize_value = true)
camel_xml_attributes = self.class.camel_xml_attributes
ivar_xml_attributes = self.class.ivar_xml_attributes
self.class.xml_attributes.each_with_index do |attr, index|
next if additional_attributes.key?(attr)
next unless instance_variable_defined?(ivar_xml_attributes[index])
value = instance_variable_get(ivar_xml_attributes[index])
next if value.nil?
value = Axlsx.booleanize(value)
value = Axlsx.camel(value, false) if camelize_value
str << camel_xml_attributes[index] << '="' << value.to_s << '" '
end
additional_attributes.each do |attr, value|
next if value.nil?
value = Axlsx.booleanize(value)
value = Axlsx.camel(value, false) if camelize_value
str << Axlsx.camel(attr, false) << '="' << value.to_s << '" '
end
str
end
# serialized instance values at text nodes on a camelized element of the
# attribute name. You may pass in a block for evaluation against non nil
# values. We use an array for element attributes becuase misordering will
# break the xml and 1.8.7 does not support ordered hashes.
# @param [String] str The string instance to which serialized data is appended
# @param [Array] additional_attributes An array of additional attribute names.
# @return [String] The serialized output.
def serialized_element_attributes(str = +'', additional_attributes = [])
attrs = self.class.xml_element_attributes + additional_attributes
values = Axlsx.instance_values_for(self)
attrs.each do |attribute_name|
value = values[attribute_name.to_s]
next if value.nil?
value = yield value if block_given?
element_name = Axlsx.camel(attribute_name, false)
str << '<' << element_name << '>' << value << '</' << element_name << '>'
end
str
end
end
end
|
