Set default value of ITopicRepository.Delete(isRecursive) to false

JeremyCaney · JeremyCaney · commit 704c8defdeba · 2020-12-16T17:00:57.000-08:00
Originally, `ITopicRepository.Delete()`'s `isRecursive` parameter was set to a default value of `false`, as it only makes sense to do a recursive delete if the user opts into it. Unfortunately, however, there was a long-standing bug where `Delete()` failed to validate whether or not there were children, and thus would _always_ do a recursive delete, regardless of whether or not `isRecursive` was set. Whoops. This was fixed in OnTopic 4.5.0 (a0cc21c). In order to avoid breaking backward compatibility, however, the default was changed to `true` so that it continued to operate as it had before (1773113); otherwise this would have been a breaking change. Having the default be more aggressive doesn't make much sense; users should opt in to the more invasive mode. As such, now that we're preparing for a major release, I'm reverting this back to its original default of `false`. Now, if a user attempts to `Delete(Topic)` without explicitly defining `isRecursive`, and that topic has children, an exception will be thrown, and the topic will not be deleted.
diff --git a/OnTopic.Data.Sql/SqlTopicRepository.cs b/OnTopic.Data.Sql/SqlTopicRepository.cs
@@ -546,7 +546,7 @@ public override void Move(Topic topic, Topic target, Topic? sibling) {
     | METHOD: DELETE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
-    public override void Delete(Topic topic, bool isRecursive = true) {
+    public override void Delete(Topic topic, bool isRecursive = false) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Delete from memory
diff --git a/OnTopic.TestDoubles/DummyTopicRepository.cs b/OnTopic.TestDoubles/DummyTopicRepository.cs
@@ -54,7 +54,7 @@ public DummyTopicRepository() : base() { }
     | METHOD: DELETE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
-    public override void Delete(Topic topic, bool isRecursive = true) => throw new NotImplementedException();
+    public override void Delete(Topic topic, bool isRecursive = false) => throw new NotImplementedException();
 
   } //Class
 } //Namespace
diff --git a/OnTopic.TestDoubles/StubTopicRepository.cs b/OnTopic.TestDoubles/StubTopicRepository.cs
@@ -157,7 +157,7 @@ public override void Move(Topic topic, Topic target, Topic? sibling = null) {
     | METHOD: DELETE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc />
-    public override void Delete(Topic topic, bool isRecursive = true) => base.Delete(topic, isRecursive);
+    public override void Delete(Topic topic, bool isRecursive = false) => base.Delete(topic, isRecursive);
 
     /*==========================================================================================================================
     | METHOD: GET ATTRIBUTES (PROXY)
diff --git a/OnTopic/Repositories/ITopicRepository.cs b/OnTopic/Repositories/ITopicRepository.cs
@@ -147,13 +147,13 @@ public interface ITopicRepository {
     /// <param name="topic">The topic object to delete.</param>
     /// <param name="isRecursive">
     ///   Boolean indicator nothing whether to recurse through the topic's descendants and delete them as well. If set to false
-    ///   and the topic has children, including any nested topics, an exception will be thrown.
+    ///   and the topic has children, including any nested topics, an exception will be thrown. The default is false.
     /// </param>
     /// <requires description="The topic to delete must be provided." exception="T:System.ArgumentNullException">
     ///   topic is not null
     /// </requires>
     /// <exception cref="ArgumentNullException">topic</exception>
-    void Delete(Topic topic, bool isRecursive = true);
+    void Delete(Topic topic, bool isRecursive = false);
 
   } //Interface
 } //Namespace
