Class: Dry::Schema::Macros::DSL

Inherits:
Core
  • Object
show all
Includes:
Logic::Operators
Defined in:
lib/dry/schema/macros/dsl.rb

Overview

Macro specialization used within the DSL

Direct Known Subclasses

Array, Each, Key, Maybe, Value

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Core

#new, #operation, #to_ast, #to_rule

Instance Attribute Details

#chain ⇒ Boolean (readonly)

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.

Indicate if the macro should append its rules to the provided trace

Returns:

  • (Boolean) 


23
 
# File 'lib/dry/schema/macros/dsl.rb', line 23

option :chain, default: -> { true }

#predicate_inferrer ⇒ PredicateInferrer (readonly)

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.

PredicateInferrer is used to infer predicate type-check from a type spec

Returns:



29
 
# File 'lib/dry/schema/macros/dsl.rb', line 29

option :predicate_inferrer, default: proc { PredicateInferrer.new(compiler.predicates) }

Instance Method Details

#array(*args, &block) ⇒ Macros::Core

Like ‘each` but sets `array?` type-check

Examples:

a list of strings

required(:tags).array(:str?)

a list of hashes

required(:tags).array(:hash) do
  required(:name).filled(:string)
end

Returns:



145
146
147
148
149
 
# File 'lib/dry/schema/macros/dsl.rb', line 145

def array(*args, &block)
  append_macro(Macros::Array) do |macro|
    macro.value(*args, &block)
  end
end

#each(*args, &block) ⇒ Macros::Core

Specify predicates that should be applied to each element of an array

This is a simpler building block than ‘array` macro, use it when you want to provide `array?` type-check with other rules manually.

Examples:

a list of strings

required(:tags).value(:array, min_size?: 2).each(:str?)

a list of hashes

required(:tags).value(:array, min_size?: 2).each(:hash) do
  required(:name).filled(:string)
end

Returns:



126
127
128
129
130
 
# File 'lib/dry/schema/macros/dsl.rb', line 126

def each(*args, &block)
  append_macro(Macros::Each) do |macro|
    macro.value(*args, &block)
  end
end

#filled(*args, **opts, &block) ⇒ Macros::Core

Prepends ‘:filled?` predicate

Examples:

with a type spec

required(:name).filled(:string)

with a type spec and a predicate

required(:name).filled(:string, format?: /\w+/)

Returns:



69
70
71
72
73
 
# File 'lib/dry/schema/macros/dsl.rb', line 69

def filled(*args, **opts, &block)
  append_macro(Macros::Filled) do |macro|
    macro.call(*args, **opts, &block)
  end
end

#hash(*args, &block) ⇒ Object

Specify a nested hash with enforced ‘hash?` type-check

Examples:

required(:tags).hash do
  required(:name).value(:string)
end


103
104
105
106
107
 
# File 'lib/dry/schema/macros/dsl.rb', line 103

def hash(*args, &block)
  append_macro(Macros::Hash) do |macro|
    macro.call(*args, &block)
  end
end

#schema(*args, &block) ⇒ Macros::Core

Specify a nested hash without enforced ‘hash?` type-check

This is a simpler building block than ‘hash` macro, use it when you want to provide `hash?` type-check with other rules manually.

Examples:

required(:tags).value(:hash, min_size?: 1).schema do
  required(:name).value(:string)
end

Returns:



89
90
91
92
93
 
# File 'lib/dry/schema/macros/dsl.rb', line 89

def schema(*args, &block)
  append_macro(Macros::Schema) do |macro|
    macro.call(*args, &block)
  end
end

#type(spec) ⇒ Macros::Key

Set type spec

Examples:

required(:name).type(:string).value(min_size?: 2)

Parameters:

  • spec (Symbol, Array, Dry::Types::Type)

Returns:



161
162
163
164
 
# File 'lib/dry/schema/macros/dsl.rb', line 161

def type(spec)
  schema_dsl.set_type(name, spec)
  self
end

#value(*predicates, **predicate_opts) ⇒ Macros::Core

Set predicates without and with arguments

Examples:

with a predicate

required(:name).value(:filled?)

with a predicate with arguments

required(:name).value(min_size?: 2)

with a predicate with and without arguments

required(:name).value(:filled?, min_size?: 2)

with a block

required(:name).value { filled? & min_size?(2) }

Parameters:

  • predicates (Array<Symbol>)
  • predicate_opts (Hash)

Returns:



52
53
54
55
56
 
# File 'lib/dry/schema/macros/dsl.rb', line 52

def value(*predicates, **opts, &block)
  append_macro(Macros::Value) do |macro|
    macro.call(*predicates, **opts, &block)
  end
end