Feature/styling and formatting (#130)

* Update CONTRIBUTING.md * Update dependabot.yml * Update FUNDING.yml * nuget updates * move test nugets into test csprojs * target frameworks netstandard2.0 and net8.0 * test naming updates * Update Pilgaard.ScheduledJobs.Tests.csproj * more cleanup, more nuget updates
NielsPilgaard · Jun 9, 2024 · ea7a177 · ea7a177
1 parent f042590
commit ea7a177
Show file tree

Hide file tree

Showing 11 changed files with 298 additions and 289 deletions.
diff --git a/src/Pilgaard.BackgroundJobs/BackgroundJobScheduler.cs b/src/Pilgaard.BackgroundJobs/BackgroundJobScheduler.cs
@@ -76,7 +76,6 @@ public async IAsyncEnumerable<BackgroundJobRegistration> GetBackgroundJobsAsync(
 		}
 	}
 
-
 	public IEnumerable<BackgroundJobRegistration> GetRecurringJobs() => _options.Value.Registrations.Where(registration => registration.IsRecurringJob);
 
 	/// <summary>

diff --git a/src/Pilgaard.BackgroundJobs/BackgroundJobService.cs b/src/Pilgaard.BackgroundJobs/BackgroundJobService.cs
diff --git a/src/Pilgaard.BackgroundJobs/IBackgroundJobScheduler.cs b/src/Pilgaard.BackgroundJobs/IBackgroundJobScheduler.cs
@@ -1,27 +1,26 @@
 namespace Pilgaard.BackgroundJobs;
 
-
 /// <summary>
 /// IBackgroundJobScheduler is responsible for scheduling background jobs.
 /// </summary>
 internal interface IBackgroundJobScheduler
 {
-    /// <summary>
-    /// Asynchronously retrieves an ordered enumerable of background job registrations.
-    /// <para>
-    /// Jobs that implement <see cref="IRecurringJob"/> are not retrieved, they are scheduled during startup.
-    /// </para>
-    /// <para>
-    /// Each background job registration is returned when it should be run.
-    /// </para>
-    /// </summary>
-    /// <param name="cancellationToken">The <see cref="CancellationToken"/> used for cancelling the enumeration.</param>
-    /// <returns>An asynchronous enumerable of background job registrations.</returns>
-    IAsyncEnumerable<BackgroundJobRegistration> GetBackgroundJobsAsync(CancellationToken cancellationToken);
+	/// <summary>
+	/// Asynchronously retrieves an ordered enumerable of background job registrations.
+	/// <para>
+	/// Jobs that implement <see cref="IRecurringJob"/> are not retrieved, they are scheduled during startup.
+	/// </para>
+	/// <para>
+	/// Each background job registration is returned when it should be run.
+	/// </para>
+	/// </summary>
+	/// <param name="cancellationToken">The <see cref="CancellationToken"/> used for cancelling the enumeration.</param>
+	/// <returns>An asynchronous enumerable of background job registrations.</returns>
+	IAsyncEnumerable<BackgroundJobRegistration> GetBackgroundJobsAsync(CancellationToken cancellationToken);
 
-    /// <summary>
-    /// Retrieves all <see cref="BackgroundJobRegistration"/>s where <see cref="BackgroundJobRegistration.IsRecurringJob"/> is <c>true</c>
-    /// </summary>
-    /// <returns>An enumerable of background job registrations where <see cref="BackgroundJobRegistration.IsRecurringJob"/> is <c>true</c></returns>
-    IEnumerable<BackgroundJobRegistration> GetRecurringJobs();
+	/// <summary>
+	/// Retrieves all <see cref="BackgroundJobRegistration"/>s where <see cref="BackgroundJobRegistration.IsRecurringJob"/> is <c>true</c>
+	/// </summary>
+	/// <returns>An enumerable of background job registrations where <see cref="BackgroundJobRegistration.IsRecurringJob"/> is <c>true</c></returns>
+	IEnumerable<BackgroundJobRegistration> GetRecurringJobs();
 }
diff --git a/src/Pilgaard.BackgroundJobs/Jobs/BackgroundJobExtensions.cs b/src/Pilgaard.BackgroundJobs/Jobs/BackgroundJobExtensions.cs
@@ -2,36 +2,36 @@ namespace Pilgaard.BackgroundJobs;
 
 public static class BackgroundJobExtensions
 {
-    /// <summary>
-    /// Get the next occurrence of the background job.
-    /// </summary>
-    /// <param name="backgroundJob">The background job to get the next occurrence of.</param>
-    /// <returns><see cref="DateTime"/> of the next occurrence, or <c>null</c> if none.</returns>
-    /// <exception cref="ArgumentOutOfRangeException"></exception>
-    public static DateTime? GetNextOccurrence(this IBackgroundJob backgroundJob) =>
-        backgroundJob switch
-        {
-            ICronJob cronJob => cronJob.GetNextOccurrence(),
-            IRecurringJob recurringJob => recurringJob.GetNextOccurrence(),
-            IOneTimeJob oneTimeJob => oneTimeJob.GetNextOccurrence(),
-            _ => throw new ArgumentOutOfRangeException(nameof(IBackgroundJob),
-                $"Background job must implement either {nameof(ICronJob)}, {nameof(IRecurringJob)} or {nameof(IOneTimeJob)}")
-        };
+	/// <summary>
+	/// Get the next occurrence of the background job.
+	/// </summary>
+	/// <param name="backgroundJob">The background job to get the next occurrence of.</param>
+	/// <returns><see cref="DateTime"/> of the next occurrence, or <c>null</c> if none.</returns>
+	/// <exception cref="ArgumentOutOfRangeException"></exception>
+	public static DateTime? GetNextOccurrence(this IBackgroundJob backgroundJob) =>
+		backgroundJob switch
+		{
+			ICronJob cronJob => cronJob.GetNextOccurrence(),
+			IRecurringJob recurringJob => recurringJob.GetNextOccurrence(),
+			IOneTimeJob oneTimeJob => oneTimeJob.GetNextOccurrence(),
+			_ => throw new ArgumentOutOfRangeException(nameof(backgroundJob),
+				$"Background job must implement either {nameof(ICronJob)}, {nameof(IRecurringJob)} or {nameof(IOneTimeJob)}")
+		};
 
-    /// <summary>
-    /// Get all occurrences of the background job up to a certain date.
-    /// </summary>
-    /// <param name="backgroundJob">The background job to get the occurrences of.</param>
-    /// <param name="toUtc">The date up to which to get occurrences.</param>
-    /// <returns><see cref="IEnumerable{T}"/> of all occurrences.</returns>
-    /// <exception cref="ArgumentOutOfRangeException"></exception>
-    public static IEnumerable<DateTime> GetOccurrences(this IBackgroundJob backgroundJob, DateTime toUtc) =>
-        backgroundJob switch
-        {
-            ICronJob cronJob => cronJob.GetOccurrences(toUtc),
-            IRecurringJob recurringJob => recurringJob.GetOccurrences(toUtc),
-            IOneTimeJob oneTimeJob => oneTimeJob.GetOccurrences(toUtc),
-            _ => throw new ArgumentOutOfRangeException(nameof(IBackgroundJob),
-                $"Background job must implement either {nameof(ICronJob)}, {nameof(IRecurringJob)} or {nameof(IOneTimeJob)}")
-        };
+	/// <summary>
+	/// Get all occurrences of the background job up to a certain date.
+	/// </summary>
+	/// <param name="backgroundJob">The background job to get the occurrences of.</param>
+	/// <param name="toUtc">The date up to which to get occurrences.</param>
+	/// <returns><see cref="IEnumerable{T}"/> of all occurrences.</returns>
+	/// <exception cref="ArgumentOutOfRangeException"></exception>
+	public static IEnumerable<DateTime> GetOccurrences(this IBackgroundJob backgroundJob, DateTime toUtc) =>
+		backgroundJob switch
+		{
+			ICronJob cronJob => cronJob.GetOccurrences(toUtc),
+			IRecurringJob recurringJob => recurringJob.GetOccurrences(toUtc),
+			IOneTimeJob oneTimeJob => oneTimeJob.GetOccurrences(toUtc),
+			_ => throw new ArgumentOutOfRangeException(nameof(backgroundJob),
+				$"Background job must implement either {nameof(ICronJob)}, {nameof(IRecurringJob)} or {nameof(IOneTimeJob)}")
+		};
 }
diff --git a/src/Pilgaard.BackgroundJobs/Pilgaard.BackgroundJobs.csproj b/src/Pilgaard.BackgroundJobs/Pilgaard.BackgroundJobs.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFrameworks>$(NetStandardVersion);$(NetVersion)</TargetFrameworks>
@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Cronos" Version="0.7.1" />
+    <PackageReference Include="Cronos" Version="0.8.4" />
   </ItemGroup>
 
   <ItemGroup Label="Net Nugets" Condition="'$(TargetFramework)' == '$(NetVersion)'">

diff --git a/src/Pilgaard.CronJobs/Pilgaard.CronJobs.csproj b/src/Pilgaard.CronJobs/Pilgaard.CronJobs.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
 		<TargetFrameworks>$(NetStandardVersion);$(NetVersion)</TargetFrameworks>
@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Cronos" Version="0.7.1" />
+    <PackageReference Include="Cronos" Version="0.8.4" />
   </ItemGroup>
 
 </Project>
diff --git a/src/ValueStopwatch.cs b/src/ValueStopwatch.cs
@@ -3,31 +3,31 @@
 // Copied from: https://github.com/dotnet/extensions/blob/master/src/Shared/src/ValueStopwatch/ValueStopwatch.cs
 internal readonly struct ValueStopwatch
 {
-    private static readonly double _timestampToTicks = TimeSpan.TicksPerSecond / (double)Stopwatch.Frequency;
+	private static readonly double _timestampToTicks = TimeSpan.TicksPerSecond / (double)Stopwatch.Frequency;
 
-    private readonly long _startTimestamp;
+	private readonly long _startTimestamp;
 
-    public bool IsActive => _startTimestamp != 0;
+	public bool IsActive => _startTimestamp != 0;
 
-    private ValueStopwatch(long startTimestamp)
-    {
-        _startTimestamp = startTimestamp;
-    }
+	private ValueStopwatch(long startTimestamp)
+	{
+		_startTimestamp = startTimestamp;
+	}
 
-    public static ValueStopwatch StartNew() => new(Stopwatch.GetTimestamp());
+	public static ValueStopwatch StartNew() => new(Stopwatch.GetTimestamp());
 
-    public TimeSpan GetElapsedTime()
-    {
-        // Start timestamp can't be zero in an initialized ValueStopwatch. It would have to be literally the first thing executed when the machine boots to be 0.
-        // So it being 0 is a clear indication of default(ValueStopwatch)
-        if (!IsActive)
-        {
-            throw new InvalidOperationException("An uninitialized, or 'default', ValueStopwatch cannot be used to get elapsed time.");
-        }
+	public TimeSpan GetElapsedTime()
+	{
+		// Start timestamp can't be zero in an initialized ValueStopwatch. It would have to be literally the first thing executed when the machine boots to be 0.
+		// So it being 0 is a clear indication of default(ValueStopwatch)
+		if (!IsActive)
+		{
+			throw new InvalidOperationException("An uninitialized, or 'default', ValueStopwatch cannot be used to get elapsed time.");
+		}
 
-        long end = Stopwatch.GetTimestamp();
-        long timestampDelta = end - _startTimestamp;
-        long ticks = (long)(_timestampToTicks * timestampDelta);
-        return new TimeSpan(ticks);
-    }
+		var end = Stopwatch.GetTimestamp();
+		var timestampDelta = end - _startTimestamp;
+		var ticks = (long)(_timestampToTicks * timestampDelta);
+		return new TimeSpan(ticks);
+	}
 }
diff --git a/tests/Pilgaard.BackgroundJobs.Tests/Pilgaard.BackgroundJobs.Tests.csproj b/tests/Pilgaard.BackgroundJobs.Tests/Pilgaard.BackgroundJobs.Tests.csproj
@@ -12,16 +12,19 @@
 
 	<ItemGroup>
 		<PackageReference Include="FluentAssertions" Version="6.12.0" />
-		<PackageReference Include="FluentAssertions.Analyzers" Version="0.26.0">
+		<PackageReference Include="FluentAssertions.Analyzers" Version="0.32.0">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
 		<PackageReference Include="Shouldly" Version="4.2.1" />
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-		<PackageReference Include="xunit" Version="2.6.2" />
-		<PackageReference Include="xunit.runner.visualstudio" Version="2.5.4" />
-		<PackageReference Include="PublicApiGenerator" Version="11.0.0" />
-		<PackageReference Include="coverlet.collector" Version="6.0.0">
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
+		<PackageReference Include="xunit" Version="2.8.1" />
+		<PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
+		  <PrivateAssets>all</PrivateAssets>
+		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+		</PackageReference>
+		<PackageReference Include="PublicApiGenerator" Version="11.1.0" />
+		<PackageReference Include="coverlet.collector" Version="6.0.2">
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 			<PrivateAssets>all</PrivateAssets>
 		</PackageReference>

diff --git a/tests/Pilgaard.CronJobs.Tests/Pilgaard.CronJobs.Tests.csproj b/tests/Pilgaard.CronJobs.Tests/Pilgaard.CronJobs.Tests.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
 		<TargetFramework>$(NetVersion)</TargetFramework>
@@ -12,20 +12,23 @@
 
 	<ItemGroup>
 		<PackageReference Include="FluentAssertions" Version="6.12.0" />
-		<PackageReference Include="FluentAssertions.Analyzers" Version="0.26.0">
+		<PackageReference Include="FluentAssertions.Analyzers" Version="0.32.0">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
 		<PackageReference Include="Shouldly" Version="4.2.1" />
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-		<PackageReference Include="xunit" Version="2.6.2" />
-		<PackageReference Include="xunit.runner.visualstudio" Version="2.5.4" />
-		<PackageReference Include="PublicApiGenerator" Version="11.0.0" />
-		<PackageReference Include="coverlet.collector" Version="6.0.0">
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
+		<PackageReference Include="xunit" Version="2.8.1" />
+		<PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
+		  <PrivateAssets>all</PrivateAssets>
+		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+		</PackageReference>
+		<PackageReference Include="PublicApiGenerator" Version="11.1.0" />
+		<PackageReference Include="coverlet.collector" Version="6.0.2">
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 			<PrivateAssets>all</PrivateAssets>
 		</PackageReference>
-		<PackageReference Include="Microsoft.Extensions.Hosting" Version="7.0.1" />
+		<PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
 	</ItemGroup>
 
 </Project>
diff --git a/tests/Pilgaard.RecurringJobs.Tests/Pilgaard.RecurringJobs.Tests.csproj b/tests/Pilgaard.RecurringJobs.Tests/Pilgaard.RecurringJobs.Tests.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
 		<TargetFramework>$(NetVersion)</TargetFramework>
@@ -12,20 +12,23 @@
 
 	<ItemGroup>
 		<PackageReference Include="FluentAssertions" Version="6.12.0" />
-		<PackageReference Include="FluentAssertions.Analyzers" Version="0.26.0">
+		<PackageReference Include="FluentAssertions.Analyzers" Version="0.32.0">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
 		<PackageReference Include="Shouldly" Version="4.2.1" />
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-		<PackageReference Include="xunit" Version="2.6.2" />
-		<PackageReference Include="xunit.runner.visualstudio" Version="2.5.4" />
-		<PackageReference Include="PublicApiGenerator" Version="11.0.0" />
-		<PackageReference Include="coverlet.collector" Version="6.0.0">
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
+		<PackageReference Include="xunit" Version="2.8.1" />
+		<PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
+		  <PrivateAssets>all</PrivateAssets>
+		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+		</PackageReference>
+		<PackageReference Include="PublicApiGenerator" Version="11.1.0" />
+		<PackageReference Include="coverlet.collector" Version="6.0.2">
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 			<PrivateAssets>all</PrivateAssets>
 		</PackageReference>
-		<PackageReference Include="Microsoft.Extensions.Hosting" Version="7.0.1" />
+		<PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
 	</ItemGroup>
 
 </Project>
diff --git a/tests/Pilgaard.ScheduledJobs.Tests/Pilgaard.ScheduledJobs.Tests.csproj b/tests/Pilgaard.ScheduledJobs.Tests/Pilgaard.ScheduledJobs.Tests.csproj
@@ -12,20 +12,23 @@
 
 	<ItemGroup>
 		<PackageReference Include="FluentAssertions" Version="6.12.0" />
-		<PackageReference Include="FluentAssertions.Analyzers" Version="0.26.0">
+		<PackageReference Include="FluentAssertions.Analyzers" Version="0.32.0">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
 		<PackageReference Include="Shouldly" Version="4.2.1" />
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-		<PackageReference Include="xunit" Version="2.6.2" />
-		<PackageReference Include="xunit.runner.visualstudio" Version="2.5.4" />
-		<PackageReference Include="PublicApiGenerator" Version="11.0.0" />
-		<PackageReference Include="coverlet.collector" Version="6.0.0">
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
+		<PackageReference Include="xunit" Version="2.8.1" />
+		<PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
+		  <PrivateAssets>all</PrivateAssets>
+		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+		</PackageReference>
+		<PackageReference Include="PublicApiGenerator" Version="11.1.0" />
+		<PackageReference Include="coverlet.collector" Version="6.0.2">
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 			<PrivateAssets>all</PrivateAssets>
 		</PackageReference>
-		<PackageReference Include="Microsoft.Extensions.Hosting" Version="7.0.1" />
+		<PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
 	</ItemGroup>
 
 </Project>