Refactor

Author: sebastianbergmann

src/Node/File.php

@@ -636,7 +636,7 @@ private function newMethod(string $className, Method $method, string $link): arr
     {
         $methodData = [
             'methodName'         => $method->name(),
-            'visibility'         => $method->visibility(),
+            'visibility'         => $method->visibility()->value,
             'signature'          => $method->signature(),
             'startLine'          => $method->startLine(),
             'endLine'            => $method->endLine(),

src/StaticAnalysis/CodeUnitFindingVisitor.php

@@ -237,20 +237,17 @@ private function type(ComplexType|Identifier|Name $type): string
         return $type->toString();
     }
 
-    /**
-     * @return 'private'|'protected'|'public'
-     */
-    private function visibility(ClassMethod $node): string
+    private function visibility(ClassMethod $node): Visibility
     {
         if ($node->isPrivate()) {
-            return 'private';
+            return Visibility::Private;
         }
 
         if ($node->isProtected()) {
-            return 'protected';
+            return Visibility::Protected;
         }
 
-        return 'public';
+        return Visibility::Public;
     }
 
     private function processInterface(Interface_ $node): void

src/StaticAnalysis/Value/Method.php

@@ -28,11 +28,7 @@
      * @var non-negative-int
      */
     private int $endLine;
-
-    /**
-     * @var 'private'|'protected'|'public'
-     */
-    private string $visibility;
+    private Visibility $visibility;
 
     /**
      * @var non-empty-string
@@ -45,14 +41,13 @@
     private int $cyclomaticComplexity;
 
     /**
-     * @param non-empty-string               $name
-     * @param non-negative-int               $startLine
-     * @param non-negative-int               $endLine
-     * @param non-empty-string               $signature
-     * @param 'private'|'protected'|'public' $visibility
-     * @param positive-int                   $cyclomaticComplexity
+     * @param non-empty-string $name
+     * @param non-negative-int $startLine
+     * @param non-negative-int $endLine
+     * @param non-empty-string $signature
+     * @param positive-int     $cyclomaticComplexity
      */
-    public function __construct(string $name, int $startLine, int $endLine, string $signature, string $visibility, int $cyclomaticComplexity)
+    public function __construct(string $name, int $startLine, int $endLine, string $signature, Visibility $visibility, int $cyclomaticComplexity)
     {
         $this->name                 = $name;
         $this->startLine            = $startLine;
@@ -94,10 +89,7 @@ public function signature(): string
         return $this->signature;
     }
 
-    /**
-     * @return 'private'|'protected'|'public'
-     */
-    public function visibility(): string
+    public function visibility(): Visibility
     {
         return $this->visibility;
     }

src/StaticAnalysis/Value/Visibility.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of phpunit/php-code-coverage.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace SebastianBergmann\CodeCoverage\StaticAnalysis;
+
+/**
+ * @internal This enumeration is not covered by the backward compatibility promise for phpunit/php-code-coverage
+ */
+enum Visibility: string
+{
+    case Public    = 'public';
+    case Protected = 'protected';
+    case Private   = 'private';
+}

tests/tests/StaticAnalysis/CodeUnitFindingVisitorTest.php

@@ -52,7 +52,7 @@ public function testDoesNotFindAnonymousClass(): void
 
         $this->assertSame('method', $method->name());
         $this->assertSame('method(): string', $method->signature());
-        $this->assertSame('public', $method->visibility());
+        $this->assertSame(Visibility::Public, $method->visibility());
         $this->assertSame(6, $method->startLine());
         $this->assertSame(16, $method->endLine());
         $this->assertSame(1, $method->cyclomaticComplexity());
@@ -200,7 +200,7 @@ public function testDetailsAboutExtendedClassesImplementedInterfacesAndUsedTrait
         $this->assertSame('four', $method->name());
         $this->assertSame(21, $method->startLine());
         $this->assertSame(23, $method->endLine());
-        $this->assertSame('public', $method->visibility());
+        $this->assertSame(Visibility::Public, $method->visibility());
         $this->assertSame('four(): void', $method->signature());
         $this->assertSame(1, $method->cyclomaticComplexity());
 
@@ -233,7 +233,7 @@ public function testDetailsAboutExtendedClassesImplementedInterfacesAndUsedTrait
         $this->assertSame('five', $method->name());
         $this->assertSame(28, $method->startLine());
         $this->assertSame(30, $method->endLine());
-        $this->assertSame('public', $method->visibility());
+        $this->assertSame(Visibility::Public, $method->visibility());
         $this->assertSame('five(A $a, B $b): void', $method->signature());
         $this->assertSame(1, $method->cyclomaticComplexity());
 

tests/tests/StaticAnalysis/Value/ClassTest.php

@@ -79,7 +79,7 @@ public function testMayUseTraits(): void
 
     public function testMayHaveMethods(): void
     {
-        $methods = [new Method('', 0, 0, '', '', 0)];
+        $methods = [new Method('', 0, 0, '', Visibility::Public, 0)];
 
         $this->assertSame($methods, $this->class(methods: $methods)->methods());
     }

tests/tests/StaticAnalysis/Value/MethodTest.php

@@ -39,7 +39,7 @@ public function testHasSignature(): void
 
     public function testHasVisibility(): void
     {
-        $this->assertSame('public', $this->method()->visibility());
+        $this->assertSame(Visibility::Public, $this->method()->visibility());
     }
 
     public function testHasCyclomaticComplexity(): void
@@ -54,7 +54,7 @@ private function method(): Method
             1,
             2,
             'the-signature',
-            'public',
+            Visibility::Public,
             3,
         );
     }

tests/tests/StaticAnalysis/Value/TraitTest.php

@@ -44,7 +44,7 @@ public function testHasEndLine(): void
 
     public function testMayHaveMethods(): void
     {
-        $methods = [new Method('', 0, 0, '', '', 0)];
+        $methods = [new Method('', 0, 0, '', Visibility::Public, 0)];
 
         $this->assertSame($methods, $this->trait(methods: $methods)->methods());
     }