lite-command 3.1.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 953b62c2ba61091b949e8fe3a673bc98be6a516afcea85192ea356e356aaf84e
-  data.tar.gz: adfb9bf29183586b33f8b32b801afadfbcf890398827e002dd794692bb708c9e
+  metadata.gz: 6eb09ff348ac355723d82848c69c1673d7ffa2782b3bb0061b16ccbe205b9529
+  data.tar.gz: 514ffc0ce29de277bd0969c29a51884d2509fd46b69e5cc6f85ded44fba4e827
 SHA512:
-  metadata.gz: b618d0bda8cdbdc2335a16900e00addbdcf0a71e4ee6170c907d3b1e8110415990191d4bc9a9b5a0765582d2ce83df758d4b9109114fa33f04ec0ca27e388524
-  data.tar.gz: 6a606bcd18ad5c97920e67557bc946f8e38446c83fdb2155a298530e338cf1f033e6388b411f7229919be6a70eb6c45510b8c1a1c95f9eeed0beabaa143550fa
+  metadata.gz: 00d47aa6fc59fa96895311bd78be8dcf3b283da16197f6973eb5db4100b61ef6303ab65673b695dfd51cfbc64ae63eca9b70adc0eba46763a25597fa1c1e6ba0
+  data.tar.gz: 2e60eaa36e8b86cec861bc67bfa3bee12292c8edf8c92503e4339128f69f467421f94a4b53ee1a8a96a467cb25617cb6918d553419bbb6b1fbd23c817b2227dd

data/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.2] - 2024-10-26
+### Changed
+- Make state set methods private
+- Add returns for invalid state and status transitions
+
+## [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.2)
       activemodel
       ostruct
 
@@ -136,7 +136,7 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (3.1.0)
+    rubocop-rspec (3.2.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     securerandom (0.3.1)

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

@@ -59,7 +59,7 @@ module Lite
         end
 
         def bad?(reason = nil)
-          ![SUCCESS, NOOP].include?(status) && reason?(reason)
+          !ok?(reason)
         end
 
         FAULTS.each do |f|
@@ -75,22 +75,27 @@ module Lite
           str.nil? || str == reason
         end
 
-        def fault(object, status, metadata)
-          @status   = status
-          @metadata = metadata
+        def fault(object, s, m) # rubocop:disable Naming/MethodParameterName
+          return if s == SUCCESS || status != SUCCESS
 
-          down_stream = Lite::Command::FaultStreamer.new(self, object)
-          @reason    ||= down_stream.reason
-          @metadata  ||= down_stream.metadata
-          @caused_by ||= down_stream.caused_by
-          @thrown_by ||= down_stream.thrown_by
+          @status   = s
+          @metadata = m
+
+          fault_streamer = Lite::Command::FaultStreamer.new(self, object)
+          @reason    ||= fault_streamer.reason
+          @metadata  ||= fault_streamer.metadata
+          @caused_by ||= fault_streamer.caused_by
+          @thrown_by ||= fault_streamer.thrown_by
+          @fault_exception ||= fault_streamer.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|
+            return unless success?
+
             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

@@ -24,13 +24,28 @@ module Lite
         STATES.each do |s|
           # eg: executing?
           define_method(:"#{s}?") { state == s }
-
-          # eg: interrupted!
-          define_method(:"#{s}!") { @state = s }
         end
 
         private
 
+        def executing!
+          return unless pending?
+
+          @state = EXECUTING
+        end
+
+        def complete!
+          return if executed?
+
+          @state = COMPLETE
+        end
+
+        def interrupted!
+          return if executed?
+
+          @state = INTERRUPTED
+        end
+
         def before_execution
           increment_execution_index
           assign_execution_cmd_id
@@ -60,8 +75,8 @@ module Lite
           around_execution { call }
           Utils.try(self, :on_success)
         rescue StandardError => e
-          @exception = e
-          fault(e, ERROR, metadata) unless e.is_a?(Lite::Command::Fault)
+          @original_exception = e
+          fault(e, ERROR, metadata)
           after_execution
           Utils.try(self, :"on_#{status}", e)
         ensure
@@ -72,8 +87,8 @@ module Lite
           around_execution { call }
           Utils.try(self, :on_success)
         rescue StandardError => e
-          @exception = e
-          fault(e, ERROR, metadata) unless e.is_a?(Lite::Command::Fault)
+          @original_exception = e
+          fault(e, ERROR, metadata)
           after_execution
           Utils.try(self, :"on_#{status}", e)
           raise(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,11 @@ module Lite
           fault? && !caused_fault?
         end
 
-        def raise!
+        def raise!(original: false)
+          exception = (fault_exception unless original) || original_exception
           return if exception.nil?
 
-          raise exception
+          raise(exception)
         end
 
         private

data/lib/lite/command/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Command
 
-    VERSION = "3.1.0"
+    VERSION = "3.1.2"
 
   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.2
 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