Merge pull request #259 from vierge-noire/#258_fix_pipelines

#258 fix pipelines

Author: pabloelcolombiano

composer.json

@@ -22,12 +22,13 @@
     },
     "require-dev": {
         "cakephp/bake": "^3.0.0",
+        "cakephp/twig-view": "^2.0.2",
         "cakephp/cakephp-codesniffer": "^5.1",
         "cakephp/migrations": "^4.0.0",
         "josegonzalez/dotenv": "^4.0.0",
         "phpstan/phpstan": "^1.0",
-        "phpunit/phpunit": "^10.1",
-        "vimeo/psalm": "^5.0"
+        "phpunit/phpunit": "^10.5",
+        "vimeo/psalm": "^6.0"
     },
     "autoload": {
         "psr-4": {

psalm.xml

@@ -14,9 +14,8 @@
 >
     <projectFiles>
         <directory name="src"/>
+        <ignoreFiles>
+            <file name="vendor/cakephp/cakephp/src/ORM/Locator/TableLocator.php" />
+        </ignoreFiles>
     </projectFiles>
-    <issueHandlers>
-        <InvalidScalarArgument errorLevel="suppress" />
-        <NoInterfaceProperties errorLevel="suppress" />
-    </issueHandlers>
 </psalm>

src/Command/BakeFixtureFactoryCommand.php

@@ -25,6 +25,7 @@
 use Cake\Utility\Inflector;
 use CakephpFixtureFactories\Factory\FactoryAwareTrait;
 use Exception;
+use Override;
 use ReflectionClass;
 use ReflectionException;
 
@@ -66,6 +67,7 @@ public function template(): string
     /**
      * @inheritDoc
      */
+    #[Override]
     public static function defaultName(): string
     {
         return 'bake fixture_factory';
@@ -104,6 +106,7 @@ public function setTable(string $tableName, ConsoleIo $io)
      * @param \Cake\Console\Arguments $args Arguments
      * @return string
      */
+    #[Override]
     public function getPath(Arguments $args): string
     {
         $outputDir = Configure::read('FixtureFactories.testFixtureOutputDir', 'Factory/');
@@ -214,6 +217,7 @@ private function bakeAllModels(Arguments $args, ConsoleIo $io): string
      * @param \Cake\Console\ConsoleIo $io The console io
      * @return int|null The exit code or null for success
      */
+    #[Override]
     public function execute(Arguments $args, ConsoleIo $io): ?int
     {
         $this->extractCommonProperties($args);
@@ -393,8 +397,8 @@ public function handleFactoryWithSameName(string $name, Arguments $args, Console
                 $io->abort(
                     sprintf(
                         'A factory with the name `%s` already exists.',
-                        $name
-                    )
+                        $name,
+                    ),
                 );
             }
 
@@ -415,6 +419,7 @@ public function handleFactoryWithSameName(string $name, Arguments $args, Console
      *
      * @return \Cake\Console\ConsoleOptionParser
      */
+    #[Override]
     public function getOptionParser(): ConsoleOptionParser
     {
         $name = ($this->plugin ? $this->plugin . '.' : '') . $this->name;
@@ -423,33 +428,19 @@ public function getOptionParser(): ConsoleOptionParser
         $parser = $this->_setCommonOptions($parser);
 
         $parser->setDescription(
-            'Fixture factory generator.'
+            'Fixture factory generator.',
         )
             ->addArgument('model', [
                 'help' => 'Name of the model the factory will create entities from' .
                     '(plural, without the `Table` suffix). You can use the Foo.Bars notation ' .
                     'to bake a factory for the model Bars located in the plugin Foo. \n
                     Factories are located in the folder test\Factory of your app, resp. plugin.',
             ])
-            ->addOption('plugin', [
-                'short' => 'p',
-                'help' => 'Plugin to bake into.',
-            ])
             ->addOption('all', [
                 'short' => 'a',
                 'boolean' => true,
                 'help' => 'Bake factories for all models.',
             ])
-            ->addOption('force', [
-                'short' => 'f',
-                'boolean' => true,
-                'help' => 'Force overwriting existing file if a factory already exists with the same name.',
-            ])
-            ->addOption('quiet', [
-                'short' => 'q',
-                'boolean' => true,
-                'help' => 'Enable quiet output.',
-            ])
             ->addOption('methods', [
                 'short' => 'm',
                 'boolean' => true,

src/Command/PersistCommand.php

@@ -23,6 +23,7 @@
 use CakephpFixtureFactories\Error\PersistenceException;
 use CakephpFixtureFactories\Factory\BaseFactory;
 use CakephpFixtureFactories\Factory\FactoryAwareTrait;
+use Override;
 
 class PersistCommand extends Command
 {
@@ -33,6 +34,7 @@ class PersistCommand extends Command
     /**
      * @inheritDoc
      */
+    #[Override]
     public static function defaultName(): string
     {
         return 'fixture_factories_persist';
@@ -41,6 +43,7 @@ public static function defaultName(): string
     /**
      * @inheritDoc
      */
+    #[Override]
     protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
     {
         $parser
@@ -83,6 +86,7 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
     /**
      * @inheritDoc
      */
+    #[Override]
     public function execute(Arguments $args, ConsoleIo $io): int
     {
         $factory = null;
@@ -193,7 +197,7 @@ public function aliasConnection(string $connection, BaseFactory $factory): void
     {
         ConnectionManager::alias(
             $connection,
-            $factory->getTable()->getConnection()->configName()
+            $factory->getTable()->getConnection()->configName(),
         );
     }
 

src/Event/ModelEventsHandler.php

@@ -136,7 +136,7 @@ private function processModelListener(Table $table, mixed $listener, string $orm
         if (
             !in_array(
                 $ormEvent,
-                $this->getListeningModelEvents()
+                $this->getListeningModelEvents(),
             )
         ) {
             $table->getEventManager()->off($ormEvent, $listener);

src/Factory/AssociationBuilder.php

@@ -63,7 +63,7 @@ public function __construct(BaseFactory $factory)
      */
     public function getAssociation(string $associationName): Association
     {
-        $this->removeBrackets($associationName);
+        $associationName = $this->removeBrackets($associationName);
 
         try {
             $association = $this->getTable()->getAssociation($associationName);
@@ -75,7 +75,7 @@ public function getAssociation(string $associationName): Association
         } else {
             $associationType = get_class($association);
             throw new AssociationBuilderException(
-                "Unknown association type $associationType on table {$this->getTable()->getAlias()}"
+                "Unknown association type $associationType on table {$this->getTable()->getAlias()}",
             );
         }
     }
@@ -122,7 +122,7 @@ public function validateToOneAssociation(string $associationName, BaseFactory $a
     {
         if ($this->associationIsToOne($this->getAssociation($associationName)) && $associationFactory->getTimes() > 1) {
             throw new AssociationBuilderException(
-                "Association $associationName on " . $this->getTable()->getEntityClass() . ' cannot be multiple'
+                "Association $associationName on " . $this->getTable()->getEntityClass() . ' cannot be multiple',
             );
         }
 
@@ -153,13 +153,13 @@ public function removeAssociationForToOneFactory(string $associationName, BaseFa
      */
     public function getAssociatedFactory(
         string $associationName,
-        mixed $data = []
+        mixed $data = [],
     ): BaseFactory {
         $associations = explode('.', $associationName);
         $firstAssociation = array_shift($associations);
 
         $times = $this->getTimeBetweenBrackets($firstAssociation);
-        $this->removeBrackets($firstAssociation);
+        $firstAssociation = $this->removeBrackets($firstAssociation);
 
         $table = $this->getTable()->getAssociation($firstAssociation)->getClassName();
 
@@ -193,14 +193,14 @@ public function getFactoryFromTableName(string $modelName, mixed $data = []): Ba
     }
 
     /**
-     * Remove the brackets and there content in a n 'Association1[i].Association2[j]' formatted string
+     * Remove the brackets and their content in an 'Association1[i].Association2[j]' formatted string
      *
      * @param string $string String
-     * @return string
+     * @return string|null
      */
-    public function removeBrackets(string &$string): string
+    public function removeBrackets(string $string): ?string
     {
-        return $string = preg_replace("/\[[^]]+\]/", '', $string);
+        return preg_replace("/\[[^]]+\]/", '', $string);
     }
 
     /**
@@ -259,8 +259,8 @@ public function dropAssociation(string $associationName): void
         $this->setAssociated(
             Hash::remove(
                 $this->getAssociated(),
-                $associationName
-            )
+                $associationName,
+            ),
         );
     }
 

src/Factory/BaseFactory.php

@@ -128,7 +128,7 @@ abstract protected function setDefaultTemplate(): void;
      */
     public static function make(
         mixed $makeParameter = [],
-        int $times = 1
+        int $times = 1,
     ): BaseFactory {
         if (is_numeric($makeParameter)) {
             $factory = self::makeFromNonCallable();
@@ -579,8 +579,8 @@ public function mergeAssociated(array $data)
         $this->getAssociationBuilder()->setAssociated(
             array_merge(
                 $this->getAssociationBuilder()->getAssociated(),
-                $data
-            )
+                $data,
+            ),
         );
 
         return $this;
@@ -599,7 +599,7 @@ public function skipSetterFor(mixed $skippedSetters, bool $merge = false)
     {
         if (!is_string($skippedSetters) && !is_array($skippedSetters)) {
             throw new FixtureFactoryException(
-                'BaseFactory::skipSettersFor() accepts an array of string or a string as argument.'
+                'BaseFactory::skipSettersFor() accepts an array of string or a string as argument.',
             );
         }
         $skippedSetters = (array)$skippedSetters;
@@ -642,7 +642,7 @@ public static function get(
         array|string $finder = 'all',
         CacheInterface|string|null $cache = null,
         Closure|string|null $cacheKey = null,
-        mixed ...$args
+        mixed ...$args,
     ): EntityInterface {
         return (new static())->getTable()->get($primaryKey, $finder, $cache, $cacheKey, ...$args);
     }
@@ -666,7 +666,7 @@ public static function count(): int
      * @throws \Cake\Datasource\Exception\RecordNotFoundException When there is no first record.
      */
     public static function firstOrFail(
-        ExpressionInterface|Closure|array|string|null $conditions = null
+        ExpressionInterface|Closure|array|string|null $conditions = null,
     ): EntityInterface|array {
         return self::find()->where($conditions)->firstOrFail();
     }

src/Factory/DataCompiler.php

@@ -192,7 +192,7 @@ public function getCompiledTemplateData(): EntityInterface|array
      */
     public function compileEntity(
         array|callable|EntityInterface|string $injectedData = [],
-        bool $setPrimaryKey = false
+        bool $setPrimaryKey = false,
     ): EntityInterface {
         if (is_string($injectedData)) {
             $injectedData = $this->setDisplayFieldToInjectedString($injectedData);
@@ -238,7 +238,7 @@ private function patchEntity(EntityInterface $entity, array $data): EntityInterf
         return $this->getFactory()->getTable()->patchEntity(
             $entity,
             $data,
-            $this->getFactory()->getMarshallerOptions()
+            $this->getFactory()->getMarshallerOptions(),
         );
     }
 
@@ -262,7 +262,7 @@ private function castArrayNotation(EntityInterface $entity, array $data): array
             $entityValue = $entityValue ?? ($entity->get($rootKey) ?? []);
             if (!is_array($entityValue)) {
                 throw new FixtureFactoryException(
-                    "Value $entityValue cannot be merged with array notation $key => $value"
+                    "Value $entityValue cannot be merged with array notation $key => $value",
                 );
             }
             $data[$rootKey] = $entityValue = array_replace_recursive($entityValue, $subData[$rootKey]);
@@ -291,7 +291,7 @@ private function setDisplayFieldToInjectedString(string $data): array
         $table = get_class($this->getFactory()->getTable());
         throw new FixtureFactoryException(
             'The display field of a table must be a string when injecting a string into its factory. ' .
-            "You injected '$data' in $factory but $table's display field is not a string."
+            "You injected '$data' in $factory but $table's display field is not a string.",
         );
     }
 
@@ -347,7 +347,7 @@ private function mergeWithInjectedData(EntityInterface $entity, array|callable|E
         if (is_callable($data)) {
             $data = $data(
                 $this->getFactory(),
-                $this->getFactory()->getFaker()
+                $this->getFactory()->getFaker(),
             );
         } elseif (is_array($data)) {
             $this->addEnforcedFields($data);
@@ -561,7 +561,7 @@ public function generateArrayOfRandomPrimaryKeys(): array
         $res = [];
         foreach ($primaryKeys as $pk) {
             $res[$pk] = $this->generateRandomPrimaryKey(
-                $this->getFactory()->getTable()->getSchema()->getColumnType($pk)
+                $this->getFactory()->getTable()->getSchema()->getColumnType($pk),
             );
         }
 
@@ -618,7 +618,7 @@ public function setPrimaryKeyOffset(mixed $primaryKeyOffset): void
             $primaryKey = $this->getFactory()->getTable()->getPrimaryKey();
             if (!is_string($primaryKey)) {
                 throw new FixtureFactoryException(
-                    "The primary key assigned must be a string as $primaryKeyOffset is a string or an integer."
+                    "The primary key assigned must be a string as $primaryKeyOffset is a string or an integer.",
                 );
             }
             $this->primaryKeyOffset = [
@@ -628,7 +628,7 @@ public function setPrimaryKeyOffset(mixed $primaryKeyOffset): void
             $this->primaryKeyOffset = $primaryKeyOffset;
         } else {
             throw new FixtureFactoryException(
-                "$primaryKeyOffset must be an integer, a string or an array of format ['primaryKey1' => value, ...]"
+                "$primaryKeyOffset must be an integer, a string or an array of format ['primaryKey1' => value, ...]",
             );
         }
     }
@@ -656,7 +656,7 @@ private function updatePostgresSequence(array $primaryKeys): void
 		            SELECT pg_get_serial_sequence('$tableName','$pk')")->fetchAll()[0][0];
                 if ($seq !== null) {
                     $table->getConnection()->execute(
-                        "SELECT setval('$seq', $offset);"
+                        "SELECT setval('$seq', $offset);",
                     );
                 }
             }
@@ -676,9 +676,9 @@ public function getModifiedUniqueFields(): array
                 $this->getEnforcedFields(),
                 array_merge(
                     $this->getFactory()->getUniqueProperties(),
-                    (array)$this->getFactory()->getTable()->getPrimaryKey()
-                )
-            )
+                    (array)$this->getFactory()->getTable()->getPrimaryKey(),
+                ),
+            ),
         );
     }
 
@@ -727,7 +727,7 @@ public function addEnforcedFields(array $fields): void
     {
         $this->enforcedFields = array_merge(
             array_keys($fields),
-            $this->enforcedFields
+            $this->enforcedFields,
         );
     }