iknow_view_models 3.2.13 → 3.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3991314cdb010347b417869ff3e2e22b0e7adb4ab590e25739cb6b12bf49a219
-  data.tar.gz: 0cd5994d07bdd9b9d311732be56b01a51d7b4f1eb71f7fa1d0217bf71911b97f
+  metadata.gz: ae5588513419124ea7eac511b571af52ea42e23d9bf87c01cf59a60af50e8055
+  data.tar.gz: c7de424a0a465c65fa4ba6823f7aa3743c69c0d41a8efa9da9c67efb030931d8
 SHA512:
-  metadata.gz: a5cd70dd6f79db33a97dbdfb05eefec460c7e332784839ad461cf5a359307ce8abedb39c046d42d04a3b7355280d1ad54948cb6cc61fdc35effa0f684ea4c821
-  data.tar.gz: 6a673b6387892588434f981b57f8131e9c7a97991cc16d3901e72f043b9429efd0fef7a8e1f44cb0ea1ee364256d63d48f198a10e270b487d3da61311780eec7
+  metadata.gz: dbcde44426aa3f49d963f4f6588ea49f2fce10ae616e8dd5d78af30bac20a09381fe2e369829b92888c23078136f12a2f6a4b2fd49be17e4920927ed918dc04d
+  data.tar.gz: da13c596cb4ec09f17d74c79d9c2c17b8e3b9b2405856b49355f8d02be015d8cb430984fc2adf1c6f3fa668332152b8d440e5972204b66694d0a181cc1213f52

data/.circleci/config.yml

@@ -111,6 +111,11 @@ workflows:
           ruby-version: "2.7"
           pg-version: "12"
           gemfile: gemfiles/rails_6_0.gemfile
+      - test:
+          name: 'ruby 2.7 rails 6.1 pg 12'
+          ruby-version: "2.7"
+          pg-version: "12"
+          gemfile: gemfiles/rails_6_1.gemfile
       - publish:
           filters:
             branches:

data/Appraisals

@@ -7,3 +7,8 @@ appraise 'rails-6-0' do
   gem 'activerecord', '~> 6.0.0'
   gem 'activesupport', '~> 6.0.0'
 end
+
+appraise 'rails-6-1' do
+  gem 'activerecord', '~> 6.1.0'
+  gem 'activesupport', '~> 6.1.0'
+end

data/README.md

@@ -1,6 +1,6 @@
 # IknowViewModels
 
-[![Build Status](https://travis-ci.org/iknow/iknow_view_models.svg?branch=master)](https://travis-ci.org/iknow/iknow_view_models)
+[![Build Status](https://circleci.com/gh/iknow/iknow_view_models.svg?style=svg)](https://circleci.com/gh/iknow/iknow_view_models/)
 
 ViewModels provide a means of encapsulating a collection of related data and specifying its JSON serialization.
 

data/gemfiles/rails_6_1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'minitest-ci'
+gem 'activerecord', '~> 6.1.0'
+gem 'activesupport', '~> 6.1.0'
+
+gemspec path: '../'

data/lib/iknow_view_models/version.rb

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

data/lib/view_model.rb

@@ -173,6 +173,17 @@ class ViewModel
       Jbuilder.new { |json| serialize(viewmodel, json, serialize_context: serialize_context) }.attributes!
     end
 
+    def serialize_from_cache(views, migration_versions: {}, locked: false, serialize_context:)
+      plural = views.is_a?(Array)
+      views = Array.wrap(views)
+
+      json_views, json_refs = ViewModel::ActiveRecord::Cache.render_viewmodels_from_cache(
+                    views, locked: locked, migration_versions: migration_versions, serialize_context: serialize_context)
+
+      json_views = json_views.first unless plural
+      return json_views, json_refs
+    end
+
     def encode_json(value)
       # Jbuilder#encode no longer uses MultiJson, but instead calls `.to_json`. In
       # the context of ActiveSupport, we don't want this, because AS replaces the

data/lib/view_model/active_record/cache.rb

@@ -11,6 +11,30 @@ class ViewModel::ActiveRecord::Cache
 
   attr_reader :viewmodel_class
 
+  class << self
+    def render_viewmodels_from_cache(viewmodels, migration_versions: {}, locked: false, serialize_context: nil)
+      if viewmodels.empty?
+        return [], {}
+      end
+
+      ids = viewmodels.map(&:id)
+      # ideally the roots wouldn't have to all be the same type
+      viewmodel_class = viewmodels.first.class
+      serialize_context ||= viewmodel_class.new_serialize_context
+
+      render_from_cache(viewmodel_class, ids,
+                        initial_viewmodels: viewmodels,
+                        migration_versions: migration_versions,
+                        locked: locked,
+                        serialize_context: serialize_context)
+    end
+
+    def render_from_cache(viewmodel_class, ids, initial_viewmodels: nil, migration_versions: {}, locked: false, serialize_context: viewmodel_class.new_serialize_context)
+      worker = CacheWorker.new(migration_versions: migration_versions, serialize_context: serialize_context)
+      worker.render_from_cache(viewmodel_class, ids, initial_viewmodels: initial_viewmodels, locked: locked)
+    end
+  end
+
   # If cache_group: is specified, it must be a group of a single key: `:id`
   def initialize(viewmodel_class, cache_group: nil)
     @viewmodel_class = viewmodel_class
@@ -35,85 +59,98 @@ class ViewModel::ActiveRecord::Cache
     @cache_group.invalidate_cache_group
   end
 
+  # @deprecated Replaced by class methods
   def fetch_by_viewmodel(viewmodels, migration_versions: {}, locked: false, serialize_context: @viewmodel_class.new_serialize_context)
     ids = viewmodels.map(&:id)
     fetch(ids, initial_viewmodels: viewmodels, migration_versions: migration_versions, locked: locked, serialize_context: serialize_context)
   end
 
+  # @deprecated Replaced by class methods
   def fetch(ids, initial_viewmodels: nil, migration_versions: {}, locked: false, serialize_context: @viewmodel_class.new_serialize_context)
-    data_serializations = Array.new(ids.size)
-    worker = CacheWorker.new(migration_versions: migration_versions, serialize_context: serialize_context)
-
-    # If initial root viewmodels were provided, visit them to ensure that they
-    # are visible. Other than this, no traversal callbacks are performed, as a
-    # view may be resolved from the cache without ever loading its viewmodel.
-    # Note that if unlocked, these views will be reloaded as part of obtaining a
-    # share lock. If the visibility of this viewmodel can change due to edits,
-    # it is necessary to obtain a lock before calling `fetch`.
-    initial_viewmodels&.each do |v|
-      serialize_context.run_callback(ViewModel::Callbacks::Hook::BeforeVisit, v)
-      serialize_context.run_callback(ViewModel::Callbacks::Hook::AfterVisit, v)
-    end
+    self.class.render_from_cache(@viewmodel_class, ids,
+                                 initial_viewmodels: initial_viewmodels, locked: locked,
+                                 migration_versions: migration_versions, serialize_context: serialize_context)
+  end
 
-    # Collect input array positions for each id, allowing duplicates
-    positions = ids.each_with_index.with_object({}) do |(id, i), h|
-      (h[id] ||= []) << i
-    end
+  class CacheWorker
+    SENTINEL = Object.new
+    WorklistEntry = Struct.new(:ref_name, :viewmodel)
 
-    # Fetch duplicates only once
-    ids = positions.keys
+    attr_reader :migration_versions, :serialize_context, :resolved_references
 
-    # Load existing serializations from the cache
-    cached_serializations = worker.load_from_cache(self, ids)
-    cached_serializations.each do |id, data|
-      positions[id].each do |idx|
-        data_serializations[idx] = data
-      end
+    def initialize(migration_versions:, serialize_context:)
+      @worklist                = {} # Hash[type_name, Hash[id, WorklistEntry]]
+      @resolved_references     = {} # Hash[refname, json]
+      @migration_versions      = migration_versions
+      @migrated_cache_versions = {}
+      @serialize_context       = serialize_context
     end
 
-    # Resolve and serialize missing views
-    missing_ids = ids.to_set.subtract(cached_serializations.keys)
+    def render_from_cache(viewmodel_class, ids, initial_viewmodels: nil, locked: false)
+      viewmodel_class.transaction do
+        root_serializations = Array.new(ids.size)
 
-    # If initial viewmodels have been locked, we can serialize them for cache
-    #  misses.
-    available_viewmodels =
-      if locked
-        initial_viewmodels&.each_with_object({}) do |vm, h|
-          h[vm.id] = vm if missing_ids.include?(vm.id)
+        # Collect input array positions for each id, allowing duplicates
+        positions = ids.each_with_index.with_object({}) do |(id, i), h|
+          (h[id] ||= []) << i
         end
-      end
 
-    @viewmodel_class.transaction do
-      # Load remaining views and serialize
-      viewmodels = worker.find_and_preload_viewmodels(@viewmodel_class, missing_ids.to_a,
-                                                      available_viewmodels: available_viewmodels)
+        # If duplicates are specified, fetch each only once
+        ids = positions.keys
+
+        ids_to_render = ids.to_set
+
+        if viewmodel_class < CacheableView
+          # Load existing serializations from the cache
+          cached_serializations = load_from_cache(viewmodel_class.viewmodel_cache, ids)
+          cached_serializations.each do |id, data|
+            positions[id].each do |idx|
+              root_serializations[idx] = data
+            end
+          end
 
-      loaded_serializations = worker.serialize_and_cache(viewmodels)
-      loaded_serializations.each do |id, data|
-        positions[id].each do |idx|
-          data_serializations[idx] = data
+          ids_to_render.subtract(cached_serializations.keys)
+
+          # If initial root viewmodels were provided, call hooks on any
+          # viewmodels which were rendered from the cache to ensure that the
+          # root is visible (in isolation). Other than this, no traversal
+          # callbacks are performed for cache-rendered views. This particularly
+          # requires care for references: if a visible view may refer to
+          # non-visible cacheable views, those referenced views will not be
+          # access control checked.
+          initial_viewmodels&.each do |v|
+            next unless cached_serializations.has_key?(v.id)
+            serialize_context.run_callback(ViewModel::Callbacks::Hook::BeforeVisit, v)
+            serialize_context.run_callback(ViewModel::Callbacks::Hook::AfterVisit, v)
+          end
         end
-      end
 
-      # Resolve references
-      worker.resolve_references!
+        # Render remaining views. If initial viewmodels have been locked, we may
+        # use them to serialize from, otherwise we must reload with share lock
+        # in find_and_preload.
+        available_viewmodels =
+          if locked
+            initial_viewmodels&.each_with_object({}) do |vm, h|
+              h[vm.id] = vm if ids_to_render.include?(vm.id)
+            end
+          end
 
-      return data_serializations, worker.resolved_references
-    end
-  end
+        viewmodels = find_and_preload_viewmodels(viewmodel_class, ids_to_render.to_a,
+                                                 available_viewmodels: available_viewmodels)
 
-  class CacheWorker
-    SENTINEL = Object.new
-    WorklistEntry = Struct.new(:ref_name, :viewmodel)
+        loaded_serializations = serialize_and_cache(viewmodels)
 
-    attr_reader :migration_versions, :serialize_context, :resolved_references
+        loaded_serializations.each do |id, data|
+          positions[id].each do |idx|
+            root_serializations[idx] = data
+          end
+        end
 
-    def initialize(migration_versions:, serialize_context:)
-      @worklist                = {}
-      @resolved_references     = {}
-      @migration_versions      = migration_versions
-      @migrated_cache_versions = {}
-      @serialize_context       = serialize_context
+        # recursively resolve referenced views
+        self.resolve_references!
+
+        [root_serializations, self.resolved_references]
+      end
     end
 
     def resolve_references!

data/lib/view_model/active_record/cache/cacheable_view.rb

@@ -39,14 +39,6 @@ module ViewModel::ActiveRecord::Cache::CacheableView
     def viewmodel_cache
       @viewmodel_cache
     end
-
-    def serialize_from_cache(views, migration_versions: {}, locked: false, serialize_context:)
-      plural = views.is_a?(Array)
-      views = Array.wrap(views)
-      json_views, json_refs = viewmodel_cache.fetch_by_viewmodel(views, locked: locked, migration_versions: migration_versions, serialize_context: serialize_context)
-      json_views = json_views.first unless plural
-      return json_views, json_refs
-    end
   end
 
   # Clear the cache if the view or its nested children were changed during

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

@@ -135,8 +135,8 @@ class ViewModel::ActiveRecord
       [data, refs]
     end
 
-    def fetch_with_cache
-      viewmodel_class.viewmodel_cache.fetch([root.id], migration_versions: migration_versions)
+    def fetch_with_cache(**rest)
+      ViewModel::ActiveRecord::Cache.render_from_cache(viewmodel_class, [root.id], migration_versions: migration_versions, **rest)
     end
 
     def serialize_with_cache
@@ -206,6 +206,19 @@ class ViewModel::ActiveRecord
 
       describe 'without migrations' do
         include BehavesLikeACache
+
+        it 'returns the right serialization with provided initial viewmodel' do
+          fetched_result = parse_result(fetch_with_cache(initial_viewmodels: [root_view]))
+
+          value(fetched_result).must_equal(serialize_from_database)
+        end
+
+        it 'returns the right serialization with provided locked initial viewmodel' do
+          locked_root_view = viewmodel_class.new(model_class.lock("FOR SHARE").find(root.id))
+          fetched_result = parse_result(fetch_with_cache(initial_viewmodels: [locked_root_view], locked: true))
+
+          value(fetched_result).must_equal(serialize_from_database)
+        end
       end
 
       describe 'with migrations' do
@@ -337,8 +350,8 @@ class ViewModel::ActiveRecord
             [data, refs]
           end
 
-          def fetch_with_cache
-            viewmodel_class.viewmodel_cache.fetch([root.id, root2.id])
+          def fetch_with_cache(**rest)
+            ViewModel::ActiveRecord::Cache.render_from_cache(viewmodel_class, [root.id, root2.id], **rest)
           end
 
           it 'merges matching shared references between cache hits and misses' do
@@ -376,8 +389,8 @@ class ViewModel::ActiveRecord
     end
 
     describe 'when fetched by viewmodel' do
-      def fetch_with_cache
-        viewmodel_class.viewmodel_cache.fetch_by_viewmodel([root_view])
+      def fetch_with_cache(**rest)
+        ViewModel::ActiveRecord::Cache.render_viewmodels_from_cache([root_view], **rest)
       end
 
       include CacheableParentAndChildren

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_view_models
 version: !ruby/object:Gem::Version
-  version: 3.2.13
+  version: 3.2.14
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-19 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -379,6 +379,7 @@ files:
 - Rakefile
 - gemfiles/rails_5_2.gemfile
 - gemfiles/rails_6_0.gemfile
+- gemfiles/rails_6_1.gemfile
 - iknow_view_models.gemspec
 - lib/iknow_view_models.rb
 - lib/iknow_view_models/railtie.rb