Merge pull request #65 from Afischbacher/develop

v3.7.0

Author: Afischbacher

.editorconfig

@@ -441,4 +441,10 @@ dotnet_naming_rule.parameters_rule.severity             = warning
 # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 # OTHER DEALINGS IN THE SOFTWARE.
-##########################################
+##########################################
+
+# CA1707: Identifiers should not contain underscores
+dotnet_diagnostic.CA1707.severity = none
+
+# IDE1006: Remove warning for underscores
+dotnet_diagnostic.IDE1006.severity = none

.github/workflows/codeql-analysis.yml

@@ -51,10 +51,14 @@ jobs:
         # Prefix the list here with "+" to use these queries and those in the config file.
         # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
+    - name: Setup .NET 9
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '9.0.x'
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --no-restore --configuration Release
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl

.github/workflows/develop-build.yml

@@ -10,15 +10,18 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 8
+    - name: Setup .NET 9
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '8.0.x'
+        dotnet-version: '9.0.x'
     - name: Restore dependencies
       run: dotnet restore
     - name: Build
       run: dotnet build --no-restore --configuration Release
     - name: Run Tests
-      run: dotnet test --configuration Release --no-build --verbosity normal /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
-    - name: Upload coverage reports to Codecov with GitHub Action
-      uses: codecov/codecov-action@v3
+      run: dotnet test -m --configuration Release --no-build --verbosity normal /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        fail_ci_if_error: false
+        token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/master-build-daily.yml

@@ -10,10 +10,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 8
+    - name: Setup .NET 9
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '8.0.x'
+        dotnet-version: '9.0.x'
     - name: Restore dependencies
       run: dotnet restore
     - name: Build

.github/workflows/master-build.yml

@@ -9,15 +9,18 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 8
+    - name: Setup .NET 9
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '8.0.x'
+        dotnet-version: '9.0.x'
     - name: Restore dependencies
       run: dotnet restore
     - name: Build
       run: dotnet build --no-restore --configuration Release
     - name: Run Tests
-      run: dotnet test --configuration Release --no-build --verbosity normal /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
-    - name: Upload coverage reports to Codecov with GitHub Action
-      uses: codecov/codecov-action@v3
+      run: dotnet test -m --configuration Release --no-build --verbosity normal /p:CollectCoverage=true /p:CoverletOutputFormat=opencover
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        fail_ci_if_error: false
+        token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/publish-nuget.yml

@@ -10,15 +10,15 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup .NET 8
+    - name: Setup .NET 9
       uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '8.0.x'
+        dotnet-version: '9.0.x'
     - name: Restore dependencies
       run: dotnet restore
     - name: Build
       run: dotnet build --no-restore --configuration Release
     - name: Run Tests
-      run: dotnet test
+      run: dotnet test -m
     - name: Deploy NuGet Package
       run: dotnet nuget push ../../Nhl.Api/Nhl.Api/Nhl.Api/bin/Release/*.nupkg --api-key ${{secrets.NUGET_API_KEY}} --source https://api.nuget.org/v3/index.json

Nhl.Api.Common/Exceptions/InvalidPlayerPositionException.cs

@@ -4,13 +4,9 @@ namespace Nhl.Api.Common.Exceptions;
 /// <summary>
 /// An exception for when a request is made to the Nhl.Api and the player/goalie position is invalid 
 /// </summary>
-public class InvalidPlayerPositionException : Exception
+/// <remarks>
+/// An exception for when a request is made to the Nhl.Api and the player/goalie position is invalid 
+/// </remarks>
+public class InvalidPlayerPositionException(string message) : Exception(message)
 {
-    /// <summary>
-    /// An exception for when a request is made to the Nhl.Api and the player/goalie position is invalid 
-    /// </summary>
-    public InvalidPlayerPositionException(string message) : base(message)
-    {
-
-    }
 }

Nhl.Api.Common/Exceptions/InvalidSeasonException.cs

@@ -4,13 +4,9 @@ namespace Nhl.Api.Common.Exceptions;
 /// <summary>
 /// An exception when the season year entered is not a valid NHL season
 /// </summary>
-public class InvalidSeasonException : Exception
+/// <remarks>
+/// An exception when the season year entered is not a valid NHL season
+/// </remarks>
+public class InvalidSeasonException(string message) : Exception(message)
 {
-    /// <summary>
-    /// An exception when the season year entered is not a valid NHL season
-    /// </summary>
-    public InvalidSeasonException(string message) : base(message)
-    {
-
-    }
 }

Nhl.Api.Common/Exceptions/InvalidTeamAbbreviationException.cs

@@ -0,0 +1,14 @@
+using System;
+
+namespace Nhl.Api.Common.Exceptions;
+
+/// <summary>
+/// This exception is thrown when an invalid team abbreviation is used
+/// </summary>
+public class InvalidTeamAbbreviationException(string message) : Exception
+{
+    /// <summary>
+    /// The exception message
+    /// </summary>
+    public override string Message => message;
+}

Nhl.Api.Common/Exceptions/NhlApiRequestException.cs

@@ -4,13 +4,9 @@ namespace Nhl.Api.Common.Exceptions;
 /// <summary>
 /// An exception for a failed Nhl.Api HTTP request
 /// </summary>
-public class NhlApiRequestException : Exception
+/// <remarks>
+/// An exception for a failed Nhl.Api HTTP request
+/// </remarks>
+public class NhlApiRequestException(string message) : Exception(message)
 {
-    /// <summary>
-    /// An exception for a failed Nhl.Api HTTP request
-    /// </summary>
-    public NhlApiRequestException(string message) : base(message)
-    {
-
-    }
 }

Nhl.Api.Common/Extensions/EnumExtensions.cs

@@ -15,7 +15,7 @@ public static class EnumExtensions
     /// <typeparam name="T">The enumeration type</typeparam>
     /// <param name="value">The value of the enumerations</param>
     /// <returns>The string value of the enumeration based on the attribute <see cref="EnumMemberAttribute"/></returns>
-    public static string GetEnumMemberValue<T>(this T value) where T : Enum => typeof(T)
+    public static string? GetEnumMemberValue<T>(this T value) where T : Enum => typeof(T)
             .GetTypeInfo()
             .DeclaredMembers
             .SingleOrDefault(x => x.Name == value.ToString())

Nhl.Api.Common/Extensions/StringExtensions.cs

@@ -14,12 +14,12 @@ public static class StringExtensions
     public static string ReplaceNonAsciiWithAscii(this string input)
     {
         // Define a regular expression pattern for non-ASCII characters
-        string pattern = @"[^\x00-\x7F]";
+        var pattern = @"[^\x00-\x7F]";
 
         // Replace non-ASCII characters with their ASCII equivalents
-        string output = Regex.Replace(input, pattern, (match) =>
+        var output = Regex.Replace(input, pattern, (match) =>
         {
-            char c = match.Value[0];
+            var c = match.Value[0];
             return c switch
             {
                 'À' or 'Á' or 'Â' or 'Ã' or 'Ä' => "A",