Refactor EloquentVersionManager

liquetsoft · Sep 9, 2024 · 8f40a8f · 8f40a8f
1 parent 681437c
commit 8f40a8f
Show file tree

Hide file tree

Showing 29 changed files with 170 additions and 112 deletions.
diff --git a/composer.json b/composer.json
@@ -39,12 +39,12 @@
     "coverage": "vendor/bin/phpunit --configuration phpunit.xml.dist --coverage-html=tests/coverage",
     "fixer": "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php -vv --allow-risky=yes",
     "linter": [
-        "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php -vv --dry-run --stop-on-violation --allow-risky=yes",
-        "vendor/bin/psalm --show-info=true --php-version=$(php -r \"echo phpversion();\")"
+      "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php -vv --dry-run --stop-on-violation --allow-risky=yes",
+      "vendor/bin/psalm --show-info=true --php-version=$(php -r \"echo phpversion();\")"
     ],
     "entities": [
-        "php -f generator/generate_entities.php",
-        "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --allow-risky=yes -q"
+      "php -f generator/generate_entities.php",
+      "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --allow-risky=yes -q"
     ]
   },
   "extra": {

diff --git a/generator/ModelGenerator.php b/generator/ModelGenerator.php
@@ -61,6 +61,8 @@ protected function decorateClass(ClassType $class, EntityDescriptor $descriptor)
             $class->addComment("{$description}.\n");
         }
 
+        $class->addComment('@psalm-consistent-constructor');
+
         $isPrimaryIsUuid = false;
         $primaryName = null;
         $fill = [];
@@ -106,7 +108,7 @@ protected function decorateClass(ClassType $class, EntityDescriptor $descriptor)
         $fillableValue = new Literal("[\n    '" . implode("',\n    '", $fill) . "',\n]");
         $class->addProperty('fillable', $fillableValue)
             ->setVisibility('protected')
-            ->addComment('@var string[]')
+            ->addComment('@var array<int, string>')
         ;
 
         $castValue = new Literal($this->createCastValue($descriptor));
@@ -116,7 +118,7 @@ protected function decorateClass(ClassType $class, EntityDescriptor $descriptor)
         ;
 
         $connectionMethod = "\$connection = \$this->connection;\n";
-        $connectionMethod .= "if (\\function_exists('app') && app()->has('config')) {\n";
+        $connectionMethod .= "if (\\function_exists('app') && app()->has('config') === true) {\n";
         $connectionMethod .= "    /** @var string|null */\n";
         $connectionMethod .= "    \$connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: \$this->connection;\n";
         $connectionMethod .= "}\n\n";

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,10 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="./vendor/autoload.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
-    <include>
-      <directory>./src</directory>
-    </include>
-  </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="./vendor/autoload.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd">
   <testsuites>
     <testsuite name="LiquetsoftFiasBundle tests suit">
       <directory>./tests</directory>
@@ -17,4 +12,9 @@
     <env name="DB_PASSWORD" value=""/>
     <env name="DB_NAME" value=""/>
   </php>
+  <source>
+    <include>
+      <directory>./src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/src/Entity/AddrObj.php b/src/Entity/AddrObj.php
@@ -9,6 +9,8 @@
 /**
  * Сведения классификатора адресообразующих элементов.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $id         Уникальный идентификатор записи. Ключевое поле
  * @property int                $objectid   Глобальный уникальный идентификатор адресного объекта типа INTEGER
  * @property string             $objectguid Глобальный уникальный идентификатор адресного объекта типа UUID
@@ -39,7 +41,7 @@ class AddrObj extends Model
     /** @var string */
     protected $primaryKey = 'id';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'id',
         'objectid',
@@ -85,7 +87,7 @@ class AddrObj extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/AddrObjDivision.php b/src/Entity/AddrObjDivision.php
@@ -9,6 +9,8 @@
 /**
  * Сведения по операциям переподчинения.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int $id       Уникальный идентификатор записи. Ключевое поле
  * @property int $parentid Родительский ID
  * @property int $childid  Дочерний ID
@@ -28,7 +30,7 @@ class AddrObjDivision extends Model
     /** @var string */
     protected $primaryKey = 'id';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'id',
         'parentid',
@@ -52,7 +54,7 @@ class AddrObjDivision extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/AddrObjTypes.php b/src/Entity/AddrObjTypes.php
@@ -9,6 +9,8 @@
 /**
  * Сведения по типам адресных объектов.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $id         Идентификатор записи
  * @property int                $level      Уровень адресного объекта
  * @property string             $shortname  Краткое наименование типа объекта
@@ -33,7 +35,7 @@ class AddrObjTypes extends Model
     /** @var string */
     protected $primaryKey = 'id';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'id',
         'level',
@@ -67,7 +69,7 @@ class AddrObjTypes extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/AdmHierarchy.php b/src/Entity/AdmHierarchy.php
@@ -9,6 +9,8 @@
 /**
  * Сведения по иерархии в административном делении.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $id          Уникальный идентификатор записи. Ключевое поле
  * @property int                $objectid    Глобальный уникальный идентификатор объекта
  * @property int|null           $parentobjid Идентификатор родительского объекта
@@ -41,7 +43,7 @@ class AdmHierarchy extends Model
     /** @var string */
     protected $primaryKey = 'id';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'id',
         'objectid',
@@ -91,7 +93,7 @@ class AdmHierarchy extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/ApartmentTypes.php b/src/Entity/ApartmentTypes.php
@@ -9,6 +9,8 @@
 /**
  * Сведения по типам помещений.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $id         Идентификатор типа (ключ)
  * @property string             $name       Наименование
  * @property string|null        $shortname  Краткое наименование
@@ -32,7 +34,7 @@ class ApartmentTypes extends Model
     /** @var string */
     protected $primaryKey = 'id';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'id',
         'name',
@@ -64,7 +66,7 @@ class ApartmentTypes extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/Apartments.php b/src/Entity/Apartments.php
@@ -9,6 +9,8 @@
 /**
  * Сведения по помещениям.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $id         Уникальный идентификатор записи. Ключевое поле
  * @property int                $objectid   Глобальный уникальный идентификатор объекта типа INTEGER
  * @property string             $objectguid Глобальный уникальный идентификатор адресного объекта типа UUID
@@ -38,7 +40,7 @@ class Apartments extends Model
     /** @var string */
     protected $primaryKey = 'id';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'id',
         'objectid',
@@ -82,7 +84,7 @@ class Apartments extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/Carplaces.php b/src/Entity/Carplaces.php
@@ -9,6 +9,8 @@
 /**
  * Сведения по машино-местам.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $id         Уникальный идентификатор записи. Ключевое поле
  * @property int                $objectid   Глобальный уникальный идентификатор объекта типа INTEGER
  * @property string             $objectguid Глобальный уникальный идентификатор адресного объекта типа UUID
@@ -37,7 +39,7 @@ class Carplaces extends Model
     /** @var string */
     protected $primaryKey = 'id';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'id',
         'objectid',
@@ -79,7 +81,7 @@ class Carplaces extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/ChangeHistory.php b/src/Entity/ChangeHistory.php
@@ -9,6 +9,8 @@
 /**
  * Сведения по истории изменений.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $changeid    ID изменившей транзакции
  * @property int                $objectid    Уникальный ID объекта
  * @property string             $adrobjectid Уникальный ID изменившей транзакции (GUID)
@@ -30,7 +32,7 @@ class ChangeHistory extends Model
     /** @var string */
     protected $primaryKey = 'changeid';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'changeid',
         'objectid',
@@ -58,7 +60,7 @@ class ChangeHistory extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/FiasVersion.php b/src/Entity/FiasVersion.php
@@ -9,6 +9,8 @@
 /**
  * Модель, которая хранит историю версий ФИАС.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $version    Номер версии ФИАС
  * @property string             $fullurl    Ссылка для загрузки полной версии ФИАС
  * @property string             $deltaurl   Ссылка для загрузки обновления до версии ФИАС
@@ -28,7 +30,7 @@ class FiasVersion extends Model
     /** @var string */
     protected $primaryKey = 'version';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'version',
         'fullurl',
@@ -52,7 +54,7 @@ class FiasVersion extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/HouseTypes.php b/src/Entity/HouseTypes.php
@@ -9,6 +9,8 @@
 /**
  * Сведения по типам домов.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $id         Идентификатор
  * @property string             $name       Наименование
  * @property string|null        $shortname  Краткое наименование
@@ -32,7 +34,7 @@ class HouseTypes extends Model
     /** @var string */
     protected $primaryKey = 'id';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'id',
         'name',
@@ -64,7 +66,7 @@ class HouseTypes extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/Houses.php b/src/Entity/Houses.php
@@ -9,6 +9,8 @@
 /**
  * Сведения по номерам домов улиц городов и населенных пунктов.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $id         Уникальный идентификатор записи. Ключевое поле
  * @property int                $objectid   Глобальный уникальный идентификатор объекта типа INTEGER
  * @property string             $objectguid Глобальный уникальный идентификатор адресного объекта типа UUID
@@ -42,7 +44,7 @@ class Houses extends Model
     /** @var string */
     protected $primaryKey = 'id';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'id',
         'objectid',
@@ -94,7 +96,7 @@ class Houses extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }

diff --git a/src/Entity/MunHierarchy.php b/src/Entity/MunHierarchy.php
@@ -9,6 +9,8 @@
 /**
  * Сведения по иерархии в муниципальном делении.
  *
+ * @psalm-consistent-constructor
+ *
  * @property int                $id          Уникальный идентификатор записи. Ключевое поле
  * @property int                $objectid    Глобальный уникальный идентификатор адресного объекта
  * @property int|null           $parentobjid Идентификатор родительского объекта
@@ -36,7 +38,7 @@ class MunHierarchy extends Model
     /** @var string */
     protected $primaryKey = 'id';
 
-    /** @var string[] */
+    /** @var array<int, string> */
     protected $fillable = [
         'id',
         'objectid',
@@ -76,7 +78,7 @@ class MunHierarchy extends Model
     public function getConnectionName()
     {
         $connection = $this->connection;
-        if (\function_exists('app') && app()->has('config')) {
+        if (\function_exists('app') && app()->has('config') === true) {
             /** @var string|null */
             $connection = app('config')->get('liquetsoft_fias.eloquent_connection') ?: $this->connection;
         }