QA: code cleanup (#5)

ghostwriter · May 9, 2022 · 824e29e · 824e29e
2 parents 674cdfd + 7a2d41d
commit 824e29e
Show file tree

Hide file tree

Showing 8 changed files with 80 additions and 67 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 [![Latest Version on Packagist](https://badgen.net/packagist/v/ghostwriter/container)](https://packagist.org/packages/ghostwriter/container)
 [![Downloads](https://badgen.net/packagist/dt/ghostwriter/container?color=blue)](https://packagist.org/packages/ghostwriter/container)
 
-Provides an extensible [PSR-11](https://www.php-fig.org/psr/psr-11/), dependency injection service container.
+Provides an extensible [PSR-11](https://www.php-fig.org/psr/psr-11/), Dependency Injection Service Container for Automated Object Composition, Interception, and Lifetime Management.
 
 ## Installation
 

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "ghostwriter/container",
-    "description": "Provides a PSR-11, Dependency Injection Service Container",
+    "description": "Provides an extensible PSR-11, Dependency Injection Service Container for Automated Object Composition, Interception, and Lifetime Management.",
     "license": "BSD-3-Clause",
     "type": "library",
     "keywords": [

diff --git a/composer.lock b/composer.lock
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -2,7 +2,7 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
          bootstrap="vendor/autoload.php"
-         cacheResultFile=".phpunit.cache/test-results"
+         cacheResultFile=".cache/phpunit/test-results"
          executionOrder="depends,defects"
          forceCoversAnnotation="true"
          beStrictAboutCoversAnnotation="true"
@@ -12,13 +12,14 @@
          failOnWarning="true"
          colors="true"
          stopOnFailure="true"
+         testdox="true"
          verbose="true">
     <testsuites>
         <testsuite name="Unit">
             <directory>tests/Unit</directory>
         </testsuite>
     </testsuites>
-    <coverage cacheDirectory=".phpunit.cache/code-coverage"
+    <coverage cacheDirectory=".cache/phpunit/code-coverage"
               processUncoveredFiles="true">
         <include>
             <directory suffix=".php">src</directory>

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,2 +1,2 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.22.0@fc2c6ab4d5fa5d644d8617089f012f3bb84b8703"/>
+<files psalm-version="4.23.0@f1fe6ff483bf325c803df9f510d09a03fd796f88"/>
diff --git a/src/Container.php b/src/Container.php
@@ -41,7 +41,7 @@ final class Container implements ContainerInterface
      *     providers: array<string,ServiceProviderInterface>,
      *     services: array<string,callable|null|object|scalar>,
      *     tags: array<string,array<string>>,
-     * } $services
+     * }
      */
     private array $services = self::DEFAULT_SERVICES;
 
@@ -230,9 +230,9 @@ public function extend(string $class, callable $extension): void
 
         $this->services[self::EXTENSIONS][$class] = array_key_exists($class, $extensions) ?
             static fn (ContainerInterface $container, object $service): object =>
-                $extension($container, $extensions[$class]($container, $service)) :
+            $extension($container, $extensions[$class]($container, $service)) :
             static fn (ContainerInterface $container, object $service): object =>
-                $extension($container, $service);
+            $extension($container, $service);
     }
 
     public function get(string $id): mixed
@@ -417,6 +417,9 @@ public function tag(string $id, iterable $tags): void
         $this->services[self::TAGS] = $serviceTags;
     }
 
+    /**
+     * @return iterable<string>
+     */
     public function tagged(string $tag): iterable
     {
         yield from $this->services[self::TAGS][$tag] ?? [];

diff --git a/src/Contract/ContainerInterface.php b/src/Contract/ContainerInterface.php
@@ -17,6 +17,7 @@
 use Psr\Container\ContainerInterface as PsrContainerInterface;
 use Psr\Container\NotFoundExceptionInterface as PsrNotFoundExceptionInterface;
 use ReflectionException;
+use Throwable;
 
 /**
  * An extendable, closure based dependency injection container.
@@ -87,7 +88,7 @@ interface ContainerInterface extends ArrayAccess, PsrContainerInterface
     public const TAGS = 'tags';
 
     /**
-     * Destroy the "static" instance of this container.
+     * Remove all registered services from this container and reset the default services.
      */
     public function __destruct();
 
@@ -219,13 +220,18 @@ public function has(string $id): bool;
      * @param array<string,mixed> $arguments optional arguments passed to $callback
      *
      * @throws ReflectionException
+     * @throws Throwable
      */
     public function invoke(callable $callback, array $arguments = []): mixed;
 
     /** @param string $offset */
     public function offsetExists(mixed $offset): bool;
 
-    /** @param string $offset */
+    /**
+     * @param string $offset
+     *
+     * @throws Throwable
+     */
     public function offsetGet(mixed $offset): mixed;
 
     /** @param string $offset */

diff --git a/tests/Unit/ContainerTest.php b/tests/Unit/ContainerTest.php
@@ -162,10 +162,7 @@ static function (Container $container): void {
             InvalidArgumentException::class,
             InvalidArgumentException::emptyServiceId()->getMessage(),
             static function (Container $container): void {
-                $container->extend(
-                    '',
-                    static fn (Container $container): Container => $container
-                );
+                $container->extend('', static fn (Container $container): Container => $container);
             },
         ];
 
@@ -561,37 +558,6 @@ public function testContainerBuild(string $class, array $arguments = []): void
         }
     }
 
-    /**
-     * @covers \Ghostwriter\Container\Container::__construct
-     * @covers \Ghostwriter\Container\Container::__destruct
-     * @covers \Ghostwriter\Container\Container::invoke
-     * @covers \Ghostwriter\Container\Container::get
-     * @covers \Ghostwriter\Container\Container::getInstance
-     * @covers \Ghostwriter\Container\Container::resolve
-     * @covers \Ghostwriter\Container\Container::set
-     *
-     * @dataProvider dataProviderContainerCallables
-     *
-     * @param callable():void|string|TestEventListener|class-string<TestEventListener>[]|TestEventListener[]|string[] $callback
-     * @param array<class-string|string, mixed> $arguments
-     *
-     * @throws Throwable
-     */
-    public function testContainerCall(callable $callback, array $arguments = []): void
-    {
-        $this->container->set(TestEvent::class, $arguments['event'] ?? new TestEvent());
-        $actual = random_int(10, 50);
-
-        $expectedCount = $actual;
-
-        while ($actual) {
-            $this->container->invoke($callback, $arguments);
-            --$actual;
-        }
-
-        self::assertCount($expectedCount, $this->container->get(TestEvent::class)->all());
-    }
-
     /**
      * @covers \Ghostwriter\Container\Container::__construct
      * @covers \Ghostwriter\Container\Container::__destruct
@@ -745,6 +711,37 @@ public function testContainerImplementsPsrContainerInterface(): void
         self::assertInstanceOf(Container::class, $this->container);
     }
 
+    /**
+     * @covers \Ghostwriter\Container\Container::__construct
+     * @covers \Ghostwriter\Container\Container::__destruct
+     * @covers \Ghostwriter\Container\Container::invoke
+     * @covers \Ghostwriter\Container\Container::get
+     * @covers \Ghostwriter\Container\Container::getInstance
+     * @covers \Ghostwriter\Container\Container::resolve
+     * @covers \Ghostwriter\Container\Container::set
+     *
+     * @dataProvider dataProviderContainerCallables
+     *
+     * @param callable():void|string|TestEventListener|class-string<TestEventListener>[]|TestEventListener[]|string[] $callback
+     * @param array<class-string|string, mixed> $arguments
+     *
+     * @throws Throwable
+     */
+    public function testContainerInvoke(callable|string|TestEventListener|array $callback, array $arguments = []): void
+    {
+        $this->container->set(TestEvent::class, $arguments['event'] ?? new TestEvent());
+        $actual = random_int(10, 50);
+
+        $expectedCount = $actual;
+
+        while ($actual) {
+            $this->container->invoke($callback, $arguments);
+            --$actual;
+        }
+
+        self::assertCount($expectedCount, $this->container->get(TestEvent::class)->all());
+    }
+
     /**
      * @covers \Ghostwriter\Container\Container::__destruct
      * @covers \Ghostwriter\Container\Container::add
@@ -813,16 +810,19 @@ public function testContainerRemove(): void
      * @covers \Ghostwriter\Container\Container::set
      * @dataProvider dataProviderServices
      *
-     * @param bool|Closure():null|float|int|stdClass|string|string|string[] $value
-     * @param bool|float|int|stdClass|string|string[]                       $expected
+     * @param bool|Closure():null|float|int|stdClass|string|string[] $value
+     * @param null|bool|float|int|stdClass|string|string[]           $expected
      *
      * @throws PsrNotFoundExceptionInterface
      * @throws ContainerExceptionInterface
      * @throws NotFoundExceptionInterface
      * @throws PsrContainerExceptionInterface
      */
-    public function testContainerSet(string $key, mixed $value, mixed $expected): void
-    {
+    public function testContainerSet(
+        string $key,
+        mixed $value,
+        null|bool|float|int|stdClass|string|array $expected
+    ): void {
         $this->container->set($key, $value);
         self::assertSame($expected, $this->container->get($key));
     }