Class: Dry::Types::Default

Inherits:

Object

• Object
• Dry::Types::Default

Includes:

Builder, Decorator, Printable, Type

Defined in:

lib/dry/types/default.rb

Overview

Default types are useful when a missing value should be replaced by a default one

Direct Known Subclasses

Callable

Defined Under Namespace

Classes: Callable

Instance Attribute Summary

• #options ⇒ Hash included from Options readonly private
• #type ⇒ Type included from Decorator readonly
• #value ⇒ Object (also: #evaluate) readonly

Class Method Summary

• .[](value) ⇒ Class private

  Default or Callable.

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 = Undefined, &block) ⇒ Object private

  Value passed through Dry::Types::Decorator#type or Builder#default value.

• #call_unsafe(input = Undefined) ⇒ Object private

  Value passed through Dry::Types::Decorator#type or Builder#default value.

• #callable? ⇒ false private
• #constrained ⇒ Default

  Build 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(input = Undefined, options = EMPTY_HASH, &block) ⇒ Default included from Builder

  Turn a type into a type with a default value.

• #default? ⇒ true
• #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, value) ⇒ Default constructor private

  A new instance of Default.

• #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_proc ⇒ Proc included from Decorator

  Wrap the type with a proc.

• #to_s ⇒ String (also: #inspect) included from Printable private
• #try(input) ⇒ Result::Success
• #valid?(value = Undefined) ⇒ Boolean
• #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, value) ⇒ Default

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

Parameters:

• type (Type)
• value (Object)

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

def initialize(type, value, **)
  super
  @value = value
end

Dynamic Method Handling

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

Instance Attribute Details

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

#value ⇒ Object (readonly) Also known as: evaluate

Returns:

• (Object)

# File 'lib/dry/types/default.rb', line 32

def value
  @value
end

Class Method Details

.[](value) ⇒ Class

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 Dry::Types::Default or Callable.

Parameters:

• value (Object, #call)

Returns:

• (Class) —

  Dry::Types::Default or Callable

# File 'lib/dry/types/default.rb', line 41

def self.[](value)
  if value.respond_to?(:call)
    Callable
  else
    self
  end
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 = Undefined, &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 value passed through Dry::Types::Decorator#type or Builder#default value.

Parameters:

• input (Object) (defaults to: Undefined)

Returns:

• (Object) —

  value passed through Dry::Types::Decorator#type or Builder#default value

# File 'lib/dry/types/default.rb', line 110

def call_safe(input = Undefined, &block)
  if input.equal?(Undefined)
    evaluate
  else
    Undefined.default(type.call_safe(input, &block)) { evaluate }
  end
end

#call_unsafe(input = Undefined) ⇒ 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 value passed through Dry::Types::Decorator#type or Builder#default value.

Parameters:

• input (Object) (defaults to: Undefined)

Returns:

• (Object) —

  value passed through Dry::Types::Decorator#type or Builder#default value

# File 'lib/dry/types/default.rb', line 97

def call_unsafe(input = Undefined)
  if input.equal?(Undefined)
    evaluate
  else
    Undefined.default(type.call_unsafe(input)) { evaluate }
  end
end

#callable? ⇒ false

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:

• (false)

# File 'lib/dry/types/default.rb', line 121

def callable?
  false
end

#constrained ⇒ Default

Build a constrained type

Parameters:

• args (Array) —

  see Builder#constrained

Returns:

• (Default)

# File 'lib/dry/types/default.rb', line 65

def constrained(...)
  type.constrained(...).default(value)
end

#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(input = Undefined, options = EMPTY_HASH, &block) ⇒ Default Originally defined in module Builder

Turn a type into a type with a default value

Parameters:

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

  a customizable set of options

Returns:

• (Default)

Raises:

• (ConstraintError)

#default? ⇒ true

Returns:

• (true)

# File 'lib/dry/types/default.rb', line 72

def default?
  true
end

#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_proc ⇒ Proc Originally defined in module Decorator

Wrap the type with a proc

Returns:

• (Proc)

#to_s ⇒ String Also known as: inspect Originally defined in module Printable

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:

• (String)

#try(input) ⇒ Result::Success

Parameters:

• input (Object)

Returns:

• (Result::Success)

# File 'lib/dry/types/default.rb', line 81

def try(input)
  success(call(input))
end

#valid?(value = Undefined) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/dry/types/default.rb', line 88

def valid?(value = Undefined)
  Undefined.equal?(value) || super
end

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