gl_command 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c64386ffafec990d01604c12482b0cf2deb8b4caff95c638d9d4e8835c4cb92
-  data.tar.gz: 9a58f0b30039b493382f01d22fb8cc2c8d6950af71f16ec3b4e708a776e78af9
+  metadata.gz: '09bb7724a153ffb2e0f53a71bac270a2410df26bb4b145e776e381f41dff3fff'
+  data.tar.gz: 0a882a14125ac56b3dc132954382b01fa0722349ac1fd74605296f760167e751
 SHA512:
-  metadata.gz: 126e275c0bd65be3fb7fe1ead77e283231a158359b1c95ab00d691e010287f41b397a97a9202de316ba921313b1df66c59e76b4f5e13d62d4130d762aba6f803
-  data.tar.gz: 728454632aa41f5b740b4f3eaf97c85ee8022857ac349ca86bfa0d655687fc6b402b7501629e580c3ed3c2b87b621a56a11333a95f3239d8ec0095901bb0e311
+  metadata.gz: 44e04e38a4537e47d8be1614e7d0b8e04c759f83f467a1aa9fde1d372b70ec000163277637b502254006f50f5f950c76a886012606c1c0396a74e9256b5742b2
+  data.tar.gz: f5b28a4e1933b2c89d33d7f435a552430bfe4c7bbe8464fba15e1fb6b9367a37e4e870a5f268d96a64a2fb736929b1a0805b8f5ee5102e5185d32816cf74377d

data/README.md

@@ -195,6 +195,24 @@ class SomeChain < GLCommand::Chainable
   end
 end
 ```
+And if you need to return early (and skip the `chain`), call `skip_chain` - or else you will get an error: `#chain method not called in GLCommand::Chainable #call.`
+
+```ruby
+class SomeChain < GLCommand::Chainable
+  requires :item
+
+  returns :new_item
+
+  chain CommmandOne, CommandTwo
+
+  def call
+    skip_chain unless item.valid? # Automatically skips the whole chain without any errors
+
+    chain(:item)
+  end
+end
+
+```
 
 
 ---

data/gl_command.gemspec

@@ -8,12 +8,13 @@ Gem::Specification.new do |spec|
   spec.authors = ['Give Lively']
   spec.summary = 'Give Lively Commands'
   spec.homepage = 'https://github.com/givelively/gl_command'
-  spec.license = 'Apache'
+  spec.license = 'Apache-2.0'
   spec.platform = Gem::Platform::RUBY
 
   spec.required_ruby_version = '>= 3.1'
   spec.extra_rdoc_files = ['README.md']
-  spec.files = %w[gl_command.gemspec README.md LICENSE] + `git ls-files | grep -E '^(lib)'`.split("\n")
+  spec.files = %w[gl_command.gemspec README.md
+                  LICENSE] + `git ls-files | grep -E '^(lib)'`.split("\n")
 
   spec.add_dependency 'activerecord', '>= 3.2.0'
   spec.add_dependency 'gl_exception_notifier', '>= 1.0.2'

data/lib/gl_command/chainable.rb

@@ -32,7 +32,7 @@ module GLCommand
       end
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Lint/UnderscorePrefixedVariableName
     def chain(args)
       return if @chain_skipped
 
@@ -43,20 +43,21 @@ module GLCommand
         cargs = context.chain_arguments_and_returns.slice(*command.arguments)
                        .merge(context.opts_hash).merge(in_chain: true)
 
-        result = command.call(**cargs)
-        context.assign_parameters(skip_unknown_parameters: true, **result.returns)
+        # using _result to make sure it doesn't cause naming conflicts with other uses of result
+        _result = command.call(**cargs)
+        context.assign_parameters(skip_unknown_parameters: true, **_result.returns)
 
-        if result.success?
+        if _result.success?
           context.called << command
         else
           @notified = true # chained command already notified
-          errors.merge!(result.errors)
-          stop_and_fail!(result.error, no_notify: result.no_notify?)
+          errors&.merge!(_result.errors)
+          stop_and_fail!(_result.error, no_notify: _result.no_notify?)
           break
         end
       end
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Lint/UnderscorePrefixedVariableName
 
     def commands
       self.class.commands

data/lib/gl_command/context.rb

@@ -25,10 +25,9 @@ module GLCommand
     attr_reader :klass, :error
     attr_writer :full_error_message
 
-    # 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
+    # If someone calls #errors, they expect to get the errors! Include the non-validation error, if it exists
     def errors
-      current_errors&.add(:base, "full_error_message: #{full_error_message}") if @failure && current_errors.blank?
+      current_errors&.add(:base, "Command Error: #{full_error_message}") if add_command_error?
       current_errors
     end
 
@@ -102,7 +101,9 @@ module GLCommand
         if exception?(passed_error)
           # This catches errors within GLCommand::Context and prevents self referential error display
           # $ERROR_INFO (aka $!), stores the last Ruby error
-          @full_error_message ||= $ERROR_INFO.to_s if $ERROR_INFO.to_s.include?('for <GLCommand::Context')
+          if $ERROR_INFO.to_s.include?('for <GLCommand::Context')
+            @full_error_message ||= $ERROR_INFO.to_s
+          end
           # If something raised ActiveRecord::RecordInvalid, assign its errors to #errors
           merge_errors(passed_error.record.errors) if
             passed_error.is_a?(ActiveRecord::RecordInvalid) && defined?(passed_error.record.errors)
@@ -132,6 +133,16 @@ module GLCommand
       @callable&.errors
     end
 
+    def add_command_error?
+      return false if @error.blank?
+
+      return true if current_errors.blank?
+
+      # Add command error unless the existing error is a validation error or there's already a command error
+      @error&.class != ActiveRecord::RecordInvalid &&
+        current_errors.full_messages.none? { |err| err.start_with?('Command Error: ') }
+    end
+
     def exception?(passed_error)
       passed_error.is_a?(Exception) ||
         (passed_error.respond_to?(:ancestors) && passed_error.ancestors.include?(Exception))
@@ -145,7 +156,9 @@ module GLCommand
     def merge_errors(new_errors)
       # When merging the errors, don't add duplicate errors
       new_errors.each do |new_error|
-        errors.import(new_error) unless errors&.full_messages&.include?(new_error.full_message)
+        unless current_errors&.full_messages&.include?(new_error.full_message)
+          current_errors.import(new_error)
+        end
       end
     end
 

data/lib/gl_command/context_inspect.rb

@@ -1,44 +1,42 @@
 module GLCommand
   class ContextInspect
-    def self.error(error_obj)
-      return '' if error_obj.blank?
+    class << self
+      def error(error_obj)
+        return '' if error_obj.blank?
 
-      error_obj.is_a?(Array) ? error_obj.uniq.join(', ') : error_obj.to_s
-    end
+        error_obj.is_a?(Array) ? error_obj.uniq.join(', ') : error_obj.to_s
+      end
 
-    def self.hash_params(hash)
-      hash.map do |key, value|
-        value_s =
-          if value.nil?
-            'nil'
-          elsif value.respond_to?(:to_sql)
-            object_param_as_sql(value)
-          elsif value.respond_to?(:uuid)
-            object_param_with_id(value, :uuid)
-          elsif value.respond_to?(:id)
-            object_param_with_id(value, :id)
-          else
-            value
-          end
-        "#{key}: #{value_s}"
-      end.join(', ')
-    end
+      def hash_params(hash)
+        hash.map do |key, value|
+          value_s =
+            if value.nil?
+              'nil'
+            elsif value.respond_to?(:to_sql)
+              object_param_as_sql(value)
+            elsif value.respond_to?(:uuid)
+              object_param_with_id(value, :uuid)
+            elsif value.respond_to?(:id)
+              object_param_with_id(value, :id)
+            else
+              value
+            end
+          "#{key}: #{value_s}"
+        end.join(', ')
+      end
 
-    # Active record objects can be really big - rather than rendering the whole object, just show the ID
-    private_class_method def self.object_param_with_id(obj, key)
-      obj_id = obj.send(key)
-      id_value = obj_id.is_a?(Integer) ? obj_id : "\"#{obj_id}\""
-      "#<#{obj.class.name} #{key}=#{id_value}>"
-    end
+      private
+
+      # Active record objects can be really big - rather than rendering the whole object, just show the ID
+      def object_param_with_id(obj, key)
+        obj_id = obj.send(key)
+        id_value = obj_id.is_a?(Integer) ? obj_id : "\"#{obj_id}\""
+        "#<#{obj.class.name} #{key}=#{id_value}>"
+      end
 
-    private_class_method def self.object_param_as_sql(obj)
-      count =
-        if obj.respond_to?(:count)
-          obj.count
-        else
-          'N/A'
-        end
-      "#<#{obj.class.name} count=#{count}, sql=\"#{obj.to_sql}\">"
+      def object_param_as_sql(obj)
+        "#<#{obj.class.name} sql=\"#{obj.to_sql}\">"
+      end
     end
   end
 end

data/lib/gl_command/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_command
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -58,7 +58,7 @@ files:
 - lib/gl_command/version.rb
 homepage: https://github.com/givelively/gl_command
 licenses:
-- Apache
+- Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
 post_install_message: