Merge branch 'release/4.1.1'

Author: JeremyCaney

OnTopic.TestDoubles/StubTopicRepository.cs

@@ -222,7 +222,7 @@ private Topic CreateFakeData() {
 
       var contactContentType = TopicFactory.Create("Contact", "ContentTypeDescriptor", contentTypes);
 
-      addAttribute(contactContentType, "Email");
+      addAttribute(contactContentType, "Name");
       addAttribute(contactContentType, "AlternateEmail");
       addAttribute(contactContentType, "BillingContactEmail");
 

OnTopic.Tests/BindingModels/ContactTopicBindingModel.cs

@@ -18,7 +18,7 @@ namespace OnTopic.Tests.BindingModels {
   /// </remarks>
   public class ContactTopicBindingModel {
 
-    public string? Email { get; set; }
+    public string? Name { get; set; }
 
   } //Class
 } //Namespace

OnTopic.Tests/BindingModels/EmailTopicBindingModel.cs

@@ -0,0 +1,24 @@
+/*==============================================================================================================================
+| Author        Ignia, LLC
+| Client        Ignia, LLC
+| Project       Topics Library
+\=============================================================================================================================*/
+
+namespace OnTopic.Tests.BindingModels {
+
+  /*============================================================================================================================
+  | BINDING MODEL: EMAIL
+  \---------------------------------------------------------------------------------------------------------------------------*/
+  /// <summary>
+  ///   Provides a minimal implementation of a custom topic binding model with a single property intended to be called from
+  ///   <see cref="MapToParentTopicBindingModel"/>.
+  /// </summary>
+  /// <remarks>
+  ///   This is a sample class intended for test purposes only; it is not designed for use in a production environment.
+  /// </remarks>
+  public class EmailTopicBindingModel {
+
+    public string? Email { get; set; }
+
+  } //Class
+} //Namespace

OnTopic.Tests/BindingModels/MapToParentTopicBindingModel.cs

@@ -22,10 +22,10 @@ public class MapToParentTopicBindingModel : BasicTopicBindingModel {
     public ContactTopicBindingModel PrimaryContact { get; set; } = new ContactTopicBindingModel();
 
     [MapToParent(AttributePrefix="Alternate")]
-    public ContactTopicBindingModel AlternateContact { get; set; } = new ContactTopicBindingModel();
+    public EmailTopicBindingModel AlternateContact { get; set; } = new EmailTopicBindingModel();
 
     [MapToParent]
-    public ContactTopicBindingModel BillingContact { get; set; } = new ContactTopicBindingModel();
+    public EmailTopicBindingModel BillingContact { get; set; } = new EmailTopicBindingModel();
 
   } //Class
 } //Namespace

OnTopic.Tests/ReverseTopicMappingServiceTest.cs

@@ -139,7 +139,7 @@ public async Task Map_Existing_ReturnsUpdatedTopic() {
       target.Title              = "Original Attribute";
       target.DefaultValue       = "Hello";
       target.IsRequired         = true;
-      target.IsExtendedAttribute        = false;
+      target.IsExtendedAttribute= false;
       target.Description        = "Original Description";
 
       target                    = (TextAttribute?)await mappingService.MapAsync(bindingModel, target).ConfigureAwait(false);
@@ -170,14 +170,14 @@ public async Task Map_ComplexObject_ReturnsFlattenedTopic() {
         ContentType             = "Contact"
       };
 
-      bindingModel.PrimaryContact.Email = "[email protected]";
-      bindingModel.AlternateContact.Email = "[email protected]";
-      bindingModel.BillingContact.Email = "[email protected]";
-
+      bindingModel.PrimaryContact.Name                          = "Jeremy";
+      bindingModel.AlternateContact.Email                       = "[email protected]";
+      bindingModel.BillingContact.Email                         = "[email protected]";
+ 
       var target                = (Topic?)await mappingService.MapAsync(bindingModel).ConfigureAwait(false);
 
       Assert.IsNotNull(target);
-      Assert.AreEqual<string>("[email protected]", target.Attributes.GetValue("Email"));
+      Assert.AreEqual<string>("Jeremy", target.Attributes.GetValue("Name"));
       Assert.AreEqual<string>("[email protected]", target.Attributes.GetValue("AlternateEmail"));
       Assert.AreEqual<string>("[email protected]", target.Attributes.GetValue("BillingContactEmail"));
 

OnTopic/Mapping/BindingModelValidator.cs

@@ -87,10 +87,12 @@ static internal class BindingModelValidator {
     /// <param name="contentTypeDescriptor">
     ///   The <see cref="ContentTypeDescriptor"/> object against which to validate the model.
     /// </param>
+    /// <param name="attributePrefix">The prefix to apply to the attributes.</param>
     static internal void ValidateModel(
       [AllowNull]Type sourceType,
       [AllowNull]MemberInfoCollection<PropertyInfo> properties,
-      [AllowNull]ContentTypeDescriptor contentTypeDescriptor
+      [AllowNull]ContentTypeDescriptor contentTypeDescriptor,
+      [AllowNull]string attributePrefix = ""
       ) {
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -111,7 +113,7 @@ [AllowNull]ContentTypeDescriptor contentTypeDescriptor
       | Validate
       \-----------------------------------------------------------------------------------------------------------------------*/
       foreach (var property in properties) {
-        ValidateProperty(sourceType, property, contentTypeDescriptor);
+        ValidateProperty(sourceType, property, contentTypeDescriptor, attributePrefix);
       }
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -139,10 +141,12 @@ [AllowNull]ContentTypeDescriptor contentTypeDescriptor
     /// <param name="contentTypeDescriptor">
     ///   The <see cref="ContentTypeDescriptor"/> object against which to validate the model.
     /// </param>
+    /// <param name="attributePrefix">The prefix to apply to the attributes.</param>
     static internal void ValidateProperty(
       [AllowNull]Type sourceType,
       [AllowNull]PropertyInfo property,
-      [AllowNull]ContentTypeDescriptor contentTypeDescriptor
+      [AllowNull]ContentTypeDescriptor contentTypeDescriptor,
+      [AllowNull]string attributePrefix = ""
     ) {
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -156,7 +160,7 @@ [AllowNull]ContentTypeDescriptor contentTypeDescriptor
       | Define variables
       \-----------------------------------------------------------------------------------------------------------------------*/
       var propertyType          = property.PropertyType;
-      var configuration         = new PropertyConfiguration(property);
+      var configuration         = new PropertyConfiguration(property, attributePrefix);
       var compositeAttributeKey = configuration.AttributeKey;
       var attributeDescriptor   = contentTypeDescriptor.AttributeDescriptors.GetTopic(compositeAttributeKey);
       var childRelationships    = new[] { RelationshipType.Children, RelationshipType.NestedTopics };
@@ -178,7 +182,8 @@ [AllowNull]ContentTypeDescriptor contentTypeDescriptor
         ValidateModel(
           propertyType,
           childProperties,
-          contentTypeDescriptor
+          contentTypeDescriptor,
+          configuration.AttributePrefix
         );
         return;
       }
@@ -219,9 +224,9 @@ [AllowNull]ContentTypeDescriptor contentTypeDescriptor
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (attributeDescriptor == null) {
         throw new InvalidOperationException(
-          $"A {nameof(sourceType)} object was provided with a content type set to {contentTypeDescriptor.Key}'. This " +
+          $"A '{nameof(sourceType)}' object was provided with a content type set to '{contentTypeDescriptor.Key}'. This " +
           $"content type does not contain an attribute named '{compositeAttributeKey}', as requested by the " +
-          $"{configuration.Property.Name} property. If this property is not intended to be mapped by the " +
+          $"'{configuration.Property.Name}' property. If this property is not intended to be mapped by the " +
           $"{nameof(ReverseTopicMappingService)}, then it should be decorated with {nameof(DisableMappingAttribute)}."
         );
       }
@@ -242,12 +247,12 @@ [AllowNull]ContentTypeDescriptor contentTypeDescriptor
         listType != null
       ) {
         throw new InvalidOperationException(
-          $"The {property.Name} on the {sourceType.Name} has been determined to be a {configuration.RelationshipType}, but " +
-          $"the generic type {listType.Name} does not implement the {nameof(ITopicBindingModel)} interface. This is " +
-          $"required for binding models. If this collection is not intended to be mapped to " +
-          $"{ModelType.NestedTopic} then update the definition in the associated {nameof(ContentTypeDescriptor)}. If this " +
-          $"collection is not intended to be mapped at all, include the {nameof(DisableMappingAttribute)} to exclude it from " +
-          $"mapping."
+          $"The '{property.Name}' property on the '{sourceType.Name}' class has been determined to be a " +
+          $"{configuration.RelationshipType}, but the generic type '{listType.Name}' does not implement the " +
+          $"{nameof(ITopicBindingModel)} interface. This is required for binding models. If this collection is not intended " +
+          $"to be mapped as a {ModelType.NestedTopic} then update the definition in the associated " +
+          $"{nameof(ContentTypeDescriptor)}. If this collection is not intended to be mapped at all, include the " +
+          $"{nameof(DisableMappingAttribute)} to exclude it from mapping."
         );
       }
 
@@ -259,11 +264,12 @@ [AllowNull]ContentTypeDescriptor contentTypeDescriptor
         !typeof(IRelatedTopicBindingModel).IsAssignableFrom(propertyType)
       ) {
         throw new InvalidOperationException(
-          $"The {property.Name} on the {sourceType.Name} has been determined to be a {ModelType.Reference}, but " +
-          $"the generic type {propertyType.Name} does not implement the {nameof(IRelatedTopicBindingModel)} interface. This " +
-          $"is required for references. If this property is not intended to be mapped to {ModelType.Reference} then update " +
-          $"the definition in the associated {nameof(ContentTypeDescriptor)}. If this property is not intended to be mapped " +
-          $"at all, include the {nameof(DisableMappingAttribute)} to exclude it from mapping."
+          $"The '{property.Name}' property on the '{sourceType.Name}' class has been determined to be a " +
+          $"{ModelType.Reference}, but the generic type '{propertyType.Name}' does not implement the " +
+          $"{nameof(IRelatedTopicBindingModel)} interface. This is required for references. If this property is not intended " +
+          $"to be mapped as a {ModelType.Reference} then update the definition in the associated " +
+          $"{nameof(ContentTypeDescriptor)}. If this property is not intended to be mapped at all, include the " +
+          $"{nameof(DisableMappingAttribute)} to exclude it from mapping."
         );
       }
 
@@ -275,12 +281,13 @@ [AllowNull]ContentTypeDescriptor contentTypeDescriptor
         !configuration.AttributeKey.EndsWith("Id", StringComparison.InvariantCulture)
       ) {
         throw new InvalidOperationException(
-          $"The {property.Name} on the {sourceType.Name} has been determined to be a topic reference, but the generic type " +
-          $"{compositeAttributeKey} does not end in <c>Id</c>. By convention, all topic reference are expected to end " +
-          $"in <c>Id</c>. To keep the property name set to {propertyType.Name}, use the {nameof(AttributeKeyAttribute)} to " +
-          $"specify the name of the topic reference this should map to. If this property is not intended to be mapped at " +
-          $"all, include the {nameof(DisableMappingAttribute)}. If the {contentTypeDescriptor.Key} defines a topic reference " +
-          $"attribute that doesn't follow this convention, then it should be updated."
+          $"The '{property.Name}' property on the '{sourceType.Name}' class has been determined to be a topic reference, but " +
+          $"the generic type '{compositeAttributeKey}' does not end in <c>Id</c>. By convention, all topic reference are " +
+          $"expected to end in <c>Id</c>. To keep the property name set to '{propertyType.Name}', use the " +
+          $"{nameof(AttributeKeyAttribute)} to specify the name of the topic reference this should map to. If this property " +
+          $"is not intended to be mapped at all, include the {nameof(DisableMappingAttribute)}. If the " +
+          $"'{contentTypeDescriptor.Key}' defines a topic reference attribute that doesn't follow this convention, then it " +
+          $"should be updated."
         );
       }
 
@@ -328,8 +335,9 @@ [AllowNull]Type                      listType
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (!typeof(IList).IsAssignableFrom(property.PropertyType)) {
         throw new InvalidOperationException(
-          $"The {property.Name} on the {sourceType.Name} maps to a relationship attribute {attributeDescriptor.Key}, but does" +
-          $"not implement {nameof(IList)}. Relationships must implement {nameof(IList)} or derive from a collection that does."
+          $"The '{property.Name}' property on the '{sourceType.Name}' class maps to a relationship attribute " +
+          $"'{attributeDescriptor.Key}', but does not implement {nameof(IList)}. Relationships must implement " +
+          $"{nameof(IList)} or derive from a collection that does."
         );
       }
 
@@ -338,9 +346,9 @@ [AllowNull]Type                      listType
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (!new[] { RelationshipType.Any, RelationshipType.Relationship }.Contains(configuration.RelationshipType)) {
         throw new InvalidOperationException(
-          $"The {property.Name} on the {sourceType.Name} maps to a relationship attribute {attributeDescriptor.Key}, but is " +
-          $"configured as a {configuration.RelationshipType}. The property should be flagged as either " +
-          $"{nameof(RelationshipType.Any)} or {nameof(RelationshipType.Relationship)}."
+          $"The '{property.Name}' property on the '{sourceType.Name}' class maps to a relationship attribute " +
+          $"'{attributeDescriptor.Key}', but is configured as a {configuration.RelationshipType}. The property should be " +
+          $"flagged as either {nameof(RelationshipType.Any)} or {nameof(RelationshipType.Relationship)}."
         );
       }
 
@@ -349,11 +357,12 @@ [AllowNull]Type                      listType
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (!typeof(IRelatedTopicBindingModel).IsAssignableFrom(listType)) {
         throw new InvalidOperationException(
-          $"The {property.Name} on the {sourceType.Name} has been determined to be a {configuration.RelationshipType}, but " +
-          $"the generic type {listType.Name} does not implement the {nameof(IRelatedTopicBindingModel)} interface. This is " +
-          $"required for binding models. If this collection is not intended to be mapped to {configuration.RelationshipType} " +
-          $"then update the definition in the associated {nameof(ContentTypeDescriptor)}. If this collection is not intended " +
-          $"to be mapped at all, include the {nameof(DisableMappingAttribute)} to exclude it from mapping."
+          $"The '{property.Name}' property on the '{sourceType.Name}' class has been determined to be a " +
+          $"{configuration.RelationshipType}, but the generic type '{listType?.Name}' does not implement the " +
+          $"{nameof(IRelatedTopicBindingModel)} interface. This is required for binding models. If this collection is not " +
+          $"intended to be mapped as a {configuration.RelationshipType} then update the definition in the associated " +
+          $"{nameof(ContentTypeDescriptor)}. If this collection is not intended to be mapped at all, include the " +
+          $"{nameof(DisableMappingAttribute)} to exclude it from mapping."
         );
       }
 

OnTopic/Mapping/Reverse/ReverseTopicMappingService.cs

@@ -213,7 +213,7 @@ public ReverseTopicMappingService(ITopicRepository topicRepository) {
       var properties = _typeCache.GetMembers<PropertyInfo>(source.GetType());
       var contentTypeDescriptor = _contentTypeDescriptors.GetTopic(target.ContentType);
 
-      BindingModelValidator.ValidateModel(source.GetType(), properties, contentTypeDescriptor);
+      BindingModelValidator.ValidateModel(source.GetType(), properties, contentTypeDescriptor, attributePrefix);
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Loop through properties, mapping each one
@@ -608,7 +608,7 @@ TopicCollection           targetList
         var topicTask = await Task.WhenAny(taskQueue).ConfigureAwait(false);
         taskQueue.Remove(topicTask);
         var topic = await topicTask.ConfigureAwait(false);
-        if (!targetList.Contains(topic.Key)) {
+        if (topic != null && !targetList.Contains(topic.Key)) {
           targetList.Add(topic);
         }
       }