kind 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1ca16c1feac58c7a1303c0ee1cda8cd5831a2270039ed8301912afc7a3a9f55
-  data.tar.gz: 61dba4fdf5c8c94118f93ca5d16ab55364601fc5846f9d574cf44df05f6dff2a
+  metadata.gz: 8d3ff3a2a9d5b61087a96cf0255208086b5338f2a5f5ccb4ca609a9c8cff01e5
+  data.tar.gz: 10d77db1c01fb6990056fbb1b3a2dde463b8627af1f5aa415b7b11a89b76c367
 SHA512:
-  metadata.gz: 8397153bb070e3e27d4f2dfd0557a5f050a7ec292f4e2e779ffb7cdda26c125c29c64c283d8adc8ea09dce5ad4b23ed18575f35c711353a2184fbdff4effe34a
-  data.tar.gz: 7fee91750a8b24697e023a4be435b8c8db78cdd3f365dd70f5b9b0fda6daf549b3235528e94f6d9f985b5850ee031cbdd84475f8aabe4b549392c2304b7d8fa0
+  metadata.gz: ef9bd5cfb51763cb15690e232e60b474c6f958f5d2de7faab9d5688ce1f9e9b74c529b2bc2fbae39082e7bc0ea13b5d95038d6fd488f0a8d96d576e4843eb5c4
+  data.tar.gz: 515db015436abfe14cc392d46cdb41e8590af11c1d5e8e12466a4d85bfcd8681759e40f20ffbd9bac44a859a9b658e37c9218f2eec9bcc9118f68d3f755b8c56

data/.travis.yml

@@ -17,4 +17,12 @@ before_install:
 
 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: bundle exec rake test
+
+after_success:
+  - "./cc-test-reporter after-build -t simplecov"

data/README.md

@@ -1,6 +1,8 @@
 ![Ruby](https://img.shields.io/badge/ruby-2.2+-ruby.svg?colorA=99004d&colorB=cc0066)
 [![Gem](https://img.shields.io/gem/v/kind.svg?style=flat-square)](https://rubygems.org/gems/kind)
 [![Build Status](https://travis-ci.com/serradura/kind.svg?branch=master)](https://travis-ci.com/serradura/kind)
+[![Maintainability](https://api.codeclimate.com/v1/badges/711329decb2806ccac95/maintainability)](https://codeclimate.com/github/serradura/kind/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/711329decb2806ccac95/test_coverage)](https://codeclimate.com/github/serradura/kind/test_coverage)
 
 # Kind <!-- omit in toc -->
 
@@ -18,12 +20,12 @@ One of the goals of this project is to do simple type checking like `"some strin
 - [Usage](#usage)
   - [Verifying the kind of some object](#verifying-the-kind-of-some-object)
   - [Verifying the kind of some class/module](#verifying-the-kind-of-some-classmodule)
+  - [How to create a new type checker?](#how-to-create-a-new-type-checker)
+    - [What happens if a custom type checker has a namespace?](#what-happens-if-a-custom-type-checker-has-a-namespace)
 - [Built-in type checkers](#built-in-type-checkers)
   - [Special type checkers](#special-type-checkers)
     - [Kind.of](#kindof)
     - [Kind.is](#kindis)
-- [How to create a new type checker?](#how-to-create-a-new-type-checker)
-- [What happens if a custom type checker has a namespace?](#what-happens-if-a-custom-type-checker-has-a-namespace)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -59,9 +61,9 @@ def sum(a, b)
   Kind.of.Numeric(a) + Kind.of.Numeric(b)
 end
 
-sum(1, 1)  # 2
+sum(1, 1)   # 2
 
-sum('1', 1 # Kind::Error ("\"1\" expected to be a kind of Numeric")
+sum('1', 1) # Kind::Error ("\"1\" expected to be a kind of Numeric")
 ```
 
 ### Verifying the kind of some object
@@ -69,6 +71,8 @@ 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('')     # raise Kind::Error, "'' expected to be a kind of Hash"
 
 Kind.of.Hash({a: 1}) # {a: 1}
@@ -145,47 +149,7 @@ Kind.of.Hash.class?(ActiveSupport::HashWithIndifferentAccess) # true
 
 [⬆️ Back to Top](#table-of-contents-)
 
-## Built-in type checkers
-
-The list of types (classes and modules) available to use with `Kind.of.*` or `Kind.is.*` are:
-
-| Classes    | Modules    |
-| ---------- | ---------- |
-| String     | Enumerable |
-| Symbol     | Comparable |
-| Numeric    |            |
-| Integer    |            |
-| Float      |            |
-| Regexp     |            |
-| Time       |            |
-| Array      |            |
-| Range      |            |
-| Hash       |            |
-| Struct     |            |
-| Enumerator |            |
-| Method     |            |
-| Proc       |            |
-| IO         |            |
-| File       |            |
-
-### Special type checkers
-
-#### Kind.of
-
-- `Kind.of.Class()`
-- `Kind.of.Module()`
-- `Kind.of.Lambda()`
-- `Kind.of.Boolean()`
-
-#### Kind.is
-
-- `Kind.of.Class()`
-- `Kind.of.Module()`
-- `Kind.of.Boolean()`
-
-[⬆️ Back to Top](#table-of-contents-)
-
-## How to create a new type checker?
+### How to create a new type checker?
 
 Use `Kind::Types.add()`. e.g:
 
@@ -222,7 +186,7 @@ Kind.of.User.class?(User)  # true
 
 [⬆️ Back to Top](#table-of-contents-)
 
-## What happens if a custom type checker has a namespace?
+#### What happens if a custom type checker has a namespace?
 
 The type checker will preserve the namespace. ;)
 
@@ -268,6 +232,48 @@ Kind.of.Account::User::Membership.class?(Hash)  # false
 Kind.of.Account::User::Membership.class?(User)  # true
 ```
 
+[⬆️ Back to Top](#table-of-contents-)
+
+## Built-in type checkers
+
+The list of types (classes and modules) available to use with `Kind.of.*` or `Kind.is.*` are:
+
+| Classes    | Modules    |
+| ---------- | ---------- |
+| String     | Enumerable |
+| Symbol     | Comparable |
+| Numeric    |            |
+| Integer    |            |
+| Float      |            |
+| Regexp     |            |
+| Time       |            |
+| Array      |            |
+| Range      |            |
+| Hash       |            |
+| Struct     |            |
+| Enumerator |            |
+| Method     |            |
+| Proc       |            |
+| IO         |            |
+| File       |            |
+
+### Special type checkers
+
+#### Kind.of
+
+- `Kind.of.Class()`
+- `Kind.of.Module()`
+- `Kind.of.Lambda()`
+- `Kind.of.Boolean()`
+
+#### Kind.is
+
+- `Kind.of.Class()`
+- `Kind.of.Module()`
+- `Kind.of.Boolean()`
+
+[⬆️ Back to Top](#table-of-contents-)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/kind.rb

@@ -3,6 +3,8 @@
 require 'kind/version'
 
 module Kind
+  Undefined = Object.new
+
   class Error < TypeError
     def initialize(klass, object)
       super("#{object.inspect} expected to be a kind of #{klass}")
@@ -47,8 +49,8 @@ module Kind
       raise Kind::Error.new((name || klass.name), object)
     end
 
-    def self.Class(object = nil)
-      return Class if object.nil?
+    def self.Class(object = Undefined)
+      return Class if object == Undefined
 
       self.call(::Class, object)
     end
@@ -63,8 +65,8 @@ module Kind
       def self.instance?(value); class?(value); end
     end)
 
-    def self.Module(object = nil)
-      return Module if object.nil?
+    def self.Module(object = Undefined)
+      return Module if object == Undefined
 
       self.call(::Module, object)
     end
@@ -86,18 +88,18 @@ module Kind
     COLONS = '::'.freeze
 
     KIND_OF = <<-RUBY
-      def self.%{method_name}(object = nil, options = {})
+      def self.%{method_name}(object = Undefined, options = {})
         default = options[:or]
 
-        return Kind::Of::%{kind_name} if object.nil? && default.nil?
+        return Kind::Of::%{kind_name} if object == Undefined && default.nil?
 
         Kind::Of.(::%{kind_name}, (object || default), name: "%{kind_name}".freeze)
       end
     RUBY
 
     KIND_IS = <<-RUBY
-      def self.%{method_name}(value = nil)
-        return Kind::Is::%{kind_name} if value.nil?
+      def self.%{method_name}(value = Undefined)
+        return Kind::Is::%{kind_name} if value == Undefined
 
         Kind::Is.(::%{kind_name}, value)
       end
@@ -202,10 +204,10 @@ module Kind
   module Of
     # -- Boolean
 
-    def self.Boolean(object = nil, options = {})
+    def self.Boolean(object = Undefined, options = {})
       default = options[:or]
 
-      return Kind::Of::Boolean if object.nil? && default.nil?
+      return Kind::Of::Boolean if object == Undefined && default.nil?
 
       bool = object.nil? ? default : object
 
@@ -228,10 +230,10 @@ module Kind
 
     # -- Lambda
 
-    def self.Lambda(object = nil, options = {})
+    def self.Lambda(object = Undefined, options = {})
       default = options[:or]
 
-      return Kind::Of::Lambda if object.nil? && default.nil?
+      return Kind::Of::Lambda if object == Undefined && default.nil?
 
       func = object || default
 

data/lib/kind/version.rb

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

metadata

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