dry-validation 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6a47d27d49e9894cf283af7e4809cea07f45e5f8f3f52a180dd20d8c849b315
-  data.tar.gz: 83f1e9b5ff94c4db24769624dd1552f0876be541926ffd57d43c2490757ab662
+  metadata.gz: 705706b2bc77cae54a87647ce3d85d685aa2fe619e40950533e1d96a513d1ca0
+  data.tar.gz: a0ad40a08b44475bafa4510707870603517145602e5567bb10cd39f98a1895af
 SHA512:
-  metadata.gz: 67ab872380ecdc45fbe1efeb8cec95a03dff692aae2e74ca498483ceb7104b6a2d5cd78bdc23884d69d89665f110f79c3fa67285b97a40cc2c3625f9744bc34f
-  data.tar.gz: f306b9dc73085526c485a7b18f2e33c83d08dd72922f1640bbc9b3b6ea0164ad1fbda752da0bb9b5d1f55dbd47c6ca6aa9ebef297035fd7adb22bb18be879c4e
+  metadata.gz: 7f2a5347e9b057d76cf9d99c0c313c7437133c1884e750a6c54d095e00f66eb600d7d79a033c2ba561a32c92b783c3153cbd8d88e62c715cd75e9d238f2a034a
+  data.tar.gz: 0a6312efffe80b0156da48da466a9c4384e0b636ef34a93587097592e72a9a2d72f9503e8aa6e556399fc8ad9a18399cc1e5fea2ddb9e66b6268509fcb796d4a

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+# v1.0.0.beta2 2019-04-04
+
+### Added
+
+* Support for arbitrary meta-data in failures, ie:
+
+  ```ruby
+  class NewUserContract < Dry::Validation::Contract
+    params do
+      required(:login).filled(:string)
+    end
+
+    rule(:login) do
+      key.failure(text: 'is taken', code: 123) unless db.unique?(values[:login])
+    end
+  end
+  ```
+
+  Now your error hash will include `{ login: [{ text: 'is taken', code: 123 }] }` (solnic + flash-gordon)
+
+### Changed
+
+* [BREAKING] `Error` was renamed to `Message` as it is a more generic concept (solnic)
+* [BREAKING] `ErrorSet` was renamed to `MessageSet` for consistency (solnic)
+* [BREAKING] `:monads` extension wraps entire result objects in `Success` or `Failure` (flash-gordon)
+
+[Compare v1.0.0.beta1...v1.0.0.beta2](https://github.com/dry-rb/dry-validation/compare/v1.0.0.beta1...v1.0.0.beta2)
+
 # v1.0.0.beta1 2019-03-26
 
 ### Added

data/README.md

@@ -1,10 +1,10 @@
 [gem]: https://rubygems.org/gems/dry-validation
 [travis]: https://travis-ci.org/dry-rb/dry-validation
 [codeclimate]: https://codeclimate.com/github/dry-rb/dry-validation
-[coveralls]: https://coveralls.io/r/dry-rb/dry-validation
+[chat]: https://dry-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/dry-rb/dry-validation
 
-# dry-validation [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
+# dry-validation [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/dry-validation.svg)][gem]
 [![Build Status](https://travis-ci.org/dry-rb/dry-validation.svg?branch=master)][travis]

data/lib/dry/validation/contract.rb

@@ -11,7 +11,6 @@ require 'dry/validation/rule'
 require 'dry/validation/evaluator'
 require 'dry/validation/messages/resolver'
 require 'dry/validation/result'
-require 'dry/validation/error'
 require 'dry/validation/contract/class_interface'
 
 module Dry

data/lib/dry/validation/extensions/monads.rb

@@ -27,7 +27,7 @@ module Dry
       #
       # @api public
       def to_monad
-        success? ? Success(to_h) : Failure(self)
+        success? ? Success(self) : Failure(self)
       end
     end
   end

data/lib/dry/validation/{error.rb → message.rb}

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
 require 'dry/equalizer'
+
+require 'dry/schema/constants'
 require 'dry/schema/message'
 
 module Dry
   module Validation
-    # Error message
+    # Message message
     #
     # @api public
-    class Error < Schema::Message
-      include Dry::Equalizer(:text, :path)
+    class Message < Schema::Message
+      include Dry::Equalizer(:text, :path, :meta)
 
       # @!attribute [r] text
       #   @return [String] text The error message text
@@ -19,29 +21,36 @@ module Dry
       #   @return [Array<Symbol, Integer>] path The path to the value with the error
       attr_reader :path
 
+      # @!attribute [r] meta
+      #   @return [Hash] meta Optional hash with meta-data
+      attr_reader :meta
+
       # @api public
-      class Localized < Error
+      class Localized < Message
         # @api public
         def evaluate(**opts)
-          Error.new(text.(opts), path: path)
+          evaluated_text, rest = text.(opts)
+          Message.new(evaluated_text, path: path, meta: rest.merge(meta))
         end
       end
 
       # Build an error
       #
-      # @return [Error, Error::Localized]
+      # @return [Message, Message::Localized]
       #
       # @api public
-      def self.[](text, path)
-        text.respond_to?(:call) ? Localized.new(text, path: path) : Error.new(text, path: path)
+      def self.[](text, path, meta)
+        klass = text.respond_to?(:call) ? Localized : Message
+        klass.new(text, path: path, meta: meta)
       end
 
       # Initialize a new error object
       #
       # @api private
-      def initialize(text, path:)
+      def initialize(text, path:, meta: EMPTY_HASH)
         @text = text
         @path = Array(path)
+        @meta = meta
       end
 
       # Check if this is a base error not associated with any key

data/lib/dry/validation/{error_set.rb → message_set.rb}

@@ -3,17 +3,17 @@
 require 'dry/schema/message_set'
 
 require 'dry/validation/constants'
-require 'dry/validation/error'
+require 'dry/validation/message'
 
 module Dry
   module Validation
-    # ErrorSet is a specialized message set for handling validation errors
+    # MessageSet is a specialized message set for handling validation messages
     #
     # @api public
-    class ErrorSet < Schema::MessageSet
+    class MessageSet < Schema::MessageSet
       # @!attribute [r] source
       #   Return the source set of messages used to produce final evaluated messages
-      #   @return [Array<Error, Error::Localized, Schema::Message>]
+      #   @return [Array<Message, Message::Localized, Schema::Message>]
       #   @api private
       attr_reader :source_messages
 
@@ -29,54 +29,54 @@ module Dry
         super
       end
 
-      # Return a new error set using updated options
+      # Return a new message set using updated options
       #
-      # @return [ErrorSet]
+      # @return [MessageSet]
       #
       # @api private
       def with(other, new_options = EMPTY_HASH)
         return self if new_options.empty?
 
         self.class.new(
-          other + select { |err| err.is_a?(Error) },
+          other + select { |err| err.is_a?(Message) },
           options.merge(source: source_messages, **new_options)
         ).freeze
       end
 
-      # Add a new error
+      # Add a new message
       #
       # This is used when result is being prepared
       #
-      # @return [ErrorSet]
+      # @return [MessageSet]
       #
       # @api private
-      def add(error)
-        source_messages << error
-        messages << error
+      def add(message)
+        source_messages << message
+        messages << message
         initialize_placeholders!
         self
       end
 
-      # Filter error set using provided predicates
+      # Filter message set using provided predicates
       #
-      # This method is open to any predicate because errors can be anything that
+      # This method is open to any predicate because messages can be anything that
       # implements Message API, thus they can implement whatever predicates you
       # may need.
       #
-      # @example get a list of base errors
-      #   error_set = contract.(input).error_set
-      #   error_set.filter(:base?)
+      # @example get a list of base messages
+      #   message_set = contract.(input).message_set
+      #   message_set.filter(:base?)
       #
       # @param [Array<Symbol>] *predicates
       #
-      # @return [ErrorSet]
+      # @return [MessageSet]
       #
       # @api public
       def filter(*predicates)
-        errors = select { |e|
-          predicates.all? { |predicate| e.respond_to?(predicate) && e.public_send(predicate) }
+        messages = select { |msg|
+          predicates.all? { |predicate| msg.respond_to?(predicate) && msg.public_send(predicate) }
         }
-        self.class.new(errors)
+        self.class.new(messages)
       end
 
       # @api private
@@ -101,7 +101,7 @@ module Dry
       def messages_map
         @messages_map ||= reduce(placeholders) { |hash, msg|
           node = msg.path.reduce(hash) { |a, e| a.is_a?(Hash) ? a[e] : a.last[e] }
-          (node.size > 1 ? node[0] : node) << msg.to_s
+          (node.size > 1 ? node[0] : node) << msg.dump
           hash
         }
       end

data/lib/dry/validation/messages/resolver.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'dry/validation/message'
+
 module Dry
   module Validation
     module Messages
@@ -23,19 +25,23 @@ module Dry
           @locale = locale
         end
 
-        # Resolve Error object from provided args and path
+        # Resolve Message object from provided args and path
         #
         # This is used internally by contracts when rules are applied
         #
-        # @return [Error, Error::Localized]
+        # @return [Message, Message::Localized]
         #
         # @api public
-        def call(message:, tokens:, path:)
+        def call(message:, tokens:, path:, meta: EMPTY_HASH)
           case message
           when Symbol
-            Error[->(**opts) { message(message, path: path, tokens: tokens, **opts) }, path]
+            Message[->(**opts) { message(message, path: path, tokens: tokens, **opts) }, path, meta]
           when String
-            Error[message, path]
+            Message[message, path, meta]
+          when Hash
+            meta = message.dup
+            text = meta.delete(:text)
+            call(message: text, tokens: tokens, path: path, meta: meta)
           end
         end
         alias_method :[], :call
@@ -50,10 +56,10 @@ module Dry
           msg_opts = tokens.merge(path: keys, locale: locale)
 
           if keys.empty?
-            template = messages["rules.#{rule}", msg_opts]
+            template, meta = messages["rules.#{rule}", msg_opts]
           else
-            template = messages[rule, msg_opts.merge(path: keys.join(DOT))]
-            template ||= messages[rule, msg_opts.merge(path: keys.last)]
+            template, meta = messages[rule, msg_opts.merge(path: keys.join(DOT))]
+            template, meta = messages[rule, msg_opts.merge(path: keys.last)] unless template
           end
 
           unless template
@@ -64,7 +70,7 @@ module Dry
 
           text = template.(template.data(tokens))
 
-          full ? "#{messages.rule(keys.last, msg_opts)} #{text}" : text
+          [full ? "#{messages.rule(keys.last, msg_opts)} #{text}" : text, meta]
         end
       end
     end

data/lib/dry/validation/result.rb

@@ -3,7 +3,7 @@
 require 'dry/equalizer'
 
 require 'dry/validation/constants'
-require 'dry/validation/error_set'
+require 'dry/validation/message_set'
 
 module Dry
   module Validation
@@ -45,7 +45,7 @@ module Dry
 
       # Get error set
       #
-      # @return [ErrorSet]
+      # @return [MessageSet]
       #
       # @api public
       def errors(new_options = EMPTY_HASH)
@@ -134,7 +134,7 @@ module Dry
 
       # @api private
       def initialize_errors(options = self.options)
-        ErrorSet.new(schema_errors(options), options)
+        MessageSet.new(schema_errors(options), options)
       end
 
       # @api private

data/lib/dry/validation/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Validation
-    VERSION = '1.0.0.beta1'
+    VERSION = '1.0.0.beta2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-validation
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-26 00:00:00.000000000 Z
+date: 2019-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -76,22 +76,22 @@ dependencies:
   name: dry-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,10 +150,10 @@ files:
 - lib/dry/validation/constants.rb
 - lib/dry/validation/contract.rb
 - lib/dry/validation/contract/class_interface.rb
-- lib/dry/validation/error.rb
-- lib/dry/validation/error_set.rb
 - lib/dry/validation/evaluator.rb
 - lib/dry/validation/extensions/monads.rb
+- lib/dry/validation/message.rb
+- lib/dry/validation/message_set.rb
 - lib/dry/validation/messages/resolver.rb
 - lib/dry/validation/result.rb
 - lib/dry/validation/rule.rb