Merge pull request #58 from Codeception/3.0

3.0 to master

Author: Naktibalda

.gitattributes

@@ -2,6 +2,5 @@
 /tests           export-ignore
 /.gitattributes  export-ignore
 /.gitignore      export-ignore
-/Robofile.php    export-ignore
 /*.md            export-ignore
 /*.yml           export-ignore

composer.json

@@ -1,24 +1,26 @@
 {
     "name": "codeception/module-doctrine2",
     "description": "Doctrine2 module for Codeception",
-    "keywords": [ "codeception", "doctrine2" ],
-    "homepage": "https://codeception.com/",
-    "type": "library",
     "license": "MIT",
+    "type": "library",
+    "keywords": [
+        "codeception",
+        "doctrine2"
+    ],
     "authors": [
         {
-            "name":"Michael Bodnarchuk"
+            "name": "Michael Bodnarchuk"
         },
         {
-            "name":"Alex Kunin"
+            "name": "Alex Kunin"
         }
     ],
-    "minimum-stability": "dev",
+    "homepage": "https://codeception.com/",
     "require": {
         "php": "^8.0",
-        "ext-pdo": "*",
         "ext-json": "*",
-        "codeception/codeception": "^5.0.0-alpha1"
+        "ext-pdo": "*",
+        "codeception/codeception": "^5.0.0-alpha2"
     },
     "require-dev": {
         "codeception/stub": "^4.0",
@@ -27,10 +29,16 @@
         "doctrine/orm": "^2.10",
         "phpstan/phpstan": "^1.0",
         "ramsey/uuid-doctrine": "^1.6",
-        "symfony/cache": "^4.4 | ^5.4 | ^6.0"
+        "symfony/cache": "^4.4 || ^5.4 || ^6.0"
     },
+    "conflict": {
+        "codeception/codeception": "<5.0"
+    },
+    "minimum-stability": "dev",
     "autoload": {
-        "classmap": [ "src/" ]
+        "classmap": [
+            "src/"
+        ]
     },
     "config": {
         "classmap-authoritative": true,

phpstan-baseline.neon

@@ -1,6 +1,3 @@
-includes:
-    - phpstan-baseline.neon
-
 parameters:
   level: 6
   paths:
@@ -12,7 +9,7 @@ parameters:
         - tests/data/doctrine2_fixtures/TestFixture2.php
         - tests/_support/UnitTester.php
   checkMissingIterableValueType: false
-  reportUnmatchedIgnoredErrors: false
+  reportUnmatchedIgnoredErrors: true
   ignoreErrors:
       - path: tests/
         message: '#Property \S+ is never read, only written#'

phpstan.neon

@@ -9,7 +9,7 @@ A Doctrine 2 module for Codeception.
 
 ## Requirements
 
-* `PHP 7.4` or higher.
+* `PHP 8.0` or higher.
 
 ## Installation
 

readme.md

@@ -136,14 +136,14 @@
  *
  * Note that key is ignored, because actual field name is part of criteria and/or expression.
  */
-
 class Doctrine2 extends CodeceptionModule implements DependsOnModule, DataMapper
 {
-
     private ?DoctrineProvider $dependentModule = null;
 
-    /** @var array */
-    protected $config = [
+    /**
+     * @var array<string, mixed>
+     */
+    protected array $config = [
         'cleanup' => true,
         'connection_callback' => false,
         'depends' => null,
@@ -516,7 +516,7 @@ public function haveInRepository($classNameOrInstance, array $data = [])
     private function instantiateAndPopulateEntity(string $className, array $data, array &$instances)
     {
         $rpa = new ReflectionPropertyAccessor();
-        [$scalars,$relations] = $this->splitScalarsAndRelations($className, $data);
+        [$scalars, $relations] = $this->splitScalarsAndRelations($className, $data);
         // Pass relations that are already objects to the constructor, too
         $properties = array_merge(
             $scalars,
@@ -881,11 +881,11 @@ protected function proceedSeeInRepository(string $entity, array $params = []): a
      * $email = $I->grabFromRepository(User::class, 'email', ['name' => 'davert']);
      * ```
      *
-     * @version 1.1
      * @param class-string $entity
      * @param string $field
      * @param array $params
      * @return mixed
+     * @version 1.1
      */
     public function grabFromRepository(string $entity, string $field, array $params = [])
     {
@@ -910,9 +910,9 @@ public function grabFromRepository(string $entity, string $field, array $params
      * $users = $I->grabEntitiesFromRepository(User::class, ['name' => 'davert']);
      * ```
      *
-     * @template T
+     * @template T of object
      * @param class-string<T> $entity
-     * @param array $params. For `IS NULL`, use `['field' => null]`
+     * @param array $params . For `IS NULL`, use `['field' => null]`
      * @return list<T>
      * @version 1.1
      */
@@ -940,9 +940,9 @@ public function grabEntitiesFromRepository(string $entity, array $params = []):
      * $user = $I->grabEntityFromRepository(User::class, ['id' => '1234']);
      * ```
      *
-     * @template T
+     * @template T of object
      * @param class-string<T> $entity
-     * @param array $params. For `IS NULL`, use `['field' => null]`
+     * @param array $params . For `IS NULL`, use `['field' => null]`
      * @return T
      * @version 1.1
      */
@@ -1005,30 +1005,27 @@ public function _getEntityManager(): EntityManagerInterface
      */
     private function debugEntityCreation(object $instance, $pks): void
     {
-        $message = get_class($instance).' entity created with ';
+        $message = get_class($instance) . ' entity created with ';
 
         if (!is_array($pks)) {
-            $pks     = [$pks];
+            $pks = [$pks];
             $message .= 'primary key ';
         } else {
             $message .= 'composite primary key of ';
         }
 
         foreach ($pks as $pk) {
             if ($this->isDoctrineEntity($pk)) {
-                $message .= get_class($pk).': '.var_export($this->extractPrimaryKey($pk), true).', ';
+                $message .= get_class($pk) . ': ' . var_export($this->extractPrimaryKey($pk), true) . ', ';
             } else {
-                $message .= var_export($pk, true).', ';
+                $message .= var_export($pk, true) . ', ';
             }
         }
 
         $this->debug(trim($message, ' ,'));
     }
 
-    /**
-     * @param mixed $pk
-     */
-    private function isDoctrineEntity($pk): bool
+    private function isDoctrineEntity(mixed $pk): bool
     {
         $isEntity = is_object($pk);
 

src/Codeception/Module/Doctrine2.php

@@ -16,10 +16,9 @@
 class ReflectionPropertyAccessor
 {
     /**
-     * @return mixed
      * @throws ReflectionException
      */
-    public function getProperty(object $obj, string $field)
+    public function getProperty(object $obj, string $field): mixed
     {
         $class = get_class($obj);
         do {
@@ -52,7 +51,7 @@ private function setPropertiesForClass(?object $obj, string $class, array $data)
                         $constructorParameters[] = $data[$parameter->getName()];
                     } else {
                         throw new InvalidArgumentException(
-                            'Constructor parameter "'.$parameter->getName().'" missing'
+                            'Constructor parameter "' . $parameter->getName() . '" missing'
                         );
                     }
                 }