Class: Grape::Validations::Types::DryTypeCoercer

Inherits:
Object
  • Object
show all
Defined in:
lib/grape/validations/types/dry_type_coercer.rb

Overview

A base class for classes which must identify a coercer to be used. If the strict argument is true, it won't coerce the given value but check its type. More information there dry-rb.org/gems/dry-types/1.2/built-in-types/

Direct Known Subclasses

ArrayCoercer, PrimitiveCoercer

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, strict = false) ⇒ DryTypeCoercer

Returns a new instance of DryTypeCoercer.


52
53
54
55
56
# File 'lib/grape/validations/types/dry_type_coercer.rb', line 52

def initialize(type, strict = false)
  @type = type
  @strict = strict
  @scope = strict ? DryTypes::Strict : DryTypes::Params
end

Class Method Details

.coercer_instance_for(type, strict = false) ⇒ Object

Returns an instance of a coercer for a given type


37
38
39
40
41
42
43
# File 'lib/grape/validations/types/dry_type_coercer.rb', line 37

def coercer_instance_for(type, strict = false)
  return PrimitiveCoercer.new(type, strict) if type.class == Class

  # in case of a collection (Array[Integer]) the type is an instance of a collection,
  # so we need to figure out the actual type
  collection_coercer_for(type.class).new(type, strict)
end

.collection_coercer_for(type) ⇒ Object

Returns a collection coercer which corresponds to a given type. Example:

collection_coercer_for(Array)
#=> Grape::Validations::Types::ArrayCoercer

32
33
34
# File 'lib/grape/validations/types/dry_type_coercer.rb', line 32

def collection_coercer_for(type)
  collection_coercers[type]
end

.register_collection(type) ⇒ Object

Registers a collection coercer which could be found by a type, see collection_coercer_for method below. This method is meant for inheritors.


23
24
25
# File 'lib/grape/validations/types/dry_type_coercer.rb', line 23

def register_collection(type)
  DryTypeCoercer.collection_coercers[type] = self
end

Instance Method Details

#call(val) ⇒ Object

Coerces the given value to a type which was specified during initialization as a type argument.

Parameters:

  • val (Object)

62
63
64
65
66
67
68
# File 'lib/grape/validations/types/dry_type_coercer.rb', line 62

def call(val)
  return if val.nil?

  @coercer[val]
rescue Dry::Types::CoercionError => _e
  InvalidValue.new
end