[AstGenerator] Init the Component

symfony · GuilhemN · Jan 22, 2016 · Aug 6, 2016 · Aug 6, 2016 · Aug 6, 2016
commit c2d733af643079625d0a96cfdb89a9919c117139
diff --git a/composer.json b/composer.json
@@ -88,7 +88,8 @@
         "egulias/email-validator": "~1.2,>=1.2.8|~2.0",
         "symfony/polyfill-apcu": "~1.1",
         "symfony/security-acl": "~2.8|~3.0",
-        "phpdocumentor/reflection-docblock": "^3.0"
+        "phpdocumentor/reflection-docblock": "^3.0",
+        "nikic/PHP-Parser": "~2.0"
     },
     "conflict": {
         "phpdocumentor/reflection-docblock": "<3.0",

diff --git a/src/Symfony/Component/AstGenerator/.gitignore b/src/Symfony/Component/AstGenerator/.gitignore
@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+phpunit.xml
diff --git a/src/Symfony/Component/AstGenerator/AstGeneratorChain.php b/src/Symfony/Component/AstGenerator/AstGeneratorChain.php
@@ -0,0 +1,66 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\AstGenerator;
+
+/**
+ * Generator delegating the generation to a chain of generators.
+ *
+ * @author Joel Wurtz <joel.wurtz@gmail.com>
+ */
+class AstGeneratorChain implements AstGeneratorInterface
+{
+    /** @var AstGeneratorInterface[] A list of generators */
+    protected $generators;
+
+    /** @var bool Whether the generation must return as soon as possible or use all generators, default to false */
+    protected $returnOnFirst;
+
+    public function __construct(array $generators = array(), $returnOnFirst = false)
+    {
+        $this->generators = $generators;
+        $this->returnOnFirst = $returnOnFirst;
+    }
+    
+    /**
+     * {@inheritdoc}
+     */
+    public function generate($object, array $context = array())
+    {
+        $nodes = array();
+
+        foreach ($this->generators as $generator) {
+            if ($generator instanceof AstGeneratorInterface && $generator->supportsGeneration($object)) {
+                $nodes = array_merge($nodes, $generator->generate($object, $context));
+
+                if ($this->returnOnFirst) {
+                    return $nodes;
+                }
+            }
+        }
+
+        return $nodes;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supportsGeneration($object)
+    {
+        foreach ($this->generators as $generator) {
+            if ($generator instanceof AstGeneratorInterface && $generator->supportsGeneration($object)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}
diff --git a/src/Symfony/Component/AstGenerator/AstGeneratorInterface.php b/src/Symfony/Component/AstGenerator/AstGeneratorInterface.php
@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\AstGenerator;
+
+/**
+ * An AstGeneratorInterface is a contract to transform an object into an AST.
+ *
+ * @author Joel Wurtz <joel.wurtz@gmail.com>
+ */
+interface AstGeneratorInterface
+{
+    /**
+     * Generate an object into an AST given a specific context.
+     *
+     * @param mixed $object  Object to generate AST from
+     * @param array $context Context for the generator
+     *
+     * @return \PhpParser\Node[] An array of statements (AST Node)
+     */
+    public function generate($object, array $context = array());
+
+    /**
+     * Check whether the given object is supported for generation by this generator.
+     *
+     * @param mixed $object Object to generate AST from
+     *
+     * @return bool
+     */
+    public function supportsGeneration($object);
+}
diff --git a/src/Symfony/Component/AstGenerator/Exception/MissingContextException.php b/src/Symfony/Component/AstGenerator/Exception/MissingContextException.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Symfony\Component\AstGenerator\Exception;
+
+class MissingContextException extends \RuntimeException
+{
+}
diff --git a/src/Symfony/Component/AstGenerator/LICENSE b/src/Symfony/Component/AstGenerator/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2016 Fabien Potencier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/src/Symfony/Component/AstGenerator/README.md b/src/Symfony/Component/AstGenerator/README.md
@@ -0,0 +1,8 @@
+AstGenerator Component
+======================
+
+AstGenerator allows to generate PHP AST for several Component:
+
+ * Transform class, properties and types extracted from the PropertyInfo Component into POPO objects ans Normalizers
+ compatible with Serializer Component
+
diff --git a/src/Symfony/Component/AstGenerator/Tests/AstGeneratorChainTest.php b/src/Symfony/Component/AstGenerator/Tests/AstGeneratorChainTest.php
@@ -0,0 +1,88 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\AstGenerator\Tests;
+
+use Symfony\Component\AstGenerator\AstGeneratorChain;
+use Symfony\Component\AstGenerator\AstGeneratorInterface;
+
+class AstGeneratorChainTest extends \PHPUnit_Framework_TestCase
+{
+    public function testEmpty()
+    {
+        $generator = new AstGeneratorChain();
+
+        $this->assertFalse($generator->supportsGeneration('dummy'));
+        $this->assertEmpty($generator->generate('dummy'));
+    }
+
+    public function testSupports()
+    {
+        $generatorSub = $this->getGeneratorMock(true, array('ast'));
+
+        $generator = new AstGeneratorChain(array($generatorSub));
+        $this->assertTrue($generator->supportsGeneration('dummy'));
+        $this->assertEquals(array('ast'), $generator->generate('dummy'));
+    }
+
+    public function testMultiSupports()
+    {
+        $generatorSub1 = $this->getGeneratorMock(true, array('ast1'));
+        $generatorSub2 = $this->getGeneratorMock(true, array('ast2'));
+
+        $generator = new AstGeneratorChain(array($generatorSub1, $generatorSub2));
+        $this->assertTrue($generator->supportsGeneration('dummy'));
+        $this->assertEquals(array('ast1', 'ast2'), $generator->generate('dummy'));
+    }
+
+    public function testPartialSupports()
+    {
+        $generatorSub1 = $this->getGeneratorMock(true, array('ast1'));
+        $generatorSub2 = $this->getGeneratorMock(false);
+
+        $generator = new AstGeneratorChain(array($generatorSub1, $generatorSub2));
+        $this->assertTrue($generator->supportsGeneration('dummy'));
+        $this->assertEquals(array('ast1'), $generator->generate('dummy'));
+    }
+
+    public function testMultiSupportsWithFirstReturn()
+    {
+        $generatorSub1 = $this->getGeneratorMock(true, array('ast1'));
+        $generatorSub2 = $this->getGeneratorMock(true, array('ast2'));
+
+        $generator = new AstGeneratorChain(array($generatorSub1, $generatorSub2), true);
+        $this->assertTrue($generator->supportsGeneration('dummy'));
+        $this->assertEquals(array('ast1'), $generator->generate('dummy'));
+    }
+
+    private function getGeneratorMock($support, $return = null)
+    {
+        $generatorSub = $this->getMockBuilder(AstGeneratorInterface::class)->getMock();
+        $generatorSub
+            ->expects($this->any())
+            ->method('supportsGeneration')
+            ->with('dummy')
+            ->willReturn($support);
+        if (null === $return) {
+            $generatorSub
+                ->expects($this->never())
+                ->method('generate');
+        } else {
+            $generatorSub
+                ->expects($this->any())
+                ->method('generate')
+                ->with('dummy', array())
+                ->willReturn($return);
+        }
+
+        return $generatorSub;
+    }
+}
diff --git a/src/Symfony/Component/AstGenerator/Tests/UniqueVariableScopeTest.php b/src/Symfony/Component/AstGenerator/Tests/UniqueVariableScopeTest.php
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\AstGenerator\Tests;
+
+use Symfony\Component\AstGenerator\UniqueVariableScope;
+
+class UniqueVariableScopeTest extends \PHPUnit_Framework_TestCase
+{
+    public function testUniqueVariable()
+    {
+        $uniqueVariableScope = new UniqueVariableScope();
+
+        $name = $uniqueVariableScope->getUniqueName('name');
+        $this->assertEquals('name', $name);
+
+        $name = $uniqueVariableScope->getUniqueName('name');
+        $this->assertEquals('name_1', $name);
+
+        $name = $uniqueVariableScope->getUniqueName('name');
+        $this->assertEquals('name_2', $name);
+    }
+}
diff --git a/src/Symfony/Component/AstGenerator/UniqueVariableScope.php b/src/Symfony/Component/AstGenerator/UniqueVariableScope.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\AstGenerator;
+
+/**
+ * Allow to get a unique variable name for a scope (like a method).
+ */
+class UniqueVariableScope
+{
+    private $registry = array();
+
+    /**
+     * Return an unique name for a variable.
+     *
+     * @param string $name Name of the variable
+     *
+     * @return string if not found return the $name given, if not return the name suffixed with a number
+     */
+    public function getUniqueName($name)
+    {
+        if (!isset($this->registry[$name])) {
+            $this->registry[$name] = 0;
+
+            return $name;
+        }
+
+        ++$this->registry[$name];
+
+        return sprintf('%s_%s', $name, $this->registry[$name]);
+    }
+    }
diff --git a/src/Symfony/Component/AstGenerator/composer.json b/src/Symfony/Component/AstGenerator/composer.json
@@ -0,0 +1,38 @@
+{
+    "name": "symfony/ast-generator",
+    "type": "library",
+    "description": "Symfony component to generate AST from and to various others components",
+    "keywords": ["symfony", "ast", "generator"],
+    "homepage": "https://symfony.com",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Joel Wurtz",
+            "email": "joel.wurtz@gmail.com"
+        },
+        {
+            "name": "Symfony Community",
+            "homepage": "https://symfony.com/contributors"
+        }
+    ],
+    "require": {
+        "php": ">=5.5.9",
+        "nikic/php-parser": "~2.0",
+        "symfony/property-info": "~2.8|~3.0"
+    },
+    "require-dev": {
+        "symfony/serializer": "~2.8|~3.0"
+    },
+    "autoload": {
+        "psr-4": { "Symfony\\Component\\AstGenerator\\": "" },
+        "exclude-from-classmap": [
+            "/Tests/"
+        ]
+    },
+    "minimum-stability": "dev",
+    "extra": {
+        "branch-alias": {
+            "dev-master": "3.1-dev"
+        }
+    }
+}
diff --git a/src/Symfony/Component/AstGenerator/phpunit.xml.dist b/src/Symfony/Component/AstGenerator/phpunit.xml.dist
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.1/phpunit.xsd"
+         backupGlobals="false"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+>
+    <php>
+        <ini name="error_reporting" value="-1" />
+    </php>
+
+    <testsuites>
+        <testsuite name="Symfony AstGenerator Component Test Suite">
+            <directory>./Tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory>./</directory>
+            <exclude>
+                <directory>./Tests</directory>
+                <directory>./vendor</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+</phpunit>