Merge pull request PHOENIXCONTACT#837 from PHOENIXCONTACT/refactor/remove-iproductpartlink

Removed IProductPartLink

Author: dbeuchler

docs/articles/module-products/ProductDefinition.md

@@ -12,7 +12,7 @@ The level 1 product group definition is done by creating a class used to represe
 
 ## Product Parts
 
-In most cases it makes sense to model complex products as compositions of parts instead of one huge product. Those references to products are not represented as simple properties but with an explicit link object. This structure of [IProductPartLink](/src/Moryx.AbstractionLayer/Products/IProductPartLink.cs) was created because in many cases the reference carriers attributes of its own that are neither part of the product nor its part but rather define the relationship between them. For example a watch could have two or three needles that each indicate a respective part of the time (hours, minutes, seconds, stopwatch). The role of each needle could be a part of the needle product definition, but then it would not be possible to use a certain needle for seconds on one watch and for a stopwatch on another one. Furthermore if you think of the watch needle as an isolated product, its attributes rather include size, color and shape - but not its role in a watch. To define custom attributes for relationships between products a class derived from [ProductPartLink<TProduct>](/src/Moryx.AbstractionLayer/Products/ProductPartLink.cs) must be created and used within the product.
+In most cases it makes sense to model complex products as compositions of parts instead of one huge product. Those references to products are not represented as simple properties but with an explicit link object. This structure of [ProductPartLink](/src/Moryx.AbstractionLayer/Products/ProductPartLink.cs) was created because in many cases the reference carriers attributes of its own that are neither part of the product nor its part but rather define the relationship between them. For example a watch could have two or three needles that each indicate a respective part of the time (hours, minutes, seconds, stopwatch). The role of each needle could be a part of the needle product definition, but then it would not be possible to use a certain needle for seconds on one watch and for a stopwatch on another one. Furthermore if you think of the watch needle as an isolated product, its attributes rather include size, color and shape - but not its role in a watch. To define custom attributes for relationships between products a class derived from [ProductPartLink<TProduct>](/src/Moryx.AbstractionLayer/Products/ProductPartLink.cs) must be created and used within the product.
 
 ## Create Instance
 

docs/articles/module-products/ProductStorage.md

@@ -76,13 +76,13 @@ The implementation of the NeedleLinkStrategy is implemented below. The `PartCrea
 ````cs
 private class NeedleLinkStrategy : LinkStrategyBase<NeedleProduct>
 {
-    public override void LoadPartLink(IGenericColumns linkEntity, IProductPartLink target)
+    public override void LoadPartLink(IGenericColumns linkEntity, ProductPartLink target)
     {
         var needleLink = (NeedlePartLink)target;
         needleLink.Role = (NeedleRole)linkEntity.Integer1;
     }
 
-    public override void SavePartLink(IProductPartLink source, IGenericColumns target)
+    public override void SavePartLink(ProductPartLink source, IGenericColumns target)
     {
         var needleLink = (NeedlePartLink)source;
         target.Integer1 = (int)needleLink.Role;

docs/migrations/v8_to_v10.md

@@ -36,6 +36,7 @@ Several interfaces have been removed to streamline the codebase and reduce compl
 
 - `IProductType`: Replaced with base-class `ProductType`
 - `IProductInstance`: Replaced with base-class `ProductInstance`
+- `IProductPartLink`: Replaced with base-class `ProductPartLink`
 - `IConfig`: Replaced with base-class `ConfigBase`
 - `IDatabaseConfig`: Replaced with base-class `DatabaseConfig`
 

src/Moryx.AbstractionLayer.Products.Endpoints/PartialSerialization.cs

@@ -48,8 +48,8 @@ protected bool SimpleProp(PropertyInfo prop)
             // Skip reference or domain model properties
             var type = prop.PropertyType;
             if (typeof(ProductType).IsAssignableFrom(type) ||
-                typeof(IProductPartLink).IsAssignableFrom(type) ||
-                typeof(IEnumerable<IProductPartLink>).IsAssignableFrom(type))
+                typeof(ProductPartLink).IsAssignableFrom(type) ||
+                typeof(IEnumerable<ProductPartLink>).IsAssignableFrom(type))
                 return false;
 
             // Filter default properties

src/Moryx.AbstractionLayer.Products.Endpoints/ProductConverter.cs

@@ -97,9 +97,9 @@ private void ConvertParts(ProductType productType, IEnumerable<PropertyInfo> pro
             {
                 var displayName = property.GetDisplayName();
 
-                if (typeof(IProductPartLink).IsAssignableFrom(property.PropertyType))
+                if (typeof(ProductPartLink).IsAssignableFrom(property.PropertyType))
                 {
-                    var link = (IProductPartLink)property.GetValue(productType);
+                    var link = (ProductPartLink)property.GetValue(productType);
                     var partModel = ConvertPart(link);
                     var connector = new PartConnector
                     {
@@ -111,9 +111,9 @@ private void ConvertParts(ProductType productType, IEnumerable<PropertyInfo> pro
                     };
                     connectors.Add(connector);
                 }
-                else if (typeof(IEnumerable<IProductPartLink>).IsAssignableFrom(property.PropertyType))
+                else if (typeof(IEnumerable<ProductPartLink>).IsAssignableFrom(property.PropertyType))
                 {
-                    var links = (IEnumerable<IProductPartLink>)property.GetValue(productType);
+                    var links = (IEnumerable<ProductPartLink>)property.GetValue(productType);
                     var linkType = property.PropertyType.GetGenericArguments()[0];
                     var connector = new PartConnector
                     {
@@ -132,12 +132,31 @@ private void ConvertParts(ProductType productType, IEnumerable<PropertyInfo> pro
 
         private static string FetchProductType(Type linkType)
         {
-            var partLinkInterface = linkType.GetInterfaces().First(i => i.IsGenericType && i.GetGenericTypeDefinition() == typeof(IProductPartLink<>));
-            var prodType = partLinkInterface.GetGenericArguments()[0];
+            var partLinkBase = FindGenericBaseDefinition(linkType, typeof(ProductPartLink<>));
+            if (partLinkBase == null)
+            {
+                throw new InvalidOperationException($"Cannot find product type for {linkType.FullName}");
+            }
+
+            var prodType = partLinkBase.GetGenericArguments()[0];
             return prodType.FullName;
         }
 
-        private PartModel ConvertPart(IProductPartLink link)
+        private static Type FindGenericBaseDefinition(Type type, Type genericDefinition)
+        {
+            var current = type;
+            while (current != null && current != typeof(object))
+            {
+                if (current.IsGenericType && current.GetGenericTypeDefinition() == genericDefinition)
+                    return current;
+
+                current = current.BaseType;
+            }
+
+            return null;
+        }
+
+        private PartModel ConvertPart(ProductPartLink link)
         {
             // No link, no DTO!
             if (link is null || link.Product is null)
@@ -222,7 +241,7 @@ public ProductType ConvertProductBack(ProductModel source, ProductType converted
                         value = Activator.CreateInstance(prop.PropertyType);
                         prop.SetValue(converted, value);
                     }
-                    UpdateReference((IProductPartLink)value, partConnector.Parts[0]);
+                    UpdateReference((ProductPartLink)value, partConnector.Parts[0]);
                 }
                 else if (partConnector.Parts.Length == 0)
                 {
@@ -236,7 +255,7 @@ public ProductType ConvertProductBack(ProductModel source, ProductType converted
         private void UpdateCollection(IList value, IEnumerable<PartModel> parts)
         {
             // Track which part links are still represented by the models
-            var oldParts = new List<IProductPartLink>(value.OfType<IProductPartLink>());
+            var oldParts = new List<ProductPartLink>(value.OfType<ProductPartLink>());
             // Iterate over the part models
             // Create or update the part links
             var elemType = value.GetType().GetInterfaces()
@@ -251,7 +270,7 @@ private void UpdateCollection(IList value, IEnumerable<PartModel> parts)
                 // new partlink
                 if (oldPartMatch == null)
                 {
-                    oldPartMatch = (IProductPartLink)Activator.CreateInstance(elemType);
+                    oldPartMatch = (ProductPartLink)Activator.CreateInstance(elemType);
                     oldPartMatch.Product = _productManagement.LoadType(partModel.Product.Id);
                     value.Add(oldPartMatch);
                 }
@@ -270,7 +289,7 @@ private void UpdateCollection(IList value, IEnumerable<PartModel> parts)
                 value.Remove(part);
         }
 
-        private void UpdateReference(IProductPartLink value, PartModel part)
+        private void UpdateReference(ProductPartLink value, PartModel part)
         {
             EntryConvert.UpdateInstance(value, part.Properties);
             value.Product = part.Product is null ? null : _productManagement.LoadType(part.Product.Id);

src/Moryx.AbstractionLayer/Processes/ProcessBindingResolverFactory.cs

@@ -63,15 +63,15 @@ protected override IBindingResolverChain AddToChain(IBindingResolverChain resolv
     }
 
     /// <summary>
-    /// Special resolver that can detect <see cref="IProductPartLink{T}"/> and skip the additional reference to
-    /// <see cref="IProductPartLink{T}.Product"/>.
+    /// Special resolver that can detect <see cref="ProductPartLink{T}"/> and skip the additional reference to
+    /// <see cref="ProductPartLink{T}.Product"/>.
     /// </summary>
     public class PartLinkShortCut : BindingResolverBase
     {
         /// <inheritdoc />
         protected override object Resolve(object source)
         {
-            if (!(source is IProductPartLink partLink))
+            if (!(source is ProductPartLink partLink))
             {
                 // Our object is not a part link, so we leave the chain
                 this.Remove();

src/Moryx.AbstractionLayer/Products/IProductPartLink.cs

@@ -3,35 +3,6 @@
 
 namespace Moryx.AbstractionLayer.Products
 {
-    /// <summary>
-    /// Base interface for the link
-    /// </summary>
-    public interface IProductPartLink : IPersistentObject
-    {
-        /// <summary>
-        /// Generic access to the product of this part link
-        /// </summary>
-        ProductType Product { get; set; }
-
-        /// <summary>
-        /// Create single product instance for this part
-        /// </summary>
-        ProductInstance Instantiate();
-    }
-
-    /// <summary>
-    /// API for part wrapper
-    /// </summary>
-    /// <typeparam name="TProduct"></typeparam>
-    public interface IProductPartLink<TProduct> : IProductPartLink
-        where TProduct : ProductType
-    {
-        /// <summary>
-        /// Typed product of this part
-        /// </summary>
-        new TProduct Product { get; set; }
-    }
-
     /// <summary>
     /// Extension to instantiate instance collection from product type parts collection
     /// </summary>
@@ -40,7 +11,7 @@ public static class PartLinkExtension
         /// <summary>
         /// Instantiate product instance collection
         /// </summary>
-        public static List<TInstance> Instantiate<TInstance>(this IEnumerable<IProductPartLink> parts)
+        public static List<TInstance> Instantiate<TInstance>(this IEnumerable<ProductPartLink> parts)
             where TInstance : ProductInstance
         {
             return parts.Select(p => (TInstance)p.Instantiate()).ToList();

src/Moryx.AbstractionLayer/Products/ProductInstance.cs

@@ -29,7 +29,7 @@ public abstract class ProductInstance : IPersistentObject
         /// <summary>
         /// Part link that created this <see cref="ProductInstance"/>. This is <value>null</value> for root instances
         /// </summary>
-        public IProductPartLink PartLink { get; set; }
+        public ProductPartLink PartLink { get; set; }
     }
 
     /// <summary>

src/Moryx.AbstractionLayer/Products/ProductPartLink.cs

@@ -6,7 +6,7 @@ namespace Moryx.AbstractionLayer.Products
     /// <summary>
     /// Base class that allows to assign a value to <see cref="IPersistentObject.Id"/>
     /// </summary>
-    public abstract class ProductPartLink : IProductPartLink
+    public abstract class ProductPartLink : IPersistentObject
     {
         /// <summary>
         /// Default constructor for a new part link
@@ -53,7 +53,7 @@ public virtual ProductInstance Instantiate()
     /// <summary>
     /// Class to create generic part structure
     /// </summary>
-    public class ProductPartLink<TProduct> : ProductPartLink, IProductPartLink<TProduct>
+    public class ProductPartLink<TProduct> : ProductPartLink
         where TProduct : ProductType
     {
         /// <summary>

src/Moryx.AbstractionLayer/Products/ProductTypeWrapper.cs

@@ -10,19 +10,19 @@ public class ProductTypeWrapper
         public string Identifier { get; private set; }
         public Func<ProductType> Constructor { get; private set; }
 
-        public Dictionary<string, Func<IProductPartLink>> PartLinkConstructors { get; private set; }
+        public Dictionary<string, Func<ProductPartLink>> PartLinkConstructors { get; private set; }
 
         public List<PropertyInfo> Properties { get; private set; }
 
         public IEnumerable<PropertyInfo> PartLinks { get; private set; }
 
-        public ProductTypeWrapper(string identifier, Func<ProductType> constructor, Dictionary<string, Func<IProductPartLink>> partLinkConstructors, List<PropertyInfo> properties)
+        public ProductTypeWrapper(string identifier, Func<ProductType> constructor, Dictionary<string, Func<ProductPartLink>> partLinkConstructors, List<PropertyInfo> properties)
         {
             Identifier = identifier;
             Constructor = constructor;
             PartLinkConstructors = partLinkConstructors;
             Properties = properties;
-            PartLinks = properties.Where(p => typeof(IProductPartLink).IsAssignableFrom(p.PropertyType) || typeof(IEnumerable<IProductPartLink>).IsAssignableFrom(p.PropertyType));
+            PartLinks = properties.Where(p => typeof(ProductPartLink).IsAssignableFrom(p.PropertyType) || typeof(IEnumerable<ProductPartLink>).IsAssignableFrom(p.PropertyType));
         }
     }
 }