Introduced optional excludeLastModified parameter for GetAttributes()

In a previous feature, we introduced the ability to optionally exclude the byline (`LastModifiedBy`) and dateline (`LastModified`) as part of a `Save()` operation if no other attributes had been modified. This was supported by a new `AttributeValueCollection.IsDirty(excludeLastModified)`.

As an extension of this, it's now an optional `excludeLastModified` parameter off of `GetAttributes()`. This allows the caller to specify whether or not `GetAttributes()`  should exclude `LastModified*` attributes or not. This makes it easier to conditionally exclude these based e.g. on the result of `IsDirty()`.

This is relevant to the `bugfix/extended-attributes-mismatch`  branch because `IsDirty()` isn't able to detect `IsExtendedAttributeMismatch()`, which requires a reference to the `AttributeDescriptor`, and is therefore much more expensive to evaluate. As such, we can't just wrap the indexed attributes in a call to `IsDirty()` to determine as a shorthand for excluding the byline and dateline. Instead, we need to still process these—in case they include any `IsExtendedAttributeMismatch()`s—while having an easy way to exclude the byline and dateline. The `excludeLastModified` parameter allows for this.

This includes a unit test to validate the functionality, as well as an extension to the `GetAttributesProxy()` class on `StubTopicRepository`. Finally, it requires updating (and potentially repaginating) some XMLDoc references to the `GetAttributes()`, mostly in `TopicRepositoryBaseTest`.

Author: JeremyCaney

OnTopic.TestDoubles/StubTopicRepository.cs

@@ -168,8 +168,12 @@ public override void Move(Topic topic, Topic target, Topic? sibling) {
     | METHOD: GET ATTRIBUTES (PROXY)
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <inheritdoc cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?)" />
-    public IEnumerable<AttributeValue> GetAttributesProxy(Topic topic, bool? isExtendedAttribute, bool? isDirty = null) =>
-      base.GetAttributes(topic, isExtendedAttribute, isDirty);
+    public IEnumerable<AttributeValue> GetAttributesProxy(
+      Topic topic,
+      bool? isExtendedAttribute,
+      bool? isDirty = null,
+      bool excludeLastModified = false
+    ) => base.GetAttributes(topic, isExtendedAttribute, isDirty, excludeLastModified);
 
     /*==========================================================================================================================
     | METHOD: GET UNMATCHED ATTRIBUTES (PROXY)

OnTopic.Tests/TopicRepositoryBaseTest.cs

@@ -174,13 +174,35 @@ public void GetAttributes_ExtendedAttributeMismatch_ReturnsNothing() {
 
     }
 
+    /*==========================================================================================================================
+    | TEST: GET ATTRIBUTES: EXCLUDE LAST MODIFIED: RETURNS OTHER ATTRIBUTES
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Retrieves a list of attributes from a topic, filtering by <c>excludeLastModified</c>. Confirms that <see
+    ///   cref="AttributeValue"/>s are not returned which start with <c>LastModified</c>.
+    /// </summary>
+    [TestMethod]
+    public void GetAttributes_ExcludeLastModified_ReturnsOtherAttributes() {
+
+      var topic                 = TopicFactory.Create("Test", "ContentTypes");
+
+      topic.Attributes.SetDateTime("LastModified", DateTime.Now);
+      topic.Attributes.SetValue("LastModifiedBy", "Unit Tests");
+
+      var attributes            = _topicRepository.GetAttributesProxy(topic, null, excludeLastModified: true);
+
+      //Expected to return Key and ContentType, butnot LastModified or LastModifiedBy
+      Assert.AreEqual<int>(2, attributes.Count());
+
+    }
+
     /*==========================================================================================================================
     | TEST: GET ATTRIBUTES: ARBITRARY ATTRIBUTE WITH SHORT VALUE: RETURNS AS INDEXED ATTRIBUTE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
     ///   Sets an arbitrary (unmatched) attribute on a <see cref="Topic"/> with a value shorter than 255 characters, then
     ///   ensures that it is returned as an an <i>indexed</i> <see cref="AttributeValue"/> when calling <see
-    ///   cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?)"/>.
+    ///   cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?, Boolean)"/>.
     /// </summary>
     [TestMethod]
     public void GetAttributes_ArbitraryAttributeWithShortValue_ReturnsAsIndexedAttributes() {
@@ -201,7 +223,7 @@ public void GetAttributes_ArbitraryAttributeWithShortValue_ReturnsAsIndexedAttri
     /// <summary>
     ///   Sets an arbitrary (unmatched) attribute on a <see cref="Topic"/> with a value longer than 255 characters, then
     ///   ensures that it is returned as an an <see cref="AttributeDescriptor.IsExtendedAttribute"/> when calling <see
-    ///   cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?)"/>.
+    ///   cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?, Boolean)"/>.
     /// </summary>
     [TestMethod]
     public void GetAttributes_ArbitraryAttributeWithLongValue_ReturnsAsExtendedAttributes() {
@@ -342,7 +364,7 @@ public void GetContentTypeDescriptor_GetInvalidContentType_ReturnsNull() {
     | TEST: SAVE: CONTENT TYPE DESCRIPTOR: UPDATES CONTENT TYPE CACHE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Loads the <see cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?)"/>, then saves a new <see
+    ///   Loads the <see cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?, Boolean)"/>, then saves a new <see
     ///   cref="ContentTypeDescriptor"/> via <see cref="TopicRepositoryBase.Save(Topic, Boolean, Boolean)"/>, and ensures that
     ///   it is immediately reflected in the <see cref="TopicRepositoryBase"/> cache of <see cref="ContentTypeDescriptor"/>s.
     /// </summary>
@@ -362,9 +384,9 @@ public void Save_ContentTypeDescriptor_UpdatesContentTypeCache() {
     | TEST: DELETE: CONTENT TYPE DESCRIPTOR: UPDATES CONTENT TYPE CACHE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Loads the <see cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?)"/>, then deletes one of the <see
-    ///   cref="ContentTypeDescriptor"/>s via <see cref="TopicRepositoryBase.Delete(Topic, Boolean)"/>, and ensures that it is
-    ///   immediately reflected in the <see cref="TopicRepositoryBase"/> cache of <see cref="ContentTypeDescriptor"/>s.
+    ///   Loads the <see cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?, Boolean)"/>, then deletes one of the
+    ///   <see cref="ContentTypeDescriptor"/>s via <see cref="TopicRepositoryBase.Delete(Topic, Boolean)"/>, and ensures that it
+    ///   is immediately reflected in the <see cref="TopicRepositoryBase"/> cache of <see cref="ContentTypeDescriptor"/>s.
     /// </summary>
     [TestMethod]
     public void Delete_ContentTypeDescriptor_UpdatesContentTypeCache() {
@@ -382,8 +404,8 @@ public void Delete_ContentTypeDescriptor_UpdatesContentTypeCache() {
     | TEST: MOVE: CONTENT TYPE DESCRIPTOR: UPDATES CONTENT TYPE CACHE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Loads the <see cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?)"/>, then moves one of the <see
-    ///   cref="ContentTypeDescriptor"/>s via <see cref="TopicRepositoryBase.Move(Topic, Topic)"/>, and ensures that it is
+    ///   Loads the <see cref="TopicRepositoryBase.GetAttributes(Topic, Boolean?, Boolean?, Boolean)"/>, then moves one of the
+    ///   <see cref="ContentTypeDescriptor"/>s via <see cref="TopicRepositoryBase.Move(Topic, Topic)"/>, and ensures that it is
     ///   immediately reflected in the <see cref="TopicRepositoryBase"/> cache of <see cref="ContentTypeDescriptor"/>s.
     /// </summary>
     [TestMethod]

OnTopic/Repositories/TopicRepositoryBase.cs

@@ -493,7 +493,13 @@ public virtual void Delete([ValidatedNotNull, NotNull]Topic topic, bool isRecurs
     ///   Whether or not to filter by <see cref="AttributeValue.IsDirty"/>. If <c>null</c>, all <see cref="AttributeValue"/>s
     ///   are returned.
     /// </param>
-    protected IEnumerable<AttributeValue> GetAttributes(Topic topic, bool? isExtendedAttribute, bool? isDirty = null) {
+    /// <param name="excludeLastModified">Exclude any attributes that start with <c>LastModified</c>.</param>
+    protected IEnumerable<AttributeValue> GetAttributes(
+      Topic topic,
+      bool? isExtendedAttribute,
+      bool? isDirty = null,
+      bool excludeLastModified = false
+    ) {
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Validate input
@@ -520,6 +526,11 @@ protected IEnumerable<AttributeValue> GetAttributes(Topic topic, bool? isExtende
         var key                 = attributeValue.Key;
         var attribute           = (AttributeDescriptor?)null;
 
+        //Optionally exclude LastModified attributes
+        if (excludeLastModified && attributeValue.Key.StartsWith("LastModified", StringComparison.InvariantCultureIgnoreCase)) {
+          continue;
+        }
+
         //Reset cached attribute descriptors just in case a new attribute has been added
         if (!contentType.AttributeDescriptors.Contains(key)) {
           contentType.ResetAttributeDescriptors();