Removed IsHidden from the ITopicViewModel definition

JeremyCaney · JeremyCaney · commit 68a4e83d255d · 2021-03-01T12:31:13.000-08:00
In addition to cluttering an already overpopulated interface, the `IsHidden` property doesn't make much in the current version of OnTopic, as hidden view models are explicitly excluded from the the `TopicMappingService`.

The one exception to this is the top-level topic—i.e., the one sent directly to the `ITopicMappingService`, as opposed to referenced from its properties. But in those cases, we expect callers, such as `TopicController`, to explicitly determine if `IsHidden is appropriate or not. Given that, there isn't much benefit to exposing `IsHidden` to the view model—either the interface or the implementation.

As part of this, I marked the interface as obsolete, and marked the implementation as both obsolete and disabled mapping of the property. In addition, I removed references to it from the unit tests. These weren't strictly necessary, and can be safely removed while still satisfying the basic criteria of the unit tests.
diff --git a/OnTopic.AspNetCore.Mvc.Host/Views/Shared/_TopicAttributes.cshtml b/OnTopic.AspNetCore.Mvc.Host/Views/Shared/_TopicAttributes.cshtml
@@ -7,7 +7,6 @@
   <li>ContentType: @Model.ContentType</li>
   <li>UniqueKey: @Model.UniqueKey</li>
   <li>WebPath: @Model.WebPath</li>
-  <li>IsHidden? @Model.IsHidden</li>
   <li>LastModified: @Model.LastModified</li>
   <li>View: @Model.View</li>
 </ul>
diff --git a/OnTopic.Tests/TopicMappingServiceTest.cs b/OnTopic.Tests/TopicMappingServiceTest.cs
@@ -85,13 +85,11 @@ public async Task Map_Generic_ReturnsNewModel() {
 
       topic.Attributes.SetValue("MetaTitle", "ValueA");
       topic.Attributes.SetValue("Title", "Value1");
-      topic.Attributes.SetValue("IsHidden", "1");
 
       var target                = await _mappingService.MapAsync<PageTopicViewModel>(topic).ConfigureAwait(false);
 
       Assert.AreEqual<string>("ValueA", target.MetaTitle);
       Assert.AreEqual<string>("Value1", target.Title);
-      Assert.AreEqual<bool>(true, target.IsHidden);
 
     }
 
@@ -127,13 +125,11 @@ public async Task Map_Dynamic_ReturnsNewModel() {
 
       topic.Attributes.SetValue("MetaTitle", "ValueA");
       topic.Attributes.SetValue("Title", "Value1");
-      topic.Attributes.SetValue("IsHidden", "1");
 
       var target                = (PageTopicViewModel?)await _mappingService.MapAsync(topic).ConfigureAwait(false);
 
       Assert.AreEqual<string>("ValueA", target.MetaTitle);
       Assert.AreEqual<string>("Value1", target.Title);
-      Assert.AreEqual<bool>(true, target.IsHidden);
 
     }
 
diff --git a/OnTopic.ViewModels/TopicViewModel.cs b/OnTopic.ViewModels/TopicViewModel.cs
@@ -67,7 +67,9 @@ public record TopicViewModel: ITopicViewModel, IKeyedTopicViewModel, IAssociated
     /*==========================================================================================================================
     | IS HIDDEN?
     \-------------------------------------------------------------------------------------------------------------------------*/
-    /// <inheritdoc />
+    /// <inheritdoc/>
+    [Obsolete("The IsHidden property is no longer supported by TopicViewModel.", true)]
+    [DisableMapping]
     public bool IsHidden { get; init; }
 
     /*==========================================================================================================================
diff --git a/OnTopic/Models/ITopicViewModel.cs b/OnTopic/Models/ITopicViewModel.cs
@@ -68,6 +68,7 @@ public interface ITopicViewModel: IKeyedTopicViewModel, IAssociatedTopicBindingM
     /// <summary>
     ///   Gets or sets whether the current topic is hidden.
     /// </summary>
+    [Obsolete("The IsHidden property is no longer supported by ITopicViewModel.", true)]
     bool IsHidden { get; init; }
 
     /*==========================================================================================================================
