monad-oxide 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c37567d8988443ab1076e07e5784fa454f430a12400acbb15526de2164a2686
-  data.tar.gz: a09be57539e071b3094b1d052cff724f0b71e8ae22ecd3ed151ffc355984b041
+  metadata.gz: d74a96544bd662cb0fcf3131ca119560a4c0811e27a0668b24ef4bca351c610f
+  data.tar.gz: d93aa6573dd0bc7ac9529f828b630a421e9d527d1a75b6074fe8879a7defd52e
 SHA512:
-  metadata.gz: a0b562a479e20ec1f488fe476c60c1c7138aa62f67b9cb83ca526ce0ff4e97a8c193d75062a175a466e877ae27b163ab9162cf72352126122035aa397024ac88
-  data.tar.gz: a78393ad99ebe353b9a9ccdbc31756e87a9578e768fa4b47fbef1bd756b08baa131b52ff69129a502d503e40daa44df283b678ec0ac26f5738b3bce562f003c9
+  metadata.gz: 793f5483be340bb1e5789fb29488a8c040b803848b5579fbc29e50af13006b1699fa75402bf796ead161031835c246908e7d543c98994c82d43d5a56641d8d43
+  data.tar.gz: 998649fd304a9cfe9ce05dea05b67ac88e616a3e4a8a22c707c0ff4661ac5574170a016a5d21bf1c0f610ec5de2543e0817ed71830ea59a8682b6a43e1c51ab1

data/lib/err.rb

@@ -65,6 +65,17 @@ module MonadOxide
       self
     end
 
+    ##
+    # Identifies that this is an `Err`.
+    # For counterparts:
+    # @see MonadOxide::Ok#ok?
+    # @see MonadOxide::Ok#err?
+    # @see MonadOxide::Err#ok?
+    # @return [Boolean] `true` because this is an `Err`.
+    def err?()
+      true
+    end
+
     ##
     # Applies `f' or the block over the `Exception' and returns the same `Err'.
     # No changes are applied. This is ideal for logging.  Exceptions raised
@@ -122,6 +133,17 @@ module MonadOxide
       end
     end
 
+    ##
+    # Identifies that this is not an `Ok`.
+    # For counterparts:
+    # @see MonadOxide::Ok#ok?
+    # @see MonadOxide::Ok#err?
+    # @see MonadOxide::Err#err?
+    # @return [Boolean] `false` because this is not an `Ok`.
+    def ok?()
+      false
+    end
+
     ##
     # Invokes `f' or the block with the data and returns the Result returned
     # from that. Exceptions raised during `f' or the block will return an

data/lib/ok.rb

@@ -40,6 +40,17 @@ module MonadOxide
       end
     end
 
+    ##
+    # Identifies that this is not an `Err`.
+    # For counterparts:
+    # @see MonadOxide::Ok#ok?
+    # @see MonadOxide::Err#ok?
+    # @see MonadOxide::Err#err?
+    # @return [Boolean] `false` because this is not an `Err`.
+    def err?()
+      false
+    end
+
     ##
     # Falls through. @see Result#inspect_err for how this is handled in either
     # Result case, and @see Err.inspect_err for how this is handled in the Err
@@ -96,6 +107,17 @@ module MonadOxide
       self
     end
 
+    ##
+    # Identifies that this is an `Ok`.
+    # For counterparts:
+    # @see MonadOxide::Ok#err?
+    # @see MonadOxide::Err#ok?
+    # @see MonadOxide::Err#err?
+    # @return [Boolean] `true` because this is an `Ok`.
+    def ok?()
+      true
+    end
+
     ##
     # The Err equivalent to Ok#and_then. This is a no-op for Ok. @see
     # Err#or_else.

data/lib/result.rb

@@ -57,17 +57,10 @@ module MonadOxide
     end
 
     ##
-    # Un-nest this `Result'. This implementation is shared between `Ok' and
-    # `Err'. In both cases, the structure's data is operated upon.
-    # @return [Result] If `A' is a `Result' (meaning this `Result` is nested),
-    # return the inner-most `Result', regardless of the depth of nesting.
-    # Otherwise return `self'.
-    def flatten()
-      if @data.kind_of?(Result)
-        return @data.flatten()
-      else
-        self
-      end
+    # Determine if this is a MonadOxide::Err.
+    # @return [Boolean] `true` if this is a MonadOxide::Err, `false` otherwise.
+    def err?()
+      false
     end
 
     ##
@@ -113,6 +106,20 @@ module MonadOxide
       Err.new(ResultMethodNotImplementedError.new())
     end
 
+    ##
+    # Un-nest this `Result'. This implementation is shared between `Ok' and
+    # `Err'. In both cases, the structure's data is operated upon.
+    # @return [Result] If `A' is a `Result' (meaning this `Result` is nested),
+    # return the inner-most `Result', regardless of the depth of nesting.
+    # Otherwise return `self'.
+    def flatten()
+      if @data.kind_of?(Result)
+        return @data.flatten()
+      else
+        self
+      end
+    end
+
     ##
     # In the case of `Ok', applies `f' or the block over the data and returns
     # the same `Ok'. No changes are applied. This is ideal for logging.  For
@@ -179,6 +186,13 @@ module MonadOxide
       matcher[self.class].call(@data)
     end
 
+    ##
+    # Determine if this is a MonadOxide::Ok.
+    # @return [Boolean] `true` if this is a MonadOxide::Ok, `false` otherwise.
+    def ok?()
+      false
+    end
+
     ##
     # For `Err', invokes `f' or the block with the data and returns the Result
     # returned from that. Exceptions raised during `f' or the block will return

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.8.0'
+  VERSION='0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monad-oxide
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Logan Barnett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-17 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: org-ruby