[shopsys] introduced new coding standards (#2617)

shopsys · Jun 9, 2023 · b6f9130 · b6f9130
2 parents 3d04732 + 30cc2f6
commit b6f9130
Show file tree

Hide file tree

Showing 18 changed files with 62 additions and 89 deletions.
diff --git a/src/Annotation/DataSet.php b/src/Annotation/DataSet.php
@@ -12,13 +12,10 @@
  */
 class DataSet
 {
-    /**
-     * @var int
-     */
-    public $statusCode = 200;
+    public int $statusCode = 200;
 
     /**
      * @var \Shopsys\HttpSmokeTesting\Annotation\Parameter[]
      */
-    public $parameters = [];
+    public array $parameters = [];
 }
diff --git a/src/Annotation/Parameter.php b/src/Annotation/Parameter.php
@@ -14,14 +14,12 @@
 class Parameter
 {
     /**
-     * @var string
      * @Required()
      */
-    public $name;
+    public string $name;
 
     /**
-     * @var string
      * @Required()
      */
-    public $value;
+    public string $value;
 }
diff --git a/src/Auth/AuthInterface.php b/src/Auth/AuthInterface.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting\Auth;
 
 use Symfony\Component\HttpFoundation\Request;

diff --git a/src/Auth/BasicHttpAuth.php b/src/Auth/BasicHttpAuth.php
@@ -1,20 +1,16 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting\Auth;
 
 use Symfony\Component\HttpFoundation\Request;
 
 class BasicHttpAuth implements AuthInterface
 {
-    /**
-     * @var string
-     */
-    private $username;
+    private string $username;
 
-    /**
-     * @var string|null
-     */
-    private $password;
+    private ?string $password = null;
 
     /**
      * @param string $username

diff --git a/src/Auth/NoAuth.php b/src/Auth/NoAuth.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting\Auth;
 
 use Symfony\Component\HttpFoundation\Request;

diff --git a/src/Exception/RouteNameNotFoundException.php b/src/Exception/RouteNameNotFoundException.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting\Exception;
 
 use Exception;
@@ -14,7 +16,7 @@ public function __construct($routeName)
         $routeNames = (array)$routeName;
 
         parent::__construct(
-            'Route name' . (count($routeNames) !== 1 ? 's' : '') . ' "' . implode('", "', $routeNames) . '" not found!'
+            'Route name' . (count($routeNames) !== 1 ? 's' : '') . ' "' . implode('", "', $routeNames) . '" not found!',
         );
     }
 }
diff --git a/src/HttpSmokeTestCase.php b/src/HttpSmokeTestCase.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting;
 
 use Shopsys\HttpSmokeTesting\RouterAdapter\SymfonyRouterAdapter;
@@ -85,7 +87,7 @@ final public function httpResponseTestDataProvider()
             function (RequestDataSet $requestDataSet) {
                 return [$requestDataSet];
             },
-            $requestDataSets
+            $requestDataSets,
         );
     }
 
@@ -141,12 +143,12 @@ protected function assertResponse(Response $response, RequestDataSet $requestDat
             'Failed asserting that status code %d for route "%s" is identical to expected %d',
             $response->getStatusCode(),
             $requestDataSet->getRouteName(),
-            $requestDataSet->getExpectedStatusCode()
+            $requestDataSet->getExpectedStatusCode(),
         );
         $this->assertSame(
             $requestDataSet->getExpectedStatusCode(),
             $response->getStatusCode(),
-            $this->getMessageWithDebugNotes($requestDataSet, $failMessage)
+            $this->getMessageWithDebugNotes($requestDataSet, $failMessage),
         );
     }
 

diff --git a/src/RequestDataSet.php b/src/RequestDataSet.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting;
 
 use Shopsys\HttpSmokeTesting\Auth\AuthInterface;
@@ -10,40 +12,28 @@ class RequestDataSet implements RequestDataSetConfig
 {
     private const DEFAULT_EXPECTED_STATUS_CODE = 200;
 
-    /**
-     * @var string
-     */
-    private $routeName;
+    private string $routeName;
 
-    /**
-     * @var bool
-     */
-    private $skipped;
+    private bool $skipped;
 
-    /**
-     * @var \Shopsys\HttpSmokeTesting\Auth\AuthInterface|null
-     */
-    private $auth;
+    private ?AuthInterface $auth = null;
 
-    /**
-     * @var int|null
-     */
-    private $expectedStatusCode;
+    private ?int $expectedStatusCode = null;
 
     /**
-     * @var array
+     * @var array<string, mixed>
      */
-    private $parameters;
+    private array $parameters;
 
     /**
      * @var string[]
      */
-    private $debugNotes;
+    private array $debugNotes;
 
     /**
      * @var callable[]
      */
-    private $callsDuringTestExecution;
+    private array $callsDuringTestExecution;
 
     /**
      * @param string $routeName

diff --git a/src/RequestDataSetConfig.php b/src/RequestDataSetConfig.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting;
 
 use Shopsys\HttpSmokeTesting\Auth\AuthInterface;

diff --git a/src/RequestDataSetGenerator.php b/src/RequestDataSetGenerator.php
@@ -1,33 +1,26 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting;
 
 use Shopsys\HttpSmokeTesting\Annotation\DataSet;
 use Shopsys\HttpSmokeTesting\Annotation\Skipped;
 
 class RequestDataSetGenerator implements RouteConfig
 {
-    /**
-     * @var \Shopsys\HttpSmokeTesting\RouteInfo
-     */
-    private $routeInfo;
-
-    /**
-     * @var \Shopsys\HttpSmokeTesting\RequestDataSet
-     */
-    private $defaultRequestDataSet;
+    private RequestDataSet $defaultRequestDataSet;
 
     /**
      * @var \Shopsys\HttpSmokeTesting\RequestDataSet[]
      */
-    private $extraRequestDataSets;
+    private array $extraRequestDataSets;
 
     /**
      * @param \Shopsys\HttpSmokeTesting\RouteInfo $routeInfo
      */
-    public function __construct(RouteInfo $routeInfo)
+    public function __construct(private readonly RouteInfo $routeInfo)
     {
-        $this->routeInfo = $routeInfo;
         $this->defaultRequestDataSet = new RequestDataSet($this->routeInfo->getRouteName());
         $this->extraRequestDataSets = [];
     }

diff --git a/src/RequestDataSetGeneratorFactory.php b/src/RequestDataSetGeneratorFactory.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting;
 
 class RequestDataSetGeneratorFactory

diff --git a/src/RouteConfig.php b/src/RouteConfig.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting;
 
 interface RouteConfig

diff --git a/src/RouteConfigCustomizer.php b/src/RouteConfigCustomizer.php
@@ -1,22 +1,18 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting;
 
 use Shopsys\HttpSmokeTesting\Exception\RouteNameNotFoundException;
 
 class RouteConfigCustomizer
 {
-    /**
-     * @var \Shopsys\HttpSmokeTesting\RequestDataSetGenerator[]
-     */
-    private $requestDataSetGenerators;
-
     /**
      * @param \Shopsys\HttpSmokeTesting\RequestDataSetGenerator[] $requestDataSetGenerators
      */
-    public function __construct(array $requestDataSetGenerators)
+    public function __construct(private readonly array $requestDataSetGenerators)
     {
-        $this->requestDataSetGenerators = $requestDataSetGenerators;
     }
 
     /**

diff --git a/src/RouteInfo.php b/src/RouteInfo.php
@@ -1,36 +1,23 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting;
 
 use Symfony\Component\Routing\Route;
 
 class RouteInfo
 {
-    /**
-     * @var string
-     */
-    private $routeName;
-
-    /**
-     * @var \Symfony\Component\Routing\Route
-     */
-    private $route;
-
-    /**
-     * @var array
-     */
-    private $annotations;
+    private string $routeName;
 
     /**
      * @param string $routeName
      * @param \Symfony\Component\Routing\Route $route
      * @param array $annotations
      */
-    public function __construct($routeName, Route $route, array $annotations = [])
+    public function __construct($routeName, private readonly Route $route, private readonly array $annotations = [])
     {
         $this->routeName = $routeName;
-        $this->route = $route;
-        $this->annotations = $annotations;
     }
 
     /**

diff --git a/src/RouterAdapter/RouterAdapterInterface.php b/src/RouterAdapter/RouterAdapterInterface.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting\RouterAdapter;
 
 use Shopsys\HttpSmokeTesting\RequestDataSet;

diff --git a/src/RouterAdapter/SymfonyRouterAdapter.php b/src/RouterAdapter/SymfonyRouterAdapter.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Shopsys\HttpSmokeTesting\RouterAdapter;
 
 use Doctrine\Common\Annotations\AnnotationReader;
@@ -15,21 +17,15 @@
 
 class SymfonyRouterAdapter implements RouterAdapterInterface
 {
-    /**
-     * @var \Symfony\Component\Routing\RouterInterface
-     */
-    private $router;
-
-    private $annotationsReader;
+    private AnnotationReader $annotationsReader;
 
     /**
      * @param \Symfony\Component\Routing\RouterInterface $router
      */
-    public function __construct(RouterInterface $router)
+    public function __construct(private readonly RouterInterface $router)
     {
         AnnotationRegistry::registerLoader('class_exists');
 
-        $this->router = $router;
         $this->annotationsReader = new AnnotationReader();
     }
 

diff --git a/tests/Unit/RequestDataSetGeneratorTest.php b/tests/Unit/RequestDataSetGeneratorTest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Tests\HttpSmokeTesting\Unit;
 
 use PHPUnit\Framework\TestCase;
@@ -66,12 +68,12 @@ private function createRequestDataSetGenerator($routePath, $routeName, array $an
     public function testGeneratorGenerateRequestDataSetFromDataSetAnnotation(
         DataSet $dataSet,
         int $statusCode,
-        array $parameters
+        array $parameters,
     ) {
         $requestDataSetGenerator = $this->createRequestDataSetGenerator(
             'test_route_path',
             'test_route_name',
-            [$dataSet]
+            [$dataSet],
         );
         $requestDataSets = $requestDataSetGenerator->generateRequestDataSets();
 
@@ -105,7 +107,7 @@ public function testGeneratorGeneratesRequestDataSetsFromDataSetAnnotations()
         $requestDataSetGenerator = $this->createRequestDataSetGenerator(
             'test_route_path',
             'test_route_name',
-            $annotations
+            $annotations,
         );
 
         $requestDataSets = $requestDataSetGenerator->generateRequestDataSets();

diff --git a/tests/Unit/RouterAdapter/SymfonyRouterAdapterTest.php b/tests/Unit/RouterAdapter/SymfonyRouterAdapterTest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Tests\HttpSmokeTesting\Unit\RouterAdapter;
 
 use Doctrine\Common\Annotations\AnnotationReader;
@@ -19,7 +21,7 @@ public function testGetAllRouteInfoExtractsInformationFromRouteCollection()
     {
         $router = new Router(
             new AnnotatedRouteControllerLoader(new AnnotationReader()),
-            TestController::class
+            TestController::class,
         );
 
         $adapter = new SymfonyRouterAdapter($router);