kind 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe4558ce7a6bb67a5c7cb76d0ab12465ef644a909cc6f52e6c7890327db3a13
-  data.tar.gz: 511872fbaaf0884287c2d5c8e8e0e871ba832c828892ab9124f38cb458b6a2d6
+  metadata.gz: 5426cb7f865320e961b1ad352dce372af3154afc520d1d9d4f64d7095ae0ddc2
+  data.tar.gz: b4ebb397ff928f49c2616b1464a964117b879c72ad37532381235d4e03e4d8f3
 SHA512:
-  metadata.gz: 5d540ca9ec1ae62b1c560c9a3791742312832c7a4bd663cc319a5d2ac4ea7ed4a47c97de5810114d2a12f930bcf824513b058eaca37c3c736c136e5060eb55e1
-  data.tar.gz: 3b3e80863478ca100746dfe778ea1cccf9a66d19fe4748b0f07e7c1f27e987b11bf673b35b8f797fcb21b693f69ad3692b39d2a4b8433dc302b33cf1dca15bfa
+  metadata.gz: 249dcd8cbb89239e035254ff28cffdd0d26a42e811fa86ae3682bf80d9ccf5154e129f1a5756e50ac4710db698361f0ab242d9018d3464384d72b7209d829bbe
+  data.tar.gz: 39723e362d309fddbd01b6732f962b60c361a29da36bf8ba73d9af65a2a579b750a98477c673d965bf3d81ef4cda60b215bf570d6aad00321bc44e497d997136

data/README.md

@@ -30,6 +30,7 @@ One of the goals of this project is to do simple type checking like `"some strin
 - [Kind::Maybe](#kindmaybe)
   - [Kind::Maybe[] and Kind::Maybe#then](#kindmaybe-and-kindmaybethen)
   - [Kind::Maybe#try](#kindmaybetry)
+  - [Kind::Optional](#kindoptional)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -276,7 +277,7 @@ The list of types (classes and modules) available to use with `Kind.of.*` or `Ki
 - `Kind.is.Class()`
 - `Kind.is.Module()`
 - `Kind.is.Boolean()`
-- `Kind.is.Callable()`: verifies if the given value `respond_to?(:call)` or if it's a class/module, if its `public_instance_methods.include?(:call)`.
+- `Kind.is.Callable()`: verifies if the given value `respond_to?(:call)` or if it's a class/module and if its `public_instance_methods.include?(:call)`.
 
 [⬆️ Back to Top](#table-of-contents-)
 
@@ -383,6 +384,33 @@ p Kind::Maybe[object].try { |value| value.upcase } # nil
 
 [⬆️ Back to Top](#table-of-contents-)
 
+### Kind::Optional
+
+The `Kind::Optional` constant is an alias for `Kind::Maybe`. e.g:
+
+```ruby
+result1 =
+  Kind::Optional
+    .new(5)
+    .map { |value| value * 5 }
+    .map { |value| value - 10 }
+    .value_or(0)
+
+puts result1 # 15
+
+# ---
+
+result2 =
+  Kind::Optional[5]
+    .then { |value| value * 5 }
+    .then { |value| value + 10 }
+    .value_or { 0 }
+
+puts result2 # 35
+```
+
+[⬆️ 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/maybe.rb

@@ -2,21 +2,14 @@
 
 module Kind
   module Maybe
-    def self.none?(value)
-      value == nil || value == Undefined
-    end
-
-    def self.some?(value)
-      !none?(value)
-    end
-
-    def self.new(value)
-      result_type = some?(value) ? Some : None
-      result_type.new(value.is_a?(Result) ? value.value : value)
-    end
+    module Value
+      def self.none?(value)
+        value == nil || value == Undefined
+      end
 
-    def self.[](value);
-      new(value)
+      def self.some?(value)
+        !none?(value)
+      end
     end
 
     class Result
@@ -26,17 +19,7 @@ module Kind
         @value = value
       end
 
-      INVALID_DEFAULT_ARG = 'the default value must be defined as an argument or block'.freeze
-
-      def value_or(default = Undefined, &block)
-        return @value if some?
-
-        if default == Undefined && !block
-          raise ArgumentError, INVALID_DEFAULT_ARG
-        else
-          Maybe.some?(default) ? default : block.call
-        end
-      end
+      def value_or(default, &block); end
 
       def none?; end
 
@@ -44,20 +27,20 @@ module Kind
 
       def map(&fn); end
 
-      def try(method_name = Undefined, &block)
-        fn = method_name == Undefined ? block : Kind.of.Symbol(method_name).to_proc
+      def try(method_name, &block); end
+    end
 
-        if Maybe.some?(value)
-          result = fn.call(value)
+    private_constant :Result
 
-          return result if Maybe.some?(result)
-        end
-      end
+    class None < Result
+      INVALID_DEFAULT_ARG = 'the default value must be defined as an argument or block'.freeze
 
-      private_constant :INVALID_DEFAULT_ARG
-    end
+      def value_or(default = Undefined, &block)
+        raise ArgumentError, INVALID_DEFAULT_ARG if default == Undefined && !block
+
+        Maybe::Value.some?(default) ? default : block.call
+      end
 
-    class None < Result
       def none?; true; end
 
       def map(&fn)
@@ -65,26 +48,56 @@ module Kind
       end
 
       alias_method :then, :map
+
+      def try(method_name = Undefined, &block)
+        Kind.of.Symbol(method_name) if method_name != Undefined
+
+        nil
+      end
+
+      private_constant :INVALID_DEFAULT_ARG
     end
 
-    NONE_WITH_NIL = None.new(nil)
-    NONE_WITH_UNDEFINED = None.new(Undefined)
+    NONE_WITH_NIL_VALUE = None.new(nil)
+    NONE_WITH_UNDEFINED_VALUE = None.new(Undefined)
+
+    private_constant :NONE_WITH_NIL_VALUE, :NONE_WITH_UNDEFINED_VALUE
 
     class Some < Result
+      def value_or(default = Undefined, &block)
+        @value
+      end
+
       def none?; false; end
 
       def map(&fn)
-        result = yield(@value)
+        result = fn.call(@value)
+
+        return NONE_WITH_NIL_VALUE if result == nil
+        return NONE_WITH_UNDEFINED_VALUE if result == Undefined
 
-        return NONE_WITH_NIL if result == nil
-        return NONE_WITH_UNDEFINED if result == Undefined
-        return Some.new(result)
+        Some.new(result)
       end
 
       alias_method :then, :map
+
+      def try(method_name = Undefined, &block)
+        fn = method_name == Undefined ? block : Kind.of.Symbol(method_name).to_proc
+
+        result = fn.call(value)
+
+        return result if Maybe::Value.some?(result)
+      end
     end
 
-    private_constant :Result, :NONE_WITH_NIL, :NONE_WITH_UNDEFINED
+    def self.new(value)
+      result_type = Maybe::Value.none?(value) ? None : Some
+      result_type.new(value.is_a?(Result) ? value.value : value)
+    end
+
+    def self.[](value);
+      new(value)
+    end
   end
 
   Optional = Maybe

data/lib/kind/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kind
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Rodrigo Serradura