kind 5.6.0 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b72fec7c07a6b3178717f30c81ecdbb6375cc1fc625c1a3fa1d39611e4dc3960
-  data.tar.gz: efec52f15083b538c99546f8d5e1c6b095c6c5c243379fc21365bae99a176e60
+  metadata.gz: a01866d3dbb6b0ae5977a7e711b35eaa2152471b4d52781a285de03ec9ef86a1
+  data.tar.gz: 8fd0cc81e96aa364a90f3c161e824d1a501296b4c4b40e2aca1e4286a75baaec
 SHA512:
-  metadata.gz: fad78e10047e8fdd21e4c56ddcc5c8620b1ad6018f3fdfb7af097b84be23bb73c3c549cd519bec3af7980c4df89fbc5b9db2796510c518a4ad9d9b9165ef6e02
-  data.tar.gz: 3d0fa5b46405e4a766285c6e3fd95e3568c5bb1875e310941a3dd592cd99372893c7aab6cfe91a321fc6a843c966ab5fb7414e726e903021b16b92dfc03bac1e
+  metadata.gz: 10282e2b8777f2d1a738a6ce38285fc9f17f0d9a6b3aec26d46409d995cb0004fde5c20a3998ef68a98530c5fa25ee463fba8f3501e5cbeb0cb2b01e0f2627ba
+  data.tar.gz: 7d16bf63dbb4928bef6182a7886e9268da869bddab12ac0e1192e39bac3fce2a4489ed308366188df4d6550047b2003e1b427f87430ec5e68c49c34a3974c13f

data/CHANGELOG.md

@@ -3,83 +3,85 @@
 This project follows [semver 2.0.0](http://semver.org/spec/v2.0.0.html) and the recommendations of [keepachangelog.com](http://keepachangelog.com/).
 
 - [Unreleased](#unreleased)
-- [5.6.0 (2021-05-14)](#560-2021-05-14)
+- [5.7.0 (2021-06-22)](#570-2021-06-22)
   - [Added](#added)
-- [5.5.0 (2021-04-05)](#550-2021-04-05)
+- [5.6.0 (2021-05-14)](#560-2021-05-14)
   - [Added](#added-1)
+- [5.5.0 (2021-04-05)](#550-2021-04-05)
+  - [Added](#added-2)
 - [5.4.1 (2021-03-26)](#541-2021-03-26)
   - [Fixed](#fixed)
 - [5.4.0 (2021-03-25)](#540-2021-03-25)
-  - [Added](#added-2)
-- [5.3.0 (2021-03-23)](#530-2021-03-23)
   - [Added](#added-3)
-- [5.2.0 (2021-03-17)](#520-2021-03-17)
+- [5.3.0 (2021-03-23)](#530-2021-03-23)
   - [Added](#added-4)
+- [5.2.0 (2021-03-17)](#520-2021-03-17)
+  - [Added](#added-5)
   - [Deprecated](#deprecated)
   - [Changes](#changes)
 - [5.1.0 (2021-02-23)](#510-2021-02-23)
-  - [Added](#added-5)
+  - [Added](#added-6)
   - [Deprecated](#deprecated-1)
 - [5.0.0 (2021-02-22)](#500-2021-02-22)
   - [Breaking Changes](#breaking-changes)
   - [Removed](#removed)
 - [4.1.0 (2021-02-22)](#410-2021-02-22)
-  - [Added](#added-6)
-- [4.0.0 (2021-02-22)](#400-2021-02-22)
   - [Added](#added-7)
+- [4.0.0 (2021-02-22)](#400-2021-02-22)
+  - [Added](#added-8)
   - [Deprecated](#deprecated-2)
   - [Fixed](#fixed-1)
 - [3.1.0 (2020-07-08)](#310-2020-07-08)
-  - [Added](#added-8)
+  - [Added](#added-9)
 - [3.0.0 (2020-06-25)](#300-2020-06-25)
   - [Breaking Changes](#breaking-changes-1)
-  - [Added](#added-9)
-- [2.3.0 (2020-06-24)](#230-2020-06-24)
   - [Added](#added-10)
-- [2.2.0 (2020-06-23)](#220-2020-06-23)
+- [2.3.0 (2020-06-24)](#230-2020-06-24)
   - [Added](#added-11)
-- [2.1.0 (2020-05-12)](#210-2020-05-12)
+- [2.2.0 (2020-06-23)](#220-2020-06-23)
   - [Added](#added-12)
+- [2.1.0 (2020-05-12)](#210-2020-05-12)
+  - [Added](#added-13)
   - [Breaking Changes](#breaking-changes-2)
 - [2.0.0 (2020-05-07)](#200-2020-05-07)
-  - [Added](#added-13)
+  - [Added](#added-14)
   - [Breaking Changes](#breaking-changes-3)
   - [Removed](#removed-1)
 - [1.9.0 (2020-05-06)](#190-2020-05-06)
-  - [Added](#added-14)
-- [1.8.0 (2020-05-03)](#180-2020-05-03)
   - [Added](#added-15)
+- [1.8.0 (2020-05-03)](#180-2020-05-03)
+  - [Added](#added-16)
 - [1.7.0 (2020-05-03)](#170-2020-05-03)
   - [Fixed](#fixed-2)
 - [1.6.0 (2020-04-17)](#160-2020-04-17)
-  - [Added](#added-16)
+  - [Added](#added-17)
   - [Changes](#changes-1)
 - [1.5.0 (2020-04-12)](#150-2020-04-12)
-  - [Added](#added-17)
-- [1.4.0 (2020-04-12)](#140-2020-04-12)
   - [Added](#added-18)
-- [1.3.0 (2020-04-12)](#130-2020-04-12)
+- [1.4.0 (2020-04-12)](#140-2020-04-12)
   - [Added](#added-19)
-- [1.2.0 (2020-04-12)](#120-2020-04-12)
+- [1.3.0 (2020-04-12)](#130-2020-04-12)
   - [Added](#added-20)
-- [1.1.0 (2020-04-09)](#110-2020-04-09)
+- [1.2.0 (2020-04-12)](#120-2020-04-12)
   - [Added](#added-21)
+- [1.1.0 (2020-04-09)](#110-2020-04-09)
+  - [Added](#added-22)
   - [Fixed](#fixed-3)
 - [1.0.0 (2020-03-16)](#100-2020-03-16)
-  - [Added](#added-22)
-- [0.6.0 (2020-01-06)](#060-2020-01-06)
   - [Added](#added-23)
-- [0.5.0 (2020-01-04)](#050-2020-01-04)
+- [0.6.0 (2020-01-06)](#060-2020-01-06)
   - [Added](#added-24)
-- [0.4.0 (2020-01-03)](#040-2020-01-03)
+- [0.5.0 (2020-01-04)](#050-2020-01-04)
   - [Added](#added-25)
-- [0.3.0 (2020-01-03)](#030-2020-01-03)
+- [0.4.0 (2020-01-03)](#040-2020-01-03)
   - [Added](#added-26)
+- [0.3.0 (2020-01-03)](#030-2020-01-03)
+  - [Added](#added-27)
   - [Breaking Changes](#breaking-changes-4)
 - [0.2.0 (2020-01-02)](#020-2020-01-02)
-  - [Added](#added-27)
-- [0.1.0 (2019-12-26)](#010-2019-12-26)
   - [Added](#added-28)
+- [0.1.0 (2019-12-26)](#010-2019-12-26)
+  - [Added](#added-29)
 
 ## Unreleased
 
@@ -91,6 +93,59 @@ This project follows [semver 2.0.0](http://semver.org/spec/v2.0.0.html) and the
 ### Fixed
 -->
 
+5.7.0 (2021-06-22)
+------------------
+
+### Added
+
+* [#58](https://github.com/serradura/kind/pull/58) - Add `Add Kind.assert_hash!(hash, keys:)`, you can use the `require_all:` option to check if the hashes have the same keys.
+  ```ruby
+  h1 = {a: 1, b: 1}
+
+  Kind.assert_hash!(h1, keys: [:a, :b])
+  Kind.assert_hash!(h1, keys: [:a]) # ArgumentError (Unknown key: :b. Valid keys are: :a)
+
+  # --
+
+  h2 = {'a' => 1, 'b' => 2}
+
+  Kind.assert_hash!(h2, keys: ['a', 'b'])
+  ```
+
+* [#58](https://github.com/serradura/kind/pull/58) - Add `Add Kind.assert_hash!(hash, schema:)`, you can use the `require_all:` option to check if the hashes have the same keys.
+  ```ruby
+  hash = {hash: {}, array: [], number: 1, string: 'foo', email: 'bar@bar.com', null: nil}
+
+  Kind.assert_hash!(hash, schema: {
+    hash: {},
+    array: [],
+    email: 'bar@bar.com',
+    string: 'foo',
+    number: 1,
+    null: nil
+  })
+
+  Kind.assert_hash!(hash, schema: {
+    hash: Enumerable,
+    array: Enumerable,
+    email: /\A.+@.+\..+\z/,
+    string: String
+  })
+
+  Kind.assert_hash!(hash, schema: {
+    hash: Hash,
+    array: Array,
+    email: String,
+    string: String
+  })
+
+  Kind.assert_hash!(h1, schema: {
+    email: ->(value) { value.is_a?(String) && value.include?('@') }
+  })
+  ```
+
+[⬆️  Back to Top](#changelog-)
+
 5.6.0 (2021-05-14)
 ------------------
 

data/README.md

@@ -42,7 +42,7 @@ So, I invite you to check out these features to see how they could be useful for
 Version    | Documentation
 ---------- | -------------
 unreleased | https://github.com/serradura/kind/blob/main/README.md
-5.6.0      | https://github.com/serradura/kind/blob/v5.x/README.md
+5.7.0      | https://github.com/serradura/kind/blob/v5.x/README.md
 4.1.0      | https://github.com/serradura/kind/blob/v4.x/README.md
 3.1.0      | https://github.com/serradura/kind/blob/v3.x/README.md
 2.3.0      | https://github.com/serradura/kind/blob/v2.x/README.md
@@ -125,7 +125,7 @@ unreleased | https://github.com/serradura/kind/blob/main/README.md
 | kind           | branch  | ruby               | activemodel    |
 | -------------- | ------- | ------------------ | -------------- |
 | unreleased     | main    | >= 2.1.0, <= 3.0.0 | >= 3.2, < 7.0  |
-| 5.6.0          | v5.x    | >= 2.1.0, <= 3.0.0 | >= 3.2, < 7.0  |
+| 5.7.0          | v5.x    | >= 2.1.0, <= 3.0.0 | >= 3.2, < 7.0  |
 | 4.1.0          | v4.x    | >= 2.2.0, <= 3.0.0 | >= 3.2, < 7.0  |
 | 3.1.0          | v3.x    | >= 2.2.0, <= 2.7   | >= 3.2, < 7.0  |
 | 2.3.0          | v2.x    | >= 2.2.0, <= 2.7   | >= 3.2, <= 6.0 |

data/lib/kind/__lib__/assert_hash_schema.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Kind
+  module ASSERT_HASH_KEYS
+    def self.require_all(keys, hash)
+      expected_keys = keys - hash.keys
+
+      unless expected_keys.empty?
+        raise KeyError.new("#{hash.inspect} expected to have these keys: #{expected_keys}")
+      end
+
+      unexpected_keys = hash.keys - keys
+
+      unless unexpected_keys.empty?
+        raise KeyError.new("#{hash.inspect} expected to NOT have these keys: #{unexpected_keys}")
+      end
+
+      hash
+    end
+  end
+
+  module ASSERT_HASH_SCHEMA
+    extend self
+
+    UnionType = ->(value) do
+      defined?(Kind::UnionType) ? Kind::UnionType === value : false
+    end
+
+    def any(hash, spec)
+      spec.each do |key, expected|
+        value = hash[key]
+        error_message = "The key #{key.inspect} has an invalid value"
+
+        case expected
+        when ::Module then assert_kind_of(expected, value, error_message)
+        when ::Proc then assert(expected.call(value), error_message)
+        when ::Regexp then assert_match(expected, value, error_message)
+        when ::NilClass then assert_nil(value, error_message)
+        when UnionType then assert(expected === value, error_message)
+        else assert_equal(expected, value, error_message)
+        end
+      end
+
+      hash
+    end
+
+    def all(hash, spec)
+      ASSERT_HASH_KEYS.require_all(spec.keys, hash)
+
+      any(hash, spec)
+    end
+
+    private
+
+      def assert_equal(expected, value, message)
+        raise_kind_error(message) if expected != value
+      end
+
+      def assert(value, message)
+        raise_kind_error(message) unless value
+      end
+
+      def assert_nil(value, message)
+        raise_kind_error(message) unless value.nil?
+      end
+
+      def assert_match(expected, value, message)
+        STRICT.kind_of(String, value)
+
+        raise_kind_error(message) if value !~ expected
+      end
+
+      def assert_kind_of(expected, value, message)
+        raise_kind_error(message) unless expected === value
+      end
+
+      def raise_kind_error(message)
+        raise Error.new(message)
+      end
+  end
+end

data/lib/kind/__lib__/strict.rb

@@ -6,6 +6,8 @@ module Kind
   module STRICT
     extend self
 
+    require 'kind/__lib__/assert_hash_schema'
+
     def error(kind_name, value, label = nil) # :nodoc:
       raise Error.new(kind_name, value, label: label)
     end
@@ -43,6 +45,41 @@ module Kind
 
       raise Error.new("#{label_text}expected to not be nil")
     end
+
+    def in!(list, value)
+      return value if list.include?(value)
+
+      raise Error.new("#{value} expected to be included in #{list.inspect}")
+    end
+
+    def assert_hash!(hash, options)
+      require_all = options[:require_all]
+
+      return assert_hash_keys!(hash, options[:keys], require_all) if options.key?(:keys)
+      return assert_hash_schema!(hash, options[:schema], require_all) if options.key?(:schema)
+
+      raise ArgumentError, ':keys or :schema is missing'
+    end
+
+    private
+
+      def assert_hash_keys!(hash, arg, require_all)
+        keys = Array(arg)
+
+        ASSERT_HASH_KEYS.require_all(keys, hash) if require_all
+
+        hash.each_key do |k|
+          unless keys.include?(k)
+            raise ArgumentError.new("Unknown key: #{k.inspect}. Valid keys are: #{keys.map(&:inspect).join(', ')}")
+          end
+        end
+      end
+
+      def assert_hash_schema!(hash, schema, require_all)
+        return ASSERT_HASH_SCHEMA.all(hash, schema) if require_all
+
+        ASSERT_HASH_SCHEMA.any(hash, schema)
+      end
   end
 
   private_constant :STRICT

data/lib/kind/basic.rb

@@ -2,8 +2,8 @@
 
 require 'kind/version'
 
-require 'kind/__lib__/kind'
 require 'kind/__lib__/undefined'
+require 'kind/__lib__/kind'
 
 require 'kind/basic/undefined'
 require 'kind/basic/error'
@@ -80,4 +80,16 @@ module Kind
   def or_nil(kind, value)
     return value if kind === value
   end
+
+  def in!(list, value)
+    STRICT.in!(list, value)
+  end
+
+  def include!(value, list)
+    STRICT.in!(list, value)
+  end
+
+  def assert_hash!(hash, **kargs)
+    STRICT.assert_hash!(hash, kargs)
+  end
 end

data/lib/kind/strict/disabled.rb

@@ -3,8 +3,14 @@
 module Kind
   module STRICT
     [
-      :object_is_a, :class!, :kind_of,
-      :module_or_class, :module!, :not_nil
+      :object_is_a,
+      :class!,
+      :kind_of,
+      :module_or_class,
+      :module!,
+      :not_nil,
+      :in!,
+      :assert_hash!
     ].each { |method_name| remove_method(method_name) }
 
     def object_is_a(_kind, value, _label = nil) # :nodoc:
@@ -30,5 +36,17 @@ module Kind
     def not_nil(value, label) # :nodoc:
       value
     end
+
+    def in!(list, value) # :nodoc:
+      value
+    end
+
+    def assert_hash!(hash, _options) # :nodoc:
+      hash
+    end
+
+    def assert_hash!(hash, _options) # :nodoc:
+      hash
+    end
   end
 end

data/lib/kind/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kind
-  VERSION = '5.6.0'
+  VERSION = '5.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kind
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.7.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-14 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies: []
 description: A development toolkit for Ruby with several small/cohesive abstractions
   (monads, enums, business logic, data validation...) to empower your development
@@ -34,6 +34,7 @@ files:
 - kind.gemspec
 - lib/kind.rb
 - lib/kind/__lib__/action_steps.rb
+- lib/kind/__lib__/assert_hash_schema.rb
 - lib/kind/__lib__/attributes.rb
 - lib/kind/__lib__/kind.rb
 - lib/kind/__lib__/of.rb