Renamed RelationshipType to CollectionType

This corresponds to the rename of the `[Relationship()]` attribute to `[Collection()]`. This also has a large downstream effect, since `PropertyConfiguration` has a `RelationshipType` property, and there are a lot of related `relationshipType` variables throughout the code base.

Author: JeremyCaney

OnTopic.Tests/BindingModels/InvalidRelationshipTypeTopicBindingModel.cs

@@ -14,9 +14,9 @@ namespace OnTopic.Tests.BindingModels {
   | BINDING MODEL: RELATIONSHIP TYPE TOPIC (INVALID)
   \---------------------------------------------------------------------------------------------------------------------------*/
   /// <summary>
-  ///   Provides a custom binding model with an invalid <see cref="RelationshipType"/>—i.e., it refers to <see
-  ///   cref="RelationshipType.NestedTopics"/>, even though the property is associated with a <see
-  ///   cref="RelationshipType.Relationship"/>. An <see cref="InvalidOperationException"/> should be thrown when it is mapped.
+  ///   Provides a custom binding model with an invalid <see cref="CollectionType"/>—i.e., it refers to <see cref="
+  ///   CollectionType.NestedTopics"/>, even though the property is associated with a <see cref="CollectionType.Relationship"/>.
+  ///   An <see cref="InvalidOperationException"/> should be thrown when it is mapped.
   /// </summary>
   /// <remarks>
   ///   This is a sample class intended for test purposes only; it is not designed for use in a production environment.
@@ -25,7 +25,7 @@ public class InvalidRelationshipTypeTopicBindingModel : BasicTopicBindingModel {
 
     public InvalidRelationshipTypeTopicBindingModel(string? key = null) : base(key, "ContentTypeDescriptor") { }
 
-    [Collection(RelationshipType.NestedTopics)]
+    [Collection(CollectionType.NestedTopics)]
     public Collection<RelatedTopicBindingModel> ContentTypes { get; } = new();
 
   } //Class

OnTopic.Tests/ReverseTopicMappingServiceTest.cs

@@ -440,10 +440,9 @@ public async Task Map_InvalidRelationshipBaseType_ThrowsInvalidOperationExceptio
     | TEST: MAP: INVALID RELATIONSHIP TYPE: THROWS INVALID OPERATION EXCEPTION
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Maps a content type that has a relationship an invalid <see cref="RelationshipType"/>—i.e., it refers to <see
-    ///   cref="RelationshipType.NestedTopics"/>, even though the property is associated with a <see
-    ///   cref="RelationshipType.Relationship"/>. This is invalid, and expected to throw an <see
-    ///   cref="InvalidOperationException"/>.
+    ///   Maps a content type that has a relationship with an invalid <see cref="CollectionType"/>—i.e., it refers to <see cref=
+    ///   "CollectionType.NestedTopics"/>, even though the property is associated with a <see cref="CollectionType.Relationship"
+    ///   />. This is invalid, and expected to throw an <see cref="InvalidOperationException"/>.
     /// </summary>
     [TestMethod]
     [ExpectedException(typeof(MappingModelValidationException))]

OnTopic.Tests/TopicMappingServiceTest.cs

@@ -387,12 +387,11 @@ public async Task Map_Relationships_SkipsDisabled() {
     ///   type specified by <see cref="Mapping.Annotations.CollectionAttribute"/>.
     /// </summary>
     /// <remarks>
-    ///   The <see cref="AmbiguousRelationTopicViewModel.RelationshipAlias"/> uses <see
-    ///   cref="Mapping.Annotations.CollectionAttribute"/> to set the relationship key to <c>AmbiguousRelationship</c> and the
-    ///   <see cref="RelationshipType"/> to <see cref="RelationshipType.IncomingRelationship"/>. <c>AmbiguousRelationship</c>
-    ///   refers to a relationship that is both outgoing and incoming. It should be smart enough to a) look for the
-    ///   <c>AmbigousRelationship</c> instead of the <c>RelationshipAlias</c>, and b) source from the <see
-    ///   cref="Topic.IncomingRelationships"/> collection.
+    ///   The <see cref="AmbiguousRelationTopicViewModel.RelationshipAlias"/> uses <see cref="Mapping.Annotations.
+    ///   CollectionAttribute"/> to set the relationship key to <c>AmbiguousRelationship</c> and the <see cref="CollectionType"
+    ///   /> to <see cref="CollectionType.IncomingRelationship"/>. <c>AmbiguousRelationship</c> refers to a relationship that is
+    ///   both outgoing and incoming. It should be smart enough to a) look for the <c>AmbigousRelationship</c> instead of the
+    ///   <c>RelationshipAlias</c>, and b) source from the <see cref="Topic.IncomingRelationships"/> collection.
     /// </remarks>
     [TestMethod]
     public async Task Map_AlternateRelationship_ReturnsCorrectRelationship() {

OnTopic.Tests/ViewModels/AmbiguousRelationTopicViewModel.cs

@@ -16,18 +16,17 @@ namespace OnTopic.Tests.ViewModels {
   /// </summary>
   /// <remarks>
   ///   <para>
-  ///     The <see cref="RelationshipAlias"/> uses <see cref="CollectionAttribute"/> to set the relationship key to
-  ///     <c>AmbiguousRelationship</c> and the <see cref="RelationshipType"/> to <see
-  ///     cref="RelationshipType.IncomingRelationship"/>. <c>AmbiguousRelationship</c> refers to a relationship that is both
-  ///     outgoing and incoming.
+  ///     The <see cref="RelationshipAlias"/> uses <see cref="CollectionAttribute"/> to set the relationship key to <c>
+  ///     AmbiguousRelationship</c> and the <see cref="CollectionType"/> to <see cref="CollectionType.IncomingRelationship"/>.
+  ///     <c>AmbiguousRelationship</c> refers to a relationship that is both outgoing and incoming.
   ///   </para>
   ///   <para>
   ///     This is a sample class intended for test purposes only; it is not designed for use in a production environment.
   ///   </para>
   /// </remarks>
   public class AmbiguousRelationTopicViewModel: KeyOnlyTopicViewModel {
 
-    [Collection("AmbiguousRelationship", Type=RelationshipType.IncomingRelationship)]
+    [Collection("AmbiguousRelationship", Type= CollectionType.IncomingRelationship)]
     public Collection<KeyOnlyTopicViewModel> RelationshipAlias { get; } = new();
 
   } //Class

OnTopic.Tests/ViewModels/Metadata/ContentTypeDescriptorTopicViewModel.cs

@@ -22,7 +22,7 @@ public class ContentTypeDescriptorTopicViewModel {
 
     public Collection<AttributeDescriptorTopicViewModel> AttributeDescriptors { get; } = new();
 
-    [Collection(RelationshipType.MappedCollection)]
+    [Collection(CollectionType.MappedCollection)]
     [Follow(Relationships.None)]
     public Collection<ContentTypeDescriptorTopicViewModel> PermittedContentTypes { get; } = new();
 

OnTopic/Mapping/Annotations/CollectionAttribute.cs

@@ -43,29 +43,29 @@ public CollectionAttribute(string key) {
     }
 
     /// <summary>
-    ///   Annotates a property with the <see cref="CollectionAttribute"/> by providing the <see cref="RelationshipType"/>.
+    ///   Annotates a property with the <see cref="CollectionAttribute"/> by providing the <see cref="CollectionType"/>.
     /// </summary>
     /// <param name="type">Optional. The type of collection the relationship is associated with.</param>
-    public CollectionAttribute(RelationshipType type = RelationshipType.Any) {
+    public CollectionAttribute(CollectionType type = CollectionType.Any) {
       Type = type;
     }
 
     /*==========================================================================================================================
     | PROPERTY: KEY
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Gets the value of the relationship key.
+    ///   Gets the value of the collection key.
     /// </summary>
     public string? Key { get; }
 
     /*==========================================================================================================================
     | PROPERTY: TYPE
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Gets the value of the relationship type.
+    ///   Gets the value of the <see cref="CollectionType"/>.
     /// </summary>
     #pragma warning disable CA1019 // Define accessors for attribute arguments
-    public RelationshipType Type { get; set; }
+    public CollectionType Type { get; set; }
     #pragma warning restore CA1019 // Define accessors for attribute arguments
 
   } //Class

OnTopic/Mapping/Annotations/RelationshipType.cs renamed to OnTopic/Mapping/Annotations/CollectionType.cs

@@ -7,15 +7,16 @@
 namespace OnTopic.Mapping.Annotations {
 
   /*============================================================================================================================
-  | ENUM: RELATIONSHIP TYPE
+  | ENUM: COLLECTION TYPE
   \---------------------------------------------------------------------------------------------------------------------------*/
   /// <summary>
-  ///   Enum that allows a relationship to be specified.
+  ///   Enum that allows a collection to be specified.
   /// </summary>
   /// <remarks>
-  ///   This differs from <see cref="Relationships"/>, which allows <i>multiple</i> relationships to be specified.
+  ///   This differs from <see cref="Relationships"/>, which allows <i>multiple</i> collections to be specified, and also
+  ///   includes the <see cref="Topic.Parent"/> as a source.
   /// </remarks>
-  public enum RelationshipType {
+  public enum CollectionType {
 
     #pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 

OnTopic/Mapping/Annotations/Relationships.cs

@@ -23,7 +23,7 @@ namespace OnTopic.Mapping.Annotations {
   ///     relevant to the <see cref="Topic"/> class and its view models.
   ///   </para>
   ///   <para>
-  ///     This differs from <see cref="RelationshipType"/>, which only allows <i>one</i> relationship to be specified.
+  ///     This differs from <see cref="CollectionType"/>, which only allows <i>one</i> collection to be specified.
   ///   </para>
   /// </remarks>
   [Flags]
@@ -49,15 +49,15 @@ public enum Relationships {
     | CHILDREN
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Map <see cref="Topic.Children"/> references, or properties marked as <see cref="RelationshipType.Children"/>.
+    ///   Map <see cref="Topic.Children"/> references, or properties marked as <see cref="CollectionType.Children"/>.
     /// </summary>
     Children                    = 1 << 1,
 
     /*==========================================================================================================================
     | RELATIONSHIPS
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
-    ///   Map <see cref="Topic.Relationships"/> references, or properties marked as <see cref="RelationshipType.Relationship"/>.
+    ///   Map <see cref="Topic.Relationships"/> references, or properties marked as <see cref="CollectionType.Relationship"/>.
     /// </summary>
     Relationships               = 1 << 2,
 
@@ -66,7 +66,7 @@ public enum Relationships {
     \-------------------------------------------------------------------------------------------------------------------------*/
     /// <summary>
     ///   Map <see cref="Topic.IncomingRelationships"/> references, or properties marked as <see
-    ///   cref="RelationshipType.IncomingRelationship"/>.
+    ///   cref="CollectionType.IncomingRelationship"/>.
     /// </summary>
     IncomingRelationships       = 1 << 3,
 

OnTopic/Mapping/Internal/PropertyConfiguration.cs

@@ -68,7 +68,7 @@ public PropertyConfiguration(PropertyInfo property, string? attributePrefix = ""
       DefaultValue              = null;
       InheritValue              = false;
       RelationshipKey           = AttributeKey;
-      RelationshipType          = RelationshipType.Any;
+      CollectionType            = CollectionType.Any;
       CrawlRelationships        = Relationships.None;
       MetadataKey               = null;
       DisableMapping            = false;
@@ -96,12 +96,12 @@ public PropertyConfiguration(PropertyInfo property, string? attributePrefix = ""
         property,
         a => {
           RelationshipKey = a.Key ?? RelationshipKey;
-          RelationshipType = a.Type;
+          CollectionType = a.Type;
         }
       );
 
       if (RelationshipKey.Equals("Children", StringComparison.OrdinalIgnoreCase)) {
-        RelationshipType = RelationshipType.Children;
+        CollectionType = CollectionType.Children;
       }
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -264,17 +264,17 @@ public PropertyConfiguration(PropertyInfo property, string? attributePrefix = ""
     ///   <para>
     ///     By default, a collection property on a DTO class will attempt to find a match from, in order, <see
     ///     cref="Topic.Relationships"/>, <see cref="Topic.IncomingRelationships"/>, and, finally, <see cref="Topic.Children"/>.
-    ///     If the <see cref="RelationshipType"/> is set, however, then the <see cref="ITopicMappingService"/> will <i>only</i>
+    ///     If the <see cref="CollectionType"/> is set, however, then the <see cref="ITopicMappingService"/> will <i>only</i>
     ///     map the collection to a relationship of that type. This can be valuable when the <see cref="RelationshipKey"/> might
     ///     be ambiguous between multiple collections.
     ///   </para>
     ///   <para>
-    ///     The <see cref="RelationshipType"/> property corresponds to the <see cref="CollectionAttribute.Type"/> property. It
+    ///     The <see cref="CollectionType"/> property corresponds to the <see cref="CollectionAttribute.Type"/> property. It
     ///     can be assigned by decorating a DTO property with e.g. <c>[Relationship("AlternateRelationshipKey",
-    ///     RelationshipType.Children)]</c>.
+    ///     CollectionType.Children)]</c>.
     ///   </para>
     /// </remarks>
-    public RelationshipType RelationshipType { get; set; }
+    public CollectionType CollectionType { get; set; }
 
     /*==========================================================================================================================
     | PROPERTY: CRAWL RELATIONSHIPS
@@ -286,7 +286,7 @@ public PropertyConfiguration(PropertyInfo property, string? attributePrefix = ""
     /// <remarks>
     ///   <para>
     ///     By default, the all relationships will be mapped on the target DTO, unless the caller specifies otherwise. On any
-    ///     related DTOs, however, only <see cref="RelationshipType.NestedTopics"/> will be mapped. So, if a mapped DTO has a
+    ///     related DTOs, however, only <see cref="CollectionType.NestedTopics"/> will be mapped. So, if a mapped DTO has a
     ///     collection for children, relationships, or even a parent property then any relationships on <i>those</i> DTOs will
     ///     not be mapped. This behavior can be changed by specifying the <see cref="CrawlRelationships"/> flag, which allows
     ///     one or multiple relationships to be specified for a given property.

OnTopic/Mapping/Internal/RelationshipMap.cs

@@ -12,11 +12,11 @@ namespace OnTopic.Mapping.Internal {
   | CLASS: RELATIONSHIP MAP
   \---------------------------------------------------------------------------------------------------------------------------*/
   /// <summary>
-  ///   Provides a mapping of the relationship between <see cref="RelationshipType"/> and <see cref="Relationships"/>.
+  ///   Provides a mapping of the relationship between <see cref="CollectionType"/> and <see cref="Relationships"/>.
   /// </summary>
   /// <remarks>
-  ///   While the <see cref="RelationshipType"/> and <see cref="Relationships"/> enumerations are distinct, there are times when
-  ///   a single <see cref="RelationshipType"/> needs to be related to an item in the collection of <see cref="Relationships"/>.
+  ///   While the <see cref="CollectionType"/> and <see cref="Relationships"/> enumerations are distinct, there are times when
+  ///   a single <see cref="CollectionType"/> needs to be related to an item in the collection of <see cref="Relationships"/>.
   ///   This mapping makes that feasible.
   /// </remarks>
   static internal class RelationshipMap {
@@ -26,13 +26,13 @@ static internal class RelationshipMap {
     \-------------------------------------------------------------------------------------------------------------------------*/
     static RelationshipMap() {
 
-      var mappings = new Dictionary<RelationshipType, Relationships> {
-        { RelationshipType.Any, Relationships.None },
-        { RelationshipType.Children, Relationships.Children },
-        { RelationshipType.Relationship, Relationships.Relationships },
-        { RelationshipType.NestedTopics, Relationships.None },
-        { RelationshipType.MappedCollection, Relationships.MappedCollections },
-        { RelationshipType.IncomingRelationship, Relationships.IncomingRelationships }
+      var mappings = new Dictionary<CollectionType, Relationships> {
+        { CollectionType.Any, Relationships.None },
+        { CollectionType.Children, Relationships.Children },
+        { CollectionType.Relationship, Relationships.Relationships },
+        { CollectionType.NestedTopics, Relationships.None },
+        { CollectionType.MappedCollection, Relationships.MappedCollections },
+        { CollectionType.IncomingRelationship, Relationships.IncomingRelationships }
       };
 
       Mappings = mappings;
@@ -42,7 +42,7 @@ static RelationshipMap() {
     /*==========================================================================================================================
     | PROPERTY: MAPPINGS
     \-------------------------------------------------------------------------------------------------------------------------*/
-    static internal Dictionary<RelationshipType, Relationships> Mappings { get; }
+    static internal Dictionary<CollectionType, Relationships> Mappings { get; }
 
   } //Class
 } //Namespace