Class: SOAP::SOAPGenerator

Inherits:
Object show all
Includes:
SOAP
Defined in:
lib/soap/generator.rb

Overview

CAUTION: MT-unsafe

Defined Under Namespace

Classes: FormatEncodeError

Constant Summary collapse

EncodeMap =
{
  '&' => '&',
  '<' => '&lt;',
  '>' => '&gt;',
  '"' => '&quot;',
  '\'' => '&apos;',
  "\r" => '&#xd;'
}
EncodeCharRegexp =
Regexp.new("[#{EncodeMap.keys.join}]")

Constants included from SOAP

AttrActor, AttrArrayType, AttrArrayTypeName, AttrEncodingStyle, AttrEncodingStyleName, AttrMustUnderstand, AttrMustUnderstandName, AttrOffset, AttrOffsetName, AttrPosition, AttrPositionName, AttrRoot, AttrRootName, Base64Literal, EleBody, EleBodyName, EleEnvelope, EleEnvelopeName, EleFault, EleFaultActor, EleFaultActorName, EleFaultCode, EleFaultCodeName, EleFaultDetail, EleFaultDetailName, EleFaultName, EleFaultString, EleFaultStringName, EleHeader, EleHeaderName, EncodingNamespace, EnvelopeNamespace, LiteralNamespace, MediaType, NextActor, PropertyName, SOAPNamespaceTag, TypeMap, VERSION, ValueArray, ValueArrayName, XSDNamespaceTag, XSINamespaceTag

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opt = {}) ⇒ SOAPGenerator

Returns a new instance of SOAPGenerator.


33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/soap/generator.rb', line 33

def initialize(opt = {})
  @reftarget = nil
  @handlers = {}
  @charset = opt[:charset] || XSD::Charset.xml_encoding_label
  @default_encodingstyle = opt[:default_encodingstyle] || EncodingNamespace
  @generate_explicit_type =
    opt.key?(:generate_explicit_type) ? opt[:generate_explicit_type] : true
  @elementformdefault = opt[:elementformdefault]
  @attributeformdefault = opt[:attributeformdefault]
  @use_numeric_character_reference = opt[:use_numeric_character_reference]
  @indentstr = opt[:no_indent] ? '' : '  '
  @buf = @indent = @curr = nil
end

Instance Attribute Details

#charsetObject

Returns the value of attribute charset


28
29
30
# File 'lib/soap/generator.rb', line 28

def charset
  @charset
end

#default_encodingstyleObject

Returns the value of attribute default_encodingstyle


29
30
31
# File 'lib/soap/generator.rb', line 29

def default_encodingstyle
  @default_encodingstyle
end

#generate_explicit_typeObject

Returns the value of attribute generate_explicit_type


30
31
32
# File 'lib/soap/generator.rb', line 30

def generate_explicit_type
  @generate_explicit_type
end

#use_numeric_character_referenceObject

Returns the value of attribute use_numeric_character_reference


31
32
33
# File 'lib/soap/generator.rb', line 31

def use_numeric_character_reference
  @use_numeric_character_reference
end

Class Method Details

.assign_ns(attrs, ns, namespace, tag = nil) ⇒ Object


225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/soap/generator.rb', line 225

def self.assign_ns(attrs, ns, namespace, tag = nil)
  if namespace.nil?
    raise FormatEncodeError.new("empty namespace")
  end
  unless ns.assigned?(namespace)
    tag = ns.assign(namespace, tag)
    if tag == ''
      attr = 'xmlns'
    else
      attr = "xmlns:#{tag}"
    end
    attrs[attr] = namespace
  end
end

Instance Method Details

#add_reftarget(name, node) ⇒ Object


97
98
99
100
101
102
# File 'lib/soap/generator.rb', line 97

def add_reftarget(name, node)
  unless @reftarget
    raise FormatEncodeError.new("Reftarget is not defined.")
  end
  @reftarget.add(name, node)
end

#element_local?(element) ⇒ Boolean

Returns:

  • (Boolean)

209
210
211
# File 'lib/soap/generator.rb', line 209

def element_local?(element)
  element.elename.namespace.nil?
end

#element_qualified?(element) ⇒ Boolean

Returns:

  • (Boolean)

213
214
215
216
217
218
219
220
221
222
223
# File 'lib/soap/generator.rb', line 213

def element_qualified?(element)
  if element.respond_to?(:qualified)
    if element.qualified.nil?
      @elementformdefault
    else
      element.qualified
    end
  else
    @elementformdefault
  end
end

#encode_child(ns, child, parent) ⇒ Object


104
105
106
107
108
# File 'lib/soap/generator.rb', line 104

def encode_child(ns, child, parent)
  indent_backup, @indent = @indent, @indent + @indentstr
  encode_data(ns.clone_ns, child, parent)
  @indent = indent_backup
end

#encode_data(ns, obj, parent) ⇒ Object


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
# File 'lib/soap/generator.rb', line 68

def encode_data(ns, obj, parent)
  if obj.is_a?(SOAPEnvelopeElement)
    encode_element(ns, obj, parent)
    return
  end
  if @reftarget && !obj.precedents.empty?
    add_reftarget(obj.elename.name, obj)
    ref = SOAPReference.new(obj)
    ref.elename = ref.elename.dup_name(obj.elename.name)
    obj.precedents.clear	# Avoid cyclic delay.
    obj.encodingstyle = parent.encodingstyle
    # SOAPReference is encoded here.
    obj = ref
  end
  encodingstyle = obj.encodingstyle
  # Children's encodingstyle is derived from its parent.
  encodingstyle ||= parent.encodingstyle if parent
  obj.encodingstyle = encodingstyle
  handler = find_handler(encodingstyle || @default_encodingstyle)
  unless handler
    raise FormatEncodeError.new("Unknown encodingStyle: #{ encodingstyle }.")
  end
  if !obj.elename.name
    raise FormatEncodeError.new("Element name not defined: #{ obj }.")
  end
  handler.encode_data(self, ns, obj, parent)
  handler.encode_data_end(self, ns, obj, parent)
end

#encode_element(ns, obj, parent) ⇒ Object


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/soap/generator.rb', line 110

def encode_element(ns, obj, parent)
  attrs = {}
  if obj.is_a?(SOAPBody)
    @reftarget = obj
    obj.encode(self, ns, attrs) do |child|
	indent_backup, @indent = @indent, @indent + @indentstr
      encode_data(ns.clone_ns, child, obj)
	@indent = indent_backup
    end
    @reftarget = nil
  else
    if obj.is_a?(SOAPEnvelope)
      # xsi:nil="true" can appear even if dumping without explicit type.
      SOAPGenerator.assign_ns(attrs, ns,
 XSD::InstanceNamespace, XSINamespaceTag)
      if @generate_explicit_type
        SOAPGenerator.assign_ns(attrs, ns, XSD::Namespace, XSDNamespaceTag)
      end
    end
    obj.encode(self, ns, attrs) do |child|
	indent_backup, @indent = @indent, @indent + @indentstr
      encode_data(ns.clone_ns, child, obj)
	@indent = indent_backup
    end
  end
end

#encode_name(ns, data, attrs) ⇒ Object


137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/soap/generator.rb', line 137

def encode_name(ns, data, attrs)
  if element_local?(data)
    data.elename.name
  else
    if element_qualified?(data)
      SOAPGenerator.assign_ns(attrs, ns, data.elename.namespace, '')
    else
      SOAPGenerator.assign_ns(attrs, ns, data.elename.namespace)
    end
    ns.name(data.elename)
  end
end

#encode_name_end(ns, data) ⇒ Object


150
151
152
153
154
155
156
# File 'lib/soap/generator.rb', line 150

def encode_name_end(ns, data)
  if element_local?(data)
    data.elename.name
  else
    ns.name(data.elename)
  end
end

#encode_rawstring(str) ⇒ Object


181
182
183
# File 'lib/soap/generator.rb', line 181

def encode_rawstring(str)
  @buf << str
end

#encode_string(str) ⇒ Object


194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/soap/generator.rb', line 194

def encode_string(str)
  if @use_numeric_character_reference and !XSD::Charset.is_us_ascii(str)
    str.gsub!(EncodeCharRegexp) { |c| EncodeMap[c] }
    @buf << str.unpack("U*").collect { |c|
      if c == 0x9 or c == 0xa or c == 0xd or (c >= 0x20 and c <= 0x7f)
        c.chr
      else
        sprintf("&#x%x;", c)
      end
    }.join
  else
    @buf << str.gsub(EncodeCharRegexp) { |c| EncodeMap[c] }
  end
end

#encode_tag(elename, attrs = nil) ⇒ Object


158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/soap/generator.rb', line 158

def encode_tag(elename, attrs = nil)
  if !attrs or attrs.empty?
    @buf << "\n#{ @indent }<#{ elename }>"
  elsif attrs.size == 1
    key, value = attrs.shift
    @buf << %Q[\n#{ @indent }<#{ elename } #{ key }="#{ value }">]
  else
    @buf << "\n#{ @indent }<#{ elename } " <<
      attrs.collect { |key, value|
        %Q[#{ key }="#{ value }"]
      }.join("\n#{ @indent }#{ @indentstr * 2 }") <<
	'>'
  end
end

#encode_tag_end(elename, cr = nil) ⇒ Object


173
174
175
176
177
178
179
# File 'lib/soap/generator.rb', line 173

def encode_tag_end(elename, cr = nil)
  if cr
    @buf << "\n#{ @indent }</#{ elename }>"
  else
    @buf << "</#{ elename }>"
  end
end

#generate(obj, io = nil) ⇒ Object


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/soap/generator.rb', line 47

def generate(obj, io = nil)
  @buf = io || ''
  @indent = ''

  prologue
  @handlers.each do |uri, handler|
    handler.encode_prologue
  end

  ns = XSD::NS.new
  @buf << xmldecl
  encode_data(ns, obj, nil)

  @handlers.each do |uri, handler|
    handler.encode_epilogue
  end
  epilogue

  @buf
end