gl_command 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: affffd85a3150ca92bd45b28822125b8a64117bb41d2f8bffa9fd2861712c9d5
-  data.tar.gz: 45e62be391f6958720e3e8aec0a7f04fbaf0d9fe4a5b9b382fc2ae4b91246689
+  metadata.gz: 5c1d353b0428b6aa32adf96b5962256b415dfacc45116d3e4a21ea8ca345de8e
+  data.tar.gz: f8056f5711ef8ffdfafd3678fd25c05fa1879f2893f1d9acecaa9a3880565d7a
 SHA512:
-  metadata.gz: 9c2ac5fcedfc9156231e3d146a221945deca5e3f687b2413fe7db9fecd02e9ba3c8f0b94223d0e414fae1946b1ce52eb574118cfaa873a2524cea1f9b8a7812a
-  data.tar.gz: 31aee586028c0cf073f22f267ee3ad095f48041aace47df51fe9b4c48ed6a6487f2a1d138ad26e786f75e314adc087e87b573032663d9bf363adfceb6a8ac790
+  metadata.gz: 8229ae95a48c6b5fc83fbeb647d604666be82cc2e35b08d294c6c8c4c7e44ec4c52d40f520ead9005d38edeee0aab9fc03f0db9e637271b2fd1dbd98619efd21
+  data.tar.gz: 678f19f03349988f5a033eeb1f5cff6acb846e0c2b5eea744b7493e0419232d7e0e56f2b4684c9857f0d5e78d7119b9147bef86cf0b5ac642056f9b67365cd8d

data/README.md

@@ -18,6 +18,7 @@ Calling a command returns a `GLCommand::Context` which has these properties:
   - [Displaying errors (use `full_error_message`)](#displaying-errors-use-full_error_message)
   - [stop_and_fail!](#stop_and_fail)
   - [Validations](#validations)
+  - [Best practices for error handling](#best-practices-for-error-handling)
 - [GLExceptionNotifier](#glexceptionnotifier)
 - [Chainable](#chainable)
 - [Testing `GLCommand`s](#testing-glcommands)
@@ -146,12 +147,41 @@ stop_and_fail!('An error message', no_notify: true) # GLExceptionNotifier is *no
 
 ### Validations
 
-You can add validations to `GLCommand::Callable` and `GLCommand::Chainable`.
+You can add validations to `GLCommand::Callable` and `GLCommand::Chainable`. They include `ActiveModel::Validations`, so you can use [Rails active record validations](https://guides.rubyonrails.org/active_record_validations.html).
 
-If the validations fail, the command returns `success: false` without executing.
+If the validations fail, the command returns `success: false` without executing and if validations fail, `GLExceptionNotifier` is **not** called.
 
-If validations fail, `GLExceptionNotifier` is not called
+```ruby
+class ExampleCommand < GLCommand::Callable
+  validates :name, presence: true
+  validate :name_must_start_with_cool
+
+  def name_must_start_with_cool
+    return true unless name.start_with?('cool')
+
+    errors.add(:name, "Doesn't start with 'cool'")
+  end
+end
+```
+
+### Best practices for error handling
+
+#### Only add validation errors in validations
+
+i.e. don't use `errors.add` in the `call` method. Use `stop_and_fail!` instead.
+
+#### Prefer raising the original error
+
+For example, if you want to raise a custom error message, don't rescue and then `stop_and_fail!('Some special error message')`. Do this instead:
+
+```ruby
+rescue StandardError => e
+  context.full_error_message = "Some special error message"
+  raise e
+end
+```
 
+This will preserve the original error and stack trace, which makes it easier to debug and track down issues.
 
 ## GLExceptionNotifier
 

data/gl_command.gemspec

@@ -19,7 +19,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activerecord', '>= 3.2.0'
   spec.add_dependency 'gl_exception_notifier', '>= 1.0.2'
 
-  spec.add_development_dependency 'rspec', '~> 3.0'
-
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/gl_command/callable.rb

@@ -214,12 +214,15 @@ module GLCommand
       raise ArgumentError, "unknown #{error_keys_str(unknown)}" if unknown.any?
 
       # strong_attributes type checking
+      # type can be a class (e.g. String), a symbol naming a predicate method
+      # the value must answer truthily (e.g. :acts_as_syncable?), or an array of
+      # either (e.g. [User, AdminUser]), in which case the value may match any
       self.class.requires.merge(self.class.allows).each do |arg, type|
-        next if type.nil? || args[arg].is_a?(type)
+        next if type.nil? || Array(type).any? { |t| value_matches_type?(args[arg], t) }
         # Validation skipped if allows and nil (but not if blank)
         next if args[arg].nil? && self.class.allows.include?(arg)
 
-        raise GLCommand::ArgumentTypeError, ":#{arg} is not a #{type}"
+        raise GLCommand::ArgumentTypeError, ":#{arg} is not #{type_error_str(type)}"
       end
     end
     # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -227,5 +230,21 @@ module GLCommand
     def error_keys_str(keys)
       "keyword#{keys.count > 1 ? 's' : ''}: #{keys.map { |k| ":#{k}" }.join(', ')}"
     end
+
+    # A type can be a class (checked with is_a?) or a symbol naming a predicate
+    # method the value must respond to and return truthy from
+    def value_matches_type?(value, type)
+      if type.is_a?(Symbol)
+        value.respond_to?(type) && value.public_send(type)
+      else
+        value.is_a?(type)
+      end
+    end
+
+    def type_error_str(type)
+      return "one of #{type.join(', ')}" if type.is_a?(Array)
+
+      type.is_a?(Symbol) ? type.to_s : "a #{type}"
+    end
   end
 end

data/lib/gl_command/context.rb

@@ -27,7 +27,7 @@ module GLCommand
 
     # If someone calls #errors, they expect to get the errors! Include the non-validation error, if it exists
     def errors
-      current_errors&.add(:base, "Command Error: #{full_error_message}") if add_command_error?
+      current_errors&.add(:base, full_error_message) if add_command_error?
       current_errors
     end
 
@@ -126,7 +126,10 @@ module GLCommand
     private
 
     def current_errors
-      @callable&.errors
+      return @callable.errors if defined?(@callable)
+
+      # @standalone_errors only is instantiated when you use build_context
+      (@standalone_errors ||= ActiveModel::Errors.new(self))
     end
 
     def add_command_error?
@@ -136,7 +139,7 @@ module GLCommand
 
       # 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: ') }
+        current_errors.full_messages.none? { |err| err == @error.message }
     end
 
     def exception?(passed_error)

data/lib/gl_command/rspec/matchers.rb

@@ -46,15 +46,15 @@ module GLCommand
     class RequireArgumentMatcher < CommandArgumentMatcher
       private
 
-      def scope; :requires; end
-      def action; 'require'; end
+      def scope = :requires
+      def action = 'require'
     end
 
     class AllowArgumentMatcher < CommandArgumentMatcher
       private
 
-      def scope; :allows; end
-      def action; 'allow'; end
+      def scope = :allows
+      def action = 'allow'
     end
 
     # Specific matcher for `returns`, which only stores an Array of keys.
@@ -69,6 +69,7 @@ module GLCommand
         self
       end
 
+      # rubocop:disable Layout/LineLength
       def matches?(command_class)
         @command_class = command_class.is_a?(Class) ? command_class : command_class.class
 
@@ -79,6 +80,7 @@ module GLCommand
 
         @command_class.returns.include?(@attribute)
       end
+      # rubocop:enable Layout/LineLength
 
       def description
         "return attribute `#{@attribute}`"

data/lib/gl_command/validatable.rb

@@ -13,7 +13,7 @@ module GLCommand
     include ActiveModel::Validations
 
     class_methods do
-      def i18n_scope
+      define_method(:i18n_scope) do
         :activerecord
       end
     end

data/lib/gl_command/version.rb

@@ -1,3 +1,3 @@
 module GLCommand
-  VERSION = '1.4.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_command
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-11 00:00:00.000000000 Z
+date: 2026-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.2
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description:
 email:
 executables: []
@@ -92,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Give Lively Commands