foobara 0.5.5 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6527e62790180b1aeb2f98e069655d8ac72750fbff834fc63e9b75a01c35cb4e
-  data.tar.gz: a769dd2a642b71bd401dabe3c0917a1fa128069f2a7987ff79df633765ae93ad
+  metadata.gz: 0d1c5cb75a03670d17291e1d85de76a826b6fedfe4b0f099f235ca646253c165
+  data.tar.gz: 7f852654ca70620a4dd544792d4518cfb7a5cd64214802517bdd9a3e1f435b19
 SHA512:
-  metadata.gz: '0359999dd32f56220e88e3e860ff7e415a4fd2b978bf83768868b1e10b0013c9e02597731890d1a2abb2fd11c1e288e1c1e8056b3bd6bf7a11bc9589af371ae3'
-  data.tar.gz: 33cf7a4428854d3016c1ccda045820e6da47a268e34f5bb05505bcc878ecdeff909caf1c411505d97849f4ffd69cc6e9c1c51a046ee92f6ee7ac2afe1919b359
+  metadata.gz: 83077d31d4ac8f03a044568550f97a79a1772f6ec27f3b839501625a400d9b40550df500ba70e8e3241cf9ea001a2a52821b4c2c2c1a76241d5eb8265d36cf43
+  data.tar.gz: 9e41a5c335dab08647082b411e55ef4962ddf09a280cba9c8ee58b77533072349a0b271607a1f28ccd56eff82219182dd66e7e41177200abd979d855d9d53430

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [0.5.7] - 2026-02-25
+
+- Add a Manifest::Model.associations convenience method
+- Add Manifest::Tuple and various missing predicate methods
+- Add a query flag to the manifest
+
+# [0.5.6] - 2026-02-20
+
+- Introduce an official Query concept
+
 # [0.5.5] - 2026-02-19
 
 - Fix bug where WeakObjectSet#delete could fail after deactivation

data/projects/command/src/command_pattern_implementation/concerns/{description.rb → command_data.rb}

@@ -1,7 +1,7 @@
 module Foobara
   module CommandPatternImplementation
     module Concerns
-      module Description
+      module CommandData
         include Concern
 
         module ClassMethods
@@ -16,6 +16,20 @@ module Foobara
               # :nocov:
             end
           end
+
+          def is_query
+            @is_query = true
+          end
+
+          # rubocop:disable Naming/MemoizedInstanceVariableName
+          def query?
+            return @is_query if defined?(@is_query)
+
+            @is_query = if superclass.respond_to?(:query?)
+                          superclass.query?
+                        end
+          end
+          # rubocop:enable Naming/MemoizedInstanceVariableName
         end
       end
     end

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

@@ -68,6 +68,10 @@ module Foobara
                 ).declaration_data
             ).merge(description:)
 
+            if query?
+              h[:is_query] = true
+            end
+
             if result_type
               # TODO: find a way to represent literal types like "nil"
               h[:result_type] = result_type.reference_or_declaration_data_for_manifest

data/projects/command/src/command_pattern_implementation.rb

@@ -15,7 +15,7 @@ module Foobara
 
     include TruncatedInspect
 
-    include CommandPatternImplementation::Concerns::Description
+    include CommandPatternImplementation::Concerns::CommandData
     include CommandPatternImplementation::Concerns::Namespace
 
     include CommandPatternImplementation::Concerns::InputsType

data/projects/command/src/query.rb

@@ -0,0 +1,7 @@
+module Foobara
+  # TODO: we should probably include CommandPatternImplementation instead of inheriting from Foobara::Command
+  # but don't want to hunt down plumbing problems that might arise if Query isn't a Command
+  class Query < Foobara::Command
+    is_query
+  end
+end

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

@@ -251,13 +251,11 @@ module Foobara
                 contains_associations?(element_type, false)
               end
             elsif type.extends?(BuiltinTypes[:attributes])
-
               type.element_types&.values&.any? do |element_type|
                 if !remove_sensitive || !element_type.sensitive?
                   contains_associations?(element_type, false)
                 end
               end
-
             elsif type.extends?(BuiltinTypes[:associative_array])
               element_types = type.element_types
 

data/projects/manifest/spec/associations_spec.rb

@@ -0,0 +1,67 @@
+# TODO: Get this out of here and into model project
+RSpec.describe Foobara::Manifest::Model do
+  after { Foobara.reset_alls }
+
+  describe ".associations" do
+    context "when the type has associations" do
+      before do
+        stub_class "SomeInnerInnerEntity", Foobara::Entity do
+          attributes do
+            id :integer
+            bar :string, :required
+          end
+          primary_key :id
+        end
+
+        stub_class "SomeOuterModel", Foobara::Model do
+          attributes do
+            some_inner_inner_entities [:SomeInnerInnerEntity, :SomeInnerInnerEntity]
+          end
+        end
+
+        stub_class("SomeInnerEntity", Foobara::Entity) do
+          attributes do
+            id :integer
+            foo :string, :required
+          end
+
+          primary_key :id
+        end
+
+        stub_class("SomeOuterEntity", Foobara::Entity) do
+          attributes do
+            id :integer
+            some_inner_entity :SomeInnerEntity
+          end
+
+          primary_key :id
+        end
+
+        Foobara::GlobalDomain.foobara_register_type(:some_type) do
+          some_array [SomeOuterEntity]
+          some_inner_model :SomeOuterModel
+        end
+      end
+
+      it "can reproduce association info from the underlying associations in the types" do
+        raw_manifest = Foobara.manifest
+
+        root_manifest = Foobara::Manifest::RootManifest.new(raw_manifest)
+
+        manifest_type = root_manifest.type_by_name(:some_type)
+
+        expect(manifest_type).to be_a(Foobara::Manifest::Type)
+
+        associations = described_class.associations(manifest_type)
+
+        expect(associations.keys).to contain_exactly(
+          "some_array.#",
+          "some_inner_model.some_inner_inner_entities.0",
+          "some_inner_model.some_inner_inner_entities.1"
+        )
+
+        expect(associations.values).to all be_a(Foobara::Manifest::Entity)
+      end
+    end
+  end
+end

data/projects/manifest/spec/manifest_spec.rb

@@ -71,7 +71,7 @@ RSpec.describe Foobara::Manifest do
       primary_key :id
     end
 
-    stub_class "SomeOrg::SomeDomain::QueryUser", Foobara::Command
+    stub_class "SomeOrg::SomeDomain::QueryUser", Foobara::Query
     stub_class "SomeOrg::SomeDomain::QueryUser::SomethingWentWrongError", Foobara::RuntimeError do
       class << self
         def context_type_declaration
@@ -259,8 +259,11 @@ RSpec.describe Foobara::Manifest do
     expect(attributes.sensitive).to be_falsey
     expect(attributes.sensitive_exposed).to be_falsey
 
+    expect(manifest.queries.map(&:command_name)).to contain_exactly("QueryUser")
+
     command = manifest.command_by_name("SomeOrg::SomeDomain::QueryUser")
 
+    expect(command).to be_query
     expect(command).to be_a(Foobara::Manifest::Command)
     expect(command.scoped_category).to eq(:command)
     expect(command.parent_category).to eq(:domain)

data/projects/manifest/spec/type_spec.rb

@@ -0,0 +1,30 @@
+RSpec.describe Foobara::Manifest::Type do
+  after { Foobara.reset_alls }
+
+  context "when it's an associative array" do
+    before do
+      Foobara::GlobalDomain.foobara_register_type(:some_type,
+                                                  type: :associative_array,
+                                                  value_type_declaration: :string,
+                                                  key_type_declaration: :integer)
+    end
+
+    describe "#associative_array?" do
+      it "is true" do
+        root_manifest = Foobara::Manifest::RootManifest.new(Foobara.manifest)
+        expect(root_manifest.type_by_name(:some_type)).to be_associative_array
+      end
+    end
+
+    describe "#to_type_declaration_from_declaration_data" do
+      it "gives an associative_array declaration" do
+        root_manifest = Foobara::Manifest::RootManifest.new(Foobara.manifest)
+        type = root_manifest.type_by_name(:some_type)
+        declaration = type.to_type_declaration_from_declaration_data
+
+        expect(declaration).to be_a(Foobara::Manifest::TypeDeclaration)
+        expect(declaration).to be_associative_array
+      end
+    end
+  end
+end

data/projects/manifest/src/base_manifest.rb

@@ -69,8 +69,6 @@ module Foobara
       end
 
       def domain
-        domain_reference = self[:domain]
-
         Domain.new(root_manifest, [:domain, domain_reference])
       end
 

data/projects/manifest/src/command.rb

@@ -21,6 +21,10 @@ module Foobara
         scoped_full_name
       end
 
+      def query?
+        self[:is_query]
+      end
+
       def inputs_type
         Attributes.new(root_manifest, [*manifest_path, :inputs_type])
       end

data/projects/manifest/src/model.rb

@@ -3,6 +3,44 @@ require_relative "type"
 module Foobara
   module Manifest
     class Model < Type
+      class << self
+        def associations(type, path = DataPath.new, result = {}, initial: true)
+          if type.detached_entity? && !initial
+            type = type.to_type if type.is_a?(TypeDeclaration)
+            result[path.to_s] = type
+          elsif type.model?
+            type = type.to_type if type.is_a?(TypeDeclaration)
+            associations(type.attributes_type, path, result, initial: false)
+          elsif type.tuple?
+            type = type.to_type_declaration_from_declaration_data if type.is_a?(Type)
+            type.element_types&.each&.with_index do |element_type, index|
+              associations(element_type, path.append(index), result, initial: false)
+            end
+          elsif type.array?
+            type = type.to_type_declaration_from_declaration_data if type.is_a?(Type)
+            element_type = type.element_type
+
+            if element_type
+              associations(element_type, path.append(:"#"), result, initial: false)
+            end
+          elsif type.attributes?
+            type = type.to_type_declaration_from_declaration_data if type.is_a?(Type)
+            type.attribute_declarations.each_pair do |attribute_name, element_type|
+              associations(element_type, path.append(attribute_name), result, initial: false)
+            end
+          # :nocov:
+          elsif type.associative_array?
+            if contains_associations?(type)
+              raise "Associative array types with associations in them are not currently supported. " \
+                    "Use attributes type if you can or set the key_type and/or value_type to duck type"
+            end
+          end
+          # :nocov:
+
+          result
+        end
+      end
+
       self.category_symbol = :type
 
       optional_keys :delegates

data/projects/manifest/src/root_manifest.rb

@@ -25,6 +25,10 @@ module Foobara
         organizations.map(&:commands).flatten
       end
 
+      def queries
+        commands.select(&:query?)
+      end
+
       def types
         @types ||= DataPath.value_at(:type, root_manifest).keys.map do |reference|
           Type.new(root_manifest, [:type, reference])

data/projects/manifest/src/tuple.rb

@@ -0,0 +1,15 @@
+require_relative "type_declaration"
+
+module Foobara
+  module Manifest
+    class Tuple < TypeDeclaration
+      alias tuple_manifest relevant_manifest
+
+      def element_types
+        @element_types ||= (0...element_type_declarations.size).map do |index|
+          TypeDeclaration.new(root_manifest, [*manifest_path, :element_type_declarations, index])
+        end
+      end
+    end
+  end
+end

data/projects/manifest/src/type.rb

@@ -38,6 +38,22 @@ module Foobara
         !builtin? && extends_symbol?(:model)
       end
 
+      def array?
+        !builtin? && extends_symbol?(:array)
+      end
+
+      def attributes?
+        !builtin? && extends_symbol?(:attributes)
+      end
+
+      def associative_array?
+        !builtin? && extends_symbol?(:associative_array)
+      end
+
+      def tuple?
+        !builtin? && extends_symbol?(:tuple)
+      end
+
       def base_type
         base_type_symbol = self[:base_type]
 

data/projects/manifest/src/type_declaration.rb

@@ -15,6 +15,8 @@ module Foobara
               Attributes.new(type_declaration.root_manifest, type_declaration.manifest_path)
             when :array
               Array.new(type_declaration.root_manifest, type_declaration.manifest_path)
+            when :tuple
+              Tuple.new(type_declaration.root_manifest, type_declaration.manifest_path)
             else
               type_declaration
             end
@@ -82,6 +84,14 @@ module Foobara
         type.to_sym == :array
       end
 
+      def tuple?
+        type.to_sym == :tuple
+      end
+
+      def associative_array?
+        type.to_sym == :associative_array
+      end
+
       def model?
         return @model if defined?(@model)
 

data/version.rb

@@ -1,6 +1,6 @@
 module Foobara
   module Version
-    VERSION = "0.5.5".freeze
+    VERSION = "0.5.7".freeze
     MINIMUM_RUBY_VERSION = ">= 3.4.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.7
 platform: ruby
 authors:
 - Miles Georgi
@@ -84,7 +84,7 @@ files:
 - projects/command/src/command.rb
 - projects/command/src/command_pattern_implementation.rb
 - projects/command/src/command_pattern_implementation/concerns/callbacks.rb
-- projects/command/src/command_pattern_implementation/concerns/description.rb
+- projects/command/src/command_pattern_implementation/concerns/command_data.rb
 - projects/command/src/command_pattern_implementation/concerns/domain_mappers.rb
 - projects/command/src/command_pattern_implementation/concerns/entities.rb
 - projects/command/src/command_pattern_implementation/concerns/errors.rb
@@ -102,6 +102,7 @@ files:
 - projects/command/src/extensions/domain/domain_module_extension.rb
 - projects/command/src/extensions/domain/domain_module_extension_extension.rb
 - projects/command/src/extensions/foobara.rb
+- projects/command/src/query.rb
 - projects/command/src/state_machine.rb
 - projects/command_connectors/Guardfile
 - projects/command_connectors/lib/foobara/command_connectors.rb
@@ -339,10 +340,12 @@ files:
 - projects/entities_plumbing/src/extensions/authenticator.rb
 - projects/manifest/Guardfile
 - projects/manifest/lib/foobara/manifest.rb
+- projects/manifest/spec/associations_spec.rb
 - projects/manifest/spec/manifest_spec.rb
 - projects/manifest/spec/model_spec.rb
 - projects/manifest/spec/spec_helper.rb
 - projects/manifest/spec/type_declaration_spec.rb
+- projects/manifest/spec/type_spec.rb
 - projects/manifest/src/array.rb
 - projects/manifest/src/attributes.rb
 - projects/manifest/src/base_manifest.rb
@@ -357,6 +360,7 @@ files:
 - projects/manifest/src/processor.rb
 - projects/manifest/src/processor_class.rb
 - projects/manifest/src/root_manifest.rb
+- projects/manifest/src/tuple.rb
 - projects/manifest/src/type.rb
 - projects/manifest/src/type_declaration.rb
 - projects/model_plumbing/lib/foobara/model_plumbing.rb