foobara 0.0.106 → 0.0.107

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 980071302c992808e812a703ff9a203fca501336c00225dd8eeb045982975704
-  data.tar.gz: '04901d96e1717a09d736feccd2c21d31873ae32235362b0613476f508423373f'
+  metadata.gz: a8a5a11223a3bc2f8aebf691c6bc8f0d0bdb05930286f9c1e16f2f1ac8f82756
+  data.tar.gz: 07f8edc98723f2297413d12065483d0a80f1b641ca0088fab99434c59cba4d4c
 SHA512:
-  metadata.gz: cee4fbf405088f382583642aed0c40c55010249e346f6881608463ec37d8bd8fe378fe030adedc3c2c1534a89980ee475affa872e260e7e95dbad611411d84f8
-  data.tar.gz: 741ed3a774a1d92dacef4a640706b41764f10144d39b130eeaf032648a60d95b3d450830facd8334b346a1a2e07179b750899063e69ac3bb1e6862884a0bff64
+  metadata.gz: 4a75a392d55df8390b3d483b8a1d670d0b466783921fe2808961c18d4587644e82f515734cf49fac1ae9d42c8ed19a084d3562131e70ec9259ea5cdfaee945f1
+  data.tar.gz: 939caca7112b46752613e9427471c1c0dc0d422fd24d571d379973bae3a169f71816cbbffb0df2ff939a213c7bc16ae104c6416d3c0f3003ce96be5a748aca52

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# [0.0.107] - 2025-04-22
+
+- Make sure various Foobara::Error subclasses have consistent interfaces
+
 # [0.0.106] - 2025-04-20
 
 - Fix authenticator explanation that was coupled to pry

data/projects/command/src/command_pattern_implementation/concerns/entities.rb

@@ -72,7 +72,7 @@ module Foobara
 
             thunks_to_load
           rescue Entity::NotFoundError => e
-            add_runtime_error(error_class.new(e.criteria))
+            add_runtime_error(error_class.for(e.criteria))
           end
         end
 

data/projects/command/src/transformed_command.rb

@@ -581,7 +581,7 @@ module Foobara
               explanation = source || "No explanation."
             end
 
-            error = CommandConnector::NotAllowedError.new(rule_symbol: rule.symbol, explanation:)
+            error = CommandConnector::NotAllowedError.for(rule_symbol: rule.symbol, explanation:)
             self.outcome = Outcome.error(error)
 
             command.state_machine.error!
@@ -605,7 +605,7 @@ module Foobara
     rescue => e
       if capture_unknown_error
         # TODO: move to superclass?
-        self.outcome = Outcome.error(CommandConnector::UnknownError.new(e))
+        self.outcome = Outcome.error(CommandConnector::UnknownError.for(e))
       else
         # :nocov:
         raise

data/projects/command_connectors/src/command_connector/command_connector_error.rb

@@ -0,0 +1,11 @@
+module Foobara
+  class CommandConnector
+    class CommandConnectorError < Foobara::RuntimeError
+      context({})
+
+      def initialize(message:, context: {})
+        super
+      end
+    end
+  end
+end

data/projects/command_connectors/src/command_connector/invalid_context_error.rb

@@ -0,0 +1,5 @@
+module Foobara
+  class CommandConnector
+    class InvalidContextError < CommandConnectorError; end
+  end
+end

data/projects/command_connectors/src/command_connector/no_command_found_error.rb

@@ -0,0 +1,5 @@
+module Foobara
+  class CommandConnector
+    class NoCommandFoundError < NotFoundError; end
+  end
+end

data/projects/command_connectors/src/command_connector/no_command_or_type_found_error.rb

@@ -0,0 +1,7 @@
+require_relative "not_found_error"
+
+module Foobara
+  class CommandConnector
+    class NoCommandOrTypeFoundError < NotFoundError; end
+  end
+end

data/projects/command_connectors/src/command_connector/no_type_found_error.rb

@@ -0,0 +1,5 @@
+module Foobara
+  class CommandConnector
+    class NoTypeFoundError < NotFoundError; end
+  end
+end

data/projects/command_connectors/src/command_connector/not_allowed_error.rb

@@ -0,0 +1,24 @@
+module Foobara
+  class CommandConnector
+    class NotAllowedError < CommandConnectorError
+      class << self
+        def for(rule_symbol: nil, explanation: nil)
+          rule_symbol ||= :no_symbol_declared
+          message = "Not allowed"
+          if explanation
+            message += ": #{explanation}"
+          end
+          explanation ||= "No explanation"
+          context = { rule_symbol:, explanation: }
+
+          new(message:, context:)
+        end
+      end
+
+      context do
+        rule_symbol :symbol, :required
+        explanation :string, :required
+      end
+    end
+  end
+end

data/projects/command_connectors/src/command_connector/not_found_error.rb

@@ -0,0 +1,13 @@
+require_relative "command_connector_error"
+
+module Foobara
+  class CommandConnector
+    class NotFoundError < CommandConnectorError
+      context not_found: :string
+
+      def initialize(message: "Not found: #{context[:not_found]}", **)
+        super
+      end
+    end
+  end
+end

data/projects/command_connectors/src/command_connector/unauthenticated_error.rb

@@ -0,0 +1,9 @@
+module Foobara
+  class CommandConnector
+    class UnauthenticatedError < CommandConnectorError
+      def initialize(message: "Unauthenticated", **)
+        super
+      end
+    end
+  end
+end

data/projects/command_connectors/src/command_connector/unknown_error.rb

@@ -0,0 +1,15 @@
+module Foobara
+  class CommandConnector
+    class UnknownError < CommandConnectorError
+      class << self
+        def for(error)
+          new(message: error.message).tap do |unknown_error|
+            unknown_error.error = error
+          end
+        end
+      end
+
+      attr_accessor :error
+    end
+  end
+end

data/projects/command_connectors/src/command_connector.rb

@@ -2,84 +2,6 @@ module Foobara
   class CommandConnector
     class UnexpectedSensitiveTypeInManifestError < StandardError; end
 
-    class CommandConnectorError < Foobara::RuntimeError
-      class << self
-        def context_type_declaration
-          {}
-        end
-      end
-
-      def initialize(message, context: {})
-        super(message:, context:)
-      end
-    end
-
-    class UnknownError < CommandConnectorError
-      attr_accessor :error
-
-      def initialize(error)
-        # TODO: can we just use #cause for this?
-        self.error = error
-
-        super(error.message)
-      end
-    end
-
-    class NotFoundError < CommandConnectorError
-      class << self
-        def context_type_declaration
-          { not_found: :string }
-        end
-      end
-
-      attr_accessor :not_found
-
-      def initialize(not_found)
-        self.not_found = not_found
-
-        super(message, context: { not_found: })
-      end
-
-      def message
-        "Not found: #{not_found}"
-      end
-    end
-
-    class UnauthenticatedError < CommandConnectorError
-      def initialize
-        super("Unauthenticated")
-      end
-    end
-
-    class NotAllowedError < CommandConnectorError
-      class << self
-        def context_type_declaration
-          {
-            rule_symbol: :symbol,
-            explanation: :string
-          }
-        end
-      end
-
-      attr_accessor :rule_symbol, :explanation
-
-      def initialize(rule_symbol:, explanation:)
-        self.rule_symbol = rule_symbol || :no_symbol_declared
-        self.explanation = explanation || "No explanation"
-
-        super("Not allowed: #{explanation}", context:)
-      end
-
-      def context
-        { rule_symbol:, explanation: }
-      end
-    end
-
-    class InvalidContextError < CommandConnectorError; end
-    class NoCommandFoundError < NotFoundError; end
-    class NoTypeFoundError < NotFoundError; end
-    class NoCommandOrTypeFoundError < NotFoundError; end
-
     class << self
       def find_builtin_command_class(command_class_name)
         Util.find_constant_through_class_hierarchy(self, "Commands::#{command_class_name}")
@@ -231,7 +153,7 @@ module Foobara
 
         unless transformed_command_class
           # :nocov:
-          raise NoCommandFoundError, "Could not find command registered for #{full_command_name}"
+          raise NoCommandFoundError.new(message: "Could not find command registered for #{full_command_name}")
           # :nocov:
         end
 
@@ -243,7 +165,9 @@ module Foobara
 
         unless manifestable
           # :nocov:
-          raise NoCommandOrTypeFoundError, "Could not find command or type registered for #{full_command_name}"
+          raise NoCommandOrTypeFoundError.new(
+            message: "Could not find command or type registered for #{full_command_name}"
+          )
           # :nocov:
         end
 
@@ -259,7 +183,7 @@ module Foobara
 
         unless transformed_command_class
           # :nocov:
-          raise NoCommandFoundError, "Could not find command registered for #{full_command_name}"
+          raise NoCommandFoundError.new(message: "Could not find command registered for #{full_command_name}")
           # :nocov:
         end
 
@@ -274,7 +198,7 @@ module Foobara
 
         unless type
           # :nocov:
-          raise NoTypeFoundError, "Could not find type registered for #{full_command_name}"
+          raise NoTypeFoundError.new(message: "Could not find type registered for #{full_command_name}")
           # :nocov:
         end
 
@@ -323,7 +247,7 @@ module Foobara
                                     transform_command_class(command_class)
       else
         # :nocov:
-        raise InvalidContextError, "Not sure what to do with #{action}"
+        raise InvalidContextError.new(message: "Not sure what to do with #{action}")
         # :nocov:
       end
 
@@ -466,7 +390,7 @@ module Foobara
       request.command.run
     rescue => e
       if capture_unknown_error
-        request.error = CommandConnector::UnknownError.new(e)
+        request.error = CommandConnector::UnknownError.for(e)
       else
         raise
       end

data/projects/entity/src/concerns/queries.rb

@@ -55,7 +55,7 @@ module Foobara
                             record
                           end
 
-            raise NotFoundError.new(primary_key, entity_class: self)
+            raise NotFoundError.for(primary_key, entity_class: self)
           end
 
           def load_aggregate(record_or_record_id)

data/projects/entity/src/not_found_error.rb

@@ -31,41 +31,40 @@ module Foobara
           end
         end
 
-        def data_path
-          nil
+        def for(criteria, entity_class: self.entity_class, data_path: self.data_path || "")
+          message = "Could not find #{entity_class} for #{criteria}"
+          context = {
+            entity_class: entity_class.full_entity_name,
+            criteria:,
+            data_path: data_path.to_s
+          }
+
+          new(context:, message:)
         end
 
-        def context_type_declaration
-          {
-            entity_class: :string, # TODO: we don't have a way to specify an exact value for a type
-            criteria: :duck, # TODO: probably should be integer or string but no union types yet
-            data_path: :string # TODO: we don't have a way to specify an exact value for a type
-          }
+        def data_path
+          nil
         end
       end
 
-      attr_accessor :data_path, :entity_class, :criteria
+      context do
+        entity_class :string # TODO: we don't have a way to specify an exact value for a type
+        criteria :duck # TODO: probably should be integer or string but no union types yet
+        data_path :string # TODO: we don't have a way to specify an exact value for a type
+      end
 
       foobara_delegate :primary_key_attribute, :full_entity_name, to: :entity_class
 
-      def initialize(criteria, entity_class: self.class.entity_class, data_path: self.class.data_path)
-        self.criteria = criteria
-        self.entity_class = entity_class
-        self.data_path = data_path || ""
-
-        super(context:, message:)
+      def criteria
+        context[:criteria]
       end
 
-      def context
-        {
-          entity_class: full_entity_name,
-          criteria:,
-          data_path: data_path.to_s
-        }
+      def data_path
+        context[:data_path]
       end
 
-      def message
-        "Could not find #{entity_class} for #{criteria}"
+      def entity_class
+        context[:entity_class]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.0.106
+  version: 0.0.107
 platform: ruby
 authors:
 - Miles Georgi
@@ -183,12 +183,21 @@ files:
 - projects/command_connectors/lib/foobara/command_connectors.rb
 - projects/command_connectors/src/authenticator.rb
 - projects/command_connectors/src/command_connector.rb
+- projects/command_connectors/src/command_connector/command_connector_error.rb
 - projects/command_connectors/src/command_connector/commands/describe.rb
 - projects/command_connectors/src/command_connector/commands/list_commands.rb
 - projects/command_connectors/src/command_connector/commands/ping.rb
 - projects/command_connectors/src/command_connector/commands/query_git_commit_info.rb
+- projects/command_connectors/src/command_connector/invalid_context_error.rb
+- projects/command_connectors/src/command_connector/no_command_found_error.rb
+- projects/command_connectors/src/command_connector/no_command_or_type_found_error.rb
+- projects/command_connectors/src/command_connector/no_type_found_error.rb
+- projects/command_connectors/src/command_connector/not_allowed_error.rb
+- projects/command_connectors/src/command_connector/not_found_error.rb
 - projects/command_connectors/src/command_connector/request.rb
 - projects/command_connectors/src/command_connector/response.rb
+- projects/command_connectors/src/command_connector/unauthenticated_error.rb
+- projects/command_connectors/src/command_connector/unknown_error.rb
 - projects/command_connectors/src/command_registry.rb
 - projects/command_connectors/src/command_registry/allowed_rule.rb
 - projects/command_connectors/src/command_registry/exposed_command.rb