keka 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9aa8d1755bf0535f2daef94a23feca6c60b0ce322ac18b61207b820ea693633
-  data.tar.gz: b1f9fa5f84161a955e550564906deefc249709a7b2e1032d246413f53cc9d067
+  metadata.gz: 5964f3bdc33f5b4367afacac369297ab87c48ce41bc43123977622fc33718166
+  data.tar.gz: ac2a02bc9853226d5e967f16ae0dba0629e17660d8ac9aae8711e6c5b5111481
 SHA512:
-  metadata.gz: 5f97929bfb8fbfc6a154b4e80991183fbdf043a86ccd2b78bd800fc1c7c68cbdd8389e8840186007d8c3b5b89a8f2516f8b6c75bd8408ef3084edabdb4281b9c
-  data.tar.gz: 887aa03c1d48f8d304bcf599cb5352e4462e54b647f53697b7a1860d38c21f0a38abef0f164eeff159498845d36f38518c309fe0eea2cc07b0ddab866369ac5e
+  metadata.gz: 6507a7aa94118fb84b1e21246d5d30b165e0851e9354a30cebe5a090c85e518d05eeb0285264728df81bca99ce9e5d44d9f92e074cb68a8d1a4a8619e81a3a7b
+  data.tar.gz: e30427e399de612b9797ee5bd8d6b1bb443ac64b391c27870b6454e3a98a8020c1704a02a0734b0a3b589f1b99b329283ebea49710c663d68fe615f6d755cb79

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+## Version 0.5.0
+* Supports a block parameter for `Keka.err_if!` and `Keka.err_unless!`.
+
 ## Version 0.4.0
 * Support ActiveModel::Errors as argument to error message.
 

data/Gemfile.lock

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

data/README.md

@@ -18,8 +18,8 @@ class Order
     Keka.run do
       # returns an err keka with provided msg if !refundable?
       Keka.err_unless!(refundable?, 'Payment is no longer refundable.')
-      # returns an err keka with provided msg if !refund!
-      Keka.err_unless!(payment.refund, 'Refund failed. Please try again')
+      # returns an err keka with value from provided block if refund does not exist
+      Keka.err_unless!(payment.refund) { CustomErrorClass.new(message: 'Already been refunded') }
       # execute statements if nothing 'return' from above
       do_something_else
       # if cancel_delivery
@@ -42,6 +42,13 @@ class Order
   end
 end
 
+class CustomErrorClass
+  def initialize(message:)
+    @message = message
+    Airbrake.notify('Received refund request for already refunded method')
+  end
+end
+
 class SomeController
   def some_action
     keka = @order.refund
@@ -57,6 +64,18 @@ end
 Of course, you can also use `.err_unless!`, `.err_if!`, and `.ok_if!` outside
 of the `Keka.run` block.
 
+### Passing a block
+You can also pass a block to be executed if the result short circuits the execution. This is very useful for when you want to return a more complex `msg` than a String. For example, if you want to return an error class that validates certain properties upon initialization, then you will want to create the instance of error class in the block.
+
+NOTE: This block will only run if there is no `msg` provided.
+
+```
+Keka.err_if!(true)         { raise Error } # Raises error
+Keka.err_if!(false)        { raise Error } # Does not raises error
+Keka.err_if!(true, 'msg')  { raise Error } # Does not raises error
+Keka.err_if!(false, 'msg') { raise Error } # Does not raises error
+```
+
 ### 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.

data/lib/keka.rb

@@ -7,17 +7,39 @@ module Keka
   class << self
     include Context::Originable
 
-    def err_if!(evaluator, msg = nil)
-      raise Halt.new(err_result(msg)) if (evaluator.respond_to?(:ok?) ? evaluator.ok? : evaluator)
+    def err_if!(evaluator, msg = nil, &block)
+      if (evaluator.respond_to?(:ok?) ? evaluator.ok? : evaluator)
+        if msg
+          raise Halt.new(err_result(msg))
+        elsif block_given?
+          message = yield block
+          raise Halt.new(err_result(message))
+        else
+          raise Halt.new(err_result)
+        end
+      end
     end
 
-    def err_unless!(evaluator, msg = nil)
+    def err_unless!(evaluator, msg = nil, &block)
       if evaluator.is_a? self::Result
         return if evaluator.ok?
-        evaluator.msg = msg if msg
+        if msg
+          evaluator.msg = msg
+        else
+          evaluator.msg = yield block if block_given?
+        end
         raise Halt.new(evaluator)
       else
-        raise Halt.new(err_result(msg)) unless evaluator
+        unless evaluator
+          error_result = \
+            if msg
+              err_result(msg)
+            else
+              message = yield block if block_given?
+              err_result(message)
+            end
+          raise Halt.new(error_result)
+        end
       end
     end
 

data/lib/keka/version.rb

@@ -1,3 +1,3 @@
 module Keka
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keka
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - zino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler