Merge pull request #31 from tattersoftware/types

Typed Properties

.github/workflows/rector.yml

@@ -64,5 +64,5 @@ jobs:
 
       - name: Analyze for refactoring
         run: |
-          composer global require --dev rector/rector:^0.12.10
+          composer global require --dev rector/rector
           rector process --dry-run --no-progress-bar

depfile.yaml

@@ -1,6 +1,6 @@
 paths:
   - ./src/
-  - ./vendor/codeigniter4/framework/system
+  - ./vendor/codeigniter4/framework/system/
 exclude_files:
   - '#.*test.*#i'
 layers:

infection.json.dist

@@ -4,7 +4,6 @@
 			"src/"
 		],
 		"excludes": [
-			"Accounts",
 			"Config",
 			"Database/Migrations",
 			"Views"

phpstan.neon.dist

@@ -12,6 +12,7 @@ parameters:
 	ignoreErrors:
 		- '#Call to an undefined static method Config\\Services::[A-Za-z]+\(\)#'
 	universalObjectCratesClasses:
+		- CodeIgniter\Entity
 		- CodeIgniter\Entity\Entity
 		- Faker\Generator
 	scanDirectories:

rector.php

@@ -29,6 +29,7 @@
 use Rector\Php56\Rector\FunctionLike\AddDefaultValueForUndefinedVariableRector;
 use Rector\Php73\Rector\FuncCall\JsonThrowOnErrorRector;
 use Rector\Php73\Rector\FuncCall\StringifyStrNeedlesRector;
+use Rector\Php74\Rector\Property\TypedPropertyRector;
 use Rector\PHPUnit\Set\PHPUnitSetList;
 use Rector\PSR4\Rector\FileWithoutNamespace\NormalizeNamespaceByPSR4ComposerAutoloadRector;
 use Rector\Set\ValueObject\LevelSetList;
@@ -122,4 +123,8 @@
     $services->set(MakeInheritedMethodVisibilitySameAsParentRector::class);
     $services->set(SimplifyEmptyArrayCheckRector::class);
     $services->set(NormalizeNamespaceByPSR4ComposerAutoloadRector::class);
+    $services->set(TypedPropertyRector::class)
+        ->configure([
+            TypedPropertyRector::INLINE_PUBLIC => true,
+        ]);
 };

src/Components/Caller.php

@@ -11,24 +11,18 @@ class Caller
 {
     /**
      * UID of the user to make the request.
-     *
-     * @var string
      */
-    protected $uid;
+    protected string $uid = '';
 
     /**
      * A Firebase ID token for the user identified by $this->uid.
-     *
-     * @var string|null
      */
-    protected $token;
+    protected ?string $token = null;
 
     /**
      * Error messages from the last call
-     *
-     * @var array
      */
-    protected $errors = [];
+    protected array $errors = [];
 
     /**
      * Get and clear any error messsages

src/Firebase.php

@@ -21,17 +21,13 @@ class Firebase
 
     /**
      * A pre-authenticated instance of the factory
-     *
-     * @var Factory
      */
-    protected $factory;
+    protected ?Factory $factory = null;
 
     /**
      * Cache for instances that have already been loaded.
-     *
-     * @var array
      */
-    protected $instances = [];
+    protected array $instances = [];
 
     /**
      * Stores the path to the optional service account credentials file.
@@ -54,13 +50,7 @@ protected function factory(): Factory
         }
 
         // If credentials were specified then use them
-        if ($this->serviceAccount) {
-            $this->factory = (new Factory())->withServiceAccount($this->serviceAccount);
-        }
-        // Create a new instance
-        else {
-            $this->factory = new Factory();
-        }
+        $this->factory = $this->serviceAccount ? (new Factory())->withServiceAccount($this->serviceAccount) : new Factory();
 
         return $this->factory;
     }

src/Firestore/Collection.php

@@ -62,40 +62,30 @@ abstract class Collection
 
     /**
      * The table's primary key.
-     *
-     * @var string
      */
-    protected $primaryKey = 'uid';
+    protected string $primaryKey = 'uid';
 
     /**
      * An array of field names that are allowed
      * to be set by the user in inserts/updates.
-     *
-     * @var array
      */
-    protected $allowedFields = [];
+    protected array $allowedFields = [];
 
     /**
      * If true, will set createdField, and updatedField
      * values on created Entities.
-     *
-     * @var bool
      */
-    protected $useTimestamps = true;
+    protected bool $useTimestamps = true;
 
     /**
      * The column used for insert timestamps.
-     *
-     * @var string|null
      */
-    protected $createdField = 'createdAt';
+    protected ?string $createdField = 'createdAt';
 
     /**
      * The column used for update timestamps.
-     *
-     * @var string|null
      */
-    protected $updatedField = 'updatedAt';
+    protected ?string $updatedField = 'updatedAt';
 
     final public function __construct(?CollectionReference $collection = null, ?ValidationInterface $validation = null)
     {

src/Firestore/ValidationTrait.php

@@ -17,41 +17,35 @@ trait ValidationTrait
     /**
      * Whether we should limit fields in inserts
      * and updates to those available in $allowedFields or not.
-     *
-     * @var bool
      */
-    protected $protectFields = true;
+    protected bool $protectFields = true;
 
     /**
      * Our validator instance.
-     *
-     * @var ValidationInterface
      */
-    protected $validation;
+    protected ValidationInterface $validation;
 
     /**
      * Rules used to validate data in add and update methods.
      * The array must match the format of data passed to the Validation library.
      *
      * @var array<string,string>
      */
-    protected $validationRules = [];
+    protected array $validationRules = [];
 
     /**
      * Contains any custom error messages to be
      * used during data validation.
      *
      * @var array<string,string>
      */
-    protected $validationMessages = [];
+    protected array $validationMessages = [];
 
     /**
      * Skip the model's validation. Used in conjunction with skipValidation()
      * to skip data validation for any future calls.
-     *
-     * @var bool
      */
-    protected $skipValidation = false;
+    protected bool $skipValidation = false;
 
     /**
      * @return $this

src/Test/AuthenticationTestTrait.php

@@ -18,7 +18,7 @@ trait AuthenticationTestTrait
      *
      * @var string[]
      */
-    protected $firebaseUserCache = [];
+    protected array $firebaseUserCache = [];
 
     /**
      * Creates a random Firebase UserRecord.

src/Test/FirestoreTestTrait.php

@@ -75,5 +75,16 @@ protected function deleteCollection($collection, ?FirestoreClient $firestore = n
             }
             $documents = $collection->limit(30)->documents();
         }
+
+        // Repeat for any lingering deleted documents (not pagination safe)
+        $documents = $collection->listDocuments();
+
+        foreach ($documents as $document) {
+            foreach ($document->collections() as $subcollection) {
+                $this->deleteCollection($subcollection, $firestore);
+            }
+
+            $document->delete();
+        }
     }
 }

tests/AuthenticationTestTraitTest.php

@@ -15,10 +15,8 @@ final class AuthenticationTestTraitTest extends TestCase
 
     /**
      * Instance of the Firebase SDK.
-     *
-     * @var Auth
      */
-    protected $auth;
+    protected Auth $auth;
 
     protected function setUp(): void
     {

tests/_support/Collections/FruitCollection.php

@@ -10,19 +10,19 @@ final class FruitCollection extends Collection
     public const NAME   = 'fruits';
     public const ENTITY = Fruit::class;
 
-    protected $allowedFields = [
+    protected array $allowedFields = [
         'name',
         'taste',
         'weight',
         'zero',
     ];
-    protected $validationRules = [
+    protected array $validationRules = [
         'name'   => 'required|string',
         'taste'  => 'permit_empty|string',
         'weight' => 'is_natural_no_zero',
         'zero'   => 'numeric|in_list[0]',
     ];
-    protected $validationMessages = [
+    protected array $validationMessages = [
         'zero' => 'The zero field should be supplied by attributes.',
     ];
 

tests/_support/FirestoreTestCase.php

@@ -13,15 +13,8 @@ abstract class FirestoreTestCase extends TestCase
 {
     use FirestoreTestTrait;
 
-    /**
-     * @var FirestoreClient
-     */
-    protected $firestore;
-
-    /**
-     * @var FruitCollection
-     */
-    protected $collection;
+    protected FirestoreClient $firestore;
+    protected FruitCollection $collection;
 
     protected function setUp(): void
     {

tests/firestore/FirestoreTestTraitTest.php

@@ -13,7 +13,7 @@ public function testDeleteCollection()
         $collections = firestore()->collections();
         $this->assertCount(1, $collections);
 
-        $this->deleteCollection('fruits');
+        $this->deleteCollection($this->collection::NAME);
         $collections = firestore()->collections();
         $this->assertCount(0, $collections);
     }