feat: add strict types to test files, and update return types for met…

…hods in API resources, transformers, and repositories (v4)

Signed-off-by: Sam Poyigi <[email protected]>

composer.json

@@ -22,7 +22,8 @@
   },
   "require-dev": {
     "laravel/pint": "^1.2",
-    "larastan/larastan": "^2.4.0",
+    "larastan/larastan": "^3.0",
+    "rector/rector": "^2.0",
     "sampoyigi/testbench": "dev-main as 1.0",
     "pestphp/pest-plugin-laravel": "^3.0"
   },

phpstan-baseline.neon

@@ -130,26 +130,11 @@ parameters:
 			count: 1
 			path: src/ApiResources/Transformers/ReservationTransformer.php
 
-		-
-			message: "#^Access to an undefined property Igniter\\\\Reservation\\\\Models\\\\Reservation\\:\\:\\$location\\.$#"
-			count: 1
-			path: src/ApiResources/Transformers/ReservationTransformer.php
-
-		-
-			message: "#^Access to an undefined property Igniter\\\\Reservation\\\\Models\\\\Reservation\\:\\:\\$status\\.$#"
-			count: 1
-			path: src/ApiResources/Transformers/ReservationTransformer.php
-
 		-
 			message: "#^Access to an undefined property Igniter\\\\Reservation\\\\Models\\\\Reservation\\:\\:\\$status_history\\.$#"
 			count: 1
 			path: src/ApiResources/Transformers/ReservationTransformer.php
 
-		-
-			message: "#^Access to an undefined property Igniter\\\\Reservation\\\\Models\\\\Reservation\\:\\:\\$tables\\.$#"
-			count: 1
-			path: src/ApiResources/Transformers/ReservationTransformer.php
-
 		-
 			message: "#^Access to an undefined property Igniter\\\\Local\\\\Models\\\\Review\\:\\:\\$customer\\.$#"
 			count: 1
@@ -160,16 +145,6 @@ parameters:
 			count: 1
 			path: src/ApiResources/Transformers/ReviewTransformer.php
 
-		-
-			message: "#^Result of method Illuminate\\\\Console\\\\Command\\:\\:error\\(\\) \\(void\\) is used\\.$#"
-			count: 1
-			path: src/Console/IssueApiToken.php
-
-		-
-			message: "#^Default value of the parameter \\#2 \\$errors \\(string\\) of method Igniter\\\\Api\\\\Exceptions\\\\ResourceException\\:\\:__construct\\(\\) is incompatible with type array\\|Illuminate\\\\Support\\\\MessageBag\\.$#"
-			count: 1
-			path: src/Exceptions/ResourceException.php
-
 		-
 			message: "#^Access to an undefined property Illuminate\\\\Support\\\\Optional\\:\\:\\$id\\.$#"
 			count: 1

phpstan.neon.dist

@@ -2,14 +2,11 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 2
+    level: 5
     paths:
         - src/
         - config/
         - database/
         - resources/
 #    ignoreErrors:
 #        - '#PHPDoc tag @var#'
-#    excludePaths:
-#        - ./*/*/FileToBeExcluded.php
-#    checkMissingIterableValueType: false

rector.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictNewArrayRector;
+
+return RectorConfig::configure()
+    ->withPaths([__DIR__.'/src', __DIR__.'/tests'])
+    ->withSkip([
+        ReturnTypeFromStrictNewArrayRector::class,
+    ])
+    ->withTypeCoverageLevel(100)
+    ->withDeadCodeLevel(100)
+    ->withCodeQualityLevel(0);

src/ApiResources/Categories.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;

src/ApiResources/Currencies.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;

src/ApiResources/Customers.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;

src/ApiResources/DiningTables.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;

src/ApiResources/Locations.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;

src/ApiResources/MenuItemOptions.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;

src/ApiResources/MenuOptions.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;

src/ApiResources/Menus.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;

src/ApiResources/Orders.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;
@@ -28,7 +30,7 @@ class Orders extends ApiController
 
     protected string|array $requiredAbilities = ['orders:*'];
 
-    public function restAfterSave($model)
+    public function restAfterSave($model): void
     {
         if ($orderMenus = (array)request()->input('order_menus', [])) {
             $model->addOrderMenus(json_decode(json_encode($orderMenus)));

src/ApiResources/Repositories/CategoryRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Repositories/CurrencyRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Repositories/CustomerRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Repositories/DiningTableRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Repositories/LocationRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Repositories/MenuItemOptionRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Repositories/MenuOptionRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Repositories/MenuRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Repositories/OrderRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Repositories/ReservationRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Repositories/ReviewRepository.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Repositories;
 
 use Igniter\Api\Classes\AbstractRepository;

src/ApiResources/Requests/MenuItemOptionRequest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Requests;
 
 use Igniter\System\Classes\FormRequest;
@@ -19,7 +21,7 @@ public function attributes()
         ];
     }
 
-    public function rules()
+    public function rules(): array
     {
         return [
             'menu_id' => ['nullable', 'integer'],

src/ApiResources/Requests/MenuOptionRequest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Requests;
 
 use Igniter\System\Classes\FormRequest;
@@ -22,7 +24,7 @@ public function attributes()
         ];
     }
 
-    public function rules()
+    public function rules(): array
     {
         return [
             'option_name' => ['required', 'min:2', 'max:32'],

src/ApiResources/Requests/OrderRequest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Requests;
 
 use Igniter\System\Classes\FormRequest;

src/ApiResources/Requests/ReservationRequest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Requests;
 
 use Igniter\System\Classes\FormRequest;
@@ -22,7 +24,7 @@ public function attributes()
         ];
     }
 
-    public function rules()
+    public function rules(): array
     {
         return [
             'table_id' => ['sometimes', 'required', 'integer'],

src/ApiResources/Reservations.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;

src/ApiResources/Reviews.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources;
 
 use Igniter\Api\Classes\ApiController;

src/ApiResources/Transformers/AddressTransformer.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Transformers;
 
 use Igniter\Api\Traits\MergesIdAttribute;
@@ -10,7 +12,7 @@ class AddressTransformer extends TransformerAbstract
 {
     use MergesIdAttribute;
 
-    public function transform(Address $address)
+    public function transform(Address $address): array
     {
         return $this->mergesIdAttribute($address);
     }

src/ApiResources/Transformers/CategoryTransformer.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Transformers;
 
 use Igniter\Api\Traits\MergesIdAttribute;
@@ -16,22 +18,22 @@ class CategoryTransformer extends TransformerAbstract
         'locations',
     ];
 
-    public function transform(Category $category)
+    public function transform(Category $category): array
     {
         return $this->mergesIdAttribute($category);
     }
 
-    public function includeMedia(Category $category)
+    public function includeMedia(Category $category): ?\League\Fractal\Resource\Item
     {
         return ($thumb = $category->getFirstMedia()) ? $this->item($thumb, new MediaTransformer, 'media') : null;
     }
 
-    public function includeMenus(Category $category)
+    public function includeMenus(Category $category): ?\League\Fractal\Resource\Collection
     {
         return $this->collection($category->menus, new MenuTransformer, 'menus');
     }
 
-    public function includeLocations(Category $category)
+    public function includeLocations(Category $category): ?\League\Fractal\Resource\Collection
     {
         return $this->collection($category->locations, new LocationTransformer, 'locations');
     }

src/ApiResources/Transformers/CurrencyTransformer.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Igniter\Api\ApiResources\Transformers;
 
 use Igniter\Api\Traits\MergesIdAttribute;
@@ -10,7 +12,7 @@ class CurrencyTransformer extends TransformerAbstract
 {
     use MergesIdAttribute;
 
-    public function transform(Currency $currency)
+    public function transform(Currency $currency): array
     {
         return $this->mergesIdAttribute($currency);
     }