iknow_view_models 2.9.0 → 3.0.0

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

@@ -22,6 +22,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
         end
 
         define_viewmodel do
+          root!
           attributes :name
         end
       end
@@ -43,8 +44,9 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
         end
 
         define_viewmodel do
+          root!
           attributes  :name
-          association :category, shared: true, optional: true
+          association :category
         end
       end
     end
@@ -66,16 +68,11 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
     enable_logging!
   end
 
-  def serialize_context
-    ParentView.new_serialize_context(include: :category)
-  end
-
   def test_loading_batching
     Parent.create(category: Category.new)
 
     log_queries do
-      serialize(ParentView.load(serialize_context: serialize_context),
-                serialize_context: serialize_context)
+      serialize(ParentView.load())
     end
     assert_equal(['Parent Load', 'Category Load'],
                  logged_load_queries)
@@ -104,7 +101,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
   end
 
   def test_serialize_view
-    view, refs = serialize_with_references(ParentView.new(@parent1), serialize_context: serialize_context)
+    view, refs = serialize_with_references(ParentView.new(@parent1))
     cat1_ref = refs.detect { |_, v| v['_type'] == 'Category' }.first
 
     assert_equal({cat1_ref => { '_type'    => "Category",
@@ -122,20 +119,14 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
   end
 
   def test_shared_eager_include
-    parent_includes = ParentView.eager_includes
-
-    assert_equal(DeepPreloader::Spec.new, parent_includes)
-
-    extra_includes = ParentView.eager_includes(serialize_context: ParentView.new_serialize_context(include: :category))
-
-    assert_equal(DeepPreloader::Spec.new('category' => DeepPreloader::Spec.new), extra_includes)
+    includes = ParentView.eager_includes
+    assert_equal(DeepPreloader::Spec.new('category' => DeepPreloader::Spec.new), includes)
   end
 
   def test_shared_serialize_interning
     @parent2.update(category: @parent1.category)
     view, refs = serialize_with_references([ParentView.new(@parent1),
-                                            ParentView.new(@parent2)],
-                                           serialize_context: ParentView.new_serialize_context(include: :category))
+                                            ParentView.new(@parent2)])
 
     category_ref = view.first['category']['_ref']
 
@@ -144,7 +135,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
   end
 
   def test_shared_add_reference
-    alter_by_view!(ParentView, @parent2, serialize_context: serialize_context) do |p2view, refs|
+    alter_by_view!(ParentView, @parent2) do |p2view, refs|
       p2view['category'] = { '_ref' => 'myref' }
       refs['myref'] = update_hash_for(CategoryView, @category1)
     end
@@ -153,7 +144,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
   end
 
   def test_shared_add_multiple_references
-    alter_by_view!(ParentView, [@parent1, @parent2], serialize_context: serialize_context) do |(p1view, p2view), refs|
+    alter_by_view!(ParentView, [@parent1, @parent2]) do |(p1view, p2view), refs|
       refs.delete(p1view['category']['_ref'])
       refs['myref'] = update_hash_for(CategoryView, @category1)
 
@@ -167,7 +158,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
 
   def test_shared_requires_all_references
     ex = assert_raises(ViewModel::DeserializationError::InvalidStructure) do
-      alter_by_view!(ParentView, @parent2, serialize_context: serialize_context) do |p2view, refs|
+      alter_by_view!(ParentView, @parent2) do |p2view, refs|
         refs['spurious_ref'] = { '_type' => 'Parent', 'id' => @parent1.id }
       end
     end
@@ -176,8 +167,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
 
   def test_shared_requires_valid_references
     assert_raises(ViewModel::DeserializationError::InvalidSharedReference) do
-      serialize_context = ParentView.new_serialize_context(include: :category)
-      alter_by_view!(ParentView, @parent1, serialize_context: serialize_context) do |p1view, refs|
+      alter_by_view!(ParentView, @parent1) do |p1view, refs|
         refs.clear # remove the expected serialized refs
       end
     end
@@ -185,8 +175,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
 
   def test_shared_requires_assignable_type
     ex = assert_raises(ViewModel::DeserializationError::InvalidAssociationType) do
-      serialize_context = ParentView.new_serialize_context(include: :category)
-      alter_by_view!(ParentView, @parent1, serialize_context: serialize_context) do |p1view, refs|
+      alter_by_view!(ParentView, @parent1) do |p1view, refs|
         p1view['category'] = { '_ref' => 'p2' }
         refs['p2'] = update_hash_for(ParentView, @parent2)
       end
@@ -195,10 +184,9 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
   end
 
   def test_shared_requires_unique_references
-    serialize_context = ParentView.new_serialize_context(include: :category)
     c1_ref = update_hash_for(CategoryView, @category1)
     assert_raises(ViewModel::DeserializationError::DuplicateNodes) do
-      alter_by_view!(ParentView, [@parent1, @parent2], serialize_context: serialize_context) do |(p1view, p2view), refs|
+      alter_by_view!(ParentView, [@parent1, @parent2]) do |(p1view, p2view), refs|
         refs['c_a'] = c1_ref.dup
         refs['c_b'] = c1_ref.dup
         p1view['category'] = { '_ref' => 'c_a' }
@@ -208,8 +196,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
   end
 
   def test_shared_updates_shared_data
-    serialize_context = ParentView.new_serialize_context(include: :category)
-    alter_by_view!(ParentView, @parent1, serialize_context: serialize_context) do |p1view, refs|
+    alter_by_view!(ParentView, @parent1) do |p1view, refs|
       category_ref = p1view['category']['_ref']
       refs[category_ref]['name'] = 'newcatname'
     end
@@ -217,8 +204,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
   end
 
   def test_shared_delete_reference
-    serialize_context = ParentView.new_serialize_context(include: :category)
-    alter_by_view!(ParentView, @parent1, serialize_context: serialize_context) do |p1view, refs|
+    alter_by_view!(ParentView, @parent1) do |p1view, refs|
       category_ref = p1view['category']['_ref']
       refs.delete(category_ref)
       p1view['category'] = nil
@@ -228,10 +214,9 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
   end
 
   def test_child_edit_doesnt_editcheck_parent
-    serialize_context = ParentView.new_serialize_context(include: :category)
     d_context = ParentView.new_deserialize_context
 
-    alter_by_view!(ParentView, @parent1, serialize_context: serialize_context, deserialize_context: d_context) do |view, refs|
+    alter_by_view!(ParentView, @parent1, deserialize_context: d_context) do |view, refs|
       refs[view['category']["_ref"]]["name"] = "changed"
     end
 
@@ -240,9 +225,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
   end
 
   def test_child_change_editchecks_parent
-    s_context = ParentView.new_serialize_context(include: :category)
-
-    nv, d_context = alter_by_view!(ParentView, @parent1, serialize_context: s_context) do |view, refs|
+    nv, d_context = alter_by_view!(ParentView, @parent1) do |view, refs|
       refs.delete(view['category']['_ref'])
       view['category']['_ref'] = 'new_cat'
       refs['new_cat'] = { '_type' => 'Category', 'name' => 'new category' }
@@ -253,10 +236,9 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
   end
 
   def test_child_delete_editchecks_parent
-    serialize_context = ParentView.new_serialize_context(include: :category)
     d_context = ParentView.new_deserialize_context
 
-    alter_by_view!(ParentView, @parent1, serialize_context: serialize_context, deserialize_context: d_context) do |view, refs|
+    alter_by_view!(ParentView, @parent1, deserialize_context: d_context) do |view, refs|
       refs.delete(view['category']['_ref'])
       view['category'] = nil
     end
@@ -268,7 +250,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
     deps = ParentView.dependent_viewmodels
     assert_equal([ParentView, CategoryView].to_set, deps)
 
-    deps = ParentView.dependent_viewmodels(include_shared: false)
+    deps = ParentView.dependent_viewmodels(include_referenced: false)
     assert_equal([ParentView].to_set, deps)
   end
 
@@ -278,7 +260,7 @@ class ViewModel::ActiveRecord::SharedTest < ActiveSupport::TestCase
                    CategoryView.view_name => CategoryView.schema_version },
                  vers)
 
-    vers = ParentView.deep_schema_version(include_shared: false)
+    vers = ParentView.deep_schema_version(include_referenced: false)
     assert_equal({ ParentView.view_name => ParentView.schema_version },
                  vers)
   end

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

@@ -21,13 +21,13 @@ class ViewModel::ActiveRecord::VersionTest < ActiveSupport::TestCase
       end
     end
 
-
     build_viewmodel(:Target) do
       define_schema {}
       define_model do
         has_one :parent, inverse_of: :target
       end
       define_viewmodel do
+        root!
         self.schema_version = 20
       end
     end
@@ -44,8 +44,9 @@ class ViewModel::ActiveRecord::VersionTest < ActiveSupport::TestCase
       end
       define_viewmodel do
         self.schema_version = 5
+        root!
         association :child, viewmodels: [:ChildA]
-        association :target, shared: true, optional: false
+        association :target
       end
     end
   end

data/test/unit/view_model/active_record_test.rb

@@ -17,7 +17,7 @@ class ViewModel::ActiveRecordTest < ActiveSupport::TestCase
     build_viewmodel(:Trivial) do
       define_schema
       define_model {}
-      define_viewmodel {}
+      define_viewmodel { root! }
     end
 
     build_viewmodel(:Parent) do
@@ -35,6 +35,7 @@ class ViewModel::ActiveRecordTest < ActiveSupport::TestCase
       end
 
       define_viewmodel do
+        root!
         attributes :name, :lock_version
         attribute :one, read_only: true
       end
@@ -376,66 +377,6 @@ class ViewModel::ActiveRecordTest < ActiveSupport::TestCase
     end
   end
 
-  # Tests for functionality common to all ARVM instances, but require some kind
-  # of relationship.
-  class RelationshipTests < ActiveSupport::TestCase
-    include ARVMTestUtilities
-
-    def before_all
-      super
-
-      build_viewmodel(:Parent) do
-        define_schema do |t|
-          t.string :name
-        end
-
-        define_model do
-          has_many :children, dependent: :destroy, inverse_of: :parent
-        end
-
-        define_viewmodel do
-          attributes :name
-          associations :children
-        end
-      end
-
-      build_viewmodel(:Child) do
-        define_schema do |t|
-          t.references :parent, null: false, foreign_key: true
-          t.string :name
-        end
-
-        define_model do
-          belongs_to :parent, inverse_of: :children
-        end
-
-        define_viewmodel do
-          attributes :name
-        end
-      end
-    end
-
-    def test_updated_associations_returned
-      # This test ensures the data is passed back through the context. The tests
-      # for the values are in the relationship-specific tests.
-
-      updated_by_view = ->(view) do
-        context = ViewModelBase.new_deserialize_context
-        ParentView.deserialize_from_view(view, deserialize_context: context)
-        context.updated_associations
-      end
-
-      assert_equal({},
-                   updated_by_view.({ '_type' => 'Parent',
-                                      'name' => 'p' }))
-
-      assert_equal({ 'children' => {} },
-                   updated_by_view.({ '_type' => 'Parent',
-                                      'name' => 'p',
-                                      'children' => [] }))
-    end
-  end
-
   # Parent view should be correctly passed down the tree when deserializing
   class DeserializationParentContextTest < ActiveSupport::TestCase
     include ARVMTestUtilities
@@ -499,7 +440,7 @@ class ViewModel::ActiveRecordTest < ActiveSupport::TestCase
     end
   end
 
-    # Parent view should be correctly passed down the tree when deserializing
+  # Parent view should be correctly passed down the tree when deserializing
   class DeferredConstraintTest < ActiveSupport::TestCase
     include ARVMTestUtilities
 
@@ -516,7 +457,8 @@ class ViewModel::ActiveRecordTest < ActiveSupport::TestCase
         end
 
         define_viewmodel do
-          association :child, shared: true
+          root!
+          association :child
         end
       end
       List.connection.execute("ALTER TABLE lists ADD CONSTRAINT unique_child UNIQUE (child_id) DEFERRABLE INITIALLY DEFERRED")

data/test/unit/view_model/callbacks_test.rb

@@ -348,6 +348,7 @@ class ViewModel::CallbacksTest < ActiveSupport::TestCase
         alter_by_view!(viewmodel_class, vm.model) do |view, _refs|
           view['next'] = nil
         end
+
         value(callback.hook_trace).must_equal(
           [
             visit(ViewModel::Callbacks::Hook::BeforeVisit,       vm),

data/test/unit/view_model/record_test.rb

@@ -204,12 +204,6 @@ class ViewModel::RecordTest < ActiveSupport::TestCase
         assert_equal("unknown", ex.attribute)
       end
 
-      it "can prune an attribute" do
-        h = viewmodel_class.new(default_model).to_hash(serialize_context: TestSerializeContext.new(prune: [:simple]))
-        pruned_view = default_view.tap { |v| v.delete("simple") }
-        assert_equal(pruned_view, h)
-      end
-
       it "edit checks when creating empty" do
         vm = viewmodel_class.deserialize_from_view(view_base, deserialize_context: create_context)
         refute(default_model.equal?(vm.model), "returned model was the same")
@@ -377,24 +371,6 @@ class ViewModel::RecordTest < ActiveSupport::TestCase
       end
     end
 
-    describe "with optional attributes" do
-      let(:attributes) { { optional: { optional: true } } }
-
-      include CanDeserializeToNew
-      include CanDeserializeToExisting
-
-      it "can serialize with the optional attribute" do
-        h = viewmodel_class.new(default_model).to_hash(serialize_context: TestSerializeContext.new(include: [:optional]))
-        assert_equal(default_view, h)
-      end
-
-      it "can serialize without the optional attribute" do
-        h = viewmodel_class.new(default_model).to_hash
-        pruned_view = default_view.tap { |v| v.delete("optional") }
-        assert_equal(pruned_view, h)
-      end
-    end
-
     Nested = Struct.new(:member)
 
     class NestedView < TestViewModel
@@ -448,14 +424,6 @@ class ViewModel::RecordTest < ActiveSupport::TestCase
         assert_edited(vm, new: false, changed_attributes: [:nested])
         assert_edited(vm.nested, new: true, changed_attributes: [:member])
       end
-
-      it "can prune attributes in the nested value" do
-        h = viewmodel_class.new(default_model).to_hash(
-          serialize_context: TestSerializeContext.new(prune: { nested: [:member] }))
-
-        pruned_view = default_view.tap { |v| v["nested"].delete("member") }
-        assert_equal(pruned_view, h)
-      end
     end
 
     describe "with array of nested viewmodel" do

data/test/unit/view_model/traversal_context_test.rb

@@ -35,6 +35,7 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
     after_visit do
       ref = view.to_reference
       raise RuntimeError.new('Visited twice') if details.has_key?(ref)
+
       details[ref] = ContextDetail.new(
         context.parent_viewmodel&.to_reference,
         context.parent_association,
@@ -87,12 +88,12 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
     # models have no more than one shared association, and if present it is the
     # one under test.
     def clear_subject_association(view, refs)
-      refs.clear if subject_association.shared?
+      refs.clear if subject_association.referenced?
       view[subject_association_name] = subject_association.collection? ? [] : nil
     end
 
     def set_subject_association(view, refs, value)
-      if subject_association.shared?
+      if subject_association.referenced?
         refs.clear
         value = convert_to_refs(refs, value)
       end
@@ -100,7 +101,7 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
     end
 
     def add_to_subject_association(view, refs, value)
-      if subject_association.shared?
+      if subject_association.referenced?
         value = convert_to_refs(refs, value)
       end
       view[subject_association_name] << value
@@ -108,12 +109,12 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
 
     def remove_from_subject_association(view, refs)
       view[subject_association_name].reject! do |child|
-        if subject_association.shared?
+        if subject_association.referenced?
           ref = child[ViewModel::REFERENCE_ATTRIBUTE]
           child = refs[ref]
         end
         match = yield(child)
-        if match && subject_association.shared?
+        if match && subject_association.referenced?
           refs.delete(ref)
         end
         match
@@ -167,7 +168,7 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
           end
 
           expected = expected_parent_details
-          expected = expected.merge(expected_children_details) unless subject_association.shared?
+          expected = expected.merge(expected_children_details) unless subject_association.referenced?
           assert_traversal_matches(expected, context_recorder.details)
         end
 
@@ -179,7 +180,7 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
           end
 
           expected = expected_parent_details
-          expected = expected.merge(expected_children_details) unless subject_association.shared?
+          expected = expected.merge(expected_children_details) unless subject_association.referenced?
           expected = expected.merge(new_child_expected_details)
           assert_traversal_matches(expected, context_recorder.details)
         end
@@ -190,7 +191,7 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
           vm.replace_associated(subject_association_name, replacement, deserialize_context: ctx)
 
           expected = expected_parent_details
-          expected = expected.merge(expected_children_details) unless subject_association.shared?
+          expected = expected.merge(expected_children_details) unless subject_association.referenced?
           expected = expected.merge(new_child_expected_details)
           assert_traversal_matches(expected, context_recorder.details)
         end
@@ -224,7 +225,7 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
           end
 
           expected = expected_parent_details.merge(expected_children_details)
-          expected = expected.except(removed_child.to_reference) if subject_association.shared?
+          expected = expected.except(removed_child.to_reference) if subject_association.referenced?
           assert_traversal_matches(expected, context_recorder.details)
         end
 
@@ -241,7 +242,7 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
           vm.delete_associated(subject_association_name, removed_child.id, deserialize_context: ctx)
 
           expected = expected_parent_details
-          expected = expected.merge(removed_child_expected_details) unless subject_association.shared?
+          expected = expected.merge(removed_child_expected_details) unless subject_association.referenced?
           assert_traversal_matches(expected, context_recorder.details)
         end
       end
@@ -265,7 +266,7 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
 
   let(:root_detail) { ContextDetail.new(nil, nil, true) }
   let(:child_detail) do
-    if subject_association.shared?
+    if subject_association.referenced?
       root_detail
     else
       ContextDetail.new(vm.to_reference, subject_association_name, false)
@@ -346,7 +347,7 @@ class ViewModel::TraversalContextTest < ActiveSupport::TestCase
   end
 
   describe 'with parent and shared child' do
-    include ViewModelSpecHelpers::ParentAndSharedChild
+    include ViewModelSpecHelpers::ParentAndSharedBelongsToChild
 
     include BehavesLikeSerialization
     include BehavesLikeDeserialization

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iknow_view_models
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 3.0.0
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: iknow_cache
   requirement: !ruby/object:Gem::Requirement
@@ -438,7 +438,6 @@ files:
 - 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/namespacing_test.rb
-- test/unit/view_model/active_record/optional_attribute_view_test.rb
 - test/unit/view_model/active_record/poly_test.rb
 - test/unit/view_model/active_record/shared_test.rb
 - test/unit/view_model/active_record/version_test.rb
@@ -468,8 +467,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ViewModels provide a means of encapsulating a collection of related data
@@ -497,7 +495,6 @@ test_files:
 - 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/namespacing_test.rb
-- test/unit/view_model/active_record/optional_attribute_view_test.rb
 - test/unit/view_model/active_record/poly_test.rb
 - test/unit/view_model/active_record/shared_test.rb
 - test/unit/view_model/active_record/version_test.rb

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

@@ -1,58 +0,0 @@
-require_relative "../../../helpers/arvm_test_utilities.rb"
-require_relative "../../../helpers/arvm_test_models.rb"
-
-require "minitest/autorun"
-
-require "view_model/active_record"
-
-class ViewModel::ActiveRecord::AttributeViewTest < ActiveSupport::TestCase
-  include ARVMTestUtilities
-
-  def before_all
-    super
-
-    build_viewmodel(:Thing) do
-      define_schema do |t|
-        t.integer :a
-        t.integer :b
-      end
-
-      define_model do
-      end
-
-      define_viewmodel do
-        attribute :a
-        attribute :b, optional: true
-      end
-    end
-  end
-
-  def setup
-    super
-    @thing = Thing.create!(a: 1, b: 2)
-
-    @skel = { "_type"    => "Thing",
-              "_version" => 1,
-              "id"       => @thing.id }
-  end
-
-  def test_optional_not_serialized
-    view, _refs = serialize_with_references(ThingView.new(@thing))
-
-    assert_equal(@skel.merge("a" => 1), view)
-  end
-
-  def test_optional_included
-    view, _refs = serialize_with_references(ThingView.new(@thing),
-                                            serialize_context: ThingView.new_serialize_context(include: :b))
-
-    assert_equal(@skel.merge("a" => 1, "b" => 2), view)
-  end
-
-  def test_pruned_not_included
-    view, _refs = serialize_with_references(ThingView.new(@thing),
-                                            serialize_context: ThingView.new_serialize_context(include: :b, prune: :a))
-
-    assert_equal(@skel.merge("b" => 2), view)
-  end
-end