Add support for .NET 8 (#26)

sqids · Dec 1, 2023 · ff3505c · ff3505c
1 parent dc0bfb2
commit ff3505c
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 19 deletions.
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -16,7 +16,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 7.0.x
+          dotnet-version: 8.0.x
 
       - name: Generate the package
         # NOTE: As for the `${GITHUB_REF_NAME#v}` bit below, see https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables:~:text=branch%2D1.-,GITHUB_REF_NAME,-The%20short%20ref. We could've also done https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable but since we're using this value in a single place, we don't need to make it an environment variable.

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -16,7 +16,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 7.0.x # NOTE: The `windows-latest` container already comes pre-installed with the .NET versions that we need, but we do need to use `setup-dotnet` (and pass it one of the versions — e.g. 7.0.x), so that the relevant binaries (e.g. `dotnet`) are actually added to PATH so we can use them. See https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software and https://github.com/actions/setup-dotnet
+          dotnet-version: 8.0.x # NOTE: The `windows-latest` container already comes pre-installed with the .NET versions that we need, but we do need to use `setup-dotnet` (and pass it one of the versions — e.g. 7.0.x), so that the relevant binaries (e.g. `dotnet`) are actually added to PATH so we can use them. See https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software and https://github.com/actions/setup-dotnet
 
       # TODO: Some .NET codebases with GitHub Actions workflows seem to run `dotnet restore`, `dotnet build` and `dotnet test` as separate steps. Why?
       - name: Run the tests

diff --git a/src/Sqids/Sqids.csproj b/src/Sqids/Sqids.csproj
@@ -1,8 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFrameworks>netstandard2.0;net6.0;net7.0</TargetFrameworks>
-		<LangVersion>11.0</LangVersion>
+		<TargetFrameworks>netstandard2.0;net6.0;net7.0;net8.0</TargetFrameworks>
+		<LangVersion>12.0</LangVersion>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
 		<OutputType>Library</OutputType>

diff --git a/src/Sqids/SqidsEncoder.cs b/src/Sqids/SqidsEncoder.cs
@@ -110,7 +110,7 @@ public SqidsEncoder(SqidsOptions options)
 			w.Any(c => !options.Alphabet.Contains(c, StringComparison.OrdinalIgnoreCase))
 #endif
 		);
-		_blockList = options.BlockList.ToArray(); // NOTE: Arrays are faster to iterate than HashSets, so we construct an array here.
+		_blockList = [.. options.BlockList]; // NOTE: Arrays are faster to iterate than HashSets, so we construct an array here.
 
 		_alphabet = options.Alphabet.ToCharArray();
 		ConsistentShuffle(_alphabet);
@@ -129,7 +129,10 @@ public string Encode(T number)
 	public string Encode(int number)
 #endif
 	{
-#if NET7_0_OR_GREATER
+#if NET8_0_OR_GREATER
+		ArgumentOutOfRangeException.ThrowIfLessThan(number, T.Zero, nameof(number));
+#else
+#if NET7_0
 		if (number < T.Zero)
 #else
 		if (number < 0)
@@ -140,6 +143,11 @@ public string Encode(int number)
 			);
 
 		return Encode(stackalloc[] { number }); // NOTE: We use `stackalloc` here in order not to incur the cost of allocating an array on the heap, since we know the array will only have one element, we can use `stackalloc` safely.
+#endif
+
+#if NET8_0_OR_GREATER
+		return Encode([number]);
+#endif
 	}
 
 	/// <summary>
@@ -159,7 +167,10 @@ public string Encode(params int[] numbers)
 			return string.Empty;
 
 		foreach (var number in numbers)
-#if NET7_0_OR_GREATER
+#if NET8_0_OR_GREATER
+			ArgumentOutOfRangeException.ThrowIfLessThan(number, T.Zero, nameof(numbers));
+#else
+#if NET7_0
 			if (number < T.Zero)
 #else
 			if (number < 0)
@@ -168,6 +179,7 @@ public string Encode(params int[] numbers)
 					nameof(numbers),
 					"Encoding is only supported for zero and positive numbers."
 				);
+#endif
 
 		return Encode(numbers.AsSpan());
 	}
@@ -387,13 +399,13 @@ private static ReadOnlySpan<char> ToId(int num, ReadOnlySpan<char> alphabet)
 		do
 		{
 			id.Insert(0, alphabet[int.CreateChecked(result % T.CreateChecked(alphabet.Length))]);
-			result = result / T.CreateChecked(alphabet.Length);
+			result /= T.CreateChecked(alphabet.Length);
 		} while (result > T.Zero);
 #else
 		do
 		{
 			id.Insert(0, alphabet[result % alphabet.Length]);
-			result = result / alphabet.Length;
+			result /= alphabet.Length;
 		} while (result > 0);
 #endif
 

diff --git a/src/Sqids/SqidsOptions.cs b/src/Sqids/SqidsOptions.cs
@@ -32,8 +32,8 @@ public sealed class SqidsOptions
 	/// <summary>
 	/// List of blocked words that must not appear in the IDs.
 	/// </summary>
-	public HashSet<string> BlockList { get; set; } = new()
-	{
+	public HashSet<string> BlockList { get; set; } =
+	[
 		"0rgasm",
 		"1d10t",
 		"1d1ot",
@@ -594,5 +594,5 @@ public sealed class SqidsOptions
 		"zocc0la",
 		"zocco1a",
 		"zoccola"
-	};
+	];
 }
diff --git a/test/Sqids.Tests/Sqids.Tests.csproj b/test/Sqids.Tests/Sqids.Tests.csproj
@@ -2,19 +2,25 @@
 
 	<PropertyGroup>
 		<!-- NOTE: `net472` is used for testing `netstandard2.0` -->
-		<TargetFrameworks>net472;net6.0;net7.0</TargetFrameworks>
-		<LangVersion>11.0</LangVersion>
+		<TargetFrameworks>net472;net6.0;net7.0;net8.0</TargetFrameworks>
+		<LangVersion>12.0</LangVersion>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
 		<IsTestProject>true</IsTestProject>
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
-		<PackageReference Include="NUnit" Version="3.13.3" />
-		<PackageReference Include="NUnit3TestAdapter" Version="4.4.2" />
-		<PackageReference Include="NUnit.Analyzers" Version="3.6.1" />
-		<PackageReference Include="coverlet.collector" Version="3.2.0" />
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+		<PackageReference Include="NUnit" Version="3.14.0" />
+		<PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
+		<PackageReference Include="NUnit.Analyzers" Version="3.9.0">
+		  <PrivateAssets>all</PrivateAssets>
+		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+		</PackageReference>
+		<PackageReference Include="coverlet.collector" Version="6.0.0">
+		  <PrivateAssets>all</PrivateAssets>
+		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+		</PackageReference>
 		<PackageReference Include="Shouldly" Version="4.2.1" />
 	</ItemGroup>