Merge pull request #4 from okapi-web/develop

Develop

Author: WalterWoshid

README.md

@@ -63,6 +63,7 @@ composer require okapi/code-transformer
 - [Create a transformer](#create-a-transformer)
 - [Initialize the kernel](#initialize-the-kernel)
 - [Result](#result)
+- [Limitations](#limitations)
 
 
 
@@ -251,6 +252,15 @@ $iAmAppended = true;
 ```
 
 
+# Limitations
+
+- Normally xdebug will point to the original source code, not the transformed
+  one. The problem with this is if you add or remove a line of code, xdebug
+  will point to the wrong line, so try to keep the number of lines the same
+  as the original source code.
+
+
+
 # How it works
 
 - The `Kernel` registers multiple services 

TODO.md

@@ -25,3 +25,8 @@ need optimization (e.g. Profilers or benchmarking suites).
 
 # 7. Testing
 - Add tests for the `order` property of the `Transformer` class
+
+# 8. Production/Development support
+- Add support for production/development environments:
+  - Production: Cache will not be checked for updates (better performance).
+  - Development: Cache will be checked for updates (better debugging experience).

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "okapi/code-transformer",
     "description": "PHP Code Transformer is a PHP library that allows you to modify and transform the source code of a loaded PHP class.",
-    "version": "1.3.0",
+    "version": "1.3.1",
     "type": "library",
     "homepage": "https://github.com/okapi-web/php-code-transformer",
     "license": "MIT",

phpunit.xml

@@ -1,18 +1,18 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
-    colors="true"
->
-  <testsuites>
-    <testsuite name="Tests">
-      <directory>tests/</directory>
-    </testsuite>
-  </testsuites>
-
-  <coverage>
-    <include>
-      <directory suffix=".php">src/</directory>
-    </include>
-  </coverage>
-</phpunit>
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    colors="true"
+>
+  <testsuites>
+    <testsuite name="Tests">
+      <directory>tests/</directory>
+    </testsuite>
+  </testsuites>
+
+  <source>
+    <include>
+      <directory>src/</directory>
+    </include>
+  </source>
+</phpunit>

src/CodeTransformerKernel.php

@@ -32,7 +32,7 @@ abstract class CodeTransformerKernel
     private Options $options;
 
     #[Inject]
-    protected TransformerManager $transformerContainer;
+    protected TransformerManager $transformerManager;
 
     #[Inject]
     private CacheStateManager $cacheStateManager;
@@ -146,7 +146,7 @@ protected function preInit(): void
         );
 
         // Add the transformers
-        $this->transformerContainer->addTransformers($this->transformers);
+        $this->transformerManager->addTransformers($this->transformers);
     }
 
     /**
@@ -160,7 +160,7 @@ protected function registerServices(): void
         $this->options->register();
 
         // Manage the user-defined transformers
-        $this->transformerContainer->register();
+        $this->transformerManager->register();
 
         // Cache path manager
         $this->cacheStateManager->register();

src/Core/AutoloadInterceptor.php

@@ -1,9 +1,11 @@
 <?php
-
+/** @noinspection PhpPropertyOnlyWrittenInspection */
 namespace Okapi\CodeTransformer\Core;
 
 use Composer\Autoload\ClassLoader as ComposerClassLoader;
+use DI\Attribute\Inject;
 use Okapi\CodeTransformer\Core\AutoloadInterceptor\ClassLoader;
+use Okapi\CodeTransformer\Core\Util\ReflectionHelper;
 
 /**
  * # Autoload Interceptor
@@ -19,10 +21,12 @@
  */
 class AutoloadInterceptor implements ServiceInterface
 {
-    /**
-     * The DI key for the original composer class loader.
-     */
-    public const DI = 'okapi.code-transformer.service.composer.class-loader';
+    // region DI
+
+    #[Inject]
+    private ReflectionHelper $reflectionHelper;
+
+    // endregion
 
     /**
      * Register the autoload interceptor.
@@ -59,17 +63,17 @@ private function overloadComposerLoaders(): void
 
             // Get the original composer loader
             $originalClassLoader = $loader[0];
-            DI::set(static::DI, $originalClassLoader);
+            $this->reflectionHelper->setClassLoader($originalClassLoader);
 
-            // Register the AOP class loader
+            // Create the Code Transformer class loader
             $loader[0] = DI::make(ClassLoader::class, [
                 'originalClassLoader' => $originalClassLoader,
             ]);
 
             // Unregister the original composer loader
             spl_autoload_unregister($loaderToUnregister);
 
-            // Register the AOP class loader
+            // Register the Code Transformer class loader
             spl_autoload_register($loader);
         }
     }

src/Core/AutoloadInterceptor/ClassLoader.php

@@ -27,7 +27,7 @@ class ClassLoader extends ComposerClassLoader
     // region DI
 
     #[Inject]
-    private TransformerMatcher $transformerMatcher;
+    protected TransformerMatcher $transformerMatcher;
 
     #[Inject]
     protected CacheStateManager $cacheStateManager;

src/Core/Cache/CacheState/TransformedCacheState.php

@@ -52,6 +52,10 @@ public function isFresh(): bool
                 return false;
                 // @codeCoverageIgnoreEnd
             }
+
+            if (filemtime($transformerFilePath) > $this->modificationTime) {
+                return false;
+            }
         }
 
         return true;

src/Core/Cache/CacheStateManager.php

@@ -92,6 +92,7 @@ private function initializeCacheDirectory(): void
         Filesystem::mkdir(
             $this->options->getCacheDir(),
             $this->options->getCacheFileMode(),
+            recursive: true,
         );
     }
 

src/Core/Util/ReflectionHelper.php

@@ -0,0 +1,52 @@
+<?php
+/** @noinspection PhpInternalEntityUsedInspection */
+namespace Okapi\CodeTransformer\Core\Util;
+
+use Composer\Autoload\ClassLoader;
+use Roave\BetterReflection\BetterReflection;
+use Roave\BetterReflection\Reflection\ReflectionClass;
+use Roave\BetterReflection\Reflector\DefaultReflector;
+use Roave\BetterReflection\SourceLocator\SourceStubber\ReflectionSourceStubber;
+use Roave\BetterReflection\SourceLocator\Type\AggregateSourceLocator;
+use Roave\BetterReflection\SourceLocator\Type\ComposerSourceLocator;
+use Roave\BetterReflection\SourceLocator\Type\PhpInternalSourceLocator;
+
+/**
+ * # Reflection Helper
+ *
+ * This class is used to get reflection class.
+ */
+class ReflectionHelper
+{
+    private ClassLoader $classLoader;
+
+    /**
+     * Set class loader.
+     *
+     * @param ClassLoader $classLoader
+     *
+     * @return void
+     */
+    public function setClassLoader(ClassLoader $classLoader): void
+    {
+        $this->classLoader = $classLoader;
+    }
+
+    /**
+     * Get reflection class.
+     *
+     * @param class-string $namespacedClass
+     *
+     * @return ReflectionClass
+     */
+    public function getReflectionClass(string $namespacedClass): ReflectionClass
+    {
+        $astLocator = (new BetterReflection())->astLocator();
+        $reflector = new DefaultReflector(new AggregateSourceLocator([
+            new ComposerSourceLocator($this->classLoader, $astLocator),
+            new PhpInternalSourceLocator($astLocator, new ReflectionSourceStubber()),
+        ]));
+
+        return $reflector->reflectClass($namespacedClass);
+    }
+}

src/Transformer/Code.php

@@ -1,18 +1,17 @@
 <?php
-
+/** @noinspection PhpPropertyOnlyWrittenInspection */
 namespace Okapi\CodeTransformer\Transformer;
 
+use DI\Attribute\Inject;
+use Microsoft\PhpParser\Node;
 use Microsoft\PhpParser\Node\SourceFileNode;
 use Microsoft\PhpParser\Parser;
 use Microsoft\PhpParser\Token;
-use Okapi\CodeTransformer\Core\AutoloadInterceptor;
 use Okapi\CodeTransformer\Core\DI;
 use Okapi\CodeTransformer\Core\Util\CodeChecker;
+use Okapi\CodeTransformer\Core\Util\ReflectionHelper;
 use Okapi\CodeTransformer\Core\Util\StringMutator;
-use Roave\BetterReflection\BetterReflection;
 use Roave\BetterReflection\Reflection\ReflectionClass as BetterReflectionClass;
-use Roave\BetterReflection\Reflector\DefaultReflector;
-use Roave\BetterReflection\SourceLocator\Type\ComposerSourceLocator;
 
 /**
  * # Code
@@ -22,6 +21,13 @@
  */
 class Code
 {
+    // region DI
+
+    #[Inject]
+    private ReflectionHelper $reflectionHelper;
+
+    // endregion
+
     /**
      * String mutator.
      *
@@ -64,13 +70,16 @@ public function __construct(
     /**
      * Add an edit to the source code.
      *
-     * @param Token  $token       The token to edit.
-     * @param string $replacement The replacement string.
+     * @param Token|Node $token       The token or node to edit.
+     * @param string     $replacement The replacement string.
      *
      * @return void
+     *
+     * @noinspection PhpDocMissingThrowsInspection
      */
-    public function edit(Token $token, string $replacement): void
+    public function edit(Token|Node $token, string $replacement): void
     {
+        /** @noinspection PhpUnhandledExceptionInspection */
         $this->stringMutator->edit(
             $token->getStartPosition(),
             $token->getWidth(),
@@ -146,17 +155,9 @@ public function getSourceFileNode(): SourceFileNode
      */
     public function getReflectionClass(): BetterReflectionClass
     {
-        static $classLoader, $astLocator, $reflector;
-
-        if (!isset($classLoader, $astLocator, $reflector)) {
-            $classLoader = DI::get(AutoloadInterceptor::DI);
-            $astLocator  = (new BetterReflection)->astLocator();
-            $reflector   = (new DefaultReflector(
-                new ComposerSourceLocator($classLoader, $astLocator)
-            ));
-        }
-
-        return $reflector->reflectClass($this->getNamespacedClass());
+        return $this->reflectionHelper->getReflectionClass(
+            $this->getNamespacedClass(),
+        );
     }
 
     /**

tests/Stubs/Kernel/AddedTransformerKernel.php

@@ -14,6 +14,6 @@ protected function preInit(): void
     {
         parent::preInit();
 
-        $this->transformerContainer->addTransformers($this->addedTransformers);
+        $this->transformerManager->addTransformers($this->addedTransformers);
     }
 }