foobara 0.0.47 → 0.0.49

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b307418792bdb9ffc486a5f7280d67838100daac32a7826277612121612304a9
-  data.tar.gz: e6e6c541731cadc39c9c64c9f759c3d347e291fa9731351d33248d9b27ec8de5
+  metadata.gz: c906fa3ff55b19d33976a861a7d249aaf8b869507ba845cd8743459653fc117f
+  data.tar.gz: 86da929e2ed3d0b478067f27e7605060941a593eb8c5c95298304d3cf048fc45
 SHA512:
-  metadata.gz: d76ba08fc4bc43e51a3c99ec9a780da84e57e9b15d6b29b1782e916ace9adbc198f6e1723852232e4c04766a5979c367bdc1dae6ec020ec3d5d742c61bb4a667
-  data.tar.gz: 95a5ae616494aa957e57e465700a7330b1224bf2d4bb43482f5c13e35a5cabfa63b74e239492136a0e1d75f44c578b0b9a02abc7de64a0cadfd8053769de9341
+  metadata.gz: 04424105e5a0d9788839c40c3689ae34d8f1c39192128cf6e30a8c85e326fb3f5aa0b02a11cec7ac374ae62862cd941bb774db423d01e6e912b4a1a21977b3c2
+  data.tar.gz: 4030da0e998f344b19a453a624481189dbf432654c8af7a63a5197eeeb281d7a64df683c4babfcb59abad342a5b436036d61eda8bb760a0d011aa30cac1b780b

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.0.49] - 2025-01-21
+
+- Fill out more foobara_ model attribute helper methods to further support the ActiveRecordType gem
+
+## [0.0.48] - 2025-01-17
+
+- Add support for foobara_attributes_type to allow ActiveRecordType gem to work
+
 ## [0.0.47] - 2025-01-03
 
 - Bumped Ruby from 3.2.2 to 3.4.1

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

@@ -91,7 +91,7 @@ module Foobara
 
                     error_class = self.class.lookup_input_error_class(symbol, path)
                     error_class.new(**error_args, path:)
-                  elsif args.size == 2 || args.size == 3
+                  elsif [2, 3].include?(args.size)
                     input, symbol, message = args
                     context = opts
 
@@ -143,7 +143,7 @@ module Foobara
 
                     error_class = self.class.lookup_runtime_error_class(symbol)
                     error_class.new(**error_args)
-                  elsif args.is_a?(::Array) && (args.size == 1 || args.size == 2)
+                  elsif args.is_a?(::Array) && [1, 2].include?(args.size)
                     symbol, message = args
                     context = opts
 

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

@@ -2,6 +2,8 @@ module Foobara
   class Command
     module Concerns
       module Inputs
+        class UnexpectedInputValidationError < StandardError; end
+
         include Concern
 
         attr_reader :inputs
@@ -41,9 +43,8 @@ module Foobara
               if error.is_a?(Value::DataError)
                 add_input_error(error)
               else
-                # TODO: raise a real error
                 # :nocov:
-                raise "wtf"
+                raise UnexpectedInputValidationError, "Unexpected input validation error: #{error}"
                 # :nocov:
               end
             end

data/projects/detached_entity/src/concerns/associations.rb

@@ -5,10 +5,12 @@ module Foobara
         include Concern
 
         module ClassMethods
-          def associations
-            @associations ||= construct_associations
+          def foobara_associations
+            @foobara_associations ||= construct_associations
           end
 
+          alias associations foobara_associations
+
           def deep_associations
             @deep_associations ||= begin
               deep = {}
@@ -109,6 +111,8 @@ module Foobara
             end
           end
 
+          # TODO: this big switch is a problem. Hard to create new types in other projects without being able
+          # to modify this switch.  Figure out what to do.
           def construct_associations(
             type = attributes_type,
             path = DataPath.new,
@@ -135,7 +139,12 @@ module Foobara
                 construct_associations(element_type, path.append(attribute_name), result)
               end
             elsif type.extends?(BuiltinTypes[:model])
-              construct_associations(type.target_class.attributes_type, path, result)
+              target_class = type.target_class
+
+              method = target_class.respond_to?(:foobara_attributes_type) ? :foobara_attributes_type : :attributes_type
+              attributes_type = target_class.send(method)
+
+              construct_associations(attributes_type, path, result)
             elsif type.extends?(BuiltinTypes[:associative_array])
               # not going to bother testing this for now
               # :nocov:

data/projects/detached_entity/src/concerns/primary_key.rb

@@ -20,18 +20,20 @@ module Foobara
               # :nocov:
             end
 
-            @primary_key_attribute = attribute_name.to_sym
+            @foobara_primary_key_attribute = attribute_name.to_sym
 
             set_model_type
           end
 
-          def primary_key_attribute
-            return @primary_key_attribute if @primary_key_attribute
+          def foobara_primary_key_attribute
+            return @foobara_primary_key_attribute if @foobara_primary_key_attribute
 
             unless superclass == DetachedEntity
-              @primary_key_attribute = superclass.primary_key_attribute
+              @foobara_primary_key_attribute = superclass.primary_key_attribute
             end
           end
+
+          alias primary_key_attribute foobara_primary_key_attribute
         end
 
         def primary_key

data/projects/detached_entity/src/concerns/types.rb

@@ -23,10 +23,12 @@ module Foobara
             end
           end
 
-          def primary_key_type
-            @primary_key_type ||= attributes_type.element_types[primary_key_attribute]
+          def foobara_primary_key_type
+            @foobara_primary_key_type ||= attributes_type.element_types[primary_key_attribute]
           end
 
+          alias primary_key_type foobara_primary_key_type
+
           def full_entity_name
             full_model_name
           end

data/projects/entity/src/entity.rb

@@ -7,7 +7,6 @@ module Foobara
     include Concerns::Attributes
     include Concerns::Persistence
     include Concerns::Initialization
-    include Concerns::AttributeHelpers
     include Concerns::Types
 
     class << self

data/projects/foobara/lib/foobara/all.rb

@@ -30,6 +30,7 @@ module Foobara
              "model",
              "detached_entity",
              "entity",
+             "model_attribute_helpers",
              "command",
              "domain_mapper",
              "persistence",

data/projects/manifest/src/foobara/manifest/type.rb

@@ -53,7 +53,7 @@ module Foobara
       end
 
       def model?
-        return false if reference == "entity" || reference == "detached_entity"
+        return false if %w[entity detached_entity].include?(reference)
 
         type = base_type
 

data/projects/model/src/concerns/types.rb

@@ -102,7 +102,7 @@ module Foobara
             )
           end
 
-          def attributes_type
+          def foobara_attributes_type
             return @attributes_type if @attributes_type
 
             @attributes_type = if model_type
@@ -112,6 +112,8 @@ module Foobara
                                end
           end
 
+          alias attributes_type foobara_attributes_type
+
           def model_type=(model_type)
             @model_type = model_type
 

data/projects/model_attribute_helpers/lib/foobara/model_attribute_helpers.rb

@@ -0,0 +1,16 @@
+require "date"
+require "time"
+require "bigdecimal"
+
+module Foobara
+  module ModelAttributeHelpers
+    class << self
+      def install!
+        Model.include Concerns::AttributeHelpers
+        Model.include Concerns::AttributeHelperAliases
+        Entity.include Concerns::AttributeHelpers
+        Entity.include Concerns::AttributeHelperAliases
+      end
+    end
+  end
+end

data/projects/model_attribute_helpers/src/attribute_helper_aliases.rb

@@ -0,0 +1,30 @@
+# This is currently the working file, fix this up/move it
+
+module Foobara
+  module ModelAttributeHelpers
+    module Concerns
+      module AttributeHelperAliases
+        include Foobara::Concern
+
+        module ClassMethods
+          %i[
+            attributes_for_update
+            type_from_foobara_model_class
+            attributes_type_from_foobara_model_class
+            primary_key_attribute_from_foobara_model_class
+            foobara_model_class_has_primary_key
+            attributes_for_create
+            attributes_for_aggregate_update
+            attributes_for_atom_update
+            attributes_for_find_by
+            type_declaration_value_at
+          ].each do |method_name|
+            define_method method_name do |*args, **opts, &block|
+              send("foobara_#{method_name}", *args, **opts, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/projects/{entity/src/concerns → model_attribute_helpers/src}/attribute_helpers.rb

@@ -1,37 +1,56 @@
+# delete this file
+
 module Foobara
-  class Entity < DetachedEntity
+  module ModelAttributeHelpers
     module Concerns
+      # TODO: This concern is retroactively designed to be mixed into any entity-like class that can hold an
+      # entity-like foobara type.
+      # Because we want a subclass of ActiveRecord::Base to be such a target in the case of the
+      # foobara-active-record-type class, but because we can't make ActiveRecord::Base a subclass of Entity or
+      # DetachedEntity, and also because it makes sense to extend such behavior to foobara model classes,
+      # we will implement this as a Concern/mixin with a published expected interface and prefixed methods.
+      # This also means it should live in its own project, not here in the entity project.
+      # required methods:
+      #
+      # foobara_type
+      # foobara_attributes_type
+      # foobara_primary_key_attribute (nil if not an entity type)
+      # foobara_primary_key_type (nil if not an entity type)
+      # foobara_associations
       module AttributeHelpers
         include Foobara::Concern
 
         module ClassMethods
-          def attributes_for_update
-            attributes_for_aggregate_update
+          def foobara_has_primary_key?
+            respond_to?(:foobara_primary_key_attribute)
+          end
+
+          def foobara_attributes_for_update
+            foobara_attributes_for_aggregate_update
           end
 
           # TODO: we should have metadata on the entity about whether it required a primary key
           # upon creation or not instead of an option here.
-          def attributes_for_create(includes_primary_key: false)
-            return attributes_type if includes_primary_key
+          def foobara_attributes_for_create(includes_primary_key: false)
+            return foobara_attributes_type if includes_primary_key
+            return foobara_attributes_type unless foobara_has_primary_key?
+
+            primary_key_attribute = foobara_primary_key_attribute
 
             declaration = attributes_type.declaration_data
             # TODO: just slice out the element type declarations
             declaration = Util.deep_dup(declaration)
 
-            if declaration.key?(:required) && declaration[:required].include?(primary_key_attribute)
+            declaration[:element_type_declarations].delete(primary_key_attribute)
+
+            if declaration.key?(:required)
               declaration[:required].delete(primary_key_attribute)
             end
 
-            if declaration.key?(:defaults) && declaration[:defaults].include?(primary_key_attribute)
+            if declaration.key?(:defaults)
               declaration[:defaults].delete(primary_key_attribute)
             end
 
-            if declaration.key?(:element_type_declarations)
-              if declaration[:element_type_declarations].key?(primary_key_attribute)
-                declaration[:element_type_declarations].delete(primary_key_attribute)
-              end
-            end
-
             handler = Domain.global.foobara_type_builder.handler_for_class(
               TypeDeclarations::Handlers::ExtendAttributesTypeDeclaration
             )
@@ -39,48 +58,50 @@ module Foobara
             handler.desugarize(declaration)
           end
 
-          def attributes_for_aggregate_update(initial = true)
-            declaration = attributes_type.declaration_data
+          def foobara_attributes_for_aggregate_update(initial = true)
+            declaration = foobara_attributes_type.declaration_data
             # TODO: just slice out the element type declarations
             declaration = Util.deep_dup(declaration)
 
             declaration.delete(:defaults)
             declaration.delete(:required)
 
-            if initial
-              declaration[:required] = [primary_key_attribute]
+            if initial && foobara_has_primary_key?
+              declaration[:required] = [foobara_primary_key_attribute]
             end
 
-            associations.each_pair do |data_path, type|
+            foobara_associations.each_pair do |data_path, type|
               if type.extends?(BuiltinTypes[:entity])
                 target_class = type.target_class
 
-                entry = type_declaration_value_at(declaration, DataPath.new(data_path).path)
+                entry = foobara_type_declaration_value_at(declaration, DataPath.new(data_path).path)
                 entry.clear
-                entry.merge!(target_class.attributes_for_aggregate_update(false))
+                entry.merge!(target_class.foobara_attributes_for_aggregate_update(false))
               end
             end
 
             declaration
           end
 
-          def attributes_for_atom_update
-            declaration = attributes_type.declaration_data
+          def foobara_attributes_for_atom_update
+            declaration = foobara_attributes_type.declaration_data
             # TODO: just slice out the element type declarations
             declaration = Util.deep_dup(declaration)
 
             declaration.delete(:defaults)
-            declaration[:required] = [primary_key_attribute]
+            if foobara_has_primary_key?
+              declaration[:required] = [foobara_primary_key_attribute]
+            end
 
             # expect all associations to be expressed as primary key values
             # TODO: should we have a special type for encapsulating primary keys types??
-            associations.each_pair do |data_path, type|
+            foobara_associations.each_pair do |data_path, type|
               if type.extends?(BuiltinTypes[:entity])
                 target_class = type.target_class
                 # TODO: do we really need declaration_data? Why cant we use the type directly?
                 # TODO: make this work with the type directly for performance reasons.
-                primary_key_type_declaration = target_class.primary_key_type.declaration_data
-                entry = type_declaration_value_at(declaration, DataPath.new(data_path).path)
+                primary_key_type_declaration = target_class.foobara_primary_key_type.declaration_data
+                entry = foobara_type_declaration_value_at(declaration, DataPath.new(data_path).path)
                 entry.clear
                 entry.merge!(primary_key_type_declaration)
               end
@@ -89,10 +110,10 @@ module Foobara
             declaration
           end
 
-          def attributes_for_find_by
+          def foobara_attributes_for_find_by
             element_type_declarations = {}
 
-            attributes_type.element_types.each_pair do |attribute_name, attribute_type|
+            foobara_attributes_type.element_types.each_pair do |attribute_name, attribute_type|
               element_type_declarations[attribute_name] = attribute_type.reference_or_declaration_data
             end
 
@@ -108,7 +129,7 @@ module Foobara
 
           private
 
-          def type_declaration_value_at(declaration, path_parts)
+          def foobara_type_declaration_value_at(declaration, path_parts)
             return declaration if path_parts.empty?
 
             path_part, *path_parts = path_parts
@@ -124,7 +145,7 @@ module Foobara
                             # :nocov:
                           end
 
-            type_declaration_value_at(declaration, path_parts)
+            foobara_type_declaration_value_at(declaration, path_parts)
           end
         end
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.0.47
+  version: 0.0.49
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-01-04 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -219,7 +219,6 @@ files:
 - projects/domain_mapper/src/domain_mapper.rb
 - projects/domain_mapper/src/domain_mapper_lookups.rb
 - projects/entity/lib/foobara/entity.rb
-- projects/entity/src/concerns/attribute_helpers.rb
 - projects/entity/src/concerns/attributes.rb
 - projects/entity/src/concerns/callbacks.rb
 - projects/entity/src/concerns/initialization.rb
@@ -289,6 +288,9 @@ files:
 - projects/model/src/extensions/type_declarations/handlers/extend_registered_model_type_declaration/to_type_transformer.rb
 - projects/model/src/extensions/type_declarations/handlers/registered_type_declaration/model_class_desugarizer.rb
 - projects/model/src/model.rb
+- projects/model_attribute_helpers/lib/foobara/model_attribute_helpers.rb
+- projects/model_attribute_helpers/src/attribute_helper_aliases.rb
+- projects/model_attribute_helpers/src/attribute_helpers.rb
 - projects/monorepo/lib/foobara/monorepo.rb
 - projects/monorepo/lib/foobara/monorepo/project.rb
 - projects/namespace/lib/foobara/namespace.rb
@@ -415,6 +417,7 @@ require_paths:
 - "./projects/in_memory_crud_driver_minimal/lib"
 - "./projects/manifest/lib"
 - "./projects/model/lib"
+- "./projects/model_attribute_helpers/lib"
 - "./projects/monorepo/lib"
 - "./projects/namespace/lib"
 - "./projects/persistence/lib"