kind 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dd5fb43e1dfd7c69d1a7ae3ffbf875769a675bbf7f8682bcfc9c8b3aa45c739
-  data.tar.gz: db15639b472a6b75d990b83f8b317ba7919f820b36e9a49a9141d387c6623768
+  metadata.gz: 273fcdcef40d8b61e552bb440f93a7b83adfd29621e1809201a66117babf9974
+  data.tar.gz: 84dac931b67ccc4ee895a8c2a4c3326ccfe0faf0540df09ba9fbcbfbe5034edc
 SHA512:
-  metadata.gz: fd548af2d4a1d93d5c4f2ef344318d35f140e1a7e4e82289897286ed6563004d7a8cc4577f94fb38b41e194c093ababf05e9d620b96a4ed420277dc94e154d87
-  data.tar.gz: 24ef063c68dc91f160b24a6d16992582cef56902b98bbc8fc54931c4e0076166f40c4795481e86e21cf546ae030f4c5aba49259785e8c00e46ab77debe374a27
+  metadata.gz: b3d702df70066307c7dac3058c41dab688de46c606d57455194d77570823d051dab5fd43b5c87c870dee58b9cef41a9e93a7d9d4639fe39489cc4b0e2d93d4bf
+  data.tar.gz: 4c02cd4e43a0407167f4284c6972feed925380a0d71a8c5dedcb474a24f458954175a929dac9d5b4509520cfea663e45692dba67269712bc6e8d83e53b80a8aa

data/README.md

@@ -12,7 +12,7 @@ Basic type system for Ruby.
 
 As a creator of Ruby gems, I have a common need that I have to handle in many of my projects: type checking of method arguments.
 
-One of the goals of this project is to do simple type checking like `"some string".is_a?(String)`, but using a bunch of basic abstractions. So, after reading this README and realizing that you need something more robust, I recommend to you check out the [dry-types gem](https://dry-rb.org/gems/dry-types).
+One of the goals of this project is to do simple type checking like `"some string".is_a?(String)`, but using a bunch of basic abstractions. So, after reading this README and realizing that you need something more robust, I recommend you check out the [dry-types gem](https://dry-rb.org/gems/dry-types).
 
 ## Table of Contents <!-- omit in toc -->
 - [Required Ruby version](#required-ruby-version)
@@ -25,18 +25,17 @@ One of the goals of this project is to do simple type checking like `"some strin
     - [Registering new (custom) type checkers](#registering-new-custom-type-checkers)
       - [What happens if a custom type checker has a namespace?](#what-happens-if-a-custom-type-checker-has-a-namespace)
 - [Type checkers](#type-checkers)
-- [Classes' type checker](#classes-type-checker)
-  - [Module type checkers](#module-type-checkers)
-  - [Special type checkers](#special-type-checkers)
-    - [Kind.of](#kindof)
+  - [Classes' type checkers](#classes-type-checkers)
+  - [Modules' type checkers](#modules-type-checkers)
+  - [Specials' type checkers](#specials-type-checkers)
 - [Kind::Undefined](#kindundefined)
-  - [Kind.of.<Type>.or_undefined()](#kindoftypeor_undefined)
+  - [Kind.of.\<Type\>.or_undefined()](#kindoftypeor_undefined)
 - [Kind::Maybe](#kindmaybe)
   - [Kind::Maybe[] and Kind::Maybe#then](#kindmaybe-and-kindmaybethen)
   - [Kind::Maybe#try](#kindmaybetry)
   - [Kind.of.Maybe()](#kindofmaybe)
   - [Kind::Optional](#kindoptional)
-  - [Kind::Empty](#kindempty)
+- [Kind::Empty](#kindempty)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -82,7 +81,7 @@ sum('1', 1) # Kind::Error ("\"1\" expected to be a kind of Numeric")
 By default, basic verifications are strict. So, when you perform `Kind.of.Hash(value)`, if the given value was a Hash, the value itself will be returned, but if it isn't the right type, an error will be raised.
 
 ```ruby
-Kind.of.Hash(nil)    # raise Kind::Error, "nil expected to be a kind of Hash"
+Kind.of.Hash(nil)    # **raise Kind::Error, "nil expected to be a kind of Hash"**
 Kind.of.Hash('')     # raise Kind::Error, "'' expected to be a kind of Hash"
 Kind.of.Hash({a: 1}) # {a: 1}
 
@@ -105,9 +104,9 @@ Kind.of.Hash(value, or: {})    # {}
 Kind.of.Boolean(nil, or: true) # true
 ```
 
-As an alternative syntax, you can use the `Kind::Of` instead of the method. e.g: `Kind::Of::Hash('')`
+As an alternative syntax, you can use the `Kind::Of` instead of the `Kind.of` method. e.g: `Kind::Of::Hash('')`
 
-But if you don't need a strict type verification, use the `.or_nil`method
+But if you don't need a strict type verification, use the `.or_nil` method.
 
 ```ruby
 Kind.of.Hash.or_nil('')     # nil
@@ -206,8 +205,8 @@ kind_of_user.instance?(User) # true
 kind_of_user.class?(Hash)  # false
 kind_of_user.class?(User)  # true
 
-# Create type checkers dynamically is cheap
-# because of a singleton object is created to be available for use.
+# Creating type checkers dynamically is cheap
+# because a singleton object is created to be available for use.
 
 kind_of_user.object_id == Kind.of(User).object_id # true
 
@@ -215,10 +214,10 @@ kind_of_user.object_id == Kind.of(User).object_id # true
 # Kind.is() can be used to check a class/module #
 # --------------------------------------------- #
 
-class Admin < User
+class AdminUser < User
 end
 
-Kind.is(Admin, User) # true
+Kind.is(User, AdminUser) # true
 ```
 
 #### Registering new (custom) type checkers
@@ -229,7 +228,7 @@ Use `Kind::Types.add()`. e.g:
 class User
 end
 
-# You can define it at the end of the file which has the class/module.
+# You can define it at the end of the file class/module where class/module was declared.
 
 Kind::Types.add(User)
 
@@ -310,7 +309,7 @@ Kind.of.Account::User::Membership.class?(Account::User::Membership) # true
 
 The list of types (classes and modules) available to use with `Kind.of.*` or `Kind.is.*` are:
 
-## Classes' type checker
+### Classes' type checkers
 
 - `Kind.of.String`
 - `Kind.of.Symbol`
@@ -330,14 +329,12 @@ The list of types (classes and modules) available to use with `Kind.of.*` or `Ki
 - `Kind.of.IO`
 - `Kind.of.File`
 
-### Module type checkers
+### Modules' type checkers
 
 - `Kind.of.Enumerable`
 - `Kind.of.Comparable`
 
-### Special type checkers
-
-#### Kind.of
+### Specials' type checkers
 
 - `Kind.of.Class()`
 - `Kind.of.Module()`
@@ -356,7 +353,7 @@ The [`Kind::Undefined`](https://github.com/serradura/kind/blob/834f6b8ebdc737de8
 
 If you are interested, check out [the tests](https://github.com/serradura/kind/blob/834f6b8ebdc737de8e5628986585f30c1a5aa41b/test/kind/undefined_test.rb) to understand its methods.
 
-### Kind.of.<Type>.or_undefined()
+### Kind.of.\<Type\>.or_undefined()
 
 If you interested in use `Kind::Undefined` you can use the method `.or_undefined` with any of the [available type checkers](#type-checkers). e.g:
 
@@ -521,9 +518,9 @@ PS: The `Kind.of.Optional` is available to check if some value is a `Kind::Optio
 
 [⬆️ Back to Top](#table-of-contents-)
 
-### Kind::Empty
+## Kind::Empty
 
-There is a common need to define default argument values. In case you don't know, depending on the argument data type, when a  method is invoked a new object will be created in the program memory to fills some default argument value. e.g:
+When you define a method that has default arguments, for certain data types, you will always create a new object in memory. e.g:
 
 ```ruby
 def something(params = {})

data/lib/kind/is.rb

@@ -9,7 +9,11 @@ module Kind
     def self.__call__(expected_kind, object)
       kind = Kind::Of.Module(object)
 
-      kind <= expected_kind || false
+      if kind.is_a?(Class)
+        kind <= expected_kind || false
+      else
+        kind == expected_kind || kind.is_a?(expected_kind)
+      end
     end
   end
 end

data/lib/kind/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kind
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-05-03 00:00:00.000000000 Z
 dependencies: []
 description: Basic type system for Ruby (free of dependencies).
 email: