monad-oxide 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d74a96544bd662cb0fcf3131ca119560a4c0811e27a0668b24ef4bca351c610f
-  data.tar.gz: d93aa6573dd0bc7ac9529f828b630a421e9d527d1a75b6074fe8879a7defd52e
+  metadata.gz: 12758d7a4698325f9f371dd587d52879bcb2088c89f6691600e56d4525d428a5
+  data.tar.gz: a7fad1a246adc14c63fcc1ac4d9c1f4e01b658b0077b0eb058218822eadcc9a8
 SHA512:
-  metadata.gz: 793f5483be340bb1e5789fb29488a8c040b803848b5579fbc29e50af13006b1699fa75402bf796ead161031835c246908e7d543c98994c82d43d5a56641d8d43
-  data.tar.gz: 998649fd304a9cfe9ce05dea05b67ac88e616a3e4a8a22c707c0ff4661ac5574170a016a5d21bf1c0f610ec5de2543e0817ed71830ea59a8682b6a43e1c51ab1
+  metadata.gz: ebdc0c265cd9a2dfaef992c75fbb62675608fe74247e9fc00cb67201c6b6280999104d72926755990b38ab6b8ad1b5d20c3be9899446c787cf7765222129fce3
+  data.tar.gz: e27ae5ed41c7fed7f7fb90afc6a43b1165aeb41daf1295f756428cbf77a782f9210e33766b15ad973fae9760752cdcaa4d6ac96f53e9b34abbe63798da0ac2d4

data/lib/err.rb

@@ -188,6 +188,16 @@ module MonadOxide
       @data
     end
 
+    ##
+    # Safely unwrap the `Result`.  In the case of `Err`, this returns the
+    # wrapped value.
+    #
+    # @param _f A dummy function.  Not used.
+    # @return [T] The wrapped value.
+    def unwrap_err_or_else(f=nil, &_block)
+      @data
+    end
+
     ##
     # Safely unwrap the `Result`. In the case of `Err`, this returns the
     # provided default value.
@@ -198,5 +208,18 @@ module MonadOxide
       x
     end
 
+    ##
+    # Safely unwrap the `Result`. In the case of `Err`, this uses the provided
+    # function to produce a value.
+    #
+    # @param f [Proc<B>] The function to call. Could be a block
+    #          instead.  Takes nothing and returns a [B=Object].
+    # @yield Will yield a block that takes nothing and returns a [B=Object].
+    #        Same as `f' parameter.
+    # @return [B] The value returned from `f`.
+    def unwrap_or_else(f=nil, &block)
+      (f || block).call()
+    end
+
   end
 end

data/lib/ok.rb

@@ -146,13 +146,37 @@ module MonadOxide
       )
     end
 
+    ##
+    # Safely unwrap the `Result`.  In the case of `Ok`, this uses the provided
+    # function to produce a value.
+    #
+    # @param f [Proc<B>] The function to call. Could be a block
+    #          instead.  Takes nothing and returns a [B=Object].
+    # @yield Will yield a block that takes nothing and returns a [B=Object].
+    #        Same as `f' parameter.
+    # @return [B] The value returned from `f`.
+    def unwrap_err_or_else(f=nil, &block)
+      (f || block).call()
+    end
+
     ##
     # Safely unwrap the `Result`. In the case of `Ok`, this returns the
     # data in the Ok.
     #
-    # @param [B] x The value that will be returned.
+    # @param [B] _x The value that will be returned.
     # @return [A] The data in the Ok.
-    def unwrap_or(_)
+    def unwrap_or(_x)
+      @data
+    end
+
+    ##
+    # Safely unwrap the `Result`.  In the case of `Ok`, this returns the
+    # wrapped value.
+    #
+    # @param f [Proc<B>] A dummy function.  Not used.
+    #          instead.  Takes nothing and returns a [B=Object].
+    # @return [B] The value returned from `f`.
+    def unwrap_or_else(_f=nil, &_block)
       @data
     end
 

data/lib/result.rb

@@ -240,6 +240,21 @@ module MonadOxide
       Err.new(ResultMethodNotImplementedError.new())
     end
 
+    ##
+    # Safely unwrap the `Result` but with lazy evaluation.  In the case of
+    # `Err`, this returns the wrapped value.  For `Ok` the function provided is
+    # evaluated and its returned value is what is returned.
+    #
+    # @param f [Proc<B>] The function to call for `Ok`. Could be a block
+    #          instead.  Takes nothing and returns a [B=Object].
+    # @yield Will yield a block for `Ok` that takes nothing and returns a
+    #        [B=Object].  Same as `f' parameter.
+    # @return [T|B] The wrapped value for `Err` and the returned from `f` for
+    #               `Ok`.
+    def unwrap_err_or_else(_f)
+      raise ResultMethodNotImplementedError.new()
+    end
+
     ##
     # Attempt to safely access the `Result` data. This always returns a value
     # instead of raising an Exception. In the case of `Ok`, the data is
@@ -250,5 +265,35 @@ module MonadOxide
       Err.new(ResultMethodNotImplementedError.new())
     end
 
+    ##
+    # Safely unwrap the `Result` but with lazy evaluation.  In the case of
+    # `Ok`, this returns the wrapped value.  For `Err` the function provided is
+    # evaluated and its returned value is what is returned.
+    #
+    # @param f [Proc<B>] The function to call for `Err`. Could be a block
+    #          instead.  Takes nothing and returns a [B=Object].
+    # @yield Will yield a block for `Err` that takes nothing and returns a
+    #        [B=Object].  Same as `f' parameter.
+    # @return [T|B] The wrapped value for `Ok` and the returned from `f` for
+    #               `Err`.
+    def unwrap_or_else(_f)
+      raise ResultMethodNotImplementedError.new()
+    end
+
+    ##
+    # Safely unwrap the `Result` but with lazy evaluation.  In the case of `Ok`,
+    # this returns the wrapped value.  For `Err` the function provided is
+    # evaluated and its returned value is what is returned.
+    #
+    # @param f [Proc<B>] The function to call for `Err`. Could be a block
+    #          instead.  Takes nothing and returns a [B=Object].
+    # @yield Will yield a block for `Err` that takes nothing and returns a
+    #        [B=Object].  Same as `f' parameter.
+    # @return [T|B] The wrapped value for `Ok` and the returned from `f` for
+    #               `Err`.
+    def unwrap_or_else(_f)
+      raise ResultMethodNotImplementedError.new()
+    end
+
   end
 end

data/lib/version.rb

@@ -3,5 +3,5 @@ module MonadOxide
   # This version is locked to 0.x.0 because semver is a lie and this project
   # uses CICD to push new versions. Any commits that appear on main will result
   # in a new version of the gem created and published.
-  VERSION='0.9.0'
+  VERSION='0.10.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: monad-oxide
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Logan Barnett