foobara 0.5.10 → 0.6.0

data/projects/entities/projects/persistence/src/persistence.rb

@@ -8,9 +8,9 @@ module Foobara
 
       def default_crud_driver=(crud_driver)
         if default_crud_driver
-          # :nocov:
+          # simplecov:disable
           raise "Default crud driver already set."
-          # :nocov:
+          # simplecov:enable
         end
 
         @default_crud_driver = crud_driver
@@ -32,13 +32,13 @@ module Foobara
         bases = objects_to_bases(objects)
 
         if bases.empty?
-          # :nocov:
+          # simplecov:disable
           raise "No bases found for #{objects}"
-          # :nocov:
+          # simplecov:enable
         end
 
         if bases.size == 1
-          bases.first.transaction(mode, &)
+          bases[0].transaction(mode, &)
         else
           Foobara::TransactionGroup.run(bases:, mode:, &)
         end
@@ -55,9 +55,9 @@ module Foobara
         tx = base.current_transaction
 
         unless tx
-          # :nocov:
+          # simplecov:disable
           raise NoTransactionOpenError
-          # :nocov:
+          # simplecov:enable
         end
 
         tx
@@ -75,18 +75,18 @@ module Foobara
         bases = to_bases(object)
 
         if bases.empty?
-          # :nocov:
+          # simplecov:disable
           raise "Could not find a base for #{object}"
-          # :nocov:
+          # simplecov:enable
         end
 
         if bases.size > 1
-          # :nocov:
+          # simplecov:disable
           raise "Expected to only find 1 base for #{object} but found #{bases.size}"
-          # :nocov:
+          # simplecov:enable
         end
 
-        bases.first
+        bases[0]
       end
 
       def to_bases(object)
@@ -118,9 +118,9 @@ module Foobara
         when Entity
           base_for_entity_class(object.class)
         else
-          # :nocov:
+          # simplecov:disable
           raise ArgumentError, "Not able to convert #{object} to an entity base"
-          # :nocov:
+          # simplecov:enable
         end
       end
 
@@ -147,30 +147,30 @@ module Foobara
           base.register_table(table)
           tables_for_entity_class_name[entity_class_name] = table
         else
-          # :nocov:
+          # simplecov:disable
           raise NoTableOrCrudDriverError,
                 "Can't find table for #{entity_class_name} and can't dynamically build one without default crud driver."
-          # :nocov:
+          # simplecov:enable
         end
       end
 
       def register_base(*args, name: nil, table_prefix: nil)
         base = case args
                in [EntityBase]
-                 args.first
+                 args[0]
                in [Class => crud_driver_class, *rest] if crud_driver_class < EntityAttributesCrudDriver
                  unless name
-                   # :nocov:
+                   # simplecov:disable
                    raise ArgumentError, "Must provide name: when registering a base with a crud driver class"
-                   # :nocov:
+                   # simplecov:enable
                  end
 
                  crud_args, opts = case rest
                                    in [Hash]
                                      # TODO: test this code path
-                                     # :nocov:
+                                     # simplecov:disable
                                      [[], rest]
-                                     # :nocov:
+                                     # simplecov:enable
                                    in [] | [Array] | [Array, Hash]
                                      rest
                                    in Array
@@ -197,9 +197,9 @@ module Foobara
         missing = bases - sorted_bases
 
         unless missing.empty?
-          # :nocov:
+          # simplecov:disable
           raise ArgumentError, "Missing bases: #{missing} are the not registered or something?"
-          # :nocov:
+          # simplecov:enable
           # sorted_bases = [*missing, *sorted_bases]
         end
 

data/projects/entities/projects/weak_object_set/src/weak_object_set.rb

@@ -16,9 +16,9 @@ module Foobara
 
       def cleanup_proc
         if deactivated?
-          # :nocov:
+          # simplecov:disable
           raise "GarbageCleaner has been deactivated"
-          # :nocov:
+          # simplecov:enable
         end
 
         @cleanup_proc ||= begin
@@ -29,9 +29,9 @@ module Foobara
               begin
                 queue.push(object_id)
               rescue ClosedQueueError
-                # :nocov:
+                # simplecov:disable
                 deactivate
-                # :nocov:
+                # simplecov:enable
               end
             end
           end
@@ -50,9 +50,9 @@ module Foobara
               self.queue = nil
               break
             else
-              # :nocov:
+              # simplecov:disable
               raise "Unexpected nil value in the queue"
-              # :nocov:
+              # simplecov:enable
             end
           end
         end
@@ -101,9 +101,9 @@ module Foobara
         object = begin
           ref&.__getobj__
         rescue WeakRef::RefError
-          # :nocov:
+          # simplecov:disable
           nil
-          # :nocov:
+          # simplecov:enable
         end
 
         if ref&.weakref_alive?
@@ -159,9 +159,9 @@ module Foobara
 
     def <<(object)
       if closed?
-        # :nocov:
+        # simplecov:disable
         raise "Cannot add objects to a closed WeakObjectSet"
-        # :nocov:
+        # simplecov:enable
       end
 
       object_id = object.object_id
@@ -171,7 +171,7 @@ module Foobara
 
         if existing_object
           if key_method
-            key = object.send(key_method)
+            key = object.__send__(key_method)
             old_key = object_id_to_key[object_id]
 
             if key != old_key
@@ -189,7 +189,7 @@ module Foobara
           garbage_cleaner.track(object)
 
           if key_method
-            key = object.send(key_method)
+            key = object.__send__(key_method)
 
             if key
               existing_record_object_id = key_to_object_id[key]
@@ -197,9 +197,9 @@ module Foobara
               if existing_record_object_id
                 # Sometimes this path is hit in the test suite and sometimes not, depending on
                 # non-deterministic behavior of the garbage collector
-                # :nocov:
+                # simplecov:disable
                 delete(existing_record_object_id)
-                # :nocov:
+                # simplecov:enable
               end
 
               key_to_object_id[key] = object_id
@@ -237,9 +237,9 @@ module Foobara
     def find_by_key(key)
       monitor.synchronize do
         unless key_method
-          # :nocov:
+          # simplecov:disable
           raise "Cannot find by key if there was no key_method given."
-          # :nocov:
+          # simplecov:enable
         end
 
         object_id = key_to_object_id[key]

data/projects/entities/spec/builtin_types/detached_entity_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe ":detached_entity" do
       :SomeOrg,
       :SomeDomain
     ].each do |const|
-      Object.send(:remove_const, const) if Object.const_defined?(const)
+      Object.__send__(:remove_const, const) if Object.const_defined?(const)
     end
   end
 

data/projects/entities/spec/builtin_types/entity_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe ":entity" do
       :SomeOrg,
       :SomeDomain
     ].each do |const|
-      Object.send(:remove_const, const) if Object.const_defined?(const)
+      Object.__send__(:remove_const, const) if Object.const_defined?(const)
     end
   end
 

data/projects/entities/spec/builtin_types/model_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe ":model" do
       :SomeOrg,
       :SomeDomain
     ].each do |const|
-      Object.send(:remove_const, const) if Object.const_defined?(const)
+      Object.__send__(:remove_const, const) if Object.const_defined?(const)
     end
   end
 

data/projects/entities/spec/entity/extending_existing_spec.rb

@@ -2,7 +2,7 @@ RSpec.describe Foobara::Model do
   after do
     Foobara.reset_alls
     if Object.const_defined?(:User)
-      Object.send(:remove_const, :User)
+      Object.__send__(:remove_const, :User)
     end
   end
 

data/projects/entities/spec/entity/from_type_declaration_spec.rb

@@ -3,7 +3,7 @@ RSpec.describe Foobara::Entity do
     after do
       Foobara.reset_alls
 
-      Object.send(:remove_const, :User) if Object.const_defined?(:User)
+      Object.__send__(:remove_const, :User) if Object.const_defined?(:User)
     end
 
     let(:declaration_data) do

data/projects/entities/spec/model/model_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe Foobara::Model do
       :SomeEntity,
       :Foo
     ].each do |const|
-      Object.send(:remove_const, const) if Object.const_defined?(const)
+      Object.__send__(:remove_const, const) if Object.const_defined?(const)
     end
   end
 
@@ -117,7 +117,7 @@ RSpec.describe Foobara::Model do
 
       after do
         if Object.const_defined?(:Foo)
-          Object.send(:remove_const, :Foo)
+          Object.__send__(:remove_const, :Foo)
         end
       end
 

data/projects/entities/spec/spec_helper.rb

@@ -17,7 +17,7 @@ SimpleCov.command_name "entities"
 SimpleCov.coverage_dir "coverage/entities"
 
 SimpleCov.start do
-  add_filter "spec/support/"
+  skip "spec/support/"
   # This avoids printing out info about coverage generated by HTTPFormatter
   formatter Class.new { def format(_result) = nil }
 end

data/projects/entities_plumbing/lib/foobara/entities_plumbing.rb

@@ -2,12 +2,16 @@ module Foobara
   module EntitiesPlumbing
     class << self
       def install!
+        CommandPatternImplementation.include CommandPatternImplementation::Concerns::Transactions
         CommandPatternImplementation.include CommandPatternImplementation::Concerns::Entities
+        CommandPatternImplementation.include CommandPatternImplementation::Concerns::EntityInputs
+        CommandPatternImplementation.include CommandPatternImplementation::Concerns::EntityErrorsType
+        CommandPatternImplementation.include CommandPatternImplementation::Concerns::EntityReflection
 
         if Foobara.project_installed?("command_connectors")
-          # :nocov:
+          # simplecov:disable
           install_command_connector_extension
-          # :nocov:
+          # simplecov:enable
         end
       end
 

data/projects/entities_plumbing/spec/inputs_spec.rb

@@ -0,0 +1,54 @@
+RSpec.describe Foobara::CommandPatternImplementation::Concerns::Entities do
+  describe "#run" do
+    after { Foobara.reset_alls }
+
+    before do
+      Foobara::Persistence.default_crud_driver = Foobara::Persistence::CrudDrivers::InMemory.new
+    end
+
+    context "when passing entity type as the inputs" do
+      let(:read_command) do
+        user_class
+        stub_class(:ReadUser, Foobara::Command) do
+          inputs User
+        end
+      end
+
+      context "when entity has no primary key yet" do
+        let(:user_class) do
+          stub_class :User, Foobara::Entity do
+            attributes name: { type: :string, required: true }
+          end
+        end
+
+        it "results in a MissingPrimaryKeyError" do
+          expect {
+            read_command
+          }.to raise_error(
+            Foobara::TypeDeclarations::Handlers::RegisteredTypeDeclaration::
+                ValidatePrimaryKeyPresent::MissingPrimaryKeyError
+          )
+        end
+      end
+
+      context "when entity has primary key" do
+        let(:user_class) do
+          stub_class :User, Foobara::Entity do
+            attributes do
+              name :string, :required
+              id :integer
+            end
+
+            primary_key :id
+          end
+        end
+
+        it "results in a MissingPrimaryKeyError" do
+          expect {
+            read_command
+          }.to raise_error(Foobara::CommandPatternImplementation::BadCommandInputsError)
+        end
+      end
+    end
+  end
+end

data/projects/entities_plumbing/spec/spec_helper.rb

@@ -17,7 +17,7 @@ SimpleCov.command_name "entities_plumbing"
 SimpleCov.coverage_dir "coverage/entities_plumbing"
 
 SimpleCov.start do
-  add_filter "spec/support/"
+  skip "spec/support/"
   # This avoids printing out info about coverage generated by HTTPFormatter
   formatter Class.new { def format(_result) = nil }
 end

data/projects/entities_plumbing/spec/transaction_spec.rb

@@ -186,9 +186,9 @@ RSpec.describe Foobara::CommandPatternImplementation::Concerns::Entities do
         error = errors.first
 
         expect(error.class.name).to eq("ReadEmployee::EmployeeNotFoundError")
-        expect(error.key).to eq("runtime.employee_not_found")
+        expect(error.key).to eq("data.employee.not_found")
 
-        expect(error.symbol).to be(:employee_not_found)
+        expect(error.symbol).to be(:not_found)
 
         context = error.context
 

data/projects/entities_plumbing/src/extensions/command_pattern_implementation/concerns/entities.rb

@@ -5,6 +5,18 @@ module Foobara
         include Concern
 
         module ClassMethods
+          def inputs(...)
+            if defined?(@entity_class_paths)
+              remove_instance_variable(:@entity_class_paths)
+            end
+
+            if defined?(@inputs_association_paths)
+              remove_instance_variable(:@inputs_association_paths)
+            end
+
+            super
+          end
+
           # Only needed for entities not discoverable through the inputs
           def depends_on_entities(*entities_to_add)
             if entities_to_add.empty?
@@ -26,8 +38,6 @@ module Foobara
             ).transform_values(&:target_class)
           end
 
-          # TODO: move to better concern!
-          # TODO: make work with inheritance
           def to_load(*paths)
             h = @to_load_paths_and_error_classes || {}
 
@@ -36,7 +46,7 @@ module Foobara
               entity_class = entity_class_paths[path.to_s]
               error_class = Entity::NotFoundError.subclass(self, entity_class, path)
               h[path.to_s] = error_class
-              possible_error(error_class)
+              possible_input_error(path, error_class)
             end
 
             @to_load_paths_and_error_classes = h.sort_by do |path, _error_class|
@@ -64,14 +74,20 @@ module Foobara
           begin
             # here... filter out created entities...
             if thunks_to_load.size == 1
-              entity_class.load(thunks_to_load.first)
+              entity_class.load(thunks_to_load[0])
             else
               entity_class.load_many(thunks_to_load)
             end
 
             thunks_to_load
           rescue Entity::NotFoundError => e
-            add_runtime_error(error_class.for(e.criteria))
+            error_data_path = DataPath.new(e.data_path)
+            error_data_path.prepend!(data_path)
+
+            error = error_class.for(e.criteria, data_path: error_data_path.to_s)
+            add_input_error(error)
+
+            halt!
           end
         end
 

data/projects/entities_plumbing/src/extensions/command_pattern_implementation/concerns/entity_errors_type.rb

@@ -0,0 +1,23 @@
+module Foobara
+  module CommandPatternImplementation
+    module Concerns
+      module EntityErrorsType
+        include Concern
+
+        module ClassMethods
+          def error_context_type_map
+            return @error_context_type_map if defined?(@error_context_type_map)
+
+            super
+
+            inputs_association_paths&.each do |data_path|
+              possible_input_error(data_path.to_sym, Entity::NotFoundError)
+            end
+
+            @error_context_type_map
+          end
+        end
+      end
+    end
+  end
+end

data/projects/entities_plumbing/src/extensions/command_pattern_implementation/concerns/entity_inputs.rb

@@ -0,0 +1,33 @@
+module Foobara
+  module CommandPatternImplementation
+    module Concerns
+      module EntityInputs
+        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
+
+          def skip_model_to_attributes_conversion?(type)
+            super || type.extends?(BuiltinTypes[:entity])
+          end
+        end
+      end
+    end
+  end
+end

data/projects/entities_plumbing/src/extensions/command_pattern_implementation/concerns/entity_reflection.rb

@@ -0,0 +1,39 @@
+module Foobara
+  module CommandPatternImplementation
+    module Concerns
+      module EntityReflection
+        include Concern
+
+        module ClassMethods
+          def types_depended_on
+            # These lookups are duplicative of the overriden method as well as other methods.
+            # Likely there's some way to DRY this up
+            remove_sensitive = TypeDeclarations.foobara_manifest_context_remove_sensitive?
+
+            if defined?(@types_depended_on) && @types_depended_on.key?(remove_sensitive)
+              return @types_depended_on[remove_sensitive]
+            end
+
+            @types_depended_on ||= {}
+            @types_depended_on[remove_sensitive] = begin
+              types = super
+
+              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
+          end
+        end
+      end
+    end
+  end
+end

data/projects/entities_plumbing/src/extensions/command_pattern_implementation/concerns/runtime.rb

@@ -0,0 +1,39 @@
+module Foobara
+  module CommandPatternImplementation
+    module Concerns
+      module Runtime
+        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
+                    e.prepend_path!(index)
+                    e.prepend_path!(data_path.path[..-2])
+
+                    add_input_error(e)
+                  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
+                  e.prepend_path!(data_path)
+                  add_input_error(e)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/projects/manifest/spec/spec_helper.rb

@@ -17,7 +17,7 @@ SimpleCov.command_name "manifest"
 SimpleCov.coverage_dir "coverage/manifest"
 
 SimpleCov.start do
-  add_filter "spec/support/"
+  skip "spec/support/"
   # This avoids printing out info about coverage generated by HTTPFormatter
   formatter Class.new { def format(_result) = nil }
 end

data/projects/manifest/src/base_manifest.rb

@@ -55,17 +55,17 @@ module Foobara
         self.manifest_path = manifest_path
 
         if relevant_manifest.nil?
-          # :nocov:
+          # simplecov:disable
           raise InvalidPath, "invalid path #{manifest_path}"
-          # :nocov:
+          # simplecov:enable
         end
       end
 
       def path
-        # :nocov:
+        # simplecov:disable
         warn "[DEPRECATION] `path` is deprecated. Please use `manifest_path` instead."
         manifest_path
-        # :nocov:
+        # simplecov:enable
       end
 
       def domain
@@ -91,11 +91,11 @@ module Foobara
       end
 
       def parent_category
-        self[:parent]&.first
+        self[:parent]&.[](0)
       end
 
       def parent_name
-        self[:parent]&.last
+        self[:parent]&.[](-1)
       end
 
       def scoped_category
@@ -103,7 +103,7 @@ module Foobara
       end
 
       def relevant_manifest
-        @relevant_manifest ||= Foobara::DataPath.values_at(manifest_path, root_manifest).first
+        @relevant_manifest ||= Foobara::DataPath.values_at(manifest_path, root_manifest)[0]
       end
 
       def find_type(type_declaration)
@@ -126,9 +126,9 @@ module Foobara
         elsif optional_key?(method_name)
           self.class.optional_key_defaults[method_name.to_sym]
         else
-          # :nocov:
+          # simplecov:disable
           super
-          # :nocov:
+          # simplecov:enable
         end
       end