Merge pull request #1643 from spryker/cs-tests-src

CS for tests
propelorm · Aug 5, 2020 · 3cc71ba · 3cc71ba
2 parents 42c6da4 + 008ff38
commit 3cc71ba
Show file tree

Hide file tree

Showing 313 changed files with 1,617 additions and 1,426 deletions.
diff --git a/config/phpcs.xml b/config/phpcs.xml
@@ -30,8 +30,4 @@
         <severity>0</severity>
     </rule>
 
-    <rule ref="Spryker.Commenting.DocBlockReturnSelf">
-        <severity>0</severity>
-    </rule>
-
 </ruleset>
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
diff --git a/resources/dtd/database.dtd b/resources/dtd/database.dtd
@@ -1,6 +1,5 @@
 <!--
     Propel XML database schema DTD
-    $Id: database.dtd,v 1.7 2005/03/30 11:38:18 hlellelid Exp $
 
     This is based very closely on the schema DTD for Torque, but
     some differences do exist.

diff --git a/src/Propel/Generator/Behavior/QueryCache/QueryCacheBehavior.php b/src/Propel/Generator/Behavior/QueryCache/QueryCacheBehavior.php
@@ -325,7 +325,6 @@ public function doCount(ConnectionInterface \$con = null)
             \$this->cacheStore(\$key, \$sql);
     }
 
-
     return \$con->getDataFetcher(\$stmt);
 }
 ";

diff --git a/src/Propel/Generator/Builder/Util/SchemaReader.php b/src/Propel/Generator/Builder/Util/SchemaReader.php
@@ -96,20 +96,18 @@ class SchemaReader
     private $defaultPackage;
 
     /**
-     * @var bool
-     */
-    private $firstPass;
-
-    /**
+     * @deprecated Unused.
+     *
      * @var string
      */
     private $encoding;
 
     /**
-     * @var array
-     * two-dimensional array,
+     * Two-dimensional array,
      * first dimension is for schemas(key is the path to the schema file),
-     * second is for tags within the schema
+     * second is for tags within the schema.
+     *
+     * @var array
      */
     private $schemasTagsStack = [];
 
@@ -124,7 +122,6 @@ public function __construct(?PlatformInterface $defaultPlatform = null, $default
     {
         $this->schema = new Schema($defaultPlatform);
         $this->defaultPackage = $defaultPackage;
-        $this->firstPass = true;
         $this->encoding = $encoding;
     }
 

diff --git a/src/Propel/Generator/Command/Console/Input/ArrayInput.php b/src/Propel/Generator/Command/Console/Input/ArrayInput.php
@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * This file is part of the Symfony package.
  *
  * (c) Fabien Potencier <fabien@symfony.com>

diff --git a/src/Propel/Generator/Util/BehaviorLocator.php b/src/Propel/Generator/Util/BehaviorLocator.php
@@ -35,6 +35,8 @@ class BehaviorLocator
     private $composerDir;
 
     /**
+     * @deprecated Unused.
+     *
      * @var \Propel\Generator\Config\GeneratorConfigInterface
      */
     private $generatorConfig;

diff --git a/src/Propel/Runtime/ActiveQuery/Criteria.php b/src/Propel/Runtime/ActiveQuery/Criteria.php
@@ -771,11 +771,13 @@ public function get($key)
      * @param string $key
      * @param mixed $value
      *
-     * @return $this Instance of self.
+     * @return $this
      */
     public function put($key, $value)
     {
-        return $this->add($key, $value);
+        $this->add($key, $value);
+
+        return $this;
     }
 
     /**
@@ -936,7 +938,9 @@ public function addJoin($left, $right, $joinType = null)
                 $conditions[] = $condition;
             }
 
-            return $this->addMultipleJoin($conditions, $joinType);
+            $this->addMultipleJoin($conditions, $joinType);
+
+            return $this;
         }
 
         $join = new Join();
@@ -966,7 +970,9 @@ public function addJoin($left, $right, $joinType = null)
 
         $join->setJoinType($joinType);
 
-        return $this->addJoinObject($join);
+        $this->addJoinObject($join);
+
+        return $this;
     }
 
     /**
@@ -1042,7 +1048,9 @@ public function addMultipleJoin($conditions, $joinType = null)
         $join->setJoinType($joinType);
         $join->setJoinCondition($joinCondition);
 
-        return $this->addJoinObject($join);
+        $this->addJoinObject($join);
+
+        return $this;
     }
 
     /**
@@ -1886,10 +1894,14 @@ public function addUsingOperator($p1, $value = null, $operator = null, $preferCo
         if ($this->defaultCombineOperator === Criteria::LOGICAL_OR) {
             $this->defaultCombineOperator = Criteria::LOGICAL_AND;
 
-            return $this->addOr($p1, $value, $operator, $preferColumnCondition);
+            $this->addOr($p1, $value, $operator, $preferColumnCondition);
+
+            return $this;
         }
 
-        return $this->addAnd($p1, $value, $operator, $preferColumnCondition);
+        $this->addAnd($p1, $value, $operator, $preferColumnCondition);
+
+        return $this;
     }
 
     /**
@@ -2808,7 +2820,7 @@ public function _elseif($cond)
      *
      * @throws \Propel\Runtime\Exception\LogicException
      *
-     * @return \Propel\Runtime\Util\PropelConditionalProxy|$this
+     * @return \Propel\Runtime\Util\PropelConditionalProxy|static
      */
     public function _else()
     {
@@ -2825,7 +2837,7 @@ public function _else()
      *
      * @throws \Propel\Runtime\Exception\LogicException
      *
-     * @return $this
+     * @return $this|\Propel\Runtime\ActiveQuery\Criteria
      */
     public function _endif()
     {

diff --git a/src/Propel/Runtime/ActiveQuery/ModelCriteria.php b/src/Propel/Runtime/ActiveQuery/ModelCriteria.php
@@ -154,7 +154,9 @@ public function condition($conditionName, $clause, $value = null, $bindingType =
      */
     public function filterBy($column, $value, $comparison = Criteria::EQUAL)
     {
-        return $this->add($this->getRealColumnName($column), $value, $comparison);
+        $this->add($this->getRealColumnName($column), $value, $comparison);
+
+        return $this;
     }
 
     /**
@@ -882,7 +884,7 @@ public function setPrimaryCriteria(ModelCriteria $criteria, Join $previousJoin)
     /**
      * Gets the primary criteria for this secondary Criteria
      *
-     * @return $this|null The primary criteria
+     * @return \Propel\Runtime\ActiveQuery\ModelCriteria|null The primary criteria
      */
     public function getPrimaryCriteria()
     {
@@ -2240,7 +2242,9 @@ public static function getShortName($fullyQualifiedClassName)
      */
     public function addUsingAlias($column, $value = null, $operator = null)
     {
-        return $this->addUsingOperator($this->getAliasedColName($column), $value, $operator);
+        $this->addUsingOperator($this->getAliasedColName($column), $value, $operator);
+
+        return $this;
     }
 
     /**

diff --git a/src/Propel/Runtime/ActiveQuery/ModelJoin.php b/src/Propel/Runtime/ActiveQuery/ModelJoin.php
@@ -156,7 +156,9 @@ public function isPrimary()
      */
     public function setRelationAlias($relationAlias)
     {
-        return $this->setRightTableAlias($relationAlias);
+        $this->setRightTableAlias($relationAlias);
+
+        return $this;
     }
 
     /**

diff --git a/tests/Propel/Tests/Bookstore/AuthorCollection.php b/tests/Propel/Tests/Bookstore/AuthorCollection.php
@@ -1,5 +1,11 @@
 <?php
 
+/**
+ * MIT License. This file is part of the Propel package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Propel\Tests\Bookstore;
 
 use Propel\Runtime\Collection\ObjectCollection;

diff --git a/tests/Propel/Tests/BookstoreLoggingTest.php b/tests/Propel/Tests/BookstoreLoggingTest.php
@@ -1,11 +1,9 @@
 <?php
 
 /**
- * This file is part of the Propel package.
+ * MIT License. This file is part of the Propel package.
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * @license MIT License
  */
 
 namespace Propel\Tests;

diff --git a/tests/Propel/Tests/BookstoreTest.php b/tests/Propel/Tests/BookstoreTest.php
@@ -1,11 +1,9 @@
 <?php
 
 /**
- * This file is part of the Propel package.
+ * MIT License. This file is part of the Propel package.
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * @license MIT License
  */
 
 namespace Propel\Tests;

diff --git a/tests/Propel/Tests/CharacterEncodingTest.php b/tests/Propel/Tests/CharacterEncodingTest.php
@@ -1,11 +1,9 @@
 <?php
 
 /**
- * This file is part of the Propel package.
+ * MIT License. This file is part of the Propel package.
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * @license MIT License
  */
 
 namespace Propel\Tests;
@@ -38,13 +36,6 @@
  */
 class CharacterEncodingTest extends BookstoreTestBase
 {
-    /**
-     * Database adapter.
-     *
-     * @var DBAdapter
-     */
-    private $adapter;
-
     /**
      * @throws \Exception
      *

diff --git a/tests/Propel/Tests/Common/Config/ConfigTestCase.php b/tests/Propel/Tests/Common/Config/ConfigTestCase.php
@@ -1,11 +1,9 @@
 <?php
 
 /**
- * This file is part of the Propel package.
+ * MIT License. This file is part of the Propel package.
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * @license MIT License
  */
 
 namespace Propel\Tests\Common\Config;
@@ -21,11 +19,13 @@
 class ConfigTestCase extends TestCase
 {
     /**
-     * @var null
-     * Symfony\Component\Filesystem\Filesystem instance
+     * @var \Symfony\Component\Filesystem\Filesystem|null
      */
     private $fileSystem;
 
+    /**
+     * @return \Symfony\Component\Filesystem\Filesystem
+     */
     public function getFilesystem()
     {
         if (null === $this->fileSystem) {

diff --git a/tests/Propel/Tests/Common/Config/ConfigurationManagerTest.php b/tests/Propel/Tests/Common/Config/ConfigurationManagerTest.php
@@ -1,11 +1,9 @@
 <?php
 
 /**
- * This file is part of the Propel package.
+ * MIT License. This file is part of the Propel package.
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * @license MIT License
  */
 
 namespace Propel\Tests\Common\Config;
@@ -114,6 +112,7 @@ public function testNotExistingConfigFileLoadsDefaultSettingsAndDoesNotThrowExce
         $this->getFilesystem()->dumpFile('doctrine.yaml', $yamlConf);
 
         $manager = new TestableConfigurationManager();
+        $this->assertInstanceOf(ConfigurationManager::class, $manager);
     }
 
     /**
@@ -154,7 +153,7 @@ public function testUnsupportedExtensionsAreIgnored()
     }
 
     /**
-     * @expectedException Propel\Common\Config\Exception\InvalidArgumentException
+     * @expectedException \Propel\Common\Config\Exception\InvalidArgumentException
      *
      * @exceptionMessage Propel expects only one configuration file
      *
@@ -177,7 +176,7 @@ public function testMoreThanOneConfigurationFileInSameDirectoryThrowsException()
     }
 
     /**
-     * @expectedException Propel\Common\Config\Exception\InvalidArgumentException
+     * @expectedException \Propel\Common\Config\Exception\InvalidArgumentException
      *
      * @exceptionMessage Propel expects only one configuration file
      *
@@ -385,7 +384,7 @@ public function testMergeExtraProperties()
     }
 
     /**
-     * @expectedException Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
      * @expectedExceptionMessage Unrecognized options "foo, bar" under "propel"
      *
      * @return void
@@ -439,7 +438,7 @@ classname: Propel\Runtime\Connection\ConnectionWrapper
     }
 
     /**
-     * @expectedException Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
      * @expectedExceptionMessage The child node "database" at path "propel" must be configured
      *
      * @return void
@@ -458,7 +457,7 @@ public function testNotDefineDatabaseSectionTrowsException()
     }
 
     /**
-     * @expectedException Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
      * @expectedExceptionMessage Dots are not allowed in connection names
      *
      * @return void
@@ -648,7 +647,7 @@ classname: Propel\Runtime\Connection\DebugPDO
     }
 
     /**
-     * @expectedException Propel\Common\Config\Exception\InvalidArgumentException
+     * @expectedException \Propel\Common\Config\Exception\InvalidArgumentException
      * @expectedExceptionMessage Invalid configuration property name
      *
      * @return void