kind 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31c64b5797c2bc7b2b1da5a704af8f66ddd34773296a8f5b70fc92ffd8b66246
-  data.tar.gz: ceac47580bc50b6f7b346193ec2c8d9429c7e26726219ee45ea8a5b56051a8e0
+  metadata.gz: 7b62da87ad8443fb4d3f1d96535bc69259addf767721db70288401d677733967
+  data.tar.gz: 995f0a3a34ed67a3244e181380d627e076d4576a2b6e0c7de2b34fa415c5f868
 SHA512:
-  metadata.gz: b94da43b377655485792594548f3a8d2e321ce313cd88ef6ff7b9bca1fba2411a602eaba99b2fa6be0d28e4054242ca0bc19c51df8ea7c08898455a09c0b345a
-  data.tar.gz: c1ac05bf6246d5a9f10f80bdec7adab1c62b87bc40bd0d9e57b9532e5de2c8598bf97de1f12d062d31e494543a87b4b68410c2581adb9ddbbf12088d2e100427
+  metadata.gz: 3398bbf2b67fe8b81023d9c781b14ac115f5749f45641a74fc1ff1c8d05f4fd1c4e2a4bc817d6c71e7f8dc96b245ec9f9c80a776ae11d22ba69dbc878dfaa847
+  data.tar.gz: 75c6c1e387548447edf601d4b73b18ff3e2700debf3f6715b2f772f582829d39a72e7bb9d8af61fe8bcd32e9f72aa8398f1703f2c706668a0ab5e59fc0612b05

data/README.md

@@ -49,6 +49,7 @@ One of the goals of this project is to do simple type checking like `"some strin
   - [Kind::Maybe(<Type>)](#kindmaybetype)
   - [Kind::Maybe#try](#kindmaybetry)
   - [Kind::Maybe#try!](#kindmaybetry-1)
+  - [Kind::Maybe#dig](#kindmaybedig)
 - [Kind::Empty](#kindempty)
 - [Similar Projects](#similar-projects)
 - [Development](#development)
@@ -458,6 +459,7 @@ The list of types (classes and modules) available to use with `Kind.of.*` or `Ki
 - `Kind.of.Range`
 - `Kind.of.Hash`
 - `Kind.of.Struct`
+- `Kind.of.OpenStruct`
 - `Kind.of.Enumerator`
 - `Kind.of.Set`
 - `Kind.of.Method`
@@ -1090,6 +1092,71 @@ Kind::Maybe[{}].try!(:upcase) # => NoMethodError (undefined method `upcase' for
 
 [⬆️ Back to Top](#table-of-contents-)
 
+### Kind::Maybe#dig
+
+Has the same behavior of Ruby dig methods ([Hash](https://ruby-doc.org/core-2.3.0/Hash.html#method-i-dig), [Array](https://ruby-doc.org/core-2.3.0/Array.html#method-i-dig), [Struct](https://ruby-doc.org/core-2.3.0/Struct.html#method-i-dig), [OpenStruct](https://ruby-doc.org/stdlib-2.3.0/libdoc/ostruct/rdoc/OpenStruct.html#method-i-dig)), but it will not raise an error if some value can't be digged.
+
+```ruby
+[nil, 1, '', /x/].each do |value|
+  p Kind::Maybe[value].dig(:foo).value # nil
+end
+
+# --
+
+a = [1, 2, 3]
+
+Kind::Maybe[a].dig(0).value # 1
+
+Kind::Maybe[a].dig(3).value # nil
+
+# --
+
+h = { foo: {bar: {baz: 1}}}
+
+Kind::Maybe[h].dig(:foo).value             # {bar: {baz: 1}}
+Kind::Maybe[h].dig(:foo, :bar).value       # {baz: 1}
+Kind::Maybe[h].dig(:foo, :bar, :baz).value # 1
+
+Kind::Maybe[h].dig(:foo, :bar, 'baz').value # nil
+
+# --
+
+i = { foo: [{'bar' => [1, 2]}, {baz: [3, 4]}] }
+
+Kind::Maybe[i].dig(:foo, 0, 'bar', 0).value # 1
+Kind::Maybe[i].dig(:foo, 0, 'bar', 1).value # 2
+Kind::Maybe[i].dig(:foo, 0, 'bar', -1).value # 2
+
+Kind::Maybe[i].dig(:foo, 0, 'bar', 2).value # nil
+
+# --
+
+s = Struct.new(:a, :b).new(101, 102)
+o = OpenStruct.new(c: 103, d: 104)
+b = { struct: s, ostruct: o, data: [s, o]}
+
+Kind::Maybe[s].dig(:a).value            # 101
+Kind::Maybe[b].dig(:struct, :b).value   # 102
+Kind::Maybe[b].dig(:data, 0, :b).value  # 102
+Kind::Maybe[b].dig(:data, 0, 'b').value # 102
+
+Kind::Maybe[o].dig(:c).value            # 103
+Kind::Maybe[b].dig(:ostruct, :d).value  # 104
+Kind::Maybe[b].dig(:data, 1, :d).value  # 104
+Kind::Maybe[b].dig(:data, 1, 'd').value # 104
+
+Kind::Maybe[s].dig(:f).value           # nil
+Kind::Maybe[o].dig(:f).value           # nil
+Kind::Maybe[b].dig(:struct, :f).value  # nil
+Kind::Maybe[b].dig(:ostruct, :f).value # nil
+Kind::Maybe[b].dig(:data, 0, :f).value # nil
+Kind::Maybe[b].dig(:data, 1, :f).value # nil
+```
+
+> **Note:** You can also use the `#dig` method with `Kind::Optional` objects.
+
+[⬆️ Back to Top](#table-of-contents-)
+
 ## Kind::Empty
 
 When you define a method that has default arguments, for certain data types, you will always create a new object in memory. e.g:

data/lib/kind.rb

@@ -2,6 +2,8 @@
 
 require 'kind/version'
 
+require 'ostruct'
+
 require 'kind/empty'
 require 'kind/undefined'
 require 'kind/checker'
@@ -294,7 +296,7 @@ module Kind
     # -- Classes
     [
       String, Symbol, Numeric, Integer, Float, Regexp, Time,
-      Array, Range, Hash, Struct, Enumerator, Set,
+      Array, Range, Hash, Struct, Enumerator, Set, OpenStruct,
       Method, Proc,
       IO, File
     ].each { |klass| Types.add(klass) }

data/lib/kind/dig.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Kind
+  module Dig
+    extend self
+
+    def call(data, keys)
+      return unless keys.is_a?(Array)
+
+      keys.reduce(data) do |memo, key|
+        value = get(memo, key)
+
+        break if value.nil?
+
+        value
+      end
+    end
+
+    private
+
+      def get(data, key)
+        return data[key] if Hash === data
+
+        case data
+        when Array
+          data[key] if key.respond_to?(:to_int)
+        when OpenStruct
+          data[key] if key.respond_to?(:to_sym)
+        when Struct
+          if key.respond_to?(:to_int) || key.respond_to?(:to_sym)
+            data[key] rescue nil
+          end
+        end
+      end
+  end
+end

data/lib/kind/maybe.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'kind/dig'
+
 module Kind
   module Maybe
     class Typed
@@ -76,6 +78,10 @@ module Kind
 
       alias_method :try, :try!
 
+      def dig(*keys)
+        NONE_WITH_NIL_VALUE
+      end
+
       private_constant :INVALID_DEFAULT_ARG
     end
 
@@ -114,6 +120,10 @@ module Kind
         end
       end
 
+      def dig(*keys)
+        resolve(Kind::Dig.call(value, keys))
+      end
+
       private
 
         def __try__(method_name = Undefined, args, block)

data/lib/kind/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kind
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies: []
 description: A simple type system (at runtime) for Ruby - free of dependencies.
 email:
@@ -34,6 +34,7 @@ files:
 - lib/kind/checker.rb
 - lib/kind/checker/factory.rb
 - lib/kind/checker/protocol.rb
+- lib/kind/dig.rb
 - lib/kind/empty.rb
 - lib/kind/error.rb
 - lib/kind/is.rb