kind 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82342a2c0b637164a1eb73c8a47d3f2040225d04e8bfa28d1334e46a0a7afc9f
-  data.tar.gz: 6672a142b2692618e3486ca7a039ba6d80915d19d01995c355a7af337bff6416
+  metadata.gz: 9b572e02668d3a89864333fad8605a280f3bb09f5de9c0db9800bdc956632b78
+  data.tar.gz: 643847caaa8791c0bb5f4304f9e14135e853fb9763c53f92d7c3760c5d384be5
 SHA512:
-  metadata.gz: 2127164f8a852f3791460a6fbd944d05c2f023e4676351a25194b69679bd1e9c8e6c40a66a44d6ea5db37429d5a4be2ce48677b2671c6570859cfc4224aa05b9
-  data.tar.gz: 119bc6bfd8a7ce9cb0fc839da075456555adc12ddf49ed5d725bd11ca6c1f0ed9e69e134941c2c90d79d71c4bf7929cc4dd9b02072720fe261f227b6554f54f0
+  metadata.gz: c8d9057024bb9c8dd10f69946e5fcf0027f07a848dd16772bcb81dd2d9eeff12f026fe3600808c24bcf60126274d27a170ee32ab37f73f7fdaa26377e2aa1704
+  data.tar.gz: d4872142369aadb04b2679bc1bf8bb6b690ea19b9a7208dc9b0cb3f25c32f275981479d7847e0fe884bbb3c43c1da748c40ecd47e8833ff4052848514f3fcf1c

data/.gitignore

@@ -6,3 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+Gemfile.lock
+.foo

data/README.md

@@ -1,8 +1,27 @@
+- [Kind](#kind)
+  - [Installation](#installation)
+  - [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)
+  - [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)
+  - [Development](#development)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
+
 # Kind
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kind`. To experiment with that code, run `bin/console` for an interactive prompt.
+Basic type system for Ruby.
+
+**Motivation:**
 
-TODO: Delete this and the text above, and describe your gem
+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).
 
 ## Installation
 
@@ -22,7 +41,155 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Verifying the kind of some object
+
+By default, basic type verification is strict. So, when you perform `Kind.of.Hash(value)`, if the given value was a Hash it will be returned, but if it wasn't one, an error will be raised.
+
+```ruby
+Kind.of.Hash('')
+# raise Kind::Error, "'' expected to be a kind of Hash"
+
+Kind.of.Hash({a: 1})
+# {a: 1}
+
+# ---
+
+Kind.of.Boolean(nil)
+# raise Kind::Error, "nil expected to be a kind of Boolean"
+
+Kind.of.Boolean(true)  # true
+Kind.of.Boolean(false) # false
+```
+
+As an alternative syntax, you can use the `Kind::Of` instead of the method. e.g: `Kind::Of::Hash('')`
+
+But if you don't need a strict type verification, use the `.or_nil`method
+
+```ruby
+Kind.of.Hash.or_nil('')
+# nil
+
+Kind.of.Hash.or_nil({a: 1})
+# {a: 1}
+
+# ---
+
+Kind.of.Boolean.or_nil('')   # nil
+Kind.of.Boolean.or_nil(true) # true
+```
+
+And just for convenience, you can use the method `.instance?` to verify if the given object has the expected type.
+
+```ruby
+Kind.of.Hash.instance?('')
+# false
+
+# ---
+
+Kind.of.Boolean.instance?('')    # false
+Kind.of.Boolean.instance?(true)  # true
+Kind.of.Boolean.instance?(false) # true
+```
+
+### Verifying the kind of some class/module
+
+You can use `Kind.is` to verify if some class has the expected type as its ancestor.
+
+```ruby
+Kind.is.Hash(String)
+# false
+
+Kind.is.Hash(Hash)
+# true
+
+Kind.is.Hash(ActiveSupport::HashWithIndifferentAccess)
+# true
+```
+
+And just for convenience, you can use the method `Kind.of.*.class?` to verify if the given class has the expected type as its ancestor.
+
+```ruby
+Kind.of.Hash.class?(Hash)
+# true
+
+Kind.of.Hash.class?(ActiveSupport::HashWithIndifferentAccess)
+```
+
+## 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()`
+
+## How to create a new type checker?
+
+Use `Kind::Types.add()`. e.g:
+
+```ruby
+class User
+end
+
+# You can define it at the end of the file which has the class/module.
+
+Kind::Types.add(User)
+
+# Or, you can add the type checker within the class definition.
+
+class User
+  Kind::Types.add(self)
+end
+
+# --------------- #
+# Usage examples: #
+# --------------- #
+
+Kind.of.User(User.new)
+# #<User:0x0000...>
+
+Kind.of.User({})
+# Kind::Error ({} expected to be a kind of User)
+
+Kind.of.User.or_nil({})
+# nil
+
+Kind.of.User.instance?({}) # false
+Kind.of.User.class?(Hash)  # false
+
+Kind.of.User.instance?(User) # true
+Kind.of.User.class?(User)    # true
+```
 
 ## Development
 
@@ -32,7 +199,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kind. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/kind/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/serradura/kind. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/serradura/kind/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +208,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Kind project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/kind/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Kind project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/serradura/kind/blob/master/CODE_OF_CONDUCT.md).

data/lib/kind.rb

@@ -5,7 +5,7 @@ require 'kind/version'
 module Kind
   class Error < TypeError
     def initialize(klass, object)
-      super("#{object} expected to be a kind of #{klass}")
+      super("#{object.inspect} expected to be a kind of #{klass}")
     end
   end
 
@@ -19,25 +19,86 @@ module Kind
     def self.Class(object)
       self.call(::Class, object)
     end
+
+    def self.Module(object)
+      self.call(::Module, object)
+    end
+
+    def self.Boolean(object = nil)
+      return Kind::Of::Boolean if object.nil?
+
+      return object if object.is_a?(::TrueClass) || object.is_a?(::FalseClass)
+
+      raise Kind::Error.new('Boolean'.freeze, object)
+    end
+
+    module Boolean
+      def self.class?(value)
+        Kind.is.Boolean(value)
+      end
+
+      def self.instance?(value)
+        value.is_a?(TrueClass) || value.is_a?(FalseClass)
+      end
+
+      def self.or_nil(value)
+        return value if instance?(value)
+      end
+    end
+
+    def self.Lambda(object = nil)
+      return Kind::Of::Lambda if object.nil?
+
+      return object if object.is_a?(::Proc) && object.lambda?
+
+      raise Kind::Error.new('Lambda'.freeze, object)
+    end
+
+    module Lambda
+      def self.class?(value)
+        Kind.is.Proc(value)
+      end
+
+      def self.instance?(value)
+        value.is_a?(::Proc) && value.lambda?
+      end
+
+      def self.or_nil(value)
+        return value if instance?(value)
+      end
+    end
   end
 
   module Is
     def self.call(expected, value)
-      expected_klass, klass = Kind.of.Class(expected), Kind.of.Class(value)
+      expected_klass, klass = Kind.of.Module(expected), Kind.of.Module(value)
+
+      klass <= expected_klass || false
+    end
+
+    def self.Class(value)
+      value.is_a?(::Class)
+    end
+
+    def self.Module(value)
+      value == Module || (value.is_a?(::Module) && !self.Class(value))
+    end
 
-      klass <= expected_klass
+    def self.Boolean(value)
+      klass = Kind.of.Class(value)
+      klass <= TrueClass || klass <= FalseClass
     end
   end
 
   def self.of; Of; end
   def self.is; Is; end
 
-  singleton_class.send(:alias_method, :is_a, :is)
-
   module Types
+    extend self
+
     KIND_OF = <<-RUBY
       def self.%{klass}(object = nil)
-        return Kind::Of::%{klass} unless object
+        return Kind::Of::%{klass} if object.nil?
 
         Kind::Of.call(::%{klass}, object)
       end
@@ -65,8 +126,8 @@ module Kind
 
     private_constant :KIND_OF, :KIND_IS, :KIND_OF_MODULE
 
-    def self.add(klass)
-      klass_name = Kind.of.Class(klass).name
+    def add(klass)
+      klass_name = Kind.of.Module(klass).name
 
       return if Of.respond_to?(klass_name)
 
@@ -83,6 +144,16 @@ module Kind
     end
   end
 
-  [Hash, String]
-    .each { |klass| Types.add(klass) }
+  # Classes
+  [
+    String, Symbol, Numeric, Integer, Float, Regexp, Time,
+    Array, Range, Hash, Struct, Enumerator,
+    Method, Proc,
+    IO, File
+  ].each { |klass| Types.add(klass) }
+
+  # Modules
+  [
+    Enumerable, Comparable
+  ].each { |klass| Types.add(klass) }
 end

data/lib/kind/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kind
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-26 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Basic type system for Ruby.
 email:
@@ -21,7 +21,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,21 +0,0 @@
-PATH
-  remote: .
-  specs:
-    kind (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.13.0)
-    rake (12.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  kind!
-  minitest (~> 5.0)
-  rake (~> 12.0)
-
-BUNDLED WITH
-   2.1.2