Refactor - Enhance method body generation and improve code readability in StopwatchDecorator

Author: tarlepp

ecs.php

@@ -28,6 +28,7 @@
 use PhpCsFixer\Fixer\Phpdoc\PhpdocSummaryFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocToCommentFixer;
 use PhpCsFixer\Fixer\PhpTag\BlankLineAfterOpeningTagFixer;
+use PhpCsFixer\Fixer\StringNotation\ExplicitStringVariableFixer;
 use PhpCsFixer\Fixer\Whitespace\BlankLineBeforeStatementFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
@@ -43,11 +44,15 @@
     $ruleConfigurations = [
         [
             IncrementStyleFixer::class,
-            ['style' => 'post'],
+            [
+                'style' => 'post',
+            ],
         ],
         [
             CastSpacesFixer::class,
-            ['space' => 'none'],
+            [
+                'space' => 'none',
+            ],
         ],
         [
             YodaStyleFixer::class,
@@ -59,15 +64,21 @@
         ],
         [
             ConcatSpaceFixer::class,
-            ['spacing' => 'one'],
+            [
+                'spacing' => 'one',
+            ],
         ],
         [
             CastSpacesFixer::class,
-            ['space' => 'none'],
+            [
+                'space' => 'none',
+            ],
         ],
         [
             OrderedImportsFixer::class,
-            ['imports_order' => ['class', 'function', 'const']],
+            [
+                'imports_order' => ['class', 'function', 'const'],
+            ],
         ],
         [
             NoSuperfluousPhpdocTagsFixer::class,
@@ -79,15 +90,23 @@
         ],
         [
             DeclareEqualNormalizeFixer::class,
-            ['space' => 'single'],
+            [
+                'space' => 'single',
+            ],
         ],
         [
             BlankLineBeforeStatementFixer::class,
-            ['statements' => ['continue', 'declare', 'return', 'throw', 'try']],
+            [
+                'statements' => ['continue', 'declare', 'return', 'throw', 'try'],
+            ],
         ],
         [
             BinaryOperatorSpacesFixer::class,
-            ['operators' => ['&' => 'align']],
+            [
+                'operators' => [
+                    '&' => 'align',
+                ],
+            ],
         ],
     ];
 
@@ -106,5 +125,6 @@
         PhpdocAlignFixer::class => null,
         PhpdocToCommentFixer::class => null,
         NativeFunctionInvocationFixer::class => null,
+        ExplicitStringVariableFixer::class => null,
     ]);
 };

src/Decorator/StopwatchDecorator.php

@@ -207,8 +207,9 @@ private function generateProxyClass(
         $methods = $this->getProxyableMethods($reflection);
         $methodsCode = $this->generateProxyMethods($methods);
 
-        return "
-class {$proxyClassName} extends {$originalClassName} {
+        return <<<CODE
+
+class $proxyClassName extends $originalClassName {
     private object \$wrappedInstance;
     private array \$prefixInterceptors;
     private array \$suffixInterceptors;
@@ -218,8 +219,9 @@ public function __construct(object \$wrappedInstance, array \$prefixInterceptors
         \$this->prefixInterceptors = \$prefixInterceptors;
         \$this->suffixInterceptors = \$suffixInterceptors;
     }
-{$methodsCode}
-}";
+$methodsCode
+}
+CODE;
     }
 
     /**
@@ -241,15 +243,17 @@ private function generateProxyMethod(ReflectionMethod $method): string
         $methodName = $method->getName();
         [$paramsList, $argsList] = $this->buildMethodParameters($method);
         [$returnType, $isVoid] = $this->getMethodReturnType($method);
+        $methodBody = $this->generateMethodBody($methodName, $argsList, $isVoid);
+
+        return <<<CODE
 
-        $code = "\n    public function {$methodName}({$paramsList}){$returnType} {\n";
-        $code .= "        if (isset(\$this->prefixInterceptors['{$methodName}'])) {\n";
-        $code .= "            (\$this->prefixInterceptors['{$methodName}'])();\n";
-        $code .= "        }\n";
-        $code .= $this->generateMethodBody($methodName, $argsList, $isVoid);
-        $code .= "    }\n";
+    public function $methodName($paramsList)$returnType {
+        if (isset(\$this->prefixInterceptors['$methodName'])) {
+            (\$this->prefixInterceptors['$methodName'])();
+        }
+$methodBody    }
 
-        return $code;
+CODE;
     }
 
     private function generateMethodBody(string $methodName, string $argsList, bool $isVoid): string
@@ -261,26 +265,29 @@ private function generateMethodBody(string $methodName, string $argsList, bool $
 
     private function generateVoidMethodBody(string $methodName, string $argsList): string
     {
-        $code = "        \$this->wrappedInstance->{$methodName}({$argsList});\n";
-        $code .= "        if (isset(\$this->suffixInterceptors['{$methodName}'])) {\n";
-        $code .= "            \$returnValue = null;\n";
-        $code .= "            (\$this->suffixInterceptors['{$methodName}'])";
-        $code .= "(null, null, null, func_get_args(), \$returnValue);\n";
-        $code .= "        }\n";
-
-        return $code;
+        return <<<CODE
+        \$this->wrappedInstance->$methodName($argsList);
+
+        if (isset(\$this->suffixInterceptors['$methodName'])) {
+            \$returnValue = null;
+            (\$this->suffixInterceptors['$methodName'])(null, null, null, func_get_args(), \$returnValue);
+        }
+
+CODE;
     }
 
     private function generateNonVoidMethodBody(string $methodName, string $argsList): string
     {
-        $code = "        \$returnValue = \$this->wrappedInstance->{$methodName}({$argsList});\n";
-        $code .= "        if (isset(\$this->suffixInterceptors['{$methodName}'])) {\n";
-        $code .= "            (\$this->suffixInterceptors['{$methodName}'])";
-        $code .= "(null, null, null, func_get_args(), \$returnValue);\n";
-        $code .= "        }\n";
-        $code .= "        return \$returnValue;\n";
-
-        return $code;
+        return <<<CODE
+        \$returnValue = \$this->wrappedInstance->$methodName($argsList);
+
+        if (isset(\$this->suffixInterceptors['$methodName'])) {
+            (\$this->suffixInterceptors['$methodName'])(null, null, null, func_get_args(), \$returnValue);
+        }
+
+        return \$returnValue;
+
+CODE;
     }
 
     // Method parameter handling