class Grape::Validations::Types::CustomTypeCollectionCoercer

See {CustomTypeCoercer} for details on types that will be supported by this by this coercer. This coercer works in the same way as CustomTypeCoercer except that it expects to receive an array of strings to coerce and will return an array (or optionally, a set) of coerced values.

CustomTypeCoercer is already capable of providing type checking for arrays where an independent coercion method is supplied. As such, CustomTypeCollectionCoercer does not allow for such a method to be supplied independently of the type.

Public Class Methods

new(type, set = false) click to toggle source

A new coercer for collections of the given type.

@param type [Class,#parse]

type to which items in the array should be coerced.
Must implement a +parse+ method which accepts a string,
and for the purposes of type-checking it may either be
a class, or it may implement a +coerced?+, +parsed?+ or
+call+ method (in that order of precedence) which
accepts a single argument and returns true if the given
array item has been coerced correctly.

@param set [Boolean]

when true, a +Set+ will be returned by {#call} instead
of an +Array+ and duplicate items will be discarded.
# File lib/grape/validations/types/custom_type_collection_coercer.rb, line 32
def initialize(type, set = false)
  super(type)
  @set = set
end

Public Instance Methods

call(value) click to toggle source

Coerces the given value.

@param value [Array<String>] an array of values to be coerced @return [Array,Set] the coerced result. May be an Array or a

+Set+ depending on the setting given to the constructor
# File lib/grape/validations/types/custom_type_collection_coercer.rb, line 42
def call(value)
  coerced = value.map do |item|
    coerced_item = super(item)

    return coerced_item if coerced_item.is_a?(InvalidValue)

    coerced_item
  end

  @set ? Set.new(coerced) : coerced
end