iknow_view_models 3.1.6 → 3.2.2

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

@@ -40,10 +40,10 @@ module ViewModel::ActiveRecord::Cache::CacheableView
       @viewmodel_cache
     end
 
-    def serialize_from_cache(views, serialize_context:)
+    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, serialize_context: serialize_context)
+      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

data/lib/view_model/active_record/collection_nested_controller.rb

@@ -47,7 +47,7 @@ module ViewModel::ActiveRecord::CollectionNestedController
       after  = parse_relative_position(:after)
 
       if before && after
-        raise ViewModel::DeserializationError::InvalidSyntax.new("Can not provide both `before` and `after` anchors for a collection append")
+        raise ViewModel::DeserializationError::InvalidSyntax.new('Can not provide both `before` and `after` anchors for a collection append')
       end
 
       owner_view = owner_viewmodel.find(owner_viewmodel_id, eager_include: false, serialize_context: serialize_context)
@@ -55,8 +55,8 @@ module ViewModel::ActiveRecord::CollectionNestedController
       assoc_view = owner_view.append_associated(association_name,
                                                 update_hash,
                                                 references: refs,
-                                                before:     before,
-                                                after:      after,
+                                                before: before,
+                                                after: after,
                                                 deserialize_context: deserialize_context)
       ViewModel::Callbacks.wrap_serialize(owner_view, context: serialize_context) do
         child_context = owner_view.context_for_child(association_name, context: serialize_context)

data/lib/view_model/active_record/controller.rb

@@ -17,6 +17,8 @@ module ViewModel::ActiveRecord::Controller
   include ViewModel::ActiveRecord::CollectionNestedController
   include ViewModel::ActiveRecord::SingularNestedController
 
+  MIGRATION_VERSION_HEADER = 'X-ViewModel-Versions'
+
   def show(scope: nil, viewmodel_class: self.viewmodel_class, serialize_context: new_serialize_context(viewmodel_class: viewmodel_class))
     view = nil
     pre_rendered = viewmodel_class.transaction do
@@ -62,7 +64,29 @@ module ViewModel::ActiveRecord::Controller
   end
 
   included do
-    etag { self.viewmodel_class.deep_schema_version }
+    etag { migrated_deep_schema_version }
+  end
+
+  def parse_viewmodel_updates
+    super.tap do |update_hash, refs|
+      if migration_versions.present?
+        migrator = ViewModel::UpMigrator.new(migration_versions)
+        migrator.migrate!([update_hash, refs], references: refs)
+      end
+    end
+  end
+
+  def prerender_viewmodel(*)
+    super do |jbuilder|
+      yield(jbuilder) if block_given?
+
+      # migrate the resulting structure before it's serialized to a json string
+      if migration_versions.present?
+        tree = jbuilder.attributes!
+        migrator = ViewModel::DownMigrator.new(migration_versions)
+        migrator.migrate!(tree, references: tree['references'])
+      end
+    end
   end
 
   private
@@ -70,4 +94,47 @@ module ViewModel::ActiveRecord::Controller
   def viewmodel_id
     parse_param(:id)
   end
+
+  def migration_versions
+    @migration_versions ||=
+      begin
+        version_spec =
+          if params.include?(:versions)
+            params[:versions]
+          elsif request.headers.include?(MIGRATION_VERSION_HEADER)
+            begin
+              JSON.parse(request.headers[MIGRATION_VERSION_HEADER])
+            rescue JSON::ParserError
+              raise ViewModel::Error.new(status: 400, detail: "Invalid JSON in #{MIGRATION_VERSION_HEADER}")
+            end
+          else
+            {}
+          end
+
+        versions =
+          IknowParams::Parser.parse_value(
+            version_spec,
+            with: IknowParams::Serializer::HashOf.new(
+              IknowParams::Serializer::String, IknowParams::Serializer::Integer))
+
+        migration_versions = {}
+
+        versions.each do |view_name, required_version|
+          viewmodel_class = ViewModel::Registry.for_view_name(view_name)
+
+          if viewmodel_class.schema_version != required_version
+            migration_versions[viewmodel_class] = required_version
+          end
+        rescue ViewModel::DeserializationError::UnknownView
+          # Ignore requests to migrate types that no longer exist
+          next
+        end
+
+        migration_versions.freeze
+      end
+  end
+
+  def migrated_deep_schema_version
+    ViewModel::Migrator.migrated_deep_schema_version(viewmodel_class, migration_versions, include_referenced: true)
+  end
 end

data/lib/view_model/active_record/controller_base.rb

@@ -33,7 +33,7 @@ module ViewModel::ActiveRecord::ControllerBase
         if (match = /(.*)Controller$/.match(self.name))
           self.viewmodel_name = match[1].singularize
         else
-          raise ArgumentError.new("Could not auto-determine ViewModel from Controller name '#{self.name}'") if match.nil?
+          raise ArgumentError.new("Could not auto-determine ViewModel from Controller name '#{self.name}'")
         end
       end
       @viewmodel_class
@@ -43,6 +43,7 @@ module ViewModel::ActiveRecord::ControllerBase
       unless instance_variable_defined?(:@access_control)
         raise ArgumentError.new("AccessControl instance not set for Controller '#{self.name}'")
       end
+
       @access_control
     end
 
@@ -64,6 +65,7 @@ module ViewModel::ActiveRecord::ControllerBase
       unless type < ViewModel
         raise ArgumentError.new("'#{type.inspect}' is not a valid ViewModel")
       end
+
       @viewmodel_class = type
     end
 
@@ -75,6 +77,7 @@ module ViewModel::ActiveRecord::ControllerBase
       unless access_control.is_a?(Class) && access_control < ViewModel::AccessControl
         raise ArgumentError.new("'#{access_control.inspect}' is not a valid AccessControl")
       end
+
       @access_control = access_control
     end
   end

data/lib/view_model/active_record/nested_controller_base.rb

@@ -88,6 +88,7 @@ module ViewModel::ActiveRecord::NestedControllerBase
 
       self.owner_viewmodel = owner
       raise ArgumentError.new("Could not find owner ViewModel class '#{owner_name}'") if owner_viewmodel.nil?
+
       self.association_name = as
     end
   end

data/lib/view_model/active_record/update_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Assembles an update operation tree from user input. Handles the interlinking
 # and model of update operations, but does not handle the actual user data nor
 # the mechanism by which it is applied to models.
@@ -66,7 +68,7 @@ class ViewModel::ActiveRecord
         .assemble_update_tree
     end
 
-    # TODO an unfortunate abstraction violation. The `append` case constructs an
+    # TODO: an unfortunate abstraction violation. The `append` case constructs an
     # update tree and later injects the context of parent and position.
     def root_updates
       @root_update_operations
@@ -143,7 +145,7 @@ class ViewModel::ActiveRecord
           if ref.nil?
             @root_update_operations << update_op
           else
-            # TODO make sure that referenced subtree hashes are unique and provide a decent error message
+            # TODO: make sure that referenced subtree hashes are unique and provide a decent error message
             # not strictly necessary, but will save confusion
             @referenced_update_operations[ref] = update_op
           end
@@ -200,9 +202,9 @@ class ViewModel::ActiveRecord
         deferred_update.build!(self)
       end
 
-      dangling_references = @referenced_update_operations.reject { |ref, upd| upd.built? }.map { |ref, upd| upd.viewmodel.to_reference }
+      dangling_references = @referenced_update_operations.reject { |_ref, upd| upd.built? }.map { |_ref, upd| upd.viewmodel.to_reference }
       if dangling_references.present?
-        raise ViewModel::DeserializationError::InvalidStructure.new("References not referred to from roots", dangling_references)
+        raise ViewModel::DeserializationError::InvalidStructure.new('References not referred to from roots', dangling_references)
       end
 
       self
@@ -265,8 +267,8 @@ class ViewModel::ActiveRecord
     # individual node that caused it, without attempting to parse Postgres'
     # human-readable error details.
     def check_deferred_constraints!(model_class)
-      if model_class.connection.adapter_name == "PostgreSQL"
-        model_class.connection.execute("SET CONSTRAINTS ALL IMMEDIATE")
+      if model_class.connection.adapter_name == 'PostgreSQL'
+        model_class.connection.execute('SET CONSTRAINTS ALL IMMEDIATE')
       end
     rescue ::ActiveRecord::StatementInvalid => ex
       raise ViewModel::DeserializationError::DatabaseConstraint.from_exception(ex)

data/lib/view_model/active_record/update_data.rb

@@ -24,6 +24,7 @@ class ViewModel::ActiveRecord
       NAME = 'append'
       attr_accessor :before, :after
       attr_reader :contents
+
       def initialize(contents)
         @contents = contents
       end
@@ -32,6 +33,7 @@ class ViewModel::ActiveRecord
     class Update
       NAME = 'update'
       attr_reader :contents
+
       def initialize(contents)
         @contents = contents
       end
@@ -56,6 +58,7 @@ class ViewModel::ActiveRecord
     # associations or reference strings for root.
     class Replace
       attr_reader :contents
+
       def initialize(contents)
         @contents = contents
       end
@@ -66,6 +69,7 @@ class ViewModel::ActiveRecord
     # associations.
     class Functional
       attr_reader :actions
+
       def initialize(actions)
         @actions = actions
       end
@@ -215,23 +219,23 @@ class ViewModel::ActiveRecord
       # The contents of the actions are determined by the subclasses
 
       def functional_update_schema # abstract
-        raise "abstract"
+        raise 'abstract'
       end
 
       def append_action_schema # abstract
-        raise "abstract"
+        raise 'abstract'
       end
 
       def remove_action_schema # abstract
-        raise "abstract"
+        raise 'abstract'
       end
 
       def update_action_schema # abstract
-        raise "abstract"
+        raise 'abstract'
       end
 
-      def parse_contents(values) # abstract
-        raise "abstract"
+      def parse_contents(_values) # abstract
+        raise 'abstract'
       end
 
       # Remove values are always anchors
@@ -255,11 +259,11 @@ class ViewModel::ActiveRecord
       # behaviour, so we parameterise the result type as well.
 
       def replace_update_type # abstract
-        raise "abstract"
+        raise 'abstract'
       end
 
       def functional_update_type # abstract
-        raise "abstract"
+        raise 'abstract'
       end
     end
   end
@@ -390,6 +394,7 @@ class ViewModel::ActiveRecord
 
   class UpdateData
     attr_accessor :viewmodel_class, :metadata, :attributes, :associations, :referenced_associations
+
     delegate :id, :view_name, :schema_version, to: :metadata
 
     module Schemas
@@ -400,7 +405,7 @@ class ViewModel::ActiveRecord
           'properties'           => { ViewModel::TYPE_ATTRIBUTE => { 'type' => 'string' },
                                       ViewModel::ID_ATTRIBUTE   => ViewModel::Schemas::ID_SCHEMA },
           'additionalProperties' => false,
-          'required'             => [ViewModel::TYPE_ATTRIBUTE, ViewModel::ID_ATTRIBUTE]
+          'required'             => [ViewModel::TYPE_ATTRIBUTE, ViewModel::ID_ATTRIBUTE],
         }
 
       VIEWMODEL_REFERENCE_ONLY = JsonSchema.parse!(viewmodel_reference_only)
@@ -409,14 +414,14 @@ class ViewModel::ActiveRecord
         {
           'description' => 'functional update',
           'type'        => 'object',
+          'required'    => [ViewModel::TYPE_ATTRIBUTE, VALUES_ATTRIBUTE],
           'properties'  => {
             ViewModel::TYPE_ATTRIBUTE => { 'enum' => [FunctionalUpdate::Append::NAME,
                                                       FunctionalUpdate::Update::NAME,
-                                                      FunctionalUpdate::Remove::NAME] },
+                                                      FunctionalUpdate::Remove::NAME,] },
             VALUES_ATTRIBUTE => { 'type'  => 'array',
-                                  'items' => value_schema }
+                                  'items' => value_schema },
           },
-          'required' => [ViewModel::TYPE_ATTRIBUTE, VALUES_ATTRIBUTE]
         }
       end
 
@@ -426,7 +431,7 @@ class ViewModel::ActiveRecord
         'properties'           => {
           ViewModel::TYPE_ATTRIBUTE => { 'enum' => [FunctionalUpdate::Append::NAME] },
           BEFORE_ATTRIBUTE          => viewmodel_reference_only,
-          AFTER_ATTRIBUTE           => viewmodel_reference_only
+          AFTER_ATTRIBUTE           => viewmodel_reference_only,
         },
       }
 
@@ -435,7 +440,7 @@ class ViewModel::ActiveRecord
 
       fupdate_shared =
         fupdate_base.({ 'oneOf' => [ViewModel::Schemas::VIEWMODEL_REFERENCE_SCHEMA,
-                                    viewmodel_reference_only] })
+                                    viewmodel_reference_only,] })
 
       # Referenced updates are special:
       #  - Append requires `_ref` hashes
@@ -450,7 +455,7 @@ class ViewModel::ActiveRecord
         'description'          => 'collection update',
         'additionalProperties' => false,
         'properties'           => {
-          ViewModel::TYPE_ATTRIBUTE => { 'enum' => [FunctionalUpdate::Update::NAME] }
+          ViewModel::TYPE_ATTRIBUTE => { 'enum' => [FunctionalUpdate::Update::NAME] },
         },
       }
 
@@ -471,7 +476,6 @@ class ViewModel::ActiveRecord
       REMOVE_ACTION            = JsonSchema.parse!(fupdate_owned.deep_merge(remove_mixin))
       REFERENCED_REMOVE_ACTION = JsonSchema.parse!(fupdate_shared.deep_merge(remove_mixin))
 
-
       collection_update = ->(base_schema) do
         {
           'type'                 => 'object',
@@ -480,7 +484,7 @@ class ViewModel::ActiveRecord
           'required'             => [ViewModel::TYPE_ATTRIBUTE, ACTIONS_ATTRIBUTE],
           'properties'           => {
             ViewModel::TYPE_ATTRIBUTE => { 'enum' => [FUNCTIONAL_UPDATE_TYPE] },
-            ACTIONS_ATTRIBUTE => { 'type' => 'array', 'items' => base_schema }
+            ACTIONS_ATTRIBUTE => { 'type' => 'array', 'items' => base_schema },
             # The ACTIONS_ATTRIBUTE could be accurately expressed as
             #
             #   { 'oneOf' => [append, update, remove] }
@@ -488,7 +492,7 @@ class ViewModel::ActiveRecord
             # but this produces completely unusable error messages.  Instead we
             # specify it must be an array, and defer checking to the code that
             # can determine the schema by inspecting the type field.
-          }
+          },
         }
       end
 
@@ -503,7 +507,7 @@ class ViewModel::ActiveRecord
       when :_type
         viewmodel_class.view_name
       else
-        attributes.fetch(name) { associations.fetch(name) { referenced_associations.fetch(name) }}
+        attributes.fetch(name) { associations.fetch(name) { referenced_associations.fetch(name) } }
       end
     end
 
@@ -538,7 +542,7 @@ class ViewModel::ActiveRecord
       end
 
       # Ensure that no root is referred to more than once
-      check_duplicate_updates(root_updates, type: "root")
+      check_duplicate_updates(root_updates, type: 'root')
 
       # Construct reference UpdateData
       referenced_updates = referenced_subtree_hashes.transform_values do |subtree_hash|
@@ -549,7 +553,7 @@ class ViewModel::ActiveRecord
         UpdateData.new(viewmodel_class, metadata, subtree_hash, valid_reference_keys)
       end
 
-      check_duplicate_updates(referenced_updates.values, type: "reference")
+      check_duplicate_updates(referenced_updates.values, type: 'reference')
 
       return root_updates, referenced_updates
     end
@@ -614,7 +618,7 @@ class ViewModel::ActiveRecord
     def preload_dependencies
       deps = {}
 
-      (associations.merge(referenced_associations)).each do |assoc_name, reference|
+      associations.merge(referenced_associations).each do |assoc_name, reference|
         association_data = self.viewmodel_class._association_data(assoc_name)
 
         preload_specs = build_preload_specs(association_data,
@@ -665,7 +669,7 @@ class ViewModel::ActiveRecord
 
       # handle view pre-parsing if defined
       self.viewmodel_class.pre_parse(viewmodel_reference, metadata, hash_data) if self.viewmodel_class.respond_to?(:pre_parse)
-      hash_data.keys.each do |key|
+      hash_data.keys.each do |key| # rubocop:disable Style/HashEachMethods
         if self.viewmodel_class.respond_to?(:"pre_parse_#{key}")
           self.viewmodel_class.public_send("pre_parse_#{key}", viewmodel_reference, metadata, hash_data, hash_data.delete(key))
         end
@@ -710,19 +714,18 @@ class ViewModel::ActiveRecord
               referenced_associations[name] = ref
             end
           else
-            if association_data.collection?
-              associations[name] =
+            associations[name] =
+              if association_data.collection?
                 OwnedCollectionUpdate::Parser
                   .new(association_data, blame_reference, valid_reference_keys)
                   .parse(value)
-            else # not a collection
-              associations[name] =
-                if value.nil?
+              else # not a collection
+                if value.nil? # rubocop:disable Style/IfInsideElse
                   nil
                 else
                   self.class.parse_associated(association_data, blame_reference, valid_reference_keys, value)
                 end
-            end
+              end
           end
         else
           raise ViewModel::DeserializationError::UnknownAttribute.new(name, blame_reference)
@@ -730,7 +733,6 @@ class ViewModel::ActiveRecord
       end
     end
 
-
     def blame_reference
       ViewModel::Reference.new(self.viewmodel_class, self.id)
     end

data/lib/view_model/active_record/update_operation.rb

@@ -1,4 +1,6 @@
-require "renum"
+# frozen_string_literal: true
+
+require 'renum'
 
 # Partially parsed tree of user-specified update hashes, created during deserialization.
 class ViewModel::ActiveRecord
@@ -14,7 +16,7 @@ class ViewModel::ActiveRecord
                   :update_data,
                   :points_to,  # AssociationData => UpdateOperation (returns single new viewmodel to update fkey)
                   :pointed_to, # AssociationData => UpdateOperation(s) (returns viewmodel(s) with which to update assoc cache)
-                  :reparent_to,  # If node needs to update its pointer to a new parent, ParentData for the parent
+                  :reparent_to, # If node needs to update its pointer to a new parent, ParentData for the parent
                   :reposition_to, # if this node participates in a list under its parent, what should its position be?
                   :released_children # Set of children that have been released
 
@@ -46,11 +48,11 @@ class ViewModel::ActiveRecord
 
     # Evaluate a built update tree, applying and saving changes to the models.
     def run!(deserialize_context:)
-      raise ViewModel::DeserializationError::Internal.new("Internal error: UpdateOperation run before build") unless built?
+      raise ViewModel::DeserializationError::Internal.new('Internal error: UpdateOperation run before build') unless built?
 
       case @run_state
       when RunState::Running
-        raise ViewModel::DeserializationError::Internal.new("Internal error: Cycle found in running UpdateOperation")
+        raise ViewModel::DeserializationError::Internal.new('Internal error: Cycle found in running UpdateOperation')
       when RunState::Run
         return viewmodel
       end
@@ -217,7 +219,7 @@ class ViewModel::ActiveRecord
 
     # Recursively builds UpdateOperations for the associations in our UpdateData
     def build!(update_context)
-      raise ViewModel::DeserializationError::Internal.new("Internal error: UpdateOperation cannot build a deferred update") if viewmodel.nil?
+      raise ViewModel::DeserializationError::Internal.new('Internal error: UpdateOperation cannot build a deferred update') if viewmodel.nil?
       return self if built?
 
       update_data.associations.each do |association_name, association_update_data|
@@ -254,8 +256,8 @@ class ViewModel::ActiveRecord
     def add_update(association_data, update)
       target =
         case association_data.pointer_location
-        when :remote; pointed_to
-        when :local;  points_to
+        when :remote then pointed_to
+        when :local then  points_to
         end
 
       target[association_data] = update
@@ -658,7 +660,7 @@ class ViewModel::ActiveRecord
           other.indirect_viewmodel_reference == self.indirect_viewmodel_reference
       end
 
-      alias :eql? :==
+      alias eql? ==
     end
 
     # Helper class to wrap the previous members of a referenced collection and
@@ -767,6 +769,7 @@ class ViewModel::ActiveRecord
         member.ref_string = ref_string if ref_string
         member
       end
+
       def remove_from_members(removed_members)
         s = removed_members.to_set
         members.reject! { |m| s.include?(m) }
@@ -900,11 +903,12 @@ class ViewModel::ActiveRecord
 
     def clear_association_cache(model, reflection)
       association = model.association(reflection.name)
-      if reflection.collection?
-        association.target = []
-      else
-        association.target = nil
-      end
+      association.target =
+        if reflection.collection?
+          []
+        else
+          nil
+        end
     end
 
     def blame_reference