added tests

Author: carloeusebi

.github/workflows/tests.yml

@@ -1,45 +1,45 @@
 name: Tests
 
-on: ['push', 'pull_request']
+on: [ 'push', 'pull_request' ]
 
 jobs:
   ci:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: true
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        php: [8.4]
-        dependency-version: [prefer-lowest, prefer-stable]
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        php: [ 8.4 ]
+        dependency-version: [ prefer-lowest, prefer-stable ]
 
     name: Tests P${{ matrix.php }} - ${{ matrix.os }} - ${{ matrix.dependency-version }}
 
     steps:
 
-    - name: Checkout
-      uses: actions/checkout@v4
-
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: ${{ matrix.php }}
-        extensions: dom, mbstring, zip
-        coverage: none
-
-    - name: Get Composer cache directory
-      id: composer-cache
-      shell: bash
-      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: dependencies-php-${{ matrix.php }}-os-${{ matrix.os }}-version-${{ matrix.dependency-version }}-composer-${{ hashFiles('composer.json') }}
-        restore-keys: dependencies-php-${{ matrix.php }}-os-${{ matrix.os }}-version-${{ matrix.dependency-version }}-composer-
-
-    - name: Install Composer dependencies
-      run: composer update --${{ matrix.dependency-version }} --no-interaction --prefer-dist
-
-    - name: Integration Tests
-      run: php ./vendor/bin/pest
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, mbstring, zip
+          coverage: none
+
+      - name: Get Composer cache directory
+        id: composer-cache
+        shell: bash
+        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: dependencies-php-${{ matrix.php }}-os-${{ matrix.os }}-version-${{ matrix.dependency-version }}-composer-${{ hashFiles('composer.json') }}
+          restore-keys: dependencies-php-${{ matrix.php }}-os-${{ matrix.os }}-version-${{ matrix.dependency-version }}-composer-
+
+      - name: Install Composer dependencies
+        run: composer update --${{ matrix.dependency-version }} --no-interaction --prefer-dist
+
+      - name: Integration Tests
+        run: php ./vendor/bin/pest --coverage --exactly=100

README.md

@@ -84,7 +84,8 @@ $organizations = RegistroSportESalute::filterByDenominazione('Sport Club')->get(
 $organizations = RegistroSportESalute::filterByCodiceFiscale('12345678901')->get();
 
 // Chain filters
-$organizations = RegistroSportESalute::builder()
+//💡 Tip: the `builder` method is an eye candy for when you have multiple statements
+$organizations = RegistroSportESalute::builder() 
     ->filterByDenominazione('Sport Club')
     ->filterByCodiceFiscale('12345678901')
     ->get();
@@ -112,7 +113,6 @@ $organizations = RegistroSportESalute::filterByDenominazione('Sport Club')
     ->get();
 ```
 
-
 ### Order
 
 Order feature is not present. If you need it please create an issue or submit a PR.

composer.json

@@ -17,10 +17,12 @@
     "php": "^8.4.0",
     "illuminate/cache": "^12.16",
     "illuminate/http": "^12.15",
-    "illuminate/support": "^12.15"
+    "illuminate/support": "^12.15",
+    "illuminate/testing": "^12.16"
   },
   "require-dev": {
     "laravel/pint": "^1.22.1",
+    "orchestra/testbench": "^10.3",
     "pestphp/pest": "^4.0.0",
     "pestphp/pest-plugin-type-coverage": "^4.0.0",
     "phpstan/phpstan": "^2.1.16",
@@ -34,7 +36,10 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "Tests\\": "tests/"
+      "Tests\\": "tests/",
+      "Workbench\\App\\": "workbench/app/",
+      "Workbench\\Database\\Factories\\": "workbench/database/factories/",
+      "Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
     }
   },
   "minimum-stability": "dev",
@@ -51,7 +56,7 @@
     "refactor": "rector",
     "test:type-coverage": "pest",
     "test:lint": "pint --test",
-    "test:unit": "pest --coverage",
+    "test:unit": "pest --coverage --exactly=100",
     "test:types": "phpstan",
     "test:refactor": "rector --dry-run",
     "test": [
@@ -60,6 +65,18 @@
       "@test:unit",
       "@test:types",
       "@test:refactor"
+    ],
+    "post-autoload-dump": [
+      "@clear",
+      "@prepare"
+    ],
+    "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
+    "prepare": "@php vendor/bin/testbench package:discover --ansi",
+    "build": "@php vendor/bin/testbench workbench:build --ansi",
+    "serve": [
+      "Composer\\Config::disableProcessTimeout",
+      "@build",
+      "@php vendor/bin/testbench serve --ansi"
     ]
   }
-}
+}

docs/example.png

@@ -1,16 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
-    colors="true"
-    cacheDirectory=".phpunit.cache">
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
+         colors="true"
+         cacheDirectory=".phpunit.cache">
     <source>
         <include>
             <directory suffix=".php">./src</directory>
         </include>
     </source>
     <testsuites>
-        <testsuite name="default">
-            <directory suffix=".php">./tests</directory>
+        <testsuite name="Feature">
+            <directory suffix="Test.php">./tests/Feature</directory>
         </testsuite>
     </testsuites>
 </phpunit>

phpunit.xml.dist

@@ -12,6 +12,7 @@
     ])
     ->withSkip([
         AddOverrideAttributeToOverriddenMethodsRector::class,
+        \Rector\Privatization\Rector\MethodCall\PrivatizeLocalGetterToPropertyRector::class,
     ])
     ->withPreparedSets(
         deadCode: true,

rector.php

@@ -4,8 +4,22 @@
 
 namespace CarloEusebi\RegistroSportESalute\Facades;
 
+use CarloEusebi\RegistroSportESalute\Organization;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Facade;
 
+/**
+ * Facade for the RegistroSportESalute service.
+ *
+ * @see \CarloEusebi\RegistroSportESalute\RegistroSportESalute
+ *
+ * @method static \CarloEusebi\RegistroSportESalute\RegistroSportESalute builder()
+ * @method static \CarloEusebi\RegistroSportESalute\RegistroSportESalute filterByDenominazione(?string $denominazione)
+ * @method static \CarloEusebi\RegistroSportESalute\RegistroSportESalute filterByCodiceFiscale(?string $codiceFiscale)
+ * @method static \CarloEusebi\RegistroSportESalute\RegistroSportESalute page(int $page = 1, int $pageSize = 10)
+ * @method static Collection<int, Organization> get()
+ * @method static array<string, int|string> getById(int $id)
+ */
 final class RegistroSportESalute extends Facade
 {
     protected static function getFacadeAccessor(): string

src/Facades/RegistroSportESalute.php

@@ -4,7 +4,6 @@
 
 namespace CarloEusebi\RegistroSportESalute;
 
-use BladeUI\Icons\Components\Icon;
 use Carbon\Carbon;
 use Illuminate\Contracts\Support\Arrayable;
 use JsonSerializable;
@@ -249,29 +248,29 @@ public function jsonSerialize(): array
     public function toArray(): array
     {
         return [
-            'id' => $this->id,
-            'denominazione' => $this->societa__denominazione,
-            'id_pad' => $this->id_pad,
+            'id' => $this->getId(),
+            'denominazione' => $this->getDenominazione(),
+            'id_pad' => $this->getIdPad(),
             'presentazione_data' => $this->getPresentazioneData()->toISOString(),
-            'natura_giuridica' => $this->societa__natura_giuridica,
+            'natura_giuridica' => $this->getNaturaGiuridica(),
             'approvazione_data' => $this->getDataApprovazione()->toISOString(),
-            'codice_fiscale' => $this->societa__codiceFiscale,
+            'codice_fiscale' => $this->getCodiceFiscale(),
             'societa_icona_vcf' => $this->getSocietaIconaVcf(),
             'organismi_affiliazioni_attive' => $this->getOrganismiAffiliazioniAttive(),
-            'stato_istruttoria_descrizione' => $this->statoIstruttoria__descrizione,
-            'utenza' => $this->utenza,
-            'sede_legale_regione' => $this->societa__sedeLegale__regione__denominazione,
-            'sede_legale_comune' => $this->societa__sedeLegale__comune__denominazione,
-            'affiliazione_scaduta_organismo_icona' => $this->affiliazione_scaduta_organismo_icona,
-            'richiesta_integrazioni_prima_data' => $this->richiestaIntegrazioni_prima_data,
-            'richiesta_integrazioni_ultima_data' => $this->richiestaIntegrazioni_ultima_data,
-            'invio_integrazioni_prima_data' => $this->invioIntegrazioni_prima_data,
-            'invio_integrazioni_ultima_data' => $this->invioIntegrazioni_ultima_data,
-            'richiesta_aggiornamenti_ultima_data' => $this->richiestaAggiornamenti_ultima_data,
-            'richiesta_aggiornamenti_icona' => $this->richiestaAggiornamenti_icona,
-            'invio_aggiornamenti_ultima_data' => $this->invioAggiornamenti_ultima_data,
-            'tipo_istruttoria' => $this->tipoIstruttoria,
-            'stato_istruttoria_icona' => $this->statoIstruttoria_icona,
+            'stato_istruttoria_descrizione' => $this->getStatoIstruttoriaDescrizione(),
+            'utenza' => $this->getUtenza(),
+            'sede_legale_regione' => $this->getRegioneSedeLegale(),
+            'sede_legale_comune' => $this->getComuneSedeLegale(),
+            'affiliazione_scaduta_organismo_icona' => $this->getAffiliazioneSCadutaOrganismoIcona(),
+            'richiesta_integrazioni_prima_data' => $this->getRichiestaIntegrazioniPrimaData(),
+            'richiesta_integrazioni_ultima_data' => $this->getRichiestaAggiornamentiUltimaData(),
+            'invio_integrazioni_prima_data' => $this->getInvioIntegrazioniPrimaData(),
+            'invio_integrazioni_ultima_data' => $this->getInvioIntegrazioniUltimaData(),
+            'richiesta_aggiornamenti_ultima_data' => $this->getRichiestaIntegrazioniUltimaData(),
+            'richiesta_aggiornamenti_icona' => $this->getRichiestaAggiornamentiIcona(),
+            'invio_aggiornamenti_ultima_data' => $this->getInvioAggiornamentiUltimaData(),
+            'tipo_istruttoria' => $this->getTipoIstruttoria(),
+            'stato_istruttoria_icona' => $this->getStatoIstruttoriaIcona(),
         ];
     }
 }

src/Organization.php

@@ -68,19 +68,10 @@ public function filterByCodiceFiscale(?string $codiceFiscale): self
         return $this;
     }
 
-    public function page(int $page): self
+    public function page(int $page = 1, int $pageSize = 10): self
     {
-        $this->start = ($page - 1) * $this->length;
-
-        return $this;
-    }
-
-    public function pageSize(int $length): self
-    {
-        $page = ($this->start / $length) + 1;
-        $this->length = $length;
-
-        $this->page($page);
+        $this->start = ($page - 1) * $pageSize;
+        $this->length = $pageSize;
 
         return $this;
     }
@@ -93,7 +84,7 @@ public function pageSize(int $length): self
     public function get(): Collection
     {
         $key = 'registro-sport-e-salute.list.';
-        $key .= md5(json_encode([$this->filters, $this->start, $this->length, $this->orderBy], JSON_THROW_ON_ERROR));
+        $key .= md5((string) json_encode([$this->filters, $this->start, $this->length, $this->orderBy]));
 
         // @phpstan-ignore-next-line
         return Cache::remember($key, Carbon::now()->addMinutes(5), function () {
@@ -106,7 +97,7 @@ public function get(): Collection
                     'order_by' => $this->orderBy,
                     ...$this->filters,
                 ])
-                ->throw()
+                ->throwUnlessStatus(200)
                 ->json();
 
             return collect($res['payload']['data'])
@@ -128,7 +119,7 @@ public function getById(int $id): array
                 'chiamante' => 'registroPubblico_n',
             ])
 
-                ->throw()
+                ->throwUnlessStatus(200)
                 ->json();
 
             return Arr::mapWithKeys($res['payload']['corpo']['dati'], fn (array $dato) => [$dato['label'] => $dato['value']]);