definition 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c7bb937fe678e70bbb9427ca24b8153471294150a657388b913aa095c0b5864
-  data.tar.gz: 579e9943b959417867e641284c0b94cde45ceb56c9d3738a98a37b6f100cd854
+  metadata.gz: 9de3bc4f221f0a67beb7c82f3d7bacfa86ab332cfc3ab7efe3f35bd6efeeeaca
+  data.tar.gz: a11b488ecb7fc5e3b2956dbb14c533631936b78d613f6f4a68c58e584cc25faa
 SHA512:
-  metadata.gz: 7319c413e131eeef99ac40eb4b57cead39f27d86912651049bbe3276a333fc8aedafa77f08e13ce4fca4e973baf02e48a6ab49b07cbafb561f04fd3cf3224055
-  data.tar.gz: 34ffc1084ad2d22fb38248d9e88f9d4b13349c94e7376ec94eabd6765ff6986230612dc0f864f0b900fd56203cb8fb5f415889b47ab6427f0c85b1acf8ada029
+  metadata.gz: cc464d58c56ef306fdc83868be3f67a7151c64e17f9f28d652584c94f73d2ce083308c1fd1c152bc667d57989f0e7fcbaea0e4a89a9aa30e9fb6093bfab18787
+  data.tar.gz: cad0aa2a4165e5ea329751dc8ded8a61f943e110a30d930afbcfec3b2ba2ea7686dccbe41ef322906fb56c8ab23df65f83913d794933d29a3f7907ec0d3e23db

data/.circleci/config.yml

@@ -5,26 +5,32 @@ version: 2.1
 # Orbs are reusable packages of CircleCI configuration that you may share across projects, enabling you to create encapsulated, parameterized commands, jobs, and executors that can be used across multiple projects.
 # See: https://circleci.com/docs/2.0/orb-intro/
 orbs:
-  ruby: circleci/ruby@1.2.0
+  ruby: circleci/ruby@1.4.0
 
 # Define a job to be invoked later in a workflow.
 # See: https://circleci.com/docs/2.0/configuration-reference/#jobs
 jobs:
   test:
     parameters:
-      image:
+      ruby_version:
         type: string
     docker:
-      - image: << parameters.image>>
+      - image: cimg/base:stable
     steps:
+      - ruby/install:
+          version: << parameters.ruby_version >>
       - checkout
-      - ruby/install-deps
+      - run: rm Gemfile.lock
+      - run: gem install bundler
+      - run: bundle install
       - ruby/rspec-test
-  checking:
+  linting:
     docker:
-      - image: 'cimg/ruby:2.7'
+      - image: 'cimg/base:stable'
     steps:
       - checkout
+      - ruby/install:
+          version: "3.0"
       - ruby/install-deps
       - ruby/rubocop-check:
           format: progress
@@ -39,5 +45,9 @@ workflows:
       - test: 
           matrix:
             parameters:
-              image: ["cimg/ruby:2.5", "cimg/ruby:2.6", "cimg/ruby:2.7", "circleci/jruby:9.3.1-jdk11", "circleci/jruby:9.2.20-jdk11"]
-      - checking
+              ruby_version:
+                - "2.6"
+                - "2.7"
+                - "3.0"
+                - "jruby-9.3.3.0"
+      - linting

data/.rubocop.yml

@@ -2,7 +2,7 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
     
 Metrics/LineLength:
   Max: 119

data/Changelog.md

@@ -4,7 +4,19 @@ 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.6.1] - 2020-03-21
+## Unreleased
+
+## [0.7.0] - 2022-02-25
+### Added
+- Lambda definitions can now be failed with custom error messages
+- Compatibility with Ruby 3.0
+### Fixed
+- In some cases errors from nested `Keys` definitions inside `Or` definitions got lost when listing the validation errors via the `error_hash` method on the conform result object.
+### Changed
+- When no sub-definition of an `Or` conforms, then only the errors of the last definition of the `Or` are collected. Previously the errors of all sub-definitions were collected.
+- Translated error messages have been improved to be more suitable to be used as end user error messages
+
+## [0.6.1] - 2021-12-14
 ### Fixed
 - The `Keys` definition crashed with an error if the input was not a Hash
 

data/Gemfile.lock

@@ -1,31 +1,29 @@
 PATH
   remote: .
   specs:
-    definition (0.6.1)
+    definition (0.7.0)
       activesupport
       i18n
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     approvals (0.0.25)
       nokogiri (~> 1.8)
       thor (~> 1.0)
     ast (2.4.2)
     awesome_print (1.9.2)
-    benchmark-ips (2.9.2)
+    benchmark-ips (2.10.0)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
-    ffi (1.15.4)
-    ffi (1.15.4-java)
-    formatador (0.3.0)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
     fuubar (2.5.1)
       rspec-core (~> 3.0)
       ruby-progressbar (~> 1.4)
@@ -43,66 +41,52 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (1.8.11)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    jar-dependencies (0.4.1)
     jaro_winkler (1.5.4)
-    jaro_winkler (1.5.4-java)
-    listen (3.7.0)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    mini_portile2 (2.6.1)
-    minitest (5.14.4)
+    minitest (5.15.0)
     nenv (0.3.0)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
-      racc (~> 1.4)
-    nokogiri (1.12.5-java)
-      racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-linux)
+    nokogiri (1.13.1-x86_64-linux)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.21.0)
-    parser (3.0.3.2)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry (0.14.1-java)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-      spoon (~> 0.0)
-    psych (4.0.2)
-    psych (4.0.2-java)
-      jar-dependencies (>= 0.1.7)
+    psych (4.0.3)
+      stringio
     racc (1.6.0)
-    racc (1.6.0-java)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    rb-fsevent (0.11.0)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
+      rspec-support (~> 3.11.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rspec_junit_formatter (0.4.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rspec_junit_formatter (0.5.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (0.66.0)
       jaro_winkler (~> 1.5.1)
@@ -117,18 +101,15 @@ GEM
     rubocop_runner (2.2.0)
     ruby-progressbar (1.11.0)
     shellany (0.0.1)
-    spoon (0.0.6)
-      ffi
-    thor (1.1.0)
+    stringio (3.0.1)
+    thor (1.2.1)
     timecop (0.9.4)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.5.0)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
-  universal-java-11
   x86_64-linux
 
 DEPENDENCIES
@@ -150,4 +131,4 @@ DEPENDENCIES
   timecop
 
 BUNDLED WITH
-   2.2.33
+   2.3.7

data/README.md

@@ -255,6 +255,24 @@ either be the original value or any transformed version of it. By not calling
 The first argument of `Definition.Lambda` is a name you can give this definition.
 It will only be used in the error message to make it more readable.
 
+If you want to provide detailed custom error messages you can use `fail_with`:
+
+```ruby
+Definition.Lambda(:password) do |value|
+  if !value.match(/[a-z]+/)
+    fail_with("must contain at least one lower case letter")
+  elsif !value.match(/[A-Z]+/)
+    fail_with("must contain at least one upper case letter") 
+  elsif !value.match(/\d+/)
+    fail_with("must contain at least one digit") 
+  elsif value.size < 6 || value.size > 50
+    fail_with("must be between 6 and 50 characters long") 
+  else
+    conform_with(value)
+  end
+end
+```
+
 ### Composing Definitions
 
 Definitions are reusable and can be easily composed:

data/config/locales/en.yml

@@ -1,23 +1,22 @@
 en:
   definition:
-    max_size: "Value is bigger then %{max_size}"
-    min_size: "Value is smaller then %{min_size}"
-    greater_then: "Value must be greater then %{min_value}"
-    greater_then_equal: "Value must be greater or eqaul to %{min_value}"
-    less_then: "Value must be less then %{max_value}"
-    less_then_equal: "Value must be less or eqaul to %{max_value}"
+    max_size: "Value is bigger than %{max_size}"
+    min_size: "Value is smaller than %{min_size}"
+    greater_then: "Value must be greater than %{min_value}"
+    greater_then_equal: "Value must be greater or equal to %{min_value}"
+    less_then: "Value must be less than %{max_value}"
+    less_then_equal: "Value must be less or equal to %{max_value}"
     equal: "Value must be equal to '%{expected_value}'"
     empty: "Value must be empty"
     non_empty: "Value must not be empty"
     nil: "Value must be nil"
+    each: "Is not an Array"
+    include: "Does not include %{value}"
     type: "Value is of wrong type, needs to be a %{class}"
     enum: "Value is not one of: %{allowed_values}"
-    each: "Not all values are valid"
-    and: "Not all definitions conform"
-    or: "None of the definitions conform"
     non_empty_string: "Value must be a non empty string"
-    regex: "Value dos not match regex %{regex}"
+    regex: "Value does not match regex %{regex}"
     keys:
-      has_extra_key: "Hash has unexpected key %{key}"
-      has_missing_key: "Hash is missing key %{key}"
-      not_a_hash: "Is not a Hash"
+      has_extra_key: "Is unexpected"
+      has_missing_key: "Is missing"
+      not_a_hash: "Is not a Hash"

data/lib/definition/conform_error.rb

@@ -4,16 +4,18 @@ require "i18n"
 
 module Definition
   class ConformError
-    def initialize(definition, message, sub_errors: [], i18n_key: definition.name)
+    def initialize(definition, message, sub_errors: [], **options)
       self.definition = definition
       self.message = message
       self.sub_errors = sub_errors
-      self.i18n_key = i18n_key
+      self.i18n_key = options.fetch(:i18n_key, definition.name)
+      self.i18n_context = options.fetch(:i18n_context, {})
+      self.translated_error = options.fetch(:translated_message, nil)
       assign_parents
     end
 
-    attr_accessor :definition, :sub_errors, :parent, :i18n_key
-    attr_writer :message
+    attr_accessor :definition, :sub_errors, :parent, :i18n_key, :i18n_context
+    attr_writer :message, :translated_error
 
     def message
       if sub_errors.empty?
@@ -50,10 +52,8 @@ module Definition
       sub_errors.map(&:leaf_errors).flatten
     end
 
-    def translated_error(namespace = "definition", vars: {})
-      namespace ||= "definition"
-      vars[:key] = key if respond_to?(:key)
-      ::I18n.t("#{namespace}.#{i18n_key}", definition.context.merge!(vars))
+    def translated_error(namespace = "definition")
+      @translated_error ||= definition.error_renderer.new(self, i18n_namespace: namespace).translated_error
     end
 
     private

data/lib/definition/conform_result.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/hash"
+require "active_support"
 
 module Definition
   class ConformResult

data/lib/definition/dsl.rb

@@ -41,11 +41,9 @@ module Definition
                                 "a primitive that has a coercion function defined")
       end
       Types::Type.new(:type, klass) do |value|
-        begin
-          method(klass.name).call(value)
-        rescue ArgumentError
-          value
-        end
+        method(klass.name).call(value)
+      rescue ArgumentError
+        value
       end
     end
 

data/lib/definition/key_conform_error.rb

@@ -4,9 +4,9 @@ require "definition/conform_error"
 
 module Definition
   class KeyConformError < ConformError
-    def initialize(definition, message, key:, sub_errors: [], i18n_key: definition.name)
+    def initialize(definition, message, key:, sub_errors: [], **options)
       self.key = key
-      super(definition, message, sub_errors: sub_errors, i18n_key: i18n_key)
+      super(definition, message, sub_errors: sub_errors, **options)
     end
 
     attr_accessor :key

data/lib/definition/types/and.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "definition/types/base"
+require "definition/types/error_renderers/leaf"
 
 module Definition
   module Types
@@ -23,6 +24,10 @@ module Definition
         Conformer.new(self).conform(value)
       end
 
+      def error_renderer
+        ErrorRenderers::Leaf
+      end
+
       class Conformer
         def initialize(definition)
           self.definition = definition

data/lib/definition/types/base.rb

@@ -2,6 +2,7 @@
 
 require "definition/conform_result"
 require "definition/conform_error"
+require "definition/types/error_renderers/standard"
 
 module Definition
   module Types
@@ -23,6 +24,10 @@ module Definition
       def conform(_value)
         raise NotImplementedError
       end
+
+      def error_renderer
+        ErrorRenderers::Standard
+      end
     end
   end
 end

data/lib/definition/types/each.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "definition/types/base"
+require "definition/types/error_renderers/leaf"
 
 module Definition
   module Types
@@ -16,6 +17,10 @@ module Definition
         Conformer.new(self).conform(value)
       end
 
+      def error_renderer
+        ErrorRenderers::Leaf
+      end
+
       class Conformer
         def initialize(definition)
           self.definition = definition

data/lib/definition/types/error_renderers/lambda.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "definition/types/error_renderers/standard"
+
+module Definition
+  module Types
+    module ErrorRenderers
+      class Lambda < Standard
+        def default
+          "Did not pass test for '#{conform_error.definition.name}'"
+        end
+      end
+    end
+  end
+end

data/lib/definition/types/error_renderers/leaf.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "definition/types/error_renderers/standard"
+
+module Definition
+  module Types
+    module ErrorRenderers
+      class Leaf < Standard
+        def translated_error(_namespace = "definition")
+          # When there are no sub errors, proceeding gets us into an infinite loop.
+          return i18n_error if conform_error.sub_errors.empty?
+
+          conform_error.leaf_errors.map(&:translated_error).join(", ")
+        end
+      end
+    end
+  end
+end

data/lib/definition/types/error_renderers/standard.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Definition
+  module Types
+    module ErrorRenderers
+      class Standard
+        def initialize(conform_error, i18n_namespace:)
+          self.conform_error = conform_error
+          self.i18n_namespace = i18n_namespace
+        end
+
+        def translated_error
+          i18n_error
+        end
+
+        private
+
+        def i18n_error
+          ::I18n.t("#{i18n_namespace}.#{conform_error.i18n_key}",
+                   **i18n_vars)
+        end
+
+        def i18n_vars
+          conform_error.definition.context.merge(
+            conform_error.i18n_context
+          ).tap do |vars|
+            vars[:default] = default if default
+          end
+        end
+
+        def default
+          nil
+        end
+
+        attr_accessor :conform_error, :i18n_namespace
+      end
+    end
+  end
+end

data/lib/definition/types/include.rb

@@ -38,7 +38,8 @@ module Definition
           definition.required_items.map do |item|
             next if value.include?(item)
 
-            KeyConformError.new(definition, "#{definition.name} does not include #{item.inspect}", key: item)
+            KeyConformError.new(definition, "#{definition.name} does not include #{item.inspect}",
+                                key: item, i18n_context: { value: item.inspect })
           end.compact
         end
 

data/lib/definition/types/lambda.rb

@@ -1,34 +1,65 @@
 # frozen_string_literal: true
 
 require "definition/types/base"
+require "definition/types/error_renderers/lambda"
 
 module Definition
   module Types
     class Lambda < Base
-      module Dsl
-        def conform_with(value)
-          ConformResult.new(value)
-        end
-      end
-      include Dsl
+      attr_accessor :conformity_test_lambda
 
-      def initialize(name, context: {}, &test_lambda)
-        self.test_lambda = test_lambda
+      def initialize(name, context: {}, &conformity_test_lambda)
+        self.conformity_test_lambda = conformity_test_lambda
         super(name, context: context)
       end
 
       def conform(value)
-        lambda_result = instance_exec(value, &test_lambda)
-        return lambda_result if lambda_result.is_a?(ConformResult)
+        Conformer.new(self).conform(value)
+      end
 
-        ConformResult.new(value, errors: [
-                            ConformError.new(self, "Did not pass test for #{name}")
-                          ])
+      def error_renderer
+        ErrorRenderers::Lambda
       end
 
-      private
+      class Conformer
+        module Dsl
+          def conform_with(value)
+            ConformResult.new(value)
+          end
+
+          def fail_with(error_message)
+            self.error_message = error_message
+          end
+        end
+        include Dsl
+
+        def initialize(definition)
+          self.definition = definition
+        end
+
+        def conform(value)
+          lambda_result = instance_exec(value, &definition.conformity_test_lambda)
+          return lambda_result if lambda_result.is_a?(ConformResult)
 
-      attr_accessor :test, :test_lambda
+          failure_result_with(value, error_message)
+        end
+
+        private
+
+        attr_accessor :definition, :error_message
+
+        def standard_error_message
+          "Did not pass test for #{definition.name}"
+        end
+
+        def failure_result_with(value, error_message)
+          ConformResult.new(value, errors: [
+                              ConformError.new(definition,
+                                               standard_error_message,
+                                               translated_message: error_message)
+                            ])
+        end
+      end
     end
   end
 end

data/lib/definition/types/or.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "definition/types/base"
+require "definition/types/error_renderers/leaf"
 
 module Definition
   module Types
@@ -23,6 +24,10 @@ module Definition
         Conformer.new(self).conform(value)
       end
 
+      def error_renderer
+        ErrorRenderers::Leaf
+      end
+
       class Conformer
         def initialize(definition)
           self.definition = definition
@@ -34,7 +39,8 @@ 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}'."\
+                                     " Errors for last tested definition:",
                                      sub_errors: result)
             ConformResult.new(value, errors: [error])
           end
@@ -48,7 +54,7 @@ module Definition
             result = definition.conform(value)
             return result if result.passed?
 
-            errors.push(result.error_tree)
+            errors = result.error_tree
           end
 
           errors.flatten

data/lib/definition/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: definition
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Dominik Goltermann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-14 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -286,6 +286,9 @@ files:
 - lib/definition/types/and.rb
 - lib/definition/types/base.rb
 - lib/definition/types/each.rb
+- lib/definition/types/error_renderers/lambda.rb
+- lib/definition/types/error_renderers/leaf.rb
+- lib/definition/types/error_renderers/standard.rb
 - lib/definition/types/include.rb
 - lib/definition/types/keys.rb
 - lib/definition/types/lambda.rb