Class: Porridge::ChainSerializer

Inherits:

Serializer

• Object
• Serializer
• Porridge::ChainSerializer

Defined in:

lib/porridge/chain_serializer.rb

Overview

ChainSerializer is a serializer that chains multiple other serializers together by passing the output of the first one as the input of the second, and the output of the second as the input of the third, and so on.

Instance Attribute Summary

• #serializers ⇒ Array<Serializer, #call> readonly private

  The array of chained serializers.

Instance Method Summary

• #call(object, input, options) ⇒ Object

  Transforms the given input for the given object with the given options by chaining each serializer (contained in #serializers).

• #initialize(*serializers) ⇒ ChainSerializer constructor

  Creates a new instance of ChainSerializer with the given serializers to chain.

Methods inherited from Serializer

ensure_valid!, valid?

Constructor Details

#initialize(*serializers) ⇒ ChainSerializer

Creates a new instance of Porridge::ChainSerializer with the given serializers to chain.

Parameters:

• serializers (Array<Serializer,#call>) —

  the splatted array of serializers to chain.

Raises:

• (InvalidSerializerError) —

  if any of the given serializers are not valid serializers.

# File 'lib/porridge/chain_serializer.rb', line 10

def initialize(*serializers)
  super()
  Serializer.ensure_valid!(*serializers)
  @serializers = serializers
end

Instance Attribute Details

#serializers ⇒ Array<Serializer, #call> (readonly, private)

The array of chained serializers.

Returns:

• (Array<Serializer, #call>)

# File 'lib/porridge/chain_serializer.rb', line 39

def serializers
  @serializers
end

Instance Method Details

#call(object, input, options) ⇒ Object

Transforms the given input for the given object with the given options by chaining each serializer (contained in #serializers). The provided input will be given to the first serializer, whose output will be given to the next serializer, and so on for each serializer.

The given object and options will be given to all the provided serializers. Note that the options are not cloned or duplicated. Therefore none of the serializers should mutate the options object or else all the other serializers will also receive the mutated version.

Parameters:

• object —

  the object for which to transform the input.

• input —

  the object being transformed, typically either a hash or an array.

• options (Hash) —

  a hash of “options,” which may be application specific.

Returns:

• the transformed output, typically either a hash or an array, as returned from the final chained serializer.

# File 'lib/porridge/chain_serializer.rb', line 29

def call(object, input, options)
  output = input
  serializers.each { |serializer| output = serializer.call(object, output, options) }
  output
end