Merge upstream changes

.devcontainer/devcontainer.json

@@ -0,0 +1,27 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/php
+{
+	"name": "PHP",
+	"build": {
+		"dockerfile": "docker/Dockerfile"
+	},
+	"features": {
+		"ghcr.io/devcontainers/features/docker-in-docker:2": {}
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"junstyle.php-cs-fixer",
+				"GitHub.vscode-github-actions"
+			],
+			"settings": {
+				"php-cs-fixer.onsave": true,
+				"[php]": {
+					"editor.defaultFormatter": "junstyle.php-cs-fixer"
+				}
+			}
+		}
+	},
+	"postCreateCommand": ".devcontainer/postCreate.sh",
+	"remoteUser": "vscode"
+}

.devcontainer/docker/Dockerfile

@@ -0,0 +1,44 @@
+########################## Base ###########################
+# Create & configure the base for this DevContainer image #
+###########################################################
+
+# Define the DevContainer template to be used as the base
+ARG PHP=8.3
+ARG DISTRO=bullseye
+
+FROM mcr.microsoft.com/vscode/devcontainers/php:$PHP-$DISTRO
+
+# Add global Composer /bin to PATH for vscode
+USER vscode
+
+RUN echo "export PATH=\$(XDEBUG_MODE=off composer global config bin-dir --absolute --quiet):\$PATH" >> ~/.bashrc
+
+# Add global Composer /bin to PATH for root
+USER root
+
+RUN echo "export PATH=\$(XDEBUG_MODE=off composer global config bin-dir --absolute --quiet):\$PATH" >> ~/.bashrc
+
+##################### Dependencies #####################
+# Add any dependencies required to develop the project #
+########################################################
+
+# 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
+
+
+###################### Tools ######################
+# Install tools that are required for development #
+###################################################
+
+# 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
+
+# Install PHP Code Sniffer Fixer
+USER vscode
+
+RUN composer global require friendsofphp/php-cs-fixer

.devcontainer/postCreate.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# Install dependencies using Composer
+if [ ! -f composer.lock ]; then
+    composer install
+fi

.github/workflows/Tests.yml

@@ -16,38 +16,37 @@ jobs:
         php: [8.1, 8.2, 8.3]
         ocular: [^1.9]
         experimental: [false]
-        composer-extra: ['']
+        composer-extra: [""]
         include:
           - php: 8.4
             experimental: true
     env:
       PHP_VERSION: ${{ matrix.php }}
     name: PHP ${{ matrix.php }}
     steps:
-
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           extensions: bz2,xml,curl
 
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 10
 
       - name: Validate composer.json
         run: composer validate
 
       - name: Cache composer files
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.composer/cache/files
           key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
 
       - name: Install dependencies using composer
         run: composer install --prefer-dist --no-interaction ${{ matrix.composer-extra }}
-       
+
       - name: PHP CodeStyle
         run: |
           mkdir -p build/logs

.gitignore

@@ -1,12 +1,28 @@
+# Development
+/remotes/
+test.php
 /.buildpath
 /.project
 /.settings/*
-vendor
+
+# JetBrains
 /.idea
-.phpunit.result.cache
+*.iml
+
+# Composer
+vendor
 composer.lock
 composer.phar
+
+# ApiGen
+build/apigen
+
+# PHPUnit
+phpunit.xml
+.phpunit.result.cache
+coverage/
+build/logs/*
 !build/logs/.gitkeep
-build/logs/
-test.php
-*.iml
+
+# PHP Code Sniffer Fixer
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,29 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in([
+        __DIR__.'/src',
+        __DIR__.'/tests',
+    ])
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR2' => true,
+
+        /* Imports / use */
+        'no_unused_imports' => true,
+        'no_unneeded_import_alias' => true,
+        'no_leading_import_slash' => true,
+        'ordered_imports' => true,
+
+        /* Comments */
+        'single_line_comment_style' => true,
+
+        /* Blank lines */
+        'no_extra_blank_lines' => [
+            'tokens' => ['curly_brace_block']
+        ]
+    ])
+    ->setFinder($finder)
+;

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "junstyle.php-cs-fixer",
+        "github.vscode-github-actions"
+    ]
+}

.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Tests",
+            "type": "php",
+            "request": "launch",
+            "port": 0,
+            "cwd": "${workspaceFolder}",
+            "runtimeArgs": [
+                "-dxdebug.mode=debug,develop",
+                "-dxdebug.client_port=${port}",
+                "-dxdebug.start_with_request=yes"
+            ],
+            "program": "${workspaceFolder}/vendor/bin/phpunit",
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,72 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Test",
+            "isTestCommand": true,
+            "dependsOrder": "sequence",
+            "dependsOn": [
+                "PHP Code Sniffer",
+                "PHP Mess Detector",
+                "PHPUnit"
+            ] 
+        },
+        {
+            "label": "PHP Code Sniffer",
+            "type": "shell",
+            "command": "vendor/bin/phpcs",
+            "args": [
+                "src",
+                "tests",
+                "--extensions=php",
+                "--ignore=bootstrap",
+                "--report=checkstyle",
+                "--report-file=build/logs/checkstyle.xml",
+                "--standard=build/config/phpcs.xml",
+                "-v"
+            ]
+        },
+        {
+            "label": "PHP Coding Standards Fixer",
+            "type": "shell",
+            "command": "php-cs-fixer",
+            "args": [
+                "fix"
+            ]
+        },
+        {
+            "label": "PHP Mess Detector",
+            "type": "shell",
+            "command": "vendor/bin/phpmd",
+            "args": [
+                "src,tests",
+                "xml",
+                "build/config/phpmd.xml"
+            ]
+        },
+        {
+            "label": "PHPUnit",
+            "type": "shell",
+            "command": "vendor/bin/phpunit"
+        },
+        {
+            "label": "GitHub Workflows",
+            "type": "shell",
+            "command": "act",
+            "args": [
+                "--platform=ubuntu-latest=catthehacker/ubuntu:act-latest",
+                "--job=${input:GitHubWorkflowsJob}"
+            ] 
+        },
+    ],
+    "inputs": [
+        {
+            "id": "GitHubWorkflowsJob",
+            "type": "promptString",
+            "description": "Job:",
+            "default": "CI"
+        }
+    ]
+}

GameQ.code-workspace

@@ -0,0 +1,8 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+	],
+	"settings": {}
+}

README.md

@@ -1,4 +1,5 @@
 # GameQ Fork by Krymo Software
+
 [![CI](https://github.com/KrymoSoftware/GameQ/actions/workflows/Tests.yml/badge.svg)](https://github.com/KrymoSoftware/GameQ/actions/workflows/Tests.yml)
 [![License](https://img.shields.io/badge/license-LGPL-blue.svg?style=flat)](https://packagist.org/packages/krymosoftware/gameq)
 
@@ -8,11 +9,14 @@ This repository is a maintained fork of [Austinb/GameQ](https://github.com/Austi
 While we don't plan to add new games for now, we'll ensure compatibility with the latest PHP versions and fix issues as they arise.
 
 ## Requirements
+
 * PHP 8.1+ - [Tested](https://github.com/KrymoSoftware/GameQ/actions/workflows/Tests.yml) in PHP 8.1, 8.2 and 8.3
 * [Bzip2](http://www.php.net/manual/en/book.bzip2.php) - Used for A2S compressed responses
 
 ## Installation
+
 #### [Composer](https://getcomposer.org/)
+
 This method assumes you already have composer [installed](https://getcomposer.org/doc/00-intro.md) and working properly. Add `krymosoftware/gameq` as a requirement to composer.json by using `composer require krymosoftware/gameq:^4.0.0` or by manually adding the following to the *composer.json* file in the **require** section:
 
 ```json
@@ -22,14 +26,17 @@ This method assumes you already have composer [installed](https://getcomposer.or
 Update your packages with `composer update` or install with `composer install`.
 
 #### Standalone Library
+
 Download the [latest version](https://github.com/KrymoSoftware/GameQ/releases) of the library and unpack it into your project. Add the following to your bootstrap file:
 
 ```php
 require_once('/path/to/src/GameQ/Autoloader.php');
 ```
+
 The `Autoloader.php` file provides the same autoloading functionality as the Composer installation.
 
-## Example
+## Useage
+
 ```php
 $GameQ = new \GameQ\GameQ();
 $GameQ->addServer([
@@ -38,13 +45,15 @@ $GameQ->addServer([
 ]);
 $results = $GameQ->process();
 ```
-Need more? See [Examples](https://github.com/Austinb/GameQ/wiki/Examples-v3).
 
-## Contributing 
-
+Need more? See the [Examples](https://github.com/Austinb/GameQ/wiki/Examples-v3) as well as the [Documentation](https://austinb.github.io/GameQ/api/).
+
+## Contributing
+
 Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## License
+
 See [LICENSE](LICENSE.lgpl) for more information
 
 ## Third Party Provider

src/GameQ/Autoloader.php

@@ -28,7 +28,6 @@
  * See: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader-examples.md
  */
 spl_autoload_register(static function ($class) {
-
     // project-specific namespace prefix
     $prefix = 'GameQ\\';