Merge pull request #1 from johelvisguzman/feature/spec

Introduced specification

Author: johelvisguzman

DotNetToolkit.Repository.sln

@@ -7,6 +7,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{DD273D5E-6D6
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DotNetToolkit.Repository", "src\DotNetToolkit.Repository\DotNetToolkit.Repository.csproj", "{76BC5AB7-1198-4C99-B2C3-3B734931F8EE}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{DAB3DD1E-AD99-46C9-AC42-07E2F03D5A06}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DotNetToolkit.Repository.Test", "test\DotNetToolkit.Repository.Test\DotNetToolkit.Repository.Test.csproj", "{EAE7B507-D908-4650-A301-C3341F005A51}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -17,12 +21,17 @@ Global
 		{76BC5AB7-1198-4C99-B2C3-3B734931F8EE}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{76BC5AB7-1198-4C99-B2C3-3B734931F8EE}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{76BC5AB7-1198-4C99-B2C3-3B734931F8EE}.Release|Any CPU.Build.0 = Release|Any CPU
+		{EAE7B507-D908-4650-A301-C3341F005A51}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{EAE7B507-D908-4650-A301-C3341F005A51}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{EAE7B507-D908-4650-A301-C3341F005A51}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{EAE7B507-D908-4650-A301-C3341F005A51}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{76BC5AB7-1198-4C99-B2C3-3B734931F8EE} = {DD273D5E-6D6C-41FA-A0C8-646CC53C4DC3}
+		{EAE7B507-D908-4650-A301-C3341F005A51} = {DAB3DD1E-AD99-46C9-AC42-07E2F03D5A06}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {96973E0C-81D1-42DE-9F78-7103241B4E07}

appveyor.yml

@@ -45,5 +45,11 @@ build:
 after_build:
   - dotnet pack .\src\DotNetToolkit.Repository\DotNetToolkit.Repository.csproj --configuration Release
 
+#---------------------------------#
+#       tests configuration       #
+#---------------------------------#
+test_script:
+  - dotnet test .\test\DotNetToolkit.Repository.Test\DotNetToolkit.Repository.Test.csproj --configuration Release
+  
 artifacts:
   - path: '**\DotNetToolkit.Repository.*.nupkg'     # find all NuGet packages recursively

src/DotNetToolkit.Repository/FetchStrategies/FetchStrategy.cs

@@ -0,0 +1,63 @@
+namespace DotNetToolkit.Repository.FetchStrategies
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq.Expressions;
+
+    /// <summary>
+    /// An implementation of <see cref="IFetchStrategy{T}" />.
+    /// </summary>
+    public class FetchStrategy<T> : IFetchStrategy<T>
+    {
+        #region Fields
+
+        private readonly IList<string> _properties;
+
+        #endregion
+
+        #region Constructors
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="FetchStrategy{T}" /> class.
+        /// </summary>
+        public FetchStrategy()
+        {
+            _properties = new List<string>();
+        }
+
+        #endregion
+
+        #region IFetchStrategy<T> Members
+
+        /// <summary>
+        /// Gets the collection of related objects to include in the query results.
+        /// </summary>
+        public IEnumerable<string> IncludePaths
+        {
+            get { return _properties; }
+        }
+
+        /// <summary>
+        /// Specifies the related objects to include in the query results.
+        /// </summary>
+        /// <param name="path">A lambda expression representing the path to include.</param>
+        /// <returns>A new <see cref="IFetchStrategy{T}" /> with the defined query path.</returns>
+        public IFetchStrategy<T> Include(Expression<Func<T, object>> path)
+        {
+            return Include(path.ToIncludeString());
+        }
+
+        /// <summary>
+        /// Specifies the related objects to include in the query results.
+        /// </summary>
+        /// <param name="path">The dot-separated list of related objects to return in the query results.</param>
+        /// <returns>A new <see cref="IFetchStrategy{T}" /> with the defined query path.</returns>
+        public IFetchStrategy<T> Include(string path)
+        {
+            _properties.Add(path);
+            return this;
+        }
+
+        #endregion
+    }
+}

src/DotNetToolkit.Repository/FetchStrategies/FetchStrategyExtensions.cs

@@ -0,0 +1,39 @@
+namespace DotNetToolkit.Repository.FetchStrategies
+{
+    using Helpers;
+    using System;
+    using System.Collections.Generic;
+    using System.Linq.Expressions;
+    using System.Reflection;
+    using System.Text;
+
+    // https://github.com/SharpRepository/SharpRepository/tree/master/SharpRepository.Repository/FetchStrategies/FetchStrategyExtensions.cs
+    internal static class FetchStrategyExtensions
+    {
+        /// <summary>
+        ///  Evaluates the Linq expression and returns the name of the property or the multiple level deep string representation of the Expression (i.e. prop.Collection.Property).
+        /// </summary>
+        /// <typeparam name="T">Type being evaluated</typeparam>
+        /// <param name="selector">Name of the property per the Linq expression</param>
+        /// <returns></returns>
+        public static string ToIncludeString<T>(this Expression<Func<T, object>> selector)
+        {
+            // Retrieve member path:
+            var members = new List<PropertyInfo>();
+            ExpressionHelper.CollectRelationalMembers(selector, members);
+
+            // Build string path:
+            var sb = new StringBuilder();
+            var separator = "";
+            foreach (var member in members)
+            {
+                sb.Append(separator);
+                sb.Append(member.Name);
+                separator = ".";
+            }
+
+            // return concatenated string
+            return sb.ToString();
+        }
+    }
+}

src/DotNetToolkit.Repository/FetchStrategies/IFetchStrategy.cs

@@ -0,0 +1,32 @@
+namespace DotNetToolkit.Repository.FetchStrategies
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq.Expressions;
+
+    /// <summary>
+    /// An abstraction which defines the child objects that should be retrieved when loading the entity.
+    /// </summary>
+    /// <typeparam name="T">The type of the entity.</typeparam>
+    public interface IFetchStrategy<T>
+    {
+        /// <summary>
+        /// Gets the collection of related objects to include in the query results.
+        /// </summary>
+        IEnumerable<string> IncludePaths { get; }
+
+        /// <summary>
+        /// Specifies the related objects to include in the query results.
+        /// </summary>
+        /// <param name="path">A lambda expression representing the path to include.</param>
+        /// <returns>A new <see cref="IFetchStrategy{T}" /> with the defined query path.</returns>
+        IFetchStrategy<T> Include(Expression<Func<T, object>> path);
+
+        /// <summary>
+        /// Specifies the related objects to include in the query results.
+        /// </summary>
+        /// <param name="path">The dot-separated list of related objects to return in the query results.</param>
+        /// <returns>A new <see cref="IFetchStrategy{T}" /> with the defined query path.</returns>
+        IFetchStrategy<T> Include(string path);
+    }
+}

src/DotNetToolkit.Repository/Helpers/ExpressionHelper.cs

@@ -0,0 +1,41 @@
+namespace DotNetToolkit.Repository.Helpers
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq.Expressions;
+    using System.Reflection;
+
+    // https://github.com/SharpRepository/SharpRepository/tree/master/SharpRepository.Repository/Helpers/ExpressionHelper.cs
+    internal static class ExpressionHelper
+    {
+        internal static void CollectRelationalMembers(Expression exp, IList<PropertyInfo> members)
+        {
+            switch (exp.NodeType)
+            {
+                case ExpressionType.Lambda:
+                    CollectRelationalMembers(((LambdaExpression)exp).Body, members);
+                    break;
+                case ExpressionType.MemberAccess:
+                    var mexp = (MemberExpression)exp;
+                    CollectRelationalMembers(mexp.Expression, members);
+                    members.Add((PropertyInfo)mexp.Member);
+
+                    break;
+                case ExpressionType.Call:
+                    var cexp = (MethodCallExpression)exp;
+
+                    if (cexp.Method.IsStatic == false)
+                        throw new InvalidOperationException("Invalid type of expression.");
+
+                    foreach (var arg in cexp.Arguments)
+                        CollectRelationalMembers(arg, members);
+
+                    break;
+                case ExpressionType.Parameter:
+                    return;
+                default:
+                    throw new InvalidOperationException("Invalid type of expression.");
+            }
+        }
+    }
+}

src/DotNetToolkit.Repository/IRepository.cs

@@ -7,7 +7,7 @@
     /// </summary>
     /// <typeparam name="TEntity">The type of the entity.</typeparam>
     /// <typeparam name="TKey">The type of the primary key.</typeparam>
-    public interface IRepository<TEntity, in TKey> : ICanAdd<TEntity>, ICanUpdate<TEntity>, ICanDelete<TEntity, TKey>, ICanGet<TEntity, TKey>, ICanFind<TEntity, TKey>
+    public interface IRepository<TEntity, in TKey> : ICanAdd<TEntity>, ICanUpdate<TEntity>, ICanDelete<TEntity, TKey>, ICanGet<TEntity, TKey>, ICanFind<TEntity>
         where TEntity : class
     {
     }