wip

Author: devajmeireles

src/Concerns/ShareableInterpreter.php

@@ -21,6 +21,9 @@ public function __construct(
         // ...
     }
 
+    /**
+     * Resolve the dependencies for the action.
+     */
     final public function dependencies(Container $container): DependencyResolver
     {
         return $container->make(DependencyResolver::class, [
@@ -29,13 +32,17 @@ final public function dependencies(Container $container): DependencyResolver
         ]);
     }
 
+    /** {@inheritDoc} */
     final public function then(array $then): self
     {
         $this->then = $then;
 
         return $this;
     }
 
+    /**
+     * Run the hooks after the action is handled.
+     */
     final public function hooks(): void
     {
         if ($this->then === []) {

src/Configurable/DeferUsing.php

@@ -15,6 +15,7 @@ public function __construct(
         //
     }
 
+    /** {@inheritDoc} */
     public function toArray(): array
     {
         return [

src/Configurable/QueueUsing.php

@@ -16,6 +16,7 @@ public function __construct(
         //
     }
 
+    /** {@inheritDoc} */
     public function toArray(): array
     {
         return [

src/Contracts/Configurable.php

@@ -6,5 +6,8 @@
 
 interface Configurable
 {
+    /**
+     * Configure the interpreter with the given data.
+     */
     public function configure(array $data): void;
 }

src/Contracts/ShouldInterpreter.php

@@ -8,7 +8,13 @@
 
 interface ShouldInterpreter
 {
+    /**
+     * Handle the action.
+     */
     public function handle(Container $container): mixed;
 
+    /**
+     * Register the action's hooks.
+     */
     public function then(array $then): self;
 }

src/FractionBuilder.php

@@ -23,10 +23,21 @@
 
 final class FractionBuilder implements Arrayable
 {
+    /**
+     * The array of "then" hooks.
+     *
+     * @var array<int, string>
+     */
     private array $then = [];
 
+    /**
+     * Configuration for queueing the action.
+     */
     private ?QueueUsing $queued = null;
 
+    /**
+     * Configuration for deferring the action.
+     */
     private ?DeferUsing $deferred = null;
 
     public function __construct(
@@ -37,7 +48,10 @@ public function __construct(
         // ...
     }
 
-    /** @throws BindingResolutionException|InvalidArgumentException|PreventDeferQueueSameTime
+    /**
+     * Run the action.
+     *
+     * @throws BindingResolutionException|InvalidArgumentException|PreventDeferQueueSameTime
      */
     public function __invoke(...$arguments): mixed
     {
@@ -73,13 +87,21 @@ public function __invoke(...$arguments): mixed
         return $result;
     }
 
+    /**
+     * Register a "then" hook.
+     */
     public function then(string|UnitEnum $action): self
     {
         $this->then[] = new Then($this->action, $action);
 
         return $this;
     }
 
+    /**
+     * Enable the action to be queued.
+     *
+     * @return $this
+     */
     public function queued(
         mixed $delay = null,
         ?string $queue = null,
@@ -90,6 +112,11 @@ public function queued(
         return $this;
     }
 
+    /**
+     * Enable the action to be deferred.
+     *
+     * @return $this
+     */
     public function deferred(
         bool $always = false,
         ?string $name = null,
@@ -99,6 +126,7 @@ public function deferred(
         return $this;
     }
 
+    /** {@inheritDoc} */
     public function toArray(): array
     {
         return [

src/FractionManager.php

@@ -21,6 +21,8 @@ public function __construct(public Application $application)
     }
 
     /**
+     * Register a new action.
+     *
      * @throws UnallowedActionDuplication
      */
     public function register(string|UnitEnum $action, Closure $closure): FractionBuilder
@@ -41,6 +43,8 @@ public function register(string|UnitEnum $action, Closure $closure): FractionBui
     }
 
     /**
+     * Get the action by its name.
+     *
      * @throws ActionNotRegistered
      */
     public function get(string|UnitEnum $action): mixed
@@ -52,6 +56,9 @@ public function get(string|UnitEnum $action): mixed
         return $this->fractions[$action] ?? throw new ActionNotRegistered($original);
     }
 
+    /**
+     * Bootstrap the actions.
+     */
     public function boot(): void
     {
         $cached = [];

src/Interpreters/AsDefault.php

@@ -7,14 +7,11 @@
 use Fraction\Concerns\ShareableInterpreter;
 use Fraction\Contracts\ShouldInterpreter;
 use Illuminate\Container\Container;
-use Illuminate\Contracts\Container\BindingResolutionException;
-use ReflectionException;
 
 final class AsDefault implements ShouldInterpreter
 {
     use ShareableInterpreter;
 
-    /** @throws ReflectionException|BindingResolutionException */
     public function handle(Container $container): mixed
     {
         $result = $this->dependencies($container)->resolve($this->closure, $this->arguments);

src/Jobs/FractionJob.php

@@ -4,6 +4,7 @@
 
 namespace Fraction\Jobs;
 
+use Fraction\Exceptions\DependencyUnresolvable;
 use Fraction\Support\DependencyResolver;
 use Fraction\ValueObjects\Then;
 use Illuminate\Container\Container;
@@ -26,7 +27,11 @@ public function __construct(
         // ...
     }
 
-    /** @throws ReflectionException|BindingResolutionException */
+    /**
+     * Handle the job.
+     *
+     * @throws ReflectionException|BindingResolutionException|DependencyUnresolvable
+     */
     public function handle(Container $application): void
     {
         $application->make(DependencyResolver::class, [

src/Support/DependencyResolver.php

@@ -25,7 +25,7 @@ public function __construct(
     }
 
     /**
-     * //
+     * Resolve the dependencies of a closure or serializable closure.
      *
      * @throws ReflectionException|BindingResolutionException|DependencyUnresolvable
      */