feature #104 make:entity improved: interactive field created & entity update support (weaverryan)

This PR was squashed before being merged into the 1.0-dev branch (closes #104).

Discussion
----------

make:entity improved: interactive field created & entity update support

Hi guys!

The PR we (or at least me) have been waiting for :). This makes `make:entity` behave similar to `doctrine:generate:entity` from SensioGeneratorBundle: it interactively asks you for the field names and generates the getters/setters... but with some improved UX.

## Features:

* Ability to create new entities & fields
* Ability to update *existing* entities 🎆
* Support for adding *relations* (double 🎆)
* A `--regenerate` flag to add getters/setters for existing properties (replaces `doctrine:generate:entities`)
* Generates code that passes phpcs

Please help test! It's easy: [composer require details to for testing](https://gist.github.com/weaverryan/a20fc281ccd1faea2ea04a5da7fdaa55)

## Blocker 😢

We're using the newest version of `nikic/php-parser` heavily... but it only has a *beta* release so far :(. We need to wait until this is stable. OR, we need to remove it as a dependency temporarily, then throw an error to tell people to install it manually (at the beta version). :/ nikic/PHP-Parser#474

## Important notes:

* I bumped the min php version to 7.1 (from 7.0). This was so that we could consistently generated code using nullable types.

* Some of the code generated for relationships is opinionated. For example, I automatically synchronize (i.e. by calling the setter) the *owning* side if you set data on the inverse side of the relation. I also make all relation return types nullable (even if the relation is required in the db), to be friendly in case they're not set yet.

* The setters are not fluent. We *could* make them fluent, or make that an option on the bundle (i.e. one in a config file, not asked interactively)

![make:entity](https://i.imgur.com/Sflti0y.gif)

If you want to see the available type list (relations are now in this list, but not shown):

<img width="535" alt="screen shot 2018-01-08 at 3 09 32 pm" src="https://user-images.githubusercontent.com/121003/34690183-21f7498e-f486-11e7-9fcf-a5fe56d2a321.png">

I would love feedback! I added many little "features" to make the user experience as excellent as possible. But, I need users to help validate that!

Cheers!

Commits
-------

16596b1 updating tests for removed comment
01f6a3c Fixing a bug where a repository would not be generated under certain conditions
2f0e0f3 adding support for associative arrays in annotations
7d3042c Fixing bug where the name was always interactive
2a72ee3 Fixing cs
3b65fb6 Merge branch 'master' into make-entity-improved
e54988c Fixing issue where sometimes nullable is not defined on a join column
259141d removing comment - it does not add much value & is hard to keep in the right place
b0fed52 updating to stable nickic/php-parser 4.0 release!
7bcc966 Disabling replaceNodes to avoid possible AST accidental changes
613abef Adding an option (true by default) for fluent setter methods
8634a91 cs
9261cd1 Adding the "length" question for the string type
9c5a786 phpcs
328e486 fixing windows bug
92aeff5 playing with appveyor
b3647d7 attempting to split tests to combat windows testing issue
f022f5f Fixed window path bug while looking for the vendor/ dir
89d5708 trying to fix windows tests with long paths that cause errors :/
fd088ac temporarily debugging Windows errors
35ef3ae removing duplicate sqlite extension for appveyor
8c37893 Making appveyor use sqlite for simplicity
abbe8d9 Fixing windows bug where C:/ slash may already be normalized
20df636 Fixing a few Windows bugs
f9fa0db adding missing success message
38e6a0e Fixing missing return on --regenerate
1650301 Fixing missing method
fb74302 Fixing typo for class name
9c40654 added missing service
866e534 Extracting logic into AutoloaderUtil
05480da Fixing bug where new classes were never actually written in regenerator
e535f0d Adding an error if you try to generate a class that does not use annotation metadata
656c199 Fixing 2 merge bugs: entities could not be updated & mix up of entity vs repo class name
8d400e7 Fixing bug with getting property of classes just created
e8e5689 fix arg name
b8856c0 Code changes to sync with upstream updates
4afbc0e removing dup functions after merge
a34a1a2 Fixing "composer require orm orm" bug
5bc34bd removing unused use
d34ff45 also run phpcs on updated files
f370b52 fixing tests
5395788 Not setting the owning side (from inverse) on OneToOne
922563a clarifying note
ab03675 fixing missing return type
cf9e08a making decimal/scale more clear
0f2d52d Removing unnecessary service locator: just let the registry be null
1f57317 minor tweaks
d65d772 Fixing some tests
a822400 adding missing headers
dc7973d Fixing tests + one missing return
c3ccf5f Ask the user if they want the inverse side of a relation
2fd2e0c Making the user message a little nicer
663afee test needs database
c79b73c Fixes thanks to Stof!
6c914fa Removing debugging code, committing missing file to fix tests
4bde1dc With --overwrite, put updated methods in same location as original
ed15a2b temp debugging code for failing test on CI
dbe11a5 hack to fix tests temporarily
cd4f517 Fixing possible non-existent directory in tests
e52e33e Adding an enhanced make:entity command

Author: weaverryan

.gitignore

@@ -1,5 +1,5 @@
-composer.lock
-phpunit.xml
-vendor/
-tests/tmp/*
-.php_cs.cache
+/composer.lock
+/phpunit.xml
+/vendor/
+/tests/tmp/*
+/.php_cs.cache

.travis.yml

@@ -7,7 +7,6 @@ git:
     depth: 1
 
 php:
-  - 7.0
   - 7.1
   - 7.2
 

appveyor.yml

@@ -8,6 +8,9 @@ cache:
 init:
     - SET PATH=c:\php;%PATH%
 
+environment:
+    TEST_DATABASE_DSN: sqlite:///c:\projects\maker-bundle\tests\tmp\app.db
+
 install:
     - mkdir c:\php && cd c:\php
     - appveyor DownloadFile https://github.com/symfony/binary-utils/releases/download/v0.1/php-7.1.3-Win32-VC14-x86.zip
@@ -47,4 +50,6 @@ install:
     - ./vendor/bin/simple-phpunit install
 
 test_script:
-    - ./vendor/bin/simple-phpunit
+    - ./vendor/bin/simple-phpunit --group=functional_group1
+    - ./vendor/bin/simple-phpunit --group=functional_group2
+    - ./vendor/bin/simple-phpunit --exclude-group=functional_group1,functional_group2

composer.json

@@ -12,16 +12,21 @@
         }
     ],
     "require": {
-        "php": "^7.0.8",
+        "php": "^7.1.3",
+        "doctrine/inflector": "^1.2",
+        "nikic/php-parser": "^4.0",
         "symfony/config": "^3.4|^4.0",
         "symfony/console": "^3.4|^4.0",
         "symfony/dependency-injection": "^3.4|^4.0",
         "symfony/filesystem": "^3.4|^4.0",
+        "symfony/finder": "^3.4|^4.0",
         "symfony/framework-bundle": "^3.4|^4.0",
         "symfony/http-kernel": "^3.4|^4.0"
     },
     "require-dev": {
         "allocine/twigcs": "^3.0",
+        "doctrine/doctrine-bundle": "^1.8",
+        "doctrine/orm": "^2.6",
         "friendsofphp/php-cs-fixer": "^2.8",
         "symfony/phpunit-bridge": "^3.4|^4.0",
         "symfony/process": "^3.4|^4.0"

phpunit.xml.dist

@@ -9,6 +9,7 @@
 >
     <php>
         <ini name="error_reporting" value="-1" />
+        <env name="TEST_DATABASE_DSN" value="mysql://root:@127.0.0.1:3306/test_maker" />
     </php>
 
     <testsuites>

src/DependencyBuilder.php

@@ -113,7 +113,7 @@ private function getRequiredDependencyNames(array $dependencies)
             $packages[] = $package['name'];
         }
 
-        return $packages;
+        return array_unique($packages);
     }
 
     private function calculateMissingDependencies(array $dependencies)
@@ -134,6 +134,6 @@ private function calculateMissingDependencies(array $dependencies)
             return [];
         }
 
-        return array_merge($missingPackages, $missingOptionalPackages);
+        return array_unique(array_merge($missingPackages, $missingOptionalPackages));
     }
 }

src/Doctrine/BaseCollectionRelation.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle 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\Bundle\MakerBundle\Doctrine;
+
+use Symfony\Bundle\MakerBundle\Str;
+
+/**
+ * @internal
+ */
+abstract class BaseCollectionRelation extends BaseRelation
+{
+    abstract public function getOrphanRemoval(): bool;
+
+    abstract public function getTargetSetterMethodName(): string;
+
+    public function getAdderMethodName(): string
+    {
+        return 'add'.Str::asCamelCase(Str::pluralCamelCaseToSingular($this->getPropertyName()));
+    }
+
+    public function getRemoverMethodName(): string
+    {
+        return 'remove'.Str::asCamelCase(Str::pluralCamelCaseToSingular($this->getPropertyName()));
+    }
+}

src/Doctrine/BaseRelation.php

@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle 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\Bundle\MakerBundle\Doctrine;
+
+/**
+ * @internal
+ */
+abstract class BaseRelation
+{
+    private $propertyName;
+    private $targetClassName;
+    private $targetPropertyName;
+    private $mapInverseRelation = true;
+
+    abstract public function isOwning(): bool;
+
+    public function getPropertyName()
+    {
+        return $this->propertyName;
+    }
+
+    public function setPropertyName($propertyName)
+    {
+        $this->propertyName = $propertyName;
+
+        return $this;
+    }
+
+    public function getTargetClassName()
+    {
+        return $this->targetClassName;
+    }
+
+    public function setTargetClassName($targetClassName)
+    {
+        $this->targetClassName = $targetClassName;
+
+        return $this;
+    }
+
+    public function getTargetPropertyName()
+    {
+        return $this->targetPropertyName;
+    }
+
+    public function setTargetPropertyName(?string $targetPropertyName)
+    {
+        $this->targetPropertyName = $targetPropertyName;
+
+        return $this;
+    }
+
+    public function getMapInverseRelation(): bool
+    {
+        return $this->mapInverseRelation;
+    }
+
+    public function setMapInverseRelation(bool $mapInverseRelation)
+    {
+        $this->mapInverseRelation = $mapInverseRelation;
+
+        return $this;
+    }
+}

src/Doctrine/BaseSingleRelation.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle 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\Bundle\MakerBundle\Doctrine;
+
+/**
+ * @internal
+ */
+abstract class BaseSingleRelation extends BaseRelation
+{
+    private $isNullable;
+
+    public function isNullable(): bool
+    {
+        return $this->isNullable;
+    }
+
+    public function setIsNullable($isNullable)
+    {
+        $this->isNullable = $isNullable;
+
+        return $this;
+    }
+}

src/Doctrine/DoctrineMetadataFactory.php

@@ -12,6 +12,9 @@
 namespace Symfony\Bundle\MakerBundle\Doctrine;
 
 use Doctrine\Common\Persistence\ManagerRegistry;
+use Doctrine\Common\Persistence\Mapping\Driver\MappingDriver;
+use Doctrine\Common\Persistence\Mapping\Driver\MappingDriverChain;
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Tools\DisconnectedClassMetadataFactory;
 
@@ -55,12 +58,7 @@ public function getMetadataForNamespace($namespace)
         return $metadata;
     }
 
-    /**
-     * @param string $entity
-     *
-     * @return ClassMetadata|null
-     */
-    public function getMetadataForClass(string $entity)
+    public function getMetadataForClass(string $entity): ?ClassMetadata
     {
         foreach ($this->registry->getManagers() as $em) {
             $cmf = new DisconnectedClassMetadataFactory();
@@ -74,6 +72,30 @@ public function getMetadataForClass(string $entity)
         return null;
     }
 
+    public function getMappingDriverForClass(string $className): ?MappingDriver
+    {
+        /** @var EntityManagerInterface $em */
+        $em = $this->registry->getManagerForClass($className);
+
+        if (null === $em) {
+            throw new \InvalidArgumentException(sprintf('Cannot find the entity manager for class "%s"', $className));
+        }
+
+        $metadataDriver = $em->getConfiguration()->getMetadataDriverImpl();
+
+        if (!$metadataDriver instanceof MappingDriverChain) {
+            return $metadataDriver;
+        }
+
+        foreach ($metadataDriver->getDrivers() as $namespace => $driver) {
+            if (0 === strpos($className, $namespace)) {
+                return $driver;
+            }
+        }
+
+        return $metadataDriver->getDefaultDriver();
+    }
+
     /**
      * @return array
      */