Code improvements and fixes

CHANGELOG.md

@@ -31,4 +31,4 @@
 * Nothing
 
 ### Fixed
-* Nothing
+* Nothing

README.md

@@ -1,12 +1,14 @@
 # dot-response-header
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-response-header)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-response-header/3.1.0)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-response-header/3.2.0)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-response-header)](https://github.com/dotkernel/dot-response-header/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-response-header)](https://github.com/dotkernel/dot-response-header/network)
 [![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-response-header)](https://github.com/dotkernel/dot-response-header/stargazers)
-[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-response-header)](https://github.com/dotkernel/response-header/LICENSE.md)
+[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-response-header)](https://github.com/dotkernel/dot-response-header/blob/3.0/LICENSE)
+
+[![Build Static](https://github.com/dotkernel/dot-response-header/actions/workflows/static-analysis.yml/badge.svg?branch=3.0)](https://github.com/dotkernel/dot-response-header/actions/workflows/static-analysis.yml)
 
 [![SymfonyInsight](https://insight.symfony.com/projects/dce88959-bd29-40ef-b1e7-d12815145438/big.svg)](https://insight.symfony.com/projects/dce88959-bd29-40ef-b1e7-d12815145438)
 
@@ -15,7 +17,7 @@ Middleware for setting and overwriting custom response headers.
 
 
 ### Requirements
-- PHP >= 7.4
+- PHP >= 8.1
 
 ### Installation
 

composer.json

@@ -31,12 +31,12 @@
   },
   "autoload": {
     "psr-4": {
-      "Dot\\ResponseHeader\\": "src"
+      "Dot\\ResponseHeader\\": "src/"
     }
   },
   "autoload-dev": {
     "psr-4": {
-      "DotTest\\ResponseHeader\\": "tests/"
+      "DotTest\\ResponseHeader\\": "test/"
     }
   },
   "scripts": {

config/response-header.global.php.dist

@@ -18,4 +18,4 @@ return [
             ]
         ]
     ]
-];
+];

phpcs.xml

@@ -14,7 +14,7 @@
     <!-- Paths to check -->
     <file>config</file>
     <file>src</file>
-    <file>tests</file>
+    <file>test</file>
 
     <!-- Include all rules from the Laminas Coding Standard -->
     <rule ref="LaminasCodingStandard"/>

phpunit.xml

@@ -2,7 +2,7 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd" bootstrap="./vendor/autoload.php" colors="true">
     <testsuites>
         <testsuite name="dot-response-header Test Suite">
-            <directory>./tests</directory>
+            <directory>./test</directory>
         </testsuite>
     </testsuites>
     <coverage/>

src/Factory/ResponseHeaderMiddlewareFactory.php

@@ -5,12 +5,39 @@
 namespace Dot\ResponseHeader\Factory;
 
 use Dot\ResponseHeader\Middleware\ResponseHeaderMiddleware;
+use Exception;
+use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
+use Psr\Container\NotFoundExceptionInterface;
+
+use function array_key_exists;
+use function is_array;
 
 class ResponseHeaderMiddlewareFactory
 {
+    public const MESSAGE_MISSING_CONFIG         = 'Unable to find config.';
+    public const MESSAGE_MISSING_PACKAGE_CONFIG = 'Unable to find dot-response-header config.';
+
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     * @throws Exception
+     */
     public function __invoke(ContainerInterface $container): ResponseHeaderMiddleware
     {
+        if (! $container->has('config')) {
+            throw new Exception(self::MESSAGE_MISSING_CONFIG);
+        }
+        $config = $container->get('config');
+
+        if (
+            ! array_key_exists('dot_response_headers', $config)
+            || ! is_array($config['dot_response_headers'])
+            || empty($config['dot_response_headers'])
+        ) {
+            throw new Exception(self::MESSAGE_MISSING_PACKAGE_CONFIG);
+        }
+
         return new ResponseHeaderMiddleware($container->get('config')['dot_response_headers'] ?? []);
     }
 }

src/Middleware/ResponseHeaderMiddleware.php

@@ -45,7 +45,7 @@ public function addHeaders(ResponseInterface $response, string $route): Response
                 if (! array_key_exists('value', $data)) {
                     continue;
                 }
-                $overwrite = isset($data['overwrite']) && $data['overwrite'] === true ? true : false;
+                $overwrite = isset($data['overwrite']) && $data['overwrite'] === true;
                 if ($overwrite) {
                     $response = $response->withHeader($header, $data['value']);
                 }

test/ConfigProviderTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DotTest\ResponseHeader;
+
+use Dot\ResponseHeader\ConfigProvider;
+use PHPUnit\Framework\TestCase;
+
+class ConfigProviderTest extends TestCase
+{
+    private ConfigProvider $configProvider;
+
+    public function setUp(): void
+    {
+        $this->configProvider = new ConfigProvider();
+    }
+
+    public function testInvoke()
+    {
+        $data = $this->configProvider->__invoke();
+
+        $this->assertIsArray($data);
+    }
+
+    public function testGetDependencies()
+    {
+        $data = $this->configProvider->getDependencies();
+
+        $this->assertIsArray($data);
+    }
+}

test/ResponseHeaderMiddlewareFactoryTest.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DotTest\ResponseHeader;
+
+use Dot\ResponseHeader\Factory\ResponseHeaderMiddlewareFactory;
+use PHPUnit\Framework\MockObject\Exception;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\ContainerInterface;
+use Psr\Container\NotFoundExceptionInterface;
+
+class ResponseHeaderMiddlewareFactoryTest extends TestCase
+{
+    private ResponseHeaderMiddlewareFactory $responseHeaderMiddlewareFactory;
+
+    private ContainerInterface|MockObject $containerInterface;
+
+    /**
+     * @throws Exception
+     */
+    public function setUp(): void
+    {
+        $this->responseHeaderMiddlewareFactory = new ResponseHeaderMiddlewareFactory();
+        $this->containerInterface              = $this->createMock(ContainerInterface::class);
+    }
+
+    /**
+     * @throws ContainerExceptionInterface
+     * @throws Exception
+     * @throws NotFoundExceptionInterface
+     */
+    public function testWillNotCreateApplicationWithoutConfig(): void
+    {
+        $container = $this->createMock(ContainerInterface::class);
+
+        $container->expects($this->once())
+            ->method('has')
+            ->with('config')
+            ->willReturn(false);
+
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage(ResponseHeaderMiddlewareFactory::MESSAGE_MISSING_CONFIG);
+        (new ResponseHeaderMiddlewareFactory())($container);
+    }
+
+    /**
+     * @throws Exception
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
+     */
+    public function testWillNotCreateApplicationWithoutPackageConfig(): void
+    {
+        $container = $this->createMock(ContainerInterface::class);
+
+        $container->expects($this->once())
+            ->method('has')
+            ->with('config')
+            ->willReturn(true);
+
+        $container->expects($this->once())
+            ->method('get')
+            ->with('config')
+            ->willReturn([
+                'test',
+            ]);
+
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage(ResponseHeaderMiddlewareFactory::MESSAGE_MISSING_PACKAGE_CONFIG);
+        (new ResponseHeaderMiddlewareFactory())($container);
+    }
+}

tests/ResponseHeaderMiddlewareTest.php → test/ResponseHeaderMiddlewareTest.php

@@ -5,6 +5,7 @@
 namespace DotTest\ResponseHeader;
 
 use Dot\ResponseHeader\Middleware\ResponseHeaderMiddleware;
+use PHPUnit\Framework\MockObject\Exception;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ResponseInterface;
@@ -22,10 +23,11 @@ class ResponseHeaderMiddlewareTest extends TestCase
 
     private ResponseInterface $responseInterface;
 
+    /**
+     * @throws Exception
+     */
     public function setUp(): void
     {
-        parent::setUp();
-
         $this->responseHeader    = new ResponseHeaderMiddleware([]);
         $this->serverRequest     = $this->createMock(ServerRequestInterface::class);
         $this->requestHandler    = $this->createMock(RequestHandlerInterface::class);
@@ -47,7 +49,7 @@ public function testProcess()
 
     public function testAddHeaders()
     {
-        $data = $this->responseHeader->addHeaders($this->responseInterface, 'home');
+        $data = $this->responseHeader->addHeaders($this->responseInterface, '');
 
         $this->assertInstanceOf(ResponseInterface::class, $data);
     }