Renamed Topic.IsSaved to Topic.IsNew

In a recent commit, we introduced the new `Topic.IsSaved` property to determine if a topic mapped to a topic saved in the underlying `ITopicRepository` (1678523). This is prone to confusion because `IsSaved` could imply that the topic is an existing entity, but that its current state hasn't yet been saved. To help avoid that confusion, I've renamed it to `Topic.IsNew`. This is less ambiguous.

As this has the opposite meaning of the previous property, this means flipping the `!` references.

Author: JeremyCaney

OnTopic.Data.Sql/SqlTopicRepository.cs

@@ -392,7 +392,7 @@ SqlDateTime version
       /*------------------------------------------------------------------------------------------------------------------------
       | Establish database connection
       \-----------------------------------------------------------------------------------------------------------------------*/
-      var procedureName         = !topic.IsSaved? "CreateTopic" : "UpdateTopic";
+      var procedureName         = topic.IsNew? "CreateTopic" : "UpdateTopic";
 
       using var command         = new SqlCommand(procedureName, connection) {
         CommandType             = CommandType.StoredProcedure
@@ -413,7 +413,7 @@ SqlDateTime version
       /*------------------------------------------------------------------------------------------------------------------------
       | Establish query parameters
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (topic.IsSaved) {
+      if (!topic.IsNew) {
         command.AddParameter("TopicID", topic.Id);
         command.AddParameter("DeleteRelationships", areReferencesResolved && areRelationshipsDirty);
       }
@@ -435,7 +435,7 @@ SqlDateTime version
         topic.Id                = command.GetReturnCode();
 
         Contract.Assume<InvalidOperationException>(
-          topic.IsSaved,
+          !topic.IsNew,
           "The call to the CreateTopic stored procedure did not return the expected 'Id' parameter."
         );
 
@@ -605,7 +605,7 @@ private static void PersistRelations(Topic topic, SqlConnection connection) {
 
           var relatedTopics     = topic.Relationships.GetTopics(key);
           var topicId           = topic.Id.ToString(CultureInfo.InvariantCulture);
-          var savedTopics       = relatedTopics.Where(t => t.IsSaved).Select<Topic, int>(m => m.Id);
+          var savedTopics       = relatedTopics.Where(t => !t.IsNew).Select<Topic, int>(m => m.Id);
 
           using var targetIds   = new TopicListDataTable();
           using var command     = new SqlCommand("UpdateRelationships", connection) {

OnTopic.TestDoubles/StubTopicRepository.cs

@@ -115,7 +115,7 @@ public override int Save(Topic topic, bool isRecursive = false, bool isDraft = f
       /*------------------------------------------------------------------------------------------------------------------------
       | Recurse through children
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (!topic.IsSaved) {
+      if (topic.IsNew) {
         topic.Id = _identity++;
       }
 

OnTopic/Mapping/TopicMappingService.cs

@@ -193,7 +193,7 @@ private async Task<object> MapAsync(
       if (cache.TryGetValue(topic.Id, out var dto)) {
         return dto;
       }
-      else if (topic.IsSaved) {
+      else if (!topic.IsNew) {
         cache.GetOrAdd(topic.Id, target);
       }
 

OnTopic/Repositories/TopicRepositoryBase.cs

@@ -333,7 +333,7 @@ public virtual int Save([ValidatedNotNull, NotNull]Topic topic, bool isRecursive
       /*----------------------------------------------------------------------------------------------------------------------
       | Perform reordering and/or move
       \---------------------------------------------------------------------------------------------------------------------*/
-      if (topic.Parent != null && topic.Attributes.IsDirty("ParentId") && topic.IsSaved) {
+      if (topic.Parent != null && topic.Attributes.IsDirty("ParentId") && !topic.IsNew) {
         var topicIndex = topic.Parent.Children.IndexOf(topic);
         if (topicIndex > 0) {
           Move(topic, topic.Parent, topic.Parent.Children[topicIndex - 1]);
@@ -347,7 +347,7 @@ public virtual int Save([ValidatedNotNull, NotNull]Topic topic, bool isRecursive
       | If new content type, add to cache
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (
-        !topic.IsSaved &&
+        topic.IsNew &&
         topic is ContentTypeDescriptor &&
         _contentTypeDescriptors != null &&
         !_contentTypeDescriptors.Contains(topic.Key)
@@ -358,7 +358,7 @@ topic is ContentTypeDescriptor &&
       /*------------------------------------------------------------------------------------------------------------------------
       | If new attribute, refresh cache
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (!topic.IsSaved && IsAttributeDescriptor(topic)) {
+      if (topic.IsNew && IsAttributeDescriptor(topic)) {
         ResetAttributeDescriptors(topic);
       }
 
@@ -606,7 +606,7 @@ protected IEnumerable<AttributeDescriptor> GetUnmatchedAttributes(Topic topic) {
       foreach (var attribute in contentType.AttributeDescriptors) {
 
         // Ignore unsaved topics
-        if (!topic.IsSaved) {
+        if (topic.IsNew) {
           continue;
         }
 

OnTopic/Topic.cs

@@ -285,16 +285,21 @@ public string? View {
     }
 
     /*==========================================================================================================================
-    | PROPERTY: IS SAVED
+    | PROPERTY: IS NEW
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
     ///   Determines whether or not the current <see cref="Topic"/> has been saved to an underlying <see
-    ///   cref="Repositories.ITopicRepository"/>.
+    ///   cref="Repositories.ITopicRepository"/>. If not, returns <c>true</c>.
     /// </summary>
+    /// <remarks>
+    ///   This property does <i>not</i> reflect whether the current <i>state</i> of the topic has been saved. It <i>only</i>
+    ///   determines if the <see cref="Topic"/> maps to an existing entity in the underlying <see
+    ///   cref="Repositories.ITopicRepository"/>.
+    /// </remarks>
     /// <value>
     ///   <c>true</c> if it has been saved; otherwise, <c>false</c>.
     /// </value>
-    public bool IsSaved => Id >= 0;
+    public bool IsNew => Id < 0;
 
     /*==========================================================================================================================
     | PROPERTY: IS HIDDEN