foobara 0.0.51 → 0.0.53

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e82271074f7658b6b54239b1ba4e79c944baca14bc63af1fd48e7b5d5c418043
-  data.tar.gz: f5f0dcd5bcd9e553dbcdbab70f4e9388ab98c99b4359aca8bfaf4d32fad89e7a
+  metadata.gz: 6f36fa530b7c550b95ee9f580590ad68e18700e80048746fb734078ea0e9744e
+  data.tar.gz: 1454b5d06e3be5c3be8b9cfee10b6e598b71ad74f409c7f09d2a66427f71f3a7
 SHA512:
-  metadata.gz: 33ce048fb57a1c12811756a5d1b9238b0b79587993d6f45323f65294cca6bcd46d33bc281e9021070c21e6f5852e9066927cb8e78a7f2f62c29b3e705ab95e4c
-  data.tar.gz: 59cde8f01b6c5e74e69b78e951ea74cb4f85eecb9f41b1f7a1c79cd6f9f5ce4e492109c8b860aefcfd73f832355e0a912796d10b0e3a67d456921b06a7da62ed
+  metadata.gz: 5a238d0b3ba1366f67a0edee344a7f0228367b56a0c45eabe230603310a4b36b9f13b765382907a9e8c72533f0ec18af6f1b956e575a0c79bffe08e036de3097
+  data.tar.gz: 99b3b4c279bc4104fc1faefda279bf4fadcae8ee57975655dec120f17ce5980fda6b2dccf1476e00df20460e3a091dba56f5c00afdc4907bdf62c374feddee78

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.0.53] - 2025-01-30
+
+- Prefix and re-organize several model methods to facilitate type extension
+- Add support for generating a manifest with detached entities based on context
+
 ## [0.0.51] - 2025-01-26
 
 - Add a Type#remove_processor_by_symbol method to help with certain situations when defining custom types

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

@@ -0,0 +1,39 @@
+module Foobara
+  class DetachedEntity < Model
+    module Concerns
+      module Aliases
+        include Concern
+
+        module ClassMethods
+          def depends_on(...)
+            foobara_depends_on(...)
+          end
+
+          def deep_depends_on(...)
+            foobara_deep_depends_on(...)
+          end
+
+          def associations(...)
+            foobara_associations(...)
+          end
+
+          def deep_associations(...)
+            foobara_deep_associations(...)
+          end
+
+          def attributes_type(...)
+            foobara_attributes_type(...)
+          end
+
+          def primary_key_attribute(...)
+            foobara_primary_key_attribute(...)
+          end
+
+          def model_name(...)
+            foobara_model_name(...)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,8 +11,8 @@ module Foobara
 
           alias associations foobara_associations
 
-          def deep_associations
-            @deep_associations ||= begin
+          def foobara_deep_associations
+            @foobara_deep_associations ||= begin
               deep = {}
 
               associations.each_pair do |data_path, type|
@@ -29,6 +29,8 @@ module Foobara
             end
           end
 
+          alias deep_associations foobara_deep_associations
+
           # TODO: stamp this metadata out somewhere, preferably on deep_associations hash somehow
           def association(name, *association_identifiers)
             target_association_key = association_for(association_identifiers)

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

@@ -28,8 +28,8 @@ module Foobara
           def foobara_primary_key_attribute
             return @foobara_primary_key_attribute if @foobara_primary_key_attribute
 
-            unless superclass == DetachedEntity
-              @foobara_primary_key_attribute = superclass.primary_key_attribute
+            if superclass != DetachedEntity && superclass.respond_to?(:foobara_primary_key_attribute)
+              @foobara_primary_key_attribute = superclass.foobara_primary_key_attribute
             end
           end
 

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

@@ -2,29 +2,15 @@ module Foobara
   class DetachedEntity < Model
     module Concerns
       module Reflection
-        class CannotConvertRecordWithoutPrimaryKeyToJsonError < StandardError; end
-
         include Concern
 
-        def inspect
-          "<#{entity_name}:#{primary_key}>"
-        end
-
-        def to_json(*_args)
-          primary_key&.to_json || raise(
-            CannotConvertRecordWithoutPrimaryKeyToJsonError,
-            "Cannot call record.to_json on unless record has a primary key. " \
-            "Consider instead calling record.attributes.to_json instead."
-          )
-        end
-
         module ClassMethods
-          def depends_on
-            associations.values.map(&:target_class).uniq
+          def foobara_depends_on
+            foobara_associations.values.map(&:target_class).uniq
           end
 
-          def deep_depends_on
-            types = deep_associations.sort_by do |path, _type|
+          def foobara_deep_depends_on
+            types = foobara_deep_associations.sort_by do |path, _type|
               [DataPath.new(path).path.size, path]
             end.map(&:last)
 
@@ -32,29 +18,32 @@ module Foobara
           end
 
           def foobara_manifest(to_include: Set.new)
-            associations = self.associations.map do |(path, type)|
+            associations = foobara_associations.map do |(path, type)|
               entity_class = type.target_class
-              entity_name = entity_class.full_entity_name
+              entity_name = entity_class.foobara_type.scoped_full_name
 
               [path, entity_name]
             end.sort.to_h
 
-            deep_associations = self.deep_associations.map do |(path, type)|
+            deep_associations = foobara_deep_associations.map do |(path, type)|
               entity_class = type.target_class
-              entity_name = entity_class.full_entity_name
+              entity_name = entity_class.foobara_type.scoped_full_name
 
               [path, entity_name]
             end.sort.to_h
 
-            super.merge(
+            base_manifest = superclass.respond_to?(:foobara_manifest) ? super : {}
+
+            base_manifest.merge(
               Util.remove_blank(
-                depends_on: depends_on.map(&:full_entity_name),
-                deep_depends_on: deep_depends_on.map(&:full_entity_name),
+                depends_on: foobara_depends_on.map(&:full_entity_name),
+                deep_depends_on: foobara_deep_depends_on.map(&:full_entity_name),
                 associations:,
                 deep_associations:,
-                entity_name:,
-                primary_key_attribute:,
-                primary_key_type: attributes_type.declaration_data[:element_type_declarations][primary_key_attribute]
+                entity_name: foobara_model_name,
+                primary_key_attribute: foobara_primary_key_attribute,
+                primary_key_type:
+                  foobara_attributes_type.declaration_data[:element_type_declarations][foobara_primary_key_attribute]
               )
             )
           end

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

@@ -0,0 +1,23 @@
+module Foobara
+  class DetachedEntity < Model
+    module Concerns
+      module Serialize
+        class CannotConvertRecordWithoutPrimaryKeyToJsonError < StandardError; end
+
+        include Concern
+
+        def inspect
+          "<#{entity_name}:#{primary_key}>"
+        end
+
+        def to_json(*_args)
+          primary_key&.to_json || raise(
+            CannotConvertRecordWithoutPrimaryKeyToJsonError,
+            "Cannot call record.to_json on unless record has a primary key. " \
+            "Consider instead calling record.attributes.to_json instead."
+          )
+        end
+      end
+    end
+  end
+end

data/projects/detached_entity/src/detached_entity.rb

@@ -5,6 +5,8 @@ module Foobara
     include Concerns::PrimaryKey
     include Concerns::Reflection
     include Concerns::Types
+    include Concerns::Aliases
+    include Concerns::Serialize
 
     class << self
       def allowed_subclass_opts

data/projects/detached_entity/src/detached_entity_type.rb

@@ -0,0 +1,63 @@
+module Foobara
+  class DetachedEntityType < Types::Type
+    class << self
+      def types_requiring_conversion
+        @types_requiring_conversion ||= Set.new
+      end
+
+      def model_base_classes_requiring_conversion
+        @model_base_classes_requiring_conversion ||= Set.new
+      end
+
+      def type_requires_conversion?(type)
+        types_requiring_conversion.include?(type)
+      end
+
+      def model_base_class_requires_conversion?(model_base_class)
+        model_base_classes_requiring_conversion.include?(model_base_class)
+      end
+    end
+
+    def foobara_manifest(to_include: Set.new)
+      manifest = super
+
+      if detached_context?
+        declaration_data = manifest[:declaration_data]
+        if self.class.type_requires_conversion?(declaration_data[:type])
+          declaration_data = declaration_data.merge(type: :detached_entity)
+        end
+
+        if self.class.model_base_class_requires_conversion?(declaration_data[:model_base_class])
+          declaration_data = declaration_data.merge(model_base_class: "Foobara::DetachedEntity")
+        end
+
+        manifest = manifest.merge(declaration_data:)
+      end
+
+      manifest
+    end
+
+    def types_to_add_to_manifest
+      types = super
+
+      if detached_context?
+        types.delete(base_type)
+        types.unshift(base_type_for_manifest)
+      end
+
+      types
+    end
+
+    def base_type_for_manifest
+      if detached_context?
+        BuiltinTypes[:detached_entity]
+      else
+        super
+      end
+    end
+
+    def detached_context?
+      Thread.foobara_var_get("foobara_manifest_context")&.[](:detached)
+    end
+  end
+end

data/projects/detached_entity/src/extensions/type_declarations/handlers/extend_detached_entity_type_declaration/to_type_transformer.rb

@@ -20,6 +20,10 @@ module Foobara
               end
             end
           end
+
+          def type_class
+            Foobara::DetachedEntityType
+          end
         end
       end
     end

data/projects/entity/lib/foobara/entity.rb

@@ -11,6 +11,9 @@ module Foobara
 
         detached_entity = Namespace.global.foobara_lookup_type!(:detached_entity)
         BuiltinTypes.build_and_register!(:entity, detached_entity, nil)
+
+        DetachedEntityType.types_requiring_conversion << :entity
+        DetachedEntityType.model_base_classes_requiring_conversion << "Foobara::Entity"
       end
 
       def reset_all

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

@@ -53,6 +53,7 @@ module Foobara
       end
 
       def model?
+        # TODO: hmmmm, should be false for :active_record
         return false if %w[entity detached_entity].include?(reference)
 
         type = base_type

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

@@ -0,0 +1,15 @@
+module Foobara
+  class Model
+    module Concerns
+      module Aliases
+        include Concern
+
+        module ClassMethods
+          def model_name(...)
+            foobara_model_name(...)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,12 +7,12 @@ module Foobara
         module ClassMethods
           def foobara_manifest(to_include: Set.new)
             Util.remove_blank(
-              attributes_type: attributes_type.declaration_data,
-              organization_name:,
-              domain_name:,
-              model_name:,
-              model_base_class: model_type.declaration_data[:model_base_class],
-              model_class: model_type.declaration_data[:model_class]
+              attributes_type: foobara_attributes_type.declaration_data,
+              organization_name: foobara_type.foobara_domain.foobara_organization_name,
+              domain_name: foobara_type.foobara_domain.foobara_domain_name,
+              model_name: foobara_model_name,
+              model_base_class: foobara_type.declaration_data[:model_base_class],
+              model_class: foobara_type.declaration_data[:model_class]
             )
           end
         end

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

@@ -80,6 +80,10 @@ module Foobara
             end
           end
 
+          def foobara_type
+            model_type
+          end
+
           def type_declaration(attributes_declaration)
             if name.start_with?(closest_namespace_module.name)
               model_module_name = closest_namespace_module.name

data/projects/model/src/model.rb

@@ -8,6 +8,7 @@ module Foobara
 
     include Concerns::Types
     include Concerns::Reflection
+    include Concerns::Aliases
 
     class << self
       attr_accessor :is_abstract
@@ -84,8 +85,8 @@ module Foobara
         end
       end
 
-      def model_name
-        model_type&.scoped_name || Util.non_full_name(self)
+      def foobara_model_name
+        foobara_type&.scoped_name || Util.non_full_name(self)
       rescue Foobara::Scoped::NoScopedPathSetError
         # :nocov:
         Util.non_full_name(self)

data/projects/thread_parent/src/thread_parent.rb

@@ -19,6 +19,10 @@ class Thread
     def foobara_var_set(...)
       Thread.current.foobara_var_set(...)
     end
+
+    def foobara_with_var(...)
+      Thread.current.foobara_with_var(...)
+    end
   end
 
   attr_reader :foobara_parent
@@ -35,4 +39,15 @@ class Thread
   def foobara_var_set(...)
     thread_variable_set(...)
   end
+
+  def foobara_with_var(key, value, &block)
+    old_value = foobara_var_get(key)
+
+    begin
+      foobara_var_set(key, value)
+      block.call
+    ensure
+      foobara_var_set(key, old_value)
+    end
+  end
 end

data/projects/type_declarations/src/handlers/extend_registered_type_declaration/to_type_transformer.rb

@@ -45,7 +45,7 @@ module Foobara
               category << processor
             end
 
-            Types::Type.new(
+            type_class.new(
               strict_type_declaration,
               base_type:,
               # description: strict_type_declaration.is_a?(::Hash) && strict_type_declaration[:description],
@@ -60,6 +60,10 @@ module Foobara
             )
           end
 
+          def type_class
+            Types::Type
+          end
+
           # TODO: test that registering a custom type sets its name
           def type_name(strict_type_declaration)
             "Anonymous #{strict_type_declaration[:type]} extension"

data/projects/types/src/type/concerns/reflection.rb

@@ -15,7 +15,7 @@ module Foobara
 
             return if !start && registered?
 
-            to_process = [*base_type, *element_type, *possible_errors.map(&:error_class)]
+            to_process = types_to_add_to_manifest
 
             if element_types
               to_process += case element_types
@@ -43,6 +43,10 @@ module Foobara
             result
           end
 
+          def types_to_add_to_manifest
+            [*base_type, *element_type, *possible_errors.map(&:error_class)]
+          end
+
           def deep_types_depended_on
             result = Set.new
             to_process = types_depended_on

data/projects/types/src/type.rb

@@ -323,7 +323,7 @@ module Foobara
           declaration_data:,
           types_depended_on: types.sort,
           possible_errors: possible_errors_manifests
-        ).merge(description:, base_type: base_type&.full_type_name&.to_sym)
+        ).merge(description:, base_type: base_type_for_manifest)
 
         h.merge!(
           supported_processor_manifest(to_include).merge(
@@ -340,6 +340,10 @@ module Foobara
         super.merge(h)
       end
 
+      def base_type_for_manifest
+        base_type&.full_type_name&.to_sym
+      end
+
       def supported_processor_manifest(to_include)
         supported_casters = []
         supported_transformers = []

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.0.51
+  version: 0.0.53
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-01-27 00:00:00.000000000 Z
+date: 2025-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -186,12 +186,15 @@ files:
 - projects/delegate/lib/foobara/delegate.rb
 - projects/delegate/src/extensions/module.rb
 - projects/detached_entity/lib/foobara/detached_entity.rb
+- projects/detached_entity/src/concerns/aliases.rb
 - projects/detached_entity/src/concerns/associations.rb
 - projects/detached_entity/src/concerns/equality.rb
 - projects/detached_entity/src/concerns/primary_key.rb
 - projects/detached_entity/src/concerns/reflection.rb
+- projects/detached_entity/src/concerns/serialize.rb
 - projects/detached_entity/src/concerns/types.rb
 - projects/detached_entity/src/detached_entity.rb
+- projects/detached_entity/src/detached_entity_type.rb
 - projects/detached_entity/src/extensions/builtin_types/detached_entity.rb
 - projects/detached_entity/src/extensions/builtin_types/detached_entity/casters/hash.rb
 - projects/detached_entity/src/extensions/builtin_types/detached_entity/validators/attributes_declaration.rb
@@ -270,6 +273,7 @@ files:
 - projects/manifest/src/foobara/manifest/type.rb
 - projects/manifest/src/foobara/manifest/type_declaration.rb
 - projects/model/lib/foobara/model.rb
+- projects/model/src/concerns/aliases.rb
 - projects/model/src/concerns/reflection.rb
 - projects/model/src/concerns/types.rb
 - projects/model/src/extensions/builtin_types/model/casters/hash.rb
@@ -438,7 +442,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A command-centric and discoverable software framework with a focus on domain
   concepts and abstracting away integration code