Project Setup (Part 1)

.config/dotnet-tools.json

@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "husky": {
+      "version": "0.7.1",
+      "commands": [
+        "husky"
+      ],
+      "rollForward": false
+    }
+  }
+}

.editorconfig

@@ -30,10 +30,10 @@ dotnet_sort_system_directives_first = true
 file_header_template = unset
 
 # this. and Me. preferences
-dotnet_style_qualification_for_event = false:silent
-dotnet_style_qualification_for_field = false:silent
-dotnet_style_qualification_for_method = false:silent
-dotnet_style_qualification_for_property = false:silent
+dotnet_style_qualification_for_event = true:warning
+dotnet_style_qualification_for_field = true:warning
+dotnet_style_qualification_for_method = true:warning
+dotnet_style_qualification_for_property = true:warning
 
 # Language keywords vs BCL types preferences
 dotnet_style_predefined_type_for_locals_parameters_members = true:silent
@@ -78,9 +78,9 @@ dotnet_remove_unnecessary_suppression_exclusions = none
 [*.cs]
 
 # var preferences
-csharp_style_var_elsewhere = false:silent
-csharp_style_var_for_built_in_types = false:silent
-csharp_style_var_when_type_is_apparent = false:silent
+csharp_style_var_elsewhere = false:warning
+csharp_style_var_for_built_in_types = false:warning
+csharp_style_var_when_type_is_apparent = true:warning
 
 # Expression-bodied members
 csharp_style_expression_bodied_accessors = true:silent
@@ -174,6 +174,7 @@ csharp_style_namespace_declarations = block_scoped:silent
 csharp_style_prefer_method_group_conversion = true:silent
 csharp_style_prefer_top_level_statements = true:silent
 csharp_style_prefer_primary_constructors = true:suggestion
+csharp_prefer_system_threading_lock = true:suggestion
 
 #### Naming styles ####
 [*.{cs,vb}]

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# lint project based on editorconfig rules
+dotnet husky run --group pre-commit

.husky/pre-push

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# build project and run unit tests
+dotnet husky run --group pre-push

.husky/task-runner.json

@@ -0,0 +1,39 @@
+{
+   "$schema": "https://alirezanet.github.io/Husky.Net/schema.json",
+   "tasks": [
+      {
+         "name": "dotnet-format",
+         "group": "pre-commit",
+         "command": "dotnet",
+         "args": [
+            "format",
+            "--include",
+            "${staged}",
+            "--verbosity",
+            "diagnostic"
+         ],
+         "include": [
+            "**/*.cs",
+            "**/*.ps1"
+         ]
+      },
+      {
+         "name": "dotnet-build",
+         "group": "pre-push",
+         "command": "dotnet",
+         "args": [
+            "build",
+            "/warnaserror"
+         ]
+      },
+      {
+         "name": "dotnet-test",
+         "group": "pre-push",
+         "command": "dotnet",
+         "args": [
+            "test",
+            "--nologo"
+         ]
+      }
+   ]
+}

AdvancedSystems.Connector.Abstractions/AdvancedSystems.Connector.Abstractions.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
       <TargetFramework>net8.0</TargetFramework>
       <Version>0.0.0-alpha</Version>
-      <Description>TODO</Description>
+      <Description>Abstractions for AdvancedSystems.Connector.</Description>
       <PackageId>AdvancedSystems.Connector.Abstractions</PackageId>
       <RootNamespace>AdvancedSystems.Connector.Abstractions</RootNamespace>
       <Title>Advanced Systems Connector Abstractions Library</Title>

AdvancedSystems.Connector.Abstractions/Provider.cs → AdvancedSystems.Connector.Abstractions/DbProvider.cs

@@ -1,12 +1,17 @@
-namespace AdvancedSystems.Connector;
+namespace AdvancedSystems.Connector.Abstractions;
 
 /// <summary>
 ///     Represents the different database providers supported by the system.
 /// </summary>
-public enum Provider
+public enum DbProvider
 {
+    /// <summary>
+    ///     Generic SQL Server.
+    /// </summary>
+    Generic = 0,
+
     /// <summary>
     ///     Microsoft SQL Server.
     /// </summary>
-    MsSql,
-}
+    MsSql = 1,
+}

AdvancedSystems.Connector.Abstractions/Exceptions/DbConnectionException.cs

@@ -1,11 +1,12 @@
 using System;
+using System.Data.Common;
 
 namespace AdvancedSystems.Connector.Abstractions.Exceptions;
 
 /// <summary>
-///     Represents an error that occurs during the communication with a database.
+///     Represents an exception that occurs when a database connection fails.
 /// </summary>
-public class DbConnectionException : Exception
+public class DbConnectionException : DbException
 {
     /// <summary>
     ///     Initializes a new instance of the <seealso cref="DbConnectionException"/> class.
@@ -17,10 +18,10 @@ public DbConnectionException()
 
     /// <summary>
     ///     Initializes a new instance of the <seealso cref="DbConnectionException"/> class
-    ///     with a specified error <paramref name="message"/>.
+    ///     with the specified error <paramref name="message"/>.
     /// </summary>
     /// <param name="message">
-    ///     The error message that explains the reason for the exception.
+    ///     The message to display for this exception.
     /// </param>
     public DbConnectionException(string message) : base(message)
     {
@@ -29,17 +30,17 @@ public DbConnectionException(string message) : base(message)
 
     /// <summary>
     ///     Initializes a new instance of the <seealso cref="DbConnectionException"/> class
-    ///     with a specified error <paramref name="message"/> a reference to the <paramref name="inner"/>
-    ///     exception that is the cause of this exception.
+    ///     with the specified error <paramref name="message"/> and a reference to the
+    ///     <paramref name="innerException"/> that is cause of this exception.
     /// </summary>
     /// <param name="message">
-    ///     The error message that explains the reason for the exception.
+    ///     The message to display for this exception.
     /// </param>
-    /// <param name="inner">
-    ///     The exception that is the cause of the current exception, or a null reference if no inner exception is specified.
+    /// <param name="innerException">
+    ///     The inner exception reference.
     /// </param>
-    public DbConnectionException(string message, Exception inner) : base(message, inner)
+    public DbConnectionException(string message, Exception innerException) : base(message, innerException)
     {
 
     }
-}
+}

AdvancedSystems.Connector.Abstractions/IDbCommand.cs

@@ -0,0 +1,41 @@
+using System.Collections.Generic;
+using System.Data;
+
+namespace AdvancedSystems.Connector.Abstractions;
+
+/// <summary>
+///     Defines an SQL statement or stored procedure to execute against a data source.
+/// </summary>
+public interface IDbCommand
+{
+    #region Properties
+
+    /// <summary>
+    ///     Gets or sets the Transact-SQL statement or stored
+    ///     procedure to execute at the data source.
+    /// </summary>
+    string CommandText { get; set; }
+
+    /// <summary>
+    ///     Gets or sets a value indicating how the <seealso cref="CommandText"/>
+    ///     property is to be interpreted.
+    /// </summary>
+    CommandType CommandType { get; set; }
+
+    /// <summary>
+    ///     Gets a collection of <seealso cref="IDbParameter"/> parameters.
+    /// </summary>
+    IReadOnlyList<IDbParameter> Parameters { get; }
+
+    #endregion
+
+    #region Methods
+
+    void AddParameter(string parameterName, object value, DbType type);
+
+    void AddParameter<T>(string parameterName, T value);
+
+    string ToString();
+
+    #endregion
+}

AdvancedSystems.Connector.Abstractions/IDbCommandFactory.cs

@@ -0,0 +1,9 @@
+using System.Data;
+using System.Data.Common;
+
+namespace AdvancedSystems.Connector.Abstractions;
+
+public interface IDbCommandFactory
+{
+    DbCommand Create(DbProvider dbProvider, DbConnection dbConnection, string commandText, CommandType commandType);
+}

AdvancedSystems.Connector.Abstractions/IDatabaseConnectionFactory.cs → AdvancedSystems.Connector.Abstractions/IDbConnectionFactory.cs

@@ -1,25 +1,33 @@
 using System;
+using System.Data.Common;
 
 namespace AdvancedSystems.Connector.Abstractions;
 
 /// <summary>
-///     Defines a factory for creating instances of <seealso cref="IDatabaseConnectionService"/>.
+///     Defines a factory for creating instances of <seealso cref="DbConnection"/>.
 /// </summary>
-public interface IDatabaseConnectionFactory
+public interface IDbConnectionFactory
 {
+    #region Methods
+
     /// <summary>
-    ///     Creates a new instance of <see cref="IDatabaseConnectionService"/> based on the
+    ///     Creates a new instance of <see cref="DbConnection"/> based on the
     ///     specified provider.
     /// </summary>
     /// <param name="provider">
     ///     The database provider for which the connection service should be created.
     /// </param>
+    /// <param name="connectionString">
+    ///     The connection string used to establish the connection with the database.
+    /// </param>
     /// <returns>
-    ///     An instance of <see cref="IDatabaseConnectionService"/> configured for the
+    ///     An instance of <see cref="DbConnection"/> configured for the
     ///     specified provider.
     /// </returns>
     /// <exception cref="NotSupportedException">
     ///     Thrown when the specified <paramref name="provider"/> is not supported by the factory.
     /// </exception>
-    IDatabaseConnectionService Create(Provider provider);
-}
+    DbConnection Create(DbProvider provider, string connectionString);
+
+    #endregion
+}