dry-validation 0.13.3 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d569600e476b1c0830184bea7e9393f333693e11c1a9d8b074e2b2329deeba7a
-  data.tar.gz: 4811db9bc4e1cc3f398df8717333683355779116a72314532b10bc2d49a87333
+  metadata.gz: 60a3c6ffd96f85afae4533e24216f467888d9f3bfdb3d1f01e78b292a5cceb92
+  data.tar.gz: c6e27c162c638614e9fb876f11c8f5dde26ecc2b06edbaef62c14f6a23fd1b1d
 SHA512:
-  metadata.gz: c497db70c2bf78e3355c685176361b06357ee9d9f17a2c867127d4d575865f0e6cb1f5bafae4b595e1db3af8748fc6122e6522177a152e17e8e6119006591b3c
-  data.tar.gz: 2b93c44b453e47f6a68ec05bedaec9d2f48d001a6dc9d0f62f2f2d7b70de5f8c1a7130bfc33c558fff1129fceb69d37f33f341d38c96549570a684d7279d24b0
+  metadata.gz: 884c2d19f7de54aec614eaf90c6a11040c48f5c267482f09e6b86f8439871b7df6403762cb7885eb238d1dae0835f315abc7bbae6ff84208ea024ec33dcb93c4
+  data.tar.gz: bf22f2906b4d9892015b58c1c0f637b10d82f5f63770a703c1b92e8d105fb3f44b7a9d822c20ffc4bacc1a63e882f13303157c13fdd6c2a65a1c42e0931195fb

data/CHANGELOG.md

@@ -1,31 +1,13 @@
-# v0.13.3 2019-05-21
+# v1.0.0.alpha1 2019-03-04
 
-### Fixed
-
-* Fixed regression with caching templates that rely on predicate arguments (solnic)
-* Removed ugly workaround for template evaluation with extra tokens (solnic)
-
-### Changed
-
-* [internal] `Messages::Abstract#call` returns a `Template` object now, this was backported from dry-schema (solnic)
-
-[Compare v0.13.2...v0.13.3](https://github.com/dry-rb/dry-validation/compare/v0.13.2...v0.13.3)
-
-# v0.13.2 2019-05-12
-
-### Fixed
-
-* Caching message templates uses restricted set of known keys to calculate cache keys (solnic)
+Complete rewrite on top of `dry-schema`.
 
-[Compare v0.13.1...v0.13.2](https://github.com/dry-rb/dry-validation/compare/v0.13.1...v0.13.2)
-
-# v0.13.1 2019-03-22
-
-### Changed
+### Added
 
-- `dry-types` was locked to `~> 0.14.0` (flash-gordon)
+* [BREAKING] `Dry::Validation::Contract` as a replacement for validation schemas (solnic)
+* [BREAKING] New `rule` DSL with an improved API for setting error messages (solnic)
 
-[Compare v0.13.0...v0.13.1](https://github.com/dry-rb/dry-validation/compare/v0.13.0...v0.13.1)
+[Compare v0.13.0...v1.0.0.alpha1](https://github.com/dry-rb/dry-validation/compare/v0.13.0...v1.0.0.alpha1)
 
 # v0.13.0 2019-01-29
 
@@ -38,7 +20,15 @@
 
 - Warning about method redefined (amatsuda)
 
-[Compare v0.12.2...v0.13.0](https://github.com/dry-rb/dry-validation/compare/v0.12.2...v0.13.0)
+[Compare v0.12.3...v0.13.0](https://github.com/dry-rb/dry-validation/compare/v0.12.3...v0.13.0)
+
+# v0.12.3 2019-01-29
+
+### Changed
+
+* [internal] dyr-logic was pinned to `~> 0.4.2` (flash-gordon)
+
+[Compare v0.12.2...v0.12.3](https://github.com/dry-rb/dry-validation/compare/v0.12.2...v0.12.3)
 
 # v0.12.2 2018-08-29
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Dryrb Team
+Copyright (c) 2015-2019 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -12,15 +12,20 @@
 [![Test Coverage](https://codeclimate.com/github/dry-rb/dry-validation/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-validation.svg?branch=master)][inchpages]
 
-## Status
-
-We're working on a new foundation for dry-validation, called dry-schema. You can see progress in [this PR](https://github.com/dry-rb/dry-schema/pull/3). This will result in a partial rewrite for 1.0.0 version. Currently known bugs/issues will be addressed in 1.0.0, **not in 0.x** due to lack of time. More info about 1.0.0 plans can be found [in this thread](https://discourse.dry-rb.org/t/plans-for-dry-validation-dry-schema-a-new-gem/215/3).
-
 ## Links
 
 * [Documentation](http://dry-rb.org/gems/dry-validation)
 * [Guidelines for contributing](CONTRIBUTING.md)
 
+## Supported Ruby versions
+
+This library officially supports following Ruby versions:
+
+* MRI >= `2.4`
+* jruby >= `9.2`
+
+It **should** work on MRI `2.3.x` too, but there's no official support for this version.
+
 ## License
 
 See `LICENSE` file.

data/lib/dry-validation.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'dry/validation'

data/lib/dry/validation.rb

@@ -1,43 +1,16 @@
-require 'dry/core/extensions'
-require 'dry/core/constants'
+# frozen_string_literal: true
+
+require 'dry/validation/contract'
 
 module Dry
+  # Main library namespace
+  #
+  # @api private
   module Validation
     extend Dry::Core::Extensions
-    include Dry::Core::Constants
-
-    MissingMessageError = Class.new(StandardError)
-    InvalidSchemaError = Class.new(StandardError)
-
-    def self.messages_paths
-      Messages::Abstract.config.paths
-    end
-
-    def self.Schema(base = Schema, **options, &block)
-      schema_class = Class.new(base.is_a?(Schema) ? base.class : base)
-      klass = schema_class.define(options.merge(schema_class: schema_class), &block)
 
-      if options[:build] == false
-        klass
-      else
-        klass.new
-      end
-    end
-
-    def self.Params(base = nil, **options, &block)
-      klass = base ? Schema::Params.configure(Class.new(base)) : Schema::Params
-      Validation.Schema(klass, options, &block)
-    end
-
-    def self.JSON(base = Schema::JSON, **options, &block)
-      klass = base ? Schema::JSON.configure(Class.new(base)) : Schema::JSON
-      Validation.Schema(klass, options, &block)
+    register_extension(:monads) do
+      require 'dry/validation/extensions/monads'
     end
   end
 end
-
-require 'dry/validation/schema'
-require 'dry/validation/schema/params'
-require 'dry/validation/schema/json'
-require 'dry/validation/extensions'
-require 'dry/validation/version'

data/lib/dry/validation/constants.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'dry/core/constants'
+
+module Dry
+  module Validation
+    include Dry::Core::Constants
+
+    MissingMessageError = Class.new(StandardError)
+    DuplicateSchemaError = Class.new(StandardError)
+  end
+end

data/lib/dry/validation/contract.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'dry/equalizer'
+require 'dry/configurable'
+require 'dry/initializer'
+
+require 'dry/validation/constants'
+require 'dry/validation/rule'
+require 'dry/validation/evaluator'
+require 'dry/validation/result'
+require 'dry/validation/contract/class_interface'
+
+module Dry
+  module Validation
+    # Contract objects apply rules to input
+    #
+    # A contract consists of a schema and rules. The schema is applied to the
+    # input before rules are applied, this way you can be sure that your rules
+    # won't be applied to values that didn't pass schema checks.
+    #
+    # It's up to you how exactly you're going to separate schema checks from
+    # your rules.
+    #
+    # @example
+    #   class NewUser < Dry::Validation::Contract
+    #     params do
+    #       required(:email).filled(:string)
+    #       required(:age).filled(:integer)
+    #       optional(:login).maybe(:string, :filled?)
+    #       optional(:password).maybe(:string, min_size?: 10)
+    #       optional(:password_confirmation).maybe(:string)
+    #     end
+    #
+    #     rule(:password) do
+    #       failure('is required') if values[:login] && !values[:password]
+    #     end
+    #
+    #     rule(:age) do
+    #       failure('must be greater or equal 18') if values[:age] < 18
+    #     end
+    #   end
+    #
+    #   new_user_contract = NewUserContract.new
+    #   new_user_contract.call(email: 'jane@doe.org', age: 21)
+    #
+    # @api public
+    class Contract
+      include Dry::Equalizer(:schema, :rules, :messages)
+
+      extend Dry::Configurable
+      extend Dry::Initializer
+      extend ClassInterface
+
+      # @!group Configuration
+
+      # @overload config.messages=(identifier)
+      #   Set message backend
+      #
+      #   @param identifier [Symbol] the backend identifier, either `:yaml` or `:i18n`
+      #
+      #   @api public
+      # @!scope class
+      setting :messages, :yaml
+
+      # @overload config.messages_file=(path)
+      #   Set additional path to messages file
+      #
+      #   @param path [String, Pathname] the path
+      #
+      #   @api public
+      # @!scope class
+      setting :messages_file
+
+      # @overload config.namespace=(name)
+      #   Set namespace that will be used to override default messages
+      #
+      #   @param name [Symbol] the namespace
+      #
+      #   @api public
+      # @!scope class
+      setting :namespace
+
+      # @!endgroup
+
+      # @!attribute [r] schema
+      #   @return [Dry::Schema::Params, Dry::Schema::JSON, Dry::Schema::Processor]
+      #   @api private
+      option :schema, default: -> { self.class.__schema__ }
+
+      # @!attribute [r] rules
+      #   @return [Hash]
+      #   @api private
+      option :rules, default: -> { self.class.rules }
+
+      # @!attribute [r] messages
+      #   @return [Messages::I18n, Messages::YAML]
+      #   @api private
+      option :messages, default: -> { self.class.messages }
+
+      # Apply contract to an input
+      #
+      # @return [Result]
+      #
+      # @api public
+      def call(input)
+        Result.new(schema.(input)) do |result|
+          rules.each do |rule|
+            next if rule.keys.any? { |key| result.error?(key) }
+
+            rule_result = rule.(self, result)
+            result.add_error(*rule_result.message) if rule_result.failure?
+          end
+        end
+      end
+
+      # Get message text for the given rule name and options
+      #
+      # @return [String]
+      #
+      # @api private
+      def message(key, tokens: EMPTY_HASH, **opts)
+        template = messages[key, opts.merge(tokens)]
+
+        if template
+          template.(template.data(tokens))
+        else
+          raise MissingMessageError, "Message template for #{key.inspect} was not found"
+        end
+      end
+    end
+  end
+end

data/lib/dry/validation/contract/class_interface.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'dry/schema'
+require 'dry/validation/messages'
+require 'dry/validation/constants'
+
+module Dry
+  module Validation
+    class Contract
+      # Contract's class interface
+      #
+      # @api public
+      module ClassInterface
+        # Define a params schema for your contract
+        #
+        # This type of schema is suitable for HTTP parameters
+        #
+        # @return [Dry::Schema::Params]
+        #
+        # @api public
+        def params(&block)
+          define(:Params, &block)
+        end
+
+        # Define a JSON schema for your contract
+        #
+        # This type of schema is suitable for JSON data
+        #
+        # @return [Dry::Schema::JSON]
+        #
+        # @api public
+        def json(&block)
+          define(:JSON, &block)
+        end
+
+        # Define a plain schema for your contract
+        #
+        # This type of schema does not offer coercion out of the box
+        #
+        # @return [Dry::Schema::Processor]
+        #
+        # @api public
+        def schema(&block)
+          define(:schema, &block)
+        end
+
+        # Define a rule for your contract
+        #
+        # @example using a symbol
+        #   rule(:age) do
+        #     failure('must be at least 18') if values[:age] < 18
+        #   end
+        #
+        # @example using a path to a value and a custom predicate
+        #   rule('address.street') do
+        #     failure('please provide a valid street address') if valid_street?(values[:street])
+        #   end
+        #
+        # @return [Array<Rule>]
+        #
+        # @api public
+        def rule(*keys, &block)
+          rules << Rule.new(keys: keys, block: block)
+          rules
+        end
+
+        # A shortcut that can be used to define contracts that won't be reused or inherited
+        #
+        # @api public
+        def build(option = nil, &block)
+          Class.new(self, &block).new(option)
+        end
+
+        # @api private
+        def __schema__
+          @__schema__ if defined?(@__schema__)
+        end
+
+        # @api private
+        def rules
+          @__rules__ ||= EMPTY_ARRAY
+                         .dup
+                         .concat(superclass.respond_to?(:rules) ? superclass.rules : EMPTY_ARRAY)
+        end
+
+        # @api private
+        def messages
+          @__messages__ ||= Messages.setup(config)
+        end
+
+        private
+
+        # @api private
+        def schema_opts
+          { parent: superclass&.__schema__, config: config }
+        end
+
+        # @api private
+        def define(method_name, &block)
+          raise ::Dry::Validation::DuplicateSchemaError, 'Schema has already been defined' if defined?(@__schema__)
+
+          case method_name
+          when :schema
+            @__schema__ = Schema.define(schema_opts, &block)
+          when :Params
+            @__schema__ = Schema.Params(schema_opts, &block)
+          when :JSON
+            @__schema__ = Schema.JSON(schema_opts, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/validation/evaluator.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'dry/initializer'
+require 'dry/validation/constants'
+
+module Dry
+  module Validation
+    # Evaluator is the execution context for rules
+    #
+    # Evaluators expose an API for setting failure messages and forward
+    # method calls to the contracts, so that you can use your contract
+    # methods within rule blocks
+    #
+    # @api private
+    class Evaluator
+      extend Dry::Initializer
+
+      # @!attribute [r] _context
+      #   @return [Contract]
+      #   @api private
+      param :_context
+
+      # @!attribute [r] keys
+      #   @return [Array<String, Symbol, Hash>]
+      #   @api private
+      option :keys
+
+      # @!attribute [r] default_id
+      #   @return [String, Symbol, Hash]
+      #   @api private
+      option :default_id, default: proc { keys.first }
+
+      # @!attribute [r] values
+      #   @return [Object]
+      #   @api private
+      option :values
+
+      # @!attribute [r] message
+      #   @return [String]
+      #   @api private
+      attr_reader :message
+
+      # Initialize a new evaluator
+      #
+      # @api private
+      def initialize(*args, &block)
+        super(*args)
+        @failure = false
+        instance_eval(&block)
+      end
+
+      # Set failure message
+      #
+      # @overload failure(message)
+      #   Set message text explicitly
+      #   @param message [String] The message text
+      #   @example
+      #     failure('this failed')
+      #
+      # @overload failure(id)
+      #   Use message identifier (needs localized messages setup)
+      #   @param id [Symbol] The message id
+      #   @example
+      #     failure(:taken)
+      #
+      # @overload failure(key, message)
+      #   Set message under specified key (overrides rule's default key)
+      #   @param id [Symbol] The message key
+      #   @example
+      #     failure(:my_error, 'this failed')
+      #
+      # @return [Evaluator]
+      #
+      # @api public
+      def failure(*args, **tokens)
+        id, text =
+          if args.size.equal?(1)
+            case (msg = args[0])
+            when Symbol
+              [default_id, _context.message(msg, rule: default_id, tokens: tokens)]
+            when String
+              [default_id, msg]
+            end
+          else
+            args
+          end
+        @failure = true
+        @message = [id, text]
+        self
+      end
+
+      # Check if evaluation resulted in a failure message
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def failure?
+        @failure.equal?(true)
+      end
+
+      # @api private
+      def respond_to_missing?(meth, include_private = false)
+        super || _context.respond_to?(meth, true)
+      end
+
+      private
+
+      # Forward to the underlying context
+      #
+      # @api private
+      def method_missing(meth, *args, &block)
+        # yes, we do want to delegate to private methods too
+        if _context.respond_to?(meth, true)
+          _context.__send__(meth, *args, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end