iknow_view_models 3.7.7 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 849a8c0a38a21b8d8d8c706aae9800c2d5b009a81e59432d501cc0cef8329db3
-  data.tar.gz: b9cfa60ace9c9f6af4c711f7ae11fd8aa76934bcef7d6e7b360b749fe667d4b4
+  metadata.gz: 10ac2bba9965a5eb683cdbb972d1a7c8b31a6fd86304b1e52816cdd5649818d9
+  data.tar.gz: dcd13cba67c3b27beb4491b23d6a487ff30a3a3b930a8d2188a5503f77298c89
 SHA512:
-  metadata.gz: 6e510f3a65791a27df5be2eabb889bd5a5addb84ee17f4e1b2f1ff7b76dfb1630978e3fc1b90bc1c26b36a83d9bb6892e9c3eb7e235b7f762946ab0c3b9b4ab4
-  data.tar.gz: 67f12f88ce24394ddcaa639008a66ea0120fa5e062463fed5c4d30e0f20a75e7dda7823f025304b3cf4d1cda9e5640cbe281f459aab22f84ed5a4d920eb7f9b6
+  metadata.gz: a0faccad196615ad236d93016b3268fe50c3eac86bfc52750445a53655fc24d24ff068442071d4ea0a6d1d19e86cdaba8ae24ad9cba5d4feedfbb007333217e9
+  data.tar.gz: 253dea949f2c1a79360969fbd662a93d072ef93ff43554b5b08bc65344e2cc96c58b0eea2a71ff734cd8d3507c07b2569638be4d483c116d7b498ea98aca5fd5

data/lib/iknow_view_models/version.rb

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

data/lib/view_model/active_record/update_context.rb

@@ -134,7 +134,15 @@ class ViewModel::ActiveRecord
 
         updates.each do |ref, update_data|
           viewmodel =
-            if update_data.new?
+            if update_data.auto_child_update?
+              raise ViewModel::DeserializationError::InvalidStructure.new(
+                      'Cannot make an automatic child update to a root node',
+                      ViewModel::Reference.new(update_data.viewmodel_class, nil))
+            elsif update_data.child_update?
+              raise ViewModel::DeserializationError::InvalidStructure.new(
+                      'Cannot update an existing root node without a specified id',
+                      ViewModel::Reference.new(update_data.viewmodel_class, nil))
+            elsif update_data.new?
               viewmodel_class.for_new_model(id: update_data.id)
             else
               viewmodel_class.new(existing_models[update_data.id])

data/lib/view_model/active_record/update_data.rb

@@ -520,9 +520,7 @@ class ViewModel::ActiveRecord
       end
     end
 
-    def new?
-      id.nil? || metadata.new?
-    end
+    delegate :new?, :child_update?, :auto_child_update?, to: :metadata
 
     def self.parse_hashes(root_subtree_hashes, referenced_subtree_hashes = {})
       valid_reference_keys = referenced_subtree_hashes.keys.to_set

data/lib/view_model/active_record/update_operation.rb

@@ -300,6 +300,26 @@ class ViewModel::ActiveRecord
         case
         when update_data.new?
           child_viewmodel_class.for_new_model(id: update_data.id)
+        when update_data.child_update?
+          if association_data.collection?
+            raise ViewModel::DeserializationError::InvalidStructure.new(
+                    'Cannot update existing children of a collection association without specified ids',
+                    ViewModel::Reference.new(update_data.viewmodel_class, nil))
+          end
+
+          child = previous_child_viewmodels[0]
+
+          if child.nil?
+            unless update_data.auto_child_update?
+              raise ViewModel::DeserializationError::PreviousChildNotFound.new(
+                    association_data.association_name.to_s,
+                    self.blame_reference)
+            end
+
+            child = child_viewmodel_class.for_new_model
+          end
+
+          child
         when existing_child = previous_by_key[key]
           existing_child
         when taken_child = update_context.try_take_released_viewmodel(key)

data/lib/view_model/deserialization_error.rb

@@ -211,6 +211,23 @@ class ViewModel
       end
     end
 
+    class PreviousChildNotFound < NotFound
+      attr_reader :association
+
+      def initialize(association, blame_nodes)
+        @association = association
+        super(blame_nodes)
+      end
+
+      def detail
+        "No child currently exists to update for association '#{association}'"
+      end
+
+      def meta
+        super.merge(association: association)
+      end
+    end
+
     class DuplicateNodes < InvalidRequest
       attr_reader :type
 

data/lib/view_model/schemas.rb

@@ -21,7 +21,7 @@ class ViewModel::Schemas
       'description' => 'viewmodel update',
       'properties'  => { ViewModel::TYPE_ATTRIBUTE    => { 'type' => 'string' },
                          ViewModel::ID_ATTRIBUTE      => ID_SCHEMA,
-                         ViewModel::NEW_ATTRIBUTE     => { 'type' => 'boolean' },
+                         ViewModel::NEW_ATTRIBUTE     => { 'oneOf' => [{ 'type' => 'boolean' }, { 'type' => 'string', 'enum' => ['auto'] }] },
                          ViewModel::VERSION_ATTRIBUTE => { 'type' => 'integer' } },
       'required'    => [ViewModel::TYPE_ATTRIBUTE],
     }.freeze

data/lib/view_model.rb

@@ -11,6 +11,22 @@ class ViewModel
   ID_ATTRIBUTE        = 'id'
   TYPE_ATTRIBUTE      = '_type'
   VERSION_ATTRIBUTE   = '_version'
+
+  # The optional _new attribute specifies explicitly whether a deserialization
+  # is to an new or existing model. The behaviour of _new is as follows:
+  #  * true  - Always create a new model, using the id if provided, error if
+  #            a model with that id already exists
+  #  * false - Never create a new model. If id isn’t provided, it's an error
+  #            unless the viewmodel is being deserialized in the context of a
+  #            singular association, in which case it's implicitly referring
+  #            to the current child of that association, and is an error if
+  #            that child doesn't exist.
+  # * nil    - Create a new model if `id` is not specified, otherwise update the
+  #            existing record with `id`, and error if it doesn't exist.
+  # * 'auto' - Can only be used when the viewmodel is being deserialized in the
+  #            context of a singular association. `id` must not be specified. If
+  #            the association currently has a child, update it, otherwise
+  #            create a new one.
   NEW_ATTRIBUTE       = '_new'
 
   BULK_UPDATE_TYPE       = '_bulk_update'
@@ -20,10 +36,36 @@ class ViewModel
   # 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.
-  MIGRATED_ATTRIBUTE  = '_migrated'
+  MIGRATED_ATTRIBUTE = '_migrated'
 
   Metadata = Struct.new(:id, :view_name, :schema_version, :new, :migrated) do
-    alias_method :new?, :new
+    # Does this metadata describe deserialization to a new model, either by
+    # {new: true} or {new: nil, id: nil}
+    def new?
+      if new.nil?
+        id.nil?
+      else
+        new == true
+      end
+    end
+
+    # Does this metadata describe an change to the anonymous child of a singular
+    # association
+    def child_update?
+      explicit_child_update? || auto_child_update?
+    end
+
+    # Does this metadata describe an update to the already-existing anonymous
+    # child of a singular association
+    def explicit_child_update?
+      new == false && id.nil?
+    end
+
+    # Does this child metadata describe an create-or-update to the anonymous
+    # child of a singular association
+    def auto_child_update?
+      new == 'auto'
+    end
   end
 
   class << self
@@ -119,9 +161,14 @@ class ViewModel
       id             = hash.delete(ViewModel::ID_ATTRIBUTE)
       type_name      = hash.delete(ViewModel::TYPE_ATTRIBUTE)
       schema_version = hash.delete(ViewModel::VERSION_ATTRIBUTE)
-      new            = hash.delete(ViewModel::NEW_ATTRIBUTE) { false }
+      new            = hash.delete(ViewModel::NEW_ATTRIBUTE)
       migrated       = hash.delete(ViewModel::MIGRATED_ATTRIBUTE) { false }
 
+      if id && new == 'auto'
+        raise ViewModel::DeserializationError::InvalidSyntax.new(
+                "An explicit id must not be specified with an 'auto' child update")
+      end
+
       Metadata.new(id, type_name, schema_version, new, migrated)
     end
 

data/test/unit/view_model/active_record/belongs_to_test.rb

@@ -85,7 +85,7 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
     end
   end
 
-  def test_belongs_to_create
+  def test_belongs_to_create_implicit_new
     @model1.update(child: nil)
 
     alter_by_view!(ModelView, @model1) do |view, _refs|
@@ -95,6 +95,108 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
     assert_equal('cheese', @model1.child.name)
   end
 
+  def test_belongs_to_create
+    @model1.update(child: nil)
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', '_new' => true, 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+  end
+
+  def test_belongs_to_create_with_id
+    @model1.update(child: nil)
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', 'id' => 9999, '_new' => true, 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+    assert_equal(9999, @model1.child.id)
+  end
+
+  def test_belongs_to_create_with_colliding_id
+    child_id = @model1.child_id
+    @model1.update(child: nil)
+
+    ex = assert_raises(ViewModel::DeserializationError::UniqueViolation) do
+      alter_by_view!(ModelView, @model1) do |view, _refs|
+        view['child'] = { '_type' => 'Child', 'id' => child_id, '_new' => true, 'name' => 'cheese' }
+      end
+    end
+
+    assert_equal(['id'], ex.columns)
+    assert_equal([ViewModel::Reference.new(ChildView, child_id)], ex.nodes)
+  end
+
+  def test_belongs_to_create_child_with_auto
+    @model1.update(child: nil)
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', '_new' => 'auto', 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+  end
+
+  def test_belongs_to_edit_implicit_new
+    child_id = @model1.child_id
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', 'id' => child_id, 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+    assert_equal(child_id, @model1.child.id)
+  end
+
+  def test_belongs_to_edit
+    child_id = @model1.child_id
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', 'id' => child_id, '_new' => false, 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+    assert_equal(child_id, @model1.child.id)
+  end
+
+  def test_belongs_to_edit_child_without_id
+    child_id = @model1.child_id
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', '_new' => false, 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+    assert_equal(child_id, @model1.child.id)
+  end
+
+  def test_belongs_to_one_edit_without_id_no_child
+    @model1.update(child: nil)
+
+    ex = assert_raises(ViewModel::DeserializationError::PreviousChildNotFound) do
+      alter_by_view!(ModelView, @model1) do |view, _refs|
+        view['child'] = { '_type' => 'Child', '_new' => false, 'name' => 'cheese' }
+      end
+    end
+
+    assert_equal('child', ex.association)
+    assert_equal([ViewModel::Reference.new(ModelView, @model1.id)], ex.nodes)
+  end
+
+  def test_belongs_to_edit_child_with_auto
+    child_id = @model1.child_id
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', '_new' => 'auto', 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+    assert_equal(child_id, @model1.child.id)
+  end
+
   def test_belongs_to_replace
     old_child = @model1.child
 

data/test/unit/view_model/active_record/has_many_test.rb

@@ -107,7 +107,7 @@ class ViewModel::ActiveRecord::HasManyTest < ActiveSupport::TestCase
     assert(pv.model.children.blank?)
   end
 
-  def test_create_has_many
+  def test_create_has_many_implicit_new
     view = { '_type'    => 'Model',
              'name'     => 'p',
              'children' => [{ '_type' => 'Child', 'name' => 'c1' },
@@ -123,6 +123,64 @@ class ViewModel::ActiveRecord::HasManyTest < ActiveSupport::TestCase
     assert_equal(%w[c1 c2], pv.model.children.map(&:name))
   end
 
+  def test_create_has_many
+    view = { '_type'    => 'Model',
+             'name'     => 'p',
+             'children' => [{ '_type' => 'Child', '_new' => true, 'name' => 'c1' },
+                            { '_type' => 'Child', '_new' => true, 'name' => 'c2' },] }
+
+    context = viewmodel_class.new_deserialize_context
+    pv = viewmodel_class.deserialize_from_view(view, deserialize_context: context)
+
+    assert_contains_exactly(
+      [pv.to_reference, pv.children[0].to_reference, pv.children[1].to_reference],
+      context.valid_edit_refs)
+
+    assert_equal(%w[c1 c2], pv.model.children.map(&:name))
+  end
+
+  def test_create_has_many_with_id
+    view = { '_type'    => 'Model',
+             'name'     => 'p',
+             'children' => [{ '_type' => 'Child', 'id' => 9998, '_new' => true, 'name' => 'c1' },
+                            { '_type' => 'Child', 'id' => 9999, '_new' => true, 'name' => 'c2' },] }
+
+    context = viewmodel_class.new_deserialize_context
+    pv = viewmodel_class.deserialize_from_view(view, deserialize_context: context)
+
+    assert_contains_exactly(
+      [pv.to_reference, pv.children[0].to_reference, pv.children[1].to_reference],
+      context.valid_edit_refs)
+
+    assert_equal(%w[c1 c2], pv.model.children.map(&:name))
+  end
+
+  def test_create_has_many_auto
+    view = { '_type'    => 'Model',
+             'name'     => 'p',
+             'children' => [{ '_type' => 'Child', '_new' => 'auto', 'name' => 'c1' }] }
+
+    context = viewmodel_class.new_deserialize_context
+    ex = assert_raises(ViewModel::DeserializationError::InvalidStructure) do
+      viewmodel_class.deserialize_from_view(view, deserialize_context: context)
+    end
+    assert_match(/existing children of a collection association without specified ids/, ex.message)
+    assert_equal([ViewModel::Reference.new(ChildView, nil)], ex.nodes)
+  end
+
+  def test_update_has_many_without_id
+    view = { '_type'    => 'Model',
+             'name'     => 'p',
+             'children' => [{ '_type' => 'Child', '_new' => false, 'name' => 'c1' }] }
+
+    context = viewmodel_class.new_deserialize_context
+    ex = assert_raises(ViewModel::DeserializationError::InvalidStructure) do
+      viewmodel_class.deserialize_from_view(view, deserialize_context: context)
+    end
+    assert_match(/existing children of a collection association without specified ids/, ex.message)
+    assert_equal([ViewModel::Reference.new(ChildView, nil)], ex.nodes)
+  end
+
   def test_nil_multiple_association
     view = {
       '_type' => 'Model',

data/test/unit/view_model/active_record/has_one_test.rb

@@ -98,7 +98,7 @@ class ViewModel::ActiveRecord::HasOneTest < ActiveSupport::TestCase
     assert_nil(pv.model.child)
   end
 
-  def test_has_one_create
+  def test_has_one_create_implicit_new
     @model1.update(child: nil)
 
     alter_by_view!(ModelView, @model1) do |view, _refs|
@@ -108,12 +108,106 @@ class ViewModel::ActiveRecord::HasOneTest < ActiveSupport::TestCase
     assert_equal('t', @model1.child.name)
   end
 
-  def test_has_one_update
+  def test_has_one_create
+    @model1.update(child: nil)
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', '_new' => true, 'name' => 't' }
+    end
+
+    assert_equal('t', @model1.child.name)
+  end
+
+  def test_has_one_create_with_id
+    @model1.update(child: nil)
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', 'id' => 9999, '_new' => true, 'name' => 't' }
+    end
+
+    assert_equal('t', @model1.child.name)
+    assert_equal(9999, @model1.child.id)
+  end
+
+  def test_has_one_create_with_colliding_id
+    child_id = @model2.child.id
+    @model1.update(child: nil)
+
+    ex = assert_raises(ViewModel::DeserializationError::UniqueViolation) do
+      alter_by_view!(ModelView, @model1) do |view, _refs|
+        view['child'] = { '_type' => 'Child', 'id' => child_id, '_new' => true, 'name' => 'cheese' }
+      end
+    end
+
+    assert_equal(['id'], ex.columns)
+    assert_equal([ViewModel::Reference.new(ChildView, child_id)], ex.nodes)
+  end
+
+  def test_has_one_create_child_with_auto
+    @model1.update(child: nil)
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', '_new' => 'auto', 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+  end
+
+  def test_has_one_edit_implicit_new
+    child_id = @model1.child.id
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', 'id' => child_id, 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+    assert_equal(child_id, @model1.child.id)
+  end
+
+  def test_has_one_edit
+    child_id = @model1.child.id
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', 'id' => child_id, '_new' => false, 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+    assert_equal(child_id, @model1.child.id)
+  end
+
+  def test_has_one_edit_without_id
+    child_id = @model1.child.id
+
+    alter_by_view!(ModelView, @model1) do |view, _refs|
+      view['child'] = { '_type' => 'Child', '_new' => false, 'name' => 'cheese' }
+    end
+
+    assert_equal('cheese', @model1.child.name)
+    assert_equal(child_id, @model1.child.id)
+  end
+
+  def test_has_one_edit_without_id_no_child
+    @model1.update(child: nil)
+
+    ex = assert_raises(ViewModel::DeserializationError::PreviousChildNotFound) do
+      alter_by_view!(ModelView, @model1) do |view, _refs|
+        view['child'] = { '_type' => 'Child', '_new' => false, 'name' => 'cheese' }
+      end
+    end
+
+    assert_equal('child', ex.association)
+    assert_equal([ViewModel::Reference.new(ModelView, @model1.id)], ex.nodes)
+  end
+
+  def test_belongs_to_edit_child_with_auto
+    child_id = @model1.child.id
+
     alter_by_view!(ModelView, @model1) do |view, _refs|
-      view['child']['name'] = 'hello'
+      view['child'] = { '_type' => 'Child', '_new' => 'auto', 'name' => 'cheese' }
     end
 
-    assert_equal('hello', @model1.child.name)
+    assert_equal('cheese', @model1.child.name)
+    assert_equal(child_id, @model1.child.id)
   end
 
   def test_has_one_destroy

data/test/unit/view_model/active_record_test.rb

@@ -127,6 +127,30 @@ class ViewModel::ActiveRecordTest < ActiveSupport::TestCase
     assert_equal([ViewModel::Reference.new(ParentView, 9999)], ex.nodes)
   end
 
+  def test_create_implicit_id_raises
+    view = {
+      '_type' => 'Parent',
+      '_new'  => false,
+    }
+    ex = assert_raises(ViewModel::DeserializationError::InvalidStructure) do
+      ParentView.deserialize_from_view(view)
+    end
+    assert_match(/existing root node without a specified id/, ex.message)
+    assert_equal([ViewModel::Reference.new(ParentView, nil)], ex.nodes)
+  end
+
+  def test_create_auto_raises
+    view = {
+      '_type' => 'Parent',
+      '_new'  => 'auto',
+    }
+    ex = assert_raises(ViewModel::DeserializationError::InvalidStructure) do
+      ParentView.deserialize_from_view(view)
+    end
+    assert_match(/automatic child update to a root node/, ex.message)
+    assert_equal([ViewModel::Reference.new(ParentView, nil)], ex.nodes)
+  end
+
   def test_read_only_raises_with_id
     view = {
       '_type' => 'Parent',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_view_models
 version: !ruby/object:Gem::Version
-  version: 3.7.7
+  version: 3.8.0
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack