Fix duplicate count constants and globals (#38)

* Don't count undocumented globals as duplicates if only checking documented globals

* Don't count constants in conditions as duplicates

* globals without @var in comment are not documented

Common false positive in WordPress where a global is annotated with @param since it's assigned the result of an apply_filters

* update tests and add test for doc in constant

* remove comments from undocumented globals

Author: kkmuffme

src/NodeVisitor.php

@@ -376,8 +376,14 @@ private function needsNode(Node $node, string $namespace): bool
                     $node->consts,
                     function (\PhpParser\Node\Const_ $const) {
                         $fullyQualifiedName = $const->name->name;
-                        return $this->count('constants', $fullyQualifiedName)
-                            && !defined($fullyQualifiedName);
+
+                        if (
+                            !$this->isInIf ||
+                            !isset($this->counts['constants'][$fullyQualifiedName])
+                        ) {
+                            return $this->count('constants', $fullyQualifiedName)
+                                   && !defined($fullyQualifiedName);
+                        }
                     }
                 );
 
@@ -392,8 +398,13 @@ function (\PhpParser\Node\Const_ $const) {
             ) {
                 $fullyQualifiedName = $node->expr->args[0]->value->value;
 
-                return $this->count('constants', $fullyQualifiedName)
-                    && !defined($fullyQualifiedName);
+                if (
+                    !$this->isInIf ||
+                    !isset($this->counts['constants'][$fullyQualifiedName])
+                ) {
+                    return $this->count('constants', $fullyQualifiedName)
+                           && !defined($fullyQualifiedName);
+                }
             }
         }
 
@@ -404,12 +415,24 @@ function (\PhpParser\Node\Const_ $const) {
             && $node->expr->var instanceof Variable
             && is_string($node->expr->var->name)
         ) {
-            $this->count('globals', $node->expr->var->name);
             // We'll keep regular global variable declarations, depending on
             // whether or not they are documented.
-            if ($node->getDocComment()) {
+            // Only @var comments are actual, useful documentation for stubs
+            $hasValidComment = $node->getDocComment() && preg_match('/@(?:[a-z]+-)?var\s/', $node->getDocComment()->getText());
+
+            if ($this->needsDocumentedGlobals && $hasValidComment) {
+                $this->count('globals', $node->expr->var->name);
                 return $this->needsDocumentedGlobals;
-            } else {
+            }
+
+            if ($this->needsUndocumentedGlobals && !$hasValidComment) {
+                $this->count('globals', $node->expr->var->name);
+
+                // remove useless comments
+                if ($node->getComments() !== []) {
+                    $node->setAttribute('comments', []);
+                }
+
                 return $this->needsUndocumentedGlobals;
             }
         }

test/files/constants.in.php

@@ -7,3 +7,13 @@
 define('FIZ', 'BUZ');
 
 const A = 1, B = 2;
+
+if (!defined('ACME')) {
+    define('ACME', 1);
+}
+
+if (!defined('ACME')) {
+    define('ACME', 2);
+}
+
+\define( 'FOOBAR', /** @var int */ 0 );

test/files/constants.out.php

@@ -7,3 +7,11 @@
 \define('FIZ', 'BUZ');
 
 const A = 1, B = 2;
+
+\define('ACME', 1);
+
+\define(
+    'FOOBAR',
+    /** @var int */
+    0
+);

test/files/globals.all.out.php

@@ -1,10 +1,14 @@
 <?php
-/** doc */
+/** @var string */
 $a = 'a' . 'a';
 
-/** @doc */
+/** @var string $b */
 $b = 'b' . 'b';
 
 $c = 'c' . 'c';
 
 $d = 'd' . 'd';
+
+$x = 'x' . 'x';
+
+$y = 'y' . 'y';

test/files/globals.doc.out.php

@@ -1,6 +1,6 @@
 <?php
-/** doc */
+/** @var string */
 $a = 'a' . 'a';
 
-/** @doc */
+/** @var string $b */
 $b = 'b' . 'b';

test/files/globals.in.php

@@ -1,8 +1,8 @@
 <?php
-/** doc */
+/** @var string */
 $a = 'a' . 'a';
 
-/** @doc */
+/** @var string $b */
 $GLOBALS['b'] = 'b' . 'b';
 
 $c = 'c' . 'c';
@@ -25,3 +25,9 @@
 
 function () {
 };
+
+/** doc */
+$x = 'x' . 'x';
+
+/** @doc */
+$GLOBALS['y'] = 'y' . 'y';

test/files/globals.no-doc.out.php

@@ -2,3 +2,7 @@
 $c = 'c' . 'c';
 
 $d = 'd' . 'd';
+
+$x = 'x' . 'x';
+
+$y = 'y' . 'y';

test/files/globals.nullified.out.php

@@ -1,10 +1,14 @@
 <?php
-/** doc */
+/** @var string */
 $a = \null;
 
-/** @doc */
+/** @var string $b */
 $b = \null;
 
 $c = \null;
 
 $d = \null;
+
+$x = \null;
+
+$y = \null;