definition 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db6d3a697d9641388ce9045cd7b9504d485e165480339e864dca6fe096289c6f
-  data.tar.gz: ef5adc969fde0a0ca0a3e3b9a365cbce588379d2e0bd47be36567b2f4568e7e9
+  metadata.gz: b4e5ac14f31ff6bdd8bab587f652fa408ac28285c92bedf457ded9383cc8a5a9
+  data.tar.gz: 8ed978aa993d0b68fd95dbc24e5800ab38b416c39798a33c8f6f039dfce201d7
 SHA512:
-  metadata.gz: 800d13aa9d79318e639eaa969ab6d5d5e8737160f0852df873e38e18685ac58b6133f81e8327de2a937e6a9432e8e68ef26bf0b3758fad4a6c757db5b134572d
-  data.tar.gz: 52082265fba3abe62846ccf4236888c9d5f6f2e04a9e265282da1526572b3e39b5c3bed3e6490fb5e98525165f74caed5064bdbc479053471e913175313ab353
+  metadata.gz: 63f912d53159f378ec03ff69d9907978e739f96bb994f89f9131d3ee53f2b07ce0621aa2cae6ddf5b81d475dc63543b24f1da2474476e96c62f22e3f7d5ae3b3
+  data.tar.gz: 60234129f0693be1e83b1265c3a435bbf3e3cea4990a882a722722f022f31b02736378c53cfc9f17d4ada50163d0bfc33f14c21b92899466110ab9ce53461bac

data/.travis.yml

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

data/Changelog.md

@@ -4,6 +4,10 @@ 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] - 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"

data/README.md

@@ -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

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

data/lib/definition/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: definition
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Dominik Goltermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2020-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport