Improve Snapshot comparison

Author: nyamsprod

CHANGELOG.md

@@ -26,6 +26,7 @@ All Notable changes to `bakame/stackwatch` will be documented in this file.
 - Added `Profiler::dump` and its global function counterpart `pfd` to profile, dump a human-readable result into the output stream and die.
 - Added `forHuman()` method to return a human-readable version of `toArray`
 - Added `human()` method to return the human-redable version of a single property.
+- Added Snapshot relation method `compareTo` and its aliases `isBefore*` `isAfter*` and `isAtSameTime` using the `Snapshot::hrtime` property
 
 ### Fixed
 

src/Exporter/StatsExporter.php

@@ -13,6 +13,7 @@
 use Bakame\Stackwatch\Result;
 use Bakame\Stackwatch\Snapshot;
 use Bakame\Stackwatch\Span;
+use Bakame\Stackwatch\Statistics;
 use Bakame\Stackwatch\Translator;
 
 use function array_keys;
@@ -52,18 +53,6 @@ public function writeln(string $content): int|false
         return fwrite($this->stream, $content."\n");
     }
 
-    public function exportMetrics(Result|Span|Metrics $metrics): void
-    {
-        /** @var Metrics $source */
-        $source = match ($metrics::class) {
-            Result::class => $metrics->span->metrics,
-            Span::class => $metrics->metrics,
-            Metrics::class => $metrics,
-        };
-
-        $this->writeLeaderPrinter($source->toHuman());
-    }
-
     /**
      * @param array<string, string> $data
      */
@@ -79,11 +68,28 @@ public function exportSnapshots(Snapshot $snapshot): void
         $this->writeLeaderPrinter($snapshot->toHuman());
     }
 
-    public function exportEnvironement(Environment $environment): void
+    public function exportMetrics(Result|Span|Metrics $metrics): void
+    {
+        /** @var Metrics $source */
+        $source = match ($metrics::class) {
+            Result::class => $metrics->span->metrics,
+            Span::class => $metrics->metrics,
+            Metrics::class => $metrics,
+        };
+
+        $this->writeLeaderPrinter($source->toHuman());
+    }
+
+    public function exportEnvironment(Environment $environment): void
     {
         $this->writeLeaderPrinter($environment->toHuman());
     }
 
+    public function exportStatistics(Statistics $statistics): void
+    {
+        $this->writeLeaderPrinter($statistics->toHuman());
+    }
+
     public function exportReport(Report $report): void
     {
         $reportData = $report->toHuman();

src/Metrics.php

@@ -68,11 +68,11 @@ public static function none(): self
 
     public static function fromSnapshots(Snapshot $start, Snapshot $end): self
     {
-        ($excutionTime = $end->hrtime - $start->hrtime) >= 0 || throw new UnableToProfile('The ending snapshot was taken before the starting snapshot.');
+        $start->isBeforeOrAtSameTime($end) || throw new UnableToProfile('The ending snapshot was taken before the starting snapshot.');
 
         return new self(
             cpuTime: $end->cpuUserTime + $end->cpuSystemTime - $start->cpuUserTime - $start->cpuSystemTime,
-            executionTime: $excutionTime,
+            executionTime: $end->hrtime - $start->hrtime,
             memoryUsage: $end->memoryUsage - $start->memoryUsage,
             peakMemoryUsage: $end->peakMemoryUsage - $start->peakMemoryUsage,
             realMemoryUsage: $end->realMemoryUsage - $start->realMemoryUsage,

src/Snapshot.php

@@ -200,6 +200,36 @@ public function equals(mixed $other): bool
             && $this->originLine === $other->originLine;
     }
 
+    public function isBefore(Snapshot $other): bool
+    {
+        return -1 === $this->compareTo($other);
+    }
+
+    public function isAfter(Snapshot $other): bool
+    {
+        return 1 === $this->compareTo($other);
+    }
+
+    public function isAtSameTime(Snapshot $other): bool
+    {
+        return 0 === $this->compareTo($other);
+    }
+
+    public function isAfterOrAtSameTime(Snapshot $other): bool
+    {
+        return 0 <= $this->compareTo($other);
+    }
+
+    public function isBeforeOrAtSameTime(Snapshot $other): bool
+    {
+        return 0 >= $this->compareTo($other);
+    }
+
+    public function compareTo(Snapshot $other): int
+    {
+        return $this->hrtime <=> $other->hrtime;
+    }
+
     /**
      * @return SnapshotMap
      */

src/SnapshotTest.php

@@ -4,6 +4,7 @@
 
 namespace Bakame\Stackwatch;
 
+use DateTimeImmutable;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
@@ -103,4 +104,54 @@ public function it_fails_to_create_a_new_instance_from_an_invalid_array(): void
 
         Snapshot::fromArray([]); /* @phpstan-ignore-line */
     }
+
+    #[Test]
+    public function testCompareToAndRelations(): void
+    {
+        $a = new Snapshot(
+            'start',
+            new DateTimeImmutable(),
+            100,
+            1_500_000,
+            250_000,
+            1000,
+            2000,
+            3000,
+            4000,
+        );
+
+        $b = new Snapshot(
+            'start',
+            new DateTimeImmutable(),
+            200,
+            1_500_000,
+            250_000,
+            1000,
+            2000,
+            3000,
+            4000,
+        );
+
+        self::assertSame(-1, $a->compareTo($b));
+        self::assertTrue($a->isBefore($b));
+        self::assertFalse($a->isAfter($b));
+        self::assertFalse($a->isAtSameTime($b));
+        self::assertTrue($a->isBeforeOrAtSameTime($b));
+        self::assertFalse($a->isAfterOrAtSameTime($b));
+
+        self::assertSame(1, $b->compareTo($a));
+        self::assertTrue($b->isAfter($a));
+        self::assertFalse($b->isBefore($a));
+        self::assertFalse($b->isAtSameTime($a));
+        self::assertFalse($b->isBeforeOrAtSameTime($a));
+        self::assertTrue($b->isAfterOrAtSameTime($a));
+
+        $c = clone $a;
+        self::assertSame(0, $a->compareTo($c));
+        self::assertFalse($a->isBefore($c));
+        self::assertFalse($a->isAfter($c));
+        self::assertTrue($a->isAtSameTime($c));
+        self::assertTrue($a->isBeforeOrAtSameTime($c));
+        self::assertTrue($a->isAfterOrAtSameTime($c));
+    }
 }