Add missing param doc blocks to avoid code sniffer errors - close #30

sandrokeil · sandrokeil · commit a17f60a5b40b · 2021-08-05T13:20:41.000+02:00
diff --git a/composer.json b/composer.json
@@ -34,7 +34,7 @@
     "require": {
         "php": "^7.4 || ^8.0",
         "open-code-modeling/json-schema-to-php": "^0.3.0 || 0.4.x-dev",
-        "open-code-modeling/php-code-ast": "^0.12.0 || 0.13.x-dev"
+        "open-code-modeling/php-code-ast": "^0.13.0 || 0.13.x-dev"
     },
     "require-dev": {
         "laminas/laminas-filter": "^2.9",
diff --git a/composer.lock b/composer.lock
diff --git a/src/ValueObject/Bcp47Factory.php b/src/ValueObject/Bcp47Factory.php
@@ -170,11 +170,12 @@ public function methodEquals(string $propertyName, string $argumentName = 'other
         $method = new MethodGenerator(
             'equals',
             [
-                new ParameterGenerator($argumentName),
+                (new ParameterGenerator($argumentName))->setTypeDocBlockHint('mixed'),
             ],
             MethodGenerator::FLAG_PUBLIC,
             new BodyGenerator($this->parser, $body)
         );
+        $method->setDocBlockComment('');
         $method->setTyped($this->typed);
         $method->setReturnType('bool');
 
diff --git a/src/ValueObject/BooleanFactory.php b/src/ValueObject/BooleanFactory.php
@@ -188,11 +188,12 @@ public function methodEquals(string $propertyName, string $argumentName = 'other
         $method = new MethodGenerator(
             'equals',
             [
-                new ParameterGenerator($argumentName),
+                (new ParameterGenerator($argumentName))->setTypeDocBlockHint('mixed'),
             ],
             MethodGenerator::FLAG_PUBLIC,
             new BodyGenerator($this->parser, $body)
         );
+        $method->setDocBlockComment('');
         $method->setTyped($this->typed);
         $method->setReturnType('bool');
 
diff --git a/src/ValueObject/EnumFactory.php b/src/ValueObject/EnumFactory.php
@@ -360,7 +360,7 @@ public function methodEquals(string $propertyName, string $argumentName = 'other
     return \$this->$propertyName === \$$argumentName->$propertyName;
 PHP;
 
-        $parameter = new ParameterGenerator($argumentName);
+        $parameter = (new ParameterGenerator($argumentName))->setTypeDocBlockHint('mixed');
 
         $method = new MethodGenerator(
             'equals',
@@ -370,6 +370,7 @@ public function methodEquals(string $propertyName, string $argumentName = 'other
             MethodGenerator::FLAG_PUBLIC,
             new BodyGenerator($this->parser, $body)
         );
+        $method->setDocBlockComment('');
         $method->setTyped($this->typed);
         $method->setReturnType('bool');
 
@@ -420,7 +421,7 @@ public function methodIsOneOf(string $argumentName, ?string $className): MethodG
     }
     return false;
 PHP;
-        $parameter = (new ParameterGenerator($argumentName))->setVariadic(true);
+        $parameter = (new ParameterGenerator($argumentName))->setVariadic(true)->setTypeDocBlockHint('mixed');
 
         if ($className !== null) {
             $parameter->setType($className);
@@ -434,6 +435,7 @@ public function methodIsOneOf(string $argumentName, ?string $className): MethodG
             MethodGenerator::FLAG_PUBLIC,
             new BodyGenerator($this->parser, $body)
         );
+        $method->setDocBlockComment('');
         $method->setTyped($this->typed);
         $method->setReturnType('bool');
 
diff --git a/src/ValueObject/IntegerFactory.php b/src/ValueObject/IntegerFactory.php
@@ -188,11 +188,12 @@ public function methodEquals(string $propertyName, string $argumentName = 'other
         $method = new MethodGenerator(
             'equals',
             [
-                new ParameterGenerator($argumentName),
+                (new ParameterGenerator($argumentName))->setTypeDocBlockHint('mixed'),
             ],
             MethodGenerator::FLAG_PUBLIC,
             new BodyGenerator($this->parser, $body)
         );
+        $method->setDocBlockComment('');
         $method->setTyped($this->typed);
         $method->setReturnType('bool');
 
diff --git a/src/ValueObject/NumberFactory.php b/src/ValueObject/NumberFactory.php
@@ -188,11 +188,12 @@ public function methodEquals(string $propertyName, string $argumentName = 'other
         $method = new MethodGenerator(
             'equals',
             [
-                new ParameterGenerator($argumentName),
+                (new ParameterGenerator($argumentName))->setTypeDocBlockHint('mixed'),
             ],
             MethodGenerator::FLAG_PUBLIC,
             new BodyGenerator($this->parser, $body)
         );
+        $method->setDocBlockComment('');
         $method->setTyped($this->typed);
         $method->setReturnType('bool');
 
diff --git a/src/ValueObject/StringFactory.php b/src/ValueObject/StringFactory.php
@@ -188,11 +188,12 @@ public function methodEquals(string $propertyName, string $argumentName = 'other
         $method = new MethodGenerator(
             'equals',
             [
-                new ParameterGenerator($argumentName),
+                (new ParameterGenerator($argumentName))->setTypeDocBlockHint('mixed'),
             ],
             MethodGenerator::FLAG_PUBLIC,
             new BodyGenerator($this->parser, $body)
         );
+        $method->setDocBlockComment('');
         $method->setTyped($this->typed);
         $method->setReturnType('bool');
 
diff --git a/src/ValueObject/UuidFactory.php b/src/ValueObject/UuidFactory.php
@@ -192,11 +192,12 @@ public function methodEquals(string $propertyName, string $argumentName = 'other
         $method = new MethodGenerator(
             'equals',
             [
-                new ParameterGenerator($argumentName),
+                (new ParameterGenerator($argumentName))->setTypeDocBlockHint('mixed'),
             ],
             MethodGenerator::FLAG_PUBLIC,
             new BodyGenerator($this->parser, $body)
         );
+        $method->setDocBlockComment('');
         $method->setTyped($this->typed);
         $method->setReturnType('bool');
 
diff --git a/src/ValueObjectFactory.php b/src/ValueObjectFactory.php
@@ -12,8 +12,8 @@
 
 use OpenCodeModeling\CodeAst\Builder\ClassBuilder;
 use OpenCodeModeling\CodeAst\Builder\ClassPropertyBuilder;
-use OpenCodeModeling\CodeAst\Builder\File;
 use OpenCodeModeling\CodeAst\Builder\FileCollection;
+use OpenCodeModeling\CodeAst\Builder\PhpFile;
 use OpenCodeModeling\CodeAst\Code\ClassConstGenerator;
 use OpenCodeModeling\CodeAst\FileCodeGenerator;
 use OpenCodeModeling\CodeAst\Package\ClassInfo;
@@ -141,7 +141,7 @@ public function __construct(
             || $classBuilder->hasMethod('toBool');
         };
 
-        $this->currentFileAst = static function (File $classBuilder, ClassInfo $classInfo) use ($parser): array {
+        $this->currentFileAst = static function (PhpFile $classBuilder, ClassInfo $classInfo) use ($parser): array {
             $path = $classInfo->getPath($classBuilder->getNamespace() . '\\' . $classBuilder->getName());
             $filename = $classInfo->getFilenameFromPathAndName($path, $classBuilder->getName());
 
diff --git a/tests/ValueObject/ArrayFactoryTest.php b/tests/ValueObject/ArrayFactoryTest.php
@@ -228,7 +228,6 @@ public function toArray() : array
     }
     /**
      * @param mixed $other
-     * @return bool
      */
     public function equals($other) : bool
     {
diff --git a/tests/ValueObject/Bcp47FactoryTest.php b/tests/ValueObject/Bcp47FactoryTest.php
@@ -96,6 +96,9 @@ public function toString() : string
     {
         return $this->bcp47;
     }
+    /**
+     * @param mixed $other
+     */
     public function equals($other) : bool
     {
         if (!$other instanceof self) {
diff --git a/tests/ValueObject/BooleanFactoryTest.php b/tests/ValueObject/BooleanFactoryTest.php
@@ -87,6 +87,9 @@ public function toBool() : bool
     {
         return $this->boolean;
     }
+    /**
+     * @param mixed $other
+     */
     public function equals($other) : bool
     {
         if (!$other instanceof self) {
diff --git a/tests/ValueObject/EnumFactoryTest.php b/tests/ValueObject/EnumFactoryTest.php
@@ -128,13 +128,19 @@ public function toString() : string
     {
         return $this->status;
     }
+    /**
+     * @param mixed $other
+     */
     public function equals($other) : bool
     {
         if (!$other instanceof self) {
             return false;
         }
         return $this->status === $other->status;
     }
+    /**
+     * @param mixed ...$status
+     */
     public function isOneOf(...$status) : bool
     {
         foreach ($status as $otherStatus) {
diff --git a/tests/ValueObject/IntegerFactoryTest.php b/tests/ValueObject/IntegerFactoryTest.php
@@ -87,6 +87,9 @@ public function toInt() : int
     {
         return $this->number;
     }
+    /**
+     * @param mixed $other
+     */
     public function equals($other) : bool
     {
         if (!$other instanceof self) {
diff --git a/tests/ValueObject/NumberFactoryTest.php b/tests/ValueObject/NumberFactoryTest.php
@@ -87,6 +87,9 @@ public function toFloat() : float
     {
         return $this->number;
     }
+    /**
+     * @param mixed $other
+     */
     public function equals($other) : bool
     {
         if (!$other instanceof self) {
diff --git a/tests/ValueObject/StringFactoryTest.php b/tests/ValueObject/StringFactoryTest.php
@@ -87,6 +87,9 @@ public function toString() : string
     {
         return $this->name;
     }
+    /**
+     * @param mixed $other
+     */
     public function equals($other) : bool
     {
         if (!$other instanceof self) {
diff --git a/tests/ValueObject/UuidFactoryTest.php b/tests/ValueObject/UuidFactoryTest.php
@@ -103,6 +103,9 @@ public function toString() : string
     {
         return $this->uuid->toString();
     }
+    /**
+     * @param mixed $other
+     */
     public function equals($other) : bool
     {
         if (!$other instanceof self) {
diff --git a/tests/ValueObjectFactoryTest.php b/tests/ValueObjectFactoryTest.php
@@ -529,7 +529,6 @@ public function toArray() : array
     }
     /**
      * @param mixed $other
-     * @return bool
      */
     public function equals($other) : bool
     {
@@ -621,6 +620,9 @@ public function toString() : string
     {
         return $this->city;
     }
+    /**
+     * @param mixed $other
+     */
     public function equals($other) : bool
     {
         if (!$other instanceof self) {
@@ -660,6 +662,9 @@ public function toString() : string
     {
         return $this->streetAddress;
     }
+    /**
+     * @param mixed $other
+     */
     public function equals($other) : bool
     {
         if (!$other instanceof self) {
@@ -713,13 +718,19 @@ public function toString() : string
     {
         return $this->state;
     }
+    /**
+     * @param mixed $other
+     */
     public function equals($other) : bool
     {
         if (!$other instanceof self) {
             return false;
         }
         return $this->state === $other->state;
     }
+    /**
+     * @param mixed ...$state
+     */
     public function isOneOf(...$state) : bool
     {
         foreach ($state as $otherState) {
