Merge pull request #33 from samsonasik/apply-php80

Ocramius · web-flow · commit e2c1a5e7526b · 2022-10-15T13:33:10.000+02:00
Apply PHP 8.0 Syntax and constructor promotion
diff --git a/src/ProblemDetailsMiddleware.php b/src/ProblemDetailsMiddleware.php
@@ -28,11 +28,8 @@ class ProblemDetailsMiddleware implements MiddlewareInterface
     /** @var callable[] */
     private array $listeners = [];
 
-    private ProblemDetailsResponseFactory $responseFactory;
-
-    public function __construct(ProblemDetailsResponseFactory $responseFactory)
+    public function __construct(private ProblemDetailsResponseFactory $responseFactory)
     {
-        $this->responseFactory = $responseFactory;
     }
 
     /**
@@ -107,7 +104,7 @@ private function createErrorHandler(): callable
          * @param int $errline
          * @throws ErrorException if error is not within the error_reporting mask.
          */
-        return function (int $errno, string $errstr, string $errfile, int $errline): void {
+        return static function (int $errno, string $errstr, string $errfile, int $errline): void {
             if (! (error_reporting() & $errno)) {
                 // error_reporting does not include this error
                 return;
@@ -125,7 +122,7 @@ private function triggerListeners(
         ServerRequestInterface $request,
         ResponseInterface $response
     ): void {
-        array_walk($this->listeners, function ($listener) use ($error, $request, $response) {
+        array_walk($this->listeners, static function ($listener) use ($error, $request, $response): void {
             $listener($error, $request, $response);
         });
     }
diff --git a/src/ProblemDetailsNotFoundHandler.php b/src/ProblemDetailsNotFoundHandler.php
@@ -15,15 +15,12 @@
 
 class ProblemDetailsNotFoundHandler implements MiddlewareInterface
 {
-    private ProblemDetailsResponseFactory $responseFactory;
-
     /**
      * @param ProblemDetailsResponseFactory $responseFactory Factory to create a response to
      *     update and return when returning an 404 response.
      */
-    public function __construct(ProblemDetailsResponseFactory $responseFactory)
+    public function __construct(private ProblemDetailsResponseFactory $responseFactory)
     {
-        $this->responseFactory = $responseFactory;
     }
 
     /**
diff --git a/src/ProblemDetailsResponseFactory.php b/src/ProblemDetailsResponseFactory.php
@@ -26,8 +26,8 @@
 use function preg_replace;
 use function print_r;
 use function sprintf;
+use function str_contains;
 use function str_replace;
-use function strpos;
 
 use const JSON_PARTIAL_OUTPUT_ON_ERROR;
 use const JSON_PRESERVE_ZERO_FRACTION;
@@ -149,15 +149,6 @@ class ProblemDetailsResponseFactory
         'application/*+xml',
     ];
 
-    /**
-     * Whether or not to include debug details.
-     *
-     * Debug details are only included for responses created from throwables,
-     * and include full exception details and previous exceptions and their
-     * details.
-     */
-    private bool $isDebug;
-
     /**
      * JSON flags to use when generating JSON response payload.
      *
@@ -177,38 +168,39 @@ class ProblemDetailsResponseFactory
      */
     private ResponseFactoryInterface $responseFactory;
 
-    /**
-     * Flag to enable show exception details in detail field.
-     *
-     * Disabled by default for security reasons.
-     */
-    private bool $exceptionDetailsInResponse;
-
-    /**
-     * Default detail field value. Will be visible when
-     * $exceptionDetailsInResponse disabled.
-     *
-     * Empty string by default
-     */
-    private string $defaultDetailMessage;
-
-    /**
-     * A map used to infer the "type" property based on the status code.
-     *
-     * Defaults to an empty map.
-     */
-    private array $defaultTypesMap;
-
     /**
      * @param (callable():ResponseInterface)|ResponseFactoryInterface $responseFactory
      */
     public function __construct(
         $responseFactory,
-        bool $isDebug = self::EXCLUDE_THROWABLE_DETAILS,
+        /**
+         * Whether or not to include debug details.
+         *
+         * Debug details are only included for responses created from throwables,
+         * and include full exception details and previous exceptions and their
+         * details.
+         */
+        private bool $isDebug = self::EXCLUDE_THROWABLE_DETAILS,
         ?int $jsonFlags = null,
-        bool $exceptionDetailsInResponse = false,
-        string $defaultDetailMessage = self::DEFAULT_DETAIL_MESSAGE,
-        array $defaultTypesMap = []
+        /**
+         * Flag to enable show exception details in detail field.
+         *
+         * Disabled by default for security reasons.
+         */
+        private bool $exceptionDetailsInResponse = false,
+        /**
+         * Default detail field value. Will be visible when
+         * $exceptionDetailsInResponse disabled.
+         *
+         * Empty string by default
+         */
+        private string $defaultDetailMessage = self::DEFAULT_DETAIL_MESSAGE,
+        /**
+         * A map used to infer the "type" property based on the status code.
+         *
+         * Defaults to an empty map.
+         */
+        private array $defaultTypesMap = []
     ) {
         if (is_callable($responseFactory)) {
             $responseFactory = new CallableResponseFactoryDecorator(
@@ -217,7 +209,6 @@ public function __construct(
         }
         // Ensures type safety of the composed factory
         $this->responseFactory = $responseFactory;
-        $this->isDebug         = $isDebug;
         if (! $jsonFlags) {
             $jsonFlags = JSON_UNESCAPED_SLASHES
                 | JSON_UNESCAPED_UNICODE
@@ -227,10 +218,7 @@ public function __construct(
                 $jsonFlags = JSON_PRETTY_PRINT | $jsonFlags;
             }
         }
-        $this->jsonFlags                  = $jsonFlags;
-        $this->exceptionDetailsInResponse = $exceptionDetailsInResponse;
-        $this->defaultDetailMessage       = $defaultDetailMessage;
-        $this->defaultTypesMap            = $defaultTypesMap;
+        $this->jsonFlags = $jsonFlags;
     }
 
     public function createResponse(
@@ -254,7 +242,7 @@ public function createResponse(
 
         if ($additional) {
             // ensure payload can be json_encoded
-            array_walk_recursive($additional, function (&$value) {
+            array_walk_recursive($additional, static function (&$value): void {
                 if (is_resource($value)) {
                     $value = print_r($value, true) . ' of type ' . get_resource_type($value);
                 }
@@ -374,7 +362,7 @@ private function getResponseGenerator(ServerRequestInterface $request): callable
         $accept    = $request->getHeaderLine('Accept') ?: '*/*';
         $mediaType = (new Negotiator())->getBest($accept, self::NEGOTIATION_PRIORITIES);
 
-        return ! $mediaType || false === strpos($mediaType->getValue(), 'json')
+        return ! $mediaType || ! str_contains($mediaType->getValue(), 'json')
             ? Closure::fromCallable([$this, 'generateXmlResponse'])
             : Closure::fromCallable([$this, 'generateJsonResponse']);
     }
diff --git a/test/InMemoryContainer.php b/test/InMemoryContainer.php
@@ -37,8 +37,7 @@ public function has($id): bool
         return array_key_exists($id, $this->services);
     }
 
-    /** @param mixed $item */
-    public function set(string $id, $item): void
+    public function set(string $id, mixed $item): void
     {
         $this->services[$id] = $item;
     }
diff --git a/test/ProblemDetailsAssertionsTrait.php b/test/ProblemDetailsAssertionsTrait.php
@@ -83,7 +83,7 @@ public function preparePayloadForJsonResponse(MockObject $stream, callable $asse
         $stream
             ->expects($this->any())
             ->method('write')
-            ->with($this->callback(function ($body) use ($assertion) {
+            ->with($this->callback(static function ($body) use ($assertion): bool {
                 Assert::assertIsString($body);
                 $data = json_decode($body, true);
                 $assertion($data);
@@ -99,7 +99,7 @@ public function preparePayloadForXmlResponse(MockObject $stream, callable $asser
         $stream
             ->expects($this->any())
             ->method('write')
-            ->with($this->callback(function ($body) use ($assertion) {
+            ->with($this->callback(function ($body) use ($assertion): bool {
                 Assert::assertIsString($body);
                 $data = $this->deserializeXmlPayload($body);
                 $assertion($data);
@@ -114,7 +114,7 @@ public function deserializeXmlPayload(string $xml): array
         $payload = json_decode($json, true);
 
         // Ensure ints and floats are properly represented
-        array_walk_recursive($payload, function (&$item) {
+        array_walk_recursive($payload, static function (&$item): void {
             if ((string) (int) $item === $item) {
                 $item = (int) $item;
                 return;
diff --git a/test/ProblemDetailsMiddlewareTest.php b/test/ProblemDetailsMiddlewareTest.php
@@ -104,14 +104,14 @@ public function testMiddlewareRegistersErrorHandlerToConvertErrorsToProblemDetai
         $handler
             ->method('handle')
             ->with($this->request)
-            ->willReturnCallback(function () {
+            ->willReturnCallback(static function (): void {
                 trigger_error('Triggered error!', E_USER_ERROR);
             });
 
         $expected = $this->createMock(ResponseInterface::class);
         $this->responseFactory
             ->method('createResponseFromThrowable')
-            ->with($this->request, $this->callback(function ($e) {
+            ->with($this->request, $this->callback(function ($e): bool {
                 $this->assertInstanceOf(ErrorException::class, $e);
                 $this->assertEquals(E_USER_ERROR, $e->getSeverity());
                 $this->assertEquals('Triggered error!', $e->getMessage());
@@ -168,7 +168,7 @@ public function testErrorHandlingTriggersListeners(string $accept): void
             ->with($this->request, $exception)
             ->willReturn($expected);
 
-        $listener  = function ($error, $request, $response) use ($exception, $expected) {
+        $listener  = function ($error, $request, $response) use ($exception, $expected): void {
             $this->assertSame($exception, $error, 'Listener did not receive same exception as was raised');
             $this->assertSame($this->request, $request, 'Listener did not receive same request');
             $this->assertSame($expected, $response, 'Listener did not receive same response');
diff --git a/test/ProblemDetailsResponseFactoryFactoryTest.php b/test/ProblemDetailsResponseFactoryFactoryTest.php
@@ -127,7 +127,7 @@ public function testUsesPrettyPrintFlagOnEnabledDebugMode(): void
                 ['config', ['debug' => true]],
                 [
                     ResponseInterface::class,
-                    function () {
+                    static function (): void {
                     },
                 ],
             ]);
@@ -154,7 +154,7 @@ public function testUsesDebugSettingFromConfigWhenPresent(): void
                 ['config', ['debug' => true]],
                 [
                     ResponseInterface::class,
-                    function () {
+                    static function (): void {
                     },
                 ],
             ]);
@@ -185,7 +185,7 @@ public function testUsesJsonFlagsSettingFromConfigWhenPresent(): void
                 ['config', ['problem-details' => ['json_flags' => JSON_PRETTY_PRINT]]],
                 [
                     ResponseInterface::class,
-                    function () {
+                    static function (): void {
                     },
                 ],
             ]);
@@ -216,7 +216,7 @@ public function testUsesDefaultTypesSettingFromConfigWhenPresent(): void
                 ['config', ['problem-details' => ['default_types_map' => $expectedDefaultTypes]]],
                 [
                     ResponseInterface::class,
-                    function () {
+                    static function (): void {
                     },
                 ],
             ]);
diff --git a/test/ProblemDetailsResponseFactoryTest.php b/test/ProblemDetailsResponseFactoryTest.php
diff --git a/test/TestAsset/RuntimeException.php b/test/TestAsset/RuntimeException.php

Original file line number	Diff line number	Diff line change
`@@ -15,15 +15,12 @@`
`15`	`15`
`16`	`16`	`class ProblemDetailsNotFoundHandler implements MiddlewareInterface`
`17`	`17`	`{`
`18`		`- private ProblemDetailsResponseFactory $responseFactory;`
`19`		`-`
`20`	`18`	`/**`
`21`	`19`	`* @param ProblemDetailsResponseFactory $responseFactory Factory to create a response to`
`22`	`20`	`* update and return when returning an 404 response.`
`23`	`21`	`*/`
`24`		`- public function __construct(ProblemDetailsResponseFactory $responseFactory)`
	`22`	`+ public function __construct(private ProblemDetailsResponseFactory $responseFactory)`
`25`	`23`	`{`
`26`		`- $this->responseFactory = $responseFactory;`
`27`	`24`	`}`
`28`	`25`
`29`	`26`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -37,8 +37,7 @@ public function has($id): bool`
`37`	`37`	`return array_key_exists($id, $this->services);`
`38`	`38`	`}`
`39`	`39`
`40`		`- /** @param mixed $item */`
`41`		`- public function set(string $id, $item): void`
	`40`	`+ public function set(string $id, mixed $item): void`
`42`	`41`	`{`
`43`	`42`	`$this->services[$id] = $item;`
`44`	`43`	`}`