Module: Dry::Types::Builder

Includes:
Core::Constants
Included in:
Constrained, Default, Definition, Maybe, Safe, Sum
Defined in:
lib/dry/types/builder.rb,
lib/dry/types/extensions/maybe.rb

Instance Method Summary collapse

Instance Method Details

#constrained(options) ⇒ Constrained

Parameters:

Returns:



25
26
27
 
# File 'lib/dry/types/builder.rb', line 25

def constrained(options)
  constrained_type.new(self, rule: Types.Rule(options))
end

#constrained_type ⇒ Constrained

Returns:



7
8
9
 
# File 'lib/dry/types/builder.rb', line 7

def constrained_type
  Constrained
end

#constructor(constructor = nil, **options, &block) ⇒ Constructor

Parameters:

  • constructor (#call) (defaults to: nil)
  • options (Hash)
  • block (#call)

Returns:



58
59
60
 
# File 'lib/dry/types/builder.rb', line 58

def constructor(constructor = nil, **options, &block)
  Constructor.new(with(options), fn: constructor || block)
end

#default(input = Undefined, &block) ⇒ Default

Parameters:

  • input (Object) (defaults to: Undefined)
  • block (#call)

Returns:

Raises:



33
34
35
36
37
38
39
40
41
 
# File 'lib/dry/types/builder.rb', line 33

def default(input = Undefined, &block)
  value = input == Undefined ? block : input

  if value.is_a?(Proc) || valid?(value)
    Default[value].new(self, value)
  else
    raise ConstraintError.new("default value #{value.inspect} violates constraints", value)
  end
end

#enum(*values) ⇒ Enum

Parameters:

Returns:



45
46
47
 
# File 'lib/dry/types/builder.rb', line 45

def enum(*values)
  Enum.new(constrained(included_in: values), values: values)
end

#maybe ⇒ Maybe

Returns:



44
45
46
 
# File 'lib/dry/types/extensions/maybe.rb', line 44

def maybe
  Maybe.new(Types['strict.nil'] | self)
end

#optional ⇒ Sum

Returns:



19
20
21
 
# File 'lib/dry/types/builder.rb', line 19

def optional
  Types['strict.nil'] | self
end

#safe ⇒ Safe

Returns:



50
51
52
 
# File 'lib/dry/types/builder.rb', line 50

def safe
  Safe.new(self)
end

#|(other) ⇒ Sum, Sum::Constrained

Parameters:

Returns:



13
14
15
16
 
# File 'lib/dry/types/builder.rb', line 13

def |(other)
  klass = constrained? && other.constrained? ? Sum::Constrained : Sum
  klass.new(self, other)
end