keka 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 441fd2d2712b2ea5b6a15076088de3a1617945f0683251addd7e0be5f5077b9e
-  data.tar.gz: 3d7cf921207b9000a838197669af05d619aadc1252b420d48d74771266dfbccf
+  metadata.gz: 41f5f9c69cd88716d3d05c109a89f1988eecd25e581de70af22e4c5f349800bd
+  data.tar.gz: a3f42179b0ac6eedf9bfe014bad4b24d91aa053b3e78d87927c0e1865031835b
 SHA512:
-  metadata.gz: 447a280a18b005007788861863dce8b2dc647100add773615a1f5e2ae1a1151020f3955b0486da070a8995e32b7c9b168f5da5adf652b8fb8cb535e1e6b1b151
-  data.tar.gz: 7514d83dd424338c51254855275b4031d45ba34a4814104130a2549aad7e0676327e288edfb1422b08a899d0528ffc48a93f8822a574f17d6af346a749ab57a3
+  metadata.gz: 3093f3e717c8f27db52f71b3002e26a46de8051c51e04c558db2d39d2224bbcc9aa3ccce9da0ad0fc772e6285d3b8cf55a8e8e8b2fa52c7552eed08a2d149982
+  data.tar.gz: 3a74a02377cbda5a874634ff090ee93012750309fd455aa88f595b8b537178bd0d9aa72522899e0071a94832b7665731195d39090e232639c676bb43be3dffce

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## Version 0.3.0
+* Support `.err!` and `.ok!` public methods.
+* Rename `.ok` to `.ok_result`. [Breaking]
+* Rename `.err` to `.err_result`. [Breaking]
+
 ## Version 0.2.0
 * Support `.rescue_with` to handle exceptions in `.run` block.
 * Add CI.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    keka (0.2.0)
+    keka (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -57,6 +57,22 @@ end
 Of course, you can also use `.err_unless!`, `.err_if!`, and `.ok_if!` outside
 of the `Keka.run` block.
 
+### Abort Unconditionally
+
+Sometimes you know you want to abort, but you also need to a few things before aborting, such as saving the error result to database, logging, or submitting a metric to your monitoring service. You can use `.err!` or `.ok!` methods to abort from the current `Keka.run` block. Both methods can be invoked with or without a message argument.
+
+```ruby
+def refund
+  Keka.run do
+    processor_response = payment.refund
+    unless processor_response.success
+      payment.log_processor_errors(processor_response.errors)
+      Keka.err! processor_response.errors
+    end
+  end
+end
+```
+
 ### Handle Exceptions
 
 Before version 0.2.0, handling exceptions in `.run` block is a bit tricky. You might do something like this

data/lib/keka/context.rb

@@ -28,12 +28,12 @@ module Keka
     def run
       raise 'Block required!' unless block_given?
       yield
-      Keka.ok
+      Keka.ok_result
     rescue Keka::Halt => e
       e.result
     rescue StandardError => e
       raise unless matched = opts[:rescue_exceptions].detect { |setting| e.is_a?(setting[:klass]) }
-      Keka.err(matched[:msg])
+      Keka.err_result(matched[:msg])
     end
 
     private

data/lib/keka/version.rb

@@ -1,3 +1,3 @@
 module Keka
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/keka.rb

@@ -8,7 +8,7 @@ module Keka
     include Context::Originable
 
     def err_if!(evaluator, msg = nil)
-      raise Halt.new(err(msg)) if (evaluator.respond_to?(:ok?) ? evaluator.ok? : evaluator)
+      raise Halt.new(err_result(msg)) if (evaluator.respond_to?(:ok?) ? evaluator.ok? : evaluator)
     end
 
     def err_unless!(evaluator, msg = nil)
@@ -17,7 +17,7 @@ module Keka
         evaluator.msg = msg if msg
         raise Halt.new(evaluator)
       else
-        raise Halt.new(err(msg)) unless evaluator
+        raise Halt.new(err_result(msg)) unless evaluator
       end
     end
 
@@ -27,17 +27,25 @@ module Keka
         evaluator.msg = msg if msg
         raise Halt.new(evaluator)
       else
-        raise Halt.new(ok(msg)) if evaluator
+        raise Halt.new(ok_result(msg)) if evaluator
       end
     end
 
+    def err!(msg = nil)
+      raise Halt.new(err_result(msg))
+    end
+
+    def ok!(msg = nil)
+      raise Halt.new(ok_result(msg))
+    end
+
     # private (maybe)
-    def ok(msg = nil)
+    def ok_result(msg = nil)
       Result.new(true, msg)
     end
 
     # private (maybe)
-    def err(msg = nil)
+    def err_result(msg = nil)
       Result.new(false, msg)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keka
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - zino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-22 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler