lite-command 1.5.0 → 2.0.1

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

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Lite
+  module Command
+
+    # Status represents the state of the callable code. If no fault
+    # is thrown then a status of SUCCESS is returned even if `call`
+    # has not been executed.
+    FAULTS = [
+      NOOP = "noop",
+      INVALID = "invalid",
+      FAILURE = "failure",
+      ERROR = "error"
+    ].freeze
+    STATUSES = [
+      *FAULTS,
+      SUCCESS = "success"
+    ].freeze
+
+    module Internals
+      module Callable
+
+        def self.included(base)
+          base.extend ClassMethods
+          base.class_eval do
+            attr_reader :faulter, :thrower, :reason
+          end
+        end
+
+        module ClassMethods
+
+          def call(context = {})
+            new(context).tap(&:execute)
+          end
+
+          def call!(context = {})
+            new(context).tap(&:execute!)
+          end
+
+        end
+
+        def call
+          raise NotImplementedError, "call method not defined in #{self.class}"
+        end
+
+        def success?
+          !fault?
+        end
+
+        def fault?(message = nil)
+          FAULTS.any? { |f| send(:"#{f}?", message) }
+        end
+
+        def status
+          STATUSES.find { |s| send(:"#{s}?") }
+        end
+
+        def faulter?
+          faulter == self
+        end
+
+        def thrower?
+          thrower == self
+        end
+
+        def thrown_fault?
+          fault? && !faulter?
+        end
+
+        FAULTS.each do |f|
+          # eg: error?(message = nil)
+          define_method(:"#{f}?") do |message = nil|
+            fault_result = instance_variable_get(:"@#{f}") || false
+            return fault_result if message.nil?
+
+            reason == message
+          end
+        end
+
+        private
+
+        def derive_faulter_from(object)
+          (object.faulter if object.respond_to?(:faulter)) || self
+        end
+
+        def derive_thrower_from(object)
+          if object.respond_to?(:executed?) && object.executed?
+            object
+          else
+            (object.thrower if object.respond_to?(:thrower)) || faulter
+          end
+        end
+
+        def derive_reason_from(object)
+          if object.respond_to?(:reason)
+            object.reason
+          elsif object.respond_to?(:message)
+            "[#{object.class.name}] #{object.message}".chomp(".")
+          else
+            object
+          end
+        end
+
+        def fault(object)
+          @faulter ||= derive_faulter_from(object)
+          @thrower ||= derive_thrower_from(object)
+          @reason ||= derive_reason_from(object)
+        end
+
+        # eg: Lite::Command::Noop.new(...)
+        def raise_fault(klass, object)
+          exception = klass.new(faulter, self, reason)
+          exception.set_backtrace(object.backtrace) if object.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)
+        end
+
+        def raise_dynamic_faults?
+          false
+        end
+
+        def throw!(command)
+          return if command.success?
+
+          send(:"#{command.status}!", command)
+        end
+
+        FAULTS.each do |f|
+          # eg: error(object)
+          define_method(:"#{f}") do |object|
+            fault(object)
+            instance_variable_set(:"@#{f}", true)
+          end
+
+          # eg: invalid!(object)
+          define_method(:"#{f}!") do |object|
+            send(:"#{f}", object)
+            raise_fault(Lite::Command.const_get(f.capitalize), object)
+          end
+
+          # eg: on_noop(exception)
+          define_method(:"on_#{f}") do |_exception|
+            # Define in your class to run code when a StandardError happens
+          end
+        end
+
+        alias fail! failure!
+
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Lite
+  module Command
+
+    # 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
+    # child command.
+    STATES = [
+      PENDING = "pending",
+      EXECUTING = "executing",
+      COMPLETE = "complete",
+      DNF = "dnf"
+    ].freeze
+
+    module Internals
+      module Executable
+
+        def execute
+          around_execution { call }
+        rescue StandardError => e
+          fn = e.respond_to?(:fault_name) ? e.fault_name : ERROR
+
+          send(:"#{fn}", e)
+          after_execution
+          send(:"on_#{fn}", 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)
+        end
+
+        def state
+          @state || PENDING
+        end
+
+        def executed?
+          dnf? || complete?
+        end
+
+        STATES.each do |s|
+          # eg: running?
+          define_method(:"#{s}?") { state == s }
+
+          # eg: dnf!
+          define_method(:"#{s}!") { @state = s }
+        end
+
+        private
+
+        def before_execution
+          increment_execution_index
+          assign_execution_cid
+          start_monotonic_time
+          executing!
+          on_before_execution
+        end
+
+        def after_execution
+          fault? ? dnf! : complete!
+          on_after_execution
+          stop_monotonic_time
+          append_execution_result
+          freeze_execution_objects
+        end
+
+        def around_execution
+          before_execution
+          yield
+          after_execution
+        end
+
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "securerandom" unless defined?(SecureRandom)
+
+module Lite
+  module Command
+    module Internals
+      module Resultable
+
+        def index
+          @index ||= context.index ||= 0
+        end
+
+        def cid
+          @cid ||= context.cid
+        end
+
+        def outcome
+          return state if pending? || thrown_fault?
+
+          status
+        end
+
+        def results
+          @results ||= context.results ||= []
+        end
+
+        def to_hash
+          {
+            index:,
+            cid:,
+            command: self.class.name,
+            outcome:,
+            state:,
+            status:,
+            reason:,
+            fault: faulter&.index,
+            throw: thrower&.index,
+            runtime:
+          }.compact
+        end
+        alias to_h to_hash
+
+        private
+
+        def assign_execution_cid
+          context.cid ||= SecureRandom.uuid
+        end
+
+        def increment_execution_index
+          @index = context.index = index.next
+        end
+
+        def start_monotonic_time
+          @start_monotonic_time ||= Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        end
+
+        def stop_monotonic_time
+          @stop_monotonic_time ||= Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        end
+
+        def runtime
+          stop_monotonic_time - start_monotonic_time
+        end
+
+        def append_execution_result
+          results.push(self).sort_by!(&:index)
+        end
+
+        def freeze_execution_objects
+          context.freeze if index == 1
+          freeze
+        end
+
+      end
+    end
+  end
+end

data/lib/lite/command/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Command
 
-    VERSION = '1.5.0'
+    VERSION = "2.0.1"
 
   end
 end

data/lib/lite/command.rb

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
-require 'generators/rails/command_generator' if defined?(Rails::Generators)
-
-require 'lite/command/version'
-
-require 'lite/command/extensions/errors'
-require 'lite/command/extensions/memoize'
-require 'lite/command/extensions/propagation'
-
-require 'lite/command/exceptions'
-require 'lite/command/states'
-require 'lite/command/simple'
-require 'lite/command/complex'
-require 'lite/command/procedure'
+require "generators/rails/command_generator" if defined?(Rails::Generators)
+
+require "lite/command/version"
+require "lite/command/internals/callable"
+require "lite/command/internals/executable"
+require "lite/command/internals/resultable"
+require "lite/command/fault"
+require "lite/command/context"
+require "lite/command/base"

data/lite-command.gemspec

@@ -1,55 +1,53 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'lite/command/version'
+require "lite/command/version"
 
 Gem::Specification.new do |spec|
-  spec.name = 'lite-command'
+  spec.name = "lite-command"
   spec.version = Lite::Command::VERSION
-  spec.authors = ['Juan Gomez']
+  spec.authors = ["Juan Gomez"]
   spec.email = %w[j.gomez@drexed.com]
 
-  spec.summary = 'Ruby Command based framework (aka service objects)'
-  spec.homepage = 'http://drexed.github.io/lite-command'
-  spec.license = 'MIT'
+  spec.summary = "Ruby Command based framework (aka service objects)"
+  spec.homepage = "http://drexed.github.io/lite-command"
+  spec.license = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     spec.metadata.merge(
-      'allowed_push_host' => 'https://rubygems.org',
-      'changelog_uri' => 'https://github.com/drexed/lite-command/blob/master/CHANGELOG.md',
-      'homepage_uri' => spec.homepage,
-      'source_code_uri' => 'https://github.com/drexed/lite-command'
+      "allowed_push_host" => "https://rubygems.org",
+      "changelog_uri" => "https://github.com/drexed/lite-command/blob/master/CHANGELOG.md",
+      "homepage_uri" => spec.homepage,
+      "source_code_uri" => "https://github.com/drexed/lite-command"
     )
   else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-          'public gem pushes.'
+    raise "RubyGems 2.0 or newer is required to protect against " \
+          "public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir = 'exe'
+  spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
-  spec.add_dependency 'lite-errors'
-  spec.add_dependency 'lite-memoize'
+  spec.add_dependency "ostruct"
 
-  spec.add_development_dependency 'activerecord'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'database_cleaner'
-  spec.add_development_dependency 'fasterer'
-  spec.add_development_dependency 'generator_spec'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-performance'
-  spec.add_development_dependency 'rubocop-rake'
-  spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "fasterer"
+  spec.add_development_dependency "generator_spec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rake"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: lite-command
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Juan Gomez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2024-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: lite-errors
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,34 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: lite-memoize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: fasterer
   requirement: !ruby/object:Gem::Requirement
@@ -233,20 +191,19 @@ files:
 - lib/generators/rails/command_generator.rb
 - lib/generators/rails/templates/command.rb.tt
 - lib/lite/command.rb
-- lib/lite/command/complex.rb
-- lib/lite/command/exceptions.rb
-- lib/lite/command/extensions/errors.rb
-- lib/lite/command/extensions/memoize.rb
-- lib/lite/command/extensions/propagation.rb
-- lib/lite/command/procedure.rb
-- lib/lite/command/simple.rb
-- lib/lite/command/states.rb
+- lib/lite/command/base.rb
+- lib/lite/command/context.rb
+- lib/lite/command/fault.rb
+- lib/lite/command/internals/callable.rb
+- lib/lite/command/internals/executable.rb
+- lib/lite/command/internals/resultable.rb
 - lib/lite/command/version.rb
 - lite-command.gemspec
 homepage: http://drexed.github.io/lite-command
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -262,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.5.19
 signing_key:
 specification_version: 4
 summary: Ruby Command based framework (aka service objects)

data/lib/lite/command/complex.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Lite
-  module Command
-    class Complex
-
-      class << self
-
-        def call(*args, **kwargs, &block)
-          instance = new(*args, **kwargs, &block)
-
-          raise Lite::Command::NotImplementedError unless instance.respond_to?(:execute)
-
-          instance.call
-          instance
-        end
-
-        def execute(*args, **kwargs, &block)
-          instance = call(*args, **kwargs, &block)
-          instance.result
-        end
-
-      end
-
-      attr_reader :args, :result
-
-      def initialize(*args)
-        @args = args
-      end
-
-      def call
-        raise Lite::Command::NotImplementedError unless defined?(execute)
-
-        return @result if called?
-
-        @called = true
-        @result = execute
-      end
-
-      def called?
-        @called ||= false
-      end
-
-      def recall!
-        @called = false
-        %i[cache errors].each { |method_name| send(method_name).clear if respond_to?(method_name) }
-        call
-      end
-
-    end
-  end
-end

data/lib/lite/command/exceptions.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Lite
-  module Command
-
-    class NotImplementedError < StandardError; end
-    class ValidationError < StandardError; end
-
-  end
-end