Merge pull request #621 from kukulich/annotations

Annotations cleanup
Roave · May 28, 2020 · aa017e6 · aa017e6
2 parents 45da27f + c6767e0
commit aa017e6
Show file tree

Hide file tree

Showing 25 changed files with 61 additions and 144 deletions.
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -14,8 +14,6 @@
         <exclude name="Generic.Files.LineLength.TooLong"/>
         <exclude name="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming"/>
         <exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming.SuperfluousSuffix"/>
-        <!-- @psalm-return annotations are used -->
-        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification"/>
     </rule>
 
     <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint">
@@ -40,4 +38,8 @@
     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint">
         <exclude-pattern>src/Reflection/Adapter/*</exclude-pattern>
     </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification">
+        <!-- Useless for data providers -->
+        <exclude-pattern>test/unit/</exclude-pattern>
+    </rule>
 </ruleset>
diff --git a/src/NodeCompiler/CompileNodeToValue.php b/src/NodeCompiler/CompileNodeToValue.php
@@ -24,11 +24,9 @@ class CompileNodeToValue
      *
      * @param Node\Stmt\Expression|Node\Expr $node Node has to be processed by the PhpParser\NodeVisitor\NameResolver
      *
-     * @return bool|int|float|string|array|null
+     * @return scalar|array<scalar>|null
      *
      * @throws Exception\UnableToCompileNode
-     *
-     * @psalm-return scalar|array<scalar>|null
      */
     public function __invoke(Node $node, CompilerContext $context)
     {
@@ -62,11 +60,9 @@ public function __invoke(Node $node, CompilerContext $context)
     /**
      * Compile constant expressions
      *
-     * @return bool|int|float|string|array|null
+     * @return scalar|array<scalar>|null
      *
      * @throws Exception\UnableToCompileNode
-     *
-     * @psalm-return scalar|array<scalar>|null
      */
     private function compileConstFetch(Node\Expr\ConstFetch $constNode, CompilerContext $context)
     {
@@ -90,12 +86,10 @@ private function compileConstFetch(Node\Expr\ConstFetch $constNode, CompilerCont
     /**
      * Compile class constants
      *
-     * @return bool|int|float|string|array|null
+     * @return scalar|array<scalar>|null
      *
      * @throws IdentifierNotFound
      * @throws Exception\UnableToCompileNode If a referenced constant could not be located on the expected referenced class.
-     *
-     * @psalm-return scalar|array<scalar>|null
      */
     private function compileClassConstFetch(Node\Expr\ClassConstFetch $node, CompilerContext $context)
     {

diff --git a/src/Reflection/Adapter/ReflectionClass.php b/src/Reflection/Adapter/ReflectionClass.php
@@ -304,7 +304,7 @@ public function getTraits()
     {
         $traits = $this->betterReflectionClass->getTraits();
 
-        /** @psalm-var array<trait-string> $traitNames */
+        /** @var array<trait-string> $traitNames */
         $traitNames = array_map(static function (BetterReflectionClass $trait) : string {
             return $trait->getName();
         }, $traits);

diff --git a/src/Reflection/Adapter/ReflectionClassConstant.php b/src/Reflection/Adapter/ReflectionClassConstant.php
@@ -29,9 +29,7 @@ public function getName() : string
     /**
      * Returns constant value
      *
-     * @return bool|int|float|string|array|null
-     *
-     * @psalm-return scalar|array<scalar>|null
+     * @return scalar|array<scalar>|null
      */
     public function getValue()
     {

diff --git a/src/Reflection/Adapter/ReflectionObject.php b/src/Reflection/Adapter/ReflectionObject.php
@@ -277,7 +277,7 @@ public function getTraits()
     {
         $traits = $this->betterReflectionObject->getTraits();
 
-        /** @psalm-var array<trait-string> $traitNames */
+        /** @var array<trait-string> $traitNames */
         $traitNames = array_map(static function (BetterReflectionClass $trait) : string {
             return $trait->getName();
         }, $traits);

diff --git a/src/Reflection/ReflectionClass.php b/src/Reflection/ReflectionClass.php
@@ -69,28 +69,16 @@ class ReflectionClass implements Reflection
     /** @var ClassLikeNode */
     private $node;
 
-    /**
-     * @var ReflectionClassConstant[]|null indexed by name, when present
-     * @psalm-var ?array<string, ReflectionClassConstant>
-     */
+    /** @var array<string, ReflectionClassConstant>|null indexed by name, when present */
     private $cachedReflectionConstants;
 
-    /**
-     * @var ReflectionProperty[]|null
-     * @psalm-var ?array<string, ReflectionProperty>
-     */
+    /** @var array<string, ReflectionProperty>|null */
     private $cachedImmediateProperties;
 
-    /**
-     * @var ReflectionProperty[]|null
-     * @psalm-var ?array<string, ReflectionProperty>
-     */
+    /** @var array<string, ReflectionProperty>|null */
     private $cachedProperties;
 
-    /**
-     * @var ReflectionMethod[]|null
-     * @psalm-var ?array<lowercase-string, ReflectionMethod>
-     */
+    /** @var array<lowercase-string, ReflectionMethod>|null */
     private $cachedMethods;
 
     /** @var array<string, string>|null */
@@ -194,7 +182,7 @@ public function getShortName() : string
      * Get the "full" name of the class (e.g. for A\B\Foo, this will return
      * "A\B\Foo").
      *
-     * @psalm-return class-string
+     * @return class-string
      */
     public function getName() : string
     {
@@ -339,9 +327,7 @@ private function createMethodsFromTrait(ReflectionMethod $method) : array
      * Methods are not merged via their name as array index, since internal PHP method
      * sorting does not follow `\array_merge()` semantics.
      *
-     * @return ReflectionMethod[] indexed by method name
-     *
-     * @psalm-return array<lowercase-string, ReflectionMethod>
+     * @return array<lowercase-string, ReflectionMethod> indexed by method name
      */
     private function getMethodsIndexedByName() : array
     {
@@ -380,9 +366,7 @@ private function getMethodsIndexedByName() : array
      * For example if $filter = \ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_FINAL
      * the only the final public methods will be returned
      *
-     * @return ReflectionMethod[]
-     *
-     * @psalm-return list<ReflectionMethod>
+     * @return list<ReflectionMethod>
      */
     public function getMethods(?int $filter = null) : array
     {
@@ -472,7 +456,7 @@ public function hasMethod(string $methodName) : bool
      * Get an associative array of only the constants for this specific class (i.e. do not search
      * up parent classes etc.), with keys as constant names and values as constant values.
      *
-     * @psalm-return array<string, scalar|array<scalar>|null>
+     * @return array<string, scalar|array<scalar>|null>
      */
     public function getImmediateConstants() : array
     {
@@ -485,7 +469,7 @@ public function getImmediateConstants() : array
      * Get an associative array of the defined constants in this class,
      * with keys as constant names and values as constant values.
      *
-     * @psalm-return array<string, scalar|array<scalar>|null>
+     * @return array<string, scalar|array<scalar>|null>
      */
     public function getConstants() : array
     {
@@ -499,9 +483,7 @@ public function getConstants() : array
      *
      * Returns null if not specified.
      *
-     * @return bool|int|float|string|array|null
-     *
-     * @psalm-return scalar|array<scalar>|null
+     * @return scalar|array<scalar>|null
      */
     public function getConstant(string $name)
     {
@@ -536,9 +518,7 @@ public function getReflectionConstant(string $name) : ?ReflectionClassConstant
      * Get an associative array of only the constants for this specific class (i.e. do not search
      * up parent classes etc.), with keys as constant names and values as {@see ReflectionClassConstant} objects.
      *
-     * @return ReflectionClassConstant[] indexed by name
-     *
-     * @psalm-return array<string, ReflectionClassConstant>
+     * @return array<string, ReflectionClassConstant> indexed by name
      */
     public function getImmediateReflectionConstants() : array
     {
@@ -582,9 +562,7 @@ static function (ReflectionClassConstant $constant) : string {
      * Get an associative array of the defined constants in this class,
      * with keys as constant names and values as {@see ReflectionClassConstant} objects.
      *
-     * @return ReflectionClassConstant[] indexed by name
-     *
-     * @psalm-return array<string, ReflectionClassConstant>
+     * @return array<string, ReflectionClassConstant> indexed by name
      */
     public function getReflectionConstants() : array
     {
@@ -651,9 +629,7 @@ public function getConstructor() : ReflectionMethod
      *
      * @see ReflectionClass::getProperties() for the usage of filter
      *
-     * @return ReflectionProperty[]
-     *
-     * @psalm-return array<string, ReflectionProperty>
+     * @return array<string, ReflectionProperty>
      */
     public function getImmediateProperties(?int $filter = null) : array
     {
@@ -704,9 +680,7 @@ static function (ReflectionProperty $property) use ($filter) : bool {
      * For example if $filter = \ReflectionProperty::IS_STATIC | \ReflectionProperty::IS_PUBLIC
      * only the static public properties will be returned
      *
-     * @return ReflectionProperty[]
-     *
-     * @psalm-return array<string, ReflectionProperty>
+     * @return array<string, ReflectionProperty>
      */
     public function getProperties(?int $filter = null) : array
     {
@@ -783,7 +757,7 @@ public function hasProperty(string $name) : bool
     }
 
     /**
-     * @psalm-return array<string, scalar|array<scalar>|null>
+     * @return array<string, scalar|array<scalar>|null>
      */
     public function getDefaultProperties() : array
     {
@@ -859,9 +833,7 @@ public function getParentClass() : ?ReflectionClass
     /**
      * Gets the parent class names.
      *
-     * @return string[] A numerical array with parent class names as the values.
-     *
-     * @psalm-return list<class-string>
+     * @return list<class-string> A numerical array with parent class names as the values.
      */
     public function getParentClassNames() : array
     {
@@ -945,9 +917,7 @@ public function isInterface() : bool
      * Get the traits used, if any are defined. If this class does not have any
      * defined traits, this will return an empty array.
      *
-     * @return ReflectionClass[]
-     *
-     * @psalm-return list<ReflectionClass>
+     * @return list<ReflectionClass>
      */
     public function getTraits() : array
     {
@@ -1116,10 +1086,8 @@ private function methodHash(string $className, string $methodName) : string
      *
      * @link https://php.net/manual/en/reflectionclass.getinterfaces.php
      *
-     * @return ReflectionClass[] An associative array of interfaces, with keys as interface names and the array
-     *                           values as {@see ReflectionClass} objects.
-     *
-     * @psalm-return array<string, ReflectionClass>
+     * @return array<string, ReflectionClass> An associative array of interfaces, with keys as interface names and the array
+     *                                        values as {@see ReflectionClass} objects.
      */
     public function getInterfaces() : array
     {
@@ -1135,9 +1103,7 @@ static function (self $reflectionClass) : array {
      * Get only the interfaces that this class implements (i.e. do not search
      * up parent classes etc.)
      *
-     * @return ReflectionClass[]
-     *
-     * @psalm-return array<string, ReflectionClass>
+     * @return array<string, ReflectionClass>
      */
     public function getImmediateInterfaces() : array
     {
@@ -1149,9 +1115,7 @@ public function getImmediateInterfaces() : array
      *
      * @link https://php.net/manual/en/reflectionclass.getinterfacenames.php
      *
-     * @return string[] A numerical array with interface names as the values.
-     *
-     * @psalm-return list<string>
+     * @return list<string> A numerical array with interface names as the values.
      */
     public function getInterfaceNames() : array
     {
@@ -1273,9 +1237,7 @@ public function isIterateable() : bool
     }
 
     /**
-     * @return ReflectionClass[] indexed by interface name
-     *
-     * @psalm-return array<string, ReflectionClass>
+     * @return array<string, ReflectionClass>
      */
     private function getCurrentClassImplementedInterfacesIndexedByName() : array
     {
@@ -1316,11 +1278,9 @@ private function getInheritanceClassHierarchy() : array
     /**
      * This method allows us to retrieve all interfaces parent of the this interface. Do not use on class nodes!
      *
-     * @return ReflectionClass[] parent interfaces of this interface
+     * @return array<string, ReflectionClass> parent interfaces of this interface
      *
      * @throws NotAnInterfaceReflection
-     *
-     * @psalm-return array<string, ReflectionClass>
      */
     private function getInterfacesHierarchy() : array
     {

diff --git a/src/Reflection/ReflectionClassConstant.php b/src/Reflection/ReflectionClassConstant.php
@@ -18,10 +18,7 @@ class ReflectionClassConstant
     /** @var bool */
     private $valueWasCached = false;
 
-    /**
-     * @var bool|int|float|string|array<bool|int|float|string>|null const value
-     * @psalm-var scalar|array<scalar>|null
-     */
+    /** @var scalar|array<scalar>|null const value */
     private $value;
 
     /** @var Reflector */
@@ -74,9 +71,7 @@ public function getName() : string
     /**
      * Returns constant value
      *
-     * @return bool|int|float|string|array|null
-     *
-     * @psalm-return scalar|array<scalar>|null
+     * @return scalar|array<scalar>|null
      */
     public function getValue()
     {

diff --git a/src/Reflection/ReflectionConstant.php b/src/Reflection/ReflectionConstant.php
@@ -41,10 +41,7 @@ class ReflectionConstant implements Reflection
     /** @var int|null */
     private $positionInNode;
 
-    /**
-     * @var bool|int|float|string|array<bool|int|float|string>|null const value
-     * @psalm-var scalar|array<scalar>|null
-     */
+    /** @var scalar|array<scalar>|null const value */
     private $value;
 
     /** @var bool */
@@ -213,9 +210,7 @@ public function isUserDefined() : bool
     /**
      * Returns constant value
      *
-     * @return bool|int|float|string|array|null
-     *
-     * @psalm-return scalar|array<scalar>|null
+     * @return scalar|array<scalar>|null
      */
     public function getValue()
     {

diff --git a/src/Reflection/ReflectionFunctionAbstract.php b/src/Reflection/ReflectionFunctionAbstract.php
@@ -194,9 +194,7 @@ static function (ReflectionParameter $p) : bool {
      * Get an array list of the parameters for this method signature, as an
      * array of ReflectionParameter instances.
      *
-     * @return ReflectionParameter[]
-     *
-     * @psalm-return list<ReflectionParameter>
+     * @return list<ReflectionParameter>
      */
     public function getParameters() : array
     {

diff --git a/src/Reflection/ReflectionObject.php b/src/Reflection/ReflectionObject.php
@@ -80,9 +80,7 @@ public static function createFromInstance($object) : ReflectionClass
      *
      * @see ReflectionClass::getProperties() for the usage of $filter
      *
-     * @return ReflectionProperty[]
-     *
-     * @psalm-return array<string, ReflectionProperty>
+     * @return array<string, ReflectionProperty>
      */
     private function getRuntimeProperties(?int $filter = null) : array
     {