lite-command 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a841431a363de96b59d32abaa1bc733c04046a5d2f33b1c544e85b8b89cdcd9
-  data.tar.gz: 11dd1cd8c8e19cc8d58a631f94f647eb4d7a6b2effe2591d04eaea4c693ecdee
+  metadata.gz: b21cf35a72b7a37760d250919ee052e3800bfe09083709e9d9f65593612d8826
+  data.tar.gz: b2b55e457b95ce878aab140537ba1f28aa5310c4e257d0e2b11948ed9ee7f9c2
 SHA512:
-  metadata.gz: ae2440d1e33ddf601c42996a513f66771fb06af24a6f60534329b3337335bb714e3be2e9fd5b43d5f71e26ff8d2bc5bbe7bc9a07d275b259491858f6f8864e9b
-  data.tar.gz: 873edb0d145a80033180e0a33072dd80da38512511d718af17e4e91ddc65d90118bd63d8a341d22278a1d026751b0cf867df708dafde21be54fc54ef0c821f47
+  metadata.gz: f8ab004280e1c00026dacc92a7d652dc2859c68f6648e31210ccfa1c16a1aba9ba31e57843910bf90d4b94677e8cd8c4c651989c2e2f1983556f33ff786e6514
+  data.tar.gz: aed6da43c95926071114ef9692b17c4fa2b5a3215629e473c8bd70a552fdd624f189095cfa1744da6aa427cbcf80cfb6adb6db81c5b754f4ff81bfee500d046d

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.3] - 2024-09-30
+### Changed
+- Simplify error building
+- Reduced recalling error since we can just throw it once
+- Rename `fault_name` to `type`
+
 ## [2.0.2] - 2024-09-29
 ### Added
 - faultable module

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-command (2.0.2)
+    lite-command (2.0.3)
       ostruct
 
 GEM

data/README.md

@@ -94,7 +94,7 @@ command.context.result #=> 8
 
 #### States
 State represents the state of the executable code. Once `execute`
-is ran, it will always `complete` or `dnf` if a fault is thrown by a
+is ran, it will always `complete` or `interrupted` if a fault is thrown by a
 child command.
 
 - `pending`
@@ -103,7 +103,7 @@ child command.
     - Command objects actively executing code.
 - `complete`
     - Command objects that executed to completion.
-- `dnf`
+- `interrupted`
     - Command objects that could NOT be executed to completion.
       This could be as a result of a fault/exception on the
       object itself or one of its children.

data/lib/lite/command/base.rb

@@ -13,16 +13,15 @@ module Lite
         base.include Lite::Command::Internals::Resultable
 
         base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          # eg: Users::ResetPassword::Fault
-          class #{base}::Fault < Lite::Command::Fault; end
+          # eg: Users::ResetPassword::Fault < Lite::Command::Fault
+          #{base}::Fault = Class.new(Lite::Command::Fault)
+
+          # eg: Users::ResetPassword::Noop < Users::ResetPassword::Fault
+          #{base}::Noop    = Class.new(#{base}::Fault)
+          #{base}::Invalid = Class.new(#{base}::Fault)
+          #{base}::Failure = Class.new(#{base}::Fault)
+          #{base}::Error   = Class.new(#{base}::Fault)
         RUBY
-
-        FAULTS.each do |f|
-          base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            # eg: Users::ResetPassword::Noop < Users::ResetPassword::Fault
-            class #{base}::#{f.capitalize} < #{base}::Fault; end
-          RUBY
-        end
       end
 
       attr_reader :context

data/lib/lite/command/fault.rb

@@ -5,22 +5,18 @@ module Lite
 
     class Fault < StandardError
 
-      attr_reader :caused_by, :thrown_by, :reason
+      attr_reader :reason, :caused_by, :thrown_by
 
-      def initialize(caused_by, thrown_by, reason)
+      def initialize(reason, caused_by, thrown_by)
         super(reason)
 
+        @reason = reason
         @caused_by = caused_by
         @thrown_by = thrown_by
-        @reason = reason
-      end
-
-      def fault_klass
-        @fault_klass ||= self.class.name.split("::").last
       end
 
-      def fault_name
-        @fault_name ||= fault_klass.downcase
+      def type
+        @type ||= self.class.name.split("::").last.downcase
       end
 
     end

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

@@ -5,10 +5,10 @@ module Lite
 
     STATUSES = [
       SUCCESS = "success",
-      NOOP = "noop",
+      NOOP    = "noop",
       INVALID = "invalid",
       FAILURE = "failure",
-      ERROR = "error"
+      ERROR   = "error"
     ].freeze
     FAULTS = (STATUSES - [SUCCESS]).freeze
 
@@ -57,16 +57,16 @@ module Lite
         private
 
         FAULTS.each do |f|
-          # eg: error(fault_or_string)
-          define_method(:"#{f}") do |fault_or_string|
-            derive_fault_from(fault_or_string)
+          # eg: error(object)
+          define_method(:"#{f}") do |object|
+            derive_fault_from(object)
             @status = f
           end
 
-          # eg: invalid!(fault_or_string)
-          define_method(:"#{f}!") do |fault_or_string|
-            send(:"#{f}", fault_or_string)
-            raise_fault(Lite::Command.const_get(f.capitalize), fault_or_string)
+          # eg: invalid!(object)
+          define_method(:"#{f}!") do |object|
+            send(:"#{f}", object)
+            raise fault(f.capitalize, object)
           end
 
           # eg: on_noop(exception)

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

@@ -4,10 +4,10 @@ module Lite
   module Command
 
     STATES = [
-      PENDING = "pending",
-      EXECUTING = "executing",
-      COMPLETE = "complete",
-      DNF = "dnf"
+      PENDING     = "pending",
+      EXECUTING   = "executing",
+      COMPLETE    = "complete",
+      INTERRUPTED = "interrupted"
     ].freeze
 
     module Internals
@@ -16,21 +16,18 @@ module Lite
         def execute
           around_execution { call }
         rescue StandardError => e
-          fn = e.respond_to?(:fault_name) ? e.fault_name : ERROR
+          f = e.respond_to?(:type) ? e.type : ERROR
 
-          send(:"#{fn}", e)
+          send(:"#{f}", e)
           after_execution
-          send(:"on_#{fn}", e)
+          send(:"on_#{f}", e)
         end
 
         def execute!
           around_execution { call }
         rescue StandardError => e
           after_execution
-
-          raise(e) unless raise_dynamic_faults? && e.is_a?(Lite::Command::Fault)
-
-          raise_dynamic_fault(e)
+          raise(e)
         end
 
         def state
@@ -38,14 +35,14 @@ module Lite
         end
 
         def executed?
-          dnf? || complete?
+          complete? || interrupted?
         end
 
         STATES.each do |s|
           # eg: executing?
           define_method(:"#{s}?") { state == s }
 
-          # eg: dnf!
+          # eg: interrupted!
           define_method(:"#{s}!") { @state = s }
         end
 
@@ -60,7 +57,7 @@ module Lite
         end
 
         def after_execution
-          fault? ? dnf! : complete!
+          fault? ? interrupted! : complete!
           on_after_execution
           stop_monotonic_time
           append_execution_result

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

@@ -37,51 +37,46 @@ module Lite
           send(:"#{command.status}!", command)
         end
 
-        def derive_caused_by_from(fault_or_string)
-          (fault_or_string.caused_by if fault_or_string.respond_to?(:caused_by)) || self
+        def derive_caused_by_from(object)
+          (object.caused_by if object.respond_to?(:caused_by)) || self
         end
 
-        def derive_thrown_by_from(fault_or_string)
-          if fault_or_string.respond_to?(:executed?) && fault_or_string.executed?
-            fault_or_string
+        def derive_thrown_by_from(object)
+          if object.respond_to?(:executed?) && object.executed?
+            object
           else
-            (fault_or_string.thrown_by if fault_or_string.respond_to?(:thrown_by)) || caused_by
+            (object.thrown_by if object.respond_to?(:thrown_by)) || caused_by
           end
         end
 
-        def derive_reason_from(fault_or_string)
-          if fault_or_string.respond_to?(:reason)
-            fault_or_string.reason
-          elsif fault_or_string.respond_to?(:message)
-            "[#{fault_or_string.class.name}] #{fault_or_string.message}".chomp(".")
+        def derive_reason_from(object)
+          if object.respond_to?(:reason)
+            object.reason
+          elsif object.respond_to?(:message)
+            "[#{object.class.name}] #{object.message}".chomp(".")
           else
-            fault_or_string
+            object
           end
         end
 
-        def derive_fault_from(fault_or_string)
-          @caused_by ||= derive_caused_by_from(fault_or_string)
-          @thrown_by ||= derive_thrown_by_from(fault_or_string)
-          @reason ||= derive_reason_from(fault_or_string)
-        end
-
-        # eg: Lite::Command::Noop.new(...)
-        def raise_fault(klass, thrower)
-          exception = klass.new(caused_by, self, reason)
-          exception.set_backtrace(thrower.backtrace) if thrower.respond_to?(:backtrace)
-          raise(exception)
-        end
-
-        # eg: Users::ResetPassword::Noop.new(...)
-        def raise_dynamic_fault(exception)
-          fault_klass = self.class.const_get(exception.fault_klass)
-          raise_fault(fault_klass, exception)
+        def derive_fault_from(object)
+          @caused_by ||= derive_caused_by_from(object)
+          @thrown_by ||= derive_thrown_by_from(object)
+          @reason ||= derive_reason_from(object)
         end
 
         def raise_dynamic_faults?
           false
         end
 
+        # eg: Lite::Command::Noop.new(...) or Users::ResetPassword::Noop.new(...)
+        def fault(type, thrower)
+          klass = raise_dynamic_faults? ? self.class : Lite::Command
+          fault = klass.const_get(type.to_s).new(reason, caused_by, self)
+          fault.set_backtrace(thrower.backtrace) if thrower.respond_to?(:backtrace)
+          fault
+        end
+
       end
     end
   end

data/lib/lite/command/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Command
 
-    VERSION = "2.0.2"
+    VERSION = "2.0.3"
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-command
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Juan Gomez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-29 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct