Class: Pump::Encoder

Inherits:
Object
  • Object
show all
Defined in:
lib/pump/encoder.rb

Direct Known Subclasses

Json, Xml

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root_name, encoder_config = nil, encoder_options = {}) { ... } ⇒ self

Creates a new XML-encoder with a root tag named after +root_name+.

Examples:

Create a simple encoder for a person with a name attribute:

Pump::Xml.new :person do
  tag :name
end

Create the same without usage of the DSL:

Pump::Xml.new :person, [{:name => :name}]

Create the same but without the xml instruct

Pump::Xml.new :person, :instruct => false do
  tag :name
end

The same again without DSL:


Pump::Xml.new :person, [{:name => :name}], :instruct => false

Parameters:

  • root_name (String, Symbol) —

    the name of the used root tag

  • encoder_config (Array<Hash>) (defaults to: nil) —

    optional config for all tags

  • encoder_options (Hash) (defaults to: {}) —

    optional encoder_options for the whole encoder

Yields:

  • an optional block to create the encoder with the Pump::Dsl



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/pump/encoder.rb', line 32

def initialize(root_name, encoder_config=nil, encoder_options={}, &blk)
  if encoder_config.is_a?(Array)
    @encoder_config  = encoder_config
    @encoder_options = encoder_options || {}
  else
    raise ArgumentError unless block_given?
    @encoder_options = encoder_config || {}
    @encoder_config = Pump::Dsl.new(&blk).config
  end
  @root_name = root_name
  merge_base

  compile_field_map
  compile
end

Instance Attribute Details

#base ⇒ Object (readonly)

Returns the value of attribute base.



5
6
7
 
# File 'lib/pump/encoder.rb', line 5

def base
  @base
end

#encoder_config ⇒ Object (readonly)

Returns the value of attribute encoder_config.



5
6
7
 
# File 'lib/pump/encoder.rb', line 5

def encoder_config
  @encoder_config
end

#encoder_options ⇒ Object (readonly)

Returns the value of attribute encoder_options.



5
6
7
 
# File 'lib/pump/encoder.rb', line 5

def encoder_options
  @encoder_options
end

#root_name ⇒ Object (readonly)

Returns the value of attribute root_name.



5
6
7
 
# File 'lib/pump/encoder.rb', line 5

def root_name
  @root_name
end

Instance Method Details

#encode(object, options = {}) ⇒ String

Encode a object or an array of objects to an formatted string.

Parameters:

  • object (Object, Array<Object>) —

    object or an array of objects to encode to XML or JSON. The only requirement: The given objects must respond to all methods configured during initalization of the Pump::Xml or Pump::JSON instance.

Returns:

  • (String) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/pump/encoder.rb', line 55

def encode(object, options={})
  object = object.to_a if defined?(ActiveRecord::Relation) && object.is_a?(ActiveRecord::Relation)
  fields_to_hash(options)
  if object.is_a?(Array)
    if options[:fields]
      encode_partial_array(object, options)
    else
      encode_array(object, options)
    end
  elsif options[:fields]
    encode_partial_single(object, options)
  else
    encode_single(object, options)
  end
end