Class: Dry::Validation::Contract

Inherits:
Object
  • Object
show all
Extended by:
Initializer, ClassInterface
Defined in:
lib/dry/validation/contract.rb,
lib/dry/validation/contract/class_interface.rb,
lib/dry/validation/extensions/predicates_as_macros.rb

Overview

Extension to use dry-logic predicates as macros.

Examples:

Dry::Validation.load_extensions(:predicates_as_macros)

class ApplicationContract < Dry::Validation::Contract
  import_predicates_as_macros
end

class AgeContract < ApplicationContract
  schema do
    required(:age).filled(:integer)
  end

  rule(:age).validate(gteq?: 18)
end

AgeContract.new.(age: 17).errors.first.text
# => 'must be greater than or equal to 18'

See Also:

Defined Under Namespace

Modules: ClassInterface

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ClassInterface

__schema__, build, inherited, json, params, rule

Methods included from Macros::Registrar

#register_macro

Instance Attribute Details

#configConfig (readonly)

Returns Contract's configuration object.

Returns:

  • (Config)

    Contract's configuration object


63
# File 'lib/dry/validation/contract.rb', line 63

option :config, default: -> { self.class.config }

#default_contextHash (readonly)

Returns Default context for rules.

Returns:

  • (Hash)

    Default context for rules


74
# File 'lib/dry/validation/contract.rb', line 74

option :default_context, default: -> { EMPTY_HASH }

#macrosMacros::Container (readonly)

Returns Configured macros.

Returns:

See Also:


69
# File 'lib/dry/validation/contract.rb', line 69

option :macros, default: -> { config.macros }

#message_resolverMessages::Resolver (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.

Returns:


89
# File 'lib/dry/validation/contract.rb', line 89

option :message_resolver, default: -> { Messages::Resolver.new(messages) }

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

Returns:

  • (Hash)

84
# File 'lib/dry/validation/contract.rb', line 84

option :rules, default: -> { self.class.rules }

#schemaDry::Schema::Params, ... (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.

Returns:

  • (Dry::Schema::Params, Dry::Schema::JSON, Dry::Schema::Processor)

79
# File 'lib/dry/validation/contract.rb', line 79

option :schema, default: -> { self.class.__schema__ || raise(SchemaMissingError, self.class) }

Class Method Details

.import_predicates_as_macrosObject

Make macros available for self and its descendants.


61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/dry/validation/extensions/predicates_as_macros.rb', line 61

def self.import_predicates_as_macros
  registry = PredicateRegistry.new

  PredicateRegistry::WHITELIST.each do |name|
    register_macro(name) do |macro:|
      predicate_args = [*macro.args, value]
      message_opts = registry.message_opts(name, predicate_args)

      key.failure(name, message_opts) unless registry.(name, predicate_args)
    end
  end
end

Instance Method Details

#call(input, context = EMPTY_HASH) ⇒ Result

Apply the contract to an input

rubocop: disable Metrics/AbcSize

Parameters:

  • input (Hash)

    The input to validate

  • context (Hash) (defaults to: EMPTY_HASH)

    Initial context for rules

Returns:


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/dry/validation/contract.rb', line 100

def call(input, context = EMPTY_HASH)
  context_map = Concurrent::Map.new.tap do |map|
    default_context.each { |key, value| map[key] = value }
    context.each { |key, value| map[key] = value }
  end

  Result.new(schema.(input), context_map) do |result|
    rules.each do |rule|
      next if rule.keys.any? { |key| error?(result, key) }

      rule_result = rule.(self, result)

      rule_result.failures.each do |failure|
        result.add_error(message_resolver.(**failure))
      end
    end
  end
end

#inspectString

Return a nice string representation

Returns:

  • (String)

125
126
127
# File 'lib/dry/validation/contract.rb', line 125

def inspect
  %(#<#{self.class} schema=#{schema.inspect} rules=#{rules.inspect}>)
end