chore: consume Timecop.Core package, change the readme. (#3)

Author: dmytro-khmara

README.md

@@ -5,7 +5,7 @@ Timecop is a small library that helps you test DateTime in a static, thread-safe
 
 Timecop targets .NET Standard 2.0, has no external dependencies, and can be used with .NET Framework 4.5+ and any version of .NET and .NET Core.
 
-Timecop is the C# port of the [timecop](https://github.com/travisjeffery/timecop) Ruby gem.
+Timecop has been inspired by the [timecop](https://github.com/travisjeffery/timecop) Ruby gem.
 
 ## Installation
 
@@ -32,10 +32,12 @@ string Greet()
 
     return $"Good {timeOfDay}!";
 }
+
 // freeze at 2pm local time:
 using var tc = Timecop.Frozen(o => o.At(14,0,0).LocalTime()); 
 
 Greet(); // Good afternoon!
+
 // travel to 8pm local time:
 tc.TravelBy(TimeSpan.FromHours(6)); 
 
@@ -48,32 +50,39 @@ Greet(); // Good evening!
 
 Time is frozen with either an instance `Freeze` or a static `Frozen` method, both having the same set of signatures. The instance `Freeze` freezes the instance of `Timecop`, the static `Frozen` creates an already frozen instance.
 
-Frozen time doesn't run for your tests unless you call `Resume` or dispose the `Timecop` instance:
+Frozen time doesn't run for your tests until you call `Resume` or dispose the `Timecop` instance:
 
 ```csharp
 using var tc = Timecop.Frozen(1990, 12, 2, 14, 38, 51, DateTimeKind.Local);
+
 Clock.Now; // 1990-12-02 14:38:51
 
 Thread.Sleep(TimeSpan.FromSeconds(3));
-Clock.Now; // 1990-12-02 14:38:51 - Still the same value
+
+Clock.Now; // 1990-12-02 14:38:51 - still the same value
 
 tc.Resume();
 
 Thread.Sleep(TimeSpan.FromSeconds(3));
-Clock.Now; // 1990-12-02 14:38:54 - Time has changed
+
+Clock.Now; // 1990-12-02 14:38:54 - time has changed
 ```
 
-Both `Freeze` and `Frozen` have the multiple overloads:
+Both `Freeze` and `Frozen` have multiple overloads:
 
 ```csharp
 // freeze at the current instant:
 tc.Freeze();
+
 // freeze at the specified DateTime:
 tc.Freeze(new DateTime(1990, 12, 2, 14, 38, 51, DateTimeKind.Utc));
+
 // freeze at the specified date and time:
 tc.Freeze(1990, 12, 2, 14, 38, 51, DateTimeKind.Utc);
+
 // freeze at the specified date:
 tc.Freeze(1990, 12, 2, DateTimeKind.Utc);
+
 // freeze at the specified date or time or both:
 tc.Freeze(o => o.On(1990, 12, 2)
                 .At(14, 13, 51)
@@ -86,9 +95,12 @@ Use  the `TravelBy` method to travel forward and backward in time:
 
 ```csharp
 using var tc = Timecop.Frozen(1990, 12, 2, 14, 38, 51, DateTimeKind.Local);
+
 tc.TravelBy(TimeSpan.FromDays(1));
-Clock.Now; // 1990-12-03 14:38:51 - One day in the future
+
+Clock.Now; // 1990-12-03 14:38:51 - one day in the future
 ```
+
 ## License
 
 Timecop was created by [Dmytro Khmara](https://dmytrokhmara.com) and is licensed under the [MIT license](LICENSE.txt).

src/Timecop/DateTimeUtils/UtcDateTime.cs

@@ -1,4 +1,5 @@
 using System;
+using TCop.Core;
 
 namespace TCop.DateTimeUtils;
 
@@ -15,4 +16,6 @@ public UtcDateTime(DateTime value)
 
         UtcValue = value.ToUniversalTime();
     }
+
+    public PointInTime PointInTime => new (UtcValue);
 }

src/Timecop/Timecop.cs

@@ -1,4 +1,5 @@
 using System;
+using TCop.Core;
 using TCop.DateTimeUtils;
 
 namespace TCop;
@@ -7,7 +8,7 @@ public class Timecop : IDisposable
 {
     private readonly TimecopContextStore _contextStore = new();
 
-    public static DateTime UtcNow => TimecopContextStore.AsyncContextUtcNow;
+    public static DateTime UtcNow => TimecopContextStore.AsyncContextUtcNow.DateTime;
 
     /// <summary>Moves in time backward or forward by the specified amount of time.</summary>
     /// <param name="duration">The amount of time to travel by. Can be positive or negative.</param>
@@ -18,7 +19,7 @@ public void TravelBy(TimeSpan duration)
 
     private void ConvertAndFreeze(UtcDateTime? utcDateTime)
     {
-        _contextStore.Mutate((ref TimecopContext context, DateTime utcNow) => context.Freeze(utcDateTime?.UtcValue ?? utcNow));
+        _contextStore.Mutate((ref TimecopContext context, PointInTime utcNow) => context.Freeze(utcDateTime?.PointInTime ?? utcNow));
     }
 
     /// <summary>Freezes an instance of <see cref="T:TCop.Timecop" /> at the current time.</summary>
@@ -80,7 +81,7 @@ public Timecop Freeze(Action<DateTimeBuilder> config)
     /// <summary>Resumes the flow of time of a frozen instance of <see cref="T:TCop.Timecop" />.</summary>
     public void Resume()
     {
-        _contextStore.Mutate((ref TimecopContext context, DateTime utcNow) => context.Unfreeze(utcNow));
+        _contextStore.Mutate((ref TimecopContext context, PointInTime utcNow) => context.Unfreeze(utcNow));
     }
 
     /// <summary>Creates an instance of <see cref="T:TCop.Timecop" /> and freezes it at the current time.</summary>

src/Timecop/Timecop.csproj

@@ -33,6 +33,8 @@
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
+
+		<PackageReference Include="Timecop.Core" Version="1.1.0" />
 	</ItemGroup>
 
 </Project>