gl_command 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11a5d5ab9dd4a28700cb671153c1a757612f5b735194a28ad22f8be660a09250
-  data.tar.gz: a3a351134af335563ee6e970d5920d08e52f2b4375cef1c8adc87e555bd1e64f
+  metadata.gz: 2c64386ffafec990d01604c12482b0cf2deb8b4caff95c638d9d4e8835c4cb92
+  data.tar.gz: 9a58f0b30039b493382f01d22fb8cc2c8d6950af71f16ec3b4e708a776e78af9
 SHA512:
-  metadata.gz: 4344a62dca3bccad299425f9d22db05ca7e3062518c0f4a0c3b1be2d3708de8ccb3d310380c5a4eb73b515a21c4866c8b3385f9ee18c23e9389fd49e9afb8803
-  data.tar.gz: '08c842fe87ac92bc793fad76498e0b12ecc772a8d5385fea2d5c34670115ba40a17545227e572a5ce1bcee9b3bc6c52f2e70f59e45a8755a871b93ebe3d344a2'
+  metadata.gz: 126e275c0bd65be3fb7fe1ead77e283231a158359b1c95ab00d691e010287f41b397a97a9202de316ba921313b1df66c59e76b4f5e13d62d4130d762aba6f803
+  data.tar.gz: 728454632aa41f5b740b4f3eaf97c85ee8022857ac349ca86bfa0d655687fc6b402b7501629e580c3ed3c2b87b621a56a11333a95f3239d8ec0095901bb0e311

data/lib/gl_command/callable.rb

@@ -6,7 +6,7 @@ require 'gl_command/validatable'
 
 module GLCommand
   class Callable
-    DEFAULT_OPTS = { raise_errors: false, skip_unknown_parameters: true }.freeze
+    DEFAULT_OPTS = { raise_errors: false, skip_unknown_parameters: true, in_chain: false }.freeze
     RESERVED_WORDS = (DEFAULT_OPTS.keys + GLCommand::ChainableContext.reserved_words).sort.freeze
 
     class << self
@@ -25,7 +25,8 @@ module GLCommand
 
         # DEFAULT_OPTS contains skip_unknown_parameters: true - so it raises on call
         # (rather than in context initialize) to make errors more legible
-        opts = DEFAULT_OPTS.merge(raise_errors: args.delete(:raise_errors)).compact
+        opts = DEFAULT_OPTS.merge(raise_errors: args.delete(:raise_errors),
+                                  in_chain: args.delete(:in_chain)).compact
         # args are passed in in perform_call(args) so that invalid args raise in a legible place
         new(build_context(**args.merge(opts))).perform_call(args)
       end
@@ -34,9 +35,13 @@ module GLCommand
         call(*posargs, **args.merge(raise_errors: true))
       end
 
-      def build_context(raise_errors: false, skip_unknown_parameters: false,
+      # error can be passed to build context, useful for stubbing in tests
+      def build_context(raise_errors: false, skip_unknown_parameters: false, error: nil,
                         **arguments_and_returns)
-        context_class.new(self, raise_errors:, skip_unknown_parameters:, **arguments_and_returns)
+        new_context = context_class.new(self, raise_errors:, skip_unknown_parameters:,
+                                              **arguments_and_returns)
+        new_context.error = error if error.present?
+        new_context
       end
 
       def requires(*attributes, **strong_attributes)
@@ -70,7 +75,7 @@ module GLCommand
         (arguments + returns).uniq
       end
 
-      # Used internally by GLCommand (probably don't reference them in your own GLCommands)
+      # Used internally by GLCommand (probably don't reference in your own GLCommands)
       # is true in GLCommand::Chainable
       def chain?
         false
@@ -106,7 +111,9 @@ module GLCommand
 
     def perform_call(args)
       raise_for_invalid_args!(**args)
+      instrument_command(:before_call)
       call_with_callbacks
+      instrument_command(:after_call)
       raise_unless_chained_or_skipped if self.class.chain? # defined in GLCommand::Chainable
       context.failure? ? handle_failure : context
     rescue StandardError => e
@@ -133,6 +140,11 @@ module GLCommand
 
     private
 
+    # trigger: [:before_call, :after_call, :before_rollback]
+    def instrument_command(trigger)
+      # Override where gem is used if you want to instrument commands
+    end
+
     # rubocop:disable Metrics/AbcSize
     def handle_failure(e = nil)
       context.error ||= e
@@ -159,9 +171,7 @@ module GLCommand
     rescue GLCommand::CommandNoNotifyError
       raise context.error # makes CommandNoNotifyError the cause
     end
-    # rubocop:enable Metrics/AbcSize
 
-    # rubocop:disable Metrics/AbcSize
     def call_with_callbacks
       GLExceptionNotifier.breadcrumbs(data: { context: context.inspect }, message: self.class.to_s)
       validate_validatable! # defined in GLCommand::Validatable
@@ -186,6 +196,8 @@ module GLCommand
     def call_rollbacks
       return if defined?(@rolled_back) # Not sure this is required
 
+      instrument_command(:before_rollback)
+
       @rolled_back = true
 
       chain_rollback if self.class.chain? # defined in GLCommand::Chainable

data/lib/gl_command/chainable.rb

@@ -41,7 +41,7 @@ module GLCommand
 
       commands.map do |command|
         cargs = context.chain_arguments_and_returns.slice(*command.arguments)
-                       .merge(context.opts_hash)
+                       .merge(context.opts_hash).merge(in_chain: true)
 
         result = command.call(**cargs)
         context.assign_parameters(skip_unknown_parameters: true, **result.returns)

data/lib/gl_command/context.rb

@@ -7,9 +7,10 @@ require 'active_support/core_ext/module'
 module GLCommand
   class Context
     def initialize(klass, raise_errors: false, skip_unknown_parameters: false,
-                   **arguments_and_returns)
+                   in_chain: false, **arguments_and_returns)
       @klass = klass
       @raise_errors = raise_errors.nil? ? false : raise_errors
+      @in_chain = in_chain
       @klass.arguments_and_returns.each { |key| singleton_class.class_eval { attr_accessor key } }
       initialize_chain_context(**arguments_and_returns) if chain?
       assign_parameters(skip_unknown_parameters:, **arguments_and_returns)
@@ -24,12 +25,21 @@ module GLCommand
     attr_reader :klass, :error
     attr_writer :full_error_message
 
-    delegate :errors, to: :@callable, allow_nil: true
+    # If someone calls errors on a context, they expect to get the errors!
+    # Make that work, but also try to make it clear that they probably shouldn't be using that for presentation
+    def errors
+      current_errors&.add(:base, "full_error_message: #{full_error_message}") if @failure && current_errors.blank?
+      current_errors
+    end
 
     def chain?
       false
     end
 
+    def in_chain?
+      @in_chain
+    end
+
     def returns
       @klass.returns.index_with { |rattr| send(rattr) }
     end
@@ -43,7 +53,7 @@ module GLCommand
     end
 
     def failure?
-      @failure || errors.present? || @full_error_message.present? || false
+      @failure || current_errors.present? || @full_error_message.present? || false
     end
 
     def success?
@@ -98,7 +108,7 @@ module GLCommand
             passed_error.is_a?(ActiveRecord::RecordInvalid) && defined?(passed_error.record.errors)
           # Return a new error if it's an error (rather than the class)
           passed_error.is_a?(Class) ? passed_error.new(@full_error_message) : passed_error
-        elsif errors.present? # check for validation errors
+        elsif current_errors.present? # check for validation errors
           # Assign ActiveRecord::RecordInvalid if validatable error
           ActiveRecord::RecordInvalid.new(@callable)
         else
@@ -118,6 +128,10 @@ module GLCommand
 
     private
 
+    def current_errors
+      @callable&.errors
+    end
+
     def exception?(passed_error)
       passed_error.is_a?(Exception) ||
         (passed_error.respond_to?(:ancestors) && passed_error.ancestors.include?(Exception))

data/lib/gl_command/version.rb

@@ -1,3 +1,3 @@
 module GLCommand
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_command
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-19 00:00:00.000000000 Z
+date: 2024-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord