Class: SOAP::Generator

Inherits:
Object show all
Includes:
SOAP, XSD::CodeGen::GenSupport
Defined in:
lib/soap/generator.rb

Overview

CAUTION: MT-unsafe

Defined Under Namespace

Classes: FormatEncodeError

Constant Summary

Constants included from SOAP

AttrActor, AttrActorName, AttrArrayType, AttrArrayTypeName, AttrEncodingStyle, AttrEncodingStyleName, AttrHref, AttrHrefName, AttrId, AttrIdName, 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, SOAPProxy, TypeMap, VERSION, ValueArray, ValueArrayName

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from XSD::CodeGen::GenSupport

capitalize, constant?, #format, keyword?, safeconstname, safeconstname?, safemethodname, safemethodname?, safevarname, safevarname?, uncapitalize

Constructor Details

#initialize(opt = {}) ⇒ Generator

Returns a new instance of Generator


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/soap/generator.rb', line 36

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
  @use_default_namespace = opt[:use_default_namespace]
  @attributeformdefault = opt[:attributeformdefault]
  @use_numeric_character_reference = opt[:use_numeric_character_reference]
  @indentstr = opt[:no_indent] ? '' : '  '
  @buf = @indent = @curr = nil
  @default_ns = opt[:default_ns]
  @default_ns_tag = opt[:default_ns_tag]
end

Instance Attribute Details

#charsetObject

Returns the value of attribute charset


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

def charset
  @charset
end

#default_encodingstyleObject

Returns the value of attribute default_encodingstyle


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

def default_encodingstyle
  @default_encodingstyle
end

#generate_explicit_typeObject

Returns the value of attribute generate_explicit_type


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

def generate_explicit_type
  @generate_explicit_type
end

#use_default_namespaceObject

Returns the value of attribute use_default_namespace


34
35
36
# File 'lib/soap/generator.rb', line 34

def use_default_namespace
  @use_default_namespace
end

#use_numeric_character_referenceObject

Returns the value of attribute use_numeric_character_reference


33
34
35
# File 'lib/soap/generator.rb', line 33

def use_numeric_character_reference
  @use_numeric_character_reference
end

Class Method Details

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


217
218
219
220
221
222
223
224
225
# File 'lib/soap/generator.rb', line 217

def self.assign_ns(attrs, ns, namespace, tag = nil)
  if namespace.nil?
    raise FormatEncodeError.new("empty namespace")
  end
  override_default_ns = (tag == '' and namespace != ns.default_namespace)
  if override_default_ns or !ns.assigned?(namespace)
    assign_ns!(attrs, ns, namespace, tag)
  end
end

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


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

def self.assign_ns!(attrs, ns, namespace, tag = nil)
  tag = ns.assign(namespace, tag)
  if tag == ''
    attr = 'xmlns'
  else
    attr = "xmlns:#{tag}"
  end
  attrs[attr] = namespace
end

Instance Method Details

#add_reftarget(name, node) ⇒ Object


119
120
121
122
123
124
# File 'lib/soap/generator.rb', line 119

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)

213
214
215
# File 'lib/soap/generator.rb', line 213

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

#encode_child(ns, child, parent) ⇒ Object


126
127
128
129
130
# File 'lib/soap/generator.rb', line 126

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


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
114
115
116
117
# File 'lib/soap/generator.rb', line 84

def encode_data(ns, obj, parent)
  if obj.respond_to?(:to_xmlpart)
    formatted = trim_eol(obj.to_xmlpart)
    formatted = trim_indent(formatted)
    formatted = formatted.gsub(/^/, @indent).sub(/\n+\z/, '')
    @buf << "\n#{formatted}"
    return
  elsif 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


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/soap/generator.rb', line 132

def encode_element(ns, obj, parent)
  attrs = obj.extraattr
  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)
      Generator.assign_ns(attrs, ns, XSD::InstanceNamespace)
      Generator.assign_ns(attrs, ns, XSD::Namespace)
    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


155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/soap/generator.rb', line 155

def encode_name(ns, data, attrs)
  if element_local?(data)
    data.elename.name
  else
    if @use_default_namespace
      Generator.assign_ns(attrs, ns, data.elename.namespace, '')
    else
      Generator.assign_ns(attrs, ns, data.elename.namespace)
    end
    ns.name(data.elename)
  end
end

#encode_name_end(ns, data) ⇒ Object


168
169
170
171
172
173
174
# File 'lib/soap/generator.rb', line 168

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

#encode_rawstring(str) ⇒ Object


205
206
207
# File 'lib/soap/generator.rb', line 205

def encode_rawstring(str)
  @buf << str
end

#encode_string(str) ⇒ Object


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

def encode_string(str)
  @buf << get_encoded(str)
end

#encode_tag(elename, attrs = nil) ⇒ Object


176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/soap/generator.rb', line 176

def encode_tag(elename, attrs = nil)
  if attrs.nil? or attrs.empty?
    @buf << "\n#{ @indent }<#{ elename }>"
    return 
  end
  ary = []
  attrs.each do |key, value|
    ary << %Q[#{ key }="#{ get_encoded(value.to_s) }"]
  end
  case ary.size
  when 0
    @buf << "\n#{ @indent }<#{ elename }>"
  when 1
    @buf << %Q[\n#{ @indent }<#{ elename } #{ ary[0] }>]
  else
    @buf << "\n#{ @indent }<#{ elename } " <<
      ary.join("\n#{ @indent }#{ @indentstr * 2 }") <<
	'>'
  end
end

#encode_tag_end(elename, cr = nil) ⇒ Object


197
198
199
200
201
202
203
# File 'lib/soap/generator.rb', line 197

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

#generate(obj, io = nil) ⇒ Object


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

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

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

  ns = SOAP::NS.new
  if @default_ns
    @default_ns.each_ns do |default_ns, default_tag|
      Generator.assign_ns(obj.extraattr, ns, default_ns, default_tag)
    end
  end
  if @default_ns_tag
    @default_ns_tag.each_ns do |default_ns, default_tag|
      ns.known_tag[default_ns] = default_tag
    end
  end
  @buf << xmldecl
  encode_data(ns, obj, nil)

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

  @buf
end