foobara 0.5.10 → 0.6.2

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

@@ -32,21 +32,21 @@ module Foobara
 
         def find_tracked(record_id)
           unless record_id
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "Cannot use a blank primary key value"
-            # :nocov:
+            # simplecov:enable
           end
 
           if record_id.is_a?(::String) && record_id.empty?
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "Cannot use a blank primary key value"
-            # :nocov:
+            # simplecov:enable
           end
 
           if record_id.is_a?(::Symbol) && record_id.to_s.empty?
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "Cannot use a blank primary key value"
-            # :nocov:
+            # simplecov:enable
           end
 
           tracked_records.find_by_key(record_id)
@@ -66,33 +66,33 @@ module Foobara
 
         def load(entity_or_record_id)
           if entity_or_record_id.nil?
-            # :nocov:
+            # simplecov:disable
             raise "Expected a record or record primary key but received nil"
-            # :nocov:
+            # simplecov:enable
           end
 
           if entity_or_record_id.is_a?(Entity)
             entity = if entity_or_record_id.persisted?
                        unless entity_or_record_id.primary_key
-                         # :nocov:
+                         # simplecov:disable
                          raise "Did not expect a record to be persisted but have no primary key"
-                         # :nocov:
+                         # simplecov:enable
                        end
 
                        tracked_records.find_by_key(entity_or_record_id.primary_key)
                      else
-                       # :nocov:
+                       # simplecov:disable
                        raise "Cannot load an unpersisted record!"
-                       # :nocov:
+                       # simplecov:enable
                      end
 
             # rubocop:disable Lint/IdentityComparison
             if entity &&
                (!entity.equal?(entity_or_record_id) || entity.object_id != entity_or_record_id.object_id)
-              # :nocov:
+              # simplecov:disable
               raise "This transaction is already tracking a different entity with the same primary key." \
                     "Try passing in the primary key instead of constructing an unloaded entity to pass in."
-              # :nocov:
+              # simplecov:enable
             end
             # rubocop:enable Lint/IdentityComparison
 
@@ -101,27 +101,27 @@ module Foobara
             record_id = entity_or_record_id
 
             if record_id.is_a?(::Hash)
-              # :nocov:
+              # simplecov:disable
               raise ArgumentError, "Unlikely that you meant to use a hash as a primary key"
-              # :nocov:
+              # simplecov:enable
             end
 
             unless record_id
-              # :nocov:
+              # simplecov:disable
               raise ArgumentError, "Cannot use a blank primary key value"
-              # :nocov:
+              # simplecov:enable
             end
 
             if record_id.is_a?(::String) && record_id.empty?
-              # :nocov:
+              # simplecov:disable
               raise ArgumentError, "Cannot use a blank primary key value"
-              # :nocov:
+              # simplecov:enable
             end
 
             if record_id.is_a?(::Symbol) && record_id.to_s.empty?
-              # :nocov:
+              # simplecov:disable
               raise ArgumentError, "Cannot use a blank primary key value"
-              # :nocov:
+              # simplecov:enable
             end
 
             entity = tracked_records.find_by_key(record_id)
@@ -136,9 +136,9 @@ module Foobara
               attributes = normalize_attributes(entity_attributes_crud_driver_table.find!(record_id))
 
               unless attributes
-                # :nocov:
+                # simplecov:disable
                 raise NoRecordFound, "could not find record for #{entity_class.full_entity_name}:#{record_id}"
-                # :nocov:
+                # simplecov:enable
               end
 
               entity.successfully_loaded(attributes)
@@ -147,9 +147,9 @@ module Foobara
             attributes = normalize_attributes(entity_attributes_crud_driver_table.find!(record_id))
 
             unless attributes
-              # :nocov:
+              # simplecov:disable
               raise NoRecordFound, "could not find record for #{entity_class.full_entity_name}:#{record_id}"
-              # :nocov:
+              # simplecov:enable
             end
 
             transaction.loaded(entity_class, attributes)
@@ -168,23 +168,23 @@ module Foobara
 
               entity = if entity_or_record_id.persisted?
                          unless entity_or_record_id.primary_key
-                           # :nocov:
+                           # simplecov:disable
                            raise "Did not expect a record to be persisted but have no primary key"
-                           # :nocov:
+                           # simplecov:enable
                          end
 
                          tracked_records.find_by_key(entity_or_record_id.primary_key)
                        else
-                         # :nocov:
+                         # simplecov:disable
                          raise "Cannot load an unpersisted record!"
-                         # :nocov:
+                         # simplecov:enable
                        end
 
               if entity && !entity.equal?(entity_or_record_id)
-                # :nocov:
+                # simplecov:disable
                 raise "This transaction is already tracking a different entity with the same primary key." \
                       "Try passing in the primary key instead of constructing an unloaded entity to pass in."
-                # :nocov:
+                # simplecov:enable
               end
 
               record_id = entity.primary_key
@@ -194,28 +194,28 @@ module Foobara
               record_id = entity_or_record_id
 
               if record_id.is_a?(::Hash)
-                # :nocov:
+                # simplecov:disable
                 raise ArgumentError, "Unlikely that you meant to use a hash as a primary key"
-                # :nocov:
+                # simplecov:enable
               end
 
               # TODO: encapsulate this record_id verification
               unless record_id
-                # :nocov:
+                # simplecov:disable
                 raise ArgumentError, "Cannot use a blank primary key value"
-                # :nocov:
+                # simplecov:enable
               end
 
               if record_id.is_a?(::String) && record_id.empty?
-                # :nocov:
+                # simplecov:disable
                 raise ArgumentError, "Cannot use a blank primary key value"
-                # :nocov:
+                # simplecov:enable
               end
 
               if record_id.is_a?(::Symbol) && record_id.to_s.empty?
-                # :nocov:
+                # simplecov:disable
                 raise ArgumentError, "Cannot use a blank primary key value"
-                # :nocov:
+                # simplecov:enable
               end
 
               entity = tracked_records.find_by_key(record_id)
@@ -323,9 +323,9 @@ module Foobara
                 # was already considered among tracked records if loaded? is true so do not return it as
                 # it has changed and no longer matches
                 # TODO: figure out how to test this code path
-                # :nocov:
+                # simplecov:disable
                 record = nil
-                # :nocov:
+                # simplecov:enable
               else
                 loading(record) do
                   record.successfully_loaded(found_attributes)
@@ -356,9 +356,9 @@ module Foobara
             when ::Array, Value::DataPath
               path_filters[attribute_name_or_path] = value
             else
-              # :nocov:
+              # simplecov:disable
               raise "Unexpected filter type: #{attribute_name_or_path.class}"
-              # :nocov:
+              # simplecov:enable
             end
           end
 
@@ -397,9 +397,9 @@ module Foobara
                   # was already considered among tracked records if loaded? is true so do not return it as
                   # it has changed and no longer matches
                   # TODO: figure out how to test this code path
-                  # :nocov:
+                  # simplecov:disable
                   record = nil
-                  # :nocov:
+                  # simplecov:enable
                 else
                   loading(record) do
                     record.successfully_loaded(found_attributes)
@@ -462,7 +462,7 @@ module Foobara
 
               if record
                 # TODO: test this code path
-                # :nocov:
+                # simplecov:disable
                 if record.loaded?
                   # was already considered among tracked records if loaded? is true so do not return it as
                   # it has changed and no longer matches
@@ -472,7 +472,7 @@ module Foobara
                     record.successfully_loaded(found_attributes)
                   end
                 end
-                # :nocov:
+                # simplecov:enable
               else
                 record = entity_class.loaded(found_attributes)
               end
@@ -526,7 +526,7 @@ module Foobara
 
               if record
                 # TODO: test this code path
-                # :nocov:
+                # simplecov:disable
                 if record.loaded?
                   # was already considered among tracked records if loaded? is true so do not return it as
                   # it has changed and no longer matches
@@ -536,7 +536,7 @@ module Foobara
                     record.successfully_loaded(found_attributes)
                   end
                 end
-                # :nocov:
+                # simplecov:enable
               else
                 record = entity_class.loaded(found_attributes)
               end
@@ -554,9 +554,9 @@ module Foobara
 
         def track_created(entity)
           if entity.persisted?
-            # :nocov:
+            # simplecov:disable
             raise "Cannot insert #{entity} because it's already persisted."
-            # :nocov:
+            # simplecov:enable
           end
 
           created(entity)

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

@@ -10,7 +10,7 @@ module Foobara
           if existing_transactions.empty?
             block.call
           elsif existing_transactions.size == 1
-            existing_transaction = existing_transactions.first
+            existing_transaction = existing_transactions[0]
 
             existing_transaction.entity_base.using_transaction(existing_transaction, &block)
           else
@@ -127,9 +127,9 @@ module Foobara
 
       def transaction(mode = nil, existing_transaction: nil)
         unless VALID_MODES.include?(mode)
-          # :nocov:
+          # simplecov:disable
           raise ArgumentError, "Mode was #{mode} but expected one of #{VALID_MODES}"
-          # :nocov:
+          # simplecov:enable
         end
 
         old_transaction = current_transaction
@@ -151,16 +151,16 @@ module Foobara
             open_nested = true
           elsif mode == :open_new
             if existing_transaction
-              # :nocov:
+              # simplecov:disable
               raise ArgumentError, "Cannot use mode :open_new with existing_transaction:"
-              # :nocov:
+              # simplecov:enable
             end
           else
-            # :nocov:
+            # simplecov:disable
             raise "Transaction already open. " \
                   "Use mode :use_existing if you want to make use of the existing transaction. " \
                   "Use mode :open_nested if you are actually trying to nest transactions."
-            # :nocov:
+            # simplecov:enable
           end
         end
 

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_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/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