iknow_view_models 3.1.6 → 3.2.2

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

@@ -1,10 +1,12 @@
-require_relative "../../../helpers/arvm_test_utilities.rb"
-require_relative "../../../helpers/arvm_test_models.rb"
-require_relative "../../../helpers/viewmodel_spec_helpers.rb"
+# frozen_string_literal: true
 
-require "minitest/autorun"
+require_relative '../../../helpers/arvm_test_utilities'
+require_relative '../../../helpers/arvm_test_models'
+require_relative '../../../helpers/viewmodel_spec_helpers'
 
-require "view_model/active_record"
+require 'minitest/autorun'
+
+require 'view_model/active_record'
 
 class ViewModel::ActiveRecord::Alias < ActiveSupport::TestCase
   include ARVMTestUtilities
@@ -14,18 +16,18 @@ class ViewModel::ActiveRecord::Alias < ActiveSupport::TestCase
 
   def child_attributes
     super.merge(
-      viewmodel: ->(v) do
-        add_view_alias "ChildA"
-        add_view_alias "ChildB"
-      end
+      viewmodel: ->(_v) do
+        add_view_alias 'ChildA'
+        add_view_alias 'ChildB'
+      end,
     )
   end
 
-  it "permits association types to be aliased" do
-    %w(Child ChildA ChildB).each do |view_alias|
+  it 'permits association types to be aliased' do
+    %w[Child ChildA ChildB].each do |view_alias|
       view = {
-        "_type" => viewmodel_class.view_name,
-        "child" => { "_type" => view_alias },
+        '_type' => viewmodel_class.view_name,
+        'child' => { '_type' => view_alias },
       }
 
       parent = viewmodel_class.deserialize_from_view(view).model

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

@@ -1,10 +1,12 @@
-require_relative "../../../helpers/arvm_test_utilities.rb"
-require_relative "../../../helpers/arvm_test_models.rb"
-require_relative '../../../helpers/viewmodel_spec_helpers.rb'
+# frozen_string_literal: true
 
-require "minitest/autorun"
+require_relative '../../../helpers/arvm_test_utilities'
+require_relative '../../../helpers/arvm_test_models'
+require_relative '../../../helpers/viewmodel_spec_helpers'
 
-require "view_model/active_record"
+require 'minitest/autorun'
+
+require 'view_model/active_record'
 
 class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
   include ARVMTestUtilities
@@ -14,13 +16,13 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
   def setup
     super
 
-    # TODO make a `has_list?` that allows a parent to set all children as an array
-    @model1 = model_class.new(name: "p1",
-                              child: child_model_class.new(name: "p1l"))
+    # TODO: make a `has_list?` that allows a parent to set all children as an array
+    @model1 = model_class.new(name: 'p1',
+                              child: child_model_class.new(name: 'p1l'))
     @model1.save!
 
-    @model2 = model_class.new(name: "p2",
-                              child: child_model_class.new(name: "p2l"))
+    @model2 = model_class.new(name: 'p2',
+                              child: child_model_class.new(name: 'p2l'))
 
     @model2.save!
 
@@ -30,14 +32,14 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
   def test_serialize_view
     view, _refs = serialize_with_references(ModelView.new(@model1))
 
-    assert_equal({ "_type"    => "Model",
-                   "_version" => 1,
-                   "id"       => @model1.id,
-                   "name"     => @model1.name,
-                   "child"    => { "_type"    => "Child",
-                                   "_version" => 1,
-                                   "id"       => @model1.child.id,
-                                   "name"     => @model1.child.name },
+    assert_equal({ '_type'    => 'Model',
+                   '_version' => 1,
+                   'id'       => @model1.id,
+                   'name'     => @model1.name,
+                   'child'    => { '_type'    => 'Child',
+                                   '_version' => 1,
+                                   'id'       => @model1.child.id,
+                                   'name'     => @model1.child.name },
                  },
                  view)
   end
@@ -53,9 +55,9 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
 
   def test_create_from_view
     view = {
-      "_type"    => "Model",
-      "name"     => "p",
-      "child"    => { "_type" => "Child", "name" => "l" },
+      '_type'    => 'Model',
+      'name'     => 'p',
+      'child'    => { '_type' => 'Child', 'name' => 'l' },
     }
 
     pv = ModelView.deserialize_from_view(view)
@@ -64,10 +66,10 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
     assert(!p.changed?)
     assert(!p.new_record?)
 
-    assert_equal("p", p.name)
+    assert_equal('p', p.name)
 
     assert(p.child.present?)
-    assert_equal("l", p.child.name)
+    assert_equal('l', p.child.name)
   end
 
   def test_create_belongs_to_nil
@@ -86,7 +88,7 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
   def test_belongs_to_create
     @model1.update(child: nil)
 
-    alter_by_view!(ModelView, @model1) do |view, refs|
+    alter_by_view!(ModelView, @model1) do |view, _refs|
       view['child'] = { '_type' => 'Child', 'name' => 'cheese' }
     end
 
@@ -96,7 +98,7 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
   def test_belongs_to_replace
     old_child = @model1.child
 
-    alter_by_view!(ModelView, @model1) do |view, refs|
+    alter_by_view!(ModelView, @model1) do |view, _refs|
       view['child'] = { '_type' => 'Child', 'name' => 'cheese' }
     end
 
@@ -108,7 +110,7 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
     old_p1_child = @model1.child
     old_p2_child = @model2.child
 
-    set_by_view!(ModelView, [@model1, @model2]) do |(p1, p2), refs|
+    set_by_view!(ModelView, [@model1, @model2]) do |(p1, p2), _refs|
       p1['child'] = nil
       p2['child'] = update_hash_for(ChildView, old_p1_child)
     end
@@ -122,7 +124,7 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
     old_p1_child = @model1.child
     old_p2_child = @model2.child
 
-    alter_by_view!(ModelView, [@model1, @model2]) do |(p1, p2), refs|
+    alter_by_view!(ModelView, [@model1, @model2]) do |(p1, p2), _refs|
       p1['child'] = update_hash_for(ChildView, old_p2_child)
       p2['child'] = update_hash_for(ChildView, old_p1_child)
     end
@@ -136,22 +138,22 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
     d_context = ModelView.new_deserialize_context
 
     target_child = Child.create
-    from_model  = Model.create(name: 'from', child: target_child)
-    to_model    = Model.create(name: 'p3')
+    from_model = Model.create(name: 'from', child: target_child)
+    to_model = Model.create(name: 'p3')
 
     alter_by_view!(
       ModelView, [from_model, to_model],
       deserialize_context: d_context
-    ) do |(from, to), refs|
+    ) do |(from, to), _refs|
       from['child'] = nil
       to['child']   = update_hash_for(ChildView, target_child)
     end
 
     assert_equal(target_child, to_model.child, 'target child moved')
     assert_equal([ViewModel::Reference.new(ModelView, from_model.id),
-                  ViewModel::Reference.new(ModelView, to_model.id)],
+                  ViewModel::Reference.new(ModelView, to_model.id),],
                  d_context.valid_edit_refs,
-                 "only models are checked for change; child was not")
+                 'only models are checked for change; child was not')
   end
 
   def test_implicit_release_invalid_belongs_to
@@ -174,11 +176,11 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
           t.integer :deleted_child_id
           t.integer :ignored_child_id
         end,
-        model: ->(m) do
+        model: ->(_m) do
           belongs_to :deleted_child, class_name: Child.name, dependent: :delete
           belongs_to :ignored_child, class_name: Child.name
         end,
-        viewmodel: ->(v) do
+        viewmodel: ->(_v) do
           associations :deleted_child, :ignored_child
         end)
     end
@@ -198,7 +200,7 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
     end
 
     def test_no_gc_dependent_ignore
-      model = model_class.create(ignored_child: Child.new(name: "one"))
+      model = model_class.create(ignored_child: Child.new(name: 'one'))
       old_child = model.ignored_child
 
       alter_by_view!(ModelView, model) do |ov, _refs|
@@ -232,7 +234,7 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
     end
 
     def test_renamed_roundtrip
-      alter_by_view!(ModelView, @model) do |view, refs|
+      alter_by_view!(ModelView, @model) do |view, _refs|
         assert_equal({ 'id'       => @model.child.id,
                        '_type'    => 'Child',
                        '_version' => 1,
@@ -284,7 +286,6 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
       end
     end
 
-
     # Do we support replacing a node in the tree and remodeling its children
     # back to it? In theory we want to, but currently we don't: the child node
     # is unresolvable.
@@ -299,8 +300,8 @@ class ViewModel::ActiveRecord::BelongsToTest < ActiveSupport::TestCase
     def test_move
       model = Aye.create(bee: Bee.new(cee: Cee.new))
       assert_raises(ViewModel::DeserializationError::ParentNotFound) do
-        alter_by_view!(AyeView, model) do |view, refs|
-          view['bee'].delete("id")
+        alter_by_view!(AyeView, model) do |view, _refs|
+          view['bee'].delete('id')
         end
       end
     end

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

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require "minitest/autorun"
-require "minitest/unit"
-require "minitest/hooks"
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/hooks'
 
-require_relative "../../../helpers/arvm_test_models.rb"
-require_relative "../../../helpers/arvm_test_utilities.rb"
-require_relative "../../../helpers/viewmodel_spec_helpers.rb"
+require_relative '../../../helpers/arvm_test_models'
+require_relative '../../../helpers/arvm_test_utilities'
+require_relative '../../../helpers/viewmodel_spec_helpers'
 
-require "view_model"
-require "view_model/active_record"
+require 'view_model'
+require 'view_model/active_record'
 
 # IknowCache uses Rails.cache: create a dummy cache.
 
@@ -34,7 +34,7 @@ class ViewModel::ActiveRecord
     # Defines a cacheable parent Model with a owned Child and a cachable shared Shared.
     module CacheableParentAndChildren
       extend ActiveSupport::Concern
-      include ViewModelSpecHelpers::ParentAndBelongsToChild
+      include ViewModelSpecHelpers::ParentAndBelongsToChildWithMigration
 
       def model_attributes
         super.merge(
@@ -43,7 +43,7 @@ class ViewModel::ActiveRecord
           viewmodel: ->(_) {
             association :shared
             cacheable!
-          }
+          },
         )
       end
 
@@ -64,8 +64,18 @@ class ViewModel::ActiveRecord
 
           define_viewmodel do
             root!
+            self.schema_version = 2
             attributes :name
             cacheable!(cache_group: shared_cache_group)
+            migrates from: 1, to: 2 do
+              up do |view, _references|
+                view['name'] = view.delete('old_name')
+              end
+
+              down do |view, _references|
+                view['old_name'] = view.delete('name')
+              end
+            end
           end
         end
       end
@@ -81,8 +91,8 @@ class ViewModel::ActiveRecord
       end
 
       included do
-        let(:shared)     { shared_model_class.create!(name: "shared1") }
-        let(:root)       { model_class.create!(name: "root1", child: Child.new(name: "owned1"), shared: shared) }
+        let(:shared)     { shared_model_class.create!(name: 'shared1') }
+        let(:root)       { model_class.create!(name: 'root1', child: Child.new(name: 'owned1'), shared: shared) }
         let(:root_view)  { viewmodel_class.new(root) }
       end
     end
@@ -91,10 +101,17 @@ class ViewModel::ActiveRecord
       DUMMY_RAILS_CACHE.clear
     end
 
+    # Request serializations to be migrated to the specified versions
+    let(:migration_versions) { {} }
+
     # Extract the iKnowCaches to verify their contents
     def read_cache(viewmodel_class, id)
       vm_cache = viewmodel_class.viewmodel_cache
-      vm_cache.send(:cache).read(vm_cache.key_for(id))
+      cache_migration_version = vm_cache.migrated_cache_version(migration_versions)
+
+      key = vm_cache.key_for(id, cache_migration_version)
+      iknow_cache = vm_cache.cache_for(cache_migration_version)
+      iknow_cache.read(key)
     end
 
     def serialize_from_database
@@ -102,6 +119,12 @@ class ViewModel::ActiveRecord
       context = viewmodel_class.new_serialize_context
       data    = ViewModel.serialize_to_hash([view], serialize_context: context)
       refs    = context.serialize_references_to_hash
+
+      if migration_versions.present?
+        migrator = ViewModel::DownMigrator.new(migration_versions)
+        migrator.migrate!([data, refs], references: refs)
+      end
+
       [data, refs]
     end
 
@@ -113,7 +136,7 @@ class ViewModel::ActiveRecord
     end
 
     def fetch_with_cache
-      viewmodel_class.viewmodel_cache.fetch([root.id])
+      viewmodel_class.viewmodel_cache.fetch([root.id], migration_versions: migration_versions)
     end
 
     def serialize_with_cache
@@ -160,13 +183,14 @@ class ViewModel::ActiveRecord
 
             # The cached reference must correspond to the returned data.
             parsed_data = JSON.parse(ref_data)
-            value(parsed_data["id"]).must_equal(id)
-            value(parsed_data["_type"]).must_equal(view_name)
+            value(parsed_data['id']).must_equal(id)
+            value(parsed_data['_type']).must_equal(view_name)
 
             # When the cached reference is to independently cached data
             # (SharedView in this test), make sure that data is correctly
             # cached.
-            next unless view_name == "Shared"
+            next unless view_name == 'Shared'
+
             value(id).must_equal(shared.id)
             cached_shared = read_cache(shared_viewmodel_class, id)
             value(cached_shared).must_be(:present?)
@@ -179,7 +203,20 @@ class ViewModel::ActiveRecord
 
     describe 'with owned and shared children' do
       include CacheableParentAndChildren
-      include BehavesLikeACache
+
+      describe 'without migrations' do
+        include BehavesLikeACache
+      end
+
+      describe 'with migrations' do
+        let(:migration_versions) { { viewmodel_class => 1, child_viewmodel_class => 2 } }
+        include BehavesLikeACache
+      end
+
+      describe 'with shared migrations' do
+        let(:migration_versions) { { shared_viewmodel_class => 1 } }
+        include BehavesLikeACache
+      end
 
       describe 'with a record in the cache' do
         # Fetch the root record to ensure it's in the cache
@@ -188,8 +225,8 @@ class ViewModel::ActiveRecord
         end
 
         def change_in_database
-          root.update_attribute(:name, "CHANGEDROOT")
-          shared.update_attribute(:name, "CHANGEDSHARED")
+          root.update_attribute(:name, 'CHANGEDROOT')
+          shared.update_attribute(:name, 'CHANGEDSHARED')
         end
 
         it 'resolves from the cache' do
@@ -207,7 +244,7 @@ class ViewModel::ActiveRecord
           viewmodel_class.viewmodel_cache.clear
 
           cache_data, cache_refs = serialize_with_cache
-          value(cache_data[0]["name"]).must_equal("CHANGEDROOT") # Root view invalidated
+          value(cache_data[0]['name']).must_equal('CHANGEDROOT') # Root view invalidated
           value(cache_refs).must_equal(before_refs) # Shared view not invalidated
         end
 
@@ -265,7 +302,7 @@ class ViewModel::ActiveRecord
           viewmodel_class.viewmodel_cache.delete(root.id)
 
           cache_data, cache_refs = serialize_with_cache
-          value(cache_data[0]["name"]).must_equal("CHANGEDROOT")
+          value(cache_data[0]['name']).must_equal('CHANGEDROOT')
           value(cache_refs).must_equal(before_refs)
         end
 
@@ -275,8 +312,8 @@ class ViewModel::ActiveRecord
 
           # Shared view invalidated, but root view not
           cache_data, cache_hrefs = serialize_with_cache
-          value(cache_data[0]["name"]).must_equal("root1")
-          value(cache_hrefs.values[0]["name"]).must_equal("CHANGEDSHARED")
+          value(cache_data[0]['name']).must_equal('root1')
+          value(cache_hrefs.values[0]['name']).must_equal('CHANGEDSHARED')
         end
 
         it 'can clear a cache via its external cache group' do
@@ -285,12 +322,12 @@ class ViewModel::ActiveRecord
 
           # Shared view invalidated, but root view not
           cache_data, cache_hrefs = serialize_with_cache
-          value(cache_data[0]["name"]).must_equal("root1")
-          value(cache_hrefs.values[0]["name"]).must_equal("CHANGEDSHARED")
+          value(cache_data[0]['name']).must_equal('root1')
+          value(cache_hrefs.values[0]['name']).must_equal('CHANGEDSHARED')
         end
 
         describe 'and a record not in the cache' do
-          let(:root2) { model_class.create!(name: "root2", child: Child.new(name: "owned2"), shared: shared) }
+          let(:root2) { model_class.create!(name: 'root2', child: Child.new(name: 'owned2'), shared: shared) }
 
           def serialize_from_database
             views   = model_class.find(root.id, root2.id).map { |r| viewmodel_class.new(r) }
@@ -318,21 +355,21 @@ class ViewModel::ActiveRecord
             change_in_database
 
             cache_data, cache_refs = serialize_with_cache
-            value(cache_data[0]["name"]).must_equal("root1")
-            value(cache_data[1]["name"]).must_equal("root2")
+            value(cache_data[0]['name']).must_equal('root1')
+            value(cache_data[1]['name']).must_equal('root2')
             value(cache_refs).must_equal(refs)
           end
         end
       end
     end
 
-    describe "with a non-cacheable shared child" do
+    describe 'with a non-cacheable shared child' do
       include ViewModelSpecHelpers::ParentAndSharedBelongsToChild
       def model_attributes
         super.merge(viewmodel: ->(_) { cacheable! })
       end
 
-      let(:root)       { model_class.create!(name: "root1", child: Child.new(name: "owned1")) }
+      let(:root)       { model_class.create!(name: 'root1', child: Child.new(name: 'owned1')) }
       let(:root_view)  { viewmodel_class.new(root) }
 
       include BehavesLikeACache