Module: SavonHelper::DSL

Included in:
MappingObject
Defined in:
lib/savon_helper/dsl.rb

DSL to define attributes mapping collapse

DSL to define attributes mapping collapse

Instance Attribute Details

#alias_accessor ⇒ Array<klass>

description

Returns:

  • (Array<klass>) 


18
19
20
 
# File 'lib/savon_helper/dsl.rb', line 18

def attr_boolean_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, BooleanMapping.new(alias_accessor, description))
end

Instance Method Details

#array_boolean_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Boolean Array accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



31
32
33
 
# File 'lib/savon_helper/dsl.rb', line 31

def array_boolean_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, ArrayMapping.new(BooleanMapping.new, alias_accessor, description))
end

#array_datetime_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new DateTime Array accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



187
188
189
 
# File 'lib/savon_helper/dsl.rb', line 187

def array_datetime_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, ArrayMapping.new(DatetimeMapping.new(), alias_accessor, description))
end

#array_double_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Float Array accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



109
110
111
 
# File 'lib/savon_helper/dsl.rb', line 109

def array_double_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, ArrayMapping.new(FloatMapping.new(), alias_accessor, description))
end

#array_enum_accessor(accessor, enum, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Enum Array accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • enum (Enum) —

    An hash of Enum to Symbol mappings

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



215
216
217
 
# File 'lib/savon_helper/dsl.rb', line 215

def array_enum_accessor(accessor, enum, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, ArrayMapping.new(EnumMapping.new(enum), alias_accessor, description))
end

#array_float__accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Float array accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



83
84
85
 
# File 'lib/savon_helper/dsl.rb', line 83

def array_float__accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, ArrayMapping.new(FloatMapping.new(), alias_accessor, description))
end

#array_integer_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Integer Array accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



57
58
59
 
# File 'lib/savon_helper/dsl.rb', line 57

def array_integer_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, ArrayMapping.new(IntegerMapping.new(), alias_accessor, description))
end

#array_ip_address_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new IP Address Array accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



161
162
163
 
# File 'lib/savon_helper/dsl.rb', line 161

def array_ip_address_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, ArrayMapping.new(IPAddressMapping.new(), alias_accessor, description))
end

#array_object_accessor(accessor, klass, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Object Array accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • klass (Class) —

    The class of the accessed object

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



256
257
258
 
# File 'lib/savon_helper/dsl.rb', line 256

def array_object_accessor(accessor, klass, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, ArrayMapping.new(ObjectMapping.new(klass, alias_accessor, description)))
end

#array_string_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new String Array accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



135
136
137
 
# File 'lib/savon_helper/dsl.rb', line 135

def array_string_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, ArrayMapping.new(StringMapping.new(), alias_accessor, description))
end

#attr_boolean_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Boolean accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



18
19
20
 
# File 'lib/savon_helper/dsl.rb', line 18

def attr_boolean_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, BooleanMapping.new(alias_accessor, description))
end

#attr_datetime_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new DateTime accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



174
175
176
 
# File 'lib/savon_helper/dsl.rb', line 174

def attr_datetime_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, DatetimeMapping.new(alias_accessor, description))
end

#attr_double_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Float accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



96
97
98
 
# File 'lib/savon_helper/dsl.rb', line 96

def attr_double_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, FloatMapping.new(alias_accessor, description))
end

#attr_enum_accessor(accessor, enum, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Enum accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • enum (Enum) —

    An hash of Enum to Symbol mappings

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



201
202
203
 
# File 'lib/savon_helper/dsl.rb', line 201

def attr_enum_accessor(accessor, enum, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, EnumMapping.new(enum, alias_accessor, description))
end

#attr_float_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Float accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



70
71
72
 
# File 'lib/savon_helper/dsl.rb', line 70

def attr_float_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, FloatMapping.new(alias_accessor, description))
end

#attr_integer_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Integer accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



44
45
46
 
# File 'lib/savon_helper/dsl.rb', line 44

def attr_integer_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, IntegerMapping.new(alias_accessor, description))
end

#attr_ip_address_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new IP Address accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



148
149
150
 
# File 'lib/savon_helper/dsl.rb', line 148

def attr_ip_address_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, IPAddressMapping.new(alias_accessor, description))
end

#attr_object_accessor(accessor, klass, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new Object accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • klass (Class) —

    The class of the accessed object

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



242
243
244
 
# File 'lib/savon_helper/dsl.rb', line 242

def attr_object_accessor(accessor, klass, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, ObjectMapping.new(klass, alias_accessor, description))
end

#attr_string_accessor(accessor, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new String accessor

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



122
123
124
 
# File 'lib/savon_helper/dsl.rb', line 122

def attr_string_accessor(accessor, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, StringMapping.new(alias_accessor, description))
end

#hint_object_accessor(accessor, klass, description = '', alias_accessor = accessor) ⇒ void

This method returns an undefined value.

Define a new "hint" for documentation purposes. Please note, that the method has to be define elsewhere!

Parameters:

  • accessor (Symbol) —

    The accessor to be created

  • description (String) (defaults to: '') —

    The description for this accessor

  • alias_accessor (Symbol) (defaults to: accessor) —

    An Alias for the accessor



228
229
230
 
# File 'lib/savon_helper/dsl.rb', line 228

def hint_object_accessor(accessor, klass, description='', alias_accessor=accessor)
  create_accessor(accessor, alias_accessor, HintMapping.new(klass, alias_accessor, description))
end