iknow_view_models 3.6.6 → 3.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb322edf3edec85adb744dba24cab64e15914716f16cfa5ec6bb75de5fcb8e33
-  data.tar.gz: 4b41f0f4ba1fa9a3d7568ee8b0005c4139e8186c91244c7aa04ff8b3bae19fce
+  metadata.gz: c673bb5888e36eb62ba3ac6ece035d8cda3203cb10bdf19716b66454df4b20f1
+  data.tar.gz: 157092fa9b7e5e6a815981a144566945ddb342bf3c108d3d788a0e476ed2dc84
 SHA512:
-  metadata.gz: a51e6a510110c90e3b4a77d0f3da2df2191e68d12137cd9ab040a97125f799e8292ae86c9b53f39b85ebb589d785fa791e8bf56883b122d6b08bfc15b2a0f702
-  data.tar.gz: 03c790566b0304ab4333e632fd81ba8886425ee8a45f1edb2fc5c777af7e2bcbfccecaa947c8a3001d47711ed8dee4132dcb4b52284cd799b915e147de9daf35
+  metadata.gz: 546321a01ca0f1bee84d7607b44f93124cf76353c28868b047ffcab66d976e2eeec6287e6b505d68b302ef14ea4eb9b69941596ce9dd8d0437ff6e6b3435cdd3
+  data.tar.gz: e95d5d0b60defa73d7ebc30dabc0e390acdac733d2f95ed888c3f6001f0330565268ab99c4003a64ac23b092716140f99012af5adb75a0801ce08f901980c7b8

data/lib/iknow_view_models/version.rb

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

data/lib/view_model/migrator.rb

@@ -37,8 +37,15 @@ class ViewModel
     end
 
     def migrate!(serialization)
-      migrate_tree!(serialization, references: serialization['references'] || {})
+      references = (serialization['references'] ||= {})
+
+      migrate_tree!(serialization, references: references)
+
       GarbageCollection.garbage_collect_references!(serialization)
+
+      if references.empty?
+        serialization.delete('references')
+      end
     end
 
     private

data/test/helpers/viewmodel_spec_helpers.rb

@@ -143,8 +143,8 @@ module ViewModelSpecHelpers
 
   module ParentAndChildMigrations
     extend ActiveSupport::Concern
-  
-  def model_attributes
+
+    def model_attributes
       super.merge(
         schema: ->(t) { t.integer :new_field, default: 1, null: false },
         viewmodel: ->(_v) {

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

@@ -30,8 +30,16 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
   let(:current_serialization) do
     ctx = viewmodel_class.new_serialize_context
     view = ViewModel.serialize_to_hash(viewmodel, serialize_context: ctx)
-    refs = ctx.serialize_references_to_hash
-    { 'data' => view, 'references' => refs }
+
+    serialization = { 'data' => view }
+
+    # Only include 'references' key if there are actually references to
+    # serialize. This matches prerender_viewmodel.
+    if ctx.has_references?
+      serialization['references'] = ctx.serialize_references_to_hash
+    end
+
+    serialization
   end
 
   let(:v2_serialization_data) do
@@ -51,12 +59,9 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
     }
   end
 
-  let(:v2_serialization_references) { {} }
-
   let(:v2_serialization) do
     {
       'data' => v2_serialization_data,
-      'references' => v2_serialization_references,
     }
   end
 
@@ -101,8 +106,7 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
     describe 'upwards' do
       let(:migrator) { up_migrator }
       let(:subject_data) { v2_serialization_data.deep_dup }
-      let(:subject_references) { v2_serialization_references.deep_dup }
-      let(:subject) { { 'data' => subject_data, 'references' => subject_references } }
+      let(:subject) { { 'data' => subject_data } }
 
       let(:expected_result) do
         current_serialization.deep_merge(
@@ -229,12 +233,9 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
       }
     end
 
-    let(:v1_serialization_references) { {} }
-
     let(:v1_serialization) do
       {
         'data' => v1_serialization_data,
-        'references' => v1_serialization_references,
       }
     end
 
@@ -331,7 +332,6 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
           ViewModel::MIGRATED_ATTRIBUTE => true,
           'name' => viewmodel.name,
         },
-        'references' => {},
       }
     end
 
@@ -370,4 +370,114 @@ class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
       end
     end
   end
+
+  describe 'changing references' do
+    include ViewModelSpecHelpers::ParentAndBelongsToChild
+    let(:migration_versions) { { viewmodel_class => 1 } }
+
+    let(:old_field_serialization) do
+      {
+        ViewModel::TYPE_ATTRIBUTE    => 'SyntheticType',
+        ViewModel::VERSION_ATTRIBUTE => 1,
+      }
+    end
+
+    def model_attributes
+      old_field_serialization = self.old_field_serialization
+      super.merge(
+        viewmodel: ->(_v) {
+          self.schema_version = 2
+
+          # The migration from 1 -> 2 deleted a referenced field.
+          migrates from: 1, to: 2 do
+            # Put the referenced field back with a canned serialization
+            down do |view, refs|
+              view['old_field'] = { ViewModel::REFERENCE_ATTRIBUTE => 'ref:old_field' }
+              refs['ref:old_field'] = old_field_serialization
+            end
+
+            # Remove the referenced field
+            up do |view, _refs|
+              view.delete('old_field')
+            end
+          end
+        },
+      )
+    end
+
+    let(:v1_serialization_data) do
+      base = {
+        ViewModel::TYPE_ATTRIBUTE => viewmodel_class.view_name,
+        ViewModel::VERSION_ATTRIBUTE => 1,
+        ViewModel::ID_ATTRIBUTE => viewmodel.id,
+        'name' => viewmodel.name,
+        'child' => {
+          ViewModel::TYPE_ATTRIBUTE => child_viewmodel_class.view_name,
+          ViewModel::VERSION_ATTRIBUTE => 1,
+          ViewModel::ID_ATTRIBUTE => viewmodel.child.id,
+          'name' => viewmodel.child.name,
+        },
+        'old_field' => { ViewModel::REFERENCE_ATTRIBUTE => 'ref:old_field' },
+      }
+    end
+
+    let(:v1_serialization_references) do
+      { 'ref:old_field' => old_field_serialization }
+    end
+
+    let(:v1_serialization) do
+      {
+        'data' => v1_serialization_data,
+        'references' => v1_serialization_references,
+      }
+    end
+
+    describe 'adding references' do
+      let(:migrator) { down_migrator }
+      let(:subject) do
+        ser = current_serialization.deep_dup
+        raise ArgumentError.new("Expected no references") if ser.has_key?('references')
+        ser
+      end
+
+      let(:expected_result) do
+        {
+          'data' => v1_serialization_data.deep_dup.deep_merge(
+            { ViewModel::MIGRATED_ATTRIBUTE => true }
+          ),
+          'references' => v1_serialization_references
+        }
+      end
+
+      it 'migrates and returns references' do
+        migrate!
+
+        assert_equal(expected_result, subject)
+      end
+    end
+
+    describe 'removing references' do
+      let(:migrator) { up_migrator }
+      let(:subject) do
+        ser = v1_serialization.deep_dup
+        raise ArgumentError.new("Expected references") unless ser.has_key?('references')
+        ser
+      end
+
+      let(:expected_result) do
+        {
+          'data' => current_serialization.fetch('data').deep_dup.merge({
+            ViewModel::MIGRATED_ATTRIBUTE => true,
+          }),
+          # references key is absent
+        }
+      end
+
+      it 'migrates and returns references' do
+        migrate!
+
+        assert_equal(expected_result, subject)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_view_models
 version: !ruby/object:Gem::Version
-  version: 3.6.6
+  version: 3.6.7
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack