feat: added getCount to retrieve total of records

Author: carloeusebi

README.md

@@ -68,6 +68,8 @@ foreach ($organizations as $organization) {
     // Convert to array
     $organizationArray = $organization->toArray();
 }
+
+RegistroSportESalute::getCount() // The total number of matched records, useful for pagination
 ```
 
 ### Filtering

composer.json

@@ -59,6 +59,10 @@
     "test:unit": "pest --coverage --exactly=100",
     "test:types": "phpstan",
     "test:refactor": "rector --dry-run",
+    "fix": [
+      "@refactor",
+      "@lint"
+    ],
     "test": [
       "@test:lint",
       "@test:type-coverage",

src/Facades/RegistroSportESalute.php

@@ -20,6 +20,7 @@
  * @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)
+ * @method static int getCount()
  */
 class RegistroSportESalute extends Facade
 {

src/RegistroSportESalute.php

@@ -45,6 +45,8 @@ class RegistroSportESalute
 
     private string $orderBy = 'societa__codiceFiscale';
 
+    public int $count = 0;
+
     public function builder(): self
     {
         return $this;
@@ -100,6 +102,8 @@ public function get(): Collection
                 ->throwUnlessStatus(200)
                 ->json();
 
+            $this->count = $res['payload']['count'];
+
             return collect($res['payload']['data'])
                 ->map(fn (array $organization): Organization => Organization::fromArray($organization));
         });
@@ -127,4 +131,9 @@ public function getById(int $id): array
             return Arr::mapWithKeys($res['payload']['corpo']['dati'], fn (array $dato) => [$dato['label'] => $dato['value']]);
         });
     }
+
+    public function getCount(): int
+    {
+        return $this->count;
+    }
 }

src/Testing/Fakes/RegistroSportESaluteFake.php

@@ -15,9 +15,11 @@
 class RegistroSportESaluteFake extends RegistroSportESalute implements Fake
 {
     public function __construct(
-        private readonly int $count = 1,
+        int $count = 1,
         private readonly bool $shouldThrowHttpException = false,
-    ) {}
+    ) {
+        $this->count = $count;
+    }
 
     public function get(): Collection
     {

tests/Feature/RegistroSportESaluteTest.php

@@ -11,7 +11,7 @@
 
     beforeEach(function (): void {
         Http::fake([
-            'https://registro.sportesalute.eu/api/istruttoria/lista*' => Http::response(['payload' => ['data' => []]]),
+            'https://registro.sportesalute.eu/api/istruttoria/lista*' => Http::response(['payload' => ['count' => 0, 'data' => []]]),
             'https://registro.sportesalute.eu/api/istruttoria/*/sidebar*' => Http::response(['payload' => ['corpo' => ['dati' => [['label' => 'test', 'value' => 'test']]]]]),
         ]);
     });
@@ -62,6 +62,16 @@
     });
 });
 
+test('count', function (): void {
+    Http::fake([
+        'https://registro.sportesalute.eu/api/istruttoria/lista*' => Http::response(['payload' => ['count' => 5, 'data' => []]]),
+    ]);
+
+    RegistroSportESalute::get();
+
+    expect(RegistroSportESalute::getCount())->toBe(5);
+});
+
 describe('exceptions', function (): void {
     beforeEach(function (): void {
         Http::fake([

tests/Feature/Testing/FakingTest.php

@@ -27,7 +27,8 @@
 test('returns correct amount of organizations', function (): void {
     RegistroSportESalute::fake(3);
 
-    expect(RegistroSportESalute::get())->toHaveCount(3);
+    expect(RegistroSportESalute::get())->toHaveCount(3)
+        ->and(RegistroSportESalute::getCount())->toBe(3);
 });
 
 test('get by id', function (): void {