Fix PHPStan problems and be explicit

nicmart · Oct 4, 2022 · e38c886 · e38c886
1 parent 65589df
commit e38c886
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 61 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,9 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="4.27.0@faf106e717c37b8c81721845dba9de3d8deed8ff">
   <file src="src/Builder/NodeBuilder.php">
-    <MissingParamType occurrences="1">
-      <code>$value1</code>
-    </MissingParamType>
     <MissingReturnType occurrences="3">
       <code>emptyStack</code>
       <code>popNode</code>
@@ -19,19 +16,6 @@
       <code>$value1</code>
     </ParamNameMismatch>
   </file>
-  <file src="src/Builder/NodeBuilderInterface.php">
-    <InvalidClass occurrences="1">
-      <code>NodebuilderInterface</code>
-    </InvalidClass>
-    <MissingParamType occurrences="1">
-      <code>$value</code>
-    </MissingParamType>
-  </file>
-  <file src="src/Node/Node.php">
-    <PropertyNotSetInConstructor occurrences="1">
-      <code>Node</code>
-    </PropertyNotSetInConstructor>
-  </file>
   <file src="src/Node/NodeInterface.php">
     <MissingReturnType occurrences="2">
       <code>accept</code>
@@ -42,9 +26,6 @@
     <ArgumentTypeCoercion occurrences="1">
       <code>$heights</code>
     </ArgumentTypeCoercion>
-    <DocblockTypeContradiction occurrences="1">
-      <code>null === $this-&gt;getParent()</code>
-    </DocblockTypeContradiction>
     <MissingParamType occurrences="1">
       <code>$value</code>
     </MissingParamType>
@@ -66,15 +47,11 @@
     <MixedReturnTypeCoercion occurrences="1">
       <code>getAncestorsAndSelf</code>
     </MixedReturnTypeCoercion>
-    <MoreSpecificReturnType occurrences="1">
-      <code>getNeighborsAndSelf</code>
-    </MoreSpecificReturnType>
-    <PossiblyNullPropertyAssignmentValue occurrences="1">
-      <code>$parent</code>
-    </PossiblyNullPropertyAssignmentValue>
-    <RedundantConditionGivenDocblockType occurrences="1">
-      <code>null !== $this-&gt;getParent()</code>
-    </RedundantConditionGivenDocblockType>
+    <PossiblyNullReference occurrences="3">
+      <code>getChildren</code>
+      <code>getChildren</code>
+      <code>getDepth</code>
+    </PossiblyNullReference>
     <UndefinedInterfaceMethod occurrences="1">
       <code>getSize</code>
     </UndefinedInterfaceMethod>
@@ -128,11 +105,6 @@
     <PossiblyNullReference occurrences="1">
       <code>leaf</code>
     </PossiblyNullReference>
-    <PropertyNotSetInConstructor occurrences="3">
-      <code>$builder</code>
-      <code>NodeBuilderTest</code>
-      <code>NodeBuilderTest</code>
-    </PropertyNotSetInConstructor>
   </file>
   <file src="tests/Node/NodeTest.php">
     <MissingReturnType occurrences="21">
@@ -192,10 +164,6 @@
       <code>removeChild</code>
       <code>removeChild</code>
     </MixedMethodCall>
-    <PropertyNotSetInConstructor occurrences="2">
-      <code>NodeTest</code>
-      <code>NodeTest</code>
-    </PropertyNotSetInConstructor>
     <UnusedVariable occurrences="4">
       <code>$child2</code>
       <code>$child2</code>
@@ -214,10 +182,6 @@
       <code>testWalkTreeWithOneNode</code>
       <code>testWalkTreeWithTwoNodes</code>
     </MissingReturnType>
-    <PropertyNotSetInConstructor occurrences="2">
-      <code>PostOrderVisitorTest</code>
-      <code>PostOrderVisitorTest</code>
-    </PropertyNotSetInConstructor>
   </file>
   <file src="tests/Visitor/PreOrderVisitorTest.php">
     <ArgumentTypeCoercion occurrences="1">
@@ -230,10 +194,6 @@
       <code>testWalkTreeWithOneNode</code>
       <code>testWalkTreeWithTwoNodes</code>
     </MissingReturnType>
-    <PropertyNotSetInConstructor occurrences="2">
-      <code>PreOrderVisitorTest</code>
-      <code>PreOrderVisitorTest</code>
-    </PropertyNotSetInConstructor>
   </file>
   <file src="tests/Visitor/YieldVisitorTest.php">
     <MissingReturnType occurrences="2">
@@ -244,10 +204,6 @@
       <code>addChild</code>
       <code>addChild</code>
     </MixedMethodCall>
-    <PropertyNotSetInConstructor occurrences="2">
-      <code>YieldVisitorTest</code>
-      <code>YieldVisitorTest</code>
-    </PropertyNotSetInConstructor>
     <UnusedVariable occurrences="1">
       <code>$d</code>
     </UnusedVariable>

diff --git a/src/Builder/NodeBuilderInterface.php b/src/Builder/NodeBuilderInterface.php
@@ -39,7 +39,7 @@ public function getNode();
      *
      * @param mixed $value
      *
-     * @return NodebuilderInterface The current instance
+     * @return NodeBuilderInterface The current instance
      */
     public function value($value);
 
@@ -55,11 +55,11 @@ public function leaf($value = null);
     /**
      * Add several leafs to the node.
      *
-     * @param $value, ... An arbitrary long list of values
+     * @param mixed ...$value An arbitrary long list of values
      *
      * @return NodeBuilderInterface The current instance
      */
-    public function leafs($value);
+    public function leafs($value /*,  $value2, ... */);
 
     /**
      * Add a child to the node enter in its scope.

diff --git a/src/Node/Node.php b/src/Node/Node.php
@@ -23,8 +23,10 @@ public function __construct($value = null, array $children = [])
     {
         $this->setValue($value);
 
-        if (!empty($children)) {
-            $this->setChildren($children);
+        if ([] === $children) {
+            return;
         }
+
+        $this->setChildren($children);
     }
 }
diff --git a/src/Node/NodeInterface.php b/src/Node/NodeInterface.php
@@ -87,7 +87,7 @@ public function setParent(?self $parent = null);
     /**
      * Return the parent node.
      *
-     * @return NodeInterface
+     * @return null|NodeInterface
      */
     public function getParent();
 
@@ -115,7 +115,7 @@ public function getNeighbors();
     /**
      * Returns all neighboring nodes, including the current node.
      *
-     * @return Node[]
+     * @return NodeInterface[]
      */
     public function getNeighborsAndSelf();
 

diff --git a/src/Node/NodeTrait.php b/src/Node/NodeTrait.php
@@ -21,9 +21,7 @@ trait NodeTrait
     private $value;
 
     /**
-     * parent.
-     *
-     * @var NodeInterface
+     * @var null|NodeInterface
      */
     private $parent;
 
@@ -106,7 +104,7 @@ public function getAncestors()
         $parents = [];
         $node = $this;
 
-        while ($parent = $node->getParent()) {
+        while (($parent = $node->getParent()) instanceof NodeInterface) {
             \array_unshift($parents, $parent);
             $node = $parent;
         }
@@ -166,7 +164,7 @@ public function root()
     {
         $node = $this;
 
-        while ($parent = $node->getParent()) {
+        while (($parent = $node->getParent()) instanceof NodeInterface) {
             $node = $parent;
         }