Solve warnings and remove deprecated code

.devcontainer/devcontainer.json

@@ -5,6 +5,9 @@
 	"build": {
 		"dockerfile": "docker/Dockerfile"
 	},
+	"features": {
+		"ghcr.io/devcontainers/features/docker-in-docker:2": {}
+	},
 	"postCreateCommand": ".devcontainer/postCreate.sh",
 	"remoteUser": "vscode"
 }

.devcontainer/docker/Dockerfile

@@ -1,11 +1,16 @@
 # Define the DevContainer template to be used as the base
-ARG TAG=8.2-bullseye
-FROM mcr.microsoft.com/vscode/devcontainers/php:$TAG
+ARG PHP=8.3
+ARG DISTRO=bullseye
+
+FROM mcr.microsoft.com/vscode/devcontainers/php:$PHP-$DISTRO
 
 # Update the registry once
 RUN apt-get update
 
 # Install ext-bz2
 RUN apt-get install -y libbz2-dev \
     && docker-php-ext-configure bz2 \
-    && docker-php-ext-install bz2
+    && docker-php-ext-install bz2
+
+# Install act
+RUN curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash -s -- -b /usr/local/bin

.github/workflows/Tests.yml

@@ -15,16 +15,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [7.0, 7.1, 7.2, 7.3, 7.4, 8.0, 8.1]
+        php: [5.6, 7.0, 7.1, 7.2, 7.3, 7.4, 8.0, 8.1, 8.2, 8.3]
         experimental: [false]
         composer-extra: ['']
         include:
-          - php: 5.6
-            experimental: false
-          - php: 8.2
-            experimental: false
-          - php: 8.3
-            experimental: false
           - php: 8.4
             experimental: true
             composer-extra: '--ignore-platform-req=php+'
@@ -66,15 +60,23 @@ jobs:
         run: vendor/bin/phpunit -c phpunit.xml --verbose
 
       - name: Upload Coveralls coverage
-        if: github.repository == 'Austinb/GameQ'
-        env:
-          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          composer global require php-coveralls/php-coveralls
-          php ~/.composer/vendor/bin/php-coveralls --coverage_clover=build/logs/clover.xml -v
+        uses: coverallsapp/github-action@v2
+        with:
+          parallel: true
+          file: build/logs/clover.xml
 
       - name: Upload Scrutinizer coverage
         uses: sudo-bot/action-scrutinizer@latest
         if: github.repository == 'Austinb/GameQ'
         with:
             cli-args: "--format=php-clover build/logs/clover.xml --revision=${{ github.event.pull_request.head.sha || github.sha }}"
+
+  Finish:
+    needs: CI
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@v2
+      with:
+        parallel-finished: true

.gitignore

@@ -17,4 +17,5 @@ composer.phar
 # PHPUnit
 .phpunit.result.cache
 coverage/
-build/logs/
+build/logs/*
+!build/logs/.gitkeep

src/GameQ/Buffer.php

@@ -46,28 +46,28 @@ class Buffer
     /**
      * The number type we use for reading integers.  Defaults to little endian
      *
-     * @type string
+     * @var string
      */
     private $number_type = self::NUMBER_TYPE_LITTLEENDIAN;
 
     /**
      * The original data
      *
-     * @type string
+     * @var string
      */
     private $data;
 
     /**
      * The original data
      *
-     * @type int
+     * @var int
      */
     private $length;
 
     /**
      * Position of pointer
      *
-     * @type int
+     * @var int
      */
     private $index = 0;
 

src/GameQ/Filters/Base.php

@@ -18,6 +18,7 @@
 
 namespace GameQ\Filters;
 
+use GameQ\Concerns\WithArrayHelpers;
 use GameQ\Server;
 
 /**
@@ -27,11 +28,10 @@
  */
 abstract class Base
 {
-
     /**
      * Holds the options for this instance of the filter
      *
-     * @type array
+     * @var array
      */
     protected $options = [];
 

src/GameQ/Filters/Normalize.php

@@ -23,111 +23,130 @@
 /**
  * Class Normalize
  *
+ * This Filter is responsible for normalizing the provided result's
+ * property names to the GameQ standard.
+ *
  * @package GameQ\Filters
  */
 class Normalize extends Base
 {
+    /**
+     * Determines if data should be persisted for unit testing.
+     *
+     * @var bool
+     */
+    protected $writeTestData = false;
 
     /**
      * Holds the protocol specific normalize information
      *
-     * @type array
+     * @var array
      */
     protected $normalize = [];
 
     /**
      * Apply this filter
      *
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     *
      * @param array         $result
      * @param \GameQ\Server $server
      *
      * @return array
      */
     public function apply(array $result, Server $server)
     {
+        /* Determine if there is data to be processed */
+        if (! empty($result)) {
+            /* Handle unit test data generation */
+            if ($this->writeTestData) {
+                /* Initialize potential data for unit testing **/
+                $unitTestData = [ ];
+
+                /* Add the initial result to the unit test data */
+                $unitTestData['raw'][$server->id()] = $result;
+            }
 
-        // No result passed so just return
-        if (empty($result)) {
-            return $result;
-        }
-
-        //$data = [ ];
-        //$data['raw'][$server->id()] = $result;
+            /* Grab the normalize definition from the server's protocol */#
+            $this->normalize = $server->protocol()->getNormalize();
 
-        // Grab the normalize for this protocol for the specific server
-        $this->normalize = $server->protocol()->getNormalize();
+            /* Normalize general information */
+            $result = array_merge($result, $this->check('general', $result));
 
-        // Do general information
-        $result = array_merge($result, $this->check('general', $result));
+            /* Normalize player information */
+            if (isset($result['players']) && count($result['players']) > 0) {
+                foreach ($result['players'] as $key => $player) {
+                    $result['players'][$key] = array_merge($player, $this->check('player', $player));
+                }
+            } else {
+                $result['players'] = [];
+            }
 
-        // Do player information
-        if (isset($result['players']) && count($result['players']) > 0) {
-            // Iterate
-            foreach ($result['players'] as $key => $player) {
-                $result['players'][$key] = array_merge($player, $this->check('player', $player));
+            /* Normalize team information */
+            if (isset($result['teams']) && count($result['teams']) > 0) {
+                foreach ($result['teams'] as $key => $team) {
+                    $result['teams'][$key] = array_merge($team, $this->check('team', $team));
+                }
+            } else {
+                $result['teams'] = [];
             }
-        } else {
-            $result['players'] = [];
-        }
 
-        // Do team information
-        if (isset($result['teams']) && count($result['teams']) > 0) {
-            // Iterate
-            foreach ($result['teams'] as $key => $team) {
-                $result['teams'][$key] = array_merge($team, $this->check('team', $team));
+            /* Handle unit test data generation */
+            if ($this->writeTestData) {
+                /* Add the filtered result to the unit test data */
+                $unitTestData['filtered'][$server->id()] = $result;
+
+                /* Persist the collected data to the tests directory */
+                file_put_contents(
+                    sprintf('%s/../../../tests/Filters/Providers/Normalize/%s_1.json', __DIR__, $server->protocol()->getProtocol()),
+                    json_encode($unitTestData, JSON_UNESCAPED_UNICODE | JSON_PARTIAL_OUTPUT_ON_ERROR)
+                );
             }
-        } else {
-            $result['teams'] = [];
         }
 
-        //$data['filtered'][$server->id()] = $result;
-        /*file_put_contents(
-            sprintf('%s/../../../tests/Filters/Providers/Normalize/%s_1.json', __DIR__, $server->protocol()->getProtocol()),
-            json_encode($data, JSON_UNESCAPED_UNICODE | JSON_PARTIAL_OUTPUT_ON_ERROR)
-        );*/
-
-        // Return the normalized result
+        /* Return the filtered result */
         return $result;
     }
 
     /**
      * Check a section for normalization
      *
-     * @param $section
-     * @param $data
+     * @param string $section
+     * @param array $data
      *
      * @return array
      */
-    protected function check($section, $data)
+    protected function check($section, array $data)
     {
-
-        // Normalized return array
+        /* Initialize the normalized output */
         $normalized = [];
 
-        if (isset($this->normalize[$section]) && !empty($this->normalize[$section])) {
-            foreach ($this->normalize[$section] as $property => $raw) {
-                // Default the value for the new key as null
-                $value = null;
-
-                if (is_array($raw)) {
-                    // Iterate over the raw property we want to use
-                    foreach ($raw as $check) {
-                        if (array_key_exists($check, $data)) {
-                            $value = $data[$check];
-                            break;
-                        }
-                    }
-                } else {
-                    // String
-                    if (array_key_exists($raw, $data)) {
-                        $value = $data[$raw];
+        /* Ensure the provided section is defined */
+        if (isset($this->normalize[$section])) {
+            /* Process each mapping individually */
+            foreach ($this->normalize[$section] as $target => $source) {
+                /* Treat explicit source like implicit sources */
+                if (! is_array($source)) {
+                    $source = [$source];
+                }
+
+                /* Find the first possible source */
+                foreach ($source as $s) {
+                    /* Determine if the current source does exist */
+                    if (array_key_exists($s, $data)) {
+                        /* Add the normalized mapping */
+                        $normalized['gq_'.$target] = $data[$s];
+                        break;
                     }
                 }
 
-                $normalized['gq_' . $property] = $value;
+                /* Write null in case no source was found */
+                // TODO: Remove this in the next major version.
+                $normalized['gq_'.$target] = isset($normalized['gq_'.$target]) ? $normalized['gq_'.$target] : null;
             }
         }
 
+        /* Return the normalized data */
         return $normalized;
     }
 }