iknow_view_models 3.4.2 → 3.5.1

data/lib/view_model/active_record/nested_controller_base.rb

@@ -7,9 +7,45 @@ require 'view_model/active_record/controller_base'
 module ViewModel::ActiveRecord::NestedControllerBase
   extend ActiveSupport::Concern
 
+  class ParentProxyModel < ViewModel
+    # Prevent this from appearing in hooks
+    self.synthetic = true
+
+    attr_reader :parent, :association_data, :changed_children
+
+    def initialize(parent, association_data, changed_children)
+      @parent = parent
+      @association_data = association_data
+      @changed_children = changed_children
+    end
+
+    def serialize(json, serialize_context:)
+      ViewModel::Callbacks.wrap_serialize(parent, context: serialize_context) do
+        child_context = parent.context_for_child(association_data.association_name, context: serialize_context)
+
+        json.set!(ViewModel::ID_ATTRIBUTE, parent.id)
+        json.set!(ViewModel::BULK_UPDATE_ATTRIBUTE) do
+          if association_data.referenced? && !association_data.owned?
+            if association_data.collection?
+              json.array!(changed_children) do |child|
+                ViewModel.serialize_as_reference(child, json, serialize_context: child_context)
+              end
+            else
+              ViewModel.serialize_as_reference(changed_children, json, serialize_context: child_context)
+            end
+          else
+            ViewModel.serialize(changed_children, json, serialize_context: child_context)
+          end
+        end
+      end
+    end
+  end
+
   protected
 
   def show_association(scope: nil, serialize_context: new_serialize_context, lock_owner: nil)
+    require_external_referenced_association!
+
     associated_views = nil
     pre_rendered = owner_viewmodel.transaction do
       owner_view = owner_viewmodel.find(owner_viewmodel_id, eager_include: false, lock: lock_owner)
@@ -27,11 +63,27 @@ module ViewModel::ActiveRecord::NestedControllerBase
     associated_views
   end
 
+  # This method always takes direct update hashes, and returns
+  # viewmodels directly.
+  #
+  # There's no multi membership, so when viewing the children of a
+  # single parent each child can only appear once. This means it's
+  # safe to use update hashes directly.
   def write_association(serialize_context: new_serialize_context, deserialize_context: new_deserialize_context, lock_owner: nil)
+    require_external_referenced_association!
+
     association_view = nil
     pre_rendered = owner_viewmodel.transaction do
       update_hash, refs = parse_viewmodel_updates
 
+      update_hash =
+        ViewModel::ActiveRecord.add_reference_indirection(
+          update_hash,
+          association_data: association_data,
+          references:       refs,
+          key:              'write-association',
+        )
+
       owner_view = owner_viewmodel.find(owner_viewmodel_id, eager_include: false, lock: lock_owner)
 
       association_view = owner_view.replace_associated(association_name, update_hash,
@@ -49,7 +101,67 @@ module ViewModel::ActiveRecord::NestedControllerBase
     association_view
   end
 
+  # This method takes direct update hashes for owned associations, and
+  # reference hashes for shared associations. The return value matches
+  # the input structure.
+  #
+  # If an association is referenced and owned, each child may only
+  # appear once so each is guaranteed to have a unique update
+  # hash. This means it's only safe to use update hashes directly in
+  # this case.
+  def write_association_bulk(serialize_context: new_serialize_context, deserialize_context: new_deserialize_context, lock_owner: nil)
+    require_external_referenced_association!
+
+    updated_by_parent_viewmodel = nil
+
+    pre_rendered = owner_viewmodel.transaction do
+      updates_by_parent_id, references = parse_bulk_update
+
+      if association_data.owned?
+        updates_by_parent_id.transform_values!.with_index do |update_hash, index|
+          ViewModel::ActiveRecord.add_reference_indirection(
+            update_hash,
+            association_data: association_data,
+            references:       references,
+            key:              "write-association-bulk-#{index}",
+          )
+        end
+      end
+
+      updated_by_parent_viewmodel =
+        owner_viewmodel.replace_associated_bulk(
+          association_name,
+          updates_by_parent_id,
+          references:          references,
+          deserialize_context: deserialize_context,
+        )
+
+      views = updated_by_parent_viewmodel.flat_map { |_parent_viewmodel, updated_views| Array.wrap(updated_views) }
+
+      ViewModel.preload_for_serialization(views)
+
+      updated_by_parent_viewmodel = yield(updated_by_parent_viewmodel) if block_given?
+
+      return_updates = updated_by_parent_viewmodel.map do |owner_view, updated_views|
+        ParentProxyModel.new(owner_view, association_data, updated_views)
+      end
+
+      return_structure = {
+        ViewModel::TYPE_ATTRIBUTE         => ViewModel::BULK_UPDATE_TYPE,
+        ViewModel::BULK_UPDATES_ATTRIBUTE => return_updates,
+      }
+
+      prerender_viewmodel(return_structure, serialize_context: serialize_context)
+    end
+
+    render_json_string(pre_rendered)
+    updated_by_parent_viewmodel
+  end
+
+
   def destroy_association(collection, serialize_context: new_serialize_context, deserialize_context: new_deserialize_context, lock_owner: nil)
+    require_external_referenced_association!
+
     if lock_owner
       owner_viewmodel.find(owner_viewmodel_id, eager_include: false, lock: lock_owner)
     end
@@ -61,7 +173,7 @@ module ViewModel::ActiveRecord::NestedControllerBase
   end
 
   def association_data
-    owner_viewmodel._association_data(association_name)
+    @association_data ||= owner_viewmodel._association_data(association_name)
   end
 
   def owner_update_hash(update)
@@ -78,22 +190,22 @@ module ViewModel::ActiveRecord::NestedControllerBase
     parse_param(id_param_name, **default)
   end
 
-  included do
-    delegate :owner_viewmodel, :association_name, to: 'self.class'
+  def owner_viewmodel_class_for_name(name)
+    ViewModel::Registry.for_view_name(name)
   end
 
-  class_methods do
-    attr_accessor :owner_viewmodel, :association_name
-
-    def nested_in(owner, as:)
-      unless owner.is_a?(Class) && owner < ViewModel::Record
-        owner = ViewModel::Registry.for_view_name(owner.to_s.camelize)
-      end
+  def owner_viewmodel
+    name = params.fetch(:owner_viewmodel) { raise ArgumentError.new("No owner viewmodel present") }
+    owner_viewmodel_class_for_name(name.to_s.camelize)
+  end
 
-      self.owner_viewmodel = owner
-      raise ArgumentError.new("Could not find owner ViewModel class '#{owner_name}'") if owner_viewmodel.nil?
+  def association_name
+    params.fetch(:association_name) { raise ArgumentError.new('No association name from routes') }
+  end
 
-      self.association_name = as
+  def require_external_referenced_association!
+    unless association_data.referenced? && association_data.external?
+      raise ArgumentError.new("Expected referenced external association: '#{association_name}'")
     end
   end
 end

data/lib/view_model/active_record/singular_nested_controller.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 # Controller mixin for accessing a root ViewModel which can be accessed
-# individually by a parent model. Enabled by calling `nested_in :parent, as:
-# :child` on the viewmodel controller
+# individually by a parent model.
 
 # Contributes the following routes:
 # POST   /parents/:parent_id/child   #create_associated  -- deserialize (possibly existing) child, replacing existing child
@@ -28,6 +27,10 @@ module ViewModel::ActiveRecord::SingularNestedController
     write_association(serialize_context: serialize_context, deserialize_context: deserialize_context, lock_owner: lock_owner, &block)
   end
 
+  def create_associated_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 destroy_associated(serialize_context: new_serialize_context, deserialize_context: new_deserialize_context, lock_owner: nil)
     destroy_association(false, serialize_context: serialize_context, deserialize_context: deserialize_context, lock_owner: lock_owner)
   end

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/callbacks.rb

@@ -181,7 +181,7 @@ module ViewModel::Callbacks
     # ARVM synthetic views are considered part of their association and as such
     # are not visited by callbacks. Eligibility exclusion is intended to be
     # library-internal: subclasses should not attempt to extend this.
-    view.is_a?(ViewModel::ActiveRecord) && view.class.synthetic
+    view.is_a?(ViewModel) && view.class.synthetic
   end
 
   def self.wrap_serialize(viewmodel, context:)

data/lib/view_model/controller.rb

@@ -75,12 +75,34 @@ module ViewModel::Controller
   protected
 
   def parse_viewmodel_updates
-    update_hash = _extract_update_data(params.fetch(:data))
-    refs        = _extract_param_hash(params.fetch(:references, {}))
+    data_param = params.fetch(:data) do
+      raise ViewModel::Error.new(status: 400, detail: "Missing 'data' parameter")
+    end
+    refs_param = params.fetch(:references, {})
+
+    update_hash = _extract_update_data(data_param)
+    refs        = _extract_param_hash(refs_param)
 
     return update_hash, refs
   end
 
+  def parse_bulk_update
+    data, references = parse_viewmodel_updates
+
+    ViewModel::Schemas.verify_schema!(ViewModel::Schemas::BULK_UPDATE, data)
+
+    updates_by_parent =
+      data.fetch(ViewModel::BULK_UPDATES_ATTRIBUTE).each_with_object({}) do |parent_update, acc|
+        parent_id = parent_update.fetch(ViewModel::ID_ATTRIBUTE)
+        update    = parent_update.fetch(ViewModel::BULK_UPDATE_ATTRIBUTE)
+
+        acc[parent_id] = update
+      end
+
+    return updates_by_parent, references
+  end
+
+
   private
 
   def _extract_update_data(data)

data/lib/view_model/migrator.rb

@@ -75,6 +75,32 @@ class ViewModel
   class UpMigrator < Migrator
     private
 
+    def migrate_tree!(node, references:)
+      if node.is_a?(Hash) && node[ViewModel::TYPE_ATTRIBUTE] == ViewModel::ActiveRecord::FUNCTIONAL_UPDATE_TYPE
+        migrate_functional_update!(node, references: references)
+      else
+        super
+      end
+    end
+
+    NESTED_FUPDATE_TYPES = ['append', 'update'].freeze
+
+    # The functional update structure uses `_type` internally with a
+    # context-dependent meaning. Retrospectively this was a poor choice, but we
+    # need to account for it here.
+    def migrate_functional_update!(node, references:)
+      actions = node[ViewModel::ActiveRecord::ACTIONS_ATTRIBUTE]
+      actions&.each do |action|
+        action_type = action[ViewModel::TYPE_ATTRIBUTE]
+        next unless NESTED_FUPDATE_TYPES.include?(action_type)
+
+        values = action[ViewModel::ActiveRecord::VALUES_ATTRIBUTE]
+        values&.each do |value|
+          migrate_tree!(value, references: references)
+        end
+      end
+    end
+
     def migrate_viewmodel!(view_name, source_version, view_hash, references)
       path = @paths[view_name]
       return false unless path

data/lib/view_model/record.rb

@@ -35,7 +35,7 @@ class ViewModel::Record < ViewModel
 
     # Should this class be registered in the viewmodel registry
     def should_register?
-      !abstract_class && !unregistered
+      !abstract_class && !unregistered && !synthetic
     end
 
     # Specifies an attribute from the model to be serialized in this view

data/lib/view_model/schemas.rb

@@ -39,6 +39,50 @@ class ViewModel::Schemas
 
   VIEWMODEL_REFERENCE = JsonSchema.parse!(VIEWMODEL_REFERENCE_SCHEMA)
 
+  BULK_UPDATE_SCHEMA =
+    {
+      'type'                 => 'object',
+      'description'          => 'bulk update collection',
+      'properties'           => {
+        ViewModel::TYPE_ATTRIBUTE => {
+          'type' => 'string',
+          'enum' => [ViewModel::BULK_UPDATE_TYPE],
+        },
+
+        ViewModel::BULK_UPDATES_ATTRIBUTE => {
+          'type'  => 'array',
+          'items' => {
+            'type'                 => 'object',
+            'properties'           => {
+              ViewModel::ID_ATTRIBUTE => ID_SCHEMA,
+
+              # These will be checked by the main deserialize operation. Any operations on the data
+              # before the main serialization must do its own checking of the presented update data.
+
+              ViewModel::BULK_UPDATE_ATTRIBUTE => {
+                'oneOf' => [
+                  { 'type' => 'array' },
+                  { 'type' => 'object' },
+                ]
+              },
+            },
+            'additionalProperties' => false,
+            'required'             => [
+              ViewModel::ID_ATTRIBUTE,
+              ViewModel::BULK_UPDATE_ATTRIBUTE,
+            ],
+          },
+        }
+      },
+      'additionalProperties' => false,
+      'required'             => [
+        ViewModel::TYPE_ATTRIBUTE,
+        ViewModel::BULK_UPDATES_ATTRIBUTE,
+      ],
+    }.freeze
+
+  BULK_UPDATE = JsonSchema.parse!(BULK_UPDATE_SCHEMA)
+
   def self.verify_schema!(schema, value)
     valid, errors = schema.validate(value)
     unless valid

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/test/helpers/arvm_test_utilities.rb

@@ -192,4 +192,69 @@ module ARVMTestUtilities
   def build_fupdate(attrs = {}, &block)
     FupdateBuilder.new.build!(&block).merge(attrs)
   end
+
+  def each_hook_span(trace)
+    return enum_for(:each_hook_span, trace) unless block_given?
+
+    hook_nesting = []
+
+    trace.each_with_index do |t, i|
+      case t.hook
+      when ViewModel::Callbacks::Hook::OnChange,
+        ViewModel::Callbacks::Hook::BeforeValidate
+        # ignore
+      when ViewModel::Callbacks::Hook::BeforeVisit,
+        ViewModel::Callbacks::Hook::BeforeDeserialize
+        hook_nesting.push([t, i])
+
+      when ViewModel::Callbacks::Hook::AfterVisit,
+        ViewModel::Callbacks::Hook::AfterDeserialize
+        (nested_top, nested_index) = hook_nesting.pop
+
+        unless nested_top.hook.name == t.hook.name.sub(/^After/, 'Before')
+          raise "Invalid nesting, processing '#{t.hook.name}', expected matching '#{nested_top.hook.name}'"
+        end
+
+        unless nested_top.view == t.view
+          raise "Invalid nesting, processing '#{t.hook.name}', " \
+                  "expected viewmodel '#{t.view}' to match '#{nested_top.view}'"
+        end
+
+        yield t.view, (nested_index..i), t.hook.name.sub(/^After/, '')
+
+      else
+        raise 'Unexpected hook type'
+      end
+    end
+  end
+
+  def show_span(view, range, hook)
+    "#{view.class.name}(#{view.id}) #{range} #{hook}"
+  end
+
+  def enclosing_hooks(spans, inner_range)
+    spans.select do |_view, range, _hook|
+      inner_range != range && range.cover?(inner_range.min) && range.cover?(inner_range.max)
+    end
+  end
+
+  def assert_all_hooks_nested_inside_parent_hook(trace)
+    spans = each_hook_span(trace).to_a
+
+    spans.reject { |view, _range, _hook| view.class == ParentView }.each do |view, range, hook|
+      enclosing_spans = enclosing_hooks(spans, range)
+
+      enclosing_parent_hook = enclosing_spans.detect do |other_view, _other_range, other_hook|
+        other_hook == hook && other_view.class == ParentView
+      end
+
+      next if enclosing_parent_hook
+
+      self_str      = show_span(view, range, hook)
+      enclosing_str = enclosing_spans.map { |ov, ora, oh| show_span(ov, ora, oh) }.join("\n")
+      assert_not_nil(
+        enclosing_parent_hook,
+        "Invalid nesting of hook: #{self_str}\nEnclosing hooks:\n#{enclosing_str}")
+    end
+  end
 end

data/test/helpers/controller_test_helpers.rb

@@ -13,8 +13,11 @@ require 'acts_as_manual_list'
 
 # models for ARVM controller test
 module ControllerTestModels
-  def before_all
-    super
+  def build_controller_test_models(externalize: [])
+    unsupported_externals = externalize - [:label, :target, :child]
+    unless unsupported_externals.empty?
+      raise ArgumentError.new("build_controller_test_models cannot externalize: #{unsupported_externals.join(", ")}")
+    end
 
     build_viewmodel(:Label) do
       define_schema do |t|
@@ -25,6 +28,7 @@ module ControllerTestModels
         has_one :target
       end
       define_viewmodel do
+        root! if externalize.include?(:label)
         attributes :text
       end
     end
@@ -80,16 +84,19 @@ module ControllerTestModels
         has_one    :target,   dependent: :destroy, inverse_of: :parent
         belongs_to :poly, polymorphic: true, dependent: :destroy, inverse_of: :parent
         belongs_to :category
+        has_many   :parent_tags
       end
       define_viewmodel do
         root!
         self.schema_version = 2
 
         attributes   :name
-        associations :label, :target
-        association  :children
+        association  :target, external: externalize.include?(:target)
+        association  :label, external: externalize.include?(:label)
+        association  :children, external: externalize.include?(:child)
         association  :poly, viewmodels: [:PolyOne, :PolyTwo]
         association  :category, external: true
+        association :tags, through: :parent_tags, external: true
 
         migrates from: 1, to: 2 do
           up do |view, _refs|
@@ -105,6 +112,31 @@ module ControllerTestModels
       end
     end
 
+    build_viewmodel(:Tag) do
+      define_schema do |t|
+        t.string :name, null: false
+      end
+      define_model do
+        has_many :parent_tags
+      end
+      define_viewmodel do
+        root!
+        attributes :name
+      end
+    end
+
+    build_viewmodel(:ParentTag) do
+      define_schema do |t|
+        t.references :parent, foreign_key: true
+        t.references :tag, foreign_key: true
+      end
+      define_model do
+        belongs_to :parent
+        belongs_to :tag
+      end
+      no_viewmodel
+    end
+
     build_viewmodel(:Child) do
       define_schema do |t|
         t.references :parent, null: false, foreign_key: true
@@ -122,6 +154,7 @@ module ControllerTestModels
         validates :age, numericality: { less_than: 42 }, allow_nil: true
       end
       define_viewmodel do
+        root! if externalize.include?(:child)
         attributes :name, :age
         acts_as_list :position
       end
@@ -138,11 +171,22 @@ module ControllerTestModels
         belongs_to :label, dependent: :destroy
       end
       define_viewmodel do
+        root! if externalize.include?(:target)
         attributes :text
         association :label
       end
     end
   end
+
+  def make_parent(name: 'p', child_names: ['c1', 'c2'])
+    Parent.create(
+      name:     name,
+      children: child_names.each_with_index.map { |c, pos|
+        Child.new(name: "c#{pos + 1}", position: (pos + 1).to_f)
+      },
+      label: Label.new,
+      target: Target.new)
+  end
 end
 
 ## Dummy Rails Controllers
@@ -253,43 +297,30 @@ module CallbackTracing
 end
 
 module ControllerTestControllers
+  CONTROLLER_NAMES = [
+    :ParentController,
+    :ChildController,
+    :LabelController,
+    :TargetController,
+    :CategoryController,
+    :TagController,
+  ]
+
   def before_all
     super
 
-    Class.new(DummyController) do |_c|
-      Object.const_set(:ParentController, self)
-      include ViewModel::ActiveRecord::Controller
-      include CallbackTracing
-      self.access_control = ViewModel::AccessControl::Open
-    end
-
-    Class.new(DummyController) do |_c|
-      Object.const_set(:ChildController, self)
-      include ViewModel::ActiveRecord::Controller
-      include CallbackTracing
-      self.access_control = ViewModel::AccessControl::Open
-      nested_in :parent, as: :children
-    end
-
-    Class.new(DummyController) do |_c|
-      Object.const_set(:LabelController, self)
-      include ViewModel::ActiveRecord::Controller
-      include CallbackTracing
-      self.access_control = ViewModel::AccessControl::Open
-      nested_in :parent, as: :label
-    end
-
-    Class.new(DummyController) do |_c|
-      Object.const_set(:TargetController, self)
-      include ViewModel::ActiveRecord::Controller
-      include CallbackTracing
-      self.access_control = ViewModel::AccessControl::Open
-      nested_in :parent, as: :target
+    CONTROLLER_NAMES.each do |name|
+      Class.new(DummyController) do |_c|
+        Object.const_set(name, self)
+        include ViewModel::ActiveRecord::Controller
+        include CallbackTracing
+        self.access_control = ViewModel::AccessControl::Open
+      end
     end
   end
 
   def after_all
-    [:ParentController, :ChildController, :LabelController, :TargetController].each do |name|
+    CONTROLLER_NAMES.each do |name|
       Object.send(:remove_const, name)
     end
     ActiveSupport::Dependencies::Reference.clear!