kind 5.6.0 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b72fec7c07a6b3178717f30c81ecdbb6375cc1fc625c1a3fa1d39611e4dc3960
-  data.tar.gz: efec52f15083b538c99546f8d5e1c6b095c6c5c243379fc21365bae99a176e60
+  metadata.gz: 195bae736a96e62b9320b209bc7845d6e8c39714342ccb34dfe5bf1ea7c169d8
+  data.tar.gz: 2cbf9ba591a62456ff1faf3f8e8e8b1052b9f2c61d96a9a8df62b7ba595a5ac4
 SHA512:
-  metadata.gz: fad78e10047e8fdd21e4c56ddcc5c8620b1ad6018f3fdfb7af097b84be23bb73c3c549cd519bec3af7980c4df89fbc5b9db2796510c518a4ad9d9b9165ef6e02
-  data.tar.gz: 3d0fa5b46405e4a766285c6e3fd95e3568c5bb1875e310941a3dd592cd99372893c7aab6cfe91a321fc6a843c966ab5fb7414e726e903021b16b92dfc03bac1e
+  metadata.gz: 37e37d949dda2c0bbe11642742473200ff42d4300d63642819532fd32beec8485c953588ad100b2c771ec0e8528281d5535180aa21ceb1e53dfe45f992ad7141
+  data.tar.gz: 93e92d5db75442cb9c637924d731eec70f7324d50f9c2da91100b1bc916ef8a8ab8c7ea1bbf7590107141a1fc9e81181f51bc5c2848500f0ed7bc940adbaa36f

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+
+name: build
+on: [pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 3.0]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Test and generate coverage
+        run: bin/test
+      - name: Format coverage
+        if: ${{ matrix.ruby >= 3 }}
+        run: bin/prepare_coverage
+      - uses: paambaati/codeclimate-action@v2.7.5
+        if: ${{ matrix.ruby >= 3 }}
+        env:
+          CC_TEST_REPORTER_ID: 9561ceed21b6724aea8063e82e5700bc8266e962978089594bf2d8f8ca5ffc94
+        with:
+          debug: true
+          coverageLocations: coverage/.resultset.json:simplecov

data/.gitignore

@@ -9,3 +9,4 @@
 
 Gemfile.lock
 .foo
+.tool-versions

data/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "cSpell.enabled": true,
+  "cSpell.ignoreWords": [
+    "paambaati",
+    "resultset",
+    "simplecov"
+  ]
+}

data/CHANGELOG.md

@@ -3,83 +3,91 @@
 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.9.0 (2021-09-22)](#590-2021-09-22)
   - [Added](#added)
-- [5.5.0 (2021-04-05)](#550-2021-04-05)
+- [5.8.1 (2021-09-22)](#581-2021-09-22)
+  - [Fixed](#fixed)
+- [5.8.0 (2021-09-22)](#580-2021-09-22)
   - [Added](#added-1)
+- [5.7.0 (2021-06-22)](#570-2021-06-22)
+  - [Added](#added-2)
+- [5.6.0 (2021-05-14)](#560-2021-05-14)
+  - [Added](#added-3)
+- [5.5.0 (2021-04-05)](#550-2021-04-05)
+  - [Added](#added-4)
 - [5.4.1 (2021-03-26)](#541-2021-03-26)
-  - [Fixed](#fixed)
+  - [Fixed](#fixed-1)
 - [5.4.0 (2021-03-25)](#540-2021-03-25)
-  - [Added](#added-2)
+  - [Added](#added-5)
 - [5.3.0 (2021-03-23)](#530-2021-03-23)
-  - [Added](#added-3)
+  - [Added](#added-6)
 - [5.2.0 (2021-03-17)](#520-2021-03-17)
-  - [Added](#added-4)
+  - [Added](#added-7)
   - [Deprecated](#deprecated)
   - [Changes](#changes)
 - [5.1.0 (2021-02-23)](#510-2021-02-23)
-  - [Added](#added-5)
+  - [Added](#added-8)
   - [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)
+  - [Added](#added-9)
 - [4.0.0 (2021-02-22)](#400-2021-02-22)
-  - [Added](#added-7)
+  - [Added](#added-10)
   - [Deprecated](#deprecated-2)
-  - [Fixed](#fixed-1)
+  - [Fixed](#fixed-2)
 - [3.1.0 (2020-07-08)](#310-2020-07-08)
-  - [Added](#added-8)
+  - [Added](#added-11)
 - [3.0.0 (2020-06-25)](#300-2020-06-25)
   - [Breaking Changes](#breaking-changes-1)
-  - [Added](#added-9)
+  - [Added](#added-12)
 - [2.3.0 (2020-06-24)](#230-2020-06-24)
-  - [Added](#added-10)
+  - [Added](#added-13)
 - [2.2.0 (2020-06-23)](#220-2020-06-23)
-  - [Added](#added-11)
+  - [Added](#added-14)
 - [2.1.0 (2020-05-12)](#210-2020-05-12)
-  - [Added](#added-12)
+  - [Added](#added-15)
   - [Breaking Changes](#breaking-changes-2)
 - [2.0.0 (2020-05-07)](#200-2020-05-07)
-  - [Added](#added-13)
+  - [Added](#added-16)
   - [Breaking Changes](#breaking-changes-3)
   - [Removed](#removed-1)
 - [1.9.0 (2020-05-06)](#190-2020-05-06)
-  - [Added](#added-14)
+  - [Added](#added-17)
 - [1.8.0 (2020-05-03)](#180-2020-05-03)
-  - [Added](#added-15)
+  - [Added](#added-18)
 - [1.7.0 (2020-05-03)](#170-2020-05-03)
-  - [Fixed](#fixed-2)
+  - [Fixed](#fixed-3)
 - [1.6.0 (2020-04-17)](#160-2020-04-17)
-  - [Added](#added-16)
+  - [Added](#added-19)
   - [Changes](#changes-1)
 - [1.5.0 (2020-04-12)](#150-2020-04-12)
-  - [Added](#added-17)
+  - [Added](#added-20)
 - [1.4.0 (2020-04-12)](#140-2020-04-12)
-  - [Added](#added-18)
+  - [Added](#added-21)
 - [1.3.0 (2020-04-12)](#130-2020-04-12)
-  - [Added](#added-19)
+  - [Added](#added-22)
 - [1.2.0 (2020-04-12)](#120-2020-04-12)
-  - [Added](#added-20)
+  - [Added](#added-23)
 - [1.1.0 (2020-04-09)](#110-2020-04-09)
-  - [Added](#added-21)
-  - [Fixed](#fixed-3)
+  - [Added](#added-24)
+  - [Fixed](#fixed-4)
 - [1.0.0 (2020-03-16)](#100-2020-03-16)
-  - [Added](#added-22)
+  - [Added](#added-25)
 - [0.6.0 (2020-01-06)](#060-2020-01-06)
-  - [Added](#added-23)
+  - [Added](#added-26)
 - [0.5.0 (2020-01-04)](#050-2020-01-04)
-  - [Added](#added-24)
+  - [Added](#added-27)
 - [0.4.0 (2020-01-03)](#040-2020-01-03)
-  - [Added](#added-25)
+  - [Added](#added-28)
 - [0.3.0 (2020-01-03)](#030-2020-01-03)
-  - [Added](#added-26)
+  - [Added](#added-29)
   - [Breaking Changes](#breaking-changes-4)
 - [0.2.0 (2020-01-02)](#020-2020-01-02)
-  - [Added](#added-27)
+  - [Added](#added-30)
 - [0.1.0 (2019-12-26)](#010-2019-12-26)
-  - [Added](#added-28)
+  - [Added](#added-31)
 
 ## Unreleased
 
@@ -91,6 +99,234 @@ This project follows [semver 2.0.0](http://semver.org/spec/v2.0.0.html) and the
 ### Fixed
 -->
 
+5.9.0 (2021-09-22)
+------------------
+
+### Added
+
+* [#68](https://github.com/serradura/kind/pull/68) - Add `Kind.object(name:, &block)` to create `Kind::Objects`.
+```ruby
+PositiveInteger = Kind.object(name: 'PositiveInteger') do |value|
+  value.kind_of?(Integer) && value > 0
+end
+
+# PositiveInteger.name
+# PositiveInteger.kind
+# The type handler can return its kind and its name
+PositiveInteger.name # "PositiveInteger"
+PositiveInteger.kind # #<Proc:0x0000.... >
+
+# PositiveInteger.===
+# Can check if a given value is an instance of its kind.
+PositiveInteger === 1 # true
+PositiveInteger === 0 # false
+
+# PositiveInteger.value?(value)
+# Can check if a given value is an instance of its kind.
+PositiveInteger.value?(1)  # true
+PositiveInteger.value?(-1) # false
+
+# If it doesn't receive an argument, a lambda will be returned and it will know how to do the type verification.
+[1, 2, 0, 3, -1].select(&PositiveInteger.value?) # [1, 2, 3]
+
+# PositiveInteger.or_nil(value)
+# Can return nil if the given value isn't an instance of its kind
+PositiveInteger.or_nil(1) # 1
+PositiveInteger.or_nil(0) # nil
+
+# PositiveInteger.or_undefined(value)
+# Can return Kind::Undefined if the given value isn't an instance of its kind
+PositiveInteger.or_undefined(2)  # 2
+PositiveInteger.or_undefined(-1) # Kind::Undefined
+
+# PositiveInteger.or(fallback, value)
+# Can return a fallback if the given value isn't an instance of its kind
+PositiveInteger.or(nil, 1) # 1
+PositiveInteger.or(nil, 0) # nil
+
+# If it doesn't receive a second argument (the value), it will return a callable that knows how to expose an instance of the expected type or a fallback if the given value was wrong.
+[1, 2, 0, 3, -1].map(&PositiveInteger.or(1))   # [1, 2, 1, 3, 1]
+[1, 2, 0, 3, -1].map(&PositiveInteger.or(nil)) # [1, 2, nil, 3, nil]
+
+# An error will be raised if the fallback didn't have the expected kind or if not nil / Kind::Undefined.
+[1, 2, 0, 3, -1].map(&PositiveInteger.or(:foo)) # Kind::Error (:foo expected to be a kind of PositiveInteger)
+
+# PositiveInteger[value]
+# Will raise Kind::Error if the given value isn't an instance of the expected kind
+PositiveInteger[1]    # 1
+PositiveInteger[:foo] # Kind::Error (:foo expected to be a kind of PositiveInteger)
+
+# PositiveInteger.value(arg, default:)
+# This method ensures that you will have a value of the expected kind. But, in the case of the given value be invalid, this method will require a default value (with the expected kind) to be returned.
+PositiveInteger.value(2, default: 1)   # 2
+
+PositiveInteger.value('1', default: 1) # 1
+
+PositiveInteger.value('1', default: 0) # Kind::Error (0 expected to be a kind of PositiveInteger)
+
+# PositiveInteger.maybe
+# This method returns a typed Kind::Maybe.
+PositiveInteger.maybe(0).value_or(1) # 1
+
+PositiveInteger.maybe(2).value_or(1) # 2
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
+
+5.8.1 (2021-09-22)
+------------------
+
+### Fixed
+
+* [#67](https://github.com/serradura/kind/pull/67) - Make `Kind.assert_hash!(some_hash, schema:)` works with a `Kind::Any` instance.
+```ruby
+require 'kind/any'
+
+Level = Kind::Any[:low, :high]
+
+Kind.assert_hash!({level: :medium}, schema: {level: Level})
+# Kind::Error (The key :status has an invalid value. Expected: Kind::Any[:low, :high])
+```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
+
+5.8.0 (2021-09-22)
+------------------
+
+### Added
+
+* [#66](https://github.com/serradura/kind/pull/66) - Add `Kind::Any` to make easier the verification of a value in a list (array) of expected values.
+  ```ruby
+  require 'kind/any'
+
+  Level = Kind::Any[:low, :high] # or Kind::Any.new([:low, :high])
+
+  Level === :low  # true
+  Level === :high # true
+
+  Level === :foo  # false
+
+  Level[:low]  # :low
+  Level[:high] # :high
+
+  Level[:foo] # Kind::Error (:foo expected to be a kind of Kind::Any[:low, :high])
+
+  level_or_any_symbol = # (Kind::Any[:low, :high] | Symbol)
+
+  Level.name    # 'Kind::Any[:low, :high]'
+  Level.inspect # 'Kind::Any[:low, :high]'
+
+  Level.values  # [:low, :high]
+  ```
+
+* [#66](https://github.com/serradura/kind/pull/66) - Make `Kind.assert_hash!(hash, schema:)` works with a `Kind::Object`.
+  ```ruby
+  require 'kind/enum'
+
+  module Level
+    include Kind::Enum.from_array([:low, :medium, :high], use_index_as_value: false)
+  end
+
+  Level.keys   # ["low", "medium", "high"]
+  Level.values # [:low, :medium, :high]
+
+  # ---
+
+  module Status
+    include Kind::Enum.from_array([:open, :closed], use_index_as_value: true)
+  end
+
+  Status.keys   # ["open", "closed"]
+  Status.values # [0, 1]
+  ```
+
+* [#66](https://github.com/serradura/kind/pull/66) - Make `Kind.assert_hash!(hash, schema:)` works with a `Kind::Object`.
+  ```ruby
+  FilledString = begin
+    filled_string = ->(value) {value.is_a?(String) && value.present?}
+
+    Kind[filled_string, name: 'FilledString']
+  end
+
+  Kind.assert_hash!(some_hash, schema: {
+    string: FilledString,
+    callable: Kind::Callable,
+  })
+  ```
+
+* [#66](https://github.com/serradura/kind/pull/66) - Improve the exception messages of `Kind.assert_hash!(hash, schema:)`.
+  ```ruby
+  Kind.assert_hash!({status: 1}, schema: {status: Kind::String | Symbol})
+  # Kind::Error (The key :status has an invalid value. Expected: (String | Symbol))
+
+  Kind.assert_hash!({status: 'closed'}, schema: {status: 'active'})
+  # Kind::Error (The key :status has an invalid value. Expected: active, Given: closed)
+
+  Kind.assert_hash!({callable: 1}, schema: {callable: Kind::Callable})
+  # Kind::Error (The key :callable has an invalid value. Expected: Callable)
+  ```
+
+* [#66](https://github.com/serradura/kind/pull/66) - Make `Kind.assert_hash!(hash, **options)` raises an error if the given hash be empty.
+  ```ruby
+  Kind.assert_hash!({}, keys: []) # ArgumentError (hash can't be empty)
+  Kind.assert_hash!({}, schema: {}) # ArgumentError (hash can't be empty)
+  ```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
+
+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?('@') }
+  })
+  ```
+
+[⬆️ &nbsp;Back to Top](#changelog-)
+
 5.6.0 (2021-05-14)
 ------------------
 

data/Gemfile

@@ -20,7 +20,7 @@ simplecov_version =
   case RUBY_VERSION
   when /\A2.[123]/ then '0.17.1'
   when /\A2.4/ then '~> 0.18.5'
-  else '~> 0.19'
+  else '~> 0.21.2'
   end
 
 is_ruby_2_1 = RUBY_VERSION <= '2.2.0'

data/README.md

@@ -8,8 +8,8 @@
     <img alt="Gem" src="https://img.shields.io/gem/v/kind.svg?style=flat-square">
   </a>
 
-  <a href="https://travis-ci.com/serradura/kind">
-    <img alt="Build Status" src="https://travis-ci.com/serradura/kind.svg?branch=master">
+  <a href="https://github.com/serradura/kind/actions/workflows/ci.yml">
+    <img alt="Build Status" src="https://github.com/serradura/kind/actions/workflows/ci.yml/badge.svg">
   </a>
 
   <br />
@@ -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.9.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
@@ -69,7 +69,7 @@ unreleased | https://github.com/serradura/kind/blob/main/README.md
   - [Creating type handlers](#creating-type-handlers)
     - [Dynamic creation](#dynamic-creation)
       - [Using a class or a module](#using-a-class-or-a-module)
-      - [Using an object which responds to ===](#using-an-object-which-responds-to-)
+      - [Using Kind.object(name:, &block) ===](#using-kindobjectname-block-)
     - [Kind::<Type> object](#kindtype-object)
   - [Utility methods](#utility-methods)
     - [Kind.of_class?()](#kindof_class)
@@ -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.9.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 |
@@ -393,7 +393,7 @@ end
 
 user = User.new
 
-kind_of_user = Kind::Of(User)
+kind_of_user = Kind[User]
 
 # kind_of_user.name
 # kind_of_user.kind
@@ -412,7 +412,7 @@ kind_of_user.value?('')       # false
 kind_of_user.value?(User.new) # true
 
 # If it doesn't receive an argument, a lambda will be returned and it will know how to do the type verification.
-[0, User.new].select?(&kind_of_user.value?) # [#<User:0x0000.... >]
+[0, User.new].select(&kind_of_user.value?) # [#<User:0x0000.... >]
 
 # kind_of_user.or_nil(value)
 # Can return nil if the given value isn't an instance of its kind
@@ -455,15 +455,12 @@ kind_of_user.maybe('1').value_or(User.new) # #<User:0x0000...>
 
 [⬆️ &nbsp;Back to Top](#table-of-contents-)
 
-##### Using an object which responds to ===
-
-Example using a lambda (an object which responds to .===) and a hash with the kind name.
+##### Using Kind.object(name:, &block) ===
 
 ```ruby
-PositiveInteger = Kind::Of(
-  -> value { value.kind_of?(Integer) && value > 0 },
-  name: 'PositiveInteger'
-)
+PositiveInteger = Kind.object(name: 'PositiveInteger') do |value|
+  value.kind_of?(Integer) && value > 0
+end
 
 # PositiveInteger.name
 # PositiveInteger.kind
@@ -482,7 +479,7 @@ PositiveInteger.value?(1)  # true
 PositiveInteger.value?(-1) # false
 
 # If it doesn't receive an argument, a lambda will be returned and it will know how to do the type verification.
-[1, 2, 0, 3, -1].select?(&PositiveInteger.value?) # [1, 2, 3]
+[1, 2, 0, 3, -1].select(&PositiveInteger.value?) # [1, 2, 3]
 
 # PositiveInteger.or_nil(value)
 # Can return nil if the given value isn't an instance of its kind

data/bin/prepare_coverage

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# Borrowed from https://gist.github.com/qortex/7e7c49f3731391a91ee898336183acef
+
+# Temporary hack to get CodeClimate to work with SimpleCov 0.18 JSON format until issue is fixed
+# upstream: https://github.com/codeclimate/test-reporter/issues/413
+
+require "json"
+
+filename = "coverage/.resultset.json"
+contents = JSON.parse(File.read(filename))
+
+def remove_lines_key(obj)
+  case obj
+  when Hash
+    obj.transform_values do |val|
+      val.is_a?(Hash) && val.key?("lines") ? val["lines"] : remove_lines_key(val)
+    end
+  else
+    obj
+  end
+end
+
+# overwrite
+File.write(filename, JSON.generate(remove_lines_key(contents)))
+
+puts Dir['coverage/.*.json']

data/bin/test

@@ -0,0 +1,76 @@
+#!/bin/bash
+
+set -e
+
+RUBY_V=$(ruby -v)
+
+function reset_gemfile_and_test {
+  rm Gemfile.lock
+
+  eval "$1 bundle update"
+  eval "$1 bundle exec rake test"
+}
+
+function test_with_activemodel {
+  reset_gemfile_and_test "ACTIVEMODEL_VERSION=$1"
+}
+
+function run_tests_by_modules {
+  rm Gemfile.lock
+
+  bundle update
+
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/{basic/*_test,basic_test}.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/enum_test.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/presence_test.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/dig_test.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/try_test.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/maybe_test.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/immutable_attributes_test.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/function_test.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/action_test.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/{functional/*_test,functional_test}.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/either/*_test.rb'"
+  eval "KIND_BASIC=t bundle exec rake test TEST='test/kind/result/*_test.rb'"
+
+  eval "KIND_STRICT=t bundle exec rake test TEST='test/kind/strict_disabled_test.rb'"
+}
+
+RUBY_2_12345="ruby 2.[12345]."
+RUBY_2_2345="ruby 2.[2345]."
+RUBY_2_1234="ruby 2.[1234]."
+RUBY_2_567="ruby 2.[567]."
+RUBY_2_12="ruby 2.[12]."
+RUBY_3_X="ruby 3.0."
+
+if [[ $RUBY_V =~ $RUBY_2_12345 ]]; then
+  if [[ $RUBY_V =~ $RUBY_2_12 ]]; then
+    test_with_activemodel "3.2"
+  fi
+
+  if [[ $RUBY_V =~ $RUBY_2_2345 ]]; then
+    test_with_activemodel "4.0"
+    test_with_activemodel "4.1"
+    test_with_activemodel "4.2"
+    test_with_activemodel "5.0"
+    test_with_activemodel "5.1"
+    test_with_activemodel "5.2"
+  fi
+
+  if [[ $RUBY_V =~ $RUBY_2_1234 ]]; then
+    run_tests_by_modules
+
+    reset_gemfile_and_test
+  fi
+fi
+
+if [[ $RUBY_V =~ $RUBY_2_567 ]] || [[ $RUBY_V =~ $RUBY_3_X ]]; then
+  gem install bundler -v ">= 2" --no-doc
+
+  test_with_activemodel "6.0"
+  test_with_activemodel "6.1"
+
+  run_tests_by_modules
+
+  reset_gemfile_and_test
+fi

data/lib/kind/__lib__/assert_hash.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Kind
+  module AssertHash
+    module 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 Schema
+      extend self
+
+      KindAny = ->(value) { defined?(Kind::Any) ? Kind::Any === value : false }
+      KindObject = ->(value) { defined?(Kind::Object) ? Kind::Object === value : false }
+      KindUnionType = ->(value) { defined?(Kind::UnionType) ? Kind::UnionType === value : false }
+
+      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 KindAny, KindObject, KindUnionType then assert_kind_object(expected, value, error_message)
+          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)
+          else assert_equal(expected, value, error_message)
+          end
+        end
+
+        hash
+      end
+
+      def all(hash, spec)
+        Keys.require_all(spec.keys, hash)
+
+        any(hash, spec)
+      end
+
+      private
+
+        def assert_equal(expected, value, message)
+          raise_kind_error("#{message}. Expected: #{expected.inspect}, Given: #{value.inspect}") if expected != value
+        end
+
+        def assert(value, message)
+          raise_kind_error(message) unless value
+        end
+
+        def assert_nil(value, message)
+          raise_kind_error("#{message}. Expected: nil") unless value.nil?
+        end
+
+        def assert_match(expected, value, message)
+          STRICT.kind_of(String, value)
+
+          raise_kind_error("#{message}. Expected: #{expected.inspect}") if value !~ expected
+        end
+
+        def assert_kind_of(expected, value, message)
+          raise_kind_error("#{message}. Expected: #{expected.inspect}") unless expected === value
+        end
+
+        def assert_kind_object(expected, value, message)
+          raise_kind_error("#{message}. Expected: #{expected.name}") unless expected === value
+        end
+
+
+        def raise_kind_error(message)
+          raise Error.new(message)
+        end
+    end
+  end
+end

data/lib/kind/__lib__/strict.rb

@@ -6,14 +6,16 @@ module Kind
   module STRICT
     extend self
 
+    require 'kind/__lib__/assert_hash'
+
     def error(kind_name, value, label = nil) # :nodoc:
       raise Error.new(kind_name, value, label: label)
     end
 
-    def object_is_a(kind, value, label = nil) # :nodoc:
+    def object_is_a(kind, value, label = nil, expected = nil) # :nodoc:
       return value if kind === value
 
-      error(kind.name, value, label)
+      error(expected || kind.name, value, label)
     end
 
     def kind_of(kind, value, kind_name = nil) # :nodoc:
@@ -43,6 +45,46 @@ 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)
+      check_keys = options.key?(:keys)
+      check_schema = options.key?(:schema)
+
+      raise ArgumentError, ':keys or :schema is missing' if !check_keys && !check_schema
+      raise ArgumentError, "hash can't be empty" if hash.empty?
+
+      require_all = options[:require_all]
+
+      return assert_hash_keys!(hash, options[:keys], require_all) if check_keys
+
+      assert_hash_schema!(hash, options[:schema], require_all)
+    end
+
+    private
+
+      def assert_hash_keys!(hash, arg, require_all)
+        keys = Array(arg)
+
+        AssertHash::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 AssertHash::Schema.all(hash, schema) if require_all
+
+        AssertHash::Schema.any(hash, schema)
+      end
   end
 
   private_constant :STRICT

data/lib/kind/any.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Kind
+  class Any
+    FilledArray = ->(value) {value.is_a?(::Array) && !value.empty?}
+
+    singleton_class.send(:alias_method, :[], :new)
+
+    attr_reader :values
+
+    def initialize(*args)
+      array = args.size == 1 ? args[0] : args
+
+      @values = Kind.of(FilledArray, array, expected: 'filled array')
+    end
+
+    def ===(other)
+      @values.any? { |value| value == other }
+    end
+
+    def [](value, label: nil)
+      STRICT.object_is_a(self, value, label)
+    end
+
+    def |(another_kind)
+      UnionType[self] | another_kind
+    end
+
+    def name
+      "Kind::Any#{@values}"
+    end
+
+    alias inspect name
+
+    private_constant :FilledArray
+  end
+end

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'
@@ -48,8 +48,8 @@ module Kind
     KIND.interface?(method_names, value)
   end
 
-  def of(kind, value, label: nil)
-    STRICT.object_is_a(kind, value, label)
+  def of(kind, value, label: nil, expected: nil)
+    STRICT.object_is_a(kind, value, label, expected)
   end
 
   alias_method :of!, :of
@@ -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/enum/methods.rb

@@ -33,7 +33,7 @@ module Kind
     end
 
     def key?(arg)
-      arg.respond_to?(:to_sym) ? ref?(arg) && !value?(arg) : false
+      arg.respond_to?(:to_sym) ? ENUM__KEYS.member?(arg.to_s) : false
     end
 
     def value?(arg)

data/lib/kind/enum.rb

@@ -11,50 +11,58 @@ module Kind
     extend self
 
     def values(input)
-      enum_module = ::Module.new
+      __create(input)
+    end
 
-      enum_items =
-        case input
-        when ::Hash then create_from_hash(input)
-        when ::Array then create_from_array(input)
-        else raise ArgumentError, 'use an array or hash to define a Kind::Enum'
-        end
+    def from_array(input, use_index_as_value:)
+      __create(input, use_index_as_value)
+    end
 
-      enum_items.each { |item| enum_module.const_set(item.name, item) }
+    private
 
-      enum_map = enum_items.each_with_object({}) do |item, memo|
-        memo[item.to_s] = item
-        memo[item.value] = item
-        memo[item.to_sym] = item
-      end
+      def __create(input, use_index_as_value = true)
+        enum_module = ::Module.new
 
-      enum_module.const_set(:ENUM__MAP, enum_map)
-      enum_module.const_set(:ENUM__HASH, enum_items.map(&:to_ary).to_h.freeze)
-      enum_module.const_set(:ENUM__KEYS, ::Set.new(enum_items.map(&:key)).freeze)
-      enum_module.const_set(:ENUM__VALS, ::Set.new(enum_items.map(&:value)).freeze)
-      enum_module.const_set(:ENUM__REFS, ::Set.new(enum_map.keys))
-      enum_module.const_set(:ENUM__ITEMS, enum_items.freeze)
+        enum_items =
+          case input
+          when ::Hash then __create_from_hash(input)
+          when ::Array then __create_from_array(input, use_index_as_value)
+          else raise ArgumentError, 'use an array or hash to define a Kind::Enum'
+          end
 
-      enum_module.send(:private_constant, :ENUM__MAP, :ENUM__HASH, :ENUM__KEYS,
-                                          :ENUM__VALS, :ENUM__REFS, :ENUM__ITEMS)
+        enum_items.each { |item| enum_module.const_set(item.name, item) }
 
-      enum_module.module_eval(METHODS)
+        enum_map = enum_items.each_with_object({}) do |item, memo|
+          memo[item.to_s] = item
+          memo[item.value] = item
+          memo[item.to_sym] = item
+        end
 
-      enum_module.extend(enum_module)
-      enum_module
-    end
+        enum_module.const_set(:ENUM__MAP, enum_map)
+        enum_module.const_set(:ENUM__HASH, enum_items.map(&:to_ary).to_h.freeze)
+        enum_module.const_set(:ENUM__KEYS, ::Set.new(enum_items.map(&:key)).freeze)
+        enum_module.const_set(:ENUM__VALS, ::Set.new(enum_items.map(&:value)).freeze)
+        enum_module.const_set(:ENUM__REFS, ::Set.new(enum_map.keys))
+        enum_module.const_set(:ENUM__ITEMS, enum_items.freeze)
 
-    private
+        enum_module.send(:private_constant, :ENUM__MAP, :ENUM__HASH, :ENUM__KEYS,
+                                            :ENUM__VALS, :ENUM__REFS, :ENUM__ITEMS)
+
+        enum_module.module_eval(METHODS)
+
+        enum_module.extend(enum_module)
+        enum_module
+      end
 
-      def create_from_hash(input)
-        input.map { |key, value| build_item(key, value) }
+      def __create_from_hash(input)
+        input.map { |key, value| __item(key, value) }
       end
 
-      def create_from_array(input)
-        input.map.with_index { |key, index| build_item(key, index) }
+      def __create_from_array(input, use_index_as_value)
+        input.map.with_index { |key, index| use_index_as_value ? __item(key, index) : __item(key, key) }
       end
 
-      def build_item(key, value)
+      def __item(key, value)
         return Item.new(key, value) if key.respond_to?(:to_sym)
 
         raise ArgumentError, 'use a string or symbol to define a Kind::Enum item'

data/lib/kind/objects/object.rb

@@ -46,6 +46,11 @@ module Kind
     Object::Instance.new(kind, opt)
   end
 
+  # Kind.object(name:,&block)
+  def self.object(name:, &block)
+    self[block, name: name]
+  end
+
   # Kind::Of()
   def self.Of(*args)
     warn '[DEPRECATION] Kind::Of() is deprecated; use Kind[] instead. ' \

data/lib/kind/strict/disabled.rb

@@ -3,11 +3,17 @@
 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:
+    def object_is_a(_kind, value, _label = nil, _expected = nil) # :nodoc:
       value
     end
 
@@ -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.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kind
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.9.0
 platform: ruby
 authors:
 - Rodrigo Serradura
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-14 00:00:00.000000000 Z
+date: 2021-09-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
@@ -19,10 +19,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".tool-versions"
-- ".travis.sh"
-- ".travis.yml"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -30,10 +30,13 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/prepare_coverage
 - bin/setup
+- bin/test
 - kind.gemspec
 - lib/kind.rb
 - lib/kind/__lib__/action_steps.rb
+- lib/kind/__lib__/assert_hash.rb
 - lib/kind/__lib__/attributes.rb
 - lib/kind/__lib__/kind.rb
 - lib/kind/__lib__/of.rb
@@ -41,6 +44,7 @@ files:
 - lib/kind/__lib__/undefined.rb
 - lib/kind/action.rb
 - lib/kind/active_model/validation.rb
+- lib/kind/any.rb
 - lib/kind/basic.rb
 - lib/kind/basic/error.rb
 - lib/kind/basic/undefined.rb
@@ -119,14 +123,13 @@ files:
 - lib/kind/try.rb
 - lib/kind/validator.rb
 - lib/kind/version.rb
-- test.sh
 homepage: https://github.com/serradura/kind
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/serradura/kind
   source_code_uri: https://github.com/serradura/kind
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.11
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A development toolkit for Ruby with several small/cohesive abstractions to
   empower your development workflow.

data/.travis.sh

@@ -1,77 +0,0 @@
-#!/bin/bash
-
-RUBY_V=$(ruby -v)
-
-function run_basic_tests {
-  if [ ! -z "$1" ]; then
-    bundle_cmd="bundle _$1_"
-  else
-    bundle_cmd="bundle"
-  fi
-
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/{basic/*_test,basic_test}.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/enum_test.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/presence_test.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/dig_test.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/try_test.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/maybe_test.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/immutable_attributes_test.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/function_test.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/action_test.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/{functional/*_test,functional_test}.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/either/*_test.rb'"
-  eval "KIND_BASIC=t $bundle_cmd exec rake test TEST='test/kind/result/*_test.rb'"
-
-  eval "KIND_STRICT=t $bundle_cmd exec rake test TEST='test/kind/strict_disabled_test.rb'"
-}
-
-function run_with_bundler {
-  rm Gemfile.lock
-
-  if [ ! -z "$1" ]; then
-    bundle_cmd="bundle _$1_"
-  else
-    bundle_cmd="bundle"
-  fi
-
-  eval "$2 $bundle_cmd update"
-  eval "$2 $bundle_cmd exec rake test"
-}
-
-function run_with_am_version_and_bundler {
-  run_with_bundler "$2" "ACTIVEMODEL_VERSION=$1"
-}
-
-RUBY_2_12="ruby 2.[12]."
-RUBY_2_2345="ruby 2.[2345]."
-RUBY_2_12345="ruby 2.[12345]."
-RUBY_2_567="ruby 2.[567]."
-RUBY_3_0="ruby 3.0."
-
-if [[ $RUBY_V =~ $RUBY_2_12 ]]; then
-  run_with_am_version_and_bundler "3.2" "$BUNDLER_V1"
-fi
-
-if [[ $RUBY_V =~ $RUBY_2_2345 ]]; then
-  run_with_am_version_and_bundler "4.0" "$BUNDLER_V1"
-  run_with_am_version_and_bundler "4.1" "$BUNDLER_V1"
-  run_with_am_version_and_bundler "4.2" "$BUNDLER_V1"
-  run_with_am_version_and_bundler "5.0" "$BUNDLER_V1"
-  run_with_am_version_and_bundler "5.1" "$BUNDLER_V1"
-  run_with_am_version_and_bundler "5.2" "$BUNDLER_V1"
-fi
-
-if [[ $RUBY_V =~ $RUBY_2_12345 ]]; then
-  run_basic_tests "$BUNDLER_V1"
-  run_with_bundler "$BUNDLER_V1"
-fi
-
-if [[ $RUBY_V =~ $RUBY_2_567 ]] || [[ $RUBY_V =~ $RUBY_3_0 ]]; then
-  gem install bundler -v ">= 2" --no-doc
-
-  run_with_am_version_and_bundler "6.0"
-  run_with_am_version_and_bundler "6.1"
-
-  run_basic_tests
-  run_with_bundler
-fi

data/.travis.yml

@@ -1,35 +0,0 @@
----
-language: ruby
-
-cache:
-  bundler: true
-  directories:
-    - /home/travis/.rvm/
-
-rvm:
-  - 2.1.10
-  - 2.2.2
-  - 2.3.0
-  - 2.4.0
-  - 2.5.0
-  - 2.6.0
-  - 2.7.0
-  - 3.0.0
-
-env:
-  - BUNDLER_V1="1.17.3"
-
-before_install:
-  - gem install bundler -v "$BUNDLER_V1"
-
-install: bundle install --jobs=3 --retry=3
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - "./cc-test-reporter before-build"
-
-script: "./.travis.sh"
-
-after_success:
-  - "./cc-test-reporter after-build -t simplecov"

data/test.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-source $(dirname $0)/.travis.sh
-
-echo ''
-echo 'Resetting Gemfile'
-echo ''
-
-rm Gemfile.lock
-
-bundle