Feature/reporter eta

README.md

@@ -10,6 +10,8 @@ Report progression with ease by using multilple components such as Bars, Spinner
 using var reporter = new ReporterBuilder()
     .DisplayingStartingTime()
     .DisplayingElapsedTime()
+    .DisplayingTimeOfArrival()
+    .DisplayingRemainingTime()
     .DisplayingItemsSummary()
     .DisplayingItemsOverview()
     .UsingReportingFrequency(TimeSpan.FromMilliseconds(50))
@@ -42,10 +44,6 @@ var descriptor = BarDescriptor.Default;
 ### Define the reporter to use the component
 ```csharp
 var reporter = new ReporterBuilder()
-    .DisplayingStartingTime()
-    .DisplayingElapsedTime()
-    .DisplayingItemsSummary()
-    .DisplayingItemsOverview()
     .UsingReportingFrequency(TimeSpan.FromMilliseconds(50))
     .UsingComponentDescriptor(descriptor)
     .Build(Worker.AllItems);

src/Progress.Samples.Bar.App/Program.cs

@@ -5,6 +5,8 @@
 using var reporter = new ReporterBuilder()
     .DisplayingStartingTime()
     .DisplayingElapsedTime()
+    .DisplayingTimeOfArrival()
+    .DisplayingRemainingTime()
     .DisplayingItemsSummary()
     .DisplayingItemsOverview()
     .UsingReportingFrequency(TimeSpan.FromMilliseconds(50))

src/Progress.Samples.HearthBeat.App/Program.cs

@@ -5,6 +5,8 @@
 using var reporter = new ReporterBuilder()
     .DisplayingStartingTime()
     .DisplayingElapsedTime()
+    .DisplayingTimeOfArrival()
+    .DisplayingRemainingTime()
     .DisplayingItemsSummary()
     .DisplayingItemsOverview()
     .UsingReportingFrequency(TimeSpan.FromMilliseconds(50))

src/Progress.Samples.Pulse.App/Program.cs

@@ -5,6 +5,8 @@
 using var reporter = new ReporterBuilder()
     .DisplayingStartingTime()
     .DisplayingElapsedTime()
+    .DisplayingTimeOfArrival()
+    .DisplayingRemainingTime()
     .DisplayingItemsSummary()
     .DisplayingItemsOverview()
     .UsingReportingFrequency(TimeSpan.FromMilliseconds(50))

src/Progress.Samples.Spinner.App/Program.cs

@@ -5,6 +5,8 @@
 using var reporter = new ReporterBuilder()
     .DisplayingStartingTime()
     .DisplayingElapsedTime()
+    .DisplayingTimeOfArrival()
+    .DisplayingRemainingTime()
     .DisplayingItemsSummary()
     .DisplayingItemsOverview()
     .UsingReportingFrequency(TimeSpan.FromMilliseconds(50))

src/Progress.UnitTest/TimerTests.cs

@@ -0,0 +1,73 @@
+namespace Progress.UnitTest;
+
+public class TimerTests
+{
+    [Fact]
+    public void GivenNothingDone_WhenGettingRemainingTime_ThenReturnsMaxValue()
+    {
+        // Arrange
+        var timer = Timer.Start();
+
+        // Act
+        var actual = timer.GetRemainingTime(0);
+
+        // Assert
+        actual.Should().Be(TimeSpan.MaxValue);
+    }
+
+
+    [Fact]
+    public void GivenEverythingDone_WhenGettingRemainingTime_ThenReturnsZero()
+    {
+        // Arrange
+        var timer = Timer.Start();
+
+        // Act
+        var actual = timer.GetRemainingTime(100);
+
+        // Assert
+        actual.Should().Be(TimeSpan.Zero);
+    }
+
+    [Fact]
+    public void GivenNothingDone_WhenGettingEstimatedTimeOfArrival_ThenReturnsMaxValue()
+    {
+        // Arrange
+        var timer = Timer.Start();
+
+        // Act
+        var actual = timer.GetEstimatedTimeOfArrival(0);
+
+        // Assert
+        actual.Should().Be(DateTimeOffset.MaxValue);
+    }
+
+    [Fact]
+    public void GivenInstance_WhenGettingStartedOn_ThenReturnsMomentOfCreation()
+    {
+        // Arrange
+        var moment = DateTimeOffset.UtcNow;
+        var timer = new Timer(moment);
+
+        // Act
+        var actual = timer.StartedOn;
+
+        // Assert
+        actual.Should().Be(moment);
+    }
+
+    [Fact]
+    public async Task GivenSomeWorkDone_WhenGettingElapsedTime_ThenReturnsTime()
+    {
+        // Arrange
+        var timer = Timer.Start();
+        var delay = TimeSpan.FromSeconds(1);
+        await Task.Delay(delay);
+
+        // Act
+        var actual = timer.ElapsedTime;
+
+        // Assert
+        actual.Should().BeGreaterThanOrEqualTo(delay);
+    }
+}

src/Progress/Components/Bar.cs

@@ -8,7 +8,6 @@ internal class Bar : Component
     private readonly uint _width;
     private readonly char[] _bar;
 
-    private Percent _percent = default!;
     private ulong _availableItems;
     private ulong _count;
     private int _adjustedPercent;
@@ -26,7 +25,7 @@ public override Component Next(ulong availableItems, ulong currentCount)
     {
         _availableItems = availableItems;
         _count = currentCount;
-        _percent = Calculate(availableItems, currentCount);
+        CurrentPercent = Calculate(availableItems, currentCount);
         return this;
     }
 
@@ -45,15 +44,15 @@ public override string ToString()
         if (DisplayPercent)
         {
             sBuilder.Append(' ');
-            sBuilder.Append(_percent.ToString());
+            sBuilder.Append(CurrentPercent.ToString());
         }
 
         return sBuilder.ToString();
     }
 
     private void Fill()
     {
-        if (_percent.Value > 0)
+        if (CurrentPercent.Value > 0)
             _adjustedPercent = (int)(_count / (decimal)_availableItems * _width);
 
         if (_adjustedPercent <= _bar.Length)

src/Progress/Components/Component.cs

@@ -6,21 +6,23 @@ internal abstract class Component
 {
     private static readonly CultureInfo Culture = new("en-US");
 
+    public Percent CurrentPercent { get; protected set; } = default!;
+
     public abstract Component Next(ulong availableItems, ulong currentCount);
 
     protected static Percent Calculate(ulong availableItems, ulong currentCount) => new(availableItems, currentCount);
 
     internal class Percent
     {
-        private readonly decimal _percent;
+        private readonly double _percent;
 
         public Percent(ulong items, ulong count)
         {
             if (count > 0)
-                _percent = count / (decimal)items;
+                _percent = count / (double)items;
         }
 
-        public decimal Value => _percent * 100;
+        public double Value => _percent * 100;
 
         public override string ToString() => _percent.ToString("P02", Culture);
     }

src/Progress/Components/HearthBeat.cs

@@ -9,7 +9,6 @@ internal class HearthBeat : Component
 
     private uint _leftIndex;
     private uint _rightIndex;
-    private Percent _percent = default!;
 
     public HearthBeat(uint width, char progressSymbol)
     {
@@ -21,7 +20,7 @@ public HearthBeat(uint width, char progressSymbol)
 
     public override Component Next(ulong availableItems, ulong currentCount)
     {
-        _percent = Calculate(availableItems, currentCount);
+        CurrentPercent = Calculate(availableItems, currentCount);
 
         if (_leftIndex == 0)
         {
@@ -53,7 +52,7 @@ public override string ToString()
         if (DisplayPercent)
         {
             sBuilder.Append(' ');
-            sBuilder.Append(_percent.ToString());
+            sBuilder.Append(CurrentPercent.ToString());
         }
 
         return sBuilder.ToString();
@@ -74,7 +73,7 @@ private void Fill()
     {
         Array.Fill(_bar, ' ');
 
-        if (_percent.Value < 100)
+        if (CurrentPercent.Value < 100)
         {
             _bar[_leftIndex] = _progressSymbol;
             _bar[_rightIndex] = _progressSymbol;

src/Progress/Components/Pulse.cs

@@ -8,7 +8,6 @@ internal class Pulse : Component
     private readonly char[] _bar;
 
     private uint _index;
-    private Percent _percent = default!;
 
     public Pulse(uint width, char progressSymbol)
     {
@@ -21,7 +20,7 @@ public Pulse(uint width, char progressSymbol)
 
     public override Component Next(ulong availableItems, ulong currentCount)
     {
-        _percent = Calculate(availableItems, currentCount);
+        CurrentPercent = Calculate(availableItems, currentCount);
 
         _index++;
 
@@ -46,7 +45,7 @@ public override string ToString()
         if (DisplayPercent)
         {
             sBuilder.Append(' ');
-            sBuilder.Append(_percent.ToString());
+            sBuilder.Append(CurrentPercent.ToString());
         }
 
         return sBuilder.ToString();
@@ -56,7 +55,7 @@ private void Fill()
     {
         Array.Fill(_bar, ' ');
 
-        if (_percent.Value < 100)
+        if (CurrentPercent.Value < 100)
             _bar[_index] = _progressSymbol;
     }
 }

src/Progress/Components/Spinner.cs

@@ -7,13 +7,11 @@ internal class Spinner : Component
     private int _counter;
     private char _current;
 
-    private Percent _percent = default!;
-
     public bool DisplayPercent { get; init; } = true;
 
     public override Component Next(ulong availableItems, ulong currentCount)
     {
-        _percent = Calculate(availableItems, currentCount);
+        CurrentPercent = Calculate(availableItems, currentCount);
         return this;
     }
 
@@ -27,7 +25,7 @@ public override string ToString()
         if (DisplayPercent)
         {
             sBuilder.Append(' ');
-            sBuilder.Append(_percent.ToString());
+            sBuilder.Append(CurrentPercent.ToString());
         }
 
         return sBuilder.ToString();

src/Progress/Content/README.md

@@ -9,6 +9,8 @@ Report progression with ease by using multilple components such as Bars, Spinner
 using var reporter = new ReporterBuilder()
     .DisplayingStartingTime()
     .DisplayingElapsedTime()
+    .DisplayingTimeOfArrival()
+    .DisplayingRemainingTime()
     .DisplayingItemsSummary()
     .DisplayingItemsOverview()
     .UsingReportingFrequency(TimeSpan.FromMilliseconds(50))
@@ -43,10 +45,12 @@ var descriptor = BarDescriptor.Default;
 var reporter = new ReporterBuilder()
     .DisplayingStartingTime()
     .DisplayingElapsedTime()
+    .DisplayingTimeOfArrival()
+    .DisplayingRemainingTime()
     .DisplayingItemsSummary()
     .DisplayingItemsOverview()
     .UsingReportingFrequency(TimeSpan.FromMilliseconds(50))
-    .UsingComponentDescriptor(descriptor)
+    .UsingComponentDescriptor(BarDescriptor.Default)
     .Build(Worker.AllItems);
 ```
 
@@ -55,6 +59,16 @@ var reporter = new ReporterBuilder()
 reporter.Start();
 ```
 
+### Stop the reporter
+```csharp
+reporter.Stop();
+```
+
+### Resume the reporter
+```csharp
+reporter.Resume();
+```
+
 ### Report progress
 ```csharp
 reporter.ReportSuccess()

src/Progress/Progress.csproj

@@ -9,7 +9,7 @@
 
 	<PropertyGroup>
 		<PackageId>Progress</PackageId>
-		<Version>1.1.0</Version>
+		<Version>1.2.0</Version>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<Authors>Gerard Castello</Authors>
 		<Title>Report progress with ease</Title>