dry-schema 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b804e7069cd7d8764f82ce208e38768fa9975e6d1460e1e44917d5c0eaeee911
-  data.tar.gz: 6814f96c49db2634895c20faf7b331feccbdcdcbc83ff89292f655acd6c0adfc
+  metadata.gz: 63100127599f36457192bd183784388f1ca2328c0bd91f4e4d2adb2498b57bb2
+  data.tar.gz: 82c6cad8a1bda4c89723a2ccccce7eab8bb56c9e90b0ce385cc4d632993be90c
 SHA512:
-  metadata.gz: 80d4cc2626025ef517e48bba83026c1bba7ef5797fa25e2543589ed503ec9d7142e799ed9713d4452b7a1f1b2d2988b4c6aeb3172230ec6fd4987d58c8621775
-  data.tar.gz: f35d2b94570ec416b6fcb0457a4e685f37ff3a265a011a4016af611307e2d8d1b8b03dc9e4b59a63b5f2cf55aacf8ceabac0a5d689e73f14e4aaa5cef96e1fa4
+  metadata.gz: dbef0b527a8e4742b3845d8bebf45b88d960fa969956599f6504ce785fb9d2b7461ad8cc94e2e4b238956dc79641007d54be3b435f73551f2219f01db8b3f60d
+  data.tar.gz: c01c98b4600c7fcec9efa3f38f0cd6a27b86191804a7502b80da81d564282cb581ac5bc69c5c006cebb4826d0f7d6653230612a80f530a301494d1fe5af01203

data/CHANGELOG.md

@@ -1,3 +1,169 @@
+# 1.0.0 2019-05-03
+
+### Changed
+
+* [BREAKING] `Result#to_hash` was removed (solnic)
+
+### Fixed
+
+* Setting `:any` as the type spec no longer crashes (solnic)
+* `Result#error?` handles paths to array elements correctly (solnic)
+
+[Compare v0.6.0...v1.0.0](https://github.com/dry-rb/dry-schema/compare/v0.6.0...v1.0.0)
+
+# 0.6.0 2019-04-24
+
+### Changed
+
+* Dependency on `dry-types` was bumped to `~> 1.0` (solnic)
+* Dependency on `dry-logic` was bumped to `~> 1.0` (solnic)
+* Dependency on `dry-initializer` was bumped to `~> 3.0` (solnic)
+
+[Compare v0.5.1...v0.6.0](https://github.com/dry-rb/dry-schema/compare/v0.5.1...v0.6.0)
+
+# 0.5.1 2019-04-17
+
+### Fixed
+
+* Key map no longer crashes on unexpected input (issue #118) (solnic)
+
+[Compare v0.5.0...v0.5.1](https://github.com/dry-rb/dry-schema/compare/v0.5.0...v0.5.1)
+
+# 0.5.0 2019-04-04
+
+### Added
+
+* Support for arbitrary meta-data in messages, ie:
+
+  ```yaml
+  en:
+    dry_schema:
+      errors:
+        filled?:
+          text: "cannot be blank"
+          code: 123
+  ```
+
+  Now your error hash will include `{ foo: [{ text: 'cannot be blank', code: 123 }] }` (solnic + flash-gordon)
+
+* Support for type specs in `array` macro, ie `required(:tags).array(:integer)` (solnic)
+* Support for type specs in `each` macro, ie `required(:tags).each(:integer)` (solnic)
+* Shortcut for defining an array with hash as its member, ie:
+  
+  ```ruby
+  Dry::Schema.Params do
+    required(:tags).array(:hash) do
+      required(:name).filled(:string)
+    end
+  end
+  ```
+
+### Fixed
+
+* Inferring predicates doesn't crash when `Any` type is used (flash-gordon)
+* Inferring type specs when type is already set works correctly (solnic)
+
+### Changed
+
+* [BREAKING] `:monads` extension wraps entire result objects in `Success` or `Failure` (flash-gordon)
+* When `:hints` are disabled, result AST will not include hint nodes (solnic)
+
+[Compare v0.4.0...v0.5.0](https://github.com/dry-rb/dry-schema/compare/v0.4.0...v0.5.0)
+
+# 0.4.0 2019-03-26
+
+### Added
+
+* Schemas are now compatible with procs via `#to_proc` (issue #53) (solnic)
+* Support for configuring `top_namespace` for localized messages (solnic)
+* Support for configuring more than one load path for localized messages (solnic)
+* Support for inferring predicates from arbitrary types (issue #101) (solnic)
+
+### Fixed
+
+* Handling of messages for `optional` keys without value rules works correctly (issue #87) (solnic)
+* Message structure for `optional` keys with an array of hashes no longer duplicates keys (issue #89) (solnic)
+* Inferring `:date_time?` predicate works correctly with `DateTime` types (issue #97) (solnic)
+
+### Changed
+
+* [BREAKING] Updated to work with `dry-types 0.15.0`  (flash-gordon)
+* [BREAKING] `Result#{errors,messages,hints}` returns `MessageSet` object now which is an enumerable coercible to a hash (solnic)
+* [BREAKING] `Messages` backend classes no longer use global configuration (solnic)
+* [BREAKING] Passing a non-symbol key name in the DSL will raise `ArgumentError` (issue #29) (solnic)
+* [BREAKING] Configuration for message backends is now nested under `messages` key with following settings:
+  * `messages.backend` - previously `messages`
+  * `messages.load_paths` - previously `messages_path`
+  * `messages.namespace` - previously `namespace`
+  * `messages.top_namespace` - **new setting** see above
+* [BREAKING] `Messages::I18n` uses `I18.store_translations` instead of messing with `I18n.load_path` (solnic)
+* Schemas (`Params` and `JSON`) have nicer inspect (solnic)
+
+[Compare v0.3.0...v0.4.0](https://github.com/dry-rb/dry-schema/compare/v0.3.0...v0.4.0)
+
+# 0.3.0 2018-03-04
+
+### Fixed
+
+* Configuration is properly inherited from a parent schema (skryukov)
+* `Result#error?` returns `true` when a preceding key has errors (solnic)
+* Predicate inferrer no longer chokes on sum, constructor and enum types (solnic)
+* Predicate inferrer infers `:bool?` from boolean types (solnic)
+* Block-based definitions using `array` works correctly (solnic)
+* Using a disjunction with `array` and `hash` produces correct errors when element validation for array failed (solnic)
+
+### Changed
+
+* Required ruby version was removed from gemspec for people who are stuck on MRI 2.3.x (solnic)
+
+[Compare v0.2.0...v0.3.0](https://github.com/dry-rb/dry-schema/compare/v0.2.0...v0.3.0)
+
+# 0.2.0 2019-02-26
+
+### Added
+
+* New `hash` macro which prepends `hash?` type-check and allows nested schema definition (solnic)
+* New `array` macro which works like `each` but prepends `array?` type-check (solnic)
+
+### Fixed
+
+* Rule name translation works correctly with I18n (issue #52) (solnic)
+* Rule name translation works correctly with namespaced messages (both I18n and plain YAML) (issue #57) (solnic)
+* Error messages under namespaces are correctly resolved for overridden names (issue #53) (solnic)
+* Namespaced error messages work correctly when schemas are reused within other schemas (issue #49) (solnic)
+* Child schema can override inherited rules now (issue #66) (skryukov)
+* Hints are correctly generated for disjunction that use type-check predicates (issue #24) (solnic)
+* Hints are correctly generated for nested schemas (issue #26) (solnic)
+* `filled` macro respects inferred type-check predicates and puts them in front (solnic)
+* Value coercion works correctly with re-usable nested schemas (issue #25) (solnic)
+
+### Changed
+
+* [BREAKING] **Messages are now configured under `dry_schema` namespace by default** (issue #38) (solnic)
+* [BREAKING] Hints are now an optional feature provided by `:hints` extension, to load it do `Dry::Schema.load_extensions(:hints)` (solnic)
+* [BREAKING] Hints generation was improved in general, output of `Result#messages` and `Result#hints` changed in some cases (solnic)
+* [BREAKING] `schema` macro no longer prepends `hash?` check, for this behavior use the new `hash` macro (see #31) (solnic)
+* [BREAKING] Support for MRI < 2.4 was dropped (solnic)
+
+[Compare v0.1.1...v0.2.0](https://github.com/dry-rb/dry-schema/compare/v0.1.1...v0.2.0)
+
+# 0.1.1 2019-02-17
+
+### Added
+
+- `Result#error?` supports checking nested errors too ie`result.error?('user.address')` (solnic)
+
+### Fixed
+
+- Fix issues with templates and invalid tokens (issue #27) (solnic)
+- Fix Ruby warnings (flash-gordon)
+
+### Internal
+
+- Key and value coercers are now equalizable (flash-gordon)
+
+[Compare v0.1.0...v0.1.1](https://github.com/dry-rb/dry-schema/compare/v0.1.0...v0.1.1)
+
 # 0.1.0 2019-01-30
 
 Initial release.

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Dryrb Team
+Copyright (c) 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

@@ -1,10 +1,10 @@
 [gem]: https://rubygems.org/gems/dry-schema
 [travis]: https://travis-ci.org/dry-rb/dry-schema
 [codeclimate]: https://codeclimate.com/github/dry-rb/dry-schema
-[coveralls]: https://coveralls.io/r/dry-rb/dry-schema
+[chat]: https://dry-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/dry-rb/dry-schema
 
-# dry-schema [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
+# dry-schema [![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-schema.svg)][gem]
 [![Build Status](https://travis-ci.org/dry-rb/dry-schema.svg?branch=master)][travis]
@@ -12,9 +12,18 @@
 [![Test Coverage](https://codeclimate.com/github/dry-rb/dry-schema/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-schema.svg?branch=master)][inchpages]
 
-<!-- ## Links
+## Links
 
-* [Documentation](http://dry-rb.org/gems/dry-schema) -->
+* [Documentation](http://dry-rb.org/gems/dry-schema)
+
+## 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
 

data/config/errors.yml

@@ -1,91 +1,96 @@
 en:
-  errors:
+  dry_schema:
     or: "or"
-    array?: "must be an array"
 
-    empty?: "must be empty"
+    errors:
+      array?: "must be an array"
 
-    excludes?: "must not include %{value}"
+      empty?: "must be empty"
 
-    excluded_from?:
-      arg:
-        default: "must not be one of: %{list}"
-        range: "must not be one of: %{list_left} - %{list_right}"
-    exclusion?: "must not be one of: %{list}"
+      excludes?: "must not include %{value}"
 
-    eql?: "must be equal to %{left}"
+      excluded_from?:
+        arg:
+          default: "must not be one of: %{list}"
+          range: "must not be one of: %{list_left} - %{list_right}"
 
-    not_eql?: "must not be equal to %{left}"
+      exclusion?: "must not be one of: %{list}"
 
-    filled?: "must be filled"
+      eql?: "must be equal to %{left}"
 
-    format?: "is in invalid format"
+      not_eql?: "must not be equal to %{left}"
 
-    number?: "must be a number"
+      filled?: "must be filled"
 
-    odd?: "must be odd"
+      format?: "is in invalid format"
 
-    even?: "must be even"
+      number?: "must be a number"
 
-    gt?: "must be greater than %{num}"
+      odd?: "must be odd"
 
-    gteq?: "must be greater than or equal to %{num}"
+      even?: "must be even"
 
-    hash?: "must be a hash"
+      gt?: "must be greater than %{num}"
 
-    included_in?:
-      arg:
-        default: "must be one of: %{list}"
-        range: "must be one of: %{list_left} - %{list_right}"
-    inclusion?: "must be one of: %{list}"
+      gteq?: "must be greater than or equal to %{num}"
 
-    includes?: "must include %{value}"
+      hash?: "must be a hash"
 
-    bool?: "must be boolean"
+      included_in?:
+        arg:
+          default: "must be one of: %{list}"
+          range: "must be one of: %{list_left} - %{list_right}"
 
-    true?: "must be true"
+      inclusion?: "must be one of: %{list}"
 
-    false?: "must be false"
+      includes?: "must include %{value}"
 
-    int?: "must be an integer"
+      bool?: "must be boolean"
 
-    float?: "must be a float"
+      true?: "must be true"
 
-    decimal?: "must be a decimal"
+      false?: "must be false"
 
-    date?: "must be a date"
+      int?: "must be an integer"
 
-    date_time?: "must be a date time"
+      float?: "must be a float"
 
-    time?: "must be a time"
+      decimal?: "must be a decimal"
 
-    key?: "is missing"
+      date?: "must be a date"
 
-    attr?: "is missing"
+      date_time?: "must be a date time"
 
-    lt?: "must be less than %{num}"
+      time?: "must be a time"
 
-    lteq?: "must be less than or equal to %{num}"
+      key?: "is missing"
 
-    max_size?: "size cannot be greater than %{num}"
+      attr?: "is missing"
 
-    min_size?: "size cannot be less than %{num}"
+      lt?: "must be less than %{num}"
 
-    nil?: "cannot be defined"
+      lteq?: "must be less than or equal to %{num}"
 
-    str?: "must be a string"
+      max_size?: "size cannot be greater than %{num}"
 
-    type?: "must be %{type}"
+      min_size?: "size cannot be less than %{num}"
 
-    size?:
-      arg:
-        default: "size must be %{size}"
-        range: "size must be within %{size_left} - %{size_right}"
+      nil?: "cannot be defined"
 
-      value:
-        string:
-          arg:
-            default: "length must be %{size}"
-            range: "length must be within %{size_left} - %{size_right}"
-    not:
-      empty?: "cannot be empty"
+      str?: "must be a string"
+
+      type?: "must be %{type}"
+
+      size?:
+        arg:
+          default: "size must be %{size}"
+          range: "size must be within %{size_left} - %{size_right}"
+
+        value:
+          string:
+            arg:
+              default: "length must be %{size}"
+              range: "length must be within %{size_left} - %{size_right}"
+
+      not:
+        empty?: "cannot be empty"

data/lib/dry/schema/compiler.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'dry/logic/rule_compiler'
+require 'dry/schema/namespaced_rule'
 require 'dry/schema/predicate_registry'
 
 module Dry
@@ -16,6 +19,27 @@ module Dry
         super
       end
 
+      # @api private
+      def visit_and(node)
+        super.with(hints: false)
+      end
+
+      # Build a special rule that will produce namespaced failures
+      #
+      # This is needed for schemas that are namespaced and they are
+      # used as nested schemas
+      #
+      # @param [Array] node
+      # @param [Hash] opts
+      #
+      # @return [NamespacedRule]
+      #
+      # @api private
+      def visit_namespace(node, opts = EMPTY_HASH)
+        namespace, rest = node
+        NamespacedRule.new(namespace, visit(rest))
+      end
+
       # Return true if a given predicate is supported by this compiler
       #
       # @param [Symbol] predicate

data/lib/dry/schema/config.rb

@@ -1,6 +1,9 @@
-require 'delegate'
+# frozen_string_literal: true
+
+require 'dry/equalizer'
 require 'dry/configurable'
 
+require 'dry/schema/constants'
 require 'dry/schema/predicate_registry'
 
 module Dry
@@ -10,42 +13,35 @@ module Dry
     # @see DSL#configure
     #
     # @api public
-    class Config < SimpleDelegator
-      extend Dry::Configurable
+    class Config
+      include Dry::Configurable
+      include Dry::Equalizer(:predicates, :messages)
 
-      setting :predicates, Schema::PredicateRegistry.new
-      setting :messages, :yaml
-      setting :messages_file
-      setting :namespace
-      setting :rules, {}
+      setting(:predicates, Schema::PredicateRegistry.new)
 
-      # Build a new config object with defaults filled in
-      #
-      # @api private
-      def self.new
-        super(struct.new(*settings.map { |key| config.public_send(key) }))
+      setting(:messages) do
+        setting(:backend, :yaml)
+        setting(:namespace)
+        setting(:load_paths, Set[DEFAULT_MESSAGES_PATH], &:dup)
+        setting(:top_namespace, DEFAULT_MESSAGES_ROOT)
       end
 
-      # Build a struct with defined settings
+      # Return configured predicate registry
       #
-      # @return [Struct]
+      # @return [Schema::PredicateRegistry]
       #
-      # @api private
-      def self.struct
-        ::Struct.new(*settings)
+      # @api public
+      def predicates
+        config.predicates
       end
 
-      # Expose configurable object to the provided block
-      #
-      # This method is used by `DSL#configure`
+      # Return configuration for message backend
       #
-      # @return [Config]
+      # @return [Dry::Configurable::Config]
       #
-      # @api private
-      def configure(&block)
-        yield(__getobj__)
-        values.freeze
-        freeze
+      # @api public
+      def messages
+        config.messages
       end
     end
   end

data/lib/dry/schema/constants.rb

@@ -1,13 +1,37 @@
+# frozen_string_literal: true
+
+require 'pathname'
 require 'dry/core/constants'
 
 module Dry
+  # Common constants used across the library
+  #
+  # @api public
   module Schema
     include Core::Constants
 
+    LIST_SEPARATOR = ', '
+    QUESTION_MARK = '?'
+    DOT = '.'
+
+    # Path to the default set of localized messages bundled within the gem
+    DEFAULT_MESSAGES_PATH = Pathname(__dir__).join('../../../config/errors.yml').realpath.freeze
+
+    # Default namespace used for localized messages in YAML files
+    DEFAULT_MESSAGES_ROOT = 'dry_schema'
+
+    # An error raised when DSL is used in an incorrect way
     InvalidSchemaError = Class.new(StandardError)
-    MissingMessageError = Class.new(StandardError)
 
-    QUESTION_MARK = '?'.freeze
-    DOT = '.'.freeze
+    # An error raised when a localized message cannot be found
+    MissingMessageError = Class.new(StandardError) do
+      # @api private
+      def initialize(path)
+        *rest, rule = path
+        super(<<~STR)
+          Message template for #{rule.inspect} under #{rest.join(DOT).inspect} was not found
+        STR
+      end
+    end
   end
 end