Merge remote-tracking branch 'origin' into PRESS11-17-v2

.github/workflows/lint.yml

@@ -22,7 +22,7 @@ jobs:
     steps:
 
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # User PHP 7.4 here for compatibility with the WordPress codesniffer rules.
       - name: Setup PHP
@@ -32,32 +32,41 @@ jobs:
           coverage: none
           tools: composer, cs2pr
 
-      - uses: technote-space/get-diff-action@v6
+      - uses: technote-space/get-diff-action@v6 # repo is archived.
         with:
           SUFFIX_FILTER: .php
 
       - name: Get Composer cache directory
         id: composer-cache
         run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
-        if: "!! env.GIT_DIFF"
 
       - name: Cache Composer vendor directory
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
           restore-keys: |
             ${{ runner.os }}-composer-
-        if: "!! env.GIT_DIFF"
 
       - name: Validate composer.json and composer.lock
         run: composer validate
-        if: "!! env.GIT_DIFF"
 
       - name: Install dependencies
         run: composer install --no-progress --optimize-autoloader --prefer-dist
-        if: "!! env.GIT_DIFF"
+
+      - name: Fix auto-fixable PHP Code Standards Violations
+        continue-on-error: true
+        run: vendor/bin/phpcbf --standard=phpcs.xml
+
+      - name: Commit PHPCBF changes on main
+        if: ${{ github.ref == 'refs/heads/main' }} # only commit on main
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "🤖 PHPCBF"
+          commit_options: ""
+        env:
+          GITHUB_TOKEN: "${{ github.token }}"
 
       - name: Detecting PHP Code Standards Violations
-        run: vendor/bin/phpcs --standard=phpcs.xml -s ${{ env.GIT_DIFF }}
+        run: vendor/bin/phpcs --standard=phpcs.xml -s ${{ env.GIT_DIFF }} --report=checkstyle | cs2pr
         if: "!! env.GIT_DIFF"

.github/workflows/codecoverage-main.yml → .github/workflows/unit-tests-and-coverage-report.yml

@@ -1,4 +1,4 @@
-name: Codecoverage-Main
+name: Unit tests + Code coverage report
 
 # Runs PHPUnit unit and Codeception wp-browser wpunit tests, merges the code coverage, commits the html report to
 # GitHub Pages, generates a README badge with the coverage percentage.
@@ -7,6 +7,11 @@ on:
   push:
     branches:
       - main
+  pull_request:
+    types: [ opened, reopened, ready_for_review, synchronize ]
+    branches:
+      - main
+  workflow_dispatch:
 
 jobs:
 
@@ -25,31 +30,36 @@ jobs:
 
     strategy:
       matrix:
-        php: [ '7.4' ]
+        php: [ '7.3', '7.4', '8.0', '8.1', '8.2', '8.3' ]
 
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-
-      - name: Check does gh-pages branch need to be created
-        run: |
-          if [[ $(git branch -l gh-pages) == "" ]]; then
-            gh_pages_branch_needed=true
-          else
-            gh_pages_branch_needed=false
-          fi
-          echo "GH_PAGES_BRANCH_NEEDED=$gh_pages_branch_needed" >> $GITHUB_ENV;
-          mkdir gh-pages
-
-      - name:  Maybe create gh-pages branch
-        if: ${{ env.GH_PAGES_BRANCH_NEEDED }}
-        uses: peaceiris/actions-gh-pages@v4
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./gh-pages
-          force_orphan: true
-          allow_empty_commit: true
-          commit_message: "🤖 Creating gh-pages branch"
+          fetch-depth: 0 # attempting to get all branch names.
+
+#      - name: Check does gh-pages branch need to be created
+#        run: |
+#          git branch -l;
+#          if [[ $(git branch -l gh-pages) == "" ]]; then
+#            gh_pages_branch_needed=true;
+#            echo "gh-pages branch is needed";
+#          else
+#            gh_pages_branch_needed=false
+#            echo "gh-pages branch already exists";
+#          fi
+#          echo "GH_PAGES_BRANCH_NEEDED=$gh_pages_branch_needed" >> $GITHUB_ENV;
+#          mkdir gh-pages
+#
+#      - name:  Maybe create gh-pages branch
+#        if: ${{ env.GH_PAGES_BRANCH_NEEDED }}
+#        uses: peaceiris/actions-gh-pages@v4
+#        with:
+#          github_token: ${{ secrets.GITHUB_TOKEN }}
+#          publish_dir: ./gh-pages
+#          force_orphan: true
+#          allow_empty_commit: true
+#          commit_message: "🤖 Creating gh-pages branch"
 
       - name: Checkout GitHub Pages branch for code coverage report
         uses: actions/checkout@v3
@@ -102,6 +112,7 @@ jobs:
         run: php-coverage-badger gh-pages/phpunit/clover.xml gh-pages/phpunit/coverage.svg
 
       - name: Commit code coverage to gh-pages
+        if: ${{ github.ref == 'refs/heads/main' && matrix.php-version == '7.3' }} # only commit on main, on the PHP version we're using in production.
         uses: stefanzweifel/git-auto-commit-action@v5
         with:
           repository: gh-pages

includes/Event.php

@@ -90,7 +90,5 @@ public function __construct( $category = 'Admin', $key = '', $data = array() ) {
 			'role'   => ( ! empty( $user->roles[0] ) ) ? $user->roles[0] : '',
 			'locale' => get_user_locale(),
 		);
-
 	}
-
 }

includes/EventQueue/EventQueue.php

@@ -36,16 +36,16 @@ public static function getInstance() {
 	/**
 	 * Constructor
 	 *
-	 * @param  Container  $container
+	 * @param  Container $container
 	 */
 	private function __construct() {
 
 		global $wpdb;
 
 		$container = new Container(
-			[
+			array(
 				'table' => "{$wpdb->prefix}nfd_data_event_queue",
-			]
+			)
 		);
 
 		$container->set(
@@ -86,5 +86,4 @@ public function container() {
 	public function queue() {
 		return $this->container->get( 'queue' );
 	}
-
 }

includes/EventQueue/Queryable.php

@@ -26,8 +26,8 @@ protected function table() {
 	 * Bulk inserts records into a table using WPDB.  All rows must contain the same keys.
 	 * Returns number of affected (inserted) rows.
 	 *
-	 * @param  string  $table
-	 * @param  non-empty-array  $rows
+	 * @param  string          $table
+	 * @param  non-empty-array $rows
 	 *
 	 * @return bool|int
 	 */
@@ -63,5 +63,4 @@ protected function bulkInsert( string $table, array $rows ) {
 		// Run the query.  Returns number of affected rows.
 		return $wpdb->query( $wpdb->prepare( $sql, $data ) );
 	}
-
 }

includes/EventQueue/Queues/BatchQueue.php

@@ -20,7 +20,7 @@ class BatchQueue implements BatchQueueInterface {
 	/**
 	 * Constructor
 	 *
-	 * @param  Container  $container
+	 * @param  Container $container
 	 */
 	public function __construct( Container $container ) {
 		$this->container = $container;
@@ -29,21 +29,21 @@ public function __construct( Container $container ) {
 	/**
 	 * Push events onto the queue
 	 *
-	 * @param  non-empty-array<Event>  $events
+	 * @param  non-empty-array<Event> $events
 	 *
 	 * @return bool
 	 */
 	public function push( array $events ) {
 
 		$time = current_time( 'mysql' );
 
-		$inserts = [];
+		$inserts = array();
 		foreach ( $events as $event ) {
-			$inserts[] = [
+			$inserts[] = array(
 				'event'        => serialize( $event ),
 				'available_at' => current_time( 'mysql' ),
 				'created_at'   => $time,
-			];
+			);
 		}
 
 		return (bool) $this->bulkInsert( $this->table(), $inserts );
@@ -56,7 +56,7 @@ public function push( array $events ) {
 	 */
 	public function pull( int $count ) {
 
-		$events = [];
+		$events = array();
 
 		$rawEvents = $this
 			->query()
@@ -84,7 +84,7 @@ public function pull( int $count ) {
 	/**
 	 * Remove events from the queue
 	 *
-	 * @param  int[]  $ids
+	 * @param  int[] $ids
 	 *
 	 * @return bool
 	 */
@@ -99,7 +99,7 @@ public function remove( array $ids ) {
 	/**
 	 * Reserve events in the queue
 	 *
-	 * @param  int[]  $ids
+	 * @param  int[] $ids
 	 *
 	 * @return bool
 	 */
@@ -108,13 +108,13 @@ public function reserve( array $ids ) {
 			->query()
 			->table( $this->table(), false )
 			->whereIn( 'id', $ids )
-			->update( [ 'reserved_at' => current_time( 'mysql' ) ] );
+			->update( array( 'reserved_at' => current_time( 'mysql' ) ) );
 	}
 
 	/**
 	 * Release events back onto the queue
 	 *
-	 * @param  int[]  $ids
+	 * @param  int[] $ids
 	 *
 	 * @return bool
 	 */
@@ -123,7 +123,7 @@ public function release( array $ids ) {
 			->query()
 			->table( $this->table(), false )
 			->whereIn( 'id', $ids )
-			->update( [ 'reserved_at' => null ] );
+			->update( array( 'reserved_at' => null ) );
 	}
 
 	/**

includes/EventQueue/Queues/BatchQueueInterface.php

@@ -9,7 +9,7 @@ interface BatchQueueInterface {
 	/**
 	 * Push one or more events onto the queue
 	 *
-	 * @param  Event[]  $events
+	 * @param  Event[] $events
 	 *
 	 * @return bool
 	 */
@@ -25,7 +25,7 @@ public function pull( int $count );
 	/**
 	 * Remove one or more events from the queue
 	 *
-	 * @param  Event[]  $events
+	 * @param  Event[] $events
 	 *
 	 * @return bool
 	 */
@@ -34,7 +34,7 @@ public function remove( array $events );
 	/**
 	 * Reserve one or more events in the queue
 	 *
-	 * @param  Event[]  $events
+	 * @param  Event[] $events
 	 *
 	 * @return bool
 	 */
@@ -43,7 +43,7 @@ public function reserve( array $events );
 	/**
 	 * Release one or more events back onto the queue
 	 *
-	 * @param  Event[]  $events
+	 * @param  Event[] $events
 	 *
 	 * @return bool
 	 */
@@ -55,5 +55,4 @@ public function release( array $events );
 	 * @return int
 	 */
 	public function count();
-
 }

includes/Helpers/SiteHealth.php

@@ -122,7 +122,7 @@ public static function calculate_score( $results ) {
 
 		$total_tests = array_reduce(
 			$results,
-			function( $total, $item ) {
+			function ( $total, $item ) {
 				return $total += (int) $item;
 			}
 		);
@@ -134,5 +134,4 @@ function( $total, $item ) {
 
 		return round( (int) $results['good'] / $total_tests * 100 );
 	}
-
 }

includes/Listeners/Content.php

@@ -25,8 +25,8 @@ public function register_hooks() {
 	/**
 	 * Post status transition
 	 *
-	 * @param string $new_status The new post status
-	 * @param string $old_status The old post status
+	 * @param string   $new_status The new post status
+	 * @param string   $old_status The old post status
 	 * @param \WP_Post $post Post object
 	 *
 	 * @return void
@@ -94,8 +94,8 @@ public function count_posts() {
 	/**
 	 * Comment status transition
 	 *
-	 * @param string $new_status The new comment status
-	 * @param string $old_status The new comment status
+	 * @param string     $new_status The new comment status
+	 * @param string     $old_status The new comment status
 	 * @param WP_Comment $comment Comment object
 	 *
 	 * @return void

includes/Listeners/Listener.php

@@ -55,5 +55,4 @@ protected function get_class_name() {
 
 		return substr( $class, $position + 1 );
 	}
-
 }

includes/Listeners/SiteHealth.php

@@ -33,8 +33,8 @@ public function tests_run( $value ) {
 		$this->push(
 			'site_health_score',
 			array(
-				'label_key' => 'score', 
-				'score' => SiteHealthHelper::calculate_score( $value ),
+				'label_key' => 'score',
+				'score'     => SiteHealthHelper::calculate_score( $value ),
 			)
 		);
 		$this->push(