Prevent MarkClean() or IsClean() if Topic.IsNew

JeremyCaney · JeremyCaney · commit 85c386fdb10e · 2021-02-08T12:52:57.000-08:00
A `Topic` instance that hasn't been saved can _only_ be dirty, by definition. As such, any efforts to mark a collection associated with a new `Topic` as clean, or to modify the collection with an `!markDirty`  parameter should not be honored.

There's no need to check this condition from `IsDirty`; instead, we can just make sure it's checked during any entry points, such as e.g. `MarkClean()`, `SetValue()` or `SetTopic()`, `InsertItem()`, and/or `SetItem()`.
diff --git a/OnTopic/Associations/TopicRelationshipMultiMap.cs b/OnTopic/Associations/TopicRelationshipMultiMap.cs
@@ -187,7 +187,7 @@ internal void SetTopic(string relationshipKey, Topic topic, bool? markDirty, boo
       var wasDirty              = _dirtyKeys.IsDirty(relationshipKey);
       if (!topics.Contains(topic)) {
         _storage.Add(relationshipKey, topic);
-        if (markDirty.HasValue && !markDirty.Value && !wasDirty) {
+        if (!_parent.IsNew && markDirty.HasValue && !markDirty.Value && !wasDirty) {
           MarkClean(relationshipKey);
         }
         else {
@@ -245,10 +245,20 @@ internal void SetTopic(string relationshipKey, Topic topic, bool? markDirty, boo
     | METHOD: MARK CLEAN
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc/>
-    public void MarkClean() => _dirtyKeys.MarkClean();
+    public void MarkClean() {
+      if (_parent.IsNew) {
+        return;
+      }
+      _dirtyKeys.MarkClean();
+    }
 
     /// <inheritdoc/>
-    public void MarkClean(string key) => _dirtyKeys.MarkClean(key);
+    public void MarkClean(string key) {
+      if (_parent.IsNew) {
+        return;
+      }
+      _dirtyKeys.MarkClean(key);
+    }
 
   } //Class
 } //Namespace
diff --git a/OnTopic/Collections/Specialized/TrackedCollection{TItem,TValue,TAttribute}.cs b/OnTopic/Collections/Specialized/TrackedCollection{TItem,TValue,TAttribute}.cs
@@ -146,6 +146,9 @@ public bool IsDirty(string key) {
     ///   cref="Topic.VersionHistory"/>.
     /// </param>
     public void MarkClean(DateTime? version) {
+      if (AssociatedTopic.IsNew) {
+        return;
+      }
       foreach (var trackedItem in Items.Where(a => a.IsDirty).ToArray()) {
         SetValue(trackedItem.Key, trackedItem.Value, false, false, version?? DateTime.UtcNow);
       }
@@ -169,7 +172,10 @@ public void MarkClean(DateTime? version) {
     ///   cref="Topic.VersionHistory"/>.
     /// </param>
     public void MarkClean(string key, DateTime? version) {
-      if (Contains(key)) {
+      if (AssociatedTopic.IsNew) {
+        return;
+      }
+      else if (Contains(key)) {
         var trackedItem         = this[key];
         if (trackedItem.IsDirty) {
           SetValue(trackedItem.Key, trackedItem.Value, false, false, version?? DateTime.UtcNow);
@@ -444,7 +450,10 @@ internal void SetValue(
       \-----------------------------------------------------------------------------------------------------------------------*/
       else if (originalItem is not null) {
         var markAsDirty = originalItem.IsDirty;
-        if (markDirty.HasValue) {
+        if (AssociatedTopic.IsNew) {
+          markAsDirty = true;
+        }
+        else if (markDirty.HasValue) {
           markAsDirty = markDirty.Value;
         }
         else if (originalItem.Value != value) {
@@ -474,7 +483,7 @@ internal void SetValue(
         updatedItem = new TItem() {
           Key                   = key,
           Value                 = value,
-          IsDirty               = markDirty ?? true,
+          IsDirty               = AssociatedTopic.IsNew || (markDirty ?? true),
           LastModified          = version?? DateTime.UtcNow
         };
       }
@@ -534,6 +543,11 @@ internal void SetValue(
     /// </exception>
     protected override void InsertItem(int index, TItem item) {
       Contract.Requires(item, nameof(item));
+      if (AssociatedTopic.IsNew && !item.IsDirty) {
+        item                    = item with {
+          IsDirty               = true
+        };
+      }
       if (_topicPropertyDispatcher.Enforce(item.Key, item)) {
         if (!Contains(item.Key)) {
           base.InsertItem(index, item);
@@ -567,6 +581,11 @@ protected override void InsertItem(int index, TItem item) {
     /// <param name="item">The <see cref="TrackedItem{T}"/> object which is being inserted.</param>
     protected override void SetItem(int index, TItem item) {
       Contract.Requires(item, nameof(item));
+      if (AssociatedTopic.IsNew && !item.IsDirty) {
+        item                    = item with {
+          IsDirty               = true
+        };
+      }
       if (_topicPropertyDispatcher.Enforce(item.Key, item)) {
         base.SetItem(index, item);
         if (DeletedItems.Contains(item.Key)) {
@@ -588,7 +607,9 @@ protected override void SetItem(int index, TItem item) {
     /// </remarks>
     protected override void RemoveItem(int index) {
       var trackedItem = this[index];
-      DeletedItems.Add(trackedItem.Key);
+      if (!AssociatedTopic.IsNew) {
+        DeletedItems.Add(trackedItem.Key);
+      }
       base.RemoveItem(index);
     }
 
@@ -604,7 +625,9 @@ protected override void RemoveItem(int index) {
     ///   cref="TrackedItem{T}"/>s are marked as <see cref="TrackedItem{T}.IsDirty"/>.
     /// </remarks>
     protected override void ClearItems() {
-      DeletedItems.AddRange(Items.Select(a => a.Key));
+      if (!AssociatedTopic.IsNew) {
+        DeletedItems.AddRange(Items.Select(a => a.Key));
+      }
       base.ClearItems();
     }
 
