Module: SOAP::Mapping

Defined in:
lib/soap/attachment.rb,
lib/soap/mapping/factory.rb,
lib/soap/mapping/mapping.rb,
lib/soap/mapping/registry.rb,
lib/soap/mapping/rubytypeFactory.rb,
lib/soap/mapping/wsdlencodedregistry.rb,
lib/soap/mapping/wsdlliteralregistry.rb

Defined Under Namespace

Modules: MappedException, TraverseSupport Classes: ArrayFactory_, AttachmentFactory, Base64Factory_, BasetypeFactory_, DateTimeFactory_, Factory, HashFactory_, MappingError, Object, Registry, RubytypeFactory, SOAPException, StringFactory_, TypedArrayFactory_, TypedStructFactory_, URIFactory_, WSDLEncodedRegistry, WSDLLiteralRegistry

Constant Summary collapse

MapQName =
XSD::QName.new(ApacheSOAPTypeNamespace, 'Map')
RubyTypeNamespace =
'http://www.ruby-lang.org/xmlns/ruby/type/1.6'
RubyTypeInstanceNamespace =
'http://www.ruby-lang.org/xmlns/ruby/type-instance'
RubyCustomTypeNamespace =
'http://www.ruby-lang.org/xmlns/ruby/type/custom'
ApacheSOAPTypeNamespace =
'http://xml.apache.org/xml-soap'
EMPTY_OPT =
{}
MARSHAL_TAG =
{
  String => ['"', 1],
  Regexp => ['/', 2],
  Array => ['[', 1],
  Hash => ['{', 1]
}
RubyTypeName =
XSD::QName.new(RubyTypeInstanceNamespace, 'rubyType')
RubyExtendName =
XSD::QName.new(RubyTypeInstanceNamespace, 'extends')
RubyIVarName =
XSD::QName.new(RubyTypeInstanceNamespace, 'ivars')
DefaultRegistry =
Registry.new
RubyOriginalRegistry =
Registry.new(:allow_original_mapping => true)

Class Method Summary collapse

Class Method Details

._obj2soap(obj, registry, type = nil) ⇒ Object


122
123
124
125
126
127
128
129
130
131
# File 'lib/soap/mapping/mapping.rb', line 122

def self._obj2soap(obj, registry, type = nil)
  if referent = Thread.current[:SOAPMarshalDataKey][obj.__id__] and
      !Thread.current[:SOAPMarshalNoReference]
    SOAPReference.new(referent)
  elsif registry
    registry.obj2soap(obj, type)
  else
    raise MappingError.new("no mapping registry given")
  end
end

._soap2obj(node, registry, klass = nil) ⇒ Object


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/soap/mapping/mapping.rb', line 133

def self._soap2obj(node, registry, klass = nil)
  if node.nil?
    return nil
  elsif node.is_a?(SOAPReference)
    target = node.__getobj__
    # target.id is not Object#id but SOAPReference#id
    if referent = Thread.current[:SOAPMarshalDataKey][target.id] and
        !Thread.current[:SOAPMarshalNoReference]
      return referent
    else
      return _soap2obj(target, registry, klass)
    end
  end
  return registry.soap2obj(node, klass)
end

.ary2md(ary, rank, type_ns = XSD::Namespace, typename = XSD::AnyTypeLiteral, registry = nil, opt = EMPTY_OPT) ⇒ Object


79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/soap/mapping/mapping.rb', line 79

def self.ary2md(ary, rank, type_ns = XSD::Namespace, typename = XSD::AnyTypeLiteral, registry = nil, opt = EMPTY_OPT)
  registry ||= Mapping::DefaultRegistry
  type = XSD::QName.new(type_ns, typename)
  md_ary = SOAPArray.new(ValueArrayName, rank, type)
  protect_threadvars(:SOAPMarshalDataKey, :SOAPExternalCES, :SOAPMarshalNoReference) do
    Thread.current[:SOAPMarshalDataKey] = {}
    Thread.current[:SOAPExternalCES] = opt[:external_ces] || $KCODE
    Thread.current[:SOAPMarshalNoReference] = opt[:no_reference]
    add_md_ary(md_ary, ary, [], registry)
  end
  md_ary
end

.ary2soap(ary, type_ns = XSD::Namespace, typename = XSD::AnyTypeLiteral, registry = nil, opt = EMPTY_OPT) ⇒ Object


64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/soap/mapping/mapping.rb', line 64

def self.ary2soap(ary, type_ns = XSD::Namespace, typename = XSD::AnyTypeLiteral, registry = nil, opt = EMPTY_OPT)
  registry ||= Mapping::DefaultRegistry
  type = XSD::QName.new(type_ns, typename)
  soap_ary = SOAPArray.new(ValueArrayName, 1, type)
  protect_threadvars(:SOAPMarshalDataKey, :SOAPExternalCES, :SOAPMarshalNoReference) do
    Thread.current[:SOAPMarshalDataKey] = {}
    Thread.current[:SOAPExternalCES] = opt[:external_ces] || $KCODE
    Thread.current[:SOAPMarshalNoReference] = opt[:no_reference]
    ary.each do |ele|
      soap_ary.add(_obj2soap(ele, registry, type))
    end
  end
  soap_ary
end

.class2element(klass) ⇒ Object


244
245
246
247
248
249
# File 'lib/soap/mapping/mapping.rb', line 244

def self.class2element(klass)
  type = Mapping.class2qname(klass)
  type.name ||= Mapping.name2elename(klass.name)
  type.namespace ||= RubyCustomTypeNamespace
  type
end

.class2qname(klass) ⇒ Object


238
239
240
241
242
# File 'lib/soap/mapping/mapping.rb', line 238

def self.class2qname(klass)
  name = schema_type_definition(klass)
  namespace = schema_ns_definition(klass)
  XSD::QName.new(namespace, name)
end

.class_from_name(name, lenient = false) ⇒ Object


220
221
222
223
224
225
226
227
# File 'lib/soap/mapping/mapping.rb', line 220

def self.class_from_name(name, lenient = false)
  const = const_from_name(name, lenient)
  if const.is_a?(::Class)
    const
  else
    nil
  end
end

.const_from_name(name, lenient = false) ⇒ Object


200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'lib/soap/mapping/mapping.rb', line 200

def self.const_from_name(name, lenient = false)
  const = ::Object
  name.sub(/\A::/, '').split('::').each do |const_str|
    if XSD::CodeGen::GenSupport.safeconstname?(const_str)
      if const.const_defined?(const_str)
        const = const.const_get(const_str)
        next
      end
    elsif lenient
      const_str = XSD::CodeGen::GenSupport.safeconstname(const_str)
      if const.const_defined?(const_str)
        const = const.const_get(const_str)
        next
      end
    end
    return nil
  end
  const
end

.create_empty_object(klass) ⇒ Object

ruby/1.7 or later.


151
152
153
# File 'lib/soap/mapping/mapping.rb', line 151

def self.create_empty_object(klass)
  klass.allocate
end

.define_attr_accessor(obj, name, getterproc, setterproc = nil) ⇒ Object


313
314
315
316
# File 'lib/soap/mapping/mapping.rb', line 313

def self.define_attr_accessor(obj, name, getterproc, setterproc = nil)
  define_singleton_method(obj, name, &getterproc)
  define_singleton_method(obj, name + '=', &setterproc) if setterproc
end

.define_singleton_method(obj, name, &block) ⇒ Object


267
268
269
270
271
272
# File 'lib/soap/mapping/mapping.rb', line 267

def self.define_singleton_method(obj, name, &block)
  sclass = (class << obj; self; end)
  sclass.class_eval {
    define_method(name, &block)
  }
end

.elename2name(name) ⇒ Object


194
195
196
197
198
# File 'lib/soap/mapping/mapping.rb', line 194

def self.elename2name(name)
  name.gsub(/\.\./n, '::').gsub(/((?:\.[0-9a-fA-F]{2})+)/n) {
    [$1.delete('.')].pack('H*')
  }
end

.fault2exception(fault, registry = nil) ⇒ Object


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
118
119
120
# File 'lib/soap/mapping/mapping.rb', line 92

def self.fault2exception(fault, registry = nil)
  registry ||= Mapping::DefaultRegistry
  detail = if fault.detail
      soap2obj(fault.detail, registry) || ""
    else
      ""
    end
  if detail.is_a?(Mapping::SOAPException)
    begin
      e = detail.to_e
	remote_backtrace = e.backtrace
      e.set_backtrace(nil)
      raise e # ruby sets current caller as local backtrace of e => e2.
    rescue Exception => e
	e.set_backtrace(remote_backtrace + e.backtrace[1..-1])
      raise
    end
  else
    fault.detail = detail
    fault.set_backtrace(
      if detail.is_a?(Array)
 detail
      else
        [detail.to_s]
      end
    )
    raise
  end
end

.get_attribute(obj, attr_name) ⇒ Object


274
275
276
277
278
279
280
281
282
283
284
285
286
# File 'lib/soap/mapping/mapping.rb', line 274

def self.get_attribute(obj, attr_name)
  if obj.is_a?(::Hash)
    obj[attr_name] || obj[attr_name.intern]
  else
    name = XSD::CodeGen::GenSupport.safevarname(attr_name)
    if obj.instance_variables.include?('@' + name)
      obj.instance_variable_get('@' + name)
    elsif ((obj.is_a?(::Struct) or obj.is_a?(Marshallable)) and
        obj.respond_to?(name))
      obj.__send__(name)
    end
  end
end

.module_from_name(name, lenient = false) ⇒ Object


229
230
231
232
233
234
235
236
# File 'lib/soap/mapping/mapping.rb', line 229

def self.module_from_name(name, lenient = false)
  const = const_from_name(name, lenient)
  if const.is_a?(::Module)
    const
  else
    nil
  end
end

.name2elename(name) ⇒ Object

Allow only (Letter | '_') (Letter | Digit | '-' | '_')* here. Caution: '.' is not allowed here. To follow XML spec., it should be NCName.

(denied chars) => .[0-F][0-F]
ex. a.b => a.2eb

188
189
190
191
192
# File 'lib/soap/mapping/mapping.rb', line 188

def self.name2elename(name)
  name.gsub(/([^a-zA-Z0-9:_\-]+)/n) {
    '.' << $1.unpack('H2' * $1.size).join('.')
  }.gsub(/::/n, '..')
end

.obj2element(obj) ⇒ Object


251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/soap/mapping/mapping.rb', line 251

def self.obj2element(obj)
  name = namespace = nil
  ivars = obj.instance_variables
  if ivars.include?('@schema_type')
    name = obj.instance_variable_get('@schema_type')
  end
  if ivars.include?('@schema_ns')
    namespace = obj.instance_variable_get('@schema_ns')
  end
  if !name or !namespace
    class2qname(obj.class)
  else
    XSD::QName.new(namespace, name)
  end
end

.obj2soap(obj, registry = nil, type = nil, opt = EMPTY_OPT) ⇒ Object


40
41
42
43
44
45
46
47
48
49
50
# File 'lib/soap/mapping/mapping.rb', line 40

def self.obj2soap(obj, registry = nil, type = nil, opt = EMPTY_OPT)
  registry ||= Mapping::DefaultRegistry
  soap_obj = nil
  protect_threadvars(:SOAPMarshalDataKey, :SOAPExternalCES, :SOAPMarshalNoReference) do
    Thread.current[:SOAPMarshalDataKey] = {}
    Thread.current[:SOAPExternalCES] = opt[:external_ces] || $KCODE
    Thread.current[:SOAPMarshalNoReference] = opt[:no_reference]
    soap_obj = _obj2soap(obj, registry, type)
  end
  soap_obj
end

.schema_attribute_definition(klass) ⇒ Object


342
343
344
# File 'lib/soap/mapping/mapping.rb', line 342

def self.schema_attribute_definition(klass)
  class_schema_variable(:schema_attribute, klass)
end

.schema_element_definition(klass) ⇒ Object


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/soap/mapping/mapping.rb', line 326

def self.schema_element_definition(klass)
  schema_element = class_schema_variable(:schema_element, klass) or return nil
  schema_ns = schema_ns_definition(klass)
  elements = []
  as_array = []
  schema_element.each do |varname, definition|
    class_name, name = definition
    if /\[\]$/ =~ class_name
      class_name = class_name.sub(/\[\]$/, '')
      as_array << (name ? name.name : varname)
    end
    elements << [name || XSD::QName.new(schema_ns, varname), class_name]
  end
  [elements, as_array]
end

.schema_ns_definition(klass) ⇒ Object


322
323
324
# File 'lib/soap/mapping/mapping.rb', line 322

def self.schema_ns_definition(klass)
  class_schema_variable(:schema_ns, klass)
end

.schema_type_definition(klass) ⇒ Object


318
319
320
# File 'lib/soap/mapping/mapping.rb', line 318

def self.schema_type_definition(klass)
  class_schema_variable(:schema_type, klass)
end

.set_attributes(obj, values) ⇒ Object


288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
# File 'lib/soap/mapping/mapping.rb', line 288

def self.set_attributes(obj, values)
  if obj.is_a?(::SOAP::Mapping::Object)
    values.each do |attr_name, value|
      obj.__add_xmlele_value(attr_name, value)
    end
  else
    values.each do |attr_name, value|
      name = XSD::CodeGen::GenSupport.safevarname(attr_name)
      setter = name + "="
      if obj.respond_to?(setter)
        obj.__send__(setter, value)
      else
        obj.instance_variable_set('@' + name, value)
        begin
          define_attr_accessor(obj, name,
            proc { instance_variable_get('@' + name) },
            proc { |value| instance_variable_set('@' + name, value) })
        rescue TypeError
          # singleton class may not exist (e.g. Float)
        end
      end
    end
  end
end

.soap2obj(node, registry = nil, klass = nil, opt = EMPTY_OPT) ⇒ Object


52
53
54
55
56
57
58
59
60
61
62
# File 'lib/soap/mapping/mapping.rb', line 52

def self.soap2obj(node, registry = nil, klass = nil, opt = EMPTY_OPT)
  registry ||= Mapping::DefaultRegistry
  obj = nil
  protect_threadvars(:SOAPMarshalDataKey, :SOAPExternalCES, :SOAPMarshalNoReference) do
    Thread.current[:SOAPMarshalDataKey] = {}
    Thread.current[:SOAPExternalCES] = opt[:external_ces] || $KCODE
    Thread.current[:SOAPMarshalNoReference] = opt[:no_reference]
    obj = _soap2obj(node, registry, klass)
  end
  obj
end