Updated tests

Author: slischka

Makefile

@@ -1,4 +1,4 @@
-.PHONY: install install-php install-js test test-php test-e2e phpstan phpcs lint-php dc-up dc-down wporg-sync release-prepare
+.PHONY: install install-php install-js test test-php test-e2e phpstan phpstan-baseline phpcs lint-php dc-up dc-down wporg-sync release-prepare
 
 install: install-php install-js
 
@@ -19,6 +19,9 @@ test-e2e:
 phpstan:
 	php vendor/bin/phpstan analyse -c phpstan.neon
 
+phpstan-baseline:
+	php vendor/bin/phpstan analyse -c phpstan.neon --generate-baseline=phpstan-baseline.neon --allow-empty-baseline
+
 phpcs:
 	php vendor/bin/phpcs --standard=phpcs.xml
 

phpstan-baseline.neon

@@ -0,0 +1,25 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Method FapiConversionPlugin\\Admin\\SettingsPage\:\:renderConsentSection\(\) is unused\.$#'
+			identifier: method.unused
+			count: 1
+			path: src/Admin/SettingsPage.php
+
+		-
+			message: '#^Call to function load_plugin_textdomain\(\) on a separate line has no effect\.$#'
+			identifier: function.resultUnused
+			count: 1
+			path: src/Plugin.php
+
+		-
+			message: '#^Function load_plugin_textdomain invoked with 3 parameters, 0 required\.$#'
+			identifier: arguments.count
+			count: 1
+			path: src/Plugin.php
+
+		-
+			message: '#^Parameter \#2 \$callback of function add_action expects callable\(mixed \.\.\.\)\: mixed, array\{\$this\(FapiConversionPlugin\\Plugin\), ''enqueueAdminAssets''\} given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/Plugin.php

phpstan-bootstrap.php

@@ -0,0 +1,14 @@
+<?php
+
+if (!defined('ABSPATH')) {
+    define('ABSPATH', __DIR__ . '/');
+}
+if (!defined('FAPI_SIGNALS_PATH')) {
+    define('FAPI_SIGNALS_PATH', __DIR__ . '/');
+}
+if (!defined('FAPI_SIGNALS_URL')) {
+    define('FAPI_SIGNALS_URL', 'https://example.org/wp-content/plugins/fapi-signals/');
+}
+if (!defined('FAPI_SIGNALS_VERSION')) {
+    define('FAPI_SIGNALS_VERSION', '0.1.0');
+}

phpstan.neon

@@ -1,9 +1,12 @@
+includes:
+  - phpstan-baseline.neon
+
 parameters:
   level: 6
+  bootstrapFiles:
+    - phpstan-bootstrap.php
   ignoreErrors:
     - '#Function .* not found\.#'
-    - '#Instantiated class .* not found\.#'
-    - '#class\.notFound#'
   paths:
     - fapi-signals.php
     - uninstall.php

src/Admin/SettingsPage.php

@@ -120,16 +120,6 @@ public function renderPage(): void
         <?php
     }
 
-    private function checkbox(string $name, bool $checked): string
-    {
-        return sprintf(
-            '<input type="checkbox" name="%s[%s]" value="1" %s>',
-            esc_attr(Settings::OPTION_KEY),
-            esc_attr($name),
-            checked($checked, true, false)
-        );
-    }
-
     private function switchMarkup(string $name, bool $checked, string $ariaLabel, bool $defaultWhenNotSet = false): string
     {
         $out = '<label class="fapi-switch" aria-label="' . esc_attr($ariaLabel) . '">';

src/Plugin.php

@@ -33,7 +33,7 @@ public function __construct()
 
     public function init(): void
     {
-        add_action('plugins_loaded', function () {
+        add_action('plugins_loaded', function (): void {
             load_plugin_textdomain(
                 'fapi-signals',
                 false,

src/ServerSide/PayloadBuilder.php

@@ -110,7 +110,7 @@ private function buildUserProfile(): array
             return [];
         }
         $user = wp_get_current_user();
-        if (!$user || !isset($user->ID) || (int) $user->ID <= 0) {
+        if (!isset($user->ID) || (int) $user->ID <= 0) {
             return [];
         }
 

tests/PageViewDispatcherTest.php

@@ -2,27 +2,34 @@
 
 namespace {
     if (!function_exists('sanitize_text_field')) {
-        function sanitize_text_field($value)
+        /** @param string $value */
+        function sanitize_text_field($value): string
         {
             return $value;
         }
     }
 
     if (!function_exists('esc_url_raw')) {
-        function esc_url_raw($value)
+        /** @param string $value */
+        function esc_url_raw($value): string
         {
             return $value;
         }
     }
 
     if (!function_exists('wp_generate_uuid4')) {
-        function wp_generate_uuid4()
+        function wp_generate_uuid4(): string
         {
             return 'uuid-1';
         }
     }
 
     if (!function_exists('wp_remote_post')) {
+        /**
+         * @param string $url
+         * @param array<string, mixed> $args
+         * @return array{response: array{code: int}}
+         */
         function wp_remote_post($url, $args)
         {
             $GLOBALS['remotePosts'][] = [$url, $args];
@@ -31,13 +38,19 @@ function wp_remote_post($url, $args)
     }
 
     if (!function_exists('wp_json_encode')) {
-        function wp_json_encode($value)
+        /** @param mixed $value */
+        function wp_json_encode($value): string
         {
             return json_encode($value);
         }
     }
 
     if (!function_exists('get_option')) {
+        /**
+         * @param string $key
+         * @param mixed $default
+         * @return mixed
+         */
         function get_option($key, $default = null)
         {
             return $GLOBALS['testOptions'][$key] ?? $default;
@@ -46,13 +59,16 @@ function get_option($key, $default = null)
 
     class WP_REST_Request
     {
+        /** @var array<string, mixed> */
         private array $params;
 
+        /** @param array<string, mixed> $params */
         public function __construct(array $params)
         {
             $this->params = $params;
         }
 
+        /** @return mixed */
         public function get_param(string $key)
         {
             return $this->params[$key] ?? null;
@@ -61,9 +77,11 @@ public function get_param(string $key)
 
     class WP_REST_Response
     {
+        /** @var array<string, mixed> */
         public array $data;
         public int $status;
 
+        /** @param array<string, mixed> $data */
         public function __construct(array $data, int $status)
         {
             $this->data = $data;
@@ -112,10 +130,12 @@ public function testHandlePageViewSendsPayload(): void
             $response = $dispatcher->handlePageView($request);
 
             $this->assertSame('sent', $response->data['status']);
-            $this->assertSame(1, count($GLOBALS['remotePosts']));
+            /** @var list<array{0: string, 1: mixed}> $posts */
+            $posts = $GLOBALS['remotePosts'];
+            $this->assertSame(1, count($posts));
             $this->assertSame(
                 'https://graph.facebook.com/v18.0/123/events?access_token=token',
-                $GLOBALS['remotePosts'][0][0]
+                $posts[0][0]
             );
         }
     }

tests/PayloadBuilderTest.php

@@ -9,6 +9,7 @@ function is_user_logged_in(): bool
     }
 
     if (!function_exists('wp_get_current_user')) {
+        /** @return \stdClass */
         function wp_get_current_user()
         {
             $user = new stdClass();
@@ -21,6 +22,12 @@ function wp_get_current_user()
     }
 
     if (!function_exists('get_user_meta')) {
+        /**
+         * @param int $userId
+         * @param string $key
+         * @param bool $single
+         * @return mixed
+         */
         function get_user_meta($userId, $key, $single = true)
         {
             return $GLOBALS['testUserMeta'][$key] ?? '';

tests/PluginInitTest.php

@@ -2,6 +2,10 @@
 
 namespace {
     if (!function_exists('add_action')) {
+        /**
+         * @param string $hook
+         * @param callable(mixed...): mixed $callback
+         */
         function add_action($hook, $callback): void
         {
             $GLOBALS['testActions'][] = [$hook, $callback];