iknow_view_models 3.4.4 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2845e303fc1acc67f0241e30586c39276f08720a824104f71416a5b9d63a8989
-  data.tar.gz: ae89dde77c602debb67793bc36a120739c6692802e227d1835f972b0d72f542f
+  metadata.gz: 0cb094f674e990ef9a67bbcb7b0ee260065356cdb6a56ee6e1b19582c320e96c
+  data.tar.gz: 5bb5c175e7fd30442794c2ff87687eb5dec132fa7da0d0128a1b012bd50131d6
 SHA512:
-  metadata.gz: 808e3772112084fb81efeb7b0229ec461d4318b2f74460e01e94cd4c57c197b6c10b1fe6b0c02f0efa995d9b27209d08de8a98ed2991b270387cdc2b7a6520b4
-  data.tar.gz: 6ffed3458c0a92ddc8a49580073bbc6827eed7be49b1c605ed7708fc995185c825df57d583fd27305d45b4425b806faf0655a81a3eb7be5f9f64cdec9d09dedc
+  metadata.gz: f196d4af404bcb91d88519e04ed2afcd7d73c590af4838e16b32b4f73171d20500a4a092cb76d693d7a683bf4ca6ad337d5e79a10a5233870f9c244acfffe969
+  data.tar.gz: bfdd726357dc50f72732498d112274301089ab82719e46d7c5d7bfc5414a6bcf3dc12459bb9dee6ffa9c174dea1c81e2a0499649d9bbe1d1618702bfad18ef04

data/lib/iknow_view_models/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IknowViewModels
-  VERSION = '3.4.4'
+  VERSION = '3.5.0'
 end

data/lib/view_model.rb

@@ -12,6 +12,10 @@ class ViewModel
   VERSION_ATTRIBUTE   = '_version'
   NEW_ATTRIBUTE       = '_new'
 
+  BULK_UPDATE_TYPE       = '_bulk_update'
+  BULK_UPDATES_ATTRIBUTE = 'updates'
+  BULK_UPDATE_ATTRIBUTE  = 'update'
+
   # Migrations leave a metadata attribute _migrated on any views that they
   # alter. This attribute is accessible as metadata when deserializing migrated
   # input, and is included in the output serialization sent to clients.
@@ -27,6 +31,14 @@ class ViewModel
     attr_reader   :view_aliases
     attr_writer   :view_name
 
+    # Boolean to indicate if the viewmodel is synthetic. Synthetic
+    # viewmodels are nearly-invisible glue. They're full viewmodels,
+    # but do not participate in hooks or registration. For example, a
+    # join table connecting A and B through T has a synthetic
+    # viewmodel T to represent the join model, but the external
+    # interface is a relationship of A to a list of Bs.
+    attr_accessor :synthetic
+
     def inherited(subclass)
       super
       subclass.initialize_as_viewmodel

data/lib/view_model/active_record.rb

@@ -35,14 +35,9 @@ class ViewModel::ActiveRecord < ViewModel::Record
 
   class << self
     attr_reader   :_list_attribute_name
-    attr_accessor :synthetic
 
     delegate :transaction, to: :model_class
 
-    def should_register?
-      super && !synthetic
-    end
-
     # Specifies that the model backing this viewmodel is a member of an
     # `acts_as_manual_list` collection.
     def acts_as_list(attr = :position)
@@ -368,6 +363,52 @@ class ViewModel::ActiveRecord < ViewModel::Record
     end
   end
 
+  # Rails 6.1 introduced "previously_new_record?", but this library still
+  # supports activerecord >= 5.0. This is an approximation.
+  def self.model_previously_new?(model)
+    if (id_changes = model.saved_change_to_id)
+      old_id, _new_id = id_changes
+      return true if old_id.nil?
+    end
+    false
+  end
+
+  # Helper to return entities that were part of the last deserialization. The
+  # interface is complex due to the data requirements, and the implementation is
+  # inefficient.
+  #
+  # Intended to be used by replace_associated style methods which may touch very
+  # large collections that must not be returned fully. Since the collection is
+  # not being returned, order is also ignored.
+  def _read_association_touched(association_name, touched_ids:)
+    association_data = self.class._association_data(association_name)
+
+    associated = model.public_send(association_data.direct_reflection.name)
+    return nil if associated.nil?
+
+    case
+    when association_data.through?
+      # associated here are join-table models; we need to get the far side out
+      associated.map do |through_model|
+        model = through_model.public_send(association_data.indirect_reflection.name)
+
+        next unless self.class.model_previously_new?(through_model) || touched_ids.include?(model.id)
+
+        association_data.viewmodel_class_for_model!(model.class).new(model)
+      end.reject(&:nil?)
+    when association_data.collection?
+      associated.map do |model|
+        next unless self.class.model_previously_new?(model) || touched_ids.include?(model.id)
+
+        association_data.viewmodel_class_for_model!(model.class).new(model)
+      end.reject(&:nil?)
+    else
+      # singleton always touched by definition
+      model = associated
+      association_data.viewmodel_class_for_model!(model.class).new(model)
+    end
+  end
+
   def _serialize_association(association_name, json, serialize_context:)
     associated = self.public_send(association_name)
     association_data = self.class._association_data(association_name)

data/lib/view_model/active_record/association_manipulation.rb

@@ -3,6 +3,8 @@
 # Mix-in for VM::ActiveRecord providing direct manipulation of
 # directly-associated entities. Avoids loading entire collections.
 module ViewModel::ActiveRecord::AssociationManipulation
+  extend ActiveSupport::Concern
+
   def load_associated(association_name, scope: nil, eager_include: true, serialize_context: self.class.new_serialize_context)
     association_data = self.class._association_data(association_name)
     direct_reflection = association_data.direct_reflection
@@ -49,49 +51,63 @@ module ViewModel::ActiveRecord::AssociationManipulation
     end
   end
 
-  # Replace the current member(s) of an association with the provided hash(es).
+  # Replace the current member(s) of an association with the provided
+  # hash(es).  Only mentioned member(s) will be returned.
+  #
+  # This interface deals with associations directly where reasonable,
+  # with the notable exception of referenced+shared associations. That
+  # is to say, that owned associations should be presented in the form
+  # of direct update hashes, regardless of their
+  # referencing. Reference and shared associations are excluded to
+  # ensure that the update hash for a shared entity is unique, and
+  # that edits may only be specified once.
   def replace_associated(association_name, update_hash, references: {}, deserialize_context: self.class.new_deserialize_context)
-    association_data = self.class._association_data(association_name)
-
-    if association_data.referenced?
-      is_fupdate =
-        association_data.collection? &&
-        update_hash.is_a?(Hash) &&
-        update_hash[ViewModel::ActiveRecord::TYPE_ATTRIBUTE] == ViewModel::ActiveRecord::FUNCTIONAL_UPDATE_TYPE
-
-      if is_fupdate
-        update_hash[ViewModel::ActiveRecord::ACTIONS_ATTRIBUTE].each_with_index do |action, i|
-          action_type_name = action[ViewModel::ActiveRecord::TYPE_ATTRIBUTE]
-          if action_type_name == ViewModel::ActiveRecord::FunctionalUpdate::Remove::NAME
-            # Remove actions are always type/id refs; others need to be translated to proper refs
-            next
-          end
+    _updated_parent, changed_children =
+      self.class.replace_associated_bulk(
+        association_name,
+        { self.id => update_hash },
+        references: references,
+        deserialize_context: deserialize_context
+      ).first
+
+    changed_children
+  end
 
-          association_references = convert_updates_to_references(
-            action[ViewModel::ActiveRecord::VALUES_ATTRIBUTE],
-            key: "#{action_type_name}_#{i}")
-          references.merge!(association_references)
-          action[ViewModel::ActiveRecord::VALUES_ATTRIBUTE] =
-            association_references.each_key.map { |ref| { ViewModel::REFERENCE_ATTRIBUTE => ref } }
-        end
-      else
-        update_hash = ViewModel::Utils.wrap_one_or_many(update_hash) do |sh|
-          association_references = convert_updates_to_references(sh, key: 'replace')
-          references.merge!(association_references)
-          association_references.each_key.map { |ref| { ViewModel::REFERENCE_ATTRIBUTE => ref } }
-        end
+  class_methods do
+    # Replace the current member(s) of an association with the provided
+    # hash(es) for many viewmodels.  Only mentioned members will be returned.
+    #
+    # This is an interim implementation that requires loading the contents of
+    # all collections into memory and filtering for the mentioned entities,
+    # even for functional updates.  This is in contrast to append_associated,
+    # which only operates on the new entities.
+    def replace_associated_bulk(association_name, updates_by_parent_id, references:, deserialize_context: self.class.new_deserialize_context)
+      association_data = _association_data(association_name)
+
+      touched_ids = updates_by_parent_id.each_with_object({}) do |(parent_id, update_hash), acc|
+        acc[parent_id] =
+          mentioned_children(
+            update_hash,
+            references:       references,
+            association_data: association_data,
+          ).to_set
       end
-    end
 
-    root_update_hash = {
-      ViewModel::ID_ATTRIBUTE   => self.id,
-      ViewModel::TYPE_ATTRIBUTE => self.class.view_name,
-      association_name.to_s     => update_hash,
-    }
+      root_update_hashes = updates_by_parent_id.map do |parent_id, update_hash|
+        {
+          ViewModel::ID_ATTRIBUTE   => parent_id,
+          ViewModel::TYPE_ATTRIBUTE => view_name,
+          association_name.to_s     => update_hash,
+        }
+      end
 
-    root_update_viewmodel = self.class.deserialize_from_view(root_update_hash, references: references, deserialize_context: deserialize_context)
+      root_update_viewmodels = deserialize_from_view(
+        root_update_hashes, references: references, deserialize_context: deserialize_context)
 
-    root_update_viewmodel._read_association(association_name)
+      root_update_viewmodels.each_with_object({}) do |updated, acc|
+        acc[updated] = updated._read_association_touched(association_name, touched_ids: touched_ids.fetch(updated.id))
+      end
+    end
   end
 
   # Create or update members of a associated collection. For an ordered
@@ -313,7 +329,10 @@ module ViewModel::ActiveRecord::AssociationManipulation
     indirect_update_data, referenced_update_data = ViewModel::ActiveRecord::UpdateData.parse_hashes(subtree_hashes, references)
 
     # Convert associated update data to references
-    indirect_references = convert_updates_to_references(indirect_update_data, key: 'indirect_append')
+    indirect_references =
+      self.class.convert_updates_to_references(
+        indirect_update_data, key: 'indirect_append')
+
     referenced_update_data.merge!(indirect_references)
 
     # Find any existing models for the direct association: need to re-use any
@@ -352,12 +371,6 @@ module ViewModel::ActiveRecord::AssociationManipulation
     return direct_update_data, referenced_update_data
   end
 
-  def convert_updates_to_references(indirect_update_data, key:)
-    indirect_update_data.each.with_index.with_object({}) do |(update, i), indirect_references|
-      indirect_references["__#{key}_ref_#{i}"] = update
-    end
-  end
-
   # TODO: this functionality could reasonably be extracted into `acts_as_manual_list`.
   def select_append_positions(association_data, position_attr, append_count, before:, after:)
     direct_reflection = association_data.direct_reflection
@@ -401,4 +414,128 @@ module ViewModel::ActiveRecord::AssociationManipulation
               "Need to specify target viewmodel type for polymorphic association '#{association_data.association_name}'")
     end
   end
+
+  class_methods do
+    def convert_updates_to_references(indirect_update_data, key:)
+      indirect_update_data.each.with_index.with_object({}) do |(update, i), indirect_references|
+        indirect_references["__#{key}_ref_#{i}"] = update
+      end
+    end
+
+    def add_reference_indirection(update_hash, association_data:, references:, key:)
+      raise ArgumentError.new('Not a referenced association') unless association_data.referenced?
+
+      is_fupdate =
+        association_data.collection? &&
+          update_hash.is_a?(Hash) &&
+          update_hash[ViewModel::ActiveRecord::TYPE_ATTRIBUTE] == ViewModel::ActiveRecord::FUNCTIONAL_UPDATE_TYPE
+
+      if is_fupdate
+        update_hash[ViewModel::ActiveRecord::ACTIONS_ATTRIBUTE].each_with_index do |action, i|
+          action_type_name = action[ViewModel::ActiveRecord::TYPE_ATTRIBUTE]
+          if action_type_name == ViewModel::ActiveRecord::FunctionalUpdate::Remove::NAME
+            # Remove actions are always type/id refs; others need to be translated to proper refs
+            next
+          end
+
+          association_references = convert_updates_to_references(
+            action[ViewModel::ActiveRecord::VALUES_ATTRIBUTE],
+            key: "#{key}_#{action_type_name}_#{i}")
+          references.merge!(association_references)
+          action[ViewModel::ActiveRecord::VALUES_ATTRIBUTE] =
+            association_references.each_key.map { |ref| { ViewModel::REFERENCE_ATTRIBUTE => ref } }
+        end
+
+        update_hash
+      else
+        ViewModel::Utils.wrap_one_or_many(update_hash) do |sh|
+          association_references = convert_updates_to_references(sh, key: "#{key}_replace")
+          references.merge!(association_references)
+          association_references.each_key.map { |ref| { ViewModel::REFERENCE_ATTRIBUTE => ref } }
+        end
+      end
+    end
+
+    # Traverses literals and fupdates to return referenced children.
+    #
+    # Runs before the main parser, so must be defensive
+    def each_child_hash(assoc_update, association_data:)
+      return enum_for(__method__, assoc_update, association_data: association_data) unless block_given?
+
+      is_fupdate =
+        association_data.collection? &&
+          assoc_update.is_a?(Hash) &&
+          assoc_update[ViewModel::ActiveRecord::TYPE_ATTRIBUTE] == ViewModel::ActiveRecord::FUNCTIONAL_UPDATE_TYPE
+
+      if is_fupdate
+        assoc_update.fetch(ViewModel::ActiveRecord::ACTIONS_ATTRIBUTE).each do |action|
+          action_type_name = action[ViewModel::ActiveRecord::TYPE_ATTRIBUTE]
+          if action_type_name.nil?
+            raise ViewModel::DeserializationError::InvalidSyntax.new(
+              "Functional update missing '#{ViewModel::ActiveRecord::TYPE_ATTRIBUTE}'"
+            )
+          end
+
+          if action_type_name == ViewModel::ActiveRecord::FunctionalUpdate::Remove::NAME
+            # Remove actions are not considered children of the action.
+            next
+          end
+
+          values = action.fetch(ViewModel::ActiveRecord::VALUES_ATTRIBUTE) {
+            raise ViewModel::DeserializationError::InvalidSyntax.new(
+              "Functional update missing '#{ViewModel::ActiveRecord::VALUES_ATTRIBUTE}'"
+            )
+          }
+          values.each { |x| yield x }
+        end
+      else
+        ViewModel::Utils.wrap_one_or_many(assoc_update) do |assoc_updates|
+          assoc_updates.each { |u| yield u }
+        end
+      end
+    end
+
+    # Collects the ids of children that are mentioned in the update data.
+    #
+    # Runs before the main parser, so must be defensive.
+    def mentioned_children(assoc_update, references:, association_data:)
+      return enum_for(__method__, assoc_update, references: references, association_data: association_data) unless block_given?
+
+      each_child_hash(assoc_update, association_data: association_data).each do |child_hash|
+        unless child_hash.is_a?(Hash)
+          raise ViewModel::DeserializationError::InvalidSyntax.new(
+            "Expected update hash, received: #{child_hash}"
+          )
+        end
+
+        if association_data.referenced?
+          ref_handle = child_hash.fetch(ViewModel::REFERENCE_ATTRIBUTE) {
+            raise ViewModel::DeserializationError::InvalidSyntax.new(
+              "Reference hash missing '#{ViewModel::REFERENCE_ATTRIBUTE}'"
+            )
+          }
+
+          ref_update_hash = references.fetch(ref_handle) {
+            raise ViewModel::DeserializationError::InvalidSyntax.new(
+              "Reference '#{ref_handle}' does not exist in references"
+            )
+          }
+
+          unless ref_update_hash.is_a?(Hash)
+            raise ViewModel::DeserializationError::InvalidSyntax.new(
+              "Expected update hash, received: #{child_hash}"
+            )
+          end
+
+          if (id = ref_update_hash[ViewModel::ID_ATTRIBUTE])
+            yield id
+          end
+        else
+          if (id = child_hash[ViewModel::ID_ATTRIBUTE])
+            yield id
+          end
+        end
+      end
+    end
+  end
 end

data/lib/view_model/active_record/collection_nested_controller.rb

@@ -3,8 +3,7 @@
 require 'view_model/active_record/nested_controller_base'
 
 # Controller mixin for accessing a root ViewModel which can be accessed in a
-# collection by a parent model. Enabled by calling `nested_in :parent, as:
-# :children` on the viewmodel controller
+# collection by a parent model.
 
 # Contributes the following routes:
 # PUT    /parents/:parent_id/children            #append  -- deserialize (possibly existing) children and append to collection
@@ -32,6 +31,10 @@ module ViewModel::ActiveRecord::CollectionNestedController
     write_association(serialize_context: serialize_context, deserialize_context: deserialize_context, lock_owner: lock_owner, &block)
   end
 
+  def replace_bulk(serialize_context: new_serialize_context, deserialize_context: new_deserialize_context, &block)
+    write_association_bulk(serialize_context: serialize_context, deserialize_context: deserialize_context, &block)
+  end
+
   def disassociate_all(serialize_context: new_serialize_context, deserialize_context: new_deserialize_context, lock_owner: nil)
     destroy_association(true, serialize_context: serialize_context, deserialize_context: deserialize_context, lock_owner: lock_owner)
   end

data/lib/view_model/active_record/controller_base.rb

@@ -102,15 +102,35 @@ module ActionDispatch
         def arvm_resources(resource_name, options = {}, &block)
           except             = options.delete(:except) { [] }
           add_shallow_routes = options.delete(:add_shallow_routes) { true }
+          defaults           = options.delete(:defaults) { {} }
 
           nested = shallow_nesting_depth > 0
 
+          association_name = options.delete(:association_name) { resource_name.to_s }
+          owner_viewmodel  = options.delete(:owner_viewmodel) do
+            if nested
+              parent_resource.name.to_s.singularize.camelize
+            end
+          end
+
+          defaults = {
+            association_name: association_name,
+            owner_viewmodel: owner_viewmodel,
+          }.merge(defaults)
+
           only_routes = []
           only_routes += [:create] unless nested
           only_routes += [:show, :destroy] if add_shallow_routes
           only_routes -= except
 
-          resources resource_name, shallow: true, only: only_routes, **options do
+          # Bulk replace
+          if nested && !except.include?(:replace_bulk)
+            collection do
+              post resource_name, controller: resource_name, action: :replace_bulk, as: nil, defaults: defaults
+            end
+          end
+
+          resources resource_name, shallow: true, only: only_routes, defaults: defaults, **options do
             instance_eval(&block) if block_given?
 
             if nested
@@ -149,16 +169,35 @@ module ActionDispatch
         def arvm_resource(resource_name, options = {}, &block)
           except             = options.delete(:except) { [] }
           add_shallow_routes = options.delete(:add_shallow_routes) { true }
+          defaults           = options.delete(:defaults) { {} }
 
           only_routes = []
-          is_shallow = false
-          resource resource_name, shallow: true, only: only_routes, **options do
-            is_shallow = shallow_nesting_depth > 1
+          nested = shallow_nesting_depth > 0
+
+          association_name = options.delete(:association_name) { resource_name.to_s }
+          owner_viewmodel  = options.delete(:owner_viewmodel) do
+            if nested
+              parent_resource.name.to_s.singularize.camelize
+            end
+          end
+
+          defaults = {
+            association_name: association_name,
+            owner_viewmodel: owner_viewmodel,
+          }.merge(defaults)
+
+          if nested && !except.include?(:create_associated_bulk)
+            collection do
+              post resource_name, controller: resource_name, action: :create_associated_bulk, as: nil, defaults: defaults
+            end
+          end
+
+          resource resource_name, shallow: true, only: only_routes, defaults: defaults, **options do
             instance_eval(&block) if block_given?
 
             name_route = { as: '' } # Only one route may take the name
 
-            if is_shallow
+            if nested
               post('',   action: :create_associated,  **name_route.extract!(:as)) unless except.include?(:create)
               get('',    action: :show_associated,    **name_route.extract!(:as)) unless except.include?(:show)
               delete('', action: :destroy_associated, **name_route.extract!(:as)) unless except.include?(:destroy)
@@ -170,7 +209,7 @@ module ActionDispatch
           end
 
           # singularly nested resources provide collection accessors at the top level
-          if is_shallow && add_shallow_routes
+          if nested && add_shallow_routes
             resources resource_name.to_s.pluralize, shallow: true, only: [:show, :destroy] - except do
               shallow_scope do
                 collection do