[TASK] Use brotkrueml/coding-standards

brotkrueml · Oct 4, 2021 · 96a236c · 96a236c
1 parent f7ff7c6
commit 96a236c
Show file tree

Hide file tree

Showing 27 changed files with 207 additions and 107 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -6,9 +6,9 @@
 /.gitattributes export-ignore
 /.github/ export-ignore
 /.gitignore export-ignore
-/.php_cs export-ignore
 /captainhook.json export-ignore
 /CHANGELOG.md export-ignore
+/ecs.php export-ignore
 /Makefile export-ignore
 /phpstan.neon export-ignore
 /README.md export-ignore

diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,5 @@
 .Build
 .idea
-.php_cs.cache
 .phpunit.result.cache
 composer.lock
 *GENERATED*
diff --git a/.php_cs b/.php_cs
diff --git a/Classes/Code/JavaScriptTrackingCodeBuilder.php b/Classes/Code/JavaScriptTrackingCodeBuilder.php
@@ -25,7 +25,9 @@ class JavaScriptTrackingCodeBuilder
 {
     private Configuration $configuration;
     private EventDispatcher $eventDispatcher;
-    /** @var list<JavaScriptCode|MatomoMethodCall> */
+    /**
+     * @var list<JavaScriptCode|MatomoMethodCall>
+     */
     private array $trackingCodeParts = [];
 
     public function __construct(EventDispatcher $eventDispatcher)

diff --git a/Classes/Code/MatomoMethodCall.php b/Classes/Code/MatomoMethodCall.php
@@ -23,9 +23,10 @@ final class MatomoMethodCall implements \Stringable
      * @see https://regex101.com/r/vxhiIw/1
      */
     private const METHOD_NAME_REGEX = '/^[a-z]+$/i';
-
     private string $methodName;
-    /** @var list<array|bool|int|string|JavaScriptCode> */
+    /**
+     * @var list<array|bool|int|string|JavaScriptCode>
+     */
     private array $parameters;
 
     /**
@@ -40,7 +41,7 @@ public function __construct(string $methodName, ...$parameters)
 
     private function checkMethodName(string $methodName): void
     {
-        if (!preg_match(self::METHOD_NAME_REGEX, $methodName)) {
+        if (! preg_match(self::METHOD_NAME_REGEX, $methodName)) {
             throw new InvalidMatomoMethodName(
                 \sprintf(
                     'The given Matomo method name "%s" is not valid, only characters between a and z are allowed!',

diff --git a/Classes/Code/TagManagerCodeBuilder.php b/Classes/Code/TagManagerCodeBuilder.php
@@ -24,9 +24,13 @@ class TagManagerCodeBuilder
 {
     private Configuration $configuration;
     private EventDispatcher $eventDispatcher;
-    /** @var JavaScriptCode[] */
+    /**
+     * @var JavaScriptCode[]
+     */
     private array $codeParts = [];
-    /** @var DataLayerVariable[] */
+    /**
+     * @var DataLayerVariable[]
+     */
     private array $dataLayerVariables = [];
 
     public function __construct(EventDispatcher $eventDispatcher)

diff --git a/Classes/Entity/Configuration.php b/Classes/Entity/Configuration.php
@@ -20,35 +20,65 @@ final class Configuration
 {
     private const SITE_CONFIGURATION_PREFIX = 'matomoIntegration';
 
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public string $url = '';
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public int $siteId = 0;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $noScript = false;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $cookieTracking = false;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $doNotTrack = false;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public string $errorPagesTemplate = '';
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $heartBeatTimer = false;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $linkTracking = false;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $performanceTracking = false;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $trackAllContentImpressions = false;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $trackErrorPages = false;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $trackJavaScriptErrors = false;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $trackVisibleContentImpressions = false;
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public string $tagManagerContainerId = '';
-    /** @readonly */
+    /**
+     * @readonly
+     */
     public bool $tagManagerDebugMode = false;
 
     private function __construct()
@@ -62,7 +92,7 @@ public static function createFromSiteConfiguration(array $siteConfiguration): se
     {
         $configuration = new self();
         foreach ($siteConfiguration as $name => $value) {
-            if (!\str_starts_with($name, self::SITE_CONFIGURATION_PREFIX)) {
+            if (! \str_starts_with($name, self::SITE_CONFIGURATION_PREFIX)) {
                 continue;
             }
 
@@ -83,7 +113,7 @@ private static function processConfiguration(self $configuration, string $name,
             return;
         }
 
-        if (!\property_exists(self::class, $property)) {
+        if (! \property_exists(self::class, $property)) {
             return;
         }
 
@@ -110,17 +140,17 @@ private static function processOptions(self $configuration, string $commaDelimit
     /**
      * @param bool|int|string $value
      */
-    private static function setConfiguration(Configuration $configuration, string $property, $value): void
+    private static function setConfiguration(self $configuration, string $property, $value): void
     {
         try {
             // @phpstan-ignore-next-line
             $type = (new \ReflectionProperty(self::class, $property))->getType()->getName();
             if ($type === 'string') {
-                $configuration->$property = (string)$value;
+                $configuration->{$property} = (string)$value;
             } elseif ($type === 'int') {
-                $configuration->$property = (int)$value;
+                $configuration->{$property} = (int)$value;
             } elseif ($type === 'bool') {
-                $configuration->$property = (bool)$value;
+                $configuration->{$property} = (bool)$value;
             }
         } catch (\ReflectionException $e) {
         }

diff --git a/Classes/Entity/DataLayerVariable.php b/Classes/Entity/DataLayerVariable.php
@@ -20,7 +20,9 @@
 final class DataLayerVariable
 {
     private string $name;
-    /** @var string|int|float|JavaScriptCode */
+    /**
+     * @var string|int|float|JavaScriptCode
+     */
     private $value;
 
     /**

diff --git a/Classes/Event/AbstractTrackPageViewEvent.php b/Classes/Event/AbstractTrackPageViewEvent.php
@@ -21,9 +21,13 @@
 abstract class AbstractTrackPageViewEvent
 {
     private Configuration $configuration;
-    /** @var JavaScriptCode[] */
+    /**
+     * @var JavaScriptCode[]
+     */
     private array $javaScriptCodes = [];
-    /** @var MatomoMethodCall[] */
+    /**
+     * @var MatomoMethodCall[]
+     */
     private array $matomoMethodCalls = [];
 
     public function __construct(Configuration $configuration)

diff --git a/Classes/Event/AddToDataLayerEvent.php b/Classes/Event/AddToDataLayerEvent.php
@@ -16,7 +16,9 @@
 
 final class AddToDataLayerEvent
 {
-    /** @var DataLayerVariable[] */
+    /**
+     * @var DataLayerVariable[]
+     */
     private array $variables = [];
 
     /**

diff --git a/Classes/Event/EnrichTrackPageViewEvent.php b/Classes/Event/EnrichTrackPageViewEvent.php
@@ -16,7 +16,9 @@
 final class EnrichTrackPageViewEvent
 {
     private string $pageTitle = '';
-    /** @var CustomDimension[] */
+    /**
+     * @var CustomDimension[]
+     */
     private array $customDimensions = [];
 
     public function setPageTitle(string $pageTitle): void

diff --git a/Classes/EventListener/CookieTracking.php b/Classes/EventListener/CookieTracking.php
@@ -20,7 +20,7 @@ final class CookieTracking
 {
     public function __invoke(BeforeTrackPageViewEvent $event): void
     {
-        if (!$event->getConfiguration()->cookieTracking) {
+        if (! $event->getConfiguration()->cookieTracking) {
             $event->addMatomoMethodCall('disableCookies');
         }
     }

diff --git a/Classes/EventListener/PerformanceTracking.php b/Classes/EventListener/PerformanceTracking.php
@@ -20,7 +20,7 @@ final class PerformanceTracking
 {
     public function __invoke(AfterTrackPageViewEvent $event): void
     {
-        if (!$event->getConfiguration()->performanceTracking) {
+        if (! $event->getConfiguration()->performanceTracking) {
             $event->addMatomoMethodCall('disablePerformanceTracking');
         }
     }

diff --git a/Classes/EventListener/TrackErrorPages.php b/Classes/EventListener/TrackErrorPages.php
@@ -33,7 +33,7 @@ public function __construct(ServerRequestInterface $request = null)
 
     public function __invoke(BeforeTrackPageViewEvent $event): void
     {
-        if (!$event->getConfiguration()->trackErrorPages) {
+        if (! $event->getConfiguration()->trackErrorPages) {
             return;
         }
 

diff --git a/Classes/Hooks/PageRenderer/TrackingCodeInjector.php b/Classes/Hooks/PageRenderer/TrackingCodeInjector.php
@@ -49,7 +49,9 @@ public function __construct(
         $this->tagManagerCodeBuilder = $tagManagerCodeBuilder ?? GeneralUtility::makeInstance(TagManagerCodeBuilder::class);
     }
 
-    /** @noinspection PhpUnusedParameterInspection */
+    /**
+     * @noinspection PhpUnusedParameterInspection
+     */
     public function execute(?array &$params, PageRenderer $pageRenderer): void
     {
         if ($this->applicationType->isBackend()) {
@@ -60,7 +62,7 @@ public function execute(?array &$params, PageRenderer $pageRenderer): void
         $site = $this->request->getAttribute('site');
         $configuration = Configuration::createFromSiteConfiguration($site->getConfiguration());
 
-        if (!$this->hasValidConfiguration($configuration)) {
+        if (! $this->hasValidConfiguration($configuration)) {
             return;
         }
 
@@ -83,7 +85,7 @@ public function execute(?array &$params, PageRenderer $pageRenderer): void
 
     private function hasValidConfiguration(Configuration $configuration): bool
     {
-        if (!\filter_var($configuration->url, \FILTER_VALIDATE_URL)) {
+        if (! \filter_var($configuration->url, \FILTER_VALIDATE_URL)) {
             return false;
         }
 

diff --git a/Classes/JavaScript/JavaScriptObjectPairCollector.php b/Classes/JavaScript/JavaScriptObjectPairCollector.php
@@ -18,7 +18,9 @@
  */
 final class JavaScriptObjectPairCollector implements \Stringable
 {
-    /** @var array<string, string|int|float|JavaScriptCode> */
+    /**
+     * @var array<string, string|int|float|JavaScriptCode>
+     */
     private array $pairs = [];
 
     /**

diff --git a/Configuration/SiteConfiguration/Overrides/sites.php b/Configuration/SiteConfiguration/Overrides/sites.php
@@ -94,7 +94,10 @@
         'config' => [
             'type' => 'check',
             'renderType' => 'checkboxToggle',
-            'items' => [[0 => '', 1 => '']],
+            'items' => [[
+                0 => '',
+                1 => '',
+            ]],
         ],
     ],
 ];

diff --git a/Makefile b/Makefile
@@ -1,13 +1,13 @@
 .PHONY: qa
-qa: coding-standards tests phpstan rector-dry yaml-lint
+qa: cs tests phpstan rector-dry yaml-lint
 
 .PHONY: code-coverage
 code-coverage: vendor
 	XDEBUG_MODE=coverage .Build/bin/phpunit -c Tests/phpunit.xml.dist --log-junit .Build/logs/phpunit.xml --coverage-text --coverage-clover .Build/logs/clover.xml
 
-.PHONY: coding-standards
-coding-standards: vendor
-	.Build/bin/php-cs-fixer fix --config=.php_cs --diff
+.PHONY: cs
+cs: vendor
+	.Build/bin/ecs check --fix
 
 .PHONY: phpstan
 phpstan: vendor

diff --git a/Tests/Unit/Code/JavaScriptTrackingCodeBuilderTest.php b/Tests/Unit/Code/JavaScriptTrackingCodeBuilderTest.php
@@ -22,7 +22,9 @@
 
 final class JavaScriptTrackingCodeBuilderTest extends TestCase
 {
-    /** @var Stub|EventDispatcher */
+    /**
+     * @var Stub|EventDispatcher
+     */
     private $eventDispatcherStub;
 
     private JavaScriptTrackingCodeBuilder $subject;