Retrofitted ReverseTopicMappingService to use new PropertyConfiguration

In #8bb6ab4, `PropertyConfiguration` was updated to be made aware of the contextual `AttributePrefix`, thus allowing the `attributePrefix` to be relayed (and composited) via the `PropertyConfiguration` instead of by passing it to each helper method, and then prepending it to every call to `configuration.AttributeKey`. This is much more elegant, and more intuitive from an implementation perspective. This doesn't change the functionality, just refactors the implementation so that the `attributePrefix` is more deeply integrated into the infrastructure—which, conveniently, makes it so that most downstream elements no longer need to be aware of the `attributePrefix`. As an example of this, we were able to remove `attributePrefix` entirely from the `BindingModelValidator` since it now infers it via the `PropertyConfiguration.AttributeKey`.

Author: JeremyCaney

OnTopic/Mapping/BindingModelValidator.cs

@@ -87,12 +87,10 @@ static internal class BindingModelValidator {
     /// <param name="contentTypeDescriptor">
     ///   The <see cref="ContentTypeDescriptor"/> object against which to validate the model.
     /// </param>
-    /// <param name="attributePrefix">The optional prefix to apply to the attributes.</param>
     static internal void ValidateModel(
       [AllowNull]Type sourceType,
       [AllowNull]MemberInfoCollection<PropertyInfo> properties,
-      [AllowNull]ContentTypeDescriptor contentTypeDescriptor,
-      string? attributePrefix = null
+      [AllowNull]ContentTypeDescriptor contentTypeDescriptor
       ) {
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -113,7 +111,7 @@ static internal void ValidateModel(
       | Validate
       \-----------------------------------------------------------------------------------------------------------------------*/
       foreach (var property in properties) {
-        ValidateProperty(sourceType, property, contentTypeDescriptor, attributePrefix);
+        ValidateProperty(sourceType, property, contentTypeDescriptor);
       }
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -141,12 +139,10 @@ static internal void ValidateModel(
     /// <param name="contentTypeDescriptor">
     ///   The <see cref="ContentTypeDescriptor"/> object against which to validate the model.
     /// </param>
-    /// <param name="attributePrefix">The optional prefix to apply to the attributes.</param>
     static internal void ValidateProperty(
       [AllowNull]Type sourceType,
       [AllowNull]PropertyInfo property,
-      [AllowNull]ContentTypeDescriptor contentTypeDescriptor,
-      string? attributePrefix
+      [AllowNull]ContentTypeDescriptor contentTypeDescriptor
     ) {
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -161,7 +157,7 @@ static internal void ValidateProperty(
       \-----------------------------------------------------------------------------------------------------------------------*/
       var propertyType          = property.PropertyType;
       var configuration         = new PropertyConfiguration(property);
-      var compositeAttributeKey = attributePrefix + configuration.AttributeKey;
+      var compositeAttributeKey = configuration.AttributeKey;
       var attributeDescriptor   = contentTypeDescriptor.AttributeDescriptors.GetTopic(compositeAttributeKey);
       var childRelationships    = new[] { RelationshipType.Children, RelationshipType.NestedTopics };
       var relationships         = new[] { RelationshipType.Relationship, RelationshipType.IncomingRelationship };
@@ -182,8 +178,7 @@ static internal void ValidateProperty(
         ValidateModel(
           propertyType,
           childProperties,
-          contentTypeDescriptor,
-          attributePrefix + configuration.AttributePrefix
+          contentTypeDescriptor
         );
         return;
       }

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, attributePrefix);
+      BindingModelValidator.ValidateModel(source.GetType(), properties, contentTypeDescriptor);
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Loop through properties, mapping each one
@@ -262,9 +262,9 @@ protected async Task SetPropertyAsync(
       /*------------------------------------------------------------------------------------------------------------------------
       | Establish per-property variables
       \-----------------------------------------------------------------------------------------------------------------------*/
-      var configuration         = new PropertyConfiguration(property);
+      var configuration         = new PropertyConfiguration(property, attributePrefix);
       var contentTypeDescriptor = _contentTypeDescriptors.GetTopic(target.ContentType);
-      var compositeAttributeKey = attributePrefix + configuration.AttributeKey;
+      var compositeAttributeKey = configuration.AttributeKey;
 
       Contract.Assume(contentTypeDescriptor, nameof(contentTypeDescriptor));
 
@@ -282,7 +282,7 @@ protected async Task SetPropertyAsync(
         await MapAsync(
           property.GetValue(source),
           target,
-          attributePrefix + configuration.AttributePrefix
+          configuration.AttributePrefix
         ).ConfigureAwait(false);
         return;
       }
@@ -308,16 +308,16 @@ await MapAsync(
       \-----------------------------------------------------------------------------------------------------------------------*/
       switch (attributeType.ModelType) {
         case ModelType.ScalarValue:
-          SetScalarValue(source, target, configuration, attributePrefix);
+          SetScalarValue(source, target, configuration);
           return;
         case ModelType.Relationship:
-          SetRelationships(source, target, configuration, attributePrefix);
+          SetRelationships(source, target, configuration);
           return;
         case ModelType.NestedTopic:
-          await SetNestedTopicsAsync(source, target, configuration, attributePrefix).ConfigureAwait(false);
+          await SetNestedTopicsAsync(source, target, configuration).ConfigureAwait(false);
           return;
         case ModelType.Reference:
-          SetReference(source, target, configuration, attributePrefix);
+          SetReference(source, target, configuration);
           return;
       }
 
@@ -332,7 +332,7 @@ await MapAsync(
     /// <remarks>
     ///   Assuming the <paramref name="configuration"/>'s <see cref="PropertyConfiguration.Property"/> is of the type <see
     ///   cref="String"/>, <see cref="Boolean"/>, <see cref="Int32"/>, or <see cref="DateTime"/>, the <see
-    ///   cref="SetScalarValue(Object, Topic, PropertyConfiguration, String)"/> method will attempt to set the property on the
+    ///   cref="SetScalarValue(Object, Topic, PropertyConfiguration)"/> method will attempt to set the property on the
     ///   <paramref name="target"/>. If the value is not set on the <paramref name="source"/> then the <see
     ///   cref="DefaultValueAttribute"/> will be evaluated as a fallback. If the property is not of a settable type then the
     ///   property is not set. If the value is empty, then it will be treated as <c>null</c> in the <paramref name="target"/>'s
@@ -343,13 +343,11 @@ await MapAsync(
     /// </param>
     /// <param name="target">The <see cref="Topic"/> entity to map the data to.</param>
     /// <param name="configuration">The <see cref="PropertyConfiguration"/> with details about the property's attributes.</param>
-    /// <param name="attributePrefix">The prefix to apply to the attributes.</param>
     /// <autogeneratedoc />
     protected static void SetScalarValue(
       object                    source,
       Topic                     target,
-      PropertyConfiguration     configuration,
-      string?                   attributePrefix                 = null
+      PropertyConfiguration     configuration
     )
     {
 
@@ -386,7 +384,7 @@ protected static void SetScalarValue(
       /*------------------------------------------------------------------------------------------------------------------------
       | Set the value (to null, if appropriate)
       \-----------------------------------------------------------------------------------------------------------------------*/
-      target.Attributes.SetValue(attributePrefix + configuration.AttributeKey, attributeValue);
+      target.Attributes.SetValue(configuration.AttributeKey, attributeValue);
 
     }
 
@@ -404,12 +402,10 @@ protected static void SetScalarValue(
     /// <param name="configuration">
     ///   The <see cref="PropertyConfiguration"/> with details about the property's attributes.
     /// </param>
-    /// <param name="attributePrefix">The prefix to apply to the attributes.</param>
     protected void SetRelationships(
       object                    source,
       Topic                     target,
-      PropertyConfiguration     configuration,
-      string?                   attributePrefix                 = null
+      PropertyConfiguration     configuration
     )
     {
 
@@ -432,7 +428,7 @@ protected void SetRelationships(
       /*------------------------------------------------------------------------------------------------------------------------
       | Clear existing relationships
       \-----------------------------------------------------------------------------------------------------------------------*/
-      target.Relationships.ClearTopics(attributePrefix + configuration.AttributeKey);
+      target.Relationships.ClearTopics(configuration.AttributeKey);
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Set relationships for each
@@ -446,7 +442,7 @@ protected void SetRelationships(
             $"be located in the repository."
           );
         }
-        target.Relationships.SetTopic(attributePrefix + configuration.AttributeKey, targetTopic);
+        target.Relationships.SetTopic(configuration.AttributeKey, targetTopic);
       }
 
     }
@@ -465,12 +461,10 @@ protected void SetRelationships(
     /// <param name="configuration">
     ///   The <see cref="PropertyConfiguration"/> with details about the property's attributes.
     /// </param>
-    /// <param name="attributePrefix">The prefix to apply to the attributes.</param>
     protected async Task SetNestedTopicsAsync(
       object                    source,
       Topic                     target,
-      PropertyConfiguration     configuration,
-      string?                   attributePrefix                 = null
+      PropertyConfiguration     configuration
     ) {
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -488,9 +482,9 @@ protected async Task SetNestedTopicsAsync(
       /*------------------------------------------------------------------------------------------------------------------------
       | Establish target collection to store mapped topics
       \-----------------------------------------------------------------------------------------------------------------------*/
-      var container = target.Children.GetTopic(attributePrefix + configuration.AttributeKey);
+      var container = target.Children.GetTopic(configuration.AttributeKey);
       if (container == null) {
-        container = TopicFactory.Create(attributePrefix + configuration.AttributeKey, "List", target);
+        container = TopicFactory.Create(configuration.AttributeKey, "List", target);
         container.IsHidden = true;
       }
 
@@ -515,12 +509,10 @@ protected async Task SetNestedTopicsAsync(
     /// <param name="configuration">
     ///   The <see cref="PropertyConfiguration"/> with details about the property's attributes.
     /// </param>
-    /// <param name="attributePrefix">The prefix to apply to the attributes.</param>
     protected void SetReference(
       object                    source,
       Topic                     target,
-      PropertyConfiguration     configuration,
-      string?                   attributePrefix                 = null
+      PropertyConfiguration     configuration
     ) {
 
       /*------------------------------------------------------------------------------------------------------------------------
@@ -560,7 +552,7 @@ protected void SetReference(
       /*------------------------------------------------------------------------------------------------------------------------
       | Set target attribute
       \-----------------------------------------------------------------------------------------------------------------------*/
-      target.Attributes.SetInteger(attributePrefix + configuration.AttributeKey, topicReference.Id);
+      target.Attributes.SetInteger(configuration.AttributeKey, topicReference.Id);
 
     }