zx-result 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0256c3f98b2f2fa7a72ae9a3ab3e0db5700583c6275fa38b38b1111fb9c4f5f1
-  data.tar.gz: 13a29cde376b2d95d3c75500b917c3caaede5a7dac1b9e9d56111e73b2706711
+  metadata.gz: da3bb02e36f9e8c958921f2ff44a76313d06b4f063ca7f9eaee5edd3eccf683d
+  data.tar.gz: 635a4e33852a269d3f03b8f80595bacec8a1b7cb8ac1c471bb11ed5443595442
 SHA512:
-  metadata.gz: efd4d61b29da7587bd6bc408ccf113d2f61ba5d30c5708ac7957dc8da78e0b022bab2a61f5938d307efb77bbd25806f74dfa516b508762b2741a75167a082e3f
-  data.tar.gz: 5630e13604ab28ad36cede46b812795b47994e35fdf34c350d407eca6981a77216a6fb3909afef13885ac58539f9986e95186b0de5bbfe73a68c9c553d88264e
+  metadata.gz: 3f8cf43b9abb8772b8436d297997321a677b7bee04ca3688ca1db4fa27dcfec79fa013bd176fc72864653f198b7d5e30c1b00265f291126ac2b97e72c4c7ec24
+  data.tar.gz: f090b620cac830f80e8037ade19f1dbcb83d629c87ee693b6618854de795a9ffb4297fcedd0bff4e11d6fe9268357554b54d0f70479a60d71cfc7e4a3fe2187a

data/README.md

@@ -136,6 +136,44 @@ result.error #=> nil or raises an exception
 result.type #=> :integer
 ```
 
+### Step or Check
+
+```ruby
+result = Zx.Success(5, type: :integer)
+  .step{ |number| number + 5 }
+  .on_success(:integer) {|number| puts number } #=> 10
+  .on(:success, :integer) {|number| puts number } #=> 10
+  .on_success {|number| puts number } #=> 10
+
+result.success? #=> true
+result.failure? #=> false
+result.value #=> 10
+result.value! #=> 10 or raise
+result.error #=> nil or raises a  n exception
+result.type #=> :integer
+```
+
+```ruby
+result = Zx.Success(5, type: :integer)
+  .step{ |number| number + 5 }
+  .check { |number| number == 10 }
+  .on_success{|number| puts number } #=> 10
+
+result.success? #=> true
+result.failure? #=> false
+result.value #=> 10
+result.value! #=> 10 or raise
+result.error #=> nil or raises an exception
+result.type #=> :integer
+```
+
+```ruby
+result = Zx.Success(5, type: :integer)
+  .step{ |number| number + 5 }
+  .check { |number| number == 15 }
+  .on_failure{|error| puts error } #=> 10
+```
+
 You can use one or multiples listeners in your result. We see some use cases.
 
 **Simple composition**

data/lib/zx/result.rb

@@ -39,6 +39,8 @@ module Zx
 
     def on_unknown(&block)
       __execute__(nil, &block)
+
+      self
     end
 
     def on_success(tag = nil, &block)
@@ -71,6 +73,10 @@ module Zx
       fmap(&block)
     end
 
+    def step(&block)
+      fmap(&block)
+    end
+
     def fmap(&block)
       return self if failure?
 
@@ -80,6 +86,12 @@ module Zx
       self
     end
 
+    def check(&block)
+      return self if !!block.call(@value)
+
+      failure!
+    end
+
     def failure!(value = nil, type: :error)
       @type = type.to_sym
       @success = false
@@ -106,7 +118,7 @@ module Zx
     def Success(value = nil, options = {})
       success!(value, type: options.fetch(:type, :ok))
     end
-    
+
     def Success!(value = nil, options = {})
       success!(value, type: options.fetch(:type, :ok))
     end
@@ -114,7 +126,7 @@ module Zx
     def Failure(value = nil, options = {})
       failure!(value, type: options.fetch(:type, :error))
     end
-    
+
     def Failure!(value = nil, options = {})
       failure!(value, type: options.fetch(:type, :error))
     end

data/lib/zx/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zx
-  VERSION = '0.0.1'.freeze
-end
+  VERSION = '0.0.3'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zx-result
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Thadeu Esteves
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2023-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler