Add contract to DI container (#9)

szvsky · web-flow · commit 9bf9d0fa7dfe · 2024-11-18T07:32:56.000+01:00
diff --git a/packages/Contracts/DI/Container.php b/packages/Contracts/DI/Container.php
@@ -9,11 +9,11 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-namespace Aether\DI;
+namespace Aether\Contracts\DI;
 
 use Psr\Container\ContainerInterface as BaseContainerInterface;
 
-interface ContainerInterface extends BaseContainerInterface, FactoryInterface, InvokerInterface
+interface Container extends BaseContainerInterface, Factory, Invoker
 {
     /**
      * Returns an entry of the container by its id.
diff --git a/packages/Contracts/DI/Exception/ContainerException.php b/packages/Contracts/DI/Exception/ContainerException.php
@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-namespace Aether\DI\Exception;
+namespace Aether\Contracts\DI\Exception;
 
 use Psr\Container\ContainerExceptionInterface;
 
diff --git a/packages/Contracts/DI/Exception/EntryNotFoundException.php b/packages/Contracts/DI/Exception/EntryNotFoundException.php
@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-namespace Aether\DI\Exception;
+namespace Aether\Contracts\DI\Exception;
 
 use Psr\Container\NotFoundExceptionInterface;
 
diff --git a/packages/Contracts/DI/Exception/ResolvingException.php b/packages/Contracts/DI/Exception/ResolvingException.php
@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-namespace Aether\DI\Exception;
+namespace Aether\Contracts\DI\Exception;
 
 class ResolvingException extends ContainerException
 {
diff --git a/packages/Contracts/DI/Exception/RuntimeException.php b/packages/Contracts/DI/Exception/RuntimeException.php
@@ -9,7 +9,7 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-namespace Aether\DI\Exception;
+namespace Aether\Contracts\DI\Exception;
 
 class RuntimeException extends \RuntimeException
 {
diff --git a/packages/Contracts/DI/Factory.php b/packages/Contracts/DI/Factory.php
@@ -9,9 +9,9 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-namespace Aether\DI;
+namespace Aether\Contracts\DI;
 
-interface FactoryInterface
+interface Factory
 {
     /**
      * Initializes a new instance of requested class using binding and set of parameters.
@@ -24,7 +24,7 @@ interface FactoryInterface
      * @return ($abstract is class-string ? T : int|float|string|callable|object|null)
      *
      * @throws \Aether\DI\Definition\Exception\CircularDependencyException
-     * @throws \Aether\DI\Exception\EntryNotFoundException
+     * @throws \Aether\Contracts\DI\Exception\EntryNotFoundException
      *
      * @template T of object
      */
diff --git a/packages/Contracts/DI/Invoker.php b/packages/Contracts/DI/Invoker.php
@@ -9,9 +9,9 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-namespace Aether\DI;
+namespace Aether\Contracts\DI;
 
-interface InvokerInterface
+interface Invoker
 {
     /**
      * Calls the given function using the given parameters. Missing parameters will be resolved from the container.
diff --git a/packages/DI/src/Container.php b/packages/DI/src/Container.php
@@ -11,6 +11,19 @@
 
 namespace Aether\DI;
 
+use Aether\Contracts\DI\Container as ContainerContract;
+use Aether\Contracts\DI\Exception\EntryNotFoundException;
+use Aether\Contracts\DI\Factory as FactoryContract;
+use Aether\Contracts\DI\Invoker as InvokerContract;
+use Aether\DI\Definition\Binding\Alias;
+use Aether\DI\Definition\Binding\Factory;
+use Aether\DI\Definition\Binding\Scalar;
+use Aether\DI\Definition\Binding\Shared;
+use Aether\DI\Definition\Binding\WeakReference;
+use Aether\DI\Definition\Exception\CircularDependencyException;
+use Aether\DI\Definition\Resolver\DefinitionResolver;
+use Aether\DI\Definition\State;
+
 use function array_key_exists;
 
 use Closure;
@@ -22,36 +35,23 @@
 use function is_string;
 use function property_exists;
 
-use Aether\DI\Definition\Binding\Alias;
-use Aether\DI\Definition\Binding\Factory;
-use Aether\DI\Definition\Binding\Scalar;
-use Aether\DI\Definition\Binding\Shared;
-use Aether\DI\Definition\Binding\WeakReference;
-
-use Aether\DI\Definition\Exception\CircularDependencyException;
-use Aether\DI\Definition\Resolver\DefinitionResolver;
-use Aether\DI\Definition\State;
-use Aether\DI\Exception\EntryNotFoundException;
-use Aether\DI\Invoker\Invoker;
-
-class Container implements ContainerInterface
+class Container implements ContainerContract
 {
     private State $state;
-    private FactoryInterface $factory;
+    private FactoryContract $factory;
 
     public function __construct()
     {
-
         $this->state = new State();
         $this->factory = new DefinitionResolver($this->state, $this);
 
         $shared = new Alias(self::class);
 
         $this->state->bindings = [
             self::class => new WeakReference(\WeakReference::create($this)),
-            ContainerInterface::class => $shared,
-            FactoryInterface::class => $shared,
-            InvokerInterface::class => $shared
+            ContainerContract::class => $shared,
+            Factory::class => $shared,
+            Invoker::class => $shared,
         ];
     }
 
@@ -85,6 +85,7 @@ public function get(string $id): int|float|string|callable|object
     public function instance(string $id, int|float|string|callable|object $instance): int|float|string|callable|object
     {
         $this->state->instances[$id] = $instance;
+
         return $instance;
     }
 
@@ -147,7 +148,7 @@ public function call(callable|array|string $callable, array $parameters = []): m
         return $this->getInvoker()->call($callable, $parameters);
     }
 
-    private function getInvoker(): InvokerInterface
+    private function getInvoker(): InvokerContract
     {
         return new Invoker($this);
     }
diff --git a/packages/DI/src/Definition/Binding/Factory.php b/packages/DI/src/Definition/Binding/Factory.php
@@ -11,8 +11,8 @@
 
 namespace Aether\DI\Definition\Binding;
 
-use Closure;
 use Aether\DI\Definition\Definition;
+use Closure;
 
 final readonly class Factory implements Definition
 {
diff --git a/packages/DI/src/Definition/Exception/CircularDependencyException.php b/packages/DI/src/Definition/Exception/CircularDependencyException.php
@@ -11,7 +11,7 @@
 
 namespace Aether\DI\Definition\Exception;
 
-use Aether\DI\Exception\ContainerException;
+use Aether\Contracts\DI\Exception\ContainerException;
 
 class CircularDependencyException extends ContainerException
 {
diff --git a/packages/DI/src/Definition/Exception/DependencyException.php b/packages/DI/src/Definition/Exception/DependencyException.php
@@ -11,7 +11,7 @@
 
 namespace Aether\DI\Definition\Exception;
 
-use Aether\DI\Exception\ContainerException;
+use Aether\Contracts\DI\Exception\ContainerException;
 
 class DependencyException extends ContainerException
 {
diff --git a/packages/DI/src/Definition/Resolver/DefinitionResolver.php b/packages/DI/src/Definition/Resolver/DefinitionResolver.php
@@ -11,41 +11,41 @@
 
 namespace Aether\DI\Definition\Resolver;
 
-use function array_key_exists;
-use function class_exists;
-use function interface_exists;
-
-use ReflectionClass;
-use Aether\DI\ContainerInterface;
+use Aether\Contracts\DI\Container;
+use Aether\Contracts\DI\Exception\ContainerException;
+use Aether\Contracts\DI\Exception\EntryNotFoundException;
+use Aether\Contracts\DI\Factory;
 use Aether\DI\Definition\Binding\Alias;
 use Aether\DI\Definition\Binding\Factory as FactoryBinding;
 use Aether\DI\Definition\Binding\WeakReference;
 use Aether\DI\Definition\Exception\CircularDependencyException;
 use Aether\DI\Definition\State;
 
-use Aether\DI\Exception\ContainerException;
-use Aether\DI\Exception\EntryNotFoundException;
-use Aether\DI\FactoryInterface;
+use function array_key_exists;
+use function class_exists;
+use function interface_exists;
+
+use ReflectionClass;
 
-final class DefinitionResolver implements FactoryInterface
+final class DefinitionResolver implements Factory
 {
     /**
      * The stack of concrete currently being built.
      *
-     * @var array<string, bool> $buildStack
+     * @var array<string, bool>
      */
     private array $buildStack = [];
 
     /**
      * The parameter resolver.
      *
-     * @var \Aether\DI\Definition\Resolver\ParameterResolverInterface $parameterResolver
+     * @var \Aether\DI\Definition\Resolver\ParameterResolverInterface
      */
     private ParameterResolverInterface $parameterResolver;
 
     public function __construct(
         private readonly State $state,
-        private readonly ContainerInterface $container
+        private readonly Container $container
     ) {
         $this->parameterResolver = new ParameterResolver($this->container);
     }
@@ -84,7 +84,7 @@ public function make(string $abstract, array $parameters = []): int|float|string
             return $concrete->value->get();
         }
 
-        if (!\property_exists($concrete, 'value')) {
+        if (! \property_exists($concrete, 'value')) {
             return null;
         }
 
@@ -112,13 +112,13 @@ private function autowire(string $abstract, array $parameters = []): object
             );
         }
 
-        if (!(class_exists($abstract) || interface_exists($abstract))) {
+        if (! (class_exists($abstract) || interface_exists($abstract))) {
             throw new EntryNotFoundException($abstract);
         }
 
         $reflection = new ReflectionClass($abstract);
 
-        if (!$reflection->isInstantiable()) {
+        if (! $reflection->isInstantiable()) {
             throw new ContainerException(
                 "$abstract is not instantiable."
             );
diff --git a/packages/DI/src/Definition/Resolver/ParameterResolver.php b/packages/DI/src/Definition/Resolver/ParameterResolver.php
@@ -11,17 +11,17 @@
 
 namespace Aether\DI\Definition\Resolver;
 
+use Aether\Contracts\DI\Container;
+use Aether\DI\Definition\Exception\DependencyException;
+
 use function array_key_exists;
 
 use ReflectionFunctionAbstract;
-use Aether\DI\ContainerInterface;
-
-use Aether\DI\Definition\Exception\DependencyException;
 
 final class ParameterResolver implements ParameterResolverInterface
 {
     public function __construct(
-        private readonly ContainerInterface $container
+        private readonly Container $container
     ) {
     }
 
@@ -44,11 +44,12 @@ public function resolveParameters(
 
             if (array_key_exists($parameter->getName(), $parameters)) {
                 $arguments[] = $parameters[$parameter->getName()];
-            } elseif ($type !== null && !$type->isBuiltin()) {
+            } elseif ($type !== null && ! $type->isBuiltin()) {
                 $arguments[] = $this->container->make($type->getName(), $parameters);
             } else {
                 if ($parameter->isDefaultValueAvailable() || $parameter->isOptional()) {
                     $arguments[] = $parameter->getDefaultValue();
+
                     continue;
                 }
 
diff --git a/packages/DI/src/Definition/State.php b/packages/DI/src/Definition/State.php
@@ -16,14 +16,14 @@ final class State
     /**
      * The bindings.
      *
-     * @var array<string, \Aether\DI\Definition\Definition> $bindings
+     * @var array<string, \Aether\DI\Definition\Definition>
      */
     public array $bindings = [];
 
     /**
      * The shared instances.
      *
-     * @var array<string, int|float|string|callable|object> $instances
+     * @var array<string, int|float|string|callable|object>
      */
     public array $instances = [];
 }
diff --git a/packages/DI/src/Invoker.php b/packages/DI/src/Invoker.php
@@ -9,8 +9,14 @@
  * of the MIT license. See the LICENSE file for details.
  */
 
-namespace Aether\DI\Invoker;
+namespace Aether\DI;
 
+use Aether\Contracts\DI\Container;
+use Aether\Contracts\DI\Exception\ContainerException;
+use Aether\Contracts\DI\Exception\RuntimeException;
+use Aether\Contracts\DI\Invoker as InvokerContract;
+use Aether\DI\Definition\Resolver\ParameterResolver;
+use Aether\DI\Definition\Resolver\ParameterResolverInterface;
 use Closure;
 
 use function is_array;
@@ -20,20 +26,13 @@
 use ReflectionException;
 use ReflectionFunction;
 use ReflectionMethod;
-use Aether\DI\ContainerInterface;
-use Aether\DI\Definition\Resolver\ParameterResolver;
-use Aether\DI\Definition\Resolver\ParameterResolverInterface;
-
-use Aether\DI\Exception\ContainerException;
-use Aether\DI\Exception\RuntimeException;
-use Aether\DI\InvokerInterface;
 
-final class Invoker implements InvokerInterface
+final class Invoker implements InvokerContract
 {
     private readonly ParameterResolverInterface $resolver;
 
     public function __construct(
-        private readonly ContainerInterface $container
+        private readonly Container $container
     ) {
         $this->resolver = new ParameterResolver($container);
     }
@@ -44,7 +43,7 @@ public function __construct(
     public function call(callable|array|string $callable, array $parameters = []): mixed
     {
         if (is_array($callable)) {
-            if (!isset($callable[1])) {
+            if (! isset($callable[1])) {
                 $callable[1] = '__invoke';
             }
 
diff --git a/packages/DI/tests/ContainerTest.php b/packages/DI/tests/ContainerTest.php
@@ -11,17 +11,16 @@
 
 namespace Aether\Tests\DI;
 
-use PHPUnit\Framework\Attributes\CoversClass;
-use PHPUnit\Framework\TestCase;
 use Aether\DI\Container;
-use Aether\DI\ContainerInterface;
 use Aether\DI\Definition\Binding\Alias;
 use Aether\DI\Definition\Binding\Factory;
 use Aether\DI\Definition\Binding\Shared;
 use Aether\DI\Definition\Resolver\DefinitionResolver;
 use Aether\DI\Definition\Resolver\ParameterResolver;
 use Aether\Tests\DI\Fixtures\SampleClass;
 use Aether\Tests\DI\Fixtures\SampleInterface;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
 
 #[CoversClass(Alias::class)]
 #[CoversClass(Factory::class)]
@@ -32,7 +31,7 @@
 class ContainerTest extends TestCase
 {
     /** @psalm-suppress PropertyNotSetInConstructor */
-    private ContainerInterface $container;
+    private Container $container;
 
     public function setUp(): void
     {
diff --git a/packages/DI/tests/Definition/Resolver/DefinitionResolverTest.php b/packages/DI/tests/Definition/Resolver/DefinitionResolverTest.php
diff --git a/packages/DI/tests/Definition/Resolver/ParameterResolverTest.php b/packages/DI/tests/Definition/Resolver/ParameterResolverTest.php
diff --git a/packages/DI/tests/InvokerTest.php b/packages/DI/tests/InvokerTest.php
diff --git a/packages/Events/tests/EventDispatcherTest.php b/packages/Events/tests/EventDispatcherTest.php

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`* of the MIT license. See the LICENSE file for details.`
`10`	`10`	`*/`
`11`	`11`
`12`		`-namespace Aether\DI\Exception;`
	`12`	`+namespace Aether\Contracts\DI\Exception;`
`13`	`13`
`14`	`14`	`class ResolvingException extends ContainerException`
`15`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,9 @@`
`9`	`9`	`* of the MIT license. See the LICENSE file for details.`
`10`	`10`	`*/`
`11`	`11`
`12`		`-namespace Aether\DI;`
	`12`	`+namespace Aether\Contracts\DI;`
`13`	`13`
`14`		`-interface FactoryInterface`
	`14`	`+interface Factory`
`15`	`15`	`{`
`16`	`16`	`/**`
`17`	`17`	`* Initializes a new instance of requested class using binding and set of parameters.`
`@@ -24,7 +24,7 @@ interface FactoryInterface`
`24`	`24`	`* @return ($abstract is class-string ? T : int\|float\|string\|callable\|object\|null)`
`25`	`25`	`*`
`26`	`26`	`* @throws \Aether\DI\Definition\Exception\CircularDependencyException`
`27`		`- * @throws \Aether\DI\Exception\EntryNotFoundException`
	`27`	`+ * @throws \Aether\Contracts\DI\Exception\EntryNotFoundException`
`28`	`28`	`*`
`29`	`29`	`* @template T of object`
`30`	`30`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Aether\DI\Definition\Binding;`
`13`	`13`
`14`		`-use Closure;`
`15`	`14`	`use Aether\DI\Definition\Definition;`
	`15`	`+use Closure;`
`16`	`16`
`17`	`17`	`final readonly class Factory implements Definition`
`18`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Aether\DI\Definition\Exception;`
`13`	`13`
`14`		`-use Aether\DI\Exception\ContainerException;`
	`14`	`+use Aether\Contracts\DI\Exception\ContainerException;`
`15`	`15`
`16`	`16`	`class CircularDependencyException extends ContainerException`
`17`	`17`	`{`