Introduced new GetCompositeAttributeKey() method

With the `attributePrefix` removed from the `ItemConfiguration`, the onus is on the caller to ensure that the `attributePrefix` is accounted for, if relevant. To simplify this process, I've added a simple convenience method for concatenating the full attribute key. This will be implemented in subsequent versions of `TopicMappingService` and `ReverseTopicMappingService`.

I've also updated all calls to `AttributeKey` to now call the new `GetCompositeAttributeKey()`. This effectively reinstates support for `attributePrefix`, which was broken when `ItemConfiguration` was moved to `ItemMetadata` (74cb817, 84735fb) and the mapping services were updated to rely on `ItemMetadata` instead of creating their own instances of `ItemConfiguration` (fe39302).

All unit tests related to `[MapToParent]` now pass again.

Author: JeremyCaney

OnTopic/Mapping/Internal/ItemConfiguration.cs

@@ -422,6 +422,21 @@ internal ItemConfiguration(ItemMetadata itemMetadata) {
     /// </remarks>
     internal Dictionary<string, string> AttributeFilters { get; }
 
+    /*==========================================================================================================================
+    | METHOD: GET COMPOSITE ATTRIBUTE KEY
+    \-------------------------------------------------------------------------------------------------------------------------*/
+    /// <summary>
+    ///   Retrieves the current <see cref="AttributeKey"/>, and, optionally, the supplied <paramref name="attributePrefix"/>.
+    /// </summary>
+    /// <param name="attributePrefix">
+    ///   The current mapping operation's attribute prefix to be prepended to the <see cref="AttributeKey"/>.
+    /// </param>
+    /// <returns>
+    ///   The composite attribute key, based on <see cref="AttributeKey"/> and, optionally, the supplied <paramref name="
+    ///   attributePrefix"/>.
+    /// </returns>
+    internal string GetCompositeAttributeKey(string? attributePrefix) => $"{attributePrefix}{AttributeKey}";
+
     /*==========================================================================================================================
     | METHOD: SATISFIES ATTRIBUTE FILTERS
     \-------------------------------------------------------------------------------------------------------------------------*/

OnTopic/Mapping/Reverse/BindingModelValidator.cs

@@ -147,8 +147,8 @@ static internal void ValidateProperty(
       /*------------------------------------------------------------------------------------------------------------------------
       | Define variables
       \-----------------------------------------------------------------------------------------------------------------------*/
-      var compositeAttributeKey = configuration.AttributeKey;
       var configuration         = propertyAccessor.Configuration;
+      var compositeAttributeKey = configuration.GetCompositeAttributeKey(attributePrefix);
       var attributeDescriptor   = contentTypeDescriptor.AttributeDescriptors.GetValue(compositeAttributeKey);
       var childCollections      = new[] { CollectionType.Children, CollectionType.NestedTopics };
       var relationships         = new[] { CollectionType.Relationship, CollectionType.IncomingRelationship };
@@ -208,7 +208,7 @@ static internal void ValidateProperty(
       /*------------------------------------------------------------------------------------------------------------------------
       | Handle parent
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (configuration.AttributeKey is "Parent") {
+      if (configuration.GetCompositeAttributeKey(attributePrefix) is "Parent") {
         throw new MappingModelValidationException(
           $"The {nameof(ReverseTopicMappingService)} does not support mapping Parent topics. This property should be " +
           $"removed from the binding model, or otherwise decorated with the {nameof(DisableMappingAttribute)} to prevent " +

OnTopic/Mapping/Reverse/ReverseTopicMappingService.cs

@@ -241,7 +241,7 @@ private async Task SetPropertyAsync(
       \-----------------------------------------------------------------------------------------------------------------------*/
       var configuration         = memberAccessor.Configuration;
       var contentTypeDescriptor = _contentTypeDescriptors.GetValue(target.ContentType);
-      var compositeAttributeKey = configuration.AttributeKey;
+      var compositeAttributeKey = configuration.GetCompositeAttributeKey(attributePrefix);
 
       Contract.Assume(contentTypeDescriptor, nameof(contentTypeDescriptor));
 
@@ -278,7 +278,7 @@ await MapAsync(
 
       if (attributeType is null) {
         throw new MappingModelValidationException(
-          $"The attribute '{configuration.AttributeKey}' mapped by the {source.GetType()} could not be found on the " +
+          $"The attribute '{configuration.GetCompositeAttributeKey(attributePrefix)}' mapped by the {source.GetType()} could not be found on the " +
           $"'{contentTypeDescriptor.Key}' content type.");
       }
 
@@ -362,7 +362,7 @@ private static void SetScalarValue(
       /*------------------------------------------------------------------------------------------------------------------------
       | Set the value (to null, if appropriate)
       \-----------------------------------------------------------------------------------------------------------------------*/
-      target.Attributes.SetValue(configuration.AttributeKey, attributeValue);
+      target.Attributes.SetValue(configuration.GetCompositeAttributeKey(attributePrefix), attributeValue);
 
     }
 
@@ -403,7 +403,7 @@ private void SetRelationships(
       /*------------------------------------------------------------------------------------------------------------------------
       | Clear existing relationships
       \-----------------------------------------------------------------------------------------------------------------------*/
-      target.Relationships.Clear(configuration.AttributeKey);
+      target.Relationships.Clear(configuration.GetCompositeAttributeKey(attributePrefix));
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Set relationships for each
@@ -416,7 +416,7 @@ private void SetRelationships(
             $"located in the repository."
           );
         }
-        target.Relationships.SetValue(configuration.AttributeKey, targetTopic);
+        target.Relationships.SetValue(configuration.GetCompositeAttributeKey(attributePrefix), targetTopic);
       }
 
     }
@@ -454,9 +454,9 @@ private async Task SetNestedTopicsAsync(
       /*------------------------------------------------------------------------------------------------------------------------
       | Establish target collection to store mapped topics
       \-----------------------------------------------------------------------------------------------------------------------*/
-      var container = target.Children.GetValue(configuration.AttributeKey);
+      var container = target.Children.GetValue(configuration.GetCompositeAttributeKey(attributePrefix));
       if (container is null) {
-        container = TopicFactory.Create(configuration.AttributeKey, "List", target);
+        container = TopicFactory.Create(configuration.GetCompositeAttributeKey(attributePrefix), "List", target);
         container.IsHidden = true;
       }
 
@@ -525,11 +525,11 @@ private void SetReference(
       /*------------------------------------------------------------------------------------------------------------------------
       | Set target attribute
       \-----------------------------------------------------------------------------------------------------------------------*/
-      if (configuration.AttributeKey.EndsWith("Id", StringComparison.Ordinal)) {
-        target.Attributes.SetValue(configuration.AttributeKey, topicReference?.Id.ToString(CultureInfo.InvariantCulture));
+      if (configuration.GetCompositeAttributeKey(attributePrefix).EndsWith("Id", StringComparison.Ordinal)) {
+        target.Attributes.SetValue(configuration.GetCompositeAttributeKey(attributePrefix), topicReference?.Id.ToString(CultureInfo.InvariantCulture));
       }
       else {
-        target.References.SetValue(configuration.AttributeKey, topicReference);
+        target.References.SetValue(configuration.GetCompositeAttributeKey(attributePrefix), topicReference);
       }
 
     }

OnTopic/Mapping/TopicMappingService.cs

@@ -567,7 +567,7 @@ await MapAsync(
       else if (itemMetadata.IsList) {
         return null;
       }
-      else if (configuration.AttributeKey is "Parent") {
+      else if (configuration.GetCompositeAttributeKey(attributePrefix) is "Parent") {
         if (associations.HasFlag(AssociationTypes.Parents) && source.Parent is not null) {
           value = await GetTopicReferenceAsync(source.Parent, targetType, itemMetadata, cache).ConfigureAwait(false);
         }
@@ -593,17 +593,17 @@ await MapAsync(
       Topic? getTopicReference() {
 
         // Check for standard topic reference
-        var topicReference      = source.References.GetValue(configuration.AttributeKey);
+        var topicReference      = source.References.GetValue(configuration.GetCompositeAttributeKey(attributePrefix));
         if (topicReference is not null) {
           return topicReference;
         }
 
         int topicReferenceId;
-        if (configuration.AttributeKey.EndsWith("Id", StringComparison.OrdinalIgnoreCase)) {
-          topicReferenceId    = source.Attributes.GetInteger(configuration.AttributeKey, 0);
+        if (configuration.GetCompositeAttributeKey(attributePrefix).EndsWith("Id", StringComparison.OrdinalIgnoreCase)) {
+          topicReferenceId      = source.Attributes.GetInteger(configuration.GetCompositeAttributeKey(attributePrefix), 0);
         }
         else {
-          topicReferenceId    = source.Attributes.GetInteger($"{configuration.AttributeKey}Id", 0);
+          topicReferenceId      = source.Attributes.GetInteger($"{configuration.GetCompositeAttributeKey(attributePrefix)}Id", 0);
         }
         if (topicReferenceId > 0) {
           topicReference        = _topicRepository.Load(topicReferenceId, source);
@@ -643,21 +643,21 @@ await MapAsync(
       \-----------------------------------------------------------------------------------------------------------------------*/
       var typeAccessor          = GetTopicAccessor(source.GetType());
 
-      var attributeValue        = typeAccessor.GetMethodValue(source, $"Get{configuration.AttributeKey}")?.ToString();
+      var attributeValue        = typeAccessor.GetMethodValue(source, $"Get{configuration.GetCompositeAttributeKey(attributePrefix)}")?.ToString();
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Attempt to retrieve value from topic.{Property}
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (attributeValue is null) {
-        attributeValue = typeAccessor.GetPropertyValue(source, configuration.AttributeKey)?.ToString();
+        attributeValue = typeAccessor.GetPropertyValue(source, configuration.GetCompositeAttributeKey(attributePrefix))?.ToString();
       }
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Otherwise, attempt to retrieve value from topic.Attributes.GetValue({Property})
       \-----------------------------------------------------------------------------------------------------------------------*/
       if (attributeValue is null) {
         attributeValue = source.Attributes.GetValue(
-          configuration.AttributeKey,
+          configuration.GetCompositeAttributeKey(attributePrefix),
           configuration.DefaultValue?.ToString(),
           configuration.InheritValue
         );
@@ -848,7 +848,7 @@ private IList<Topic> GetSourceCollection(
       //For example, the ContentTypeDescriptor's AttributeDescriptors collection, which provides a rollup of
       //AttributeDescriptors from the current ContentTypeDescriptor, as well as all of its ascendents.
       if (listSource.Count == 0) {
-        var sourceProperty = TypeAccessorCache.GetTypeAccessor(source.GetType()).GetMember(configuration.AttributeKey);
+        var sourceProperty = TypeAccessorCache.GetTypeAccessor(source.GetType()).GetMember(configuration.GetCompositeAttributeKey(attributePrefix));
         if (
           sourceProperty?.GetValue(source) is IList sourcePropertyValue &&
           sourcePropertyValue.Count > 0 &&
@@ -1132,7 +1132,7 @@ private static bool TryGetCompatibleProperty(Topic source, Type targetType, Item
       /*------------------------------------------------------------------------------------------------------------------------
       | Attempt to retrieve value from topic.{Property}
       \-----------------------------------------------------------------------------------------------------------------------*/
-      var sourcePropertyAccessor = GetTopicAccessor(source.GetType()).GetMember(configuration.AttributeKey);
+      var sourcePropertyAccessor = GetTopicAccessor(source.GetType()).GetMember(configuration.GetCompositeAttributeKey(attributePrefix));
 
       /*------------------------------------------------------------------------------------------------------------------------
       | Escape clause if preconditions are not met