Updated exception messages in BindingModelValidator

Specifically, placed quotes around (most) instance variables, and specified _property_ and _class_ instead of just injecting their names into the error message. E.g., messages now say, "The '{property}' on the '{class}' class…" as opposed to "The {property} on the {class}…".

Author: JeremyCaney

OnTopic/Mapping/BindingModelValidator.cs

@@ -224,9 +224,9 @@ static internal void ValidateProperty(
       \-----------------------------------------------------------------------------------------------------------------------*/
       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)}."
         );
       }
@@ -247,12 +247,12 @@ static internal void ValidateProperty(
         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."
         );
       }
 
@@ -264,11 +264,12 @@ static internal void ValidateProperty(
         !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."
         );
       }
 
@@ -280,12 +281,13 @@ static internal void ValidateProperty(
         !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."
         );
       }
 
@@ -333,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."
         );
       }
 
@@ -343,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)}."
         );
       }
 
@@ -354,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."
         );
       }