lite-command 3.1.3 → 3.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39377d9ecb58d9d61ae0c99305d9db08672b7f97eb368194fc209b419cec1d0a
-  data.tar.gz: 5ec36c8fcb1d68e2a6bd3ae0866f687a9c04469d502dcba0bc7fe092a9b88351
+  metadata.gz: 25949bea3778fbe660ae361819879bc36deb461fb37e9efa4ad11012529ae682
+  data.tar.gz: 7f9df66b9027c3c7e3cb7b8efaad1508dec68c22b4b63ab27c4ffd123707519e
 SHA512:
-  metadata.gz: 521be42ef9eab72ca99c2cd8dfba53ca3156538daf1e7715aff5123aefc6a70d7c4b439962306b8d1d22b87897bed1f54167353f98bea32d83ebf5eaaceffefe
-  data.tar.gz: 6c33d9b29e925c30b2e5abe06088fcfb0bccbd9cedbd241d76f398a89cfb7a679bf2a59b86ae766ccec69d94496640613d39995e9eca35ac3938d165a8e96eed
+  metadata.gz: 9c2ee67da223708a63852d539ab82f7a893214c1016376fc0af4496d224ccdcfef3340b1267f6fec11348ae8d2ede2c87b605494aa2090a8f449c317a3d9613a
+  data.tar.gz: 29ec28857fc0e8f29e1ba34a41cae8b44298a44c9477e73a237f5eb708965ba555a4b82edff984b20b61b4f1967ce93586ec74075a8421f6481c353865c0e275

data/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.5] - 2024-10-28
+### Changed
+- Renamed private `delegate` method to `delegates` to prevent rails clash
+
+## [3.1.4] - 2024-10-27
+### Added
+- Add exception data to results hash
+### Changed
+- Relocated some results methods to a runtimes internal module
+- Assign correct fault even when child command is hard called
+- Renamed `fault_exception` to `command_exception`
+
 ## [3.1.3] - 2024-10-26
 ### Added
 - Added passing `original_exception` to fault `!` calls

data/Gemfile.lock

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

data/README.md

@@ -262,9 +262,18 @@ class DecryptSecretMessage < Lite::Command::Base
 
   validates :encrypted_message, length: 10..999
   validates :version, inclusion: { in: %w[v1 v3 v8], allow_blank: true }
+  validate :validate_decrypt_magic_numbers
 
   def call
-    context.decrypted_message = SecretMessage.decrypt(ctx.encrypted_message)
+    context.decrypted_message = SecretMessage.decrypt(encrypted_message)
+  end
+
+  private
+
+  def validate_decrypt_magic_numbers
+    return if encrypted_message.starts_with?("~x01~")
+
+    errors.add(:encrypted_message, :invalid, message: "has invalid magic numbers")
   end
 
 end
@@ -352,6 +361,9 @@ cmd.status   #=> "invalid"
 cmd.reason   #=> "Invalid message start value"
 cmd.metadata #=> { i18n: "gb.invalid_start_value" }
 
+cmd.original_exception #=> <RuntimeError ...>
+cmd.command_exception  #=> <DecryptSecretMessage::Error ...>
+
 cmd.success? #=> false
 cmd.noop?    #=> false
 cmd.invalid? #=> true
@@ -606,13 +618,15 @@ command.to_hash #=> {
                 #=>   outcome: "failure",
                 #=>   state: "interrupted",
                 #=>   status: "failure",
-                #=>   reason: "[!] command stopped due to failure",
+                #=>   reason: "Command stopped due to some failure",
                 #=>   metadata: {
                 #=>     errors: { name: ["is too short"] },
                 #=>     i18n_key: "command.failure"
                 #=>   },
-                #=>   caused_by: 1,
-                #=>   thrown_by: 1,
+                #=>   caused_by: 3,
+                #=>   caused_exception: "[ChildCommand::Failure] something is wrong from within",
+                #=>   thrown_by: 2,
+                #=>   thrown_exception: "[FailureCommand::Failure] something is wrong from within",
                 #=>   runtime: 0.0123
                 #=> }
 ```

data/lib/lite/command/base.rb

@@ -11,10 +11,11 @@ module Lite
 
         base.include ActiveModel::Validations
 
+        base.include Internals::Runtimes
         base.include Internals::Attributes
+        base.include Internals::Faults
         base.include Internals::Calls
         base.include Internals::Executions
-        base.include Internals::Faults
         base.include Internals::Results
 
         if Lite::Command.configuration.raise_dynamic_faults # rubocop:disable Style/GuardClause

data/lib/lite/command/fault_streamer.rb

@@ -15,7 +15,7 @@ module Lite
         if object.respond_to?(:reason)
           object.reason
         elsif object.is_a?(StandardError)
-          "[#{object.class.name}] #{object.message}".chomp(".")
+          Utils.pretty_exception(object)
         else
           object
         end
@@ -35,7 +35,7 @@ module Lite
         Utils.try(object, :thrown_by) || command.caused_by
       end
 
-      def fault_exception
+      def command_exception
         return if command.success?
 
         Fault.build(

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

@@ -12,7 +12,7 @@ module Lite
         module ClassMethods
 
           def required(*attributes, from: :context, **options)
-            delegate(*attributes, from:)
+            delegates(*attributes, from:)
 
             validates_each(*attributes, **options) do |command, method_name, _attr_value|
               next if command.errors.added?(from, :undefined) || command.errors.added?(method_name, :required)
@@ -26,12 +26,12 @@ module Lite
           end
 
           def optional(*attributes, from: :context, **_options)
-            delegate(*attributes, from:)
+            delegates(*attributes, from:)
           end
 
           private
 
-          def delegate(*attributes, from: :context)
+          def delegates(*attributes, from: :context)
             attributes.each do |method_name|
               define_method(method_name) do
                 return unless respond_to?(from)

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

@@ -75,7 +75,7 @@ module Lite
           str.nil? || str == reason
         end
 
-        def fault(object, s, m, oe) # rubocop:disable Naming/MethodParameterName
+        def fault(object, s, m, exception: nil) # rubocop:disable Naming/MethodParameterName
           return if s == SUCCESS || status != SUCCESS
 
           @status   = s
@@ -87,8 +87,8 @@ module Lite
           @caused_by ||= fault_streamer.caused_by
           @thrown_by ||= fault_streamer.thrown_by
 
-          @fault_exception    ||= fault_streamer.fault_exception
-          @original_exception ||= oe || fault_exception
+          @command_exception  ||= fault_streamer.command_exception
+          @original_exception ||= exception || command_exception
         end
 
         FAULTS.each do |f|
@@ -96,9 +96,9 @@ module Lite
           define_method(:"#{f}!") do |object, metadata: nil, original_exception: nil|
             return unless success?
 
-            fault(object, f, metadata, original_exception)
+            fault(object, f, metadata, exception: original_exception)
 
-            raise(fault_exception)
+            raise(command_exception)
           end
         end
 

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

@@ -75,7 +75,7 @@ module Lite
           around_execution { call }
           Utils.try(self, :on_success)
         rescue StandardError => e
-          fault(e, ERROR, metadata, e)
+          fault(e, Utils.try(e, :type) || ERROR, metadata, exception: e)
           after_execution
           Utils.try(self, :"on_#{status}", e)
         ensure
@@ -86,7 +86,7 @@ module Lite
           around_execution { call }
           Utils.try(self, :on_success)
         rescue StandardError => e
-          fault(e, ERROR, metadata, e)
+          fault(e, Utils.try(e, :type) || ERROR, metadata, exception: e)
           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 :fault_exception, :original_exception }
+          base.class_eval { attr_reader :command_exception, :original_exception }
         end
 
         def caused_by
@@ -34,7 +34,7 @@ module Lite
         end
 
         def raise!(original: false)
-          exception = (fault_exception unless original) || original_exception
+          exception = (command_exception unless original) || original_exception
           return if exception.nil?
 
           raise(exception)

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

@@ -1,20 +1,10 @@
 # frozen_string_literal: true
 
-require "securerandom" unless defined?(SecureRandom)
-
 module Lite
   module Command
     module Internals
       module Results
 
-        def index
-          @index ||= context.index ||= 0
-        end
-
-        def cmd_id
-          @cmd_id ||= context.cmd_id ||= SecureRandom.uuid
-        end
-
         def outcome
           return state if pending? || thrown?
 
@@ -36,7 +26,9 @@ module Lite
             reason:,
             metadata:,
             caused_by: caused_by&.index,
+            caused_exception: Utils.pretty_exception(caused_by&.original_exception),
             thrown_by: thrown_by&.index,
+            thrown_exception: Utils.pretty_exception(thrown_by&.command_exception),
             runtime:
           }.compact
         end
@@ -44,26 +36,6 @@ module Lite
 
         private
 
-        def assign_execution_cmd_id
-          @cmd_id = context.cmd_id ||= cmd_id
-        end
-
-        def increment_execution_index
-          @index = context.index = index.next
-        end
-
-        def start_monotonic_time
-          @start_monotonic_time ||= Utils.monotonic_time
-        end
-
-        def stop_monotonic_time
-          @stop_monotonic_time ||= Utils.monotonic_time
-        end
-
-        def runtime
-          stop_monotonic_time - start_monotonic_time
-        end
-
         def append_execution_result
           results.push(self).sort_by!(&:index)
         end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "securerandom" unless defined?(SecureRandom)
+
+module Lite
+  module Command
+    module Internals
+      module Runtimes
+
+        def index
+          @index ||= context.index ||= 0
+        end
+
+        def cmd_id
+          @cmd_id ||= context.cmd_id ||= SecureRandom.uuid
+        end
+
+        private
+
+        def assign_execution_cmd_id
+          @cmd_id = context.cmd_id ||= cmd_id
+        end
+
+        def increment_execution_index
+          @index = context.index = index.next
+        end
+
+        def start_monotonic_time
+          @start_monotonic_time ||= Utils.monotonic_time
+        end
+
+        def stop_monotonic_time
+          @stop_monotonic_time ||= Utils.monotonic_time
+        end
+
+        def runtime
+          stop_monotonic_time - start_monotonic_time
+        end
+
+      end
+    end
+  end
+end

data/lib/lite/command/utils.rb

@@ -10,6 +10,12 @@ module Lite
         Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
 
+      def pretty_exception(exception)
+        return if exception.nil?
+
+        "[#{exception.class.name}] #{exception.message}".chomp(".")
+      end
+
       def descendant_of?(object, other)
         object_class = object.respond_to?(:new) ? object : object.class
         other_class = other.respond_to?(:new) ? other : other.class

data/lib/lite/command/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Command
 
-    VERSION = "3.1.3"
+    VERSION = "3.1.5"
 
   end
 end

data/lib/lite/command.rb

@@ -11,10 +11,11 @@ require "lite/command/utils"
 require "lite/command/context"
 require "lite/command/fault"
 require "lite/command/fault_streamer"
+require "lite/command/internals/runtimes"
 require "lite/command/internals/attributes"
+require "lite/command/internals/faults"
 require "lite/command/internals/calls"
 require "lite/command/internals/executions"
-require "lite/command/internals/faults"
 require "lite/command/internals/results"
 require "lite/command/base"
 require "lite/command/step"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-command
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.5
 platform: ruby
 authors:
 - Juan Gomez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-26 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -202,6 +202,7 @@ files:
 - lib/lite/command/internals/executions.rb
 - lib/lite/command/internals/faults.rb
 - lib/lite/command/internals/results.rb
+- lib/lite/command/internals/runtimes.rb
 - lib/lite/command/sequence.rb
 - lib/lite/command/step.rb
 - lib/lite/command/utils.rb