fix: Deprecations for PHP 8.4 (#96)

Dockerfile → .docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.1
+FROM php:8.4
 
 WORKDIR /usr/src/app
 
@@ -15,7 +15,7 @@ RUN apt-get update \
 #     && docker-php-ext-install pdo mysqli pdo_mysql zip intl gd
 
 # Copy the PHP config
-# COPY php.ini /usr/local/etc/php/php.ini
+COPY php.ini /usr/local/etc/php/php.ini
 
 # Copy composer
 COPY --from=composer:2 /usr/bin/composer /usr/bin/composer

.docker/docker-compose.yml

@@ -0,0 +1,9 @@
+# Command to run from the project root :
+# docker-compose -f .docker/docker-compose.yml run --build dev /bin/bash
+services:
+  dev:
+    build: .
+    stdin_open: true
+    tty: true
+    volumes:
+      - ..:/usr/src/app

.docker/php.ini

@@ -0,0 +1,2 @@
+display_errors = On
+error_reporting = E_ALL | E_DEPRECATED | E_NOTICE

.github/workflows/build-test.yml

@@ -8,12 +8,11 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
         # follows https://www.php.net/supported-versions.php
-        php-versions: ['8.1', '8.2', '8.3']
+        php-versions: ['8.1', '8.2', '8.3', '8.4']
         phpunit-versions: ['latest']
 
     steps:

phpunit.xml

@@ -3,24 +3,22 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
     backupGlobals="true"
-    backupStaticAttributes="false"
     bootstrap="vendor/autoload.php"
     cacheResult="false"
     colors="true"
-    convertErrorsToExceptions="true"
-    convertNoticesToExceptions="true"
-    convertWarningsToExceptions="true"
-    forceCoversAnnotation="false"
     processIsolation="false"
     stopOnError="true"
     stopOnFailure="false"
     stopOnIncomplete="false"
     stopOnSkipped="false"
     stopOnRisky="false"
+    displayDetailsOnTestsThatTriggerDeprecations="true"
+    displayDetailsOnTestsThatTriggerErrors="true"
+    displayDetailsOnTestsThatTriggerNotices="true"
+    displayDetailsOnTestsThatTriggerWarnings="true"
     timeoutForSmallTests="1"
     timeoutForMediumTests="10"
     timeoutForLargeTests="60"
-    verbose="false"
 >
     <coverage>
         <include>

src/Endpoints/Endpoint.php

@@ -25,11 +25,17 @@ public function __construct(
     }
 
      /**
-      * @return Item
+      * @return Item|null
       */
     public function get(string|int $id)
     {
         $res = $this->tcgdex->fetch($this->endpoint, $id);
+
+        // handle case where result is not defined or an error
+        if (is_null($res)) {
+            return null;
+        }
+
         return Model::build(new $this->itemModel($this->tcgdex), $res);
     }
 

src/Model/Serie.php

@@ -9,13 +9,18 @@ class Serie extends SerieResume
      */
     public array $sets = [];
 
+    public ?SetResume $firstSet = null;
+    public ?SetResume $lastSet = null;
+
     protected function fill(object $data): void
     {
         foreach ($data as $key => $value) {
             if ($key === 'sets') {
                 $this->sets = array_map(function ($item) {
                     return Model::build(new SetResume($this->sdk), $item);
                 }, $value);
+            } elseif ($key === 'firstSet' || $key === 'lastSet') {
+                $this->{$key} = Model::build(new SetResume($this->sdk), $value);
             } else {
                 $this->{$key} = $value;
             }

src/Model/Set.php

@@ -5,25 +5,51 @@
 use TCGdex\Model\SubModel\CardCount;
 use TCGdex\Model\SubModel\Variants;
 use TCGdex\Model\SubModel\Legal;
+use TCGdex\Model\SubModel\Abbreviation;
 
 class Set extends SetResume
 {
+    /**
+     * the serie the set is part of
+     */
     public SerieResume $serie;
 
+    /**
+     * the TCG Online ID
+     */
     public ?string $tcgOnline = null;
 
+    /**
+     * @deprecated this variable is inexistant in the API
+     */
     public ?Variants $variants = null;
 
+    /**
+     * the set release date as an ISO8601 string (ex: `2020-02-01`)
+     */
     public string $releaseDate = '';
 
+    /**
+     * Designate if the set is usable in tournaments
+     *
+     * Note: this is specific to the set and if a
+     * card is banned from the set it will still be true
+     */
     public Legal $legal;
 
     /**
+     * the number of cards of the set in total & by variant
      * @var CardCount
      */
     public $cardCount;
 
     /**
+     * The official and localized abbreviation used by TPC
+     */
+    public Abbreviation $abbreviation;
+
+    /**
+     * the list of cards of the set
      * @var CardResume[]
      */
     public array $cards = [];
@@ -35,8 +61,8 @@ protected function fill(object $data): void
                 $this->cardCount = Model::build(new CardCount($this->sdk), $value);
             } elseif ($key === 'serie') {
                 $this->serie = Model::build(new SerieResume($this->sdk), $value);
-            } elseif ($key === 'variants') {
-                $this->variants = Model::build(new Variants($this->sdk), $value);
+            } elseif ($key === 'abbreviation') {
+                $this->abbreviation = Model::build(new Abbreviation($this->sdk), $value);
             } elseif ($key === 'legal') {
                 $this->legal = Model::build(new Legal($this->sdk), $value);
             } elseif ($key === 'cards') {

src/Model/SubModel/Abbreviation.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace TCGdex\Model\SubModel;
+
+use TCGdex\Model\Model;
+
+class Abbreviation extends Model
+{
+    public ?string $official = null;
+    public ?string $localized = null;
+}

src/Model/SubModel/CardCount.php

@@ -4,11 +4,23 @@
 
 class CardCount extends CardCountResume
 {
+    /**
+     * number of cards having a normal version
+     */
     public int $normal = 0;
 
+    /**
+     * number of cards having an reverse version
+     */
     public int $reverse = 0;
 
+    /**
+     * number of cards having an holo version
+     */
     public int $holo = 0;
 
+    /**
+     * Number of cards that can have the first edition tag
+     */
     public ?int $firstEd = null;
 }

src/Model/SubModel/CardCountResume.php

@@ -6,7 +6,13 @@
 
 class CardCountResume extends Model
 {
+    /**
+     * total of number of cards
+     */
     public int $total = 0;
 
+    /**
+     * number of cards officialy (on the bottom of each cards)
+     */
     public int $official = 0;
 }

src/Model/SubModel/Legal.php

@@ -6,7 +6,13 @@
 
 class Legal extends Model
 {
+    /**
+     * Ability to play in standard tournaments
+     */
     public bool $standard;
 
+    /**
+     * Ability to play in expanded tournaments
+     */
     public bool $expanded;
 }

tests/TCGdexDeprecatedTest.php

@@ -11,7 +11,7 @@ final class TCGdexDeprecatedTest extends TestCase
 {
     public function testCanRequest(): void
     {
-        TCGdex::$client = new Psr18Mock("{\"ok\": true}");
+        TCGdex::$client = new Psr18Mock("{\"id\": \"swsh1-136\"}");
         $tcgdex = new TCGdex("en");
         $card = $tcgdex->fetchCard('testCanRequest');
         $this->assertNotEmpty($card);

tests/TCGdexTest.php

@@ -13,7 +13,7 @@ final class TCGdexTest extends TestCase
 
     public function testCanRequest(): void
     {
-        TCGdex::$client = new Psr18Mock("{\"ok\": true}");
+        TCGdex::$client = new Psr18Mock("{\"id\": \"swsh1-136\"}");
         $tcgdex = new TCGdex("en");
         $card = $tcgdex->card->get('testCanRequest');
         $this->assertNotEmpty($card);