Class: Dry::Types::Enum

Inherits:

Object

• Object
• Dry::Types::Enum

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

• #inverted_mapping ⇒ Hash readonly
• #mapping ⇒ Hash readonly
• #options ⇒ Hash included from Options readonly private
• #type ⇒ Type included from Decorator readonly
• #values ⇒ Array readonly

Instance Method Summary

• #&(other) ⇒ Intersection, Intersection::Constrained included from Builder private

  Compose two types into an Intersection type.

• #>(other) ⇒ Implication, Implication::Constrained included from Builder private

  Compose two types into an Implication type.

• #call(input = Undefined, &block) ⇒ Object (also: #[]) included from Type

  Apply type to a value.

• #call_safe(input, &block) ⇒ Object private
• #call_unsafe(input) ⇒ Object private
• #constrained ⇒ Constrained included from Builder

  Turn a type into a constrained type.

• #constrained? ⇒ Boolean included from Decorator
• #constrained_type ⇒ Class included from Builder private
• #constructor(constructor = nil, **options, &block) ⇒ Constructor (also: #append, #prepend, #>>, #<<) included from Builder

  Define a constructor for the type.

• #constructor_type ⇒ Class included from Builder private
• #default ⇒ Object private
• #default? ⇒ Boolean included from Decorator
• #enum(*values) ⇒ Enum included from Builder

  Define an enum on top of the existing type.

• #fallback(value = Undefined, shared: false, &_fallback) ⇒ Constructor included from Builder

  Use the given value on type mismatch.

• #initialize(type, **options) ⇒ Enum constructor private

  A new instance of Enum.

• #lax ⇒ Lax included from Builder

  Turn a type into a lax type that will rescue from type-errors and return the original input.

• #maybe ⇒ Maybe included from Builder

  Turn a type into a maybe type.

• #optional ⇒ Sum included from Builder

  Turn a type into an optional type.

• #respond_to_missing?(meth, include_private = false) ⇒ Boolean included from Decorator
• #to_ast(meta: true) ⇒ Object
• #to_proc ⇒ Proc included from Decorator

  Wrap the type with a proc.

• #to_s ⇒ String (also: #inspect)
• #try(input) ⇒ Object
• #valid?(input = Undefined) ⇒ Boolean (also: #===) included from Type private

  Whether a value is a valid member of the type.

• #with(**new_options) ⇒ Type included from Options private
• #|(other) ⇒ Sum, Sum::Constrained included from Builder private

  Compose two types into a Sum type.

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:

• type (Type)
• options (Hash)

Options Hash (**options):

• :values (Array)

# 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:

• (Hash)

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

def inverted_mapping
  @inverted_mapping
end

#mapping ⇒ Hash (readonly)

Returns:

• (Hash)

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

def mapping
  @mapping
end

#options ⇒ Hash (readonly) Originally defined in module Options

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:

• (Hash)

#type ⇒ Type (readonly) Originally defined in module Decorator

Returns:

• (Type)

#values ⇒ Array (readonly)

Returns:

• (Array)

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

def values
  @values
end

Instance Method Details

#&(other) ⇒ Intersection, Intersection::Constrained Originally defined in module Builder

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.

Compose two types into an Intersection type

Parameters:

• other (Type)

Returns:

• (Intersection, Intersection::Constrained)

#>(other) ⇒ Implication, Implication::Constrained Originally defined in module Builder

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.

Compose two types into an Implication type

Parameters:

• other (Type)

Returns:

• (Implication, Implication::Constrained)

#call(input = Undefined) ⇒ Object #call(input = Undefined) {|output| ... } ⇒ Object Also known as: [] Originally defined in module Type

Apply type to a value

Overloads:

• #call(input = Undefined) ⇒ Object

  Possibly unsafe coercion attempt. If a value doesn't match the type, an exception will be raised.

  Parameters:

  • input (Object) (defaults to: Undefined)

  Returns:

  • (Object)
• #call(input = Undefined) {|output| ... } ⇒ Object

  When a block is passed, #call will never throw an exception on failed coercion, instead it will call the block.

  Parameters:

  • input (Object) (defaults to: Undefined)

  Yield Parameters:

  • output (Object) —

    Partially coerced value

  Returns:

  • (Object)

#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)

# 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)

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

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

#constrained ⇒ Constrained Originally defined in module Builder

Turn a type into a constrained type

Parameters:

• options (Hash) —

  constraining rule (see Dry::Types.Rule)

Returns:

• (Constrained)

#constrained? ⇒ Boolean Originally defined in module Decorator

Returns:

• (Boolean)

#constrained_type ⇒ Class Originally defined in module Builder

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:

• (Class)

#constructor(constructor = nil, **options, &block) ⇒ Constructor Also known as: append, prepend, >>, << Originally defined in module Builder

Define a constructor for the type

Parameters:

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

Returns:

• (Constructor)

#constructor_type ⇒ Class Originally defined in module Builder

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:

• (Class)

#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.

# 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

#default? ⇒ Boolean Originally defined in module Decorator

Returns:

• (Boolean)

#enum(*values) ⇒ Enum Originally defined in module Builder

Define an enum on top of the existing type

Parameters:

• values (Array)

Returns:

• (Enum)

#fallback(value = Undefined, shared: false, &_fallback) ⇒ Constructor Originally defined in module Builder

Use the given value on type mismatch

Parameters:

• value (Object) (defaults to: Undefined)
• fallback (#call, nil)
• [Boolean] (Hash) —

  a customizable set of options

Returns:

• (Constructor)

#lax ⇒ Lax Originally defined in module Builder

Turn a type into a lax type that will rescue from type-errors and return the original input

Returns:

• (Lax)

#maybe ⇒ Maybe Originally defined in module Builder

Turn a type into a maybe type

Returns:

• (Maybe)

#optional ⇒ Sum Originally defined in module Builder

Turn a type into an optional type

Returns:

• (Sum)

#respond_to_missing?(meth, include_private = false) ⇒ Boolean Originally defined in module Decorator

Parameters:

• meth (Symbol)
• include_private (Boolean) (defaults to: false)

Returns:

• (Boolean)

#to_ast(meta: true) ⇒ Object

See Also:

• Nominal#to_ast

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

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

#to_proc ⇒ Proc Originally defined in module Decorator

Wrap the type with a proc

Returns:

• (Proc)

#to_s ⇒ String Also known as: inspect

Returns:

• (String)

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

def to_s
  PRINTER.(self)
end

#try(input) ⇒ Object

See Also:

• Constrained#try

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

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

#valid?(input = Undefined) ⇒ Boolean Also known as: === Originally defined in module Type

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.

Whether a value is a valid member of the type

Returns:

• (Boolean)

#with(**new_options) ⇒ Type Originally defined in module Options

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.

Parameters:

• new_options (Hash)

Returns:

• (Type)

#|(other) ⇒ Sum, Sum::Constrained Originally defined in module Builder

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.

Compose two types into a Sum type

Parameters:

• other (Type)

Returns:

• (Sum, Sum::Constrained)