Enhancement: Enable no_superfluous_phpdoc_tags fixer (#199)

* Enhancement: Enable no_superfluous_phpdoc_tags fixer * Fix: Run 'make cs' * Fix: Run 'make baseline'
FakerPHP · Dec 21, 2020 · c65e3b6 · c65e3b6
1 parent cc4e86b
commit c65e3b6
Show file tree

Hide file tree

Showing 33 changed files with 23 additions and 160 deletions.
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -83,6 +83,7 @@ return $config
         'no_leading_import_slash' => true,
         'no_leading_namespace_whitespace' => true,
         'no_superfluous_elseif' => true,
+        'no_superfluous_phpdoc_tags' => true,
         'no_unneeded_curly_braces' => true,
         'no_unneeded_final_method' => true,
         'no_unreachable_default_argument_value' => true,

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -47,7 +47,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$class of method Faker\\\\ORM\\\\Doctrine\\\\ColumnTypeGuesser\\:\\:guessFormat\\(\\) has invalid typehint type Doctrine\\\\Common\\\\Persistence\\\\Mapping\\\\ClassMetadata\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Doctrine/ColumnTypeGuesser.php
 
 		-
@@ -67,7 +67,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$class of method Faker\\\\ORM\\\\Doctrine\\\\EntityPopulator\\:\\:__construct\\(\\) has invalid typehint type Doctrine\\\\Common\\\\Persistence\\\\Mapping\\\\ClassMetadata\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Doctrine/EntityPopulator.php
 
 		-
@@ -157,7 +157,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$manager of method Faker\\\\ORM\\\\Doctrine\\\\EntityPopulator\\:\\:execute\\(\\) has invalid typehint type Doctrine\\\\Common\\\\Persistence\\\\ObjectManager\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Doctrine/EntityPopulator.php
 
 		-
@@ -187,7 +187,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$manager of method Faker\\\\ORM\\\\Doctrine\\\\EntityPopulator\\:\\:generateId\\(\\) has invalid typehint type Doctrine\\\\Common\\\\Persistence\\\\ObjectManager\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Doctrine/EntityPopulator.php
 
 		-
@@ -202,7 +202,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$manager of method Faker\\\\ORM\\\\Doctrine\\\\Populator\\:\\:__construct\\(\\) has invalid typehint type Doctrine\\\\Common\\\\Persistence\\\\ObjectManager\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Doctrine/Populator.php
 
 		-
@@ -227,7 +227,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$mandango of method Faker\\\\ORM\\\\Mandango\\\\EntityPopulator\\:\\:guessColumnFormatters\\(\\) has invalid typehint type Mandango\\\\Mandango\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Mandango/EntityPopulator.php
 
 		-
@@ -237,7 +237,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$mandango of method Faker\\\\ORM\\\\Mandango\\\\EntityPopulator\\:\\:execute\\(\\) has invalid typehint type Mandango\\\\Mandango\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Mandango/EntityPopulator.php
 
 		-
@@ -252,12 +252,12 @@ parameters:
 
 		-
 			message: "#^Parameter \\$mandango of method Faker\\\\ORM\\\\Mandango\\\\Populator\\:\\:__construct\\(\\) has invalid typehint type Mandango\\\\Mandango\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Mandango/Populator.php
 
 		-
 			message: "#^Parameter \\$column of method Faker\\\\ORM\\\\Propel\\\\ColumnTypeGuesser\\:\\:guessFormat\\(\\) has invalid typehint type ColumnMap\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Propel/ColumnTypeGuesser.php
 
 		-
@@ -402,7 +402,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$columnMap of method Faker\\\\ORM\\\\Propel\\\\EntityPopulator\\:\\:isColumnBehavior\\(\\) has invalid typehint type ColumnMap\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Propel/EntityPopulator.php
 
 		-
@@ -447,7 +447,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$column of method Faker\\\\ORM\\\\Propel2\\\\ColumnTypeGuesser\\:\\:guessFormat\\(\\) has invalid typehint type Propel\\\\Runtime\\\\Map\\\\ColumnMap\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Propel2/ColumnTypeGuesser.php
 
 		-
@@ -597,7 +597,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$columnMap of method Faker\\\\ORM\\\\Propel2\\\\EntityPopulator\\:\\:isColumnBehavior\\(\\) has invalid typehint type Propel\\\\Runtime\\\\Map\\\\ColumnMap\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Propel2/EntityPopulator.php
 
 		-
@@ -652,12 +652,12 @@ parameters:
 
 		-
 			message: "#^Parameter \\$locator of method Faker\\\\ORM\\\\Spot\\\\EntityPopulator\\:\\:__construct\\(\\) has invalid typehint type Spot\\\\Locator\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Spot/EntityPopulator.php
 
 		-
 			message: "#^Parameter \\$mapper of method Faker\\\\ORM\\\\Spot\\\\EntityPopulator\\:\\:__construct\\(\\) has invalid typehint type Spot\\\\Mapper\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Spot/EntityPopulator.php
 
 		-
@@ -707,7 +707,7 @@ parameters:
 
 		-
 			message: "#^Parameter \\$locator of method Faker\\\\ORM\\\\Spot\\\\Populator\\:\\:__construct\\(\\) has invalid typehint type Spot\\\\Locator\\.$#"
-			count: 2
+			count: 1
 			path: src/Faker/ORM/Spot/Populator.php
 
 		-

diff --git a/psalm.baseline.xml b/psalm.baseline.xml
@@ -45,9 +45,7 @@
     </UndefinedDocblockClass>
   </file>
   <file src="src/Faker/ORM/Doctrine/Populator.php">
-    <UndefinedClass occurrences="1">
-      <code>ObjectManager|null</code>
-    </UndefinedClass>
+    <UndefinedClass occurrences="1"/>
     <UndefinedDocblockClass occurrences="3">
       <code>$this-&gt;manager</code>
       <code>ObjectManager|null</code>
@@ -145,7 +143,6 @@
   <file src="src/Faker/ORM/Spot/Populator.php">
     <UndefinedClass occurrences="2">
       <code>$this-&gt;locator</code>
-      <code>Locator|null</code>
     </UndefinedClass>
     <UndefinedDocblockClass occurrences="1">
       <code>Locator</code>

diff --git a/src/Faker/Calculator/Isbn.php b/src/Faker/Calculator/Isbn.php
@@ -18,8 +18,6 @@ class Isbn
      * @param string $input ISBN without check-digit
      *
      * @throws \LengthException When wrong input length passed
-     *
-     * @return string
      */
     public static function checksum(string $input): string
     {
@@ -48,8 +46,6 @@ function (&$digit, $position) {
      * Checks whether the provided number is a valid ISBN-10 number
      *
      * @param string $isbn ISBN to check
-     *
-     * @return bool
      */
     public static function isValid(string $isbn): bool
     {

diff --git a/src/Faker/DefaultGenerator.php b/src/Faker/DefaultGenerator.php
@@ -17,8 +17,6 @@ public function __construct($default = null)
 
     /**
      * @param string $attribute
-     *
-     * @return mixed
      */
     public function __get($attribute)
     {
@@ -28,8 +26,6 @@ public function __get($attribute)
     /**
      * @param string $method
      * @param array  $attributes
-     *
-     * @return mixed
      */
     public function __call($method, $attributes)
     {

diff --git a/src/Faker/Documentor.php b/src/Faker/Documentor.php
@@ -6,9 +6,6 @@ class Documentor
 {
     protected $generator;
 
-    /**
-     * @param Generator $generator
-     */
     public function __construct(Generator $generator)
     {
         $this->generator = $generator;

diff --git a/src/Faker/Generator.php b/src/Faker/Generator.php
@@ -287,8 +287,6 @@ protected function callFormatWithMatches($matches)
 
     /**
      * @param string $attribute
-     *
-     * @return mixed
      */
     public function __get($attribute)
     {
@@ -298,8 +296,6 @@ public function __get($attribute)
     /**
      * @param string $method
      * @param array  $attributes
-     *
-     * @return mixed
      */
     public function __call($method, $attributes)
     {

diff --git a/src/Faker/Guesser/Name.php b/src/Faker/Guesser/Name.php
@@ -8,9 +8,6 @@ class Name
 {
     protected $generator;
 
-    /**
-     * @param \Faker\Generator $generator
-     */
     public function __construct(\Faker\Generator $generator)
     {
         $this->generator = $generator;

diff --git a/src/Faker/ORM/CakePHP/Populator.php b/src/Faker/ORM/CakePHP/Populator.php
@@ -9,9 +9,6 @@ class Populator
     protected $quantities = [];
     protected $guessers = [];
 
-    /**
-     * @param \Faker\Generator $generator
-     */
     public function __construct(\Faker\Generator $generator)
     {
         $this->generator = $generator;

diff --git a/src/Faker/ORM/Doctrine/ColumnTypeGuesser.php b/src/Faker/ORM/Doctrine/ColumnTypeGuesser.php
@@ -15,8 +15,6 @@ public function __construct(Generator $generator)
     }
 
     /**
-     * @param ClassMetadata $class
-     *
      * @return \Closure|null
      */
     public function guessFormat($fieldName, ClassMetadata $class)

diff --git a/src/Faker/ORM/Doctrine/EntityPopulator.php b/src/Faker/ORM/Doctrine/EntityPopulator.php
@@ -23,9 +23,6 @@ class EntityPopulator
      */
     protected $modifiers = [];
 
-    /**
-     * @param ClassMetadata $class
-     */
     public function __construct(ClassMetadata $class)
     {
         $this->class = $class;
@@ -57,9 +54,6 @@ public function mergeColumnFormattersWith($columnFormatters)
         $this->columnFormatters = array_merge($this->columnFormatters, $columnFormatters);
     }
 
-    /**
-     * @param array $modifiers
-     */
     public function setModifiers(array $modifiers)
     {
         $this->modifiers = $modifiers;
@@ -73,17 +67,12 @@ public function getModifiers()
         return $this->modifiers;
     }
 
-    /**
-     * @param array $modifiers
-     */
     public function mergeModifiersWith(array $modifiers)
     {
         $this->modifiers = array_merge($this->modifiers, $modifiers);
     }
 
     /**
-     * @param \Faker\Generator $generator
-     *
      * @return array
      */
     public function guessColumnFormatters(\Faker\Generator $generator)
@@ -177,8 +166,7 @@ public function guessColumnFormatters(\Faker\Generator $generator)
     /**
      * Insert one new record using the Entity class.
      *
-     * @param ObjectManager $manager
-     * @param bool          $generateId
+     * @param bool $generateId
      *
      * @return EntityPopulator
      */
@@ -238,8 +226,6 @@ private function callMethods($obj, $insertedEntities)
     }
 
     /**
-     * @param ObjectManager $manager
-     *
      * @return int|null
      */
     private function generateId($obj, $column, ObjectManager $manager)

diff --git a/src/Faker/ORM/Doctrine/Populator.php b/src/Faker/ORM/Doctrine/Populator.php
@@ -32,9 +32,7 @@ class Populator
     /**
      * Populator constructor.
      *
-     * @param Generator          $generator
-     * @param ObjectManager|null $manager
-     * @param int                $batchSize
+     * @param int $batchSize
      */
     public function __construct(Generator $generator, ObjectManager $manager = null, $batchSize = 1000)
     {

diff --git a/src/Faker/ORM/Mandango/ColumnTypeGuesser.php b/src/Faker/ORM/Mandango/ColumnTypeGuesser.php
@@ -11,9 +11,6 @@ class ColumnTypeGuesser
      */
     protected $generator;
 
-    /**
-     * @param Generator $generator
-     */
     public function __construct(Generator $generator)
     {
         $this->generator = $generator;

diff --git a/src/Faker/ORM/Mandango/EntityPopulator.php b/src/Faker/ORM/Mandango/EntityPopulator.php
@@ -48,9 +48,6 @@ public function mergeColumnFormattersWith($columnFormatters)
     }
 
     /**
-     * @param \Faker\Generator $generator
-     * @param Mandango         $mandango
-     *
      * @return array
      */
     public function guessColumnFormatters(\Faker\Generator $generator, Mandango $mandango)
@@ -97,8 +94,6 @@ public function guessColumnFormatters(\Faker\Generator $generator, Mandango $man
 
     /**
      * Insert one new record using the Entity class.
-     *
-     * @param Mandango $mandango
      */
     public function execute(Mandango $mandango, $insertedEntities)
     {

diff --git a/src/Faker/ORM/Mandango/Populator.php b/src/Faker/ORM/Mandango/Populator.php
@@ -15,10 +15,6 @@ class Populator
     protected $entities = [];
     protected $quantities = [];
 
-    /**
-     * @param \Faker\Generator $generator
-     * @param Mandango         $mandango
-     */
     public function __construct(\Faker\Generator $generator, Mandango $mandango)
     {
         $this->generator = $generator;

diff --git a/src/Faker/ORM/Propel/ColumnTypeGuesser.php b/src/Faker/ORM/Propel/ColumnTypeGuesser.php
@@ -9,17 +9,12 @@ class ColumnTypeGuesser
 {
     protected $generator;
 
-    /**
-     * @param \Faker\Generator $generator
-     */
     public function __construct(\Faker\Generator $generator)
     {
         $this->generator = $generator;
     }
 
     /**
-     * @param ColumnMap $column
-     *
      * @return \Closure|null
      */
     public function guessFormat(ColumnMap $column)