zx-result 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0256c3f98b2f2fa7a72ae9a3ab3e0db5700583c6275fa38b38b1111fb9c4f5f1
-  data.tar.gz: 13a29cde376b2d95d3c75500b917c3caaede5a7dac1b9e9d56111e73b2706711
+  metadata.gz: 477e097fbbd8ef0e9653cad235ba58be00f9fc2d3caf59d753cda5f356288841
+  data.tar.gz: de38c568f3b038e4a58fa653170ca32b651ba721c92146045dd8303de312a94c
 SHA512:
-  metadata.gz: efd4d61b29da7587bd6bc408ccf113d2f61ba5d30c5708ac7957dc8da78e0b022bab2a61f5938d307efb77bbd25806f74dfa516b508762b2741a75167a082e3f
-  data.tar.gz: 5630e13604ab28ad36cede46b812795b47994e35fdf34c350d407eca6981a77216a6fb3909afef13885ac58539f9986e95186b0de5bbfe73a68c9c553d88264e
+  metadata.gz: 8392ba2d654e02899d5c1d5022af1287648244145c16f3fd875e2064c41442d31a637b95dac71929d1b474f080e264cadb030920a2c25a9a4a192d586310adb5
+  data.tar.gz: 6c0e807a40f795cf8be7d3721e0f7bab7cda05a2d5456ec67dbe880a9deaa4a6d82b13fac26453e1f1d243b6a5366e380f8aa51e735659d3d2ab7d6b458a2e78

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

@@ -71,6 +71,10 @@ module Zx
       fmap(&block)
     end
 
+    def step(&block)
+      fmap(&block)
+    end
+
     def fmap(&block)
       return self if failure?
 
@@ -80,6 +84,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 +116,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 +124,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.2'
+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.2
 platform: ruby
 authors:
 - Thadeu Esteves
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler