[2.0] Refactoring AnnotationExporter code to a EntityGenerator tool which is...

[2.0] Refactoring AnnotationExporter code to a EntityGenerator tool which is used now in orm:convert-mapping to generate annotated entities and also used in orm:generate-entity-stubs for generating entity classes and properties/method stubs from mapping information

lib/Doctrine/Common/Cli/CliController.php

@@ -83,7 +83,8 @@ class CliController extends AbstractNamespace
              ->addTask('run-dql', $ns . '\RunDqlTask')
              ->addTask('schema-tool', $ns . '\SchemaToolTask')
              ->addTask('version', $ns . '\VersionTask')
-             ->addTask('convert-d1-schema', $ns . '\ConvertDoctrine1SchemaTask');
+             ->addTask('convert-d1-schema', $ns . '\ConvertDoctrine1SchemaTask')
+             ->addTask('generate-entity-stubs', $ns . '\GenerateEntityStubsTask');
 
         $ns = 'Doctrine\DBAL\Tools\Cli\Tasks';
         $this->addNamespace('Dbal')

lib/Doctrine/ORM/Tools/Cli/Tasks/ConvertMappingTask.php

@@ -171,7 +171,7 @@ class ConvertMappingTask extends AbstractTask
         $exporter->export();
     }
 
-    private function _determineSourceType($source)
+    protected function _determineSourceType($source)
     {
         // If the --from=<VALUE> is a directory lets determine if it is
         // annotations, yaml, xml, etc.
@@ -204,7 +204,7 @@ class ConvertMappingTask extends AbstractTask
         }
     }
 
-    private function _getSourceByType($type, $source)
+    protected function _getSourceByType($type, $source)
     {
         // If --from==database then the source is an instance of SchemaManager
         // for the current EntityMAnager

lib/Doctrine/ORM/Tools/Cli/Tasks/GenerateEntityStubsTask.php

+<?php
+/*
+ *  $Id$
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+ 
+namespace Doctrine\ORM\Tools\Cli\Tasks;
+
+use Doctrine\Common\Cli\Tasks\AbstractTask,
+    Doctrine\Common\Cli\Option,
+    Doctrine\Common\Cli\OptionGroup,
+    Doctrine\Common\Cli\CliException,
+    Doctrine\ORM\Tools\EntityGenerator,
+    Doctrine\ORM\Tools\Export\ClassMetadataExporter;
+
+/**
+ * CLI Task to generate entity classes and method stubs from your mapping information.
+ *
+ * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
+ * @link    www.doctrine-project.org
+ * @since   2.0
+ * @version $Revision$
+ * @author  Benjamin Eberlei <kontakt@beberlei.de>
+ * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
+ * @author  Jonathan Wage <jonwage@gmail.com>
+ * @author  Roman Borschel <roman@code-factory.org>
+ */
+class GenerateEntityStubsTask extends ConvertMappingTask
+{
+    /**
+     * @inheritdoc
+     */
+    public function buildDocumentation()
+    {
+        $options = new OptionGroup(OptionGroup::CARDINALITY_N_N, array(
+            new Option('from', '<FROM>', 'The path to mapping information.'),
+            new Option('dest', '<DEST>', 'The path to your entities.')
+        ));
+
+        $doc = $this->getDocumentation();
+        $doc->setName('generate-entity-stubs')
+            ->setDescription('Generate entity classes and method stubs from your mapping information.')
+            ->getOptionGroup()
+                ->addOption($options);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function validate()
+    {
+        $arguments = $this->getArguments();
+        $em = $this->getConfiguration()->getAttribute('em');
+
+        if ( ! isset($arguments['from']) || ! isset($arguments['dest'])) {
+            throw new CliException('You must specify a value for --from and --dest');
+        }
+
+        return true;
+    }
+
+    public function run()
+    {
+        $printer = $this->getPrinter();
+        $arguments = $this->getArguments();
+        $from = $arguments['from'];
+        $dest = realpath($arguments['dest']);
+
+        $generator = new EntityGenerator();
+        $generator->setGenerateAnnotations(true);
+        $generator->setGenerateStubMethods(true);
+        $generator->setRegenerateEntityIfExists(false);
+        $generator->setUpdateEntityIfExists(true);
+
+        if (isset($arguments['extend']) && $arguments['extend']) {
+            $generator->setClassToExtend($arguments['extend']);
+        }
+        
+        if (isset($arguments['num-spaces']) && $arguments['extend']) {
+            $generator->setNumSpaces($arguments['num-spaces']);
+        }
+
+        $type = $this->_determineSourceType($from);
+
+        if ( ! $type) {
+            throw new CliException(
+                "Invalid mapping source type '$sourceArg'."
+            );
+        }
+
+        $source = $this->_getSourceByType($type, $from);
+
+        $cme = new ClassMetadataExporter();
+        $cme->addMappingSource($source, $type);
+        $metadatas = $cme->getMetadatasForMappingSources();
+
+        $printer->writeln(
+            sprintf(
+                'Generating entity stubs for "%s" mapping information located at "%s" to "%s"', 
+                $printer->format($type, 'KEYWORD'),
+                $printer->format($from, 'KEYWORD'),
+                $printer->format($dest, 'KEYWORD')
+            )
+        );
+
+        $generator->generate($metadatas, $dest);
+    }
+}
\ No newline at end of file

tests/Doctrine/Tests/ORM/Tools/AllTests.php

@@ -26,6 +26,7 @@ class AllTests
         $suite->addTestSuite('Doctrine\Tests\ORM\Tools\Export\AnnotationClassMetadataExporterTest');
         $suite->addTestSuite('Doctrine\Tests\ORM\Tools\ConvertDoctrine1SchemaTest');
         $suite->addTestSuite('Doctrine\Tests\ORM\Tools\SchemaToolTest');
+        $suite->addTestSuite('Doctrine\Tests\ORM\Tools\EntityGeneratorTest');
 
         return $suite;
     }

tests/Doctrine/Tests/ORM/Tools/EntityGeneratorTest.php

+<?php
+
+namespace Doctrine\Tests\ORM\Tools;
+
+use Doctrine\ORM\Tools\SchemaTool,
+    Doctrine\ORM\Tools\EntityGenerator,
+    Doctrine\ORM\Tools\Export\ClassMetadataExporter,
+    Doctrine\ORM\Mapping\ClassMetadataInfo;
+
+require_once __DIR__ . '/../../TestInit.php';
+
+class EntityGeneratorTest extends \Doctrine\Tests\OrmTestCase
+{
+    public function testWriteEntityClass()
+    {
+        $metadata = new ClassMetadataInfo('EntityGeneratorBook');
+        $metadata->primaryTable['name'] = 'book';
+        $metadata->mapField(array('fieldName' => 'name', 'type' => 'varchar'));
+        $metadata->mapField(array('fieldName' => 'id', 'type' => 'integer', 'id' => true));
+        $metadata->mapOneToOne(array('fieldName' => 'other', 'targetEntity' => 'Other', 'mappedBy' => 'this'));
+        $joinColumns = array(
+            array('name' => 'other_id', 'referencedColumnName' => 'id')
+        );
+        $metadata->mapOneToOne(array('fieldName' => 'association', 'targetEntity' => 'Other', 'joinColumns' => $joinColumns));
+        $metadata->mapManyToMany(array(
+            'fieldName' => 'author',
+            'targetEntity' => 'Author',
+            'joinTable' => array(
+                'name' => 'book_author',
+                'joinColumns' => array(array('name' => 'bar_id', 'referencedColumnName' => 'id')),
+                'inverseJoinColumns' => array(array('name' => 'baz_id', 'referencedColumnName' => 'id')),
+            ),
+        ));
+        $metadata->setIdGeneratorType(ClassMetadataInfo::GENERATOR_TYPE_AUTO);
+
+        $generator = new EntityGenerator();
+        $generator->setGenerateAnnotations(true);
+        $generator->setGenerateStubMethods(true);
+        $generator->setRegenerateEntityIfExists(false);
+        $generator->setUpdateEntityIfExists(true);
+        $generator->writeEntityClass($metadata, __DIR__);
+
+        $path = __DIR__ . '/EntityGeneratorBook.php';
+        $this->assertTrue(file_exists($path));
+        require_once $path;
+    }
+
+    /**
+     * @depends testWriteEntityClass
+     */
+    public function testGeneratedEntityClassMethods()
+    {
+        $this->assertTrue(method_exists('\EntityGeneratorBook', 'getId'));
+        $this->assertTrue(method_exists('\EntityGeneratorBook', 'setName'));
+        $this->assertTrue(method_exists('\EntityGeneratorBook', 'getName'));
+        $this->assertTrue(method_exists('\EntityGeneratorBook', 'setOther'));
+        $this->assertTrue(method_exists('\EntityGeneratorBook', 'getOther'));
+        $this->assertTrue(method_exists('\EntityGeneratorBook', 'setAssociation'));
+        $this->assertTrue(method_exists('\EntityGeneratorBook', 'getAssociation'));
+        $this->assertTrue(method_exists('\EntityGeneratorBook', 'getAuthor'));
+        $this->assertTrue(method_exists('\EntityGeneratorBook', 'addAuthor'));
+
+        $book = new \EntityGeneratorBook();
+
+        $book->setName('Jonathan H. Wage');
+        $this->assertEquals('Jonathan H. Wage', $book->getName());
+
+        $book->setOther('Other');
+        $this->assertEquals('Other', $book->getOther());
+
+        $book->setAssociation('Test');
+        $this->assertEquals('Test', $book->getAssociation());
+
+        $book->addAuthor('Test');
+        $this->assertEquals(array('Test'), $book->getAuthor());
+
+        unlink(__DIR__ . '/EntityGeneratorBook.php');
+    }
+}
\ No newline at end of file