iknow_view_models 2.9.0 → 3.0.0

data/lib/view_model/serialize_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext'
 require 'view_model/traversal_context'
 
@@ -17,52 +19,6 @@ class ViewModel::SerializeContext < ViewModel::TraversalContext
   end
 
   delegate :references, :flatten_references, to: :shared_context
-
-  attr_reader :include, :prune
-
-  def initialize(include: nil, prune: nil, **rest)
-    super(**rest)
-    @include = self.class.normalize_includes(include)
-    @prune   = self.class.normalize_includes(prune)
-  end
-
-  def initialize_as_child(include:, prune:, **rest)
-    super(**rest)
-    @include = include
-    @prune   = prune
-  end
-
-  def for_child(parent_viewmodel, association_name:, **rest)
-    super(parent_viewmodel,
-          association_name: association_name,
-          include: @include.try { |i| i[association_name] },
-          prune:   @prune.try   { |p| p[association_name] },
-          **rest)
-  end
-
-  def includes_member?(member_name, default)
-    member_name = member_name.to_s
-
-    # Every node in the include tree is to be included
-    included = @include.try { |is| is.has_key?(member_name) }
-    # whereas only the leaves of the prune tree are to be removed
-    pruned   = @prune.try { |ps| ps.fetch(member_name, :sentinel).nil? }
-
-    (default || included) && !pruned
-  end
-
-  def add_includes(includes)
-    return if includes.blank?
-    @include ||= {}
-    @include.deep_merge!(self.class.normalize_includes(includes))
-  end
-
-  def add_prunes(prunes)
-    return if prunes.blank?
-    @prune ||= {}
-    @prune.deep_merge!(self.class.normalize_includes(prunes))
-  end
-
   delegate :add_reference, :has_references?, to: :references
 
   # Return viewmodels referenced during serialization and clear @references.
@@ -98,21 +54,4 @@ class ViewModel::SerializeContext < ViewModel::TraversalContext
   def serialize_references_to_hash
     Jbuilder.new { |json| serialize_references(json) }.attributes!
   end
-
-  def self.normalize_includes(includes)
-    case includes
-    when Array
-      includes.each_with_object({}) do |v, new_includes|
-        new_includes.merge!(normalize_includes(v))
-      end
-    when Hash
-      includes.each_with_object({}) do |(k,v), new_includes|
-        new_includes[k.to_s] = normalize_includes(v)
-      end
-    when nil
-      nil
-    else
-      { includes.to_s => nil }
-    end
-  end
 end

data/lib/view_model.rb

@@ -20,6 +20,7 @@ class ViewModel
     attr_accessor :_attributes
     attr_accessor :schema_version
     attr_reader   :view_aliases
+    attr_writer   :view_name
 
     def inherited(subclass)
       subclass.initialize_as_viewmodel
@@ -41,15 +42,23 @@ class ViewModel
         end
     end
 
-    def view_name=(name)
-      @view_name = name
-    end
-
     def add_view_alias(as)
       view_aliases << as
       ViewModel::Registry.register(self, as: as)
     end
 
+    # ViewModels are either roots or children. Root viewmodels may be
+    # (de)serialized directly, whereas child viewmodels are always nested within
+    # their parent. Associations to root viewmodel types always use indirect
+    # references.
+    def root?
+      false
+    end
+
+    def root!
+      define_singleton_method(:root?) { true }
+    end
+
     # ViewModels are typically going to be pretty simple structures. Make it a
     # bit easier to define them: attributes specified this way are given
     # accessors and assigned in order by the default constructor.
@@ -59,7 +68,7 @@ class ViewModel
 
     def attribute(attr, **_args)
       unless attr.is_a?(Symbol)
-        raise ArgumentError.new("ViewModel attributes must be symbols")
+        raise ArgumentError.new('ViewModel attributes must be symbols')
       end
 
       attr_accessor attr
@@ -116,7 +125,7 @@ class ViewModel
     # If this viewmodel represents an AR model, what associations does it make
     # use of? Returns a includes spec appropriate for DeepPreloader, either as
     # AR-style nested hashes or DeepPreloader::Spec.
-    def eager_includes(serialize_context: new_serialize_context, include_shared: true)
+    def eager_includes(serialize_context: new_serialize_context, include_referenced: true)
       {}
     end
 
@@ -225,10 +234,10 @@ class ViewModel
       schema_version == self.schema_version
     end
 
-    def preload_for_serialization(viewmodels, serialize_context: new_serialize_context, include_shared: true, lock: nil)
+    def preload_for_serialization(viewmodels, serialize_context: new_serialize_context, include_referenced: true, lock: nil)
       Array.wrap(viewmodels).group_by(&:class).each do |type, views|
         DeepPreloader.preload(views.map(&:model),
-                              type.eager_includes(serialize_context: serialize_context, include_shared: include_shared),
+                              type.eager_includes(serialize_context: serialize_context, include_referenced: include_referenced),
                               lock: lock)
       end
     end

data/shell.nix

@@ -1,7 +1,7 @@
 with import <nixpkgs> {};
 
 (bundlerEnv {
-  name = "dev";
+  name = "iknow-view-models-shell";
   gemdir = ./nix/gem;
 
   gemConfig = (defaultGemConfig.override { postgresql = postgresql_11; });

data/test/helpers/arvm_test_utilities.rb

@@ -4,6 +4,12 @@ require 'minitest/hooks'
 require 'view_model'
 require 'view_model/test_helpers'
 
+unless ViewModel::Config.configured?
+  ViewModel::Config.configure! do
+    debug_deserialization true
+  end
+end
+
 require_relative 'query_logging.rb'
 
 ActiveSupport::TestCase.include(Minitest::Hooks)

data/test/helpers/controller_test_helpers.rb

@@ -33,6 +33,7 @@ module ControllerTestModels
         has_many :parents
       end
       define_viewmodel do
+        root!
         attributes :name
       end
     end
@@ -77,11 +78,12 @@ module ControllerTestModels
         belongs_to :category
       end
       define_viewmodel do
+        root!
         attributes   :name
         associations :label, :target
-        association  :children, optional: true
+        association  :children
         association  :poly, viewmodels: [:PolyOne, :PolyTwo]
-        association  :category, shared: true
+        association  :category, external: true
       end
     end
 
@@ -99,7 +101,7 @@ module ControllerTestModels
       define_model do
         belongs_to :parent, inverse_of: :children
         acts_as_manual_list scope: :parent
-        validates :age, numericality: {less_than: 42}, allow_nil: true
+        validates :age, numericality: { less_than: 42 }, allow_nil: true
       end
       define_viewmodel do
         attributes :name, :age

data/test/helpers/viewmodel_spec_helpers.rb

@@ -77,7 +77,7 @@ module ViewModelSpecHelpers
       ViewModel::TestHelpers::ARVMBuilder::Spec.new(
         schema:    ->(t) { t.string :name },
         model:     ->(m) {},
-        viewmodel: ->(v) { attribute :name }
+        viewmodel: ->(v) { root!; attribute :name }
       )
     end
 
@@ -99,6 +99,10 @@ module ViewModelSpecHelpers
       raise RuntimeError.new('Test model does not have a child association')
     end
 
+    def subject_association_features
+      {}
+    end
+
     def subject_association_name
       subject_association.association_name
     end
@@ -114,9 +118,10 @@ module ViewModelSpecHelpers
     include ViewModelSpecHelpers::Base
 
     def model_attributes
+      f = subject_association_features
       super.merge(schema:    ->(t) { t.references :child, foreign_key: true },
                   model:     ->(m) { belongs_to :child, inverse_of: :model, dependent: :destroy },
-                  viewmodel: ->(v) { association :child })
+                  viewmodel: ->(v) { association :child, **f })
     end
 
     def child_attributes
@@ -134,17 +139,33 @@ module ViewModelSpecHelpers
     end
   end
 
+  module ParentAndSharedBelongsToChild
+    extend ActiveSupport::Concern
+    include ViewModelSpecHelpers::ParentAndBelongsToChild
+    def child_attributes
+      super.merge(viewmodel: ->(v) { root! })
+    end
+  end
+
   module List
     extend ActiveSupport::Concern
     include ViewModelSpecHelpers::Base
 
     def model_attributes
-      super.merge(schema:    ->(t) { t.integer :next_id },
-                  model:     ->(m) {
-                    belongs_to :next, class_name: self.name, inverse_of: :previous, dependent: :destroy
-                    has_one :previous, class_name: self.name, foreign_key: :next_id, inverse_of: :next
-                  },
-                  viewmodel: ->(v) { association :next })
+      ViewModel::TestHelpers::ARVMBuilder::Spec.new(
+        schema:    ->(t) {
+          t.string :name
+          t.integer :next_id
+        },
+        model:     ->(m) {
+          belongs_to :next, class_name: self.name, inverse_of: :previous, dependent: :destroy
+          has_one :previous, class_name: self.name, foreign_key: :next_id, inverse_of: :next
+        },
+        viewmodel: ->(v) {
+          # Not a root
+          association :next
+          attribute :name
+        })
     end
 
     def subject_association
@@ -157,9 +178,10 @@ module ViewModelSpecHelpers
     include ViewModelSpecHelpers::Base
 
     def model_attributes
+      f = subject_association_features
       super.merge(
         model:     ->(m) { has_one :child, inverse_of: :model, dependent: :destroy },
-        viewmodel: ->(v) { association :child }
+        viewmodel: ->(v) { association :child, **f }
       )
     end
 
@@ -181,14 +203,23 @@ module ViewModelSpecHelpers
     end
   end
 
+  module ParentAndReferencedHasOneChild
+    extend ActiveSupport::Concern
+    include ViewModelSpecHelpers::ParentAndHasOneChild
+    def child_attributes
+      super.merge(viewmodel: ->(v) { root! })
+    end
+  end
+
   module ParentAndHasManyChildren
     extend ActiveSupport::Concern
     include ViewModelSpecHelpers::Base
 
     def model_attributes
+      f = subject_association_features
       super.merge(
         model:     ->(m) { has_many :children, inverse_of: :model, dependent: :destroy },
-        viewmodel: ->(v) { association :children }
+        viewmodel: ->(v) { association :children, **f }
       )
     end
 
@@ -210,22 +241,23 @@ module ViewModelSpecHelpers
     end
   end
 
-  module ParentAndOrderedChildren
+  module ParentAndSharedHasManyChildren
     extend ActiveSupport::Concern
-    include ViewModelSpecHelpers::Base
-
-    def model_attributes
-      super.merge(
-        model:     ->(m) { has_many :children, inverse_of: :model, dependent: :destroy },
-        viewmodel: ->(v) { association :children },
-      )
+    include ViewModelSpecHelpers::ParentAndHasManyChildren
+    def child_attributes
+      super.merge(viewmodel: ->(v) { root! })
     end
+  end
+
+  module ParentAndOrderedChildren
+    extend ActiveSupport::Concern
+    include ViewModelSpecHelpers::ParentAndHasManyChildren
 
     def child_attributes
       super.merge(
-        schema:    ->(t) { t.references :model, foreign_key: true; t.float :position, null: false },
-        model:     ->(m) { belongs_to :model, inverse_of: :children },
-        viewmodel: ->(v) { acts_as_list :position },
+        schema:    ->(t) { t.float :position, null: false },
+        model:     ->(_m) { acts_as_manual_list scope: :model },
+        viewmodel: ->(_v) { acts_as_list :position },
       )
     end
 
@@ -233,7 +265,7 @@ module ViewModelSpecHelpers
       # child depends on parent, ensure it's touched first
       viewmodel_class
 
-      # Add a deferrable unique position constraiont
+      # Add a deferrable unique position constraint
       super do |klass|
         model = klass.model_class
         table = model.table_name
@@ -242,38 +274,15 @@ module ViewModelSpecHelpers
           SQL
       end
     end
-
-    def subject_association
-      viewmodel_class._association_data('children')
-    end
   end
 
-  module ParentAndSharedChild
-    extend ActiveSupport::Concern
-    include ViewModelSpecHelpers::Base
 
-    def model_attributes
-      super.merge(
-        schema:    ->(t) { t.references :child, foreign_key: true },
-        model:     ->(m) { belongs_to :child, inverse_of: :model, dependent: :destroy },
-        viewmodel: ->(v) { association :child, shared: true }
-      )
-    end
-
-    def child_attributes
-      super.merge(
-        model: ->(m) { has_one :model, inverse_of: :child }
-      )
-    end
-
-    # parent depends on child, ensure it's touched first
-    def viewmodel_class
-      child_viewmodel_class
-      super
-    end
+  module ParentAndExternalSharedChild
+    extend ActiveSupport::Concern
+    include ViewModelSpecHelpers::ParentAndSharedBelongsToChild
 
-    def subject_association
-      viewmodel_class._association_data('child')
+    def subject_association_features
+      { external: true }
     end
   end
 
@@ -282,15 +291,17 @@ module ViewModelSpecHelpers
     include ViewModelSpecHelpers::Base
 
     def model_attributes
+      f = subject_association_features
       super.merge(
         model:     ->(m) { has_many :model_children, inverse_of: :model, dependent: :destroy },
-        viewmodel: ->(v) { association :children, shared: true, through: :model_children, through_order_attr: :position }
+        viewmodel: ->(v) { association :children, through: :model_children, through_order_attr: :position, **f }
       )
     end
 
     def child_attributes
       super.merge(
-        model: ->(m) { has_many :model_children, inverse_of: :child, dependent: :destroy }
+        model: ->(m) { has_many :model_children, inverse_of: :child, dependent: :destroy },
+        viewmodel: ->(v) { root! }
       )
     end