Reusable approach to enhanced proxy generation

DependencyInjection/Compiler/PointcutMatchingPass.php

@@ -40,7 +40,6 @@
 class PointcutMatchingPass implements CompilerPassInterface
 {
     private $pointcuts;
-    private $cacheDir;
     private $container;
 
     public function __construct(array $pointcuts = null)
@@ -51,7 +50,6 @@ public function __construct(array $pointcuts = null)
     public function process(ContainerBuilder $container)
     {
         $this->container = $container;
-        $this->cacheDir = $container->getParameter('jms_aop.cache_dir').'/proxies';
         $pointcuts = $this->getPointcuts();
 
         $interceptors = array();
@@ -150,12 +148,11 @@ private function processDefinition(Definition $definition, $pointcuts, &$interce
         if ($file) {
             $generator->setRequiredFile($file);
         }
-        $enhancer = new Enhancer($class, array(), array(
-            $generator
-        ));
-        $enhancer->writeClass($filename = $this->cacheDir.'/'.str_replace('\\', '-', $class->name).'.php');
-        $definition->setFile($filename);
-        $definition->setClass($enhancer->getClassName($class));
+
+        $matcher = $this->container->get('jms_aop.proxy_matcher');
+        $proxy = $matcher->getEnhanced($definition);
+        $proxy->addGenerator($generator);
+
         $definition->addMethodCall('__CGInterception__setLoader', array(
             new Reference('jms_aop.interceptor_loader')
         ));

DependencyInjection/Compiler/WriteProxiesPass.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * @author nfx
+ */
+
+namespace JMS\AopBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+
+class WriteProxiesPass implements CompilerPassInterface
+{
+    function process(ContainerBuilder $container)
+    {
+        $matcher = $container->get('jms_aop.proxy_matcher');
+        $matcher->writeProxyFiles();
+    }
+}

JMSAopBundle.php

@@ -20,6 +20,7 @@
 
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use JMS\AopBundle\DependencyInjection\Compiler\PointcutMatchingPass;
+use JMS\AopBundle\DependencyInjection\Compiler\WriteProxiesPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -30,5 +31,6 @@ class JMSAopBundle extends Bundle
     public function build(ContainerBuilder $container)
     {
         $container->addCompilerPass(new PointcutMatchingPass(), PassConfig::TYPE_AFTER_REMOVING);
+        $container->addCompilerPass(new WriteProxiesPass(), PassConfig::TYPE_AFTER_REMOVING);
     }
 }

Proxy/ProxyMatcher.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * @author nfx
+ */
+
+namespace JMS\AopBundle\Proxy;
+
+use Symfony\Component\DependencyInjection\Definition;
+use CG\Proxy\GeneratorInterface;
+
+class ProxyMatcher
+{
+    protected $cacheDir;
+
+    /**
+     * @var \SplObjectStorage
+     */
+    protected $storage;
+
+    public function __construct($cacheDir)
+    {
+        $this->cacheDir = $cacheDir;
+        $this->storage = new \SplObjectStorage();
+    }
+
+    /**
+     * @param Definition $definition
+     * @return ProxyPromise
+     */
+    public function getEnhanced(Definition $definition)
+    {
+        if (isset($this->storage[$definition])) {
+            return $this->storage[$definition];
+        }
+
+        $promise = new ProxyPromise($this);
+        $this->storage[$definition] = $promise;
+        return $promise;
+    }
+
+    public function writeProxyFiles()
+    {
+        foreach($this->storage as $definition) {
+            $promise = $this->storage[$definition];
+
+            $class = new \ReflectionClass($definition->getClass());
+            $enhancer = $promise->getEnhancer($class);
+
+            $filename = $this->cacheDir.'/'.str_replace('\\', '-', $class->name).'.php';
+            $proxyClassName = $enhancer->getClassName($class);
+
+            $enhancer->writeClass($filename);
+            $definition->setFile($filename);
+            $definition->setClass($proxyClassName);
+        }
+    }
+}

Proxy/ProxyPromise.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * @author nfx
+ */
+
+namespace JMS\AopBundle\Proxy;
+use CG\Proxy\GeneratorInterface;
+use CG\Proxy\Enhancer;
+use ReflectionClass;
+
+class ProxyPromise
+{
+    /**
+     * @var GeneratorInterface[]
+     */
+    private $generators = array();
+
+    public function addGenerator(GeneratorInterface $generator)
+    {
+        $this->generators[] = $generator;
+    }
+
+    public function getEnhancer(ReflectionClass $class)
+    {
+        return new Enhancer($class, array(), $this->generators);
+    }
+}

Resources/config/services.xml

@@ -6,6 +6,7 @@
 
     <parameters>
         <parameter key="jms_aop.interceptor_loader.class">JMS\AopBundle\Aop\InterceptorLoader</parameter>
+        <parameter key="jms_aop.proxy_matcher.class">JMS\AopBundle\Proxy\ProxyMatcher</parameter>
     </parameters>
 
     <services>
@@ -14,5 +15,9 @@
         <service id="jms_aop.interceptor_loader" class="%jms_aop.interceptor_loader.class%">
             <argument type="service" id="service_container" />
         </service>
+
+        <service id="jms_aop.proxy_matcher" class="%jms_aop.proxy_matcher.class%">
+            <argument>%jms_aop.cache_dir%/proxies</argument>
+        </service>
     </services>
 </container>

Tests/DependencyInjection/Compiler/PointcutMatchingPassTest.php

@@ -22,7 +22,8 @@
 use Symfony\Component\DependencyInjection\Compiler\ResolveParameterPlaceHoldersPass;
 use JMS\AopBundle\DependencyInjection\JMSAopExtension;
 use JMS\AopBundle\DependencyInjection\Compiler\PointcutMatchingPass;
-use Symfony\Component\HttpKernel\Util\Filesystem;
+use JMS\AopBundle\DependencyInjection\Compiler\WriteProxiesPass;
+use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 class PointcutMatchingPassTest extends \PHPUnit_Framework_TestCase
@@ -92,5 +93,8 @@ private function process(ContainerBuilder $container)
 
         $pass = new PointcutMatchingPass();
         $pass->process($container);
+
+        $pass = new WriteProxiesPass();
+        $pass->process($container);
     }
 }

Tests/Proxy/Fixture/AnotherPass.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * @author nfx
+ */
+
+namespace JMS\AopBundle\Tests\Proxy\Fixture;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use JMS\AopBundle\Tests\Proxy\Fixture\SomeGenerator;
+
+class AnotherPass implements CompilerPassInterface
+{
+    function process(ContainerBuilder $container)
+    {
+        $methodName = '__ultimatelyAnotherMethod';
+        $matcher = $container->get('jms_aop.proxy_matcher');
+        $generator = new SomeGenerator($methodName);
+
+        $definition = $container->getDefinition('test');
+
+        $proxy = $matcher->getEnhanced($definition);
+        $proxy->addGenerator($generator);
+        $definition->addMethodCall($methodName);
+    }
+}

Tests/Proxy/Fixture/FirstPass.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * @author nfx
+ */
+
+namespace JMS\AopBundle\Tests\Proxy\Fixture;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use JMS\AopBundle\Tests\Proxy\Fixture\SomeGenerator;
+
+class FirstPass implements CompilerPassInterface
+{
+    function process(ContainerBuilder $container)
+    {
+        $methodName = '__fistPassMethod';
+        $matcher = $container->get('jms_aop.proxy_matcher');
+        $generator = new SomeGenerator($methodName);
+
+        $definition = $container->getDefinition('test');
+
+        $proxy = $matcher->getEnhanced($definition);
+        $proxy->addGenerator($generator);
+        $definition->addMethodCall($methodName);
+    }
+}

Tests/Proxy/Fixture/SomeGenerator.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * @author nfx
+ */
+
+namespace JMS\AopBundle\Tests\Proxy\Fixture;
+
+use CG\Proxy\GeneratorInterface;
+use CG\Generator\PhpClass;
+use CG\Generator\PhpMethod;
+
+class SomeGenerator implements GeneratorInterface
+{
+    public $methodName;
+
+    public function __construct($methodName)
+    {
+        $this->methodName = $methodName;
+    }
+
+    /**
+     * Generates the necessary changes in the class.
+     *
+     * @param \ReflectionClass $originalClass
+     * @param PhpClass $generatedClass The generated class
+     * @return void
+     */
+    function generate(\ReflectionClass $originalClass, PhpClass $generatedClass)
+    {
+        $method = PhpMethod::create($this->methodName)
+            ->setBody("\$this->things[] = '{$this->methodName}';");
+        $generatedClass->setMethod($method);
+    }
+}

Tests/Proxy/Fixture/TestService.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * @author nfx
+ */
+
+namespace JMS\AopBundle\Tests\Proxy\Fixture;
+
+class TestService
+{
+    protected $things = array();
+
+    public function getThings()
+    {
+        return $this->things;
+    }
+}

Tests/Proxy/ProxyMatcherTest.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * @author nfx
+ */
+
+namespace JMS\AopBundle\Tests\Proxy;
+
+use JMS\AopBundle\Exception\RuntimeException;
+use Symfony\Component\DependencyInjection\Compiler\ResolveParameterPlaceHoldersPass;
+use JMS\AopBundle\DependencyInjection\JMSAopExtension;
+use JMS\AopBundle\DependencyInjection\Compiler\WriteProxiesPass;
+use JMS\AopBundle\Tests\Proxy\Fixture\FirstPass;
+use JMS\AopBundle\Tests\Proxy\Fixture\AnotherPass;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class ProxyMatcherTest extends \PHPUnit_Framework_TestCase
+{
+    private $cacheDir;
+    private $fs;
+
+    public function testProcess()
+    {
+        $container = $this->getContainer();
+        $container->register('test', 'JMS\AopBundle\Tests\Proxy\Fixture\TestService');
+
+        $this->process($container);
+
+        $service = $container->get('test');
+        $this->assertInstanceOf('JMS\AopBundle\Tests\Proxy\Fixture\TestService', $service);
+
+        $this->assertEquals(array('__fistPassMethod', '__ultimatelyAnotherMethod'), $service->getThings());
+    }
+
+    protected function setUp()
+    {
+        $this->cacheDir = sys_get_temp_dir() . '/jms_aop_test';
+        $this->fs = new Filesystem();
+
+        if (is_dir($this->cacheDir)) {
+            $this->fs->remove($this->cacheDir);
+        }
+
+        if (false === @mkdir($this->cacheDir, 0777, true)) {
+            throw new RuntimeException(sprintf('Could not create cache dir "%s".', $this->cacheDir));
+        }
+    }
+
+    protected function tearDown()
+    {
+        $this->fs->remove($this->cacheDir);
+    }
+
+    private function getContainer()
+    {
+        $container = new ContainerBuilder();
+
+        $extension = new JMSAopExtension();
+        $extension->load(array(array('cache_dir' => $this->cacheDir)), $container);
+
+        return $container;
+    }
+
+    private function process(ContainerBuilder $container)
+    {
+        $pass = new ResolveParameterPlaceHoldersPass();
+        $pass->process($container);
+
+        $pass = new FirstPass();
+        $pass->process($container);
+
+        $pass = new AnotherPass();
+        $pass->process($container);
+
+        $pass = new WriteProxiesPass();
+        $pass->process($container);
+    }
+}

Tests/bootstrap.php

@@ -0,0 +1,15 @@
+<?php
+
+// this file searches for the autoload file of your project, and includes it
+$dir = __DIR__;
+$lastDir = null;
+while (($dir = dirname($dir)) && $dir !== $lastDir) {
+	$lastDir = $dir;
+
+	if (file_exists($file = $dir.'/app/autoload.php')) {
+		require_once $file;
+		return;
+	}
+}
+
+throw new RuntimeException('Could not locate the project\'s bootstrap.php.cache. If your bundle is not inside a project, you need to replace this bootstrap file.');