Merge pull request #528 from johelvisguzman/issue527

 Added interfaces for each repository context

Author: johelvisguzman

src/DotNetToolkit.Repository.AdoNet/Internal/DbHelper.cs renamed to src/DotNetToolkit.Repository.AdoNet/DbHelper.cs

@@ -1,10 +1,12 @@
-namespace DotNetToolkit.Repository.AdoNet.Internal
+namespace DotNetToolkit.Repository.AdoNet
 {
     using Configuration.Conventions;
     using Configuration.Logging;
     using Configuration.Logging.Internal;
     using Extensions;
     using Extensions.Internal;
+    using Internal;
+    using Queries;
     using Queries.Internal;
     using System;
     using System.Collections.Generic;
@@ -19,9 +21,9 @@ namespace DotNetToolkit.Repository.AdoNet.Internal
     using Utility;
 
     /// <summary>
-    /// Represents a database helper which contains various methods for retrieving nad manipulating data in a database.
+    /// Represents a database helper which contains various methods for retrieving and manipulating data in a database.
     /// </summary>
-    internal class DbHelper : IDisposable
+    public class DbHelper : IDisposable
     {
         #region Fields
 
@@ -30,7 +32,7 @@ internal class DbHelper : IDisposable
         private readonly string _connectionString;
         private DbConnection _connection;
         private readonly bool _ownsConnection;
-        private readonly DataAccessProviderType _providerType;
+        private readonly Internal.DataAccessProviderType _providerType;
         private readonly IRepositoryConventions _conventions;
 
         #endregion
@@ -40,7 +42,7 @@ internal class DbHelper : IDisposable
         /// <summary>
         /// Gets the provider type.
         /// </summary>
-        public DataAccessProviderType ProviderType { get { return _providerType; } }
+        internal Internal.DataAccessProviderType ProviderType { get { return _providerType; } }
 
         /// <summary>
         /// Gets the provider factory.
@@ -89,10 +91,10 @@ public DbHelper(IRepositoryConventions conventions, string nameOrConnectionStrin
             var css = GetConnectionStringSettings(nameOrConnectionString);
 
             _conventions = conventions;
-            _factory = DbProviderFactories.GetFactory(css.ProviderName);
+            _factory = Internal.DbProviderFactories.GetFactory(css.ProviderName);
             _connectionString = css.ConnectionString;
             _ownsConnection = true;
-            _providerType = DataAccessProvider.GetProviderType(css.ProviderName);
+            _providerType = Internal.DataAccessProvider.GetProviderType(css.ProviderName);
         }
 
         /// <summary>
@@ -108,10 +110,10 @@ public DbHelper(IRepositoryConventions conventions, string providerName, string
             Guard.NotEmpty(connectionString, nameof(connectionString));
 
             _conventions = conventions;
-            _factory = DbProviderFactories.GetFactory(providerName);
+            _factory = Internal.DbProviderFactories.GetFactory(providerName);
             _connectionString = connectionString;
             _ownsConnection = true;
-            _providerType = DataAccessProvider.GetProviderType(providerName);
+            _providerType = Internal.DataAccessProvider.GetProviderType(providerName);
         }
 
         /// <summary>
@@ -133,7 +135,7 @@ public DbHelper(IRepositoryConventions conventions, DbConnection existingConnect
 
             var css = GetConnectionStringSettings(existingConnection.ConnectionString);
 
-            _providerType = DataAccessProvider.GetProviderType(css.ProviderName);
+            _providerType = Internal.DataAccessProvider.GetProviderType(css.ProviderName);
         }
 
         #endregion
@@ -429,7 +431,7 @@ public T ExecuteObject<T>(string cmdText, Dictionary<string, object> parameters,
         /// <param name="parameters">The command parameters.</param>
         /// <param name="projector">A function to project each entity into a new form.</param>
         /// <returns>A list which each entity has been projected into a new form.</returns>
-        public PagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, CommandType cmdType, Dictionary<string, object> parameters, Func<DbDataReader, IRepositoryConventions, T> projector)
+        public IPagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, CommandType cmdType, Dictionary<string, object> parameters, Func<DbDataReader, IRepositoryConventions, T> projector)
         {
             using (var reader = ExecuteReader(cmdText, cmdType, parameters))
             {
@@ -471,7 +473,7 @@ public PagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, CommandTy
         /// <param name="parameters">The command parameters.</param>
         /// <param name="projector">A function to project each entity into a new form.</param>
         /// <returns>A list which each entity has been projected into a new form.</returns>
-        public PagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, Dictionary<string, object> parameters, Func<DbDataReader, IRepositoryConventions, T> projector)
+        public IPagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, Dictionary<string, object> parameters, Func<DbDataReader, IRepositoryConventions, T> projector)
         {
             return ExecuteList<T>(cmdText, CommandType.Text, parameters, projector);
         }
@@ -483,7 +485,7 @@ public PagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, Dictionar
         /// <param name="cmdText">The command text.</param>
         /// <param name="parameters">The command parameters.</param>
         /// <returns>A list which each entity has been projected into a new form.</returns>
-        public PagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, Dictionary<string, object> parameters) where T : class
+        public IPagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, Dictionary<string, object> parameters) where T : class
         {
             var mapper = new Mapper<T>(_conventions);
 
@@ -498,7 +500,7 @@ public PagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, Dictionar
         /// <param name="cmdType">The command type.</param>
         /// <param name="projector">A function to project each entity into a new form.</param>
         /// <returns>A list which each entity has been projected into a new form.</returns>
-        public PagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, CommandType cmdType, Func<DbDataReader, IRepositoryConventions, T> projector)
+        public IPagedQueryResult<IEnumerable<T>> ExecuteList<T>(string cmdText, CommandType cmdType, Func<DbDataReader, IRepositoryConventions, T> projector)
         {
             return ExecuteList<T>(cmdText, cmdType, null, projector);
         }
@@ -778,7 +780,7 @@ public Dictionary<TDictionaryKey, TElement> ExecuteDictionary<TDictionaryKey, TE
         /// <param name="projector">A function to project each entity into a new form.</param>
         /// <param name="cancellationToken">A <see cref="System.Threading.CancellationToken" /> to observe while waiting for the task to complete.</param>
         /// <returns>The <see cref="System.Threading.Tasks.Task" /> that represents the asynchronous operation, containing a list which each entity has been projected into a new form.</returns>
-        public async Task<PagedQueryResult<IEnumerable<T>>> ExecuteListAsync<T>(string cmdText, CommandType cmdType, Dictionary<string, object> parameters, Func<DbDataReader, IRepositoryConventions, T> projector, CancellationToken cancellationToken = new CancellationToken())
+        public async Task<IPagedQueryResult<IEnumerable<T>>> ExecuteListAsync<T>(string cmdText, CommandType cmdType, Dictionary<string, object> parameters, Func<DbDataReader, IRepositoryConventions, T> projector, CancellationToken cancellationToken = new CancellationToken())
         {
             using (var reader = await ExecuteReaderAsync(cmdText, cmdType, parameters, cancellationToken))
             {
@@ -821,7 +823,7 @@ public Dictionary<TDictionaryKey, TElement> ExecuteDictionary<TDictionaryKey, TE
         /// <param name="projector">A function to project each entity into a new form.</param>
         /// <param name="cancellationToken">A <see cref="System.Threading.CancellationToken" /> to observe while waiting for the task to complete.</param>
         /// <returns>The <see cref="System.Threading.Tasks.Task" /> that represents the asynchronous operation, containing a list which each entity has been projected into a new form.</returns>
-        public Task<PagedQueryResult<IEnumerable<T>>> ExecuteListAsync<T>(string cmdText, Dictionary<string, object> parameters, Func<DbDataReader, IRepositoryConventions, T> projector, CancellationToken cancellationToken = new CancellationToken())
+        public Task<IPagedQueryResult<IEnumerable<T>>> ExecuteListAsync<T>(string cmdText, Dictionary<string, object> parameters, Func<DbDataReader, IRepositoryConventions, T> projector, CancellationToken cancellationToken = new CancellationToken())
         {
             return ExecuteListAsync<T>(cmdText, CommandType.Text, parameters, projector, cancellationToken);
         }
@@ -834,7 +836,7 @@ public Dictionary<TDictionaryKey, TElement> ExecuteDictionary<TDictionaryKey, TE
         /// <param name="parameters">The command parameters.</param>
         /// <param name="cancellationToken">A <see cref="System.Threading.CancellationToken" /> to observe while waiting for the task to complete.</param>
         /// <returns>The <see cref="System.Threading.Tasks.Task" /> that represents the asynchronous operation, containing a list which each entity has been projected into a new form.</returns>
-        public Task<PagedQueryResult<IEnumerable<T>>> ExecuteListAsync<T>(string cmdText, Dictionary<string, object> parameters, CancellationToken cancellationToken = new CancellationToken()) where T : class
+        public Task<IPagedQueryResult<IEnumerable<T>>> ExecuteListAsync<T>(string cmdText, Dictionary<string, object> parameters, CancellationToken cancellationToken = new CancellationToken()) where T : class
         {
             var mapper = new Mapper<T>(_conventions);
 
@@ -868,11 +870,17 @@ public Dictionary<TDictionaryKey, TElement> ExecuteDictionary<TDictionaryKey, TE
             }
         }
 
+        /// <summary>
+        /// Maps the specified string sql data type value to <see cref="System.Type" />.
+        /// </summary>
         public static Type MapToType(string sqlDataType)
         {
             return MapToType(MapToSqlDbType(sqlDataType));
         }
 
+        /// <summary>
+        /// Maps the specified type to <see cref="System.Data.SqlDbType" />.
+        /// </summary>
         public static SqlDbType MapToSqlDbType(Type type)
         {
             var typeMap = new Dictionary<Type, SqlDbType>

src/DotNetToolkit.Repository.AdoNet/IAdoNetRepositoryContext.cs

@@ -0,0 +1,16 @@
+namespace DotNetToolkit.Repository.AdoNet
+{
+    using Configuration;
+
+    /// <summary>
+    /// Represents an ado.net repository context.
+    /// </summary>
+    /// <seealso cref="IRepositoryContextAsync" />
+    public interface IAdoNetRepositoryContext : IRepositoryContextAsync
+    {
+        /// <summary>
+        /// Gets the database helper which contains various methods for retrieving and manipulating data in a database.
+        /// </summary>
+        DbHelper DbHelper { get; }
+    }
+}

src/DotNetToolkit.Repository.AdoNet/Internal/AdoNetRepositoryContext.cs

@@ -1,6 +1,5 @@
 namespace DotNetToolkit.Repository.AdoNet.Internal
 {
-    using Configuration;
     using Configuration.Conventions;
     using Configuration.Logging;
     using Configuration.Logging.Internal;
@@ -25,10 +24,10 @@
     using Utility;
 
     /// <summary>
-    /// Represents an internal ado.net repository context.
+    /// An implementation of <see cref="IAdoNetRepositoryContext" />.
     /// </summary>
-    /// <seealso cref="IRepositoryContextAsync" />
-    internal class AdoNetRepositoryContext : IRepositoryContextAsync
+    /// <seealso cref="IAdoNetRepositoryContext" />
+    internal class AdoNetRepositoryContext : IAdoNetRepositoryContext
     {
         #region Fields
 
@@ -130,6 +129,15 @@ public AdoNetRepositoryContext(DbConnection existingConnection, bool ensureDatab
 
         #endregion
 
+        #region Implementation of IAdoNetRepositoryContext
+
+        /// <summary>
+        /// Gets the database helper which contains various methods for retrieving and manipulating data in a database.
+        /// </summary>
+        public DbHelper DbHelper { get { return _dbHelper; } }
+
+        #endregion
+
         #region Private Methods
 
         private void PrepareEntitySetQuery(EntitySet entitySet, bool existInDb, out string sql, out Dictionary<string, object> parameters)

src/DotNetToolkit.Repository.EntityFramework/IEfRepositoryContext.cs

@@ -0,0 +1,17 @@
+namespace DotNetToolkit.Repository.EntityFramework
+{
+    using Configuration;
+    using System.Data.Entity;
+
+    /// <summary>
+    /// Represents a entity framework repository context.
+    /// </summary>
+    /// <seealso cref="IRepositoryContextAsync" />
+    public interface IEfRepositoryContext : IRepositoryContextAsync
+    {
+        /// <summary>
+        /// Gets the underlying context.
+        /// </summary>
+        DbContext UnderlyingContext { get; }
+    }
+}

src/DotNetToolkit.Repository.EntityFramework/Internal/EfRepositoryContext.cs

@@ -17,10 +17,10 @@
     using Utility;
 
     /// <summary>
-    /// Represents an internal entity framework repository context.
+    /// An implementation of <see cref="IEfRepositoryContext" />.
     /// </summary>
-    /// <seealso cref="IRepositoryContextAsync" />
-    internal class EfRepositoryContext : LinqRepositoryContextBaseAsync
+    /// <seealso cref="IEfRepositoryContext" />
+    internal class EfRepositoryContext : LinqRepositoryContextBaseAsync, IEfRepositoryContext
     {
         #region Fields
 
@@ -44,6 +44,15 @@ public EfRepositoryContext(DbContext context)
 
         #endregion
 
+        #region Implementation of IEfRepositoryContext
+
+        /// <summary>
+        /// Gets the underlying context.
+        /// </summary>
+        public DbContext UnderlyingContext { get { return _context; } }
+
+        #endregion
+
         #region Implementation of IRepositoryContext
 
         /// <summary>

src/DotNetToolkit.Repository.EntityFrameworkCore/IEfCoreRepositoryContext.cs

@@ -0,0 +1,17 @@
+namespace DotNetToolkit.Repository.EntityFrameworkCore
+{
+    using Configuration;
+    using Microsoft.EntityFrameworkCore;
+
+    /// <summary>
+    /// Represents a entity framework repository context.
+    /// </summary>
+    /// <seealso cref="IRepositoryContextAsync" />
+    public interface IEfCoreRepositoryContext : IRepositoryContextAsync
+    {
+        /// <summary>
+        /// Gets the underlying context.
+        /// </summary>
+        DbContext UnderlyingContext { get; }
+    }
+}

src/DotNetToolkit.Repository.EntityFrameworkCore/Internal/EfCoreRepositoryContext.cs

@@ -17,10 +17,10 @@
     using Utility;
 
     /// <summary>
-    /// Represents an internal entity framework core repository context.
+    /// An implementation of <see cref="IEfCoreRepositoryContext" />.
     /// </summary>
-    /// <seealso cref="IRepositoryContextAsync" />
-    internal class EfCoreRepositoryContext : LinqRepositoryContextBaseAsync
+    /// <seealso cref="IEfCoreRepositoryContext" />
+    internal class EfCoreRepositoryContext : LinqRepositoryContextBaseAsync, IEfCoreRepositoryContext
     {
         #region Fields
 
@@ -44,6 +44,15 @@ public EfCoreRepositoryContext(DbContext context)
 
         #endregion
 
+        #region Implementation of IEfCoreRepositoryContext
+
+        /// <summary>
+        /// Gets the underlying context.
+        /// </summary>
+        public DbContext UnderlyingContext { get { return _context; } }
+
+        #endregion
+
         #region Implementation of IRepositoryContext
 
         /// <summary>

src/DotNetToolkit.Repository.InMemory/IInMemoryRepositoryContext.cs

@@ -0,0 +1,21 @@
+namespace DotNetToolkit.Repository.InMemory
+{
+    using Configuration;
+
+    /// <summary>
+    /// Represents an internal repository context for in-memory operations (for testing purposes).
+    /// </summary>
+    /// <seealso cref="IRepositoryContext" />
+    public interface IInMemoryRepositoryContext : IRepositoryContext
+    {
+        /// <summary>
+        /// Gets or sets the name of the database.
+        /// </summary>
+        string DatabaseName { get; set; }
+
+        /// <summary>
+        /// Ensures the in-memory store is completely deleted.
+        /// </summary>
+        void EnsureDeleted();
+    }
+}