Merge branch 'feature/Sitemap-IsPrivateBranch' into develop

The new `IsPrivateBranch` attribute allows entire branches of the topic tree to be excluded from the `SitemapController`. As the name suggests, this is intended for private branches that aren't otherwise crawlable by search engines, and thus should be excluded in order to avoid crawling errors and, potentially, exposure of private information. This can be used, for instance, for `Configuration` (which is internal infrastructure) and `Administration` (which is exposed as a web page, but requires authorization).

This is intended as a replacement for the recursive `NoIndex`, which excludes an entire branch if applied to `Container`, but only the current topic if applied to any other content type; this inconsistency is confusing, and the name is unintuitive. The name `IsPrivateBranch` is much more explicit about the scope and intent, and will better distinguish it from the `NoIndex` attribute on `Page`, which will continue to be used to request that publicly available pages not be indexed by either search engines (via the `noindex` metatag) or the `SitemapController`.

This resolves #72.

Author: JeremyCaney

OnTopic.AspNetCore.Mvc.Tests/TestDoubles/TestTopicRepository.cs

@@ -68,6 +68,8 @@ private static Topic CreateFakeData() {
       _                         = new Topic("NoIndexChild", "Page", noIndexPage);
       var noIndexContainer      = new Topic("NoIndexContainer", "Container", webTopic);
       _                         = new Topic("NoIndexContainerChild", "Page", noIndexContainer);
+      var privateBranch         = new Topic("PrivateBranch", "Page", webTopic);
+      _                         = new Topic("PrivateBranchChild", "Page", privateBranch);
       var disabledPage          = new Topic("Disabled", "Page", webTopic);
       var pageGroup             = new Topic("PageGroup", "PageGroup", rootTopic);
       _                         = new Topic("PageGroupChild", "Page", pageGroup);
@@ -97,6 +99,7 @@ private static Topic CreateFakeData() {
 
       //Excluded descendants
       noIndexContainer.Attributes.SetBoolean("NoIndex", true);
+      privateBranch.Attributes.SetBoolean("IsPrivateBranch", true);
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Return data

OnTopic.AspNetCore.Mvc.Tests/TopicControllerTest.cs

@@ -207,11 +207,11 @@ public void SitemapController_Index_ExcludesContentTypes() {
     [Fact]
     public void SitemapController_Index_ExcludesContainerDescendants() {
 
-      var controller = new SitemapController(_topicRepository) {
-        ControllerContext = new(_context)
+      var controller            = new SitemapController(_topicRepository) {
+        ControllerContext       = new(_context)
       };
-      var result = controller.Extended(true) as ContentResult;
-      var model = result?.Content as string;
+      var result                = controller.Extended(true) as ContentResult;
+      var model                 = result?.Content as string;
 
       controller.Dispose();
 
@@ -221,6 +221,29 @@ public void SitemapController_Index_ExcludesContainerDescendants() {
 
     }
 
+    /*==========================================================================================================================
+    | TEST: SITEMAP CONTROLLER: INDEX: EXCLUDES PRIVATE BRANCHES
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Triggers the index action of the <see cref="SitemapController.Index(Boolean, Boolean)" /> action and verifies that it
+    ///   properly excludes the topics that are marked as <c>IsPrivateBranch</c>, including their descendants.
+    /// </summary>
+    [Fact]
+    public void SitemapController_Index_ExcludesPrivateBranches() {
+
+      var controller            = new SitemapController(_topicRepository) {
+        ControllerContext       = new(_context)
+      };
+      var result                = controller.Extended(true) as ContentResult;
+      var model                 = result?.Content as string;
+
+      controller.Dispose();
+
+      Assert.NotNull(model);
+      Assert.False(model!.Contains("PrivateBranch/</loc>", StringComparison.Ordinal));
+      Assert.False(model!.Contains("PrivateBranchChild/</loc>", StringComparison.Ordinal));
+
+    }
 
     /*==========================================================================================================================
     | TEST: SITEMAP CONTROLLER: EXTENDED: INCLUDES ATTRIBUTES

OnTopic.AspNetCore.Mvc/Controllers/SitemapController.cs

@@ -198,6 +198,7 @@ private IEnumerable<XElement> AddTopic(Topic topic, bool includeMetadata = false
       | Validate topic
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (
+        topic.Attributes.GetBoolean("IsPrivateBranch") ||
         topic.ContentType.Equals("Container", StringComparison.OrdinalIgnoreCase) &&
         topic.Attributes.GetBoolean("NoIndex")
       ) return topics;