definition 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e17d7407705fa6a48ed0a3852b73abe91688fbe
-  data.tar.gz: 118a8ad2dc4663c8666a25b68614f89f8546ab16
+SHA256:
+  metadata.gz: 4c7bb937fe678e70bbb9427ca24b8153471294150a657388b913aa095c0b5864
+  data.tar.gz: 579e9943b959417867e641284c0b94cde45ceb56c9d3738a98a37b6f100cd854
 SHA512:
-  metadata.gz: fe00bb7ab22dbc910ab68df1e054e5d15618d3e02d91a266c2f1fb07c48a4d95553c0071fbe3f5e3274d446d833491efd1753cca8d6ef625c25aa17747c129c6
-  data.tar.gz: 5cee41aff7c8c40cb54c533f6424046152fdcdfd9a971e17fc11209ec833b21e3834d77158c200430678d9683e9fcdc510aac0527838276fc502a74ab91b5451
+  metadata.gz: 7319c413e131eeef99ac40eb4b57cead39f27d86912651049bbe3276a333fc8aedafa77f08e13ce4fca4e973baf02e48a6ab49b07cbafb561f04fd3cf3224055
+  data.tar.gz: 34ffc1084ad2d22fb38248d9e88f9d4b13349c94e7376ec94eabd6765ff6986230612dc0f864f0b900fd56203cb8fb5f415889b47ab6427f0c85b1acf8ada029

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+# Use the latest 2.1 version of CircleCI pipeline process engine.
+# See: https://circleci.com/docs/2.0/configuration-reference
+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
+
+# Define a job to be invoked later in a workflow.
+# See: https://circleci.com/docs/2.0/configuration-reference/#jobs
+jobs:
+  test:
+    parameters:
+      image:
+        type: string
+    docker:
+      - image: << parameters.image>>
+    steps:
+      - checkout
+      - ruby/install-deps
+      - ruby/rspec-test
+  checking:
+    docker:
+      - image: 'cimg/ruby:2.7'
+    steps:
+      - checkout
+      - ruby/install-deps
+      - ruby/rubocop-check:
+          format: progress
+          label: Inspecting with Rubocop
+
+# Invoke jobs via workflows
+# See: https://circleci.com/docs/2.0/configuration-reference/#workflows
+workflows:
+  test: # This is the name of the workflow, feel free to change it to better match your workflow.
+    # Inside the workflow, you define the jobs you want to run.
+    jobs:
+      - 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

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Changelog.md

@@ -4,6 +4,22 @@ 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
+### Fixed
+- The `Keys` definition crashed with an error if the input was not a Hash
+
+## [0.6.0] - 2020-03-21
+### Added
+- Added include method to Keys Definition that allows to inline other `Keys` Definitions into each other
+
+## [0.5.2] - 2019-06-03
+### Fixed
+- added missing require for "pathname"
+
+## [0.5.1] - 2019-04-27
+### Fixed
+- Typo in error debug output
+
 ## [0.5.0] - 2019-03-28
 ### Added
 - CoercibleValueObject Definition for better nesting of ValueObjects

data/Gemfile.lock

@@ -0,0 +1,153 @@
+PATH
+  remote: .
+  specs:
+    definition (0.6.1)
+      activesupport
+      i18n
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      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)
+    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)
+    fuubar (2.5.1)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    jar-dependencies (0.4.1)
+    jaro_winkler (1.5.4)
+    jaro_winkler (1.5.4-java)
+    listen (3.7.0)
+      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)
+    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)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      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)
+    racc (1.6.0)
+    racc (1.6.0-java)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    rubocop_runner (2.2.0)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    spoon (0.0.6)
+      ffi
+    thor (1.1.0)
+    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
+  approvals (~> 0.0)
+  awesome_print
+  benchmark-ips
+  definition!
+  fuubar
+  guard
+  guard-rspec
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-its (~> 1.2)
+  rspec_junit_formatter
+  rubocop (= 0.66.0)
+  rubocop-rspec (= 1.32.0)
+  rubocop_runner
+  timecop
+
+BUNDLED WITH
+   2.2.33

data/README.md

@@ -1,6 +1,6 @@
 # Definition
 
-[![Build Status](https://travis-ci.org/Goltergaul/definition.svg?branch=master)][travis]
+[![Build Status](https://circleci.com/gh/Goltergaul/definition.svg?style=svg)][circleci]
 [![Gem Version](https://badge.fury.io/rb/definition.svg)][rubygems]
 
 Simple and composable validation and coercion of data structures. It also includes a ValueObject for convenience.
@@ -279,6 +279,35 @@ order = Definition.Keys do
 end
 ```
 
+### Extending Key definitions with include
+
+Besides composing Definitions, you can also include `Keys` Definitions in each 
+other. This will basically copy all required and optional keys as well as defaults into the other definition.
+
+```ruby
+address_definition = Definition.Keys do
+  required :street, Definition.Type(String)
+  required :postal_code, Definition.Type(String)
+  required :country_code, Definition.Type(String)
+end
+
+user_definition = Definition.Keys do
+  required :user, user_definition
+
+  include address_definition
+end
+```
+Above Definition will equal the following:
+```ruby
+user_definition = Definition.Keys do
+  required :user, user_definition
+
+  required :street, Definition.Type(String)
+  required :postal_code, Definition.Type(String)
+  required :country_code, Definition.Type(String)
+end
+```
+
 ### Predefined Definitions
 
 #### Strings and Arrays
@@ -343,11 +372,24 @@ Definition.Boolean.conform(tru) # => pass
 ```ruby
 Definition.Equal(5).conform(5) # => pass
 Definition.Equal("foo").conform("foo") # => pass
+```
 
+The Nilable Definition allows a value to be nil or to conform
+with the definition you pass it as argument:
+
+```ruby
 Definition.Nilable(Definition.Type(String)).conform(nil) # => pass
 Definition.Nilable(Definition.Type(String)).conform("foo") # => pass
 ```
 
+The Enum Definition checks if the input equals one of the values you pass it as argument. You can pass in as many arguments as you like:
+
+```ruby
+Definition.Enum("foo", 1, 2.0).conform("foo") # => pass
+Definition.Enum("foo", 1, 2.0).conform(1) # => pass
+Definition.Enum("foo", 1, 2.0).conform("bar) # => fail
+```
+
 ### Examples
 
 Check out the [integration specs](./spec/integration) for more usage examples.
@@ -381,5 +423,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Goltergaul/definition.
 
-[travis]: https://travis-ci.org/Goltergaul/definition
+[circleci]: https://circleci.com/gh/Goltergaul/definition
 [rubygems]: https://rubygems.org/gems/definition

data/config/locales/en.yml

@@ -20,3 +20,4 @@ en:
     keys:
       has_extra_key: "Hash has unexpected key %{key}"
       has_missing_key: "Hash is missing key %{key}"
+      not_a_hash: "Is not a Hash"

data/definition.gemspec

@@ -31,9 +31,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "rubocop", "0.66.0"
   spec.add_development_dependency "rubocop-rspec", "1.32.0"
   spec.add_development_dependency "rubocop_runner"

data/lib/definition/conform_error.rb

@@ -24,7 +24,7 @@ module Definition
     end
 
     def to_s
-      "<Definition::ConformError \n\t desciption: \"#{message}\", \n\t json_pointer: \"#{json_pointer}\">"
+      "<Definition::ConformError \n\t message: \"#{message}\", \n\t json_pointer: \"#{json_pointer}\">"
     end
 
     alias inspect to_s

data/lib/definition/dsl.rb

@@ -93,7 +93,7 @@ module Definition
     # Example:
     # Nilable(Definition.Type(Integer))
     def Nilable(definition) # rubocop:disable Style/MethodName
-      Types::Or.new(:nullable, Nil(), definition)
+      Types::Or.new(:nilable, Nil(), definition)
     end
   end
 end

data/lib/definition/i18n.rb

@@ -1,3 +1,5 @@
 # frozen_string_literal: true
 
+require "pathname"
+
 I18n.load_path += Dir[File.join(File.expand_path(Pathname(__dir__).join("../../config/locales/")), "*.yml")]

data/lib/definition/types/keys.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# frozen_string_literal: true
-
 require "definition/types/base"
 require "definition/types/include"
 require "definition/key_conform_error"
@@ -19,10 +17,6 @@ module Definition
           default(key, opts[:default]) if opts.key?(:default)
         end
 
-        def default(key, value)
-          defaults[key] = value
-        end
-
         def option(option_name)
           case option_name
           when :ignore_extra_keys
@@ -31,6 +25,36 @@ module Definition
             raise "Option #{option_name} is not defined"
           end
         end
+
+        def include(other)
+          raise ArgumentError.new("Included Definition can only be a Keys Definition") unless other.is_a?(Types::Keys)
+
+          ensure_keys_do_not_interfere(other)
+          other.required_definitions.each do |key, definition|
+            required(key, definition)
+          end
+          other.optional_definitions.each do |key, definition|
+            optional(key, definition)
+          end
+          other.defaults.each do |key, default|
+            default(key, default)
+          end
+        end
+
+        private
+
+        def default(key, value)
+          defaults[key] = value
+        end
+
+        def ensure_keys_do_not_interfere(other)
+          overlapping_keys = keys & other.keys
+          return if overlapping_keys.empty?
+
+          raise ArgumentError.new(
+            "Included definition tries to redefine already defined fields: #{overlapping_keys.join(', ')}"
+          )
+        end
       end
 
       include Dsl
@@ -60,9 +84,15 @@ module Definition
         end
 
         def conform
-          add_extra_key_errors unless definition.ignore_extra_keys
-          add_missing_key_errors
-          values = conform_all_keys
+          if valid_input_type?
+            add_extra_key_errors unless definition.ignore_extra_keys
+            add_missing_key_errors
+            values = conform_all_keys
+          else
+            errors.push(ConformError.new(definition,
+                                         "#{definition.name} is not a Hash",
+                                         i18n_key: "keys.not_a_hash"))
+          end
 
           ConformResult.new(values, errors: errors)
         end
@@ -71,6 +101,10 @@ module Definition
 
         attr_accessor :errors
 
+        def valid_input_type?
+          value.is_a?(Hash)
+        end
+
         def add_extra_key_errors
           extra_keys = value.keys - all_keys
           return if extra_keys.empty?

data/lib/definition/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: definition
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Dominik Goltermann
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +248,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - dominik@goltermann.cc
 executables: []
@@ -242,12 +256,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".approvals"
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Changelog.md
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
@@ -283,7 +298,7 @@ homepage: https://github.com/Goltergaul/definition
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -298,9 +313,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Simple and composable validation and coercion of data structures inspired
   by clojure specs

data/.travis.yml

@@ -1,21 +0,0 @@
-language: ruby
-rvm:
-  - jruby-9.1.17.0 # ruby 2.3
-  - jruby-9.2.0.0 # ruby 2.5
-  - jruby-head
-  - 2.3.0
-  - 2.4.0
-  - 2.5.0
-  - ruby-head
-jobs:
-  include:
-    - stage: linting
-      rvm: ruby-head
-      script: bundle exec rake rubocop
-    - stage: benchmark
-      script: bundle exec ruby benchmark/complex_example.rb
-      rvm: ruby-head
-    - script: bundle exec ruby benchmark/coercion.rb
-      rvm: ruby-head
-    - script: bundle exec ruby benchmark/validation_only.rb
-      rvm: ruby-head