foobara 0.5.10 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23083c50349b64586fcc01d57460032c08ab51eaf90af20591a49dfa16c477f2
-  data.tar.gz: '04495cb4fbf6f6c93bc24da26a7f889792a4b17498a04416b539b107b0aa2158'
+  metadata.gz: 7e94765634a72f087a3a71aeebdde58025a8a7d605658c9f16389a423a6792cb
+  data.tar.gz: 208864692b0d7fff0f40a2b5cfdf10aa45ea0af67ca1f60876fb9f4455ab66cb
 SHA512:
-  metadata.gz: 23af9c5f5cd3ac5bdfe282151b13d412377c8ff9b9fa87f2a9093e3bbe6d748d6e40845cdd7ef5062710e8db892c28dcccb6e8c358f087a68e785ef9953d6a7b
-  data.tar.gz: 3669d063aa1f94ff023464841e9b5cab65fafb82290aeaae170564d13aa3659f6b012fc5ec71471f781e6b236f78e33aa5643d465aa0687f9bfcabfe4df2dfaf
+  metadata.gz: 9496fc386e0b3c0bc170dfb57a60728f28c936e79b2da5dcd91ff89c719f6986d787e4da7b1fb085d85b16402812d2788ff7e519435ae0bce1e351361ee05159
+  data.tar.gz: e5f1911f7cca2da95ebd8d48c2367e67bee640cbee9c27e5666d34afdbe50d1284701238e5a47d1e600fae0188cb894dcd647a6cf45f2d6dd84af24f3c5efbe7

data/.ruby-version

@@ -1 +1 @@
-3.4.7
+4.0.6

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# [0.6.0] - 2026-08-06
+
+- Give a way to authenticate if possible without requiring it (:authentication_optional)
+- Convert NotFoundError into a data error
+- Progress on getting closer to decoupling persistence
+- Raise an error if non-attributes-like type is used for inputs
+- Improve error message when using an entity that has no primary key as a type
+- Support concept of a type declaration being claimed but errored
+- Combine some entities cache-busting code
+- Move model project out of entities project and into typesystem
+- Raise with NotImplementedError where applicable instead of StandardError
+- Simplify raise_if_production! interface
+
 # [0.5.10] - 2026-04-17
 
 - Add a ignore_unexpected_attributes transformer to builtin attributes type

data/lib/foobara/all.rb

@@ -16,14 +16,16 @@ module Foobara
   require "foobara/builtin_types"
   require "foobara/domain"
   require "foobara/command"
+  require "foobara/domain_mapper"
+  require "foobara/manifest"
+
   # TODO: make it so these are fully decoupled, optional, and not required here
   require "foobara/model_attribute_helpers"
   require "foobara/model_plumbing"
+
   require "foobara/entities_plumbing"
   # Shouldn't this be optional? Maybe use autoload feature somehow?
   require "foobara/in_memory_crud_driver"
-  require "foobara/domain_mapper"
-  require "foobara/manifest"
 
   install!
 end

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

@@ -9,11 +9,11 @@ module Foobara
             if args.empty?
               @description
             elsif args.size == 1
-              @description = args.first
+              @description = args[0]
             else
-              # :nocov:
+              # simplecov:disable
               raise ArgumentError, "wrong number of arguments (#{args.size} for 0 or 1)"
-              # :nocov:
+              # simplecov:enable
             end
           end
 

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

@@ -63,9 +63,9 @@ module Foobara
 
         def run_mapped_subcommand!(subcommand_class, unmapped_inputs = {}, to = nil)
           unless subcommand_class
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "subcommand_class is required"
-            # :nocov:
+            # simplecov:enable
           end
 
           mapped_something = false

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

@@ -10,9 +10,9 @@ module Foobara
             key = key.to_s_type
 
             unless error_context_type_map.key?(key)
-              # :nocov:
+              # simplecov:disable
               raise "No error class was registered for #{key}"
-              # :nocov:
+              # simplecov:enable
             end
 
             error_context_type_map[key].error_class
@@ -23,9 +23,9 @@ module Foobara
             key = key.to_s_type
 
             unless error_context_type_map.key?(key)
-              # :nocov:
+              # simplecov:disable
               raise "No error class was registered for #{key}"
-              # :nocov:
+              # simplecov:enable
             end
 
             error_context_type_map[key].error_class
@@ -37,9 +37,9 @@ module Foobara
             end
 
             unless error_context_type_map.key?(key)
-              # :nocov:
+              # simplecov:disable
               raise "No error class was registered for #{key}"
-              # :nocov:
+              # simplecov:enable
             end
 
             error_context_type_map[key].error_class
@@ -66,32 +66,32 @@ module Foobara
 
         def add_input_error(*args, **opts)
           error = if args.size == 1 && opts.empty?
-                    error = args.first
+                    error = args[0]
 
                     unless error.is_a?(Value::DataError)
-                      # :nocov:
+                      # simplecov:disable
                       raise ArgumentError, "expected an DataError or keyword arguments to construct one"
-                      # :nocov:
+                      # simplecov:enable
                     end
 
                     error
-                  elsif args.empty? || (args.size == 1 && args.first.is_a?(Hash))
-                    error_args = opts.merge(args.first || {})
+                  elsif args.empty? || (args.size == 1 && args[0].is_a?(Hash))
+                    error_args = opts.merge(args[0] || {})
                     symbol = error_args[:symbol]
                     path = error_args[:input] || error_args[:path]
 
                     error_args = error_args.except(:input)
 
                     unless symbol
-                      # :nocov:
+                      # simplecov:disable
                       raise ArgumentError, "missing error symbol"
-                      # :nocov:
+                      # simplecov:enable
                     end
 
                     unless path
-                      # :nocov:
+                      # simplecov:disable
                       raise ArgumentError, "missing input"
-                      # :nocov:
+                      # simplecov:enable
                     end
 
                     error_class = self.class.lookup_input_error_class(symbol, path)
@@ -109,10 +109,10 @@ module Foobara
 
                     error_class.new(path: input, symbol:, context:, message:)
                   else
-                    # :nocov:
+                    # simplecov:disable
                     raise ArgumentError,
                           "Invalid arguments given. Expected an error or args for an error"
-                    # :nocov:
+                    # simplecov:enable
                   end
 
           add_error(error)
@@ -126,30 +126,30 @@ module Foobara
 
         def add_runtime_error(*args, halt: true, **opts)
           error = if args.size == 1 && opts.empty? && (
-            args.first.is_a?(::Class) || args.first.is_a?(Foobara::RuntimeError)
+            args[0].is_a?(::Class) || args[0].is_a?(Foobara::RuntimeError)
           )
-                    error = args.first
+                    error = args[0]
 
                     if error.is_a?(::Class) && error < Foobara::RuntimeError
                       error = error.new
                     end
 
                     unless error.is_a?(Foobara::RuntimeError)
-                      # :nocov:
+                      # simplecov:disable
                       raise ArgumentError,
                             "expected a Foobara::RuntimeError or keyword arguments to construct one"
-                      # :nocov:
+                      # simplecov:enable
                     end
 
                     error
-                  elsif args.empty? || (args.size == 1 && args.first.is_a?(Hash))
-                    error_args = opts.merge(args.first || {})
+                  elsif args.empty? || (args.size == 1 && args[0].is_a?(Hash))
+                    error_args = opts.merge(args[0] || {})
                     symbol = error_args[:symbol]
 
                     unless symbol
-                      # :nocov:
+                      # simplecov:disable
                       raise ArgumentError, "missing error symbol"
-                      # :nocov:
+                      # simplecov:enable
                     end
 
                     error_class = self.class.lookup_runtime_error_class(symbol)
@@ -161,9 +161,9 @@ module Foobara
                     error_class = self.class.lookup_runtime_error_class(symbol)
                     error_class.new(symbol:, context:, message:)
                   else
-                    # :nocov:
+                    # simplecov:disable
                     raise ArgumentError, "Invalid arguments given. Expected an error or args/opts to build error"
-                    # :nocov:
+                    # simplecov:enable
                   end
 
           add_error(error)

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

@@ -26,22 +26,22 @@ module Foobara
           def possible_error(*args)
             possible_error = case args.size
                              when 1
-                               arg = args.first
+                               arg = args[0]
 
                                if arg.is_a?(PossibleError)
                                  # TODO: test this code path
-                                 # :nocov:
+                                 # simplecov:disable
                                  arg
-                                 # :nocov:
+                                 # simplecov:enable
                                elsif arg.is_a?(::Class) && arg < Foobara::Error
                                  PossibleError.new(arg)
                                elsif arg.is_a?(::Symbol)
                                  error_class = Foobara::RuntimeError.subclass(mod: self, symbol: arg)
                                  PossibleError.new(error_class, symbol: arg)
                                else
-                                 # :nocov:
+                                 # simplecov:disable
                                  raise ArgumentError, "Expected a PossibleError or an Error but got #{arg}"
-                                 # :nocov:
+                                 # simplecov:enable
                                end
                              when 2
                                symbol, subclass_parameters, data = args
@@ -54,9 +54,9 @@ module Foobara
 
                                PossibleError.new(error_class, symbol:, data:)
                              else
-                               # :nocov:
+                               # simplecov:disable
                                raise ArgumentError, "Expected an error or a symbol and error context type declaration"
-                               # :nocov:
+                               # simplecov:enable
                              end
 
             register_possible_error_class(possible_error)
@@ -111,10 +111,6 @@ module Foobara
                                         map
                                       end
 
-            inputs_association_paths&.each do |data_path|
-              possible_input_error(data_path.to_sym, CommandPatternImplementation::NotFoundError)
-            end
-
             @error_context_type_map
           end
 

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

@@ -6,26 +6,6 @@ module Foobara
 
         include Concern
 
-        module ClassMethods
-          def inputs_association_paths
-            return @inputs_association_paths if defined?(@inputs_association_paths)
-
-            @inputs_association_paths = if inputs_type.nil?
-                                          nil
-                                        else
-                                          keys = Entity.construct_associations(inputs_type).keys
-
-                                          if keys.empty?
-                                            nil
-                                          else
-                                            keys.map do |key|
-                                              DataPath.new(key)
-                                            end
-                                          end
-                                        end
-          end
-        end
-
         attr_reader :inputs, :raw_inputs
 
         def initialize(inputs = {})
@@ -37,9 +17,9 @@ module Foobara
           if respond_to_missing_for_inputs?(method_name)
             inputs[method_name]
           else
-            # :nocov:
+            # simplecov:disable
             super
-            # :nocov:
+            # simplecov:enable
           end
         end
 
@@ -66,9 +46,9 @@ module Foobara
               if error.is_a?(Value::DataError)
                 add_input_error(error)
               else
-                # :nocov:
+                # simplecov:disable
                 raise UnexpectedInputValidationError, "Unexpected input validation error: #{error}"
-                # :nocov:
+                # simplecov:enable
               end
             end
           end

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

@@ -1,29 +1,24 @@
 module Foobara
   module CommandPatternImplementation
+    class BadCommandInputsError < StandardError; end
+
     module Concerns
       module InputsType
         include Concern
 
         module ClassMethods
           def inputs(...)
-            old_inputs_type = inputs_type
-
-            old_inputs_type&.possible_errors&.each do |possible_error|
-              unregister_possible_error_if_registered(possible_error)
-            end
-
-            if defined?(@inputs_association_paths)
-              remove_instance_variable(:@inputs_association_paths)
-            end
+            type = type_for_declaration(...)
 
-            if defined?(@entity_class_paths)
-              remove_instance_variable(:@entity_class_paths)
+            unless type.extends?(BuiltinTypes[:attributes])
+              raise BadCommandInputsError, "Expected attributes or something unambiguously convertable to attributes " \
+                                           "but got #{type}"
             end
 
-            type = type_for_declaration(...)
+            old_inputs_type = inputs_type
 
-            if type.extends?(BuiltinTypes[:model]) && !type.extends?(BuiltinTypes[:entity])
-              type = type.element_types
+            old_inputs_type&.possible_errors&.each do |possible_error|
+              unregister_possible_error_if_registered(possible_error)
             end
 
             @inputs_type = type

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

@@ -88,28 +88,15 @@ module Foobara
             remove_sensitive = TypeDeclarations.foobara_manifest_context_remove_sensitive?
 
             if defined?(@types_depended_on) && @types_depended_on.key?(remove_sensitive)
+              # simplecov:disable
               return @types_depended_on[remove_sensitive]
+              # simplecov:enable
             end
 
             @types_depended_on ||= {}
-            @types_depended_on[remove_sensitive] = begin
-              types = inputs_types_depended_on |
-                      result_types_depended_on |
-                      errors_types_depended_on
-
-              unless depends_on_entities.empty?
-                entity_types = depends_on_entities.map(&:entity_type)
-
-                if remove_sensitive
-                  entity_types = entity_types.reject(&:sensitive?)
-                end
-
-                types |= entity_types
-                types |= entity_types.map(&:types_depended_on).inject(:|)
-              end
-
-              types
-            end
+            @types_depended_on[remove_sensitive] = inputs_types_depended_on |
+                                                   result_types_depended_on |
+                                                   errors_types_depended_on
           end
 
           def inputs_types_depended_on
@@ -124,13 +111,13 @@ module Foobara
                                                             if inputs_type.registered?
                                                               # TODO: if we ever change from attributes-only inputs type
                                                               # then this will be handy
-                                                              # :nocov:
+                                                              # simplecov:disable
                                                               if !remove_sensitive || !inputs_type.sensitive?
                                                                 Set[inputs_type]
                                                               else
                                                                 Set.new
                                                               end
-                                                              # :nocov:
+                                                              # simplecov:enable
                                                             else
                                                               inputs_type.types_depended_on
                                                             end

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

@@ -7,13 +7,6 @@ module Foobara
         class CannotHaltWithoutAddingErrors < StandardError; end
         class Halt < StandardError; end
 
-        class NotFoundError < Foobara::DataError
-          context do
-            entity_class :string, :required
-            criteria :duck
-          end
-        end
-
         module ClassMethods
           def run(...)
             new(...).run
@@ -54,10 +47,10 @@ module Foobara
           return outcome if state_machine.currently_errored?
 
           if error_collection.empty?
-            # :nocov:
+            # simplecov:disable
             raise CannotHaltWithoutAddingErrors, "Cannot halt without adding errors first. " \
                                                  "Either add errors or use error! transition instead."
-            # :nocov:
+            # simplecov:enable
           end
 
           state_machine.fail!
@@ -93,44 +86,6 @@ module Foobara
           # noop but for now helpful for carrying out state transition
         end
 
-        def validate_records
-          self.class.inputs_association_paths&.each do |data_path|
-            if data_path.last == :"#"
-              records = data_path.values_at(@inputs)
-
-              records.each.with_index do |record, index|
-                if record&.persisted? && !record.loaded?
-                  begin
-                    record.class.load(record)
-                  rescue Foobara::Entity::NotFoundError => e
-                    add_input_error(
-                      [*data_path.path[..-2], index],
-                      CommandPatternImplementation::NotFoundError,
-                      criteria: e.criteria,
-                      entity_class: record.class.model_type.scoped_full_name
-                    )
-                  end
-                end
-              end
-            else
-              record = data_path.value_at(@inputs)
-
-              if record&.persisted? && !record.loaded?
-                begin
-                  record.class.load(record)
-                rescue Foobara::Entity::NotFoundError => e
-                  add_input_error(
-                    data_path.to_s,
-                    CommandPatternImplementation::NotFoundError,
-                    criteria: e.criteria,
-                    entity_class: record.class.model_type.scoped_full_name
-                  )
-                end
-              end
-            end
-          end
-        end
-
         def validate
           # can override if desired, default is a no-op
         end
@@ -152,7 +107,7 @@ module Foobara
             transition = transition_or_transitions
 
             state_machine.perform_transition!(transition) do
-              result = send(transition)
+              result = __send__(transition)
               halt! if has_errors?
             end
           end

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

@@ -74,17 +74,17 @@ module Foobara
             end
 
             if subcommand_classes.length == 1
-              subcommand_classes = Util.array(subcommand_classes.first)
+              subcommand_classes = Util.array(subcommand_classes[0])
             end
 
             subcommand_classes.each do |subcommand_class|
               subcommand_name = subcommand_class.scoped_full_name.to_sym
 
               if depends_on.include?(subcommand_name)
-                # :nocov:
+                # simplecov:disable
                 raise AlreadyRegisteredSubcommand,
                       "Already registered #{subcommand_class} as a dependency of #{self}"
-                # :nocov:
+                # simplecov:enable
               end
 
               depends_on << subcommand_name
@@ -99,9 +99,9 @@ module Foobara
             end
 
             unless depends_on?(subcommand_class)
-              # :nocov:
+              # simplecov:disable
               raise SubcommandNotRegistered, "Need to declare #{subcommand_class} on #{self} with .depends_on"
-              # :nocov:
+              # simplecov:enable
             end
           end
 

data/projects/command/src/command_pattern_implementation.rb

@@ -29,7 +29,6 @@ module Foobara
     include CommandPatternImplementation::Concerns::Runtime
     include CommandPatternImplementation::Concerns::Callbacks
     include CommandPatternImplementation::Concerns::StateMachine
-    include CommandPatternImplementation::Concerns::Transactions
     include CommandPatternImplementation::Concerns::Subcommands
     include CommandPatternImplementation::Concerns::DomainMappers
     include CommandPatternImplementation::Concerns::Reflection

data/projects/command_connectors/lib/foobara/command_connectors.rb

@@ -25,7 +25,7 @@ module Foobara
       end
 
       def reset_all
-        Foobara.raise_if_production!("reset_all")
+        Foobara.raise_if_production!
         remove_instance_variable("@desugarizer") if defined?(@desugarizer)
         remove_instance_variable("@desugarizers") if defined?(@desugarizers)
       end

data/projects/command_connectors/spec/command_connector_spec.rb

@@ -83,6 +83,7 @@ RSpec.describe Foobara::CommandConnector do
   let(:allowed_rule) { nil }
   let(:allowed_rules) { nil }
   let(:requires_authentication) { nil }
+  let(:authentication_optional) { nil }
   let(:capture_unknown_error) { false }
   let(:aggregate_entities) { nil }
   let(:atomic_entities) { nil }
@@ -473,6 +474,7 @@ RSpec.describe Foobara::CommandConnector do
         request: request_mutators,
         allowed_rule:,
         requires_authentication:,
+        authentication_optional:,
         pre_commit_transformers:,
         capture_unknown_error:,
         aggregate_entities:,
@@ -1066,6 +1068,63 @@ RSpec.describe Foobara::CommandConnector do
         end
       end
 
+      context "when authentication is optional" do
+        let(:requires_authentication) { nil }
+        let(:authentication_optional) { true }
+        let(:authenticator) { proc { "some-user" } }
+
+        it "authenticates, so the command can tell who is calling" do
+          expect(response.status).to be(0)
+          expect(response.authenticated_user).to eq("some-user")
+        end
+
+        context "when the authenticator finds nobody" do
+          let(:authenticator) { proc {} }
+
+          it "is not an error" do
+            expect(response.status).to be(0)
+            expect(response.authenticated_user).to be_nil
+          end
+        end
+      end
+
+      context "when authentication is asked for but no authenticator is configured" do
+        let(:authenticator) { nil }
+
+        context "when it is required" do
+          let(:requires_authentication) { true }
+          let(:authentication_optional) { nil }
+
+          it "blows up rather than running the command unauthenticated" do
+            expect {
+              response
+            }.to raise_error(Foobara::CommandConnector::NoAuthenticatorGivenError)
+          end
+        end
+
+        context "when it is optional" do
+          let(:requires_authentication) { nil }
+          let(:authentication_optional) { true }
+
+          it "blows up rather than running the command anonymously" do
+            expect {
+              response
+            }.to raise_error(Foobara::CommandConnector::NoAuthenticatorGivenError)
+          end
+        end
+      end
+
+      context "when neither is asked for" do
+        let(:requires_authentication) { nil }
+        let(:authentication_optional) { nil }
+        let(:authenticator) { proc { "some-user" } }
+
+        it "does not authenticate at all" do
+          expect(response.status).to be(0)
+          expect(response.authenticated_user).to be_nil
+        end
+      end
+
       context "with an entity input" do
         before do
           Foobara::Persistence.default_crud_driver = Foobara::Persistence::CrudDrivers::InMemory.new
@@ -1129,7 +1188,7 @@ RSpec.describe Foobara::CommandConnector do
             errors = JSON.parse(response.body)
 
             expect(errors.size).to eq(1)
-            expect(errors.map { |e| e["key"] }).to include("runtime.user_not_found")
+            expect(errors.map { |e| e["key"] }).to include("data.user.not_found")
           end
         end
 
@@ -1576,7 +1635,7 @@ RSpec.describe Foobara::CommandConnector do
 
         it "gives some help" do
           expect(response.status).to be(0)
-          expect(response.body).to match(/HELP!!!/)
+          expect(response.body).to include('HELP!!!')
         end
 
         context "when asking for help with a specific element" do
@@ -1585,7 +1644,7 @@ RSpec.describe Foobara::CommandConnector do
 
           it "gives some help" do
             expect(response.status).to be(0)
-            expect(response.body).to match(/HELP!!!/)
+            expect(response.body).to include('HELP!!!')
           end
         end
 
@@ -2039,7 +2098,7 @@ RSpec.describe Foobara::CommandConnector do
 
         # TODO: figure out how to set up this situation instead of directly passing a manifest
         # hash to a private method
-        patched_up_manifest = command_connector.send(
+        patched_up_manifest = command_connector.__send__(
           :patch_up_broken_parents_for_errors_with_missing_command_parents,
           manifest_hash
         )