SimpleDateTimeProvider 2021.11.26.9

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package SimpleDateTimeProvider --version 2021.11.26.9
                    


                    

                
NuGet\Install-Package SimpleDateTimeProvider -Version 2021.11.26.9
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="SimpleDateTimeProvider" Version="2021.11.26.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="SimpleDateTimeProvider" Version="2021.11.26.9" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SimpleDateTimeProvider" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add SimpleDateTimeProvider --version 2021.11.26.9
                    


                    

                
#r "nuget: SimpleDateTimeProvider, 2021.11.26.9"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=SimpleDateTimeProvider&version=2021.11.26.9
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SimpleDateTimeProvider&version=2021.11.26.9
                    


                            Install as a Cake Tool

SimpleDateTimeProvider

A simple abstraction over C#'s DateTime.Now, DateTime.Today and DateTime.UtcNow so you can control these values in your tests. No longer do you have to attempt shennanigans in your tests to handle when you need to use those values in your code.

Features

  • SystemDateTimeProvider - Abstraction over the top of System.DateTime.
  • MockDateTimeProvider - Mockable provider to control DateTime values in test projects.

Setup

It's easy to get under way using the providers, simply inject the system provider under the IDateTimeProvider interface in your functional code. If you are using another library you'll know the syntax but follow the same formula.

_ = services.AddSingleton<IDateTimeProvider, SystemDateTimeProvider>();

Create your class and use that registered SystemDateTimeProvider that we just created via the IDateTimeProvider interface. Then use the provider to set the DateTime values in your class.

public class Service
{
    private readonly IDateTimeProvider dateTimeProvider;

    public Service(IDateTimeProvider dateTimeProvider)
    {
        this.dateTimeProvider = dateTimeProvider;
    }

    public string DateTimeNow()
    {
        return $"DateTime.Now is {this.dateTimeProvider.Now}";
    }
}

Testing

The whole purpose of this was to allow for testable code. So now that you have your class above, you can inject the MockDateTimeProvider in its place to control the DateTime values in your tests. It's as easy as the sample below.

[Fact]
public void Now_ShouldReturn_MockedToday()
{
    // Arrange
    var provider = new MockDateTimeProvider();
    var service = new Service(provider);
    var today = DateTime.Today;

    provider.Today = today;

    // Act
    var result = service.DateTimeToday();

    // Assert
    _ = result.ShouldBeOfType<string>();
    result.ShouldBe($"DateTime.Today is {today}");
}

Support

I'm sharing some of my work here and if it helps you, I'd love it if you'd consider supporting me at Buy Me A Coffee

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2024.12.1.90 8,249 12/1/2024
2024.11.1.89 1,242 11/1/2024
2024.10.1.88 1,921 10/1/2024
2024.9.1.87 1,330 9/1/2024
2024.7.26.86 2,237 7/26/2024
2024.7.1.84 1,802 7/1/2024
2024.6.1.83 2,216 6/1/2024
2024.5.1.82 2,030 5/1/2024
2024.4.1.81 929 4/1/2024
2024.3.1.80 1,425 3/1/2024
2024.2.1.79 1,088 2/1/2024
2024.1.1.78 3,142 1/1/2024
2023.12.15.77 349 12/15/2023
2023.12.15.76 148 12/15/2023
2023.12.15.75 160 12/15/2023
2023.12.14.71 161 12/14/2023
2022.11.13.46 31,814 11/13/2022
2022.10.30.45 655 10/30/2022
2022.10.23.44 466 10/23/2022
2022.10.16.43 543 10/16/2022
2022.10.9.42 456 10/9/2022
2022.10.2.41 532 10/2/2022
2022.9.18.40 1,038 9/18/2022
2022.9.4.39 479 9/4/2022
2022.8.28.38 480 8/28/2022
2022.8.21.37 862 8/21/2022
2022.8.14.36 477 8/14/2022
2022.8.7.35 520 8/7/2022
2022.7.24.34 1,209 7/24/2022
2022.7.10.33 1,590 7/10/2022
2022.6.19.32 1,653 6/19/2022
2022.6.5.31 540 6/5/2022
2022.5.15.30 848 5/15/2022
2022.5.1.29 2,141 5/1/2022
2022.4.17.28 662 4/17/2022
2022.4.3.27 921 4/3/2022
2022.3.6.26 600 3/6/2022
2022.2.27.25 484 2/27/2022
2022.2.20.24 611 2/20/2022
2022.2.13.23 524 2/13/2022
2022.2.10.22 523 2/10/2022
2022.2.6.20 519 2/6/2022
2022.2.5.19 519 2/5/2022
2022.1.23.18 894 1/23/2022
2022.1.19.17 509 1/19/2022
2022.1.19.15 501 1/19/2022
2022.1.19.14 519 1/19/2022
2022.1.9.13 341 1/9/2022
2021.11.29.12 988 11/29/2021
2021.11.27.10 339 11/27/2021
2021.11.26.9 1,716 11/26/2021
2021.11.23.8 351 11/23/2021
2021.11.22.4 368 11/22/2021
2021.11.22.3 382 11/22/2021
2021.11.22.2 590 11/22/2021