lite-command 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 953b62c2ba61091b949e8fe3a673bc98be6a516afcea85192ea356e356aaf84e
-  data.tar.gz: adfb9bf29183586b33f8b32b801afadfbcf890398827e002dd794692bb708c9e
+  metadata.gz: 6239fda55d099d36d3fc4c171ecf6eff2cd56bb5ffc4536dde420da339d0b5c9
+  data.tar.gz: a7c3949c9313a479f16f4cf709730f8262576f4d899069240073c52923c9aac3
 SHA512:
-  metadata.gz: b618d0bda8cdbdc2335a16900e00addbdcf0a71e4ee6170c907d3b1e8110415990191d4bc9a9b5a0765582d2ce83df758d4b9109114fa33f04ec0ca27e388524
-  data.tar.gz: 6a606bcd18ad5c97920e67557bc946f8e38446c83fdb2155a298530e338cf1f033e6388b411f7229919be6a70eb6c45510b8c1a1c95f9eeed0beabaa143550fa
+  metadata.gz: 6330c34c333948919685049c4eaefc5913ab364b09f28322ea6283aa73b3906715cc063b1b61192e231d5582206e0ae91be506fba09035317711dd56ad7f7ae2
+  data.tar.gz: 69a682501448fb31fd0ad5709fc23f5f8b5dabc3c9a01486c4848a1d01f887523ab3fee3e7c2acdf6861b181bc1347dbee9bdccd6af3f1dc21321a6585a0a0f4

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.1] - 2024-10-25
+### Changed
+- Add option to raise original or fault exception
+
 ## [3.1.0] - 2024-10-25
 ### Added
 - Added `raise!` method to reraise soft call errors

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-command (3.1.0)
+    lite-command (3.1.1)
       activemodel
       ostruct
 

data/README.md

@@ -26,6 +26,7 @@ Or install it yourself as:
 * [Usage](#usage)
 * [Execution](#execution)
   * [Dynamic Faults](#dynamic-faults)
+  * [Raising Faults](#raising-faults)
 * [Context](#context)
   * [Attributes](#attributes)
   * [Validations](#validations)
@@ -88,21 +89,15 @@ end
 
 Executing a command can be done as an instance or class call. It returns the command instance
 in a frozen state. These will never call will never raise an execption, but will be kept track
-of in its internal state. You can raise the offending exception using `raise!`.
+of in its internal state.
 
 ```ruby
-cmd = DecryptSecretMessage.call(...)
+DecryptSecretMessage.call(...)
 # - or -
-cmd = DecryptSecretMessage.new(...).call
+DecryptSecretMessage.new(...).call
 
 # On success, fault or exception:
-cmd #=> <DecryptSecretMessage ...>
-
-# On fault:
-cmd.raise! #=> raises Lite::Command::Fault
-
-# On exception:
-cmd.raise! #=> raises StandardError
+#=> <DecryptSecretMessage ...>
 ```
 
 > [!TIP]
@@ -127,6 +122,29 @@ DecryptSecretMessage.new(...).call!
 #=> raises StandardError
 ```
 
+### Raising Faults
+
+Sometimes its suitable to raise the offending soft call command fault later
+in a call stack. Use the `raise!` method to reraise the fault or original
+error (if they differ). `original: false` is the default.
+
+```ruby
+cmd = DecryptSecretMessage.call(...)
+Apm.track_stat("DecryptSecretMessage.called")
+# other stuff...
+
+# On success:
+cmd.raise! #=> nil
+
+# On fault:
+cmd.raise!(original: false) #=> raises Lite::Command::Fault
+cmd.raise!(original: true)  #=> raises Lite::Command::Fault
+
+# On exception:
+cmd.raise!(original: false) #=> raises Lite::Command::Error
+cmd.raise!(original: true)  #=> raises StandardError
+```
+
 ### Dynamic Faults
 
 Dynamic faults are custom faults named after your command. This is especially

data/lib/lite/command/fault_streamer.rb

@@ -11,6 +11,20 @@ module Lite
         @object = object
       end
 
+      def reason
+        if object.respond_to?(:reason)
+          object.reason
+        elsif object.is_a?(StandardError)
+          "[#{object.class.name}] #{object.message}".chomp(".")
+        else
+          object
+        end
+      end
+
+      def metadata
+        Utils.try(object, :metadata) || command.metadata
+      end
+
       def caused_by
         Utils.try(object, :caused_by) || command
       end
@@ -21,18 +35,15 @@ module Lite
         Utils.try(object, :thrown_by) || command.caused_by
       end
 
-      def metadata
-        Utils.try(object, :metadata) || command.metadata
-      end
+      def fault_exception
+        return if command.success?
 
-      def reason
-        if object.respond_to?(:reason)
-          object.reason
-        elsif object.is_a?(StandardError)
-          "[#{object.class.name}] #{object.message}".chomp(".")
-        else
-          object
-        end
+        Fault.build(
+          command.status.capitalize,
+          command,
+          object,
+          dynamic: command.send(:raise_dynamic_faults?)
+        )
       end
 
     end

data/lib/lite/command/internals/calls.rb

@@ -84,13 +84,15 @@ module Lite
           @metadata  ||= down_stream.metadata
           @caused_by ||= down_stream.caused_by
           @thrown_by ||= down_stream.thrown_by
+
+          @fault_exception ||= down_stream.fault_exception
         end
 
         FAULTS.each do |f|
           # eg: invalid!("idk") or failure!(fault) or error!("idk", { error_key: "some.error" })
           define_method(:"#{f}!") do |object, metadata = nil|
             fault(object, f, metadata)
-            raise Lite::Command::Fault.build(f.capitalize, self, object, dynamic: raise_dynamic_faults?)
+            raise(fault_exception)
           end
         end
 

data/lib/lite/command/internals/executions.rb

@@ -60,7 +60,7 @@ module Lite
           around_execution { call }
           Utils.try(self, :on_success)
         rescue StandardError => e
-          @exception = e
+          @original_exception = e
           fault(e, ERROR, metadata) unless e.is_a?(Lite::Command::Fault)
           after_execution
           Utils.try(self, :"on_#{status}", e)
@@ -72,7 +72,7 @@ module Lite
           around_execution { call }
           Utils.try(self, :on_success)
         rescue StandardError => e
-          @exception = e
+          @original_exception = e
           fault(e, ERROR, metadata) unless e.is_a?(Lite::Command::Fault)
           after_execution
           Utils.try(self, :"on_#{status}", e)

data/lib/lite/command/internals/faults.rb

@@ -6,7 +6,7 @@ module Lite
       module Faults
 
         def self.included(base)
-          base.class_eval { attr_reader :exception }
+          base.class_eval { attr_reader :fault_exception, :original_exception }
         end
 
         def caused_by
@@ -33,10 +33,9 @@ module Lite
           fault? && !caused_fault?
         end
 
-        def raise!
-          return if exception.nil?
-
-          raise exception
+        def raise!(original: false)
+          exception = (fault_exception unless original) || original_exception
+          raise(exception) unless exception.nil?
         end
 
         private

data/lib/lite/command/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Command
 
-    VERSION = "3.1.0"
+    VERSION = "3.1.1"
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-command
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Juan Gomez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-25 00:00:00.000000000 Z
+date: 2024-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel