feature #173 Add configuration of root namespace (Sergey Rabochiy, weaverryan)

This PR was merged into the 1.0-dev branch.

Discussion
----------

Add configuration of root namespace

This PR adds configuration for namespaces used in `make:*` commands that was discussed in #133.
I've used [this doc](https://symfony.com/doc/current/bundles/configuration.html) in work and examples from `FrameworkBundle`.

New parameter:
`maker.root_namespace` - application root namespace, default: `App`

To change it, you should create configuration file in `config/packages/dev` with name `maker.yaml` or `maker.xml` or `maker.php` with root node `maker`. For example YAML file:
```yaml
# config/packages/dev/maker.yaml
maker:
    root_namespace: 'App'
```

I've added some tests. I think we don't need Flex recipe but just document new feature.
I need help for write documentation because my English.

TODO:
- [x] Tests
- [x] Documentations
- [ ] Squash commits

Commits
-------

42b7008 Fixing accidental removal of property
545a422 Merge branch 'master' into configurable_namespace
b92f19c Merge branch 'master' into configurable_namespace
bf1b092 updating for now-missing property
b5658c2 Merge branch 'master' into configurable_namespace
7440ade return type stuff
656116c Changing from an exception
5605d6e adding docs
23a715c Merge remote-tracking branch 'upstream/master' into configurable_namespace
152ffa6 The most important fix
f34fa39 Add exception with hint message when root namespace is not found
758a2c9 Refactor AutoloaderUtil
5423250 Remove maker.root_namespace parameter and improve tests
7157e88 Fix file creation on Windows
657f653 Remove useless code
a425953 Add functional tests for custom root namespace cases
d4139d4 Make "abstract" command and remove entity namespace from config
51d7138 Add configuration of root and entity namespaces

Author: weaverryan

src/Command/MakerCommand.php

@@ -72,6 +72,13 @@ protected function initialize(InputInterface $input, OutputInterface $output)
 
     protected function interact(InputInterface $input, OutputInterface $output)
     {
+        if (!$this->fileManager->isNamespaceConfiguredToAutoload($this->generator->getRootNamespace())) {
+            $this->io->note([
+                sprintf('It looks like your app may be using a namespace other than "%s".', $this->generator->getRootNamespace()),
+                'To configure this and make your life easier, see: https://symfony.com/doc/current/bundles/SymfonyMakerBundle/index.html#configuration.',
+            ]);
+        }
+
         foreach ($this->getDefinition()->getArguments() as $argument) {
             if ($input->getArgument($argument->getName())) {
                 continue;

src/DependencyInjection/CompilerPass/MakeCommandRegistrationPass.php

@@ -14,6 +14,7 @@
 use Symfony\Bundle\MakerBundle\Command\MakerCommand;
 use Symfony\Bundle\MakerBundle\MakerInterface;
 use Symfony\Bundle\MakerBundle\Str;
+use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
@@ -32,14 +33,12 @@ public function process(ContainerBuilder $container)
                 throw new InvalidArgumentException(sprintf('Service "%s" must implement interface "%s".', $id, MakerInterface::class));
             }
 
-            $container->register(
-                sprintf('maker.auto_command.%s', Str::asTwigVariable($class::getCommandName())),
-                MakerCommand::class
-            )->setArguments([
-                new Reference($id),
-                new Reference('maker.file_manager'),
-                new Reference('maker.generator'),
-            ])->addTag('console.command', ['command' => $class::getCommandName()]);
+            $commandDefinition = new ChildDefinition('maker.auto_command.abstract');
+            $commandDefinition->setClass(MakerCommand::class);
+            $commandDefinition->replaceArgument(0, new Reference($id));
+            $commandDefinition->addTag('console.command', ['command' => $class::getCommandName()]);
+
+            $container->setDefinition(sprintf('maker.auto_command.%s', Str::asTwigVariable($class::getCommandName())), $commandDefinition);
         }
     }
 }

src/DependencyInjection/Configuration.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class Configuration implements ConfigurationInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+        $rootNode = $treeBuilder->root('maker');
+
+        $rootNode
+            ->children()
+                ->scalarNode('root_namespace')->defaultValue('App')->end()
+            ->end()
+        ;
+
+        return $treeBuilder;
+    }
+}

src/DependencyInjection/MakerExtension.php

@@ -34,6 +34,17 @@ public function load(array $configs, ContainerBuilder $container)
         $loader->load('services.xml');
         $loader->load('makers.xml');
 
+        $configuration = $this->getConfiguration($configs, $container);
+        $config = $this->processConfiguration($configuration, $configs);
+
+        $rootNamespace = trim($config['root_namespace'], '\\');
+
+        $makeCommandDefinition = $container->getDefinition('maker.generator');
+        $makeCommandDefinition->replaceArgument(1, $rootNamespace);
+
+        $doctrineHelperDefinition = $container->getDefinition('maker.doctrine_helper');
+        $doctrineHelperDefinition->replaceArgument(0, $rootNamespace.'\\Entity');
+
         $container->registerForAutoconfiguration(MakerInterface::class)
             ->addTag(MakeCommandRegistrationPass::MAKER_TAG);
     }

src/Doctrine/DoctrineHelper.php

@@ -28,13 +28,19 @@
  */
 final class DoctrineHelper
 {
+    /**
+     * @var string
+     */
+    private $entityNamespace;
+
     /**
      * @var ManagerRegistry
      */
     private $registry;
 
-    public function __construct(ManagerRegistry $registry = null)
+    public function __construct(string $entityNamespace, ManagerRegistry $registry = null)
     {
+        $this->entityNamespace = trim($entityNamespace, '\\');
         $this->registry = $registry;
     }
 
@@ -54,6 +60,11 @@ private function isDoctrineInstalled(): bool
         return null !== $this->registry;
     }
 
+    public function getEntityNamespace(): string
+    {
+        return $this->entityNamespace;
+    }
+
     /**
      * @param string $className
      *
@@ -94,7 +105,7 @@ public function getEntitiesForAutocomplete(): array
 
             /* @var ClassMetadata $metadata */
             foreach (array_keys($allMetadata) as $classname) {
-                $entityClassDetails = new ClassNameDetails($classname, 'App\\Entity');
+                $entityClassDetails = new ClassNameDetails($classname, $this->entityNamespace);
                 $entities[] = $entityClassDetails->getRelativeName();
             }
         }

src/FileManager.php

@@ -163,6 +163,11 @@ public function getNamespacePrefixForClass(string $className): string
         return $this->autoloaderUtil->getNamespacePrefixForClass($className);
     }
 
+    public function isNamespaceConfiguredToAutoload(string $namespace): bool
+    {
+        return $this->autoloaderUtil->isNamespaceConfiguredToAutoload($namespace);
+    }
+
     /**
      * Resolve '../' in paths (like real_path), but for non-existent files.
      *

src/Generator.php

@@ -25,11 +25,11 @@ class Generator
     private $pendingOperations = [];
     private $namespacePrefix;
 
-    public function __construct(FileManager $fileManager, $namespacePrefix)
+    public function __construct(FileManager $fileManager, string $namespacePrefix)
     {
         $this->fileManager = $fileManager;
         $this->twigHelper = new GeneratorTwigHelper($fileManager);
-        $this->namespacePrefix = rtrim($namespacePrefix, '\\');
+        $this->namespacePrefix = trim($namespacePrefix, '\\');
     }
 
     /**
@@ -170,4 +170,9 @@ public function writeChanges()
 
         $this->pendingOperations = [];
     }
+
+    public function getRootNamespace(): string
+    {
+        return $this->namespacePrefix;
+    }
 }

src/Maker/MakeEntity.php

@@ -48,7 +48,7 @@ final class MakeEntity extends AbstractMaker implements InputAwareMakerInterface
     private $doctrineHelper;
     private $generator;
 
-    public function __construct(FileManager $fileManager, string $projectDirectory, DoctrineHelper $doctrineHelper, Generator $generator = null)
+    public function __construct(FileManager $fileManager, DoctrineHelper $doctrineHelper, string $projectDirectory, Generator $generator = null)
     {
         $this->fileManager = $fileManager;
         $this->doctrineHelper = $doctrineHelper;
@@ -92,7 +92,7 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
                 'This command will generate any missing methods (e.g. getters & setters) for a class or all classes in a namespace.',
                 'To overwrite any existing methods, re-run this command with the --overwrite flag',
             ], null, 'fg=yellow');
-            $classOrNamespace = $io->ask('Enter a class or namespace to regenerate', 'App\\Entity', [Validator::class, 'notBlank']);
+            $classOrNamespace = $io->ask('Enter a class or namespace to regenerate', $this->getEntityNamespace(), [Validator::class, 'notBlank']);
 
             $input->setArgument('name', $classOrNamespace);
 
@@ -518,14 +518,14 @@ private function askRelationDetails(ConsoleStyle $io, string $generatedEntityCla
             $targetEntityClass = $io->askQuestion($question);
 
             if (!class_exists($targetEntityClass)) {
-                if (!class_exists('App\\Entity\\'.$targetEntityClass)) {
+                if (!class_exists($this->getEntityNamespace().'\\'.$targetEntityClass)) {
                     $io->error(sprintf('Unknown class "%s"', $targetEntityClass));
                     $targetEntityClass = null;
 
                     continue;
                 }
 
-                $targetEntityClass = 'App\\Entity\\'.$targetEntityClass;
+                $targetEntityClass = $this->getEntityNamespace().'\\'.$targetEntityClass;
             }
         }
 
@@ -841,4 +841,9 @@ private function doesEntityUseAnnotationMapping(string $className): bool
 
         return $driver instanceof AnnotationDriver;
     }
+
+    private function getEntityNamespace(): string
+    {
+        return $this->doctrineHelper->getEntityNamespace();
+    }
 }

src/Resources/config/makers.xml

@@ -27,8 +27,8 @@
 
             <service id="maker.maker.make_entity" class="Symfony\Bundle\MakerBundle\Maker\MakeEntity">
                 <argument type="service" id="maker.file_manager" />
-                <argument>%kernel.project_dir%</argument>
                 <argument type="service" id="maker.doctrine_helper" />
+                <argument>%kernel.project_dir%</argument>
                 <argument type="service" id="maker.generator" />
                 <tag name="maker.command" />
             </service>

src/Resources/config/services.xml

@@ -13,7 +13,11 @@
                 <argument>%kernel.project_dir%</argument>
             </service>
 
-            <service id="maker.autoloader_util" class="Symfony\Bundle\MakerBundle\Util\AutoloaderUtil" />
+            <service id="maker.autoloader_finder" class="Symfony\Bundle\MakerBundle\Util\ComposerAutoloaderFinder" />
+
+            <service id="maker.autoloader_util" class="Symfony\Bundle\MakerBundle\Util\AutoloaderUtil">
+                <argument type="service" id="maker.autoloader_finder" />
+            </service>
 
             <service id="maker.event_registry" class="Symfony\Bundle\MakerBundle\EventRegistry">
                 <argument type="service" id="event_dispatcher" />
@@ -24,12 +28,19 @@
             </service>
 
             <service id="maker.doctrine_helper" class="Symfony\Bundle\MakerBundle\Doctrine\DoctrineHelper">
-                <argument type="service" id="doctrine" on-invalid="ignore"/>
+                <argument /> <!-- entity namespace -->
+                <argument type="service" id="doctrine" on-invalid="ignore" />
+            </service>
+
+            <service id="maker.auto_command.abstract" class="Symfony\Bundle\MakerBundle\Command\MakerCommand" abstract="true">
+                <argument /> <!-- maker -->
+                <argument type="service" id="maker.file_manager" />
+                <argument type="service" id="maker.generator" />
             </service>
 
             <service id="maker.generator" class="Symfony\Bundle\MakerBundle\Generator">
                 <argument type="service" id="maker.file_manager" />
-                <argument>App\</argument>
+                <argument /> <!-- root namespace -->
             </service>
         </services>
 </container>

src/Resources/doc/index.rst

@@ -41,6 +41,22 @@ optional arguments and options. Check them out with the ``--help`` option:
 
     $ php bin/console make:controller --help
 
+Configuration
+-------------
+
+This bundles doesn't require any configuration. But, you *can* configure
+the root namespace that is used to "guess" what classes you want to generate:
+
+.. code-block:: yaml
+
+    # config/packages/maker.yaml
+    # create this file if you need to configure anything
+    maker:
+        # tell MakerBundle that all of your classes lives in an
+        # Acme namespace, instead of the default App
+        # (e.g. Acme\Entity\Article, Acme\Command\MyCommand, etc)
+        root_namespace: 'Acme'
+
 Creating your Own Makers
 ------------------------
 

src/Test/MakerTestDetails.php

@@ -38,6 +38,8 @@ final class MakerTestDetails
 
     private $commandAllowedToFail = false;
 
+    private $snapshotSuffix = '';
+
     private $requiredPhpVersion;
 
     /**
@@ -64,6 +66,46 @@ public function setFixtureFilesPath(string $fixtureFilesPath): self
         return $this;
     }
 
+    public function changeRootNamespace(string $rootNamespace): self
+    {
+        $rootNamespace = trim($rootNamespace, '\\');
+
+        // to bypass read before flush issue
+        $this->snapshotSuffix = $rootNamespace;
+
+        return $this
+            ->addReplacement(
+                'composer.json',
+                '"App\\\\": "src/"',
+                '"'.$rootNamespace.'\\\\": "src/"'
+            )
+            ->addReplacement(
+                'src/Kernel.php',
+                'namespace App',
+                'namespace '.$rootNamespace
+            )
+            ->addReplacement(
+                'bin/console',
+                'use App\\Kernel',
+                'use '.$rootNamespace.'\\Kernel'
+            )
+            ->addReplacement(
+                'public/index.php',
+                'use App\\Kernel',
+                'use '.$rootNamespace.'\\Kernel'
+            )
+            ->addReplacement(
+                'config/services.yaml',
+                'App\\',
+                $rootNamespace.'\\'
+            )
+            ->addReplacement(
+                'phpunit.xml.dist',
+                '<env name="KERNEL_CLASS" value="App\\Kernel" />',
+                '<env name="KERNEL_CLASS" value="'.$rootNamespace.'\\Kernel" />'
+            );
+    }
+
     public function addPreMakeCommand(string $preMakeCommand): self
     {
         $this->preMakeCommands[] = $preMakeCommand;
@@ -202,7 +244,7 @@ public function getUniqueCacheDirectoryName(): string
     {
         // for cache purposes, only the dependencies are important
         // shortened to avoid long paths on Windows
-        return 'maker_'.substr(md5(serialize($this->getDependencies())), 0, 10);
+        return 'maker_'.substr(md5(serialize($this->getDependencies()).$this->snapshotSuffix), 0, 10);
     }
 
     public function getPreMakeCommands(): array

src/Test/MakerTestEnvironment.php

@@ -135,11 +135,11 @@ private function preMake()
 
     public function runMaker()
     {
+        $this->preMake();
+
         MakerTestProcess::create('php bin/console cache:clear --no-ansi', $this->path)
                         ->run();
 
-        $this->preMake();
-
         // We don't need ansi coloring in tests!
         $testProcess = MakerTestProcess::create(
             sprintf('php bin/console %s %s --no-ansi', $this->testDetails->getMaker()::getCommandName(), $this->testDetails->getArgumentsString()),