Update generate:bundle for non-shared bundles and more

Command/Helper/QuestionHelper.php

@@ -25,11 +25,11 @@ class QuestionHelper extends BaseQuestionHelper
     public function writeGeneratorSummary(OutputInterface $output, $errors)
     {
         if (!$errors) {
-            $this->writeSection($output, 'You can now start using the generated code!');
+            $this->writeSection($output, 'Everything is OK! Now get to work :).');
         } else {
             $this->writeSection($output, array(
                 'The command was not able to configure everything automatically.',
-                'You must do the following changes manually.',
+                'You\'ll need to make the following changes manually.',
             ), 'error');
 
             $output->writeln($errors);
@@ -43,7 +43,7 @@ public function getRunner(OutputInterface $output, &$errors)
                 $output->writeln('<fg=red>FAILED</>');
                 $errors = array_merge($errors, $err);
             } else {
-                $output->writeln('<info>OK</info>');
+                $output->writeln('<comment>OK!</comment>');
             }
         };
 

Command/Validators.php

@@ -18,6 +18,16 @@
  */
 class Validators
 {
+    /**
+     * Validates that the given namespace (e.g. Acme\FooBundle) is a valid format
+     *
+     * If $requireVendorNamespace is true, then we require you to have a vendor
+     * namespace (e.g. Acme).
+     *
+     * @param $namespace
+     * @param bool $requireVendorNamespace
+     * @return string
+     */
     public static function validateBundleNamespace($namespace, $requireVendorNamespace = true)
     {
         if (!preg_match('/Bundle$/', $namespace)) {
@@ -39,7 +49,6 @@ public static function validateBundleNamespace($namespace, $requireVendorNamespa
 
         // validate that the namespace is at least one level deep
         if ($requireVendorNamespace && false === strpos($namespace, '\\')) {
-            // language is (almost) duplicated in GenerateBundleCommand
             $msg = array();
             $msg[] = sprintf('The namespace must contain a vendor namespace (e.g. "VendorName\%s" instead of simply "%s").', $namespace, $namespace);
             $msg[] = 'If you\'ve specified a vendor namespace, did you forget to surround it with quotes (init:bundle "Acme\BlogBundle")?';
@@ -53,7 +62,7 @@ public static function validateBundleNamespace($namespace, $requireVendorNamespa
     public static function validateBundleName($bundle)
     {
         if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $bundle)) {
-            throw new \InvalidArgumentException('The bundle name contains invalid characters.');
+            throw new \InvalidArgumentException(sprintf('The bundle name %s contains invalid characters.', $bundle));
         }
 
         if (!preg_match('/Bundle$/', $bundle)) {
@@ -79,16 +88,19 @@ public static function validateControllerName($controller)
         return $controller;
     }
 
-    public static function validateTargetDir($dir, $bundle, $namespace)
-    {
-        // add trailing / if necessary
-        return '/' === substr($dir, -1, 1) ? $dir : $dir.'/';
-    }
-
     public static function validateFormat($format)
     {
+        if (!$format) {
+            throw new \RuntimeException('Please enter a configuration format.');
+        }
+
         $format = strtolower($format);
 
+        // in case they typed "yaml", but ok with that
+        if ($format == 'yaml') {
+            $format = 'yml';
+        }
+
         if (!in_array($format, array('php', 'xml', 'yml', 'annotation'))) {
             throw new \RuntimeException(sprintf('Format "%s" is not supported.', $format));
         }

Generator/BundleGenerator.php

@@ -11,8 +11,8 @@
 
 namespace Sensio\Bundle\GeneratorBundle\Generator;
 
+use Sensio\Bundle\GeneratorBundle\Model\Bundle;
 use Symfony\Component\Filesystem\Filesystem;
-use Symfony\Component\DependencyInjection\Container;
 
 /**
  * Generates a bundle.
@@ -28,9 +28,10 @@ public function __construct(Filesystem $filesystem)
         $this->filesystem = $filesystem;
     }
 
-    public function generate($namespace, $bundle, $dir, $format, $structure)
+    public function generateBundle(Bundle $bundle)
     {
-        $dir .= '/'.strtr($namespace, '\\', '/');
+        $dir = $bundle->getTargetDirectory();
+
         if (file_exists($dir)) {
             if (!is_dir($dir)) {
                 throw new \RuntimeException(sprintf('Unable to generate the bundle as the target directory "%s" exists but is a file.', realpath($dir)));
@@ -44,41 +45,35 @@ public function generate($namespace, $bundle, $dir, $format, $structure)
             }
         }
 
-        $basename = substr($bundle, 0, -6);
         $parameters = array(
-            'namespace' => $namespace,
-            'bundle'    => $bundle,
-            'format'    => $format,
-            'bundle_basename' => $basename,
-            'extension_alias' => Container::underscore($basename),
+            'namespace' => $bundle->getNamespace(),
+            'bundle'    => $bundle->getName(),
+            'format'    => $bundle->getConfigurationFormat(),
+            'bundle_basename' => $bundle->getBasename(),
+            'extension_alias' => $bundle->getExtensionAlias(),
         );
 
-        $this->renderFile('bundle/Bundle.php.twig', $dir.'/'.$bundle.'.php', $parameters);
-        $this->renderFile('bundle/Extension.php.twig', $dir.'/DependencyInjection/'.$basename.'Extension.php', $parameters);
-        $this->renderFile('bundle/Configuration.php.twig', $dir.'/DependencyInjection/Configuration.php', $parameters);
+        $this->renderFile('bundle/Bundle.php.twig', $dir.'/'.$bundle->getName().'.php', $parameters);
+        if ($bundle->shouldGenerateDependencyInjectionDirectory()) {
+            $this->renderFile('bundle/Extension.php.twig', $dir.'/DependencyInjection/'.$bundle->getBasename().'Extension.php', $parameters);
+            $this->renderFile('bundle/Configuration.php.twig', $dir.'/DependencyInjection/Configuration.php', $parameters);
+        }
         $this->renderFile('bundle/DefaultController.php.twig', $dir.'/Controller/DefaultController.php', $parameters);
         $this->renderFile('bundle/DefaultControllerTest.php.twig', $dir.'/Tests/Controller/DefaultControllerTest.php', $parameters);
         $this->renderFile('bundle/index.html.twig.twig', $dir.'/Resources/views/Default/index.html.twig', $parameters);
 
-        if ('xml' === $format || 'annotation' === $format) {
-            $this->renderFile('bundle/services.xml.twig', $dir.'/Resources/config/services.xml', $parameters);
-        } else {
-            $this->renderFile('bundle/services.'.$format.'.twig', $dir.'/Resources/config/services.'.$format, $parameters);
-        }
-
-        if ('annotation' != $format) {
-            $this->renderFile('bundle/routing.'.$format.'.twig', $dir.'/Resources/config/routing.'.$format, $parameters);
-        }
-
-        if ($structure) {
-            $this->renderFile('bundle/messages.fr.xlf', $dir.'/Resources/translations/messages.fr.xlf', $parameters);
+        // render the services.yml/xml file
+        $servicesFilename = $bundle->getServicesConfigurationFilename();
+        $this->renderFile(
+            sprintf('bundle/%s.twig', $servicesFilename),
+            $dir.'/Resources/config/'.$servicesFilename, $parameters
+        );
 
-            $this->filesystem->mkdir($dir.'/Resources/doc');
-            $this->filesystem->touch($dir.'/Resources/doc/index.rst');
-            $this->filesystem->mkdir($dir.'/Resources/translations');
-            $this->filesystem->mkdir($dir.'/Resources/public/css');
-            $this->filesystem->mkdir($dir.'/Resources/public/images');
-            $this->filesystem->mkdir($dir.'/Resources/public/js');
+        if ($routingFilename = $bundle->getRoutingConfigurationFilename()) {
+            $this->renderFile(
+                sprintf('bundle/%s.twig', $routingFilename),
+                $dir.'/Resources/config/'.$routingFilename, $parameters
+            );
         }
     }
 }

Manipulator/ConfigurationManipulator.php

@@ -0,0 +1,115 @@
+<?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 Sensio\Bundle\GeneratorBundle\Manipulator;
+
+use Sensio\Bundle\GeneratorBundle\Model\Bundle;
+use Symfony\Component\Yaml\Yaml;
+
+/**
+ * Changes the PHP code of a YAML services configuration file.
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ * @author Ryan Weaver <weaverryan@gmail.com>
+ */
+class ConfigurationManipulator extends Manipulator
+{
+    private $file;
+
+    /**
+     * Constructor.
+     *
+     * @param string $file The YAML configuration file path
+     */
+    public function __construct($file)
+    {
+        $this->file = $file;
+    }
+
+    /**
+     * Adds a configuration resource at the top of the existing ones.
+     *
+     * @param Bundle $bundle
+     *
+     * @throws \RuntimeException If this process fails for any reason
+     */
+    public function addResource(Bundle $bundle)
+    {
+        // if the config.yml file doesn't exist, don't even try.
+        if (!file_exists($this->file)) {
+            throw new \RuntimeException(sprintf('The target config file %s does not exist', $this->file));
+        }
+
+        $code = $this->getImportCode($bundle);
+
+        $currentContents = file_get_contents($this->file);
+        // Don't add same bundle twice
+        if (false !== strpos($currentContents, $code)) {
+            throw new \RuntimeException(sprintf(
+                'The %s configuration file from %s is already imported',
+                $bundle->getServicesConfigurationFilename(),
+                $bundle->getName()
+            ));
+        }
+
+        // find the "imports" line and add this at the end of that list
+        $lastImportedPath = $this->findLastImportedPath($currentContents);
+        if (!$lastImportedPath) {
+            throw new \RuntimeException(sprintf('Could not find the imports key in %s', $this->file));
+        }
+
+        // find imports:
+        $importsPosition = strpos($currentContents, 'imports:');
+        // find the last import
+        $lastImportPosition = strpos($currentContents, $lastImportedPath, $importsPosition);
+        // find the line break after the last import
+        $targetLinebreakPosition = strpos($currentContents, "\n", $lastImportPosition);
+
+        $newContents = substr($currentContents, 0, $targetLinebreakPosition)."\n".$code.substr($currentContents, $targetLinebreakPosition);
+
+        if (false === file_put_contents($this->file, $newContents)) {
+            throw new \RuntimeException(sprintf('Could not write file %s ', $this->file));
+        }
+    }
+
+    public function getImportCode(Bundle $bundle)
+    {
+        return sprintf(<<<EOF
+    - { resource: "@%s/Resources/config/%s" }
+EOF
+        ,
+            $bundle->getName(),
+            $bundle->getServicesConfigurationFilename()
+        );
+    }
+
+    /**
+     * Finds the last imported resource path in the YAML file
+     *
+     * @param $yamlContents
+     * @return bool|string
+     */
+    private function findLastImportedPath($yamlContents)
+    {
+        $data = Yaml::parse($yamlContents);
+        if (!isset($data['imports'])) {
+            return false;
+        }
+
+        // find the last imports entry
+        $lastImport = end($data['imports']);
+        if (!isset($lastImport['resource'])) {
+            return false;
+        }
+
+        return $lastImport['resource'];
+    }
+}

Manipulator/KernelManipulator.php

@@ -45,11 +45,11 @@ public function __construct(KernelInterface $kernel)
      */
     public function addBundle($bundle)
     {
-        if (!$this->reflected->getFilename()) {
+        if (!$this->getFilename()) {
             return false;
         }
 
-        $src = file($this->reflected->getFilename());
+        $src = file($this->getFilename());
         $method = $this->reflected->getMethod('registerBundles');
         $lines = array_slice($src, $method->getStartLine() - 1, $method->getEndLine() - $method->getStartLine() + 1);
 
@@ -96,10 +96,15 @@ public function addBundle($bundle)
                     array_slice($src, $this->line - 1)
                 );
 
-                file_put_contents($this->reflected->getFilename(), implode('', $lines));
+                file_put_contents($this->getFilename(), implode('', $lines));
 
                 return true;
             }
         }
     }
+
+    public function getFilename()
+    {
+        return $this->reflected->getFileName();
+    }
 }