Merge pull request #6 from young-steveo/separate-resolver

Separate resolver into Codex library.

src/Cabinet/Container.php

@@ -5,16 +5,18 @@
 namespace Arcanum\Cabinet;
 
 use Psr\Container\ContainerInterface;
+use Arcanum\Codex\ClassResolver;
+use Arcanum\Codex\Resolver;
 
 /**
  * @implements \ArrayAccess<class-string, mixed>
  */
 class Container implements \ArrayAccess, ContainerInterface
 {
     /**
-     * Resolver used to build classes.
+     * ClassResolver used to build classes.
      */
-    protected Resolver $resolver;
+    protected ClassResolver $resolver;
 
     /**
      * @var array<class-string, Provider>
@@ -24,7 +26,7 @@ class Container implements \ArrayAccess, ContainerInterface
     /**
      * Container uses a resolver to instantiate services.
      */
-    protected function __construct(Resolver $resolver = null)
+    protected function __construct(ClassResolver $resolver = null)
     {
         $this->resolver = $resolver ?? Resolver::forContainer($this);
     }
@@ -40,7 +42,7 @@ public static function create(): self
     /**
      * Create a new container from a resolver.
      */
-    public static function fromResolver(Resolver $resolver): self
+    public static function fromResolver(ClassResolver $resolver): self
     {
         return new self($resolver);
     }

src/Cabinet/NullProvider.php

@@ -9,7 +9,7 @@ final class NullProvider extends Provider
     /**
      * Provide null
      */
-    public function __invoke(Container $container): mixed
+    public function __invoke(Container $container): object|null
     {
         return null;
     }

src/Cabinet/PrototypeProvider.php

@@ -24,7 +24,7 @@ public static function fromFactory(\Closure $factory): static
     /**
      * Provide a service from the factory.
      */
-    public function __invoke(Container $container): mixed
+    public function __invoke(Container $container): object|null
     {
         return ($this->factory)($container);
     }

src/Cabinet/Provider.php

@@ -9,5 +9,5 @@ abstract class Provider
     /**
      * Invoking the provider should return the service.
      */
-    abstract public function __invoke(Container $container): mixed;
+    abstract public function __invoke(Container $container): object|null;
 }

src/Cabinet/SimpleProvider.php

@@ -29,7 +29,7 @@ public static function fromFactory(\Closure $factory): static
     /**
      * Provide a service from the factory.
      */
-    public function __invoke(Container $container): mixed
+    public function __invoke(Container $container): object|null
     {
         if (!isset($this->service)) {
             $this->service = ($this->factory)($container);

src/Codex/ClassResolver.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arcanum\Codex;
+
+use Psr\Container\ContainerInterface;
+
+interface ClassResolver
+{
+    /**
+     * Resolve a class.
+     *
+     * @template T of object
+     * @param class-string<T>|(callable(ContainerInterface): T) $className
+     * @return T
+     * @throws Error\UnknownClass
+     * @throws Error\UnresolvableClass
+     * @throws Error\UnresolvablePrimitive
+     * @throws Error\UnresolvableUnionType
+     */
+    public function resolve(string|callable $className, bool $isDependency = false): object;
+}

src/Cabinet/Error/UnknownClass.php → src/Codex/Error/UnknownClass.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Arcanum\Cabinet\Error;
+namespace Arcanum\Codex\Error;
 
 final class UnknownClass extends Unresolvable
 {

src/Cabinet/Error/Unresolvable.php → src/Codex/Error/Unresolvable.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Arcanum\Cabinet\Error;
+namespace Arcanum\Codex\Error;
 
 use Psr\Container\ContainerExceptionInterface;
 

src/Cabinet/Error/UnresolvableClass.php → src/Codex/Error/UnresolvableClass.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Arcanum\Cabinet\Error;
+namespace Arcanum\Codex\Error;
 
 final class UnresolvableClass extends Unresolvable
 {

src/Cabinet/Error/UnresolvablePrimitive.php → src/Codex/Error/UnresolvablePrimitive.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Arcanum\Cabinet\Error;
+namespace Arcanum\Codex\Error;
 
 final class UnresolvablePrimitive extends Unresolvable
 {

src/Cabinet/Error/UnresolvableUnionType.php → src/Codex/Error/UnresolvableUnionType.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Arcanum\Cabinet\Error;
+namespace Arcanum\Codex\Error;
 
 final class UnresolvableUnionType extends Unresolvable
 {

src/Codex/Event/ClassRequested.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arcanum\Codex\Event;
+
+final class ClassRequested extends \Arcanum\Echo\Event implements CodexEvent
+{
+    /**
+     * @param class-string $class
+     */
+    public function __construct(private string $class)
+    {
+    }
+
+    /**
+     * Get the class name.
+     *
+     * @return class-string
+     */
+    public function className(): string
+    {
+        return $this->class;
+    }
+
+    /**
+     * Get the class.
+     *
+     * Will return null if the class is not yet resolved.
+     */
+    public function class(): object|null
+    {
+        return null;
+    }
+}

src/Codex/Event/ClassResolved.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arcanum\Codex\Event;
+
+final class ClassResolved extends \Arcanum\Echo\Event implements CodexEvent
+{
+    /**
+     * @param object $class
+     */
+    public function __construct(private object $class)
+    {
+    }
+
+    /**
+     * Get the class name.
+     *
+     * @return class-string
+     */
+    public function className(): string
+    {
+        return get_class($this->class);
+    }
+
+    /**
+     * Get the class.
+     *
+     * Will return null if the class is not yet resolved.
+     */
+    public function class(): object|null
+    {
+        return $this->class;
+    }
+}

src/Codex/Event/CodexEvent.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arcanum\Codex\Event;
+
+interface CodexEvent
+{
+    /**
+     * Get the class name.
+     *
+     * @return class-string
+     */
+    public function className(): string;
+
+    /**
+     * Get the class.
+     *
+     * Will return null if the class is not yet resolved.
+     */
+    public function class(): object|null;
+}

src/Codex/EventDispatcher.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arcanum\Codex;
+
+/**
+ * If Arcanum\Codex\EventDispatcher is resolved by Codex,
+ * it will retain a reference to it and dispatch events to it.
+ */
+interface EventDispatcher extends \Psr\EventDispatcher\EventDispatcherInterface
+{
+}