lite-command 3.1.1 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6239fda55d099d36d3fc4c171ecf6eff2cd56bb5ffc4536dde420da339d0b5c9
-  data.tar.gz: a7c3949c9313a479f16f4cf709730f8262576f4d899069240073c52923c9aac3
+  metadata.gz: 39377d9ecb58d9d61ae0c99305d9db08672b7f97eb368194fc209b419cec1d0a
+  data.tar.gz: 5ec36c8fcb1d68e2a6bd3ae0866f687a9c04469d502dcba0bc7fe092a9b88351
 SHA512:
-  metadata.gz: 6330c34c333948919685049c4eaefc5913ab364b09f28322ea6283aa73b3906715cc063b1b61192e231d5582206e0ae91be506fba09035317711dd56ad7f7ae2
-  data.tar.gz: 69a682501448fb31fd0ad5709fc23f5f8b5dabc3c9a01486c4848a1d01f887523ab3fee3e7c2acdf6861b181bc1347dbee9bdccd6af3f1dc21321a6585a0a0f4
+  metadata.gz: 521be42ef9eab72ca99c2cd8dfba53ca3156538daf1e7715aff5123aefc6a70d7c4b439962306b8d1d22b87897bed1f54167353f98bea32d83ebf5eaaceffefe
+  data.tar.gz: 6c33d9b29e925c30b2e5abe06088fcfb0bccbd9cedbd241d76f398a89cfb7a679bf2a59b86ae766ccec69d94496640613d39995e9eca35ac3938d165a8e96eed

data/CHANGELOG.md

@@ -6,6 +6,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.3] - 2024-10-26
+### Added
+- Added passing `original_exception` to fault `!` calls
+### Changed
+- Move monotonic clock to util
+- Changed `metadata` to a keyword arg on fault `!` calls
+### Removed
+- Removed unnecessary `Lite::Command::` prefixes
+- Removed double if/unless eval for required validations
+
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-command (3.1.1)
+    lite-command (3.1.3)
       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

@@ -334,7 +334,7 @@ class DecryptSecretMessage < Lite::Command::Base
     if context.encrypted_message.empty?
       noop!("No message to decrypt")
     elsif context.encrypted_message.start_with?("== womp")
-      invalid!("Invalid message start value", i18n: "gb.invalid_start_value")
+      invalid!("Invalid message start value", metadata: { i18n: "gb.invalid_start_value" })
     elsif context.encrypted_message.algo?(OldAlgo)
       failure!("Unsafe encryption algo detected")
     else
@@ -342,7 +342,7 @@ class DecryptSecretMessage < Lite::Command::Base
     end
   rescue CryptoError => e
     Apm.report_error(e)
-    error!("Failed decryption due to: #{e}")
+    error!("Failed decryption due to: #{e}", original_exception: e)
   end
 
 end
@@ -541,7 +541,7 @@ class DecryptSecretMessage < Lite::Command::Base
     cmd = ValidateSecretMessage.call(context)
 
     if cmd.invalid?("Invalid magic numbers")
-      error!(cmd) # Manually throw a specific fault
+      failure!(cmd) # Manually throw a specific fault
     elsif command.fault?
       throw!(cmd) # Automatically throws a matching fault
     else

data/lib/lite/command/base.rb

@@ -11,11 +11,11 @@ module Lite
 
         base.include ActiveModel::Validations
 
-        base.include Lite::Command::Internals::Attributes
-        base.include Lite::Command::Internals::Calls
-        base.include Lite::Command::Internals::Executions
-        base.include Lite::Command::Internals::Faults
-        base.include Lite::Command::Internals::Results
+        base.include Internals::Attributes
+        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
           base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
@@ -32,7 +32,7 @@ module Lite
       alias ctx context
 
       def initialize(context = {})
-        @context = Lite::Command::Context.build(context)
+        @context = Context.build(context)
         Utils.try(self, :on_pending)
       end
 

data/lib/lite/command/fault.rb

@@ -29,16 +29,16 @@ module Lite
         fault
       end
 
-      def self.===(item)
-        Utils.descendant_of?(self, item) || Utils.descendant_of?(item, self)
+      def self.===(object)
+        Utils.descendant_of?(self, object) || Utils.descendant_of?(object, self)
       end
 
       def type
         @type ||= self.class.name.split("::").last.downcase
       end
 
-      def ===(item)
-        Utils.descendant_of?(self, item)
+      def ===(object)
+        Utils.descendant_of?(self, object)
       end
 
     end

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

@@ -15,7 +15,6 @@ module Lite
             delegate(*attributes, from:)
 
             validates_each(*attributes, **options) do |command, method_name, _attr_value|
-              next unless Utils.evaluate(command, options)
               next if command.errors.added?(from, :undefined) || command.errors.added?(method_name, :required)
 
               if !command.respond_to?(from, true)
@@ -55,7 +54,7 @@ module Lite
         def validate_context_attributes
           return if errors.empty?
 
-          invalid!(errors.full_messages.join(". "), errors.messages)
+          invalid!(errors.full_messages.join(". "), metadata: errors.messages)
         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,23 +75,29 @@ module Lite
           str.nil? || str == reason
         end
 
-        def fault(object, status, metadata)
-          @status   = status
-          @metadata = metadata
+        def fault(object, s, m, oe) # 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_exception ||= down_stream.fault_exception
+          fault_streamer = 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
+          @original_exception ||= oe || 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)
+          # eg: invalid!("idk") or failure!(fault) or error!("idk", metadata: { error_key: "some.error" }, original_exception: err)
+          define_method(:"#{f}!") do |object, metadata: nil, original_exception: nil|
+            return unless success?
+
+            fault(object, f, metadata, original_exception)
+
             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,7 @@ module Lite
           around_execution { call }
           Utils.try(self, :on_success)
         rescue StandardError => e
-          @original_exception = e
-          fault(e, ERROR, metadata) unless e.is_a?(Lite::Command::Fault)
+          fault(e, ERROR, metadata, e)
           after_execution
           Utils.try(self, :"on_#{status}", e)
         ensure
@@ -72,8 +86,7 @@ module Lite
           around_execution { call }
           Utils.try(self, :on_success)
         rescue StandardError => e
-          @original_exception = e
-          fault(e, ERROR, metadata) unless e.is_a?(Lite::Command::Fault)
+          fault(e, ERROR, metadata, e)
           after_execution
           Utils.try(self, :"on_#{status}", e)
           raise(e)

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

@@ -35,7 +35,9 @@ module Lite
 
         def raise!(original: false)
           exception = (fault_exception unless original) || original_exception
-          raise(exception) unless exception.nil?
+          return if exception.nil?
+
+          raise(exception)
         end
 
         private

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

@@ -53,11 +53,11 @@ module Lite
         end
 
         def start_monotonic_time
-          @start_monotonic_time ||= Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          @start_monotonic_time ||= Utils.monotonic_time
         end
 
         def stop_monotonic_time
-          @stop_monotonic_time ||= Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          @stop_monotonic_time ||= Utils.monotonic_time
         end
 
         def runtime

data/lib/lite/command/utils.rb

@@ -6,6 +6,10 @@ module Lite
 
       module_function
 
+      def monotonic_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      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.1"
+    VERSION = "3.1.3"
 
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lite-command
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.3
 platform: ruby
 authors:
 - Juan Gomez