Merge pull request #5 from sweptsquash/feat/ImprovementsAndTests

Improvements and tests

Author: jamesread

.github/workflows/lint.yml

@@ -12,6 +12,28 @@ jobs:
         with:
           ref: ${{ github.head_ref }}
 
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.4
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          coverage: none
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install Composer dependencies
+        run: |
+          composer install --no-progress --no-scripts -n -o
+
       - name: Fix PHP code style issues
         uses: aglipanci/[email protected]
         with:

.github/workflows/run-tests.yml

@@ -0,0 +1,46 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [8.4, 8.3, 8.2, 8.1]
+        dependency-version: [prefer-lowest, prefer-stable]
+
+    name: P${{ matrix.php }} - ${{ matrix.dependency-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
+          coverage: none
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-${{ matrix.php }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-${{ matrix.php }}-composer-
+
+      - name: Setup Problem Matches
+        run: |
+          echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+          echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+      - name: Install dependencies
+        run: composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
+
+      - name: Execute tests
+        run: vendor/bin/pest

README.md

@@ -1,20 +1,11 @@
 # lan-party-publisher-php
 
-This is a PHP library that implements the LAN party publishing standard, making it easy to pull your own list of events from your own database, and publish those to the world, in a standard format that can be consumed by other sites (like http://lanlist.info).
+This package enables the creation of the LAN party publishing standard, making it easy to pull your own list of events and publish those to the world in a standard format that can be consumed by other sites (like [LANList](http://lanlist.info/)).
 
 ## Using the PHP Library
 
-Normally you should put your calling script and the library in the same subdirectory to keep things together. You should not need to edit the library yourself, as it makes upgrades a real pain in the future. If there are problems with the library, just raise an issue on GitHub.
-
-**Create a new folder for your publisher**, and `cd` into it.
-
 ```shell
-user@host: mkdir lan-party-publishing-standard/
-user@host: composer require jamesread/lan-party-publisher-php
+composer require jamesread/lan-party-publisher-php
 ```
 
-**Write a "calling script"** called "index.php" that that uses the library to build the list of JSON events. Look at the several [php examples](examples) to help get you started. The example below shows a simple `index.php` file using PDO to connect to a MySQL database.
-
-**index.php** - Start with the example code; [withPdoMySQLDatabase.php](examples/withPdoMySQLDatabase.php)
-
-Adapt the above code to your own database structure, and view the resulting JSON in your browser.
+Look at the [examples](examples) to help get you started.

composer.json

@@ -15,8 +15,11 @@
         "composer-runtime-api": "^2.2"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.11",
-        "laravel/pint": "^1.18"
+        "laravel/pint": "^1.18",
+        "orchestra/testbench-core": "^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
+        "pestphp/pest": "^1.22 || ^2.0",
+        "phpstan/phpstan": "^1.10.57 || ^2.0.2",
+        "phpunit/phpunit": "^9.3 || ^10.1"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
@@ -26,12 +29,16 @@
         }
     },
     "config": {
-        "allow-plugins": {},
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        },
         "sort-packages": true
     },
     "scripts": {
         "analyse": "./vendor/bin/phpstan analyse --memory-limit=512M",
         "lint": "vendor/bin/pint --preset psr12",
-        "lint:test": "vendor/bin/pint --preset psr12 --test"
+        "lint:test": "vendor/bin/pint --preset psr12 --test",
+        "test": "./vendor/bin/pest",
+        "test:coverage": "vendor/bin/pest --coverage"
     }
 }