#157 Apply CS check and fix to test cases

.github/workflows/phpstan.yml

@@ -1,4 +1,4 @@
-name: PHPStan
+name: Static analysis
 
 on:
   push:

composer.json

@@ -25,7 +25,7 @@
         "cakephp/bake": "^1.5",
         "cakephp/migrations": "^2.3",
         "josegonzalez/dotenv": "dev-master",
-        "phpstan/phpstan": "0.12.x-dev",
+        "phpstan/phpstan": "^1.0",
         "phpunit/phpunit": "^6.1",
         "vierge-noire/cakephp-test-migrator": "^1.1"
     },

src/Event/ModelEventsHandler.php

@@ -65,9 +65,13 @@ final public function __construct(array $listeningModelEvents, array $listeningB
         $this->listeningBehaviors = $listeningBehaviors;
     }
 
-    public static function handle(Table $table, array $listeningModelEvents = [], array $listeningBehaviors = [])
+    /**
+     * @param \Cake\ORM\Table $table Table
+     * @return void
+     */
+    public function handle(Table $table): void
     {
-        (new static($listeningModelEvents, $listeningBehaviors))->ignoreModelEvents($table);
+        $this->ignoreModelEvents($table);
     }
 
     /**

src/Factory/AssociationBuilder.php

@@ -146,7 +146,7 @@ public function removeAssociationForToOneFactory(string $associationName, BaseFa
      * Get the factory for the association
      *
      * @param string $associationName Association name
-     * @param scalar[]|\CakephpFixtureFactories\Factory\BaseFactory|\Cake\Datasource\EntityInterface|\Cake\Datasource\EntityInterface[] $data Injected data
+     * @param array|int|string|callable|\CakephpFixtureFactories\Factory\BaseFactory|\CakephpFixtureFactories\Factory\BaseFactory[]|\Cake\Datasource\EntityInterface|\Cake\Datasource\EntityInterface[] $data Injected data
      * @return \CakephpFixtureFactories\Factory\BaseFactory
      */
     public function getAssociatedFactory(string $associationName, $data = []): BaseFactory

src/Factory/BaseFactory.php

@@ -509,10 +509,10 @@ protected function setDefaultData(callable $fn): self
     /**
      * Add associated entities to the fixtures generated by the factory
      * The associated name can be of several depth, dot separated
-     * The data can be an array, an integer, an entity interface, a callable or a factory
+     * The data can be an integer, a string, an entity interface, a factory, an array of all that or a callable
      *
      * @param string $associationName Association name
-     * @param array|int|callable|\CakephpFixtureFactories\Factory\BaseFactory|\Cake\Datasource\EntityInterface|string $data Injected data
+     * @param int|string|array|callable|self|\Cake\Datasource\EntityInterface $data Injected data
      * @return $this
      */
     public function with(string $associationName, $data = []): self

src/ORM/FactoryTableLocator.php

@@ -35,11 +35,8 @@ protected function _create(array $options): Table
 
         $behaviors = array_merge($options[EventCollector::MODEL_BEHAVIORS] ?? [], $defaultBehaviors);
 
-        ModelEventsHandler::handle(
-            $table,
-            $options[EventCollector::MODEL_EVENTS] ?? [],
-            $behaviors
-        );
+        (new ModelEventsHandler($options[EventCollector::MODEL_EVENTS] ?? [], $behaviors))
+            ->handle($table);
 
         $table->getEventManager()->on('Model.beforeSave', function ($event, $entity, $options) use ($table) {
             FactoryTableBeforeSave::handle($table, $entity);

tests/Scenario/NAustralianAuthorsScenario.php

@@ -13,21 +13,21 @@
  */
 namespace CakephpFixtureFactories\Test\Scenario;
 
-
 use CakephpFixtureFactories\Scenario\FixtureScenarioInterface;
 use CakephpFixtureFactories\Test\Factory\AuthorFactory;
-use TestApp\Model\Entity\Author;
 
 class NAustralianAuthorsScenario implements FixtureScenarioInterface
 {
-    const COUNTRY_NAME = 'Australia';
+    public const COUNTRY_NAME = 'Australia';
 
     /**
-     * @param int $n the number of authors
-     * @return Author|Author[]
+     * @param mixed $args the number of authors
+     * @return \TestApp\Model\Entity\Author|\TestApp\Model\Entity\Author[]
      */
     public function load($n = 1, ...$args)
     {
+        $n = $args[0];
+
         return AuthorFactory::make($n)->fromCountry(self::COUNTRY_NAME)->persist();
     }
 }

tests/Scenario/SubFolder/SubFolderScenario.php

@@ -13,7 +13,6 @@
  */
 namespace CakephpFixtureFactories\Test\Scenario\SubFolder;
 
-
 use CakephpFixtureFactories\Scenario\FixtureScenarioInterface;
 
 class SubFolderScenario implements FixtureScenarioInterface

tests/TestApp/plugins/TestPlugin/src/Model/Table/AbstractPluginTable.php

@@ -16,4 +16,5 @@
 use Cake\ORM\Table;
 
 abstract class AbstractPluginTable extends Table
-{}
+{
+}

tests/TestApp/src/Model/Entity/Country.php

@@ -4,7 +4,6 @@
 namespace TestApp\Model\Entity;
 
 use Cake\ORM\Entity;
-use CakephpFixtureFactories\Test\TestCase\Factory\BaseFactoryAssociationsTest;
 
 /**
  * Country Entity

tests/TestApp/src/Model/Table/AbstractAppTable.php

@@ -16,4 +16,5 @@
 use Cake\ORM\Table;
 
 abstract class AbstractAppTable extends Table
-{}
+{
+}

tests/TestApp/src/Model/Table/ArticlesTable.php

@@ -44,8 +44,9 @@ public function initialize(array $config)
     public function findPublished(Query $query, array $options): Query
     {
         $query->where([
-            $this->aliasField('published') => 1
+            $this->aliasField('published') => 1,
         ]);
+
         return $query;
     }
 }

tests/TestCase/Command/SetupCommandTest.php

@@ -50,7 +50,7 @@ class SetupCommandTest extends TestCase
     public function setUp()
     {
         $this->setupCommand = new SetupCommand();
-        $this->io  = new ConsoleIo();
+        $this->io = new ConsoleIo();
     }
 
     public function tearDown()

tests/TestCase/DocumentationExamplesTest.php

@@ -29,7 +29,6 @@ public function testArticlesFindPublished()
         $result = ArticleFactory::find('published')
             ->find('list')
             ->toArray();
-
         $expected = [
             $articles[0]->id => $articles[0]->title,
             $articles[1]->id => $articles[1]->title,

tests/TestCase/Event/ModelEventsHandlerTest.php

@@ -57,14 +57,16 @@ public function testBeforeMarshalOnTable()
 
     public function testBeforeMarshalOnTableHandled()
     {
-        ModelEventsHandler::handle($this->Countries);
-        $country = $this->Countries->newEntity(['name' => 'Foo']);
+        $Countries = TableRegistry::getTableLocator()->get('Countries');
+        (new ModelEventsHandler([], []))->handle($Countries);
+        $country = $Countries->newEntity(['name' => 'Foo']);
         $this->assertNull($country->get('beforeMarshalTriggered'));
     }
     public function testBeforeMarshalOnTableHandledPermissive()
     {
-        ModelEventsHandler::handle($this->Countries, ['Model.beforeMarshal']);
-        $country = $this->Countries->newEntity(['name' => 'Foo']);
+        $Countries = TableRegistry::getTableLocator()->get('Countries');
+        (new ModelEventsHandler(['Model.beforeMarshal'], []))->handle($Countries);
+        $country = $Countries->newEntity(['name' => 'Foo']);
         $this->assertTrue($country->get('beforeMarshalTriggered'));
     }
 
@@ -77,17 +79,21 @@ public function testBeforeSaveInBehaviorOnTable()
 
     public function testBeforeSaveInBehaviorOnTableHandled()
     {
-        ModelEventsHandler::handle($this->Articles);
-        $article = $this->Articles->newEntity(['title' => 'Foo']);
-        $this->Articles->saveOrFail($article);
+        $Articles = TableRegistry::getTableLocator()->get('Articles');
+        (new ModelEventsHandler([], []))->handle($Articles);
+
+        $article = $Articles->newEntity(['title' => 'Foo']);
+        $Articles->saveOrFail($article);
         $this->assertNull($article->get('beforeSaveInBehaviorTriggered'));
     }
 
     public function testBeforeSaveInBehaviorOnTableHandledPermissive()
     {
-        ModelEventsHandler::handle($this->Articles, [], ['Sluggable']);
-        $article = $this->Articles->newEntity(['title' => 'Foo']);
-        $this->Articles->saveOrFail($article);
+        $Articles = TableRegistry::getTableLocator()->get('Articles');
+        (new ModelEventsHandler([], ['Sluggable']))->handle($Articles);
+
+        $article = $Articles->newEntity(['title' => 'Foo']);
+        $Articles->saveOrFail($article);
         $this->assertTrue($article->get('beforeSaveInBehaviorTriggered'));
     }
 }

tests/TestCase/Factory/AssociationBuilderTest.php

@@ -188,9 +188,9 @@ public function testCollectAssociatedFactoryDeep2()
         $expected = [
             'City' => CityFactory::make()->getMarshallerOptions() + [
                 'associated' => [
-                    'Country' =>  CountryFactory::make()->getMarshallerOptions(),
-                ]
-            ]
+                    'Country' => CountryFactory::make()->getMarshallerOptions(),
+                ],
+            ],
         ];
         $this->assertSame($expected, $AddressFactory->getAssociated());
     }

tests/TestCase/Factory/BaseFactoryAssociationsTest.php

@@ -28,9 +28,7 @@
 use CakephpFixtureFactories\Test\Factory\CountryFactory;
 use CakephpFixtureFactories\Test\Factory\CustomerFactory;
 use CakephpFixtureFactories\Test\Factory\SubDirectory\SubCityFactory;
-use Exception;
 use TestApp\Model\Entity\Address;
-use TestApp\Model\Entity\Article;
 use TestApp\Model\Entity\City;
 use TestApp\Model\Entity\Country;
 use TestApp\Model\Entity\PremiumAuthor;
@@ -232,9 +230,7 @@ public function testGetAssociatedFactoryWithMultipleDepthAndMultipleTimes()
         $n = 10;
         $country = 'Foo';
         $path = 'BusinessAddress.City.Country';
-        $authors = AuthorFactory::make($n)->with($path, [
-            'name' => $country,
-        ])->persist();
+        $authors = AuthorFactory::make($n)->with($country)->persist();
 
         for ($i = 0; $i < $n; $i++) {
             $this->assertInstanceOf(Country::class, $authors[$i]->business_address->city->country);
@@ -313,11 +309,11 @@ public function testGetAssociatedFactoryWithReversedAssociation()
     {
         $name1 = 'Bar';
         $name2 = 'Foo';
-        AuthorFactory::make(['name' => $name1])
-            ->with('Articles.Authors', ['name' => $name2])
+        AuthorFactory::make($name1)
+            ->with('Articles.Authors', $name2)
             ->persist();
 
-        /** @var Article $article */
+        /** @var \TestApp\Model\Entity\Article $article */
         $article = ArticleFactory::find()
             ->contain('Authors', function ($q) {
                 return $q->order('Authors.name');
@@ -365,9 +361,9 @@ public function testAssignWithoutToManyAssociation()
     {
         $countryExpected = 'Foo';
         $countryNotExpected = 'Bar';
-        CountryFactory::make(['name' => $countryExpected])
+        CountryFactory::make($countryExpected)
             ->with('Cities', CityFactory::make()
-            ->with('Country', ['name' => $countryNotExpected]))
+            ->with('Country', $countryNotExpected))
             ->persist();
 
         $this->assertSame(1, CityFactory::count());
@@ -403,7 +399,8 @@ public function testAssignWithBelongsToManyAssociation()
         $nArticles = rand(3, 10);
         $authorName = 'Foo';
         $article = ArticleFactory::make()
-            ->with('Authors', AuthorFactory::make(['name' => 'Foo'])->with('Articles', $nArticles))
+            ->with('Authors', AuthorFactory::make('Foo')
+            ->with('Articles', $nArticles))
             ->persist();
 
         $authorsAssociatedToArticle = AuthorFactory::find()
@@ -518,8 +515,8 @@ public function testCountryWith2Cities()
         $city2 = 'B city';
 
         $country = CountryFactory::make()
-            ->with('Cities', ['name' => $city1])
-            ->with('Cities', ['name' => $city2])
+            ->with('Cities', $city1)
+            ->with('Cities', $city2)
             ->persist();
 
         // Make sure that all was correctly persisted
@@ -599,7 +596,6 @@ public function testCountryWith4Cities()
      * associated factory
      *
      * @see Country::_getVirtualCities()
-     * @throws Exception
      */
     public function testAssociationWithVirtualFieldNamedIdentically()
     {

tests/TestCase/Factory/BaseFactoryDisplayFieldTest.php

@@ -17,29 +17,11 @@
 use Cake\Datasource\EntityInterface;
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
-use Cake\Utility\Inflector;
 use CakephpFixtureFactories\Error\FixtureFactoryException;
-use CakephpFixtureFactories\Factory\BaseFactory;
 use CakephpFixtureFactories\Test\Factory\AddressFactory;
 use CakephpFixtureFactories\Test\Factory\ArticleFactory;
-use CakephpFixtureFactories\Test\Factory\AuthorFactory;
 use CakephpFixtureFactories\Test\Factory\BillFactory;
-use CakephpFixtureFactories\Test\Factory\CityFactory;
 use CakephpFixtureFactories\Test\Factory\CountryFactory;
-use CakephpFixtureFactories\Test\Factory\CustomerFactory;
-use Faker\Generator;
-use TestApp\Model\Entity\Address;
-use TestApp\Model\Entity\Article;
-use TestApp\Model\Entity\Author;
-use TestApp\Model\Entity\City;
-use TestApp\Model\Entity\Country;
-use TestApp\Model\Table\ArticlesTable;
-use TestApp\Model\Table\CountriesTable;
-use TestPlugin\Model\Entity\Bill;
-use TestPlugin\Model\Table\BillsTable;
-use function count;
-use function is_array;
-use function is_int;
 
 class BaseFactoryDisplayFieldTest extends TestCase
 {

tests/TestCase/Factory/BaseFactoryHiddenPropertiesTest.php

@@ -92,7 +92,8 @@ public function testHiddenPropertyInMainBuild(int $n, bool $persist)
      */
     public function testHiddenPropertyInBelongsToManyAssociation(int $n, bool $persist)
     {
-        $factory = AuthorFactory::make()->with('Articles',
+        $factory = AuthorFactory::make()->with(
+            'Articles',
             ArticleFactory::make($n)->withHiddenBiography(self::DUMMY_HIDDEN_PARAGRAPH)
         );
 
@@ -112,7 +113,8 @@ public function testHiddenPropertyInBelongsToManyAssociation(int $n, bool $persi
      */
     public function testHiddenPropertyInBelongsToAssociation(int $n, bool $persist)
     {
-        $factory = BillFactory::make($n)->with('Article',
+        $factory = BillFactory::make($n)->with(
+            'Article',
             ArticleFactory::make()->withHiddenBiography(self::DUMMY_HIDDEN_PARAGRAPH)
         );
 

tests/TestCase/Factory/BaseFactoryLoadAssociationsInInitializeTest.php

@@ -174,7 +174,7 @@ public function testLoadAssociationOnTheFly_BelongsToMany_With_Magic_Persist($cl
         $factory->getTable()->belongsToMany('ParallelArticles', [
             'className' => $className,
             'joinTable' => 'articles_authors',
-            'targetForeignKey' => 'article_id'
+            'targetForeignKey' => 'article_id',
         ]);
 
         $name = 'Foo';

tests/TestCase/Factory/BaseFactoryMakeWithEntityTest.php

@@ -14,14 +14,12 @@
 
 namespace CakephpFixtureFactories\Test\TestCase\Factory;
 
-
 use Cake\Core\Configure;
 use Cake\TestSuite\TestCase;
 use CakephpFixtureFactories\Test\Factory\AddressFactory;
 use CakephpFixtureFactories\Test\Factory\ArticleFactory;
 use CakephpFixtureFactories\Test\Factory\AuthorFactory;
 
-
 class BaseFactoryMakeWithEntityTest extends TestCase
 {
     public static function setUpBeforeClass(): void
@@ -122,8 +120,8 @@ public function testWithEntitiesAndTimes()
         $authors = AuthorFactory::make($authors1, $m)->persist();
 
         $count = 0;
-        for ($i=0; $i<$m; $i++) {
-            for ($j=0; $j<$n; $j++) {
+        for ($i = 0; $i < $m; $i++) {
+            for ($j = 0; $j < $n; $j++) {
                 $this->assertSame($authors1[$j], $authors[$count]);
                 $count++;
             }

tests/TestCase/Factory/BaseFactoryPrimaryKeyOffsetTest.php

@@ -19,7 +19,6 @@
 use CakephpFixtureFactories\Test\Factory\BillFactory;
 use CakephpFixtureFactories\Test\Factory\CityFactory;
 use CakephpFixtureFactories\Test\Factory\CountryFactory;
-use TestApp\Model\Entity\Country;
 
 class BaseFactoryPrimaryKeyOffsetTest extends TestCase
 {
@@ -92,7 +91,7 @@ public function testSetPrimaryKeyOffsetInMultipleAssociationAndBase()
         $cityOffset = rand(1, 100000);
         $countryOffset = rand(1, 100000);
 
-        /** @var Country $country */
+        /** @var \TestApp\Model\Entity\Country $country */
         $country = CountryFactory::make()
             ->with('Cities', CityFactory::make($nCities)->setPrimaryKeyOffset($cityOffset))
             ->setPrimaryKeyOffset($countryOffset)