iknow_view_models 3.1.8 → 3.2.0

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

@@ -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
@@ -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
@@ -179,7 +202,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

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

@@ -109,6 +109,24 @@ class ViewModel::ActiveRecord::ControllerTest < ActiveSupport::TestCase
     assert_all_hooks_nested_inside_parent_hook(parentcontroller.hook_trace)
   end
 
+  def test_migrated_show
+    parentcontroller = ParentController.new(id: @parent.id, versions: { ParentView.view_name => 1 })
+    parentcontroller.invoke(:show)
+
+    expected_view = @parent_view.to_hash
+                      .except('name')
+                      .merge('old_name' => @parent.name,
+                             ViewModel::VERSION_ATTRIBUTE => 1,
+                             ViewModel::MIGRATED_ATTRIBUTE => true)
+
+    assert_equal({ 'data' => expected_view },
+                 parentcontroller.hash_response)
+
+    assert_equal(200, parentcontroller.status)
+
+    assert_all_hooks_nested_inside_parent_hook(parentcontroller.hook_trace)
+  end
+
   def test_index
     p2      = Parent.create(name: "p2")
     p2_view = ParentView.new(p2)
@@ -148,6 +166,22 @@ class ViewModel::ActiveRecord::ControllerTest < ActiveSupport::TestCase
     assert_all_hooks_nested_inside_parent_hook(parentcontroller.hook_trace)
   end
 
+  def test_migrated_create
+    data = {
+      '_type'    => 'Parent',
+      '_version' => 1,
+      'old_name' => 'p2',
+    }
+
+    parentcontroller = ParentController.new(data: data, versions: { ParentView.view_name => 1 })
+    parentcontroller.invoke(:create)
+
+    assert_equal(200, parentcontroller.status)
+
+    p2 = Parent.where(name: 'p2').first
+    assert(p2.present?, 'p2 created')
+  end
+
   def test_create_empty
     parentcontroller = ParentController.new(data: [])
     parentcontroller.invoke(:create)

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

@@ -0,0 +1,161 @@
+require_relative "../../../helpers/arvm_test_utilities.rb"
+require_relative "../../../helpers/arvm_test_models.rb"
+require_relative "../../../helpers/viewmodel_spec_helpers.rb"
+
+require "minitest/autorun"
+
+require "view_model/active_record"
+
+class ViewModel::ActiveRecord::Migration < ActiveSupport::TestCase
+  include ARVMTestUtilities
+  extend Minitest::Spec::DSL
+
+  include ViewModelSpecHelpers::ParentAndBelongsToChildWithMigration
+
+  def new_model
+    model_class.new(name: 'm1', child: child_model_class.new(name: 'c1'))
+  end
+
+  let(:viewmodel) { create_viewmodel! }
+
+  let(:current_serialization) { ViewModel.serialize_to_hash(viewmodel) }
+
+  let(:v2_serialization) do
+    {
+      ViewModel::TYPE_ATTRIBUTE => viewmodel_class.view_name,
+      ViewModel::VERSION_ATTRIBUTE => 2,
+      ViewModel::ID_ATTRIBUTE => viewmodel.id,
+      'name' => viewmodel.name,
+      'old_field' => 1,
+      'child' => {
+        ViewModel::TYPE_ATTRIBUTE => child_viewmodel_class.view_name,
+        ViewModel::VERSION_ATTRIBUTE => 2,
+        ViewModel::ID_ATTRIBUTE => viewmodel.child.id,
+        'name' => viewmodel.child.name,
+        'former_field' => 'former_value',
+      }
+    }
+  end
+
+  let(:migration_versions) { { viewmodel_class => 2, child_viewmodel_class => 2 } }
+
+  let(:down_migrator) { ViewModel::DownMigrator.new(migration_versions) }
+  let(:up_migrator) { ViewModel::UpMigrator.new(migration_versions) }
+
+  def migrate!
+    migrator.migrate!(subject, references: {})
+  end
+
+
+  describe 'downwards' do
+    let(:migrator) { down_migrator }
+    let(:subject) { current_serialization.deep_dup }
+
+    let(:expected_result) do
+      v2_serialization.deep_merge(
+        {
+          ViewModel::MIGRATED_ATTRIBUTE => true,
+          'old_field' => -1,
+          'child' => {
+            ViewModel::MIGRATED_ATTRIBUTE => true,
+            'former_field' => 'reconstructed'
+          }
+        }
+      )
+    end
+
+    it 'migrates' do
+      migrate!
+
+      assert_equal(expected_result, subject)
+    end
+
+
+    describe 'to an unreachable version' do
+      let(:migration_versions) { { viewmodel_class => 2, child_viewmodel_class => 1 } }
+
+      it 'raises' do
+        assert_raises(ViewModel::Migration::NoPathError) do
+          migrate!
+        end
+      end
+    end
+  end
+
+  describe 'upwards' do
+    let(:migrator) { up_migrator }
+    let(:subject) { v2_serialization.deep_dup }
+
+    let(:expected_result) do
+      current_serialization.deep_merge(
+        ViewModel::MIGRATED_ATTRIBUTE => true,
+        'new_field' => 3,
+        'child' => {
+          ViewModel::MIGRATED_ATTRIBUTE => true,
+        }
+      )
+    end
+
+    it 'migrates' do
+      migrate!
+
+      assert_equal(expected_result, subject)
+    end
+
+    describe 'with version unspecified' do
+      let(:subject) do
+        v2_serialization
+          .except(ViewModel::VERSION_ATTRIBUTE)
+      end
+
+      it 'treats it as the requested version' do
+        migrate!
+        assert_equal(expected_result, subject)
+      end
+    end
+
+    describe 'with a version not in the specification' do
+      let(:subject) do
+        v2_serialization
+          .except('old_field')
+          .deep_merge(ViewModel::VERSION_ATTRIBUTE => 3, 'mid_field' => 1)
+      end
+
+      it 'rejects it' do
+        assert_raises(ViewModel::Migration::UnspecifiedVersionError) do
+          migrate!
+        end
+      end
+    end
+
+    describe 'from an unreachable version' do
+      let(:migration_versions) { { viewmodel_class => 2, child_viewmodel_class => 1 } }
+
+      let(:subject) do
+        v2_serialization.deep_merge(
+          'child' => { ViewModel::VERSION_ATTRIBUTE => 1 }
+        )
+      end
+
+      it 'raises' do
+        assert_raises(ViewModel::Migration::NoPathError) do
+          migrate!
+        end
+      end
+    end
+
+    describe 'in an undefined direction' do
+      let(:migration_versions) { { viewmodel_class => 1, child_viewmodel_class => 2 } }
+
+      let(:subject) do
+        v2_serialization.except('old_field').merge(ViewModel::VERSION_ATTRIBUTE => 1)
+      end
+
+      it 'raises' do
+        assert_raises(ViewModel::Migration::OneWayError) do
+          migrate!
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_view_models
 version: !ruby/object:Gem::Version
-  version: 3.1.8
+  version: 3.2.0
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rgl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -280,16 +294,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -357,15 +371,14 @@ files:
 - ".envrc"
 - ".gitignore"
 - ".idea/codeStyleSettings.xml"
-- ".travis.yml"
+- ".rubocop.yml"
 - Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- appveyor.yml
 - gemfiles/rails_5_2.gemfile
-- gemfiles/rails_6_0_beta.gemfile
+- gemfiles/rails_6_0.gemfile
 - iknow_view_models.gemspec
 - lib/iknow_view_models.rb
 - lib/iknow_view_models/railtie.rb
@@ -401,6 +414,12 @@ files:
 - lib/view_model/deserialize_context.rb
 - lib/view_model/error.rb
 - lib/view_model/error_view.rb
+- lib/view_model/migratable_view.rb
+- lib/view_model/migration.rb
+- lib/view_model/migration/no_path_error.rb
+- lib/view_model/migration/one_way_error.rb
+- lib/view_model/migration/unspecified_version_error.rb
+- lib/view_model/migrator.rb
 - lib/view_model/record.rb
 - lib/view_model/record/attribute_data.rb
 - lib/view_model/reference.rb
@@ -414,6 +433,7 @@ files:
 - lib/view_model/traversal_context.rb
 - lib/view_model/utils.rb
 - lib/view_model/utils/collections.rb
+- nix/dependencies.nix
 - nix/gem/generate.rb
 - shell.nix
 - test/config/database.yml
@@ -437,6 +457,7 @@ files:
 - test/unit/view_model/active_record/has_many_through_poly_test.rb
 - test/unit/view_model/active_record/has_many_through_test.rb
 - test/unit/view_model/active_record/has_one_test.rb
+- test/unit/view_model/active_record/migration_test.rb
 - test/unit/view_model/active_record/namespacing_test.rb
 - test/unit/view_model/active_record/poly_test.rb
 - test/unit/view_model/active_record/shared_test.rb
@@ -494,6 +515,7 @@ test_files:
 - test/unit/view_model/active_record/has_many_through_poly_test.rb
 - test/unit/view_model/active_record/has_many_through_test.rb
 - test/unit/view_model/active_record/has_one_test.rb
+- test/unit/view_model/active_record/migration_test.rb
 - test/unit/view_model/active_record/namespacing_test.rb
 - test/unit/view_model/active_record/poly_test.rb
 - test/unit/view_model/active_record/shared_test.rb

data/.travis.yml

@@ -1,31 +0,0 @@
-dist: trusty
-sudo: false
-language: ruby
-cache: bundler
-
-rvm:
-  - 2.5
-
-gemfile:
-  - gemfiles/rails_5_2.gemfile
-
-addons:
-  postgresql: "10"
-  apt:
-    packages:
-      - postgresql-10
-      - postgresql-client-10
-      - postgresql-server-dev-10
-env:
-  global:
-    - PGPORT=5433
-
-before_install:
-  - gem update --system
-  - gem install bundler
-
-before_script:
-  - psql -c 'CREATE DATABASE iknow_view_models;'
-
-notifications:
-  email: false