dry-schema 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2ca1bd28c7d47ae6b6c0ed7af0a2fee06df7a852275cbbd5066c991cc5ebba2
-  data.tar.gz: c038aa4babb93392d3fedfc26f07155dd194a5bf03c9c6d307a108159ac2f291
+  metadata.gz: 63100127599f36457192bd183784388f1ca2328c0bd91f4e4d2adb2498b57bb2
+  data.tar.gz: 82c6cad8a1bda4c89723a2ccccce7eab8bb56c9e90b0ce385cc4d632993be90c
 SHA512:
-  metadata.gz: 32388257509b79914faa0b8ef3e8d8d15e9f25c84c1c882998acc240c67a5c43a35a2ac20a9b253b4f41456aba2f94cc80bfaa1edec36783ff55f90bc95a9363
-  data.tar.gz: c6cd678fd48fcce00371789193446e1bdc19f01f84ccdc6c402fada537d6972bfafe6db5cf3e1a0d6aa2bb0ca9bf0bed98099081416ff4f3beac0eca8d02ef4e
+  metadata.gz: dbef0b527a8e4742b3845d8bebf45b88d960fa969956599f6504ce785fb9d2b7461ad8cc94e2e4b238956dc79641007d54be3b435f73551f2219f01db8b3f60d
+  data.tar.gz: c01c98b4600c7fcec9efa3f38f0cd6a27b86191804a7502b80da81d564282cb581ac5bc69c5c006cebb4826d0f7d6653230612a80f530a301494d1fe5af01203

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 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

data/lib/dry/schema.rb

@@ -8,31 +8,64 @@ require 'dry/schema/params'
 require 'dry/schema/json'
 
 module Dry
+  # Main interface
+  #
+  # @api public
   module Schema
     extend Dry::Core::Extensions
 
     # Define a schema
     #
+    # @example
+    #   Dry::Schema.define do
+    #     required(:name).filled(:string)
+    #     required(:age).value(:integer, gt?: 0)
+    #   end
+    #
+    # @param [Hash] options
+    #
     # @return [Processor]
     #
+    # @see DSL.new
+    #
     # @api public
     def self.define(**options, &block)
       DSL.new(options, &block).call
     end
 
-    # Define a param schema
+    # Define a schema suitable for HTTP params
+    #
+    # This schema type uses `Types::Params` for coercion by default
+    #
+    # @example
+    #   Dry::Schema.Params do
+    #     required(:name).filled(:string)
+    #     required(:age).value(:integer, gt?: 0)
+    #   end
     #
     # @return [Params]
     #
+    # @see Schema#define
+    #
     # @api public
     def self.Params(**options, &block)
       define(**options, processor_type: Params, &block)
     end
     singleton_class.send(:alias_method, :Form, :Params)
 
-    # Define a JSON schema
+    # Define a schema suitable for JSON data
+    #
+    # This schema type uses `Types::JSON` for coercion by default
+    #
+    # @example
+    #   Dry::Schema.JSON do
+    #     required(:name).filled(:string)
+    #     required(:age).value(:integer, gt?: 0)
+    #   end
+    #
+    # @return [Params]
     #
-    # @return [JSON]
+    # @see Schema#define
     #
     # @api public
     def self.JSON(**options, &block)

data/lib/dry/schema/constants.rb

@@ -4,6 +4,9 @@ require 'pathname'
 require 'dry/core/constants'
 
 module Dry
+  # Common constants used across the library
+  #
+  # @api public
   module Schema
     include Core::Constants
 
@@ -11,11 +14,16 @@ module Dry
     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)
 
+    # An error raised when a localized message cannot be found
     MissingMessageError = Class.new(StandardError) do
       # @api private
       def initialize(path)

data/lib/dry/schema/dsl.rb

@@ -52,28 +52,22 @@ module Dry
 
       include ::Dry::Equalizer(:options)
 
-      # @!attribute [r] compiler
-      #   @return [Compiler] The rule compiler object
+      # @return [Compiler] The rule compiler object
       option :compiler, default: -> { Compiler.new }
 
-      # @!attribute [r] processor_type
-      #   @return [Compiler] The type of the processor (Params, JSON, or a custom sub-class)
+      # @return [Compiler] The type of the processor (Params, JSON, or a custom sub-class)
       option :processor_type, default: -> { Processor }
 
-      # @!attribute [r] macros
-      #   @return [Array] An array with macros defined within the DSL
+      # @return [Array] An array with macros defined within the DSL
       option :macros, default: -> { EMPTY_ARRAY.dup }
 
-      # @!attribute [r] types
-      #   @return [Compiler] A key=>type map defined within the DSL
+      # @return [Compiler] A key=>type map defined within the DSL
       option :types, default: -> { EMPTY_HASH.dup }
 
-      # @!attribute [r] parent
-      #   @return [DSL] An optional parent DSL object that will be used to merge keys and rules
+      # @return [DSL] An optional parent DSL object that will be used to merge keys and rules
       option :parent, optional: true
 
-      # @!attribute [r] config
-      #   @return [Config] Configuration object exposed via `#configure` method
+      # @return [Config] Configuration object exposed via `#configure` method
       option :config, optional: true, default: proc { parent ? parent.config.dup : Config.new }
 
       # Build a new DSL object and evaluate provided block
@@ -249,7 +243,7 @@ module Dry
 
       # Resolve type object from the provided spec
       #
-      # @param [Symbol, Array<Symbol>, Dry::Types::Type]
+      # @param [Symbol, Array<Symbol>, Dry::Types::Type] spec
       #
       # @return [Dry::Types::Type]
       #

data/lib/dry/schema/extensions/hints.rb

@@ -17,6 +17,8 @@ module Dry
     #
     # @api public
     class Message
+      # Hints extension for Or messages
+      #
       # @see Message::Or
       #
       # @api public
@@ -43,6 +45,7 @@ module Dry
       end
     end
 
+    # Hints extensions
     module Extensions
       Compiler.prepend(Hints::CompilerMethods)
       MessageCompiler.prepend(Hints::MessageCompilerMethods)

data/lib/dry/schema/extensions/hints/message_compiler_methods.rb

@@ -4,6 +4,9 @@ module Dry
   module Schema
     module Extensions
       module Hints
+        # Adds support for processing [:hint, ...] nodes produced by dry-logic
+        #
+        # @api private
         module MessageCompilerMethods
           HINT_TYPE_EXCLUSION = %i[
             key? nil? bool? str? int? float? decimal?
@@ -12,8 +15,10 @@ module Dry
 
           HINT_OTHER_EXCLUSION = %i[format? filled?].freeze
 
+          # @api private
           attr_reader :hints
 
+          # @api private
           def initialize(*args)
             super
             @hints = @options.fetch(:hints, true)

data/lib/dry/schema/extensions/hints/message_set_methods.rb

@@ -4,8 +4,19 @@ module Dry
   module Schema
     module Extensions
       module Hints
+        # Hint extensions for MessageSet
+        #
+        # @api public
         module MessageSetMethods
-          attr_reader :hints, :failures
+          # Filtered message hints from all messages
+          #
+          # @return [Array<Message::Hint>]
+          attr_reader :hints
+          
+          # Configuration option to enable/disable showing errors
+          #
+          # @return [Boolean]
+          attr_reader :failures
 
           # @api private
           def initialize(messages, options = EMPTY_HASH)
@@ -14,6 +25,13 @@ module Dry
             @failures = options.fetch(:failures, true)
           end
 
+          # Dump message set to a hash with either all messages or just hints
+          #
+          # @see MessageSet#to_h
+          # @see ResultMethods#hints
+          #
+          # @return [Hash<Symbol=>Array<String>>]
+          #
           # @api public
           def to_h
             @to_h ||= failures ? messages_map : messages_map(hints)

data/lib/dry/schema/extensions/hints/result_methods.rb

@@ -4,9 +4,16 @@ module Dry
   module Schema
     module Extensions
       module Hints
+        # Get errors exclusively without hints
+        #
+        # @api public
         module ResultMethods
+          # Return error messages exclusively
+          #
           # @see Result#errors
           #
+          # @return [MessageSet]
+          #
           # @api public
           def errors(options = EMPTY_HASH)
             message_set(options.merge(hints: false))
@@ -16,7 +23,7 @@ module Dry
           #
           # @see #message_set
           #
-          # @return [Hash<Symbol=>Array>]
+          # @return [MessageSet]
           #
           # @api public
           def messages(options = EMPTY_HASH)
@@ -27,7 +34,7 @@ module Dry
           #
           # @see #message_set
           #
-          # @return [Hash<Symbol=>Array>]
+          # @return [MessageSet]
           #
           # @api public
           def hints(options = EMPTY_HASH)

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

@@ -4,9 +4,19 @@ require 'dry/monads/result'
 
 module Dry
   module Schema
+    # Monad extension for Result
+    #
+    # @api public
     class Result
       include Dry::Monads::Result::Mixin
 
+      # Turn result into a monad
+      #
+      # This makes result objects work with dry-monads (or anything with a compatible interface)
+      #
+      # @return [Dry::Monads::Success,Dry::Monads::Failure]
+      #
+      # @api public
       def to_monad
         if success?
           Success(self)

data/lib/dry/schema/json.rb

@@ -7,7 +7,7 @@ module Dry
     # JSON schema type
     #
     # @see Processor
-    # @see Schema.JSON
+    # @see Schema#JSON
     #
     # @api public
     class JSON < Processor

data/lib/dry/schema/key.rb

@@ -12,19 +12,13 @@ module Dry
 
       include Dry.Equalizer(:name, :coercer)
 
-      # @!attribute[r] id
-      #   @return [Symbol] The key identifier
-      #   @api public
+      # @return [Symbol] The key identifier
       attr_reader :id
 
-      # @!attribute[r] name
-      #   @return [Symbol, String, Object] The actual key name expected in an input hash
-      #   @api public
+      # @return [Symbol, String, Object] The actual key name expected in an input hash
       attr_reader :name
 
-      # @!attribute[r] id
-      #   @return [Proc, #call] A key name coercer function
-      #   @api public
+      # @return [Proc, #call] A key name coercer function
       attr_reader :coercer
 
       # @api private

data/lib/dry/schema/key_coercer.rb

@@ -33,7 +33,7 @@ module Dry
 
       # @api private
       def call(source)
-        key_map.write(Hash(source))
+        key_map.write(source.to_h)
       end
       alias_method :[], :call
     end

data/lib/dry/schema/key_map.rb

@@ -21,8 +21,7 @@ module Dry
       include Dry.Equalizer(:keys)
       include Enumerable
 
-      # @!attribute[r] keys
-      #   @return [Array<Key>] A list of defined key objects
+      # @return [Array<Key>] A list of defined key objects
       attr_reader :keys
 
       # Coerce a list of key specs into a key map
@@ -41,7 +40,7 @@ module Dry
 
       # Build new, or returned a cached instance of a key map
       #
-      # @param [Array<Symbol, Array, Hash<Symbol=>Array>>
+      # @param [Array<Symbol>, Array, Hash<Symbol=>Array>] args
       #
       # @return [KeyMap]
       def self.new(*args)

data/lib/dry/schema/macros/array.rb

@@ -7,7 +7,7 @@ module Dry
     module Macros
       # Macro used to specify predicates for each element of an array
       #
-      # @api public
+      # @api private
       class Array < DSL
         # @api private
         def value(*args, **opts, &block)
@@ -32,7 +32,6 @@ module Dry
         def to_ast(*)
           [:and, [trace.array?.to_ast, [:each, trace.to_ast]]]
         end
-
         alias_method :ast, :to_ast
       end
     end

data/lib/dry/schema/macros/dsl.rb

@@ -16,15 +16,37 @@ module Dry
         undef :eql?
         undef :nil?
 
-        # @api private
+        # @!attribute [r] chain
+        #   Indicate if the macro should append its rules to the provided trace
+        #   @return [Boolean]
+        #   @api private
         option :chain, default: -> { true }
 
         # @!attribute [r] predicate_inferrer
+        #   PredicateInferrer is used to infer predicate type-check from a type spec
         #   @return [PredicateInferrer]
         #   @api private
         option :predicate_inferrer, default: proc { PredicateInferrer.new(compiler.predicates) }
 
-        # Specify predicates that should be applied to a value
+        # @overload value(*predicates, **predicate_opts)
+        #   Set predicates without and with arguments
+        #
+        #   @param [Array<Symbol>] predicates
+        #   @param [Hash] predicate_opts
+        #
+        #   @example with a predicate
+        #     required(:name).value(:filled?)
+        #
+        #   @example with a predicate with arguments
+        #     required(:name).value(min_size?: 2)
+        #
+        #   @example with a predicate with and without arguments
+        #     required(:name).value(:filled?, min_size?: 2)
+        #
+        #   @example with a block
+        #     required(:name).value { filled? & min_size?(2) }
+        #
+        # @return [Macros::Core]
         #
         # @api public
         def value(*predicates, **opts, &block)
@@ -35,6 +57,14 @@ module Dry
 
         # Prepends `:filled?` predicate
         #
+        # @example with a type spec
+        #   required(:name).filled(:string)
+        #
+        # @example with a type spec and a predicate
+        #   required(:name).filled(:string, format?: /\w+/)
+        #
+        # @return [Macros::Core]
+        #
         # @api public
         def filled(*args, &block)
           append_macro(Macros::Filled) do |macro|
@@ -42,7 +72,18 @@ module Dry
           end
         end
 
-        # Specify a nested hash without enforced hash? type-check
+        # 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.
+        #
+        # @example
+        #   required(:tags).value(:hash, min_size?: 1).schema do
+        #     required(:name).value(:string)
+        #   end
+        #
+        # @return [Macros::Core]
         #
         # @api public
         def schema(*args, &block)
@@ -51,9 +92,12 @@ module Dry
           end
         end
 
-        # Specify a nested hash with enforced hash? type-check
+        # Specify a nested hash with enforced `hash?` type-check
         #
-        # @see #schema
+        # @example
+        #   required(:tags).hash do
+        #     required(:name).value(:string)
+        #   end
         #
         # @api public
         def hash(*args, &block)
@@ -64,6 +108,20 @@ module Dry
 
         # 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.
+        #
+        # @example a list of strings
+        #   required(:tags).value(:array, min_size?: 2).each(:str?)
+        #
+        # @example a list of hashes
+        #   required(:tags).value(:array, min_size?: 2).each(:hash) do
+        #     required(:name).filled(:string)
+        #   end
+        #
+        # @return [Macros::Core]
+        #
         # @api public
         def each(*args, &block)
           append_macro(Macros::Each) do |macro|
@@ -71,7 +129,17 @@ module Dry
           end
         end
 
-        # Like `each`, but prepends `array?` check
+        # Like `each` but sets `array?` type-check
+        #
+        # @example a list of strings
+        #   required(:tags).array(:str?)
+        #
+        # @example a list of hashes
+        #   required(:tags).array(:hash) do
+        #     required(:name).filled(:string)
+        #   end
+        #
+        # @return [Macros::Core]
         #
         # @api public
         def array(*args, &block)
@@ -82,7 +150,10 @@ module Dry
 
         # Set type spec
         #
-        # @param [Symbol, Array, Dry::Types::Type]
+        # @example
+        #   required(:name).type(:string).value(min_size?: 2)
+        #
+        # @param [Symbol, Array, Dry::Types::Type] spec
         #
         # @return [Macros::Key]
         #
@@ -129,13 +200,15 @@ module Dry
 
             type_predicates = predicate_inferrer[resolved_type]
 
-            unless predicates.include?(type_predicates)
+            unless type_predicates.empty? || predicates.include?(type_predicates)
               if type_predicates.is_a?(::Array) && type_predicates.size.equal?(1)
                 predicates.unshift(type_predicates[0])
               else
                 predicates.unshift(type_predicates)
               end
             end
+
+            return self if predicates.empty?
           end
 
           yield(*predicates, type_spec: type_spec)

data/lib/dry/schema/macros/each.rb

@@ -7,7 +7,7 @@ module Dry
     module Macros
       # Macro used to specify predicates for each element of an array
       #
-      # @api public
+      # @api private
       class Each < DSL
         # @api private
         def value(*args, **opts)

data/lib/dry/schema/macros/filled.rb

@@ -7,8 +7,9 @@ module Dry
     module Macros
       # Macro used to prepend `:filled?` predicate
       #
-      # @api public
+      # @api private
       class Filled < Value
+        # @api private
         def call(*predicates, **opts, &block)
           if predicates.include?(:empty?)
             raise ::Dry::Schema::InvalidSchemaError, 'Using filled with empty? predicate is invalid'

data/lib/dry/schema/macros/hash.rb

@@ -7,7 +7,7 @@ module Dry
     module Macros
       # Macro used to specify a nested schema
       #
-      # @api public
+      # @api private
       class Hash < Schema
         # @api private
         def call(*args, &block)

data/lib/dry/schema/macros/key.rb

@@ -8,21 +8,20 @@ require 'dry/schema/constants'
 module Dry
   module Schema
     module Macros
-      # Base macro for specifying rules applied to a value found under the key
-      #
-      # @see DSL#key
+      # Base macro for specifying rules applied to a value found under a key
       #
       # @api public
       class Key < DSL
-        # @!attribute [r] filter_schema
-        #   @return [Schema::DSL]
-        #   @api private
+        # @return [Schema::DSL]
+        # @api private
         option :filter_schema, optional: true, default: proc { schema_dsl&.new }
 
-        # Specify predicates that should be used to filter out values
-        # before coercion is applied
+        # Specify predicates that should be applied before coercion
         #
-        # @see Macros::DSL#value
+        # @example check format before coercing to a date
+        #   required(:publish_date).filter(format?: /\d{4}-\d{2}-\d{2}).value(:date)
+        #
+        # @see Macros::Key#value
         #
         # @return [Macros::Key]
         #
@@ -32,12 +31,26 @@ module Dry
           self
         end
 
-        # Set type specification and predicates
+        # @overload value(type_spec, *predicates, **predicate_opts)
+        #   Set type specification and predicates
         #
-        # @see Macros::DSL#value
+        #   @param [Symbol,Types::Type,Array] type_spec
+        #   @param [Array<Symbol>] predicates
+        #   @param [Hash] predicate_opts
+        #
+        #   @example with a predicate
+        #     required(:name).value(:string, :filled?)
+        #
+        #   @example with a predicate with arguments
+        #     required(:name).value(:string, min_size?: 2)
+        #
+        #   @example with a block
+        #     required(:name).value(:string) { filled? & min_size?(2) }
         #
         # @return [Macros::Key]
         #
+        # @see Macros::DSL#value
+        #
         # @api public
         def value(*args, **opts, &block)
           extract_type_spec(*args) do |*predicates, type_spec:|
@@ -47,7 +60,10 @@ module Dry
 
         # Set type specification and predicates for a filled value
         #
-        # @see Macros::DSL#value
+        # @example
+        #   required(:name).filled(:string)
+        #
+        # @see Macros::Key#value
         #
         # @return [Macros::Key]
         #
@@ -60,7 +76,10 @@ module Dry
 
         # Set type specification and predicates for a maybe value
         #
-        # @see Macros::DSL#value
+        # @example
+        #   required(:name).maybe(:string)
+        #
+        # @see Macros::Key#value
         #
         # @return [Macros::Key]
         #

data/lib/dry/schema/macros/maybe.rb

@@ -7,7 +7,7 @@ module Dry
     module Macros
       # Macro used to specify predicates for a value that can be `nil`
       #
-      # @api public
+      # @api private
       class Maybe < DSL
         # @api private
         def call(*args, **opts, &block)

data/lib/dry/schema/macros/optional.rb

@@ -7,7 +7,7 @@ module Dry
     module Macros
       # A Key specialization used for keys that can be skipped
       #
-      # @api public
+      # @api private
       class Optional < Key
         # @api private
         def operation

data/lib/dry/schema/macros/required.rb

@@ -7,7 +7,7 @@ module Dry
     module Macros
       # A Key specialization used for keys that must be present
       #
-      # @api public
+      # @api private
       class Required < Key
         # @api private
         def operation

data/lib/dry/schema/macros/schema.rb

@@ -7,7 +7,7 @@ module Dry
     module Macros
       # Macro used to specify a nested schema
       #
-      # @api public
+      # @api private
       class Schema < Value
         # @api private
         def call(*args, &block)

data/lib/dry/schema/macros/value.rb

@@ -7,7 +7,7 @@ module Dry
     module Macros
       # A macro used for specifying predicates to be applied to values from a hash
       #
-      # @api public
+      # @api private
       class Value < DSL
         # @api private
         def call(*predicates, **opts, &block)

data/lib/dry/schema/message.rb

@@ -16,16 +16,34 @@ module Dry
 
       extend Dry::Initializer
 
+      # @!attribute [r] text
+      #   Message text representation created from a localized template
+      #   @return [String]
       option :text
 
+      # @!attribute [r] path
+      #   Path to the value
+      #   @return [String]
       option :path
 
+      # @!attribute [r] predicate
+      #   Predicate identifier that was used to produce a message
+      #   @return [Symbol]
       option :predicate
 
+      # @!attribute [r] args
+      #   Optional list of arguments used by the predicate
+      #   @return [Array]
       option :args, default: proc { EMPTY_ARRAY }
 
+      # @!attribute [r] input
+      #   The input value
+      #   @return [Object]
       option :input
 
+      # @!attribute [r] meta
+      #   Arbitrary meta data
+      #   @return [Hash]
       option :meta, optional: true, default: proc { EMPTY_HASH }
 
       # Dump the message to a representation suitable for the message set hash
@@ -38,16 +56,27 @@ module Dry
       end
       alias to_s dump
 
+      # See if another message is the same
+      #
+      # If a string is passed, it will be compared with the text
+      #
+      # @param [Message,String]
+      #
+      # @return [Boolean]
+      #
       # @api private
       def eql?(other)
         other.is_a?(String) ? text == other : super
       end
 
+      # See which message is higher in the hierarchy
+      #
+      # @api private
       def <=>(other)
         l_path = Path[path]
         r_path = Path[other.path]
 
-        unless l_path.include?(r_path)
+        unless l_path.same_root?(r_path)
           raise ArgumentError, 'Cannot compare messages from different root paths'
         end
 

data/lib/dry/schema/message/or.rb

@@ -32,6 +32,8 @@ module Dry
           @path = left.path
         end
 
+        # Dump a message into a string
+        #
         # @see Message#dump
         #
         # @return [String]

data/lib/dry/schema/message_set.rb

@@ -13,7 +13,21 @@ module Dry
       include Enumerable
       include Dry::Equalizer(:messages, :options)
 
-      attr_reader :messages, :placeholders, :options
+      # A list of compiled message objects
+      #
+      # @return [Array<Message>]
+      attr_reader :messages
+      
+      # An internal hash that is filled in with dumped messages
+      # when a message set is coerced to a hash
+      #
+      # @return [Hash<Symbol=>[Array,Hash]>]
+      attr_reader :placeholders
+      
+      # Options hash
+      #
+      # @return [Hash]
+      attr_reader :options
 
       # @api private
       def self.[](messages, options = EMPTY_HASH)
@@ -27,6 +41,15 @@ module Dry
         initialize_placeholders!
       end
 
+      # Iterate over messages
+      #
+      # @example
+      #   result.errors.each do |message|
+      #     puts message.text
+      #   end
+      #
+      # @return [Array]
+      #
       # @api public
       def each(&block)
         return self if empty?
@@ -35,23 +58,45 @@ module Dry
         messages.each(&block)
       end
 
+      # Dump message set to a hash
+      #
+      # @return [Hash<Symbol=>Array<String>>]
+      #
       # @api public
       def to_h
         @to_h ||= messages_map
       end
       alias_method :to_hash, :to_h
 
+      # Get a list of message texts for the given key
+      #
+      # @param [Symbol] key
+      #
+      # @return [Array<String>]
+      #
       # @api public
       def [](key)
         to_h[key]
       end
 
+      # Get a list of message texts for the given key
+      #
+      # @param [Symbol] key
+      #
+      # @return [Array<String>]
+      #
+      # @raise KeyError
+      #
       # @api public
       def fetch(key)
         self[key] || raise(KeyError, "+#{key}+ message was not found")
       end
 
-      # @api private
+      # Check if a message set is empty
+      #
+      # @return [Boolean]
+      #
+      # @api public
       def empty?
         @empty ||= messages.empty?
       end

data/lib/dry/schema/messages/i18n.rb

@@ -9,6 +9,9 @@ module Dry
     #
     # @api public
     class Messages::I18n < Messages::Abstract
+      # Translation function
+      #
+      # @return [Method]
       attr_reader :t
 
       # @api private
@@ -82,7 +85,7 @@ module Dry
       def store_translations(data)
         locales = data.keys.map(&:to_sym)
 
-        I18n.available_locales += locales
+        I18n.available_locales |= locales
 
         locales.each do |locale|
           I18n.backend.store_translations(locale, data[locale.to_s])

data/lib/dry/schema/messages/namespaced.rb

@@ -59,6 +59,7 @@ module Dry
           super(tokens.merge(root: "#{tokens[:root]}.#{namespace}")) + super
         end
 
+        # @api private
         def rule_lookup_paths(tokens)
           base_paths = messages.rule_lookup_paths(tokens)
           base_paths.map { |key| key.gsub('dry_schema', "dry_schema.#{namespace}") } + base_paths

data/lib/dry/schema/messages/template.rb

@@ -17,15 +17,15 @@ module Dry
         TOKEN_REGEXP = /%{([\w\d]*)}/
 
         # !@attribute [r] text
-        #   @return [String]
+        # @return [String]
         attr_reader :text
 
         # !@attribute [r] tokens
-        #   @return [Hash]
+        # @return [Hash]
         attr_reader :tokens
 
         # !@attribute [r] evaluator
-        #   @return [Proc]
+        # @return [Proc]
         attr_reader :evaluator
 
         # @api private

data/lib/dry/schema/messages/yaml.rb

@@ -17,7 +17,15 @@ module Dry
 
       include Dry::Equalizer(:data)
 
-      attr_reader :data, :t
+      # Loaded localized message templates
+      #
+      # @return [Hash]
+      attr_reader :data
+
+      # Translation function     
+      #
+      # @return [Proc]
+      attr_reader :t
 
       # @api private
       def self.build(options = EMPTY_HASH)
@@ -81,7 +89,7 @@ module Dry
 
       # Merge messages from an additional path
       #
-      # @param [String] path
+      # @param [String] overrides
       #
       # @return [Messages::I18n]
       #

data/lib/dry/schema/namespaced_rule.rb

@@ -2,21 +2,33 @@
 
 module Dry
   module Schema
+    # A special rule type that is configured under a specified namespace
+    #
+    # This is used internally to create rules that can be properly handled
+    # by the message compiler in situations where a schema reuses another schema
+    # but it is configured to use a message namespace
+    #
+    # @api private
     class NamespacedRule
+      # @api private
       attr_reader :rule
 
+      # @api private
       attr_reader :namespace
 
+      # @api private
       def initialize(namespace, rule)
         @namespace = namespace
         @rule = rule
       end
 
+      # @api private
       def call(input)
         result = rule.call(input)
         Logic::Result.new(result.success?) { [:namespace, [namespace, result.to_ast]] }
       end
 
+      # @api private
       def ast(input=Undefined)
         [:namespace, [namespace, rule.ast(input)]]
       end

data/lib/dry/schema/params.rb

@@ -7,7 +7,7 @@ module Dry
     # Params schema type
     #
     # @see Processor
-    # @see Schema.Params
+    # @see Schema#Params
     #
     # @api public
     class Params < Processor

data/lib/dry/schema/path.rb

@@ -8,15 +8,17 @@ module Dry
     #
     # @api private
     class Path
+      include Comparable
       include Enumerable
 
-      # !@attribute [r] keys
-      #   @return [Array<Symbol>]
+      # @return [Array<Symbol>]
       attr_reader :keys
 
+      alias_method :root, :first
+
       # Coerce a spec into a path object
       #
-      # @param [Symbol, String, Hash, Array<Symbol>] spec
+      # @param [Path, Symbol, String, Hash, Array<Symbol>] spec
       #
       # @return [Path]
       #
@@ -29,10 +31,10 @@ module Dry
           new(spec.split(DOT).map(&:to_sym))
         when Hash
           new(keys_from_hash(spec))
-        when self
+        when Path
           spec
         else
-          raise ArgumentError, '+spec+ must be either a Symbol, Array or Hash'
+          raise ArgumentError, '+spec+ must be either a Symbol, Array, Hash or a Path'
         end
       end
 
@@ -62,12 +64,38 @@ module Dry
 
       # @api private
       def include?(other)
-        !find { |key| (idx = other.index(key)) && keys[idx].equal?(key) }.nil?
+        return false unless same_root?(other)
+        return false if index? && other.index? && !last.equal?(other.last)
+        self >= other
       end
 
       # @api private
       def <=>(other)
-        keys.count <=> other.count
+        raise ArgumentError, "Can't compare paths from different branches" unless same_root?(other)
+
+        return 0 if keys.eql?(other.keys)
+
+        res =
+          map { |key| (idx = other.index(key)) && keys[idx].equal?(key) }
+            .compact
+            .reject { |value| value.equal?(false) }
+
+        res.size < count ? 1 : -1
+      end
+
+      # @api private
+      def last
+        keys.last
+      end
+
+      # @api private
+      def same_root?(other)
+        root.equal?(other.root)
+      end
+
+      # @api private
+      def index?
+        last.is_a?(Integer)
       end
     end
   end

data/lib/dry/schema/predicate.rb

@@ -21,6 +21,10 @@ module Dry
           @predicate = predicate
         end
 
+        # Dump negated predicate to an AST
+        #
+        # @return [Array]
+        #
         # @api private
         def to_ast(*args)
           [:not, predicate.to_ast(*args)]
@@ -53,6 +57,9 @@ module Dry
 
       # Negate a predicate
       #
+      # @example
+      #   required(:name).value(:string) { !empty? }
+      #
       # @return [Negation]
       #
       # @api public
@@ -67,11 +74,17 @@ module Dry
         end
       end
 
+      # Compile predicate to a rule object
+      #
       # @api private
       def to_rule
         compiler.visit(to_ast)
       end
 
+      # Dump predicate to an AST
+      #
+      # @return [Array]
+      #
       # @api private
       def to_ast(*)
         [:predicate, [name, compiler.predicates.arg_list(name, *args)]]

data/lib/dry/schema/predicate_inferrer.rb

@@ -28,9 +28,8 @@ module Dry
       #
       # @api private
       class Compiler
-        # @!attribute [r] registry
-        #   @return [PredicateRegistry]
-        #   @api private
+        # @return [PredicateRegistry]
+        # @api private
         attr_reader :registry
 
         # @api private
@@ -72,9 +71,8 @@ module Dry
         end
 
         # @api private
-        def visit_safe(node)
-          other, * = node
-          visit(other)
+        def visit_lax(node)
+          visit(node)
         end
 
         # @api private
@@ -114,9 +112,8 @@ module Dry
         end
       end
 
-      # @!attribute [r] compiler
-      #   @return [Compiler]
-      #   @api private
+      # @return [Compiler]
+      # @api private
       attr_reader :compiler
 
       # @api private

data/lib/dry/schema/processor.rb

@@ -33,16 +33,17 @@ module Dry
       param :steps, default: -> { EMPTY_ARRAY.dup }
 
       class << self
-        # @!attribute [r] definition
-        #   Return DSL configured via #define
-        #   @return [DSL]
-        #   @api private
+        # Return DSL configured via #define
+        #
+        # @return [DSL]
+        # @api private
         attr_reader :definition
 
         # Define a schema for your processor class
         #
-        # @see Params
-        # @see JSON
+        # @see Schema#define
+        # @see Schema#Params
+        # @see Schema#JSON
         #
         # @return [Class]
         #

data/lib/dry/schema/result.rb

@@ -19,8 +19,11 @@ module Dry
 
       # @api private
       param :output
+
+      # Dump result to a hash returning processed and validated data
+      #
+      # @return [Hash]
       alias_method :to_h, :output
-      alias_method :to_hash, :output
 
       # @api private
       param :results, default: -> { EMPTY_ARRAY.dup }
@@ -72,7 +75,7 @@ module Dry
 
       # Check if there's an error for the provided spec
       #
-      # @param [Symbol, Hash<Symbol=>Symbol>] name
+      # @param [Symbol, Hash<Symbol=>Symbol>] spec
       #
       # @return [Boolean]
       #
@@ -103,7 +106,7 @@ module Dry
       #
       # @see #message_set
       #
-      # @return [Hash<Symbol=>Array>]
+      # @return [MessageSet]
       #
       # @api public
       def errors(options = EMPTY_HASH)

data/lib/dry/schema/value_coercer.rb

@@ -18,7 +18,7 @@ module Dry
       # @api private
       def call(input)
         if input.success?
-          type_schema[Hash(input)]
+          type_schema[input.to_h]
         else
           type_schema.each_with_object(EMPTY_HASH.dup) do |key, hash|
             name = key.name

data/lib/dry/schema/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Schema
-    VERSION = '0.6.0'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-schema
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -156,7 +156,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: |
+  dry-schema provides a DSL for defining schemas with keys and rules that should be applied to
+  values. It supports coercion, input sanitization, custom types and localized error messages
+  (with or without I18n gem). It's also used as the schema engine in dry-validation.
 email:
 - piotr.solnica@gmail.com
 executables: []
@@ -244,5 +247,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Schema coercion and validation
+summary: Coercion and validation for data structures
 test_files: []