Class: Dry::Types::Enum

Inherits:
Object
  • Object
show all
Includes:
Builder, Decorator, Type
Defined in:
lib/dry/types/enum.rb

Overview

Enum types can be used to define an enum on top of an existing type

Instance Attribute Summary collapse

Attributes included from Decorator

#type

Attributes included from Options

#options

Instance Method Summary collapse

Methods included from Builder

#&, #>, #constrained, #constrained_type, #constructor, #constructor_type, #enum, #fallback, #lax, #maybe, #optional, #|

Methods included from Decorator

#constrained?, #default?, #respond_to_missing?, #to_proc

Methods included from Options

#with

Methods included from Type

#call, #valid?

Constructor Details

#initialize(type, **options) ⇒ Enum

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Enum.

Parameters:

Options Hash (**options):



28
29
30
31
32
33
34
 
# File 'lib/dry/types/enum.rb', line 28

def initialize(type, **options)
  super
  @mapping = options.fetch(:mapping).freeze
  @values = @mapping.keys.freeze
  @inverted_mapping = @mapping.invert.freeze
  freeze
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Dry::Types::Decorator

Instance Attribute Details

#inverted_mapping ⇒ Hash (readonly)

Returns:



21
22
23
 
# File 'lib/dry/types/enum.rb', line 21

def inverted_mapping
  @inverted_mapping
end

#mapping ⇒ Hash (readonly)

Returns:



18
19
20
 
# File 'lib/dry/types/enum.rb', line 18

def mapping
  @mapping
end

#values ⇒ Array (readonly)

Returns:



15
16
17
 
# File 'lib/dry/types/enum.rb', line 15

def values
  @values
end

Instance Method Details

#call_safe(input, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Object) 


46
47
48
 
# File 'lib/dry/types/enum.rb', line 46

def call_safe(input, &block)
  type.call_safe(map_value(input), &block)
end

#call_unsafe(input) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Object) 


39
40
41
 
# File 'lib/dry/types/enum.rb', line 39

def call_unsafe(input)
  type.call_unsafe(map_value(input))
end

#default ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



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

def default(*)
  raise ".enum(*values).default(value) is not supported. Call "\
        ".default(value).enum(*values) instead"
end

#to_ast(meta: true) ⇒ Object

See Also:



69
70
71
 
# File 'lib/dry/types/enum.rb', line 69

def to_ast(meta: true)
  [:enum, [type.to_ast(meta: meta), mapping]]
end

#to_s ⇒ String Also known as: inspect

Returns:

  • (String) 


76
77
78
 
# File 'lib/dry/types/enum.rb', line 76

def to_s
  PRINTER.(self)
end

#try(input) ⇒ Object

See Also:



53
54
55
 
# File 'lib/dry/types/enum.rb', line 53

def try(input)
  super(map_value(input))
end