iknow_view_models 3.4.2 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10bc5dca413705470b182157c2a38ebc2e11a7ae5a121ad328d03b35ff64f1d6
-  data.tar.gz: c31bf72ad0a62316705618344963e7ad78d29224b33c5472dc00ca9ec9413d75
+  metadata.gz: 1b538a2d547114ecfbb76bfc790daea11b2185abdbad54d5da82723bb7fa1bef
+  data.tar.gz: 97b7e6d1d66cae14d56fe53931d06a4079e5c9b4b61e60bf56027d539fd41224
 SHA512:
-  metadata.gz: 989ff044b31ae5bdcea3e489e0528c9d7d6115fc19193c11f0986985001c2bd0d6bb3c40ef99f331d525c466c09849b2218dcbad8169545106b3736e6da7360b
-  data.tar.gz: 6bb882161397c6ad72456dd8a5d9389fce1ce3be9c27347d8168790070072287e9e5ab669c6406504e67cff15fce1df6a58babc9ec59be542a9f2935f407a787
+  metadata.gz: 4f70185a7ba12a222eee6a1549f724c08754f7213a1c1594d5b2ea0060baac04fce839cb480615e02741adcc82cd2d910e8d82e519127da15efd6e14dbdf3b0b
+  data.tar.gz: 82a343d49bf61a6e351653c8a3e3855344b5dd017acc7722cc526e41af8915d6aedb028995f859354df23de82f55b2c342b2fa1a572af76b1690345fb120ae02

data/iknow_view_models.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'iknow_view_models'
   spec.version       = IknowViewModels::VERSION
   spec.authors       = ['iKnow Team']
-  spec.email         = ['edge@iknow.jp']
+  spec.email         = ['systems@iknow.jp']
   spec.summary       = 'ViewModels provide a means of encapsulating a collection of related data and specifying its JSON serialization.'
   spec.description   = ''
   spec.homepage      = 'https://github.com/iknow/cerego_view_models'
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 5.0'
 
   spec.add_dependency 'acts_as_manual_list'
-  spec.add_dependency 'deep_preloader', '>= 1.0.1'
+  spec.add_dependency 'deep_preloader', '>= 1.0.2'
   spec.add_dependency 'iknow_cache'
   spec.add_dependency 'iknow_params', '~> 2.2.0'
   spec.add_dependency 'keyword_builder'

data/lib/iknow_view_models/version.rb

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

data/lib/view_model/active_record/association_data.rb

@@ -127,7 +127,9 @@ class ViewModel::ActiveRecord::AssociationData
   end
 
   def polymorphic?
-    target_reflection.polymorphic?
+    # STI polymorphism isn't shown on the association reflection, so in that
+    # case we have to infer it by having multiple target viewmodel types.
+    target_reflection.polymorphic? || viewmodel_classes.size > 1
   end
 
   # The side of the immediate association that holds the pointer.

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
@@ -16,7 +18,7 @@ module ViewModel::ActiveRecord::AssociationManipulation
       associated_viewmodel = association_data.viewmodel_class
       direct_viewmodel     = association_data.direct_viewmodel
     else
-      raise ArgumentError.new('Polymorphic STI relationships not supported yet') if association_data.viewmodel_classes.size > 1
+      raise ArgumentError.new('Polymorphic STI relationships not supported yet') if association_data.polymorphic?
 
       associated_viewmodel = association.klass.try { |k| association_data.viewmodel_class_for_model!(k) }
       direct_viewmodel     = associated_viewmodel
@@ -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
@@ -118,7 +134,7 @@ module ViewModel::ActiveRecord::AssociationManipulation
             direct_viewmodel_class = association_data.direct_viewmodel
             root_update_data, referenced_update_data = construct_indirect_append_updates(association_data, subtree_hashes, references)
           else
-            raise ArgumentError.new('Polymorphic STI relationships not supported yet') if association_data.viewmodel_classes.size > 1
+            raise ArgumentError.new('Polymorphic STI relationships not supported yet') if association_data.polymorphic?
 
             direct_viewmodel_class = association_data.viewmodel_class
             root_update_data, referenced_update_data = construct_direct_append_updates(association_data, subtree_hashes, references)
@@ -242,7 +258,7 @@ module ViewModel::ActiveRecord::AssociationManipulation
           direct_viewmodel = association_data.direct_viewmodel
           association_scope = association_scope.where(association_data.indirect_reflection.foreign_key => associated_id)
         else
-          raise ArgumentError.new('Polymorphic STI relationships not supported yet') if association_data.viewmodel_classes.size > 1
+          raise ArgumentError.new('Polymorphic STI relationships not supported yet') if association_data.polymorphic?
 
           # viewmodel type for current association: nil in case of empty polymorphic association
           direct_viewmodel = association.klass.try { |k| association_data.viewmodel_class_for_model!(k) }
@@ -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
@@ -395,10 +408,134 @@ module ViewModel::ActiveRecord::AssociationManipulation
   def check_association_type!(association_data, type)
     if type && !association_data.accepts?(type)
       raise ViewModel::SerializationError.new(
-              "Type error: association '#{direct_reflection.name}' can't refer to viewmodel #{type.view_name}")
+              "Type error: association '#{association_data.association_name}' can't refer to viewmodel #{type.view_name}")
     elsif association_data.polymorphic? && !type
       raise ViewModel::SerializationError.new(
-              "Need to specify target viewmodel type for polymorphic association '#{direct_reflection.name}'")
+              "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/cloner.rb

@@ -52,22 +52,23 @@ class ViewModel::ActiveRecord::Cloner
           new_associated = associated
         else
           # Otherwise descend into the child, and attach the result
-          vm_class =
-            case
-            when association_data.through?
-              # descend into the synthetic join table viewmodel
-              association_data.direct_viewmodel
-            when association_data.collection?
-              association_data.viewmodel_class
-            else
-              association_data.viewmodel_class_for_model!(associated.class)
-            end
+          build_vm = ->(model) do
+            vm_class =
+              if association_data.through?
+                # descend into the synthetic join table viewmodel
+                association_data.direct_viewmodel
+              else
+                association_data.viewmodel_class_for_model!(model.class)
+              end
+
+            vm_class.new(model)
+          end
 
           new_associated =
             if ViewModel::Utils.array_like?(associated)
-              associated.map { |m| clone(vm_class.new(m)) }.compact
+              associated.map { |m| clone(build_vm.(m)) }.compact
             else
-              clone(vm_class.new(associated))
+              clone(build_vm.(associated))
             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