definition 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3f3d334a06ce14e9f9f6eecccbc59206c11a293cd66b06cb8d20661698fb198
-  data.tar.gz: 59df3ceb4ff7643eea3eac301ad735969fafe31e7cbd6de89227fa4383beb348
+  metadata.gz: 6b8b872d14fc97965062a65fcc1d75987cfd7b21c448fe4f61dfda1f11fd003b
+  data.tar.gz: 3195829dcc11b18abe5fa12826cefb2d16f70ce8d2bb127f715dc4ee6193b181
 SHA512:
-  metadata.gz: 9e41d56a6e2eba1cc0e11adda3b69de22ce94d5de3d6ce01973c48548908745a8eb88329aa9b3f09d57f54231fc87a8eca0e614635902e1a9bb79809eed29816
-  data.tar.gz: b475ec666afc58aa64ac440be548b9c475c55ec4598ba7de97d9d413d9d11f12492a96736c6cb639d6bf65fdb7cf04c9197c67b0d2ca36bf4cfac7794ad09eba
+  metadata.gz: 4861a2c4f8ee02c9706546b24dbf9040edc02e6ba8d05f6038529f7132d72d35403de1e079d46d40bb5b00e1d5e65fa2be93781cff4e920da58f5e835f84f242
+  data.tar.gz: 53c7365d464f2fed498ebb405dac60bffd5d960dd643485ff571c06c3bb76ca593bd7a2758295011e27f1c35cc38c7da687935f280fad03704791d5b412387ed

data/.rubocop.yml

@@ -24,10 +24,6 @@ Metrics/MethodLength:
 Style/Documentation:
   Enabled: false
 
-Style/AlignHash:
-  EnforcedColonStyle: table
-  EnforcedHashRocketStyle: table
-
 Layout/AlignHash:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table
@@ -35,10 +31,6 @@ Layout/AlignHash:
 Style/HashSyntax:
   EnforcedStyle: ruby19_no_mixed_keys
 
-Style/MultilineOperationIndentation:
-  Description: Checks indentation of binary operations that span more than one line.
-  EnforcedStyle: indented
-
 Layout/MultilineOperationIndentation:
   Description: Checks indentation of binary operations that span more than one line.
   EnforcedStyle: indented

data/Changelog.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2019-03-22
+### Added
+- Added support for default values to Keys Definition
+### Changed
+- Errors returned from ConformResult were restructured for better debugging and usage
+
 ## [0.3.0] - 2019-02-03
 ### Added
 - Added I18n translation support for errors

data/README.md

@@ -41,7 +41,9 @@ conform_result.error_message # => hash fails validation for key birthday: { Is o
 conform_result.error_hash # =>
 # {
 #     :birthday => [
-#         [0] "Value is of wrong type, needs to be a Date"
+#         [0] <Definition::ConformError
+#               desciption: "hash fails validation for key birthday: { Is of type String instead of Date }",
+#               json_pointer: "/birthday">
 #     ]
 # }
 ```
@@ -107,6 +109,8 @@ array.first # => 1
 IntegerArray.new([1,2,"3"]) # => Definition::InvalidValueObjectError: Not all items conform with each: { Item "3" did not conform to each: { Is of type String instead of Integer } }
 ```
 
+You can access the conform result object via `InvalidValueObjectError#conform_result`
+
 ### Conforming Hashes
 
 Hashes can be conformed by using the `Keys` definition. It allows you to configure
@@ -116,10 +120,13 @@ needs to have a Symbol key with that name, otherwise a string key.
 
 The key definition will also fail if the input value contains extra keys.
 
+You can configure default values for optional keys, see the following example.
+
 ```ruby
 Definition.Keys do
-  required :title, Definition.Type(String)
+  required :title, Definition.NonEmptyString
   optional :publication_date, Definition.Type(Date)
+  optional :is_draft, Definition.Boolean, default: true
 end
 ```
 
@@ -301,11 +308,9 @@ Every error object has a method `translated_error` that will give you a translat
 version of the error message. You can load the default English translations shipped
 with the gem by adding them to your I18n load path.
 
-If you use the `error_hash` method on a `ConformResult` you also get the translated
-error messages
 
 ```ruby
-chema = Definition.Keys do
+schema = Definition.Keys do
   required :title, Definition.Type(String)
   required :body, Definition.Type(String)
   required(:author, Definition.Keys do
@@ -313,14 +318,7 @@ chema = Definition.Keys do
     required :email, Definition.Type(String)
   end)
 end
-result.error_hash # =>
-# {
-#     :author => {
-#         :email => [
-#             [0] "Value is of wrong type, needs to be a String"
-#         ]
-#     }
-# }
+schema.conform(input_hash).errors.first.translated_error # => Value is of wrong type, needs to be a String"
 ```
 
 ## Development

data/benchmark/coercion.rb

@@ -4,7 +4,9 @@ require "bundler/inline"
 
 gemfile do
   source "https://rubygems.org"
-  gem "dry-validation"
+  # FIXME: benchmark needs to be updated to work with dry-validation 1.0.0"
+  gem "dry-validation", "< 1.0.0"
+  gem "dry-types", "< 0.15"
   gem "awesome_print"
   gem "benchmark-ips"
   gem "pry"

data/benchmark/complex_example.rb

@@ -4,7 +4,9 @@ require "bundler/inline"
 
 gemfile do
   source "https://rubygems.org"
-  gem "dry-validation"
+  # FIXME: benchmark needs to be updated to work with dry-validation 1.0.0"
+  gem "dry-validation", "< 1.0.0"
+  gem "dry-types", "< 0.15"
   gem "awesome_print"
   gem "benchmark-ips"
   gem "pry"

data/benchmark/validation_only.rb

@@ -4,7 +4,9 @@ require "bundler/inline"
 
 gemfile do
   source "https://rubygems.org"
-  gem "dry-validation"
+  # FIXME: benchmark needs to be updated to work with dry-validation 1.0.0"
+  gem "dry-validation", "< 1.0.0"
+  gem "dry-types", "< 0.15"
   gem "awesome_print"
   gem "benchmark-ips"
   gem "definition", path: File.expand_path("../.", __dir__)

data/definition.gemspec

@@ -34,8 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-its", "~> 1.2"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "rubocop", "0.66.0"
+  spec.add_development_dependency "rubocop-rspec", "1.32.0"
   spec.add_development_dependency "rubocop_runner"
   spec.add_development_dependency "timecop"
 end

data/lib/definition/conform_error.rb

@@ -23,6 +23,12 @@ module Definition
       end
     end
 
+    def to_s
+      "<Definition::ConformError \n\t desciption: \"#{message}\", \n\t json_pointer: \"#{json_pointer}\">"
+    end
+
+    alias inspect to_s
+
     def error_path
       current = self
       path = current.is_a?(KeyConformError) ? [key] : []

data/lib/definition/conform_result.rb

@@ -16,31 +16,27 @@ module Definition
     end
     alias conformed? passed?
 
-    def descriptive_errors
-      errors.map do |e|
-        {
-          description: e.message,
-          pointer:     e.json_pointer
-        }
-      end
-    end
-
     def error_message
       error_tree.map(&:message).join(", ")
     end
 
-    def errors
+    def leaf_errors
       conform_errors.map(&:leaf_errors).flatten
     end
 
-    def error_hash(i18n_namespace: nil)
+    def errors
+      leaf_errors.map do |error|
+        find_next_parent_key_error(error) || error
+      end.compact.uniq
+    end
+
+    def error_hash
       {}.tap do |error_hash|
         errors.each do |error|
           next if error.error_path.empty?
 
-          message = error.translated_error(i18n_namespace)
           path_hash = error.error_path.reverse
-                           .inject([message]) { |messages, key| { key => messages } }
+                           .inject([error]) { |errors, key| { key => errors } }
 
           error_hash.deep_merge!(path_hash) do |_key, old, new|
             old + new if old.is_a?(Array) && new.is_a?(Array) # concat arrays during deep_merge
@@ -55,6 +51,17 @@ module Definition
 
     private
 
+    def find_next_parent_key_error(error)
+      current = error
+      loop do
+        return current if current.is_a?(KeyConformError)
+
+        current = current.parent
+        break unless current
+      end
+      nil
+    end
+
     attr_accessor :conform_errors
   end
 end

data/lib/definition/dsl.rb

@@ -9,7 +9,7 @@ module Definition
     #   required :name, Types::Type(String)
     #   optional :age, Types::Type(Integer)
     # end
-    def Keys(&block) # rubocop:disable Naming/MethodName
+    def Keys(&block) # rubocop:disable Style/MethodName
       Types::Keys.new(:hash).tap do |instance|
         instance.instance_exec(&block)
       end
@@ -17,25 +17,25 @@ module Definition
 
     # Example:
     # And(Types::Type(Float), Types::GreaterThen(10.0))
-    def And(*definitions) # rubocop:disable Naming/MethodName
+    def And(*definitions) # rubocop:disable Style/MethodName
       Types::And.new(:and, *definitions)
     end
 
     # Example:
     # Or(Types::Type(Float), Types::Type(Integer))
-    def Or(*definitions) # rubocop:disable Naming/MethodName
+    def Or(*definitions) # rubocop:disable Style/MethodName
       Types::Or.new(:or, *definitions)
     end
 
     # Example:
     # Type(Integer)
-    def Type(klass) # rubocop:disable Naming/MethodName
+    def Type(klass) # rubocop:disable Style/MethodName
       Types::Type.new(:type, klass)
     end
 
     # Example:
     # CoercibleType(Integer)
-    def CoercibleType(klass) # rubocop:disable Naming/MethodName
+    def CoercibleType(klass) # rubocop:disable Style/MethodName
       unless Kernel.respond_to?(klass.name)
         raise ArgumentError.new("#{klass} can't be used as CoercibleType because its not "\
                                 "a primitive that has a coercion function defined")
@@ -53,13 +53,13 @@ module Definition
     # Lambda(:even) do |value|
     #   value.even?
     # end
-    def Lambda(name, context: {}, &block) # rubocop:disable Naming/MethodName
+    def Lambda(name, context: {}, &block) # rubocop:disable Style/MethodName
       Types::Lambda.new(name, context: context, &block)
     end
 
     # Example:
     # Enum("allowed_value1", "allowed_value2")
-    def Enum(*allowed_values) # rubocop:disable Naming/MethodName
+    def Enum(*allowed_values) # rubocop:disable Style/MethodName
       Lambda("enum", context: { allowed_values: allowed_values }) do |value|
         conform_with(value) if allowed_values.include?(value)
       end
@@ -67,8 +67,14 @@ module Definition
 
     # Example:
     # Each(Definition::Type(Integer))
-    def Each(definition) # rubocop:disable Naming/MethodName
+    def Each(definition) # rubocop:disable Style/MethodName
       Types::Each.new(:each, definition: definition)
     end
+
+    # Example:
+    # Boolean
+    def Boolean # rubocop:disable Style/MethodName
+      Types::Or.new(:boolean, Type(TrueClass), Type(FalseClass))
+    end
   end
 end

data/lib/definition/dsl/comparators.rb

@@ -5,7 +5,7 @@ module Definition
     module Comparators
       # Example:
       # MaxSize(5)
-      def MaxSize(max_size) # rubocop:disable Naming/MethodName
+      def MaxSize(max_size) # rubocop:disable Style/MethodName
         Types::Lambda.new(:max_size, context: { max_size: max_size }) do |value|
           case value
           when String, Enumerable
@@ -18,7 +18,7 @@ module Definition
 
       # Example:
       # MinSize(5)
-      def MinSize(min_size) # rubocop:disable Naming/MethodName
+      def MinSize(min_size) # rubocop:disable Style/MethodName
         Types::Lambda.new(:min_size, context: { min_size: min_size }) do |value|
           case value
           when String, Enumerable
@@ -31,13 +31,13 @@ module Definition
 
       # Example:
       # NonEmptyString
-      def NonEmptyString # rubocop:disable Naming/MethodName
+      def NonEmptyString # rubocop:disable Style/MethodName
         Types::And.new(:non_empty_string, Type(String), MinSize(1))
       end
 
       # Example:
       # GreaterThen(5)
-      def GreaterThen(min_value) # rubocop:disable Naming/MethodName
+      def GreaterThen(min_value) # rubocop:disable Style/MethodName
         Types::Lambda.new("greater_then", context: { min_value: min_value }) do |value|
           conform_with(value) if value.is_a?(Numeric) && value > min_value
         end
@@ -45,7 +45,7 @@ module Definition
 
       # Example:
       # GreaterThenEqual(5)
-      def GreaterThenEqual(min_value) # rubocop:disable Naming/MethodName
+      def GreaterThenEqual(min_value) # rubocop:disable Style/MethodName
         Types::Lambda.new("greater_then_equal", context: { min_value: min_value }) do |value|
           conform_with(value) if value.is_a?(Numeric) && value >= min_value
         end
@@ -53,7 +53,7 @@ module Definition
 
       # Example:
       # LessThen(5)
-      def LessThen(max_value) # rubocop:disable Naming/MethodName
+      def LessThen(max_value) # rubocop:disable Style/MethodName
         Types::Lambda.new("less_then", context: { max_value: max_value }) do |value|
           conform_with(value) if value.is_a?(Numeric) && value < max_value
         end
@@ -61,7 +61,7 @@ module Definition
 
       # Example:
       # LessThenEqual(5)
-      def LessThenEqual(max_value) # rubocop:disable Naming/MethodName
+      def LessThenEqual(max_value) # rubocop:disable Style/MethodName
         Types::Lambda.new("less_then_equal", context: { max_value: max_value }) do |value|
           conform_with(value) if value.is_a?(Numeric) && value <= max_value
         end
@@ -69,7 +69,7 @@ module Definition
 
       # Example:
       # Equal("value")
-      def Equal(expected_value) # rubocop:disable Naming/MethodName
+      def Equal(expected_value) # rubocop:disable Style/MethodName
         Types::Lambda.new(:equal, context: { expected_value: expected_value }) do |value|
           conform_with(value) if value == expected_value
         end
@@ -77,7 +77,7 @@ module Definition
 
       # Example:
       # Empty
-      def Empty # rubocop:disable Naming/MethodName
+      def Empty # rubocop:disable Style/MethodName
         Types::Lambda.new(:empty) do |value|
           case value
           when String, Array, Hash
@@ -90,7 +90,7 @@ module Definition
 
       # Example:
       # NonEmpty
-      def NonEmpty # rubocop:disable Naming/MethodName
+      def NonEmpty # rubocop:disable Style/MethodName
         Types::Lambda.new(:non_empty) do |value|
           case value
           when String, Array, Hash
@@ -103,7 +103,7 @@ module Definition
 
       # Example:
       # Regex
-      def Regex(regex, name: :regex) # rubocop:disable Naming/MethodName
+      def Regex(regex, name: :regex) # rubocop:disable Style/MethodName
         Types::Lambda.new(name, context: { regex: regex.inspect }) do |value|
           case value
           when String

data/lib/definition/dsl/nil.rb

@@ -5,7 +5,7 @@ module Definition
     module Nil
       # Example:
       # Nil
-      def Nil # rubocop:disable Naming/MethodName
+      def Nil # rubocop:disable Style/MethodName
         Types::Lambda.new(:nil) do |value|
           conform_with(value) if value.nil?
         end

data/lib/definition/types/and.rb

@@ -35,7 +35,7 @@ module Definition
             ConformResult.new(results.last.value)
           else
             ConformResult.new(value, errors: [
-                                ConformError.new(definition, "Not all definitions are valid for #{definition.name}",
+                                ConformError.new(definition, "Not all definitions are valid for '#{definition.name}'",
                                                  sub_errors: results.map(&:error_tree).flatten)
                               ])
           end

data/lib/definition/types/each.rb

@@ -30,7 +30,7 @@ module Definition
             ConformResult.new(results.map(&:value))
           else
             ConformResult.new(value, errors: [ConformError.new(definition,
-                                                               "Not all items conform with #{definition.name}",
+                                                               "Not all items conform with '#{definition.name}'",
                                                                sub_errors: errors(results))])
           end
         end

data/lib/definition/types/keys.rb

@@ -14,18 +14,24 @@ module Definition
           required_definitions[key] = definition
         end
 
-        def optional(key, definition)
+        def optional(key, definition, **opts)
           optional_definitions[key] = definition
+          default(key, opts[:default]) if opts.key?(:default)
+        end
+
+        def default(key, value)
+          defaults[key] = value
         end
       end
 
       include Dsl
-      attr_accessor :required_definitions, :optional_definitions
+      attr_accessor :required_definitions, :optional_definitions, :defaults
 
-      def initialize(name, req: {}, opt: {})
+      def initialize(name, req: {}, opt: {}, defaults: {})
         super(name)
         self.required_definitions = req
         self.optional_definitions = opt
+        self.defaults = defaults
       end
 
       def conform(value)
@@ -73,7 +79,7 @@ module Definition
           required_keys_values = conform_definitions(required_definitions)
           optional_keys_values = conform_definitions(optional_definitions)
 
-          required_keys_values.merge!(optional_keys_values)
+          definition.defaults.merge(required_keys_values.merge!(optional_keys_values))
         end
 
         def all_keys

data/lib/definition/types/or.rb

@@ -34,7 +34,7 @@ module Definition
             result
           else
             error = ConformError.new(definition,
-                                     "None of the definitions are valid for #{definition.name}",
+                                     "None of the definitions are valid for '#{definition.name}'",
                                      sub_errors: result)
             ConformResult.new(value, errors: [error])
           end

data/lib/definition/value_object.rb

@@ -1,13 +1,20 @@
 # frozen_string_literal: true
 
 module Definition
-  class InvalidValueObjectError < StandardError; end
+  class InvalidValueObjectError < StandardError
+    attr_accessor :conform_result
+
+    def initialize(conform_result)
+      super(conform_result.error_message)
+      self.conform_result = conform_result
+    end
+  end
   class NotConfiguredError < StandardError; end
 
   class ValueObject < SimpleDelegator
     def initialize(args = nil, **kwargs)
       result = self.class.conform(args || kwargs)
-      raise InvalidValueObjectError.new(result.error_message) unless result.passed?
+      raise InvalidValueObjectError.new(result) unless result.passed?
 
       super(result.value.freeze)
     end

data/lib/definition/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Definition
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: definition
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Dominik Goltermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -182,30 +182,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.66.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.66.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.32.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.32.0
 - !ruby/object:Gem::Dependency
   name: rubocop_runner
   requirement: !ruby/object:Gem::Requirement