Fix tests

Author: szepeviktor

.gitignore

@@ -1 +1,2 @@
+/composer.lock
 /vendor/

composer.json

@@ -1,14 +1,18 @@
 {
     "require-dev": {
-        "wp-coding-standards/wpcs": "^2.1.0",
-        "dealerdirect/phpcodesniffer-composer-installer": "^0.4.4",
-        "szepeviktor/phpstan-wordpress": "^0.2.0",
-        "phpstan/phpstan-shim": "^0.11.16",
-        "php-stubs/wordpress-stubs": "^4.9"
+        "dealerdirect/phpcodesniffer-composer-installer": "^0.7",
+        "php-stubs/wordpress-stubs": "^4.9",
+        "szepeviktor/phpstan-wordpress": "^1.0",
+        "wp-coding-standards/wpcs": "^2.1"
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     },
     "scripts": {
-        "phpcs": "vendor/bin/phpcs",
-        "phpstan": "vendor/bin/phpstan analyze",
+        "phpcs": "phpcs",
+        "phpstan": "phpstan analyze",
         "test": [
             "@phpcs",
             "@phpstan"

phpcs.xml

@@ -19,16 +19,12 @@
         </properties>
     </rule>
     <rule ref="WordPress-Core">
+        <exclude name="Generic.Arrays.DisallowShortArraySyntax"/>
+        <exclude name="Generic.Formatting.MultipleStatementAlignment"/>
         <exclude name="Generic.WhiteSpace.DisallowSpaceIndent"/>
     </rule>
-    <!-- <rule ref="WordPress-Docs"/> -->
-    <rule ref="WordPress-Extra"/>
-
 <!--
-    <rule ref="WordPress.PHP.DiscouragedPHPFunctions">
-        <properties>
-            <property name="exclude" value="obfuscation"/>
-        </properties>
-    </rule>
+    <rule ref="WordPress-Docs"/>
 -->
+    <rule ref="WordPress-Extra"/>
 </ruleset>

phpstan.neon

@@ -1,16 +1,16 @@
 includes:
-    - phar://phpstan.phar/conf/bleedingEdge.neon
     - vendor/szepeviktor/phpstan-wordpress/extension.neon
 parameters:
     level: max
     paths:
-        - %currentWorkingDirectory%/tiny-cache.php
-        - %currentWorkingDirectory%/tiny-nav-menu-cache.php
-        - %currentWorkingDirectory%/tiny-translation-cache.php
-    autoload_files:
-        - %currentWorkingDirectory%/tiny-cache.php
-        - %currentWorkingDirectory%/tiny-nav-menu-cache.php
-        - %currentWorkingDirectory%/tiny-translation-cache.php
+        - tiny-cache.php
+        - tiny-nav-menu-cache.php
+        - tiny-translation-cache.php
     ignoreErrors:
-        - '#^Function do_action invoked with [345] parameters, 1-2 required\.$#'
+#        - '#^Function do_action invoked with [345] parameters, 1-2 required\.$#'
         - '#^Function apply_filters invoked with [345] parameters, 2 required\.$#'
+        -
+            path: tiny-nav-menu-cache.php
+            message: '#^Access to an undefined property object::\$menu_id\.$#'
+            count: 1
+

tiny-nav-menu-cache.php

@@ -14,7 +14,7 @@ class Tiny_Nav_Menu_Cache {
     private const GROUP = 'navmenu';
 
     /**
-     * @var array List of whitelisted query string fields (these do not prevent cache write).
+     * @var array<string> List of whitelisted query string fields (these do not prevent cache write).
      */
     private $whitelisted_query_string_fields = [
         // https://support.google.com/searchads/answer/7342044
@@ -35,6 +35,9 @@ public function __construct() {
         add_action( 'init', array( $this, 'init' ) );
     }
 
+    /**
+     * @return void
+     */
     public function init() {
 
         // Detect object cache
@@ -49,22 +52,22 @@ public function init() {
         add_action( 'split_shared_term', array( $this, 'flush_all' ) );
 
         // Learned from W3TC Page Cache rules and WP Super Cache rules
-	if ( is_user_logged_in() /* User is logged in */
-	    || ! ( isset( $_SERVER['REQUEST_METHOD'] ) && 'GET' === $_SERVER['REQUEST_METHOD'] ) /* Not a GET request */ // WPCS: input var OK.
+        if ( is_user_logged_in() /* User is logged in */
+            || ! ( isset( $_SERVER['REQUEST_METHOD'] ) && 'GET' === $_SERVER['REQUEST_METHOD'] ) /* Not a GET request */ // WPCS: input var OK.
             || ( defined( 'DONOTCACHEPAGE' ) && DONOTCACHEPAGE ) /* DO-NOT-CACHE tag present */
         ) {
             return;
         }
 
-	// Add user-defined query parameters to the whitelist. Define the parameters you
-	// want whitelisted in wp-config in the following way:
-	//
-	// define('TINY_NAV_CACHE_WHITELIST_QUERY_STRING_FIELDS', 'XDEBUG_TRIGGER|do_xhprof_profile');
+        // Add user-defined query parameters to the whitelist. Define the parameters you
+        // want whitelisted in wp-config in the following way:
+        //
+        // define('TINY_NAV_CACHE_WHITELIST_QUERY_STRING_FIELDS', 'XDEBUG_TRIGGER|do_xhprof_profile');
 
-	if ( defined( 'TINY_NAV_CACHE_WHITELIST_QUERY_STRING_FIELDS' ) ) {
-		$fields = array_map( 'trim', explode( '|', TINY_NAV_CACHE_WHITELIST_QUERY_STRING_FIELDS) );
-		$this->whitelisted_query_string_fields = array_merge( $this->whitelisted_query_string_fields, $fields );
-	}
+        if ( defined( 'TINY_NAV_CACHE_WHITELIST_QUERY_STRING_FIELDS' ) ) {
+            $fields = array_map( 'trim', explode( '|', TINY_NAV_CACHE_WHITELIST_QUERY_STRING_FIELDS ) );
+            $this->whitelisted_query_string_fields = array_merge( $this->whitelisted_query_string_fields, $fields );
+        }
 
         add_filter( 'pre_wp_nav_menu', array( $this, 'get_nav_menu' ), 30, 2 );
         add_filter( 'wp_nav_menu', array( $this, 'save_nav_menu' ), PHP_INT_MAX, 2 );
@@ -81,6 +84,7 @@ public function get_nav_menu( $nav_menu_html, $args ) {
             $found = null;
             $cache = wp_cache_get( $this->get_cache_key( $args ), self::GROUP, false, $found );
             if ( $found ) {
+                /** @var string $cache */
                 return $cache;
             }
         }
@@ -104,6 +108,9 @@ public function save_nav_menu( $nav_menu_html, $args ) {
         return $nav_menu_html;
     }
 
+    /**
+     * @return void
+     */
     public function flush_all() {
 
         foreach ( $this->get_all_keys() as $key ) {
@@ -114,23 +121,25 @@ public function flush_all() {
 
     /**
      * @param string $key
+     * @return void
      */
     private function remember_key( $key ) {
 
         // @TODO Not atomic
-        $found    = false;
+        $found = false;
         $key_list = wp_cache_get( 'key_list', self::GROUP, false, $found );
 
         $key_list = $found ? $key_list . '|' . $key : $key;
         wp_cache_set( 'key_list', $key_list, self::GROUP, DAY_IN_SECONDS );
     }
 
     /**
-     * @return array
+     * @return array<string>
      */
     private function get_all_keys() {
 
-        $found    = null;
+        $found = null;
+        /** @var string $key_list */
         $key_list = wp_cache_get( 'key_list', self::GROUP, false, $found );
         if ( ! $found ) {
             $key_list = '';
@@ -161,7 +170,7 @@ private function is_enabled( $args ) {
 
         // Do not cache requests with query string except whitelisted ones.
         // phpcs:ignore WordPress.Security.NonceVerification.Recommended
-        if ( [] !== array_diff( array_keys( $_GET ), $this->whitelisted_query_string_fields) ) {
+        if ( [] !== array_diff( array_keys( $_GET ), $this->whitelisted_query_string_fields ) ) {
             return false;
         }