Detect getters and setters with types

Fixes phpmetrics#335
UFOMelkor · Dec 15, 2017 · 4d3cc3d · 4d3cc3d
1 parent 08eb64b
commit 4d3cc3d
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 21 deletions.
diff --git a/src/Hal/Metric/Helper/RoleOfMethodDetector.php b/src/Hal/Metric/Helper/RoleOfMethodDetector.php
@@ -1,7 +1,6 @@
 <?php
 namespace Hal\Metric\Helper;
 
-
 use PhpParser\Node\Expr\Cast;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Stmt\ClassMethod;
@@ -13,24 +12,43 @@
  */
 class RoleOfMethodDetector
 {
-
     /**
      * @var array
      */
     private $fingerprints = [
         'getter' => [
-            'PhpParser\\Node\\Stmt\\ClassMethod',
-            'PhpParser\\Node\\Stmt\\Return_',
-            'PhpParser\\Node\\Expr\\PropertyFetch',
-            'PhpParser\\Node\\Expr\\Variable',
+            [
+                'PhpParser\\Node\\Stmt\\ClassMethod',
+                'PhpParser\\Node\\Stmt\\Return_',
+                'PhpParser\\Node\\Expr\\PropertyFetch',
+                'PhpParser\\Node\\Expr\\Variable',
+            ],
+            [
+                'PhpParser\\Node\\Stmt\\ClassMethod',
+                'PhpParser\\Node\\Stmt\\Return_',
+                'PhpParser\\Node\\Expr\\PropertyFetch',
+                'PhpParser\\Node\\Expr\\Variable',
+                'PhpParser\\Node\\Name',
+            ],
         ],
         'setter' => [
-            'PhpParser\\Node\\Stmt\\ClassMethod',
-            'PhpParser\\Node\\Expr\\Assign',
-            'PhpParser\\Node\\Expr\\Variable',
-            'PhpParser\\Node\\Expr\\PropertyFetch',
-            'PhpParser\\Node\\Expr\\Variable',
-            'PhpParser\\Node\\Param',
+            [
+                'PhpParser\\Node\\Stmt\\ClassMethod',
+                'PhpParser\\Node\\Expr\\Assign',
+                'PhpParser\\Node\\Expr\\Variable',
+                'PhpParser\\Node\\Expr\\PropertyFetch',
+                'PhpParser\\Node\\Expr\\Variable',
+                'PhpParser\\Node\\Param',
+            ],
+            [
+                'PhpParser\\Node\\Stmt\\ClassMethod',
+                'PhpParser\\Node\\Expr\\Assign',
+                'PhpParser\\Node\\Expr\\Variable',
+                'PhpParser\\Node\\Expr\\PropertyFetch',
+                'PhpParser\\Node\\Expr\\Variable',
+                'PhpParser\\Node\\Param',
+                'PhpParser\\Node\\Name',
+            ]
         ]
     ];
 
@@ -40,8 +58,7 @@ class RoleOfMethodDetector
      */
     public function detects($node)
     {
-
-        if (!$node instanceof ClassMethod) {
+        if (! $node instanceof ClassMethod) {
             return null;
         }
 
@@ -65,13 +82,12 @@ public function detects($node)
         $fingerprintOfMethod = array_reverse($fingerprintOfMethod);
 
         // compare with database of fingerprints
-        foreach ($this->fingerprints as $type => $fingerprint) {
-            if ($fingerprint == $fingerprintOfMethod) {
+        foreach ($this->fingerprints as $type => $fingerprints) {
+            if (in_array($fingerprintOfMethod, $fingerprints, true)) {
                 return $type;
             }
         }
 
         return null;
     }
-
-}
+}
diff --git a/tests/Metric/Helper/RoleOfMethodDetectorTest.php b/tests/Metric/Helper/RoleOfMethodDetectorTest.php
@@ -13,7 +13,6 @@
  */
 class RoleOfMethodDetectorTest extends \PHPUnit_Framework_TestCase
 {
-
     /**
      * @dataProvider provideExamples
      */
@@ -38,15 +37,21 @@ public function testICanDetectRoleOfMethod($expected, $code)
 
     public function provideExamples()
     {
-        return [
+        $examples = [
             ['getter', '<?php class A { function getName(){ return $this->name; } }  ?>'],
             ['getter', '<?php class A { function getName(){ return (string) $this->name; } }  ?>'],
             ['getter', '<?php class A { function getName(){ return (int) $this->name; } }  ?>'],
             ['setter', '<?php class A { function setName($string){ $this->name = $name; } } ?>'],
             ['setter', '<?php class A { function setName($string){ $this->name = (string) $name; } } ?>'],
             ['setter', '<?php class A { function setName($string){ $this->name = (string) $name; return $this; } } ?>'],
             [null, '<?php class A { function foo($string){ $this->name = (string) $name * 3; } } ?>'],
-
         ];
+        if (version_compare(PHP_VERSION, '7.0.0') >= 0) {
+            $examples[] = ['getter', '<?php class A { function getName(): string { return $this->name; } }'];
+            $examples[] = ['setter', '<?php class A { function setName(string $name): void { $this->name = $name; } }'];
+            $examples[] = ['getter', '<?php class A { function getName(): Name { return $this->name; } }'];
+            $examples[] = ['setter', '<?php class A { function setName(Name $name): void { $this->name = $name; } }'];
+        }
+        return $examples;
     }
 }