Merge pull request #121 from dunglas/jlagneau-master

Support for PSR-4 prefixes

Author: dunglas

src/Command/GenerateTypesCommand.php

@@ -35,15 +35,32 @@ final class GenerateTypesCommand extends Command
 {
     private const DEFAULT_CONFIG_FILE = 'schema.yaml';
 
+    private $namespacePrefix;
+    private $defaultOutput;
+
     /**
      * {@inheritdoc}
      */
     protected function configure(): void
     {
+        if (file_exists('composer.json') && is_file('composer.json') && is_readable('composer.json')) {
+            $composer = json_decode(file_get_contents('composer.json'), true);
+            foreach ($composer['autoload']['psr-4'] ?? [] as $prefix => $output) {
+                if ('' === $prefix) {
+                    continue;
+                }
+
+                $this->namespacePrefix = $prefix;
+                $this->defaultOutput = $output;
+
+                break;
+            }
+        }
+
         $this
             ->setName('generate-types')
             ->setDescription('Generate types')
-            ->addArgument('output', InputArgument::REQUIRED, 'The output directory')
+            ->addArgument('output', $this->defaultOutput ? InputArgument::OPTIONAL : InputArgument::REQUIRED, 'The output directory', $this->defaultOutput)
             ->addArgument('config', InputArgument::OPTIONAL, 'The config file to use (default to "schema.yaml" in the current directory, will generate all types if no config file exists)');
     }
 
@@ -52,10 +69,18 @@ protected function configure(): void
      */
     protected function execute(InputInterface $input, OutputInterface $output): void
     {
+        $defaultOutput = $this->defaultOutput ? realpath($this->defaultOutput) : null;
         $outputDir = $input->getArgument('output');
+        $configArgument = $input->getArgument('config');
+
         if ($dir = realpath($input->getArgument('output'))) {
             if (!is_dir($dir)) {
-                throw new \InvalidArgumentException(sprintf('The file "%s" is not a directory.', $dir));
+                if (!$this->defaultOutput) {
+                    throw new \InvalidArgumentException(sprintf('The file "%s" is not a directory.', $dir));
+                }
+
+                $dir = $defaultOutput;
+                $configArgument = $outputDir;
             }
 
             if (!is_writable($dir)) {
@@ -69,7 +94,6 @@ protected function execute(InputInterface $input, OutputInterface $output): void
             $outputDir = realpath($outputDir);
         }
 
-        $configArgument = $input->getArgument('config');
         if ($configArgument) {
             if (!file_exists($configArgument)) {
                 throw new \InvalidArgumentException(sprintf('The file "%s" doesn\'t exist.', $configArgument));
@@ -95,7 +119,7 @@ protected function execute(InputInterface $input, OutputInterface $output): void
         }
 
         $processor = new Processor();
-        $configuration = new TypesGeneratorConfiguration();
+        $configuration = new TypesGeneratorConfiguration($dir === $defaultOutput ? $this->namespacePrefix : null);
         $processedConfiguration = $processor->processConfiguration($configuration, [$config]);
         $processedConfiguration['output'] = $outputDir;
         if (!$processedConfiguration['output']) {

src/TypesGenerator.php

@@ -827,6 +827,10 @@ private function generateClassUses(array $annotationGenerators, array $classes,
      */
     private function namespaceToDir(array $config, string $namespace): string
     {
+        if (null !== ($prefix = $config['namespaces']['prefix'] ?? null) && 0 === strpos($namespace, $prefix)) {
+            $namespace = substr($namespace, strlen($prefix));
+        }
+
         return sprintf('%s/%s/', $config['output'], strtr($namespace, '\\', '/'));
     }
 

src/TypesGeneratorConfiguration.php

@@ -39,11 +39,20 @@ final class TypesGeneratorConfiguration implements ConfigurationInterface
     public const GOOD_RELATIONS_OWL_URL = __DIR__.'/../data/v1.owl';
     public const SCHEMA_ORG_NAMESPACE = 'http://schema.org/';
 
+    private $defaultPrefix;
+
+    public function __construct(?string $defaultPrefix = null)
+    {
+        $this->defaultPrefix = $defaultPrefix;
+    }
+
     /**
      * {@inheritdoc}
      */
     public function getConfigTreeBuilder(): TreeBuilder
     {
+        $namespacePrefix = $this->defaultPrefix ?? 'AppBundle\\';
+
         $treeBuilder = new TreeBuilder();
         $rootNode = $treeBuilder->root('config');
         $rootNode
@@ -92,9 +101,10 @@ function ($rdfa) {
                     ->addDefaultsIfNotSet()
                     ->info('PHP namespaces')
                     ->children()
-                        ->scalarNode('entity')->defaultValue('AppBundle\Entity')->info('The namespace of the generated entities')->example('Acme\Entity')->end()
-                        ->scalarNode('enum')->defaultValue('AppBundle\Enum')->info('The namespace of the generated enumerations')->example('Acme\Enum')->end()
-                        ->scalarNode('interface')->defaultValue('AppBundle\Model')->info('The namespace of the generated interfaces')->example('Acme\Model')->end()
+                        ->scalarNode('prefix')->defaultValue($this->defaultPrefix)->info('The global namespace\'s prefix')->example('App\\')->end()
+                        ->scalarNode('entity')->defaultValue("{$namespacePrefix}Entity")->info('The namespace of the generated entities')->example('App\Entity')->end()
+                        ->scalarNode('enum')->defaultValue("{$namespacePrefix}Enum")->info('The namespace of the generated enumerations')->example('App\Enum')->end()
+                        ->scalarNode('interface')->defaultValue("{$namespacePrefix}Model")->info('The namespace of the generated interfaces')->example('App\Model')->end()
                     ->end()
                 ->end()
                 ->arrayNode('doctrine')

tests/Command/DumpConfigurationTest.php

@@ -76,14 +76,17 @@ public function testDumpConfiguration()
     # PHP namespaces
     namespaces:
 
+        # The global namespace's prefix
+        prefix:               null # Example: App\
+
         # The namespace of the generated entities
-        entity:               AppBundle\Entity # Example: Acme\Entity
+        entity:               AppBundle\Entity # Example: App\Entity
 
         # The namespace of the generated enumerations
-        enum:                 AppBundle\Enum # Example: Acme\Enum
+        enum:                 AppBundle\Enum # Example: App\Enum
 
         # The namespace of the generated interfaces
-        interface:            AppBundle\Model # Example: Acme\Model
+        interface:            AppBundle\Model # Example: App\Model
 
     # Doctrine
     doctrine:

tests/Command/GenerateTypesCommandTest.php

@@ -308,4 +308,41 @@ public function testDoNotGenerateId()
         $this->assertNotContains('function getId', $person);
         $this->assertNotContains('function setId', $person);
     }
+
+    public function testNamespacesPrefix()
+    {
+        $outputDir = __DIR__.'/../../build/namespaces-prefix';
+        $config = __DIR__.'/../config/namespaces-prefix.yaml';
+
+        $this->fs->mkdir($outputDir);
+
+        $commandTester = new CommandTester(new GenerateTypesCommand());
+        $this->assertEquals(0, $commandTester->execute(['output' => $outputDir, 'config' => $config]));
+
+        $person = file_get_contents("$outputDir/Entity/Person.php");
+
+        $this->assertContains('namespace App\Entity;', $person);
+    }
+
+    public function testNamespacesPrefixAutodetect()
+    {
+        $outputDir = __DIR__.'/../../build/namespaces-prefix-autodetect/';
+
+        $this->fs->mkdir($outputDir);
+        $this->fs->copy(__DIR__.'/../config/namespaces-prefix-autodetect/composer.json', "$outputDir/composer.json");
+        $this->fs->copy(__DIR__.'/../config/namespaces-prefix-autodetect/schema.yaml', "$outputDir/schema.yaml");
+
+        $currentDir = getcwd();
+        chdir($outputDir);
+        try {
+            $commandTester = new CommandTester(new GenerateTypesCommand());
+            $this->assertEquals(0, $commandTester->execute([]));
+
+            $person = file_get_contents("$outputDir/src/Entity/Person.php");
+
+            $this->assertContains('namespace App\Entity;', $person);
+        } finally {
+            chdir($currentDir);
+        }
+    }
 }

tests/TypesGeneratorTest.php

@@ -392,17 +392,16 @@ private function getClasses(): array
     private function getContextMatcher(array $class)
     {
         $config = $this->getConfig();
-        $classes = $this->getClasses();
 
-        return function ($context) use ($config, $classes, $class) {
+        return function ($context) use ($config, $class) {
             if (!isset($context['config']) || $config !== $context['config']) {
                 return false;
             }
 
             $baseClass = $class;
             unset($baseClass['fields']);
 
-            if (!isset($context['class']) || !is_array($context['class']) || $this->arrayEqual($baseClass, array_intersect_key($context['class'], $baseClass))) {
+            if (!isset($context['class']) || !\is_array($context['class']) || $this->arrayEqual($baseClass, array_intersect_key($context['class'], $baseClass))) {
                 return false;
             }
 
@@ -416,6 +415,6 @@ private function getContextMatcher(array $class)
 
     private function arrayEqual(array $a, array $b): bool
     {
-        return count($a) === count($b) && !array_diff($a, $b);
+        return \count($a) === \count($b) && !array_diff($a, $b);
     }
 }

tests/config/namespaces-prefix-autodetect/composer.json

@@ -0,0 +1,5 @@
+{
+  "autoload": {
+    "psr-4": { "App\\": "src/" }
+  }
+}

tests/config/namespaces-prefix-autodetect/schema.yaml

@@ -0,0 +1,4 @@
+types:
+  Person:
+    properties:
+      name: ~

tests/config/namespaces-prefix.yaml

@@ -0,0 +1,7 @@
+namespaces:
+  prefix: App\
+  entity: App\Entity
+types:
+  Person:
+    properties:
+      name: ~