gl_command 1.1.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b963d760cbf796923d8ade7638d344076b2c7d08f9a9bfcd42a2153fea79201
-  data.tar.gz: b468cf7458eab4c4e9c145a82d59010d145a7d06bd5bb8b81b3fb9e6e0766f35
+  metadata.gz: d64529ae90558047a1a67fb4641fcbc6807f4bac0ef8b503945d2981dac33f80
+  data.tar.gz: 541c75d629f1ba4971ab7d6fd37ac4a1fdfee2f19cb6256477d4857408fb64ce
 SHA512:
-  metadata.gz: 9ced69bc84bbe0d55bfb5ea324334165fdd3acdc4a06b45252ff9397cb3f70193d8cbcff7a75dbc3b1a852fcc00f223d84add9294047ddf731ea5e121fb70db4
-  data.tar.gz: 30ab133f7d7d10ccd0b3d7e5f29b6121c064c8518f6e528253f96b5713bf04308051600acd51948004583541083a267e1bf0718c0da7266c800241c3f7d71ad8
+  metadata.gz: 7767272a19c79ed50bc21bcd5a94a04f8f16c26e509bdfc3b86937e8204dabf2d053ea2fc85919acc56de3a770fd35ff88490b2d101fdcf6e6a89a714c55176f
+  data.tar.gz: f4fd2347bedf5ccbd94c09e230bf760d16d0ec1f19a4ecada73416d7a4b0da52a7f79759f074c4a38f98cd783ce45a07dd84c46dd1f13b87685cfdec8d0e9c9e

data/README.md

@@ -215,6 +215,24 @@ end
 ```
 
 
+## Publishing the gem to Rubygems
+
+1. As per our code agreements, all code changes to this gem are required to be made via pull request with final approval from at least one Give Lively engineer.
+
+2. When creating a pull request, ensure that your code changes include an update to the gem's [version number](https://github.com/givelively/gl_command/blob/main/lib/gl_command/version.rb) using [semantic versioning](https://semver.org/)
+
+3. After getting approval, merge your changes to `main`.
+
+4. Once your CI build finishes successfully, pull the latest version of `main` locally.
+
+5. Run the command `gem build`. This bundles the relevant files from the gem and prepares it to be published to [rubygems.org](https://rubygems.org/).
+
+6. This will create a new file locally that looks like `gl_command-<new_gem_version_number>.gem`.
+
+7. Run `gem push gl_command-<new_gem_version_number>.gem` to publish the new version
+
+**NOTE: only the gem owners listed on rubygems can publish new versions**
+
 ---
 
 This library is influenced by [interactors](https://github.com/collectiveidea/interactor) and inspired by the [Command Pattern](https://en.wikipedia.org/wiki/Command_pattern).

data/lib/gl_command/callable.rb

@@ -6,6 +6,7 @@ require 'gl_command/validatable'
 
 module GLCommand
   class Callable
+    include GLCommand::Validatable
     ALWAYS_RAISE_ERRORS = ENV['GL_COMMAND_ALWAYS_RAISE'] == 'true'
     DEFAULT_OPTS = { raise_errors: false, skip_unknown_parameters: true, in_chain: false }.freeze
     RESERVED_WORDS = (DEFAULT_OPTS.keys + GLCommand::ChainableContext.reserved_words).sort.freeze
@@ -102,8 +103,6 @@ module GLCommand
       end
     end
 
-    include GLCommand::Validatable
-
     attr_reader :context
 
     def initialize(context = nil)
@@ -203,6 +202,7 @@ module GLCommand
 
       chain_rollback if self.class.chain? # defined in GLCommand::Chainable
       rollback
+      instrument_command(:after_rollback)
     end
 
     # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

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(in_chain: true)
+                       .merge(context.opts_hash).merge(in_chain: context)
 
         # using _result to make sure it doesn't cause naming conflicts with other uses of result
         _result = command.call(**cargs)

data/lib/gl_command/context.rb

@@ -22,7 +22,7 @@ module GLCommand
       { raise_errors: raise_errors? }
     end
 
-    attr_reader :klass, :error
+    attr_reader :klass, :error, :in_chain
     attr_writer :full_error_message
 
     # If someone calls #errors, they expect to get the errors! Include the non-validation error, if it exists
@@ -35,10 +35,6 @@ module GLCommand
       false
     end
 
-    def in_chain?
-      @in_chain
-    end
-
     def returns
       @klass.returns.index_with { |rattr| send(rattr) }
     end

data/lib/gl_command/context_inspect.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module GLCommand
   class ContextInspect
+    PERMITTED_OUTPUTS = %i[string hash].freeze
+
     class << self
       def error(error_obj)
         return '' if error_obj.blank?
@@ -7,35 +11,50 @@ module GLCommand
         error_obj.is_a?(Array) ? error_obj.uniq.join(', ') : error_obj.to_s
       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(', ')
+      def hash_params(hash, output: :string)
+        unless PERMITTED_OUTPUTS.include?(output)
+          raise "Unknown output type: #{output}, must be one of #{PERMITTED_OUTPUTS}"
+        end
+
+        result = hash.map { |key, value| output_for(key:, value:, output:) }
+        output == :string ? result.join(', ') : result.to_h
       end
 
       private
 
+      def output_for(key:, value:, output:)
+        value_s = if value.nil?
+                    'nil'
+                  elsif value.respond_to?(:to_sql)
+                    object_param_as_sql(value, output:)
+                  elsif value.respond_to?(:id)
+                    object_param_with_id(value, :id, output:)
+                  elsif value.respond_to?(:uuid)
+                    object_param_with_id(value, :uuid, output:)
+                  else
+                    value
+                  end
+
+        output == :string ? "#{key}: #{value_s}" : [key, value_s]
+      end
+
       # Active record objects can be really big - rather than rendering the whole object, just show the ID
-      def object_param_with_id(obj, key)
+      def object_param_with_id(obj, key, output:)
         obj_id = obj.send(key)
-        id_value = obj_id.is_a?(Integer) ? obj_id : "\"#{obj_id}\""
-        "#<#{obj.class.name} #{key}=#{id_value}>"
+        if output == :string
+          id_value = obj_id.is_a?(Integer) ? obj_id : "\"#{obj_id}\""
+          "#<#{obj.class.name} #{key}=#{id_value}>"
+        else
+          obj_id
+        end
       end
 
-      def object_param_as_sql(obj)
-        "#<#{obj.class.name} sql=\"#{obj.to_sql}\">"
+      def object_param_as_sql(obj, output:)
+        if output == :string
+          "#<#{obj.class.name} sql=\"#{obj.to_sql}\">"
+        else
+          obj.to_sql
+        end
       end
     end
   end

data/lib/gl_command/version.rb

@@ -1,3 +1,3 @@
 module GLCommand
-  VERSION = '1.1.4'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_command
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-18 00:00:00.000000000 Z
+date: 2025-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord