make Halt return an Attempt<SideEffect>

Author: Baptouuuu

README.md

@@ -26,7 +26,7 @@ use Innmind\TimeContinuum\Period;
 function yourApp(Halt $halt): void
 {
     // do something
-    $halt(Period::minute(42));
+    $halt(Period::minute(42))->unwrap();
     // do some more
 }
 

proofs/logger.php

@@ -7,6 +7,7 @@
     Halt\Usleep,
 };
 use Innmind\TimeContinuum\Period;
+use Innmind\Immutable\SideEffect;
 use Psr\Log\NullLogger;
 
 return static function() {
@@ -22,10 +23,12 @@
 
     yield test(
         'Logger',
-        static fn($assert) => $assert->null(
-            Logger::psr(new Usleep, new NullLogger)(
-                Period::millisecond(100),
-            ),
-        ),
+        static fn($assert) => $assert
+            ->object(
+                Logger::psr(new Usleep, new NullLogger)(
+                    Period::millisecond(100),
+                )->unwrap(),
+            )
+            ->instance(SideEffect::class),
     );
 };

proofs/usleep.php

@@ -6,6 +6,7 @@
     Halt\Usleep,
 };
 use Innmind\TimeContinuum\Period;
+use Innmind\Immutable\SideEffect;
 
 return static function() {
     yield test(
@@ -19,9 +20,11 @@
         'Usleep',
         static fn($assert) => $assert
             ->time(static function() use ($assert) {
-                $assert->null(
-                    (new Usleep)(Period::millisecond(500)),
-                );
+                $assert
+                    ->object(
+                        (new Usleep)(Period::millisecond(500))->unwrap(),
+                    )
+                    ->instance(SideEffect::class);
             })
             ->inMoreThan()
             ->milliseconds(500),

src/Halt.php

@@ -4,11 +4,17 @@
 namespace Innmind\TimeWarp;
 
 use Innmind\TimeContinuum\Period;
+use Innmind\Immutable\{
+    Attempt,
+    SideEffect,
+};
 
 interface Halt
 {
     /**
      * Halt the program for the given period
+     *
+     * @return Attempt<SideEffect>
      */
-    public function __invoke(Period $period): void;
+    public function __invoke(Period $period): Attempt;
 }

src/Halt/Logger.php

@@ -5,6 +5,7 @@
 
 use Innmind\TimeWarp\Halt;
 use Innmind\TimeContinuum\Period;
+use Innmind\Immutable\Attempt;
 use Psr\Log\LoggerInterface;
 
 final class Logger implements Halt
@@ -19,7 +20,7 @@ private function __construct(Halt $halt, LoggerInterface $logger)
     }
 
     #[\Override]
-    public function __invoke(Period $period): void
+    public function __invoke(Period $period): Attempt
     {
         $this->logger->debug('Halting current process...', ['period' => [
             'years' => $period->years(),
@@ -30,7 +31,8 @@ public function __invoke(Period $period): void
             'seconds' => $period->seconds(),
             'milliseconds' => $period->milliseconds(),
         ]]);
-        ($this->halt)($period);
+
+        return ($this->halt)($period);
     }
 
     public static function psr(Halt $halt, LoggerInterface $logger): self

src/Halt/Usleep.php

@@ -8,6 +8,10 @@
     PeriodToMilliseconds,
 };
 use Innmind\TimeContinuum\Period;
+use Innmind\Immutable\{
+    Attempt,
+    SideEffect,
+};
 
 final class Usleep implements Halt
 {
@@ -19,9 +23,11 @@ public function __construct()
     }
 
     #[\Override]
-    public function __invoke(Period $period): void
+    public function __invoke(Period $period): Attempt
     {
         /** @psalm-suppress ArgumentTypeCoercion todo update types to fix this error */
         \usleep(($this->periodToMilliseconds)($period) * 1000);
+
+        return Attempt::result(SideEffect::identity());
     }
 }