bug #847 Fix autowiring for legacy factory and repository (loic425)

This PR was merged into the 1.11 branch.

Discussion
----------

| Q               | A
| --------------- | -----
| Bug fix?        | yes (on 1.11)
| New feature?    | no
| BC breaks?      | no
| Deprecations?   | no
| Related tickets | 
| License         | MIT


Commits
-------

6d4b752 Fix autowiring for legacy factory and repository
f40b94e Trying to fix Psalm error
eff5a29 Fix coding standard
d637236 Fix PHPUnit tests
4804b19 Handle translatable factory bc-layer

Author: lchrusciel

psalm.xml

@@ -83,12 +83,6 @@
             </errorLevel>
         </InvalidArgument>
 
-        <InvalidDocblock>
-            <errorLevel type="suppress">
-                <file name="vendor/doctrine/orm/lib/Doctrine/ORM/EntityRepository.php" />
-            </errorLevel>
-        </InvalidDocblock>
-
         <InvalidReturnStatement>
             <errorLevel type="suppress">
                 <file name="src/Component/src/Doctrine/Persistence/InMemoryRepository.php" />

src/Bundle/DependencyInjection/Driver/AbstractDriver.php

@@ -13,6 +13,8 @@
 
 namespace Sylius\Bundle\ResourceBundle\DependencyInjection\Driver;
 
+use Sylius\Component\Resource\Factory\FactoryInterface as LegacyFactoryInterface;
+use Sylius\Component\Resource\Factory\TranslatableFactoryInterface as LegacyTranslatableFactoryInterface;
 use Sylius\Resource\Factory\Factory;
 use Sylius\Resource\Factory\TranslatableFactoryInterface;
 use Sylius\Resource\Metadata\Metadata;
@@ -120,10 +122,14 @@ protected function addFactory(ContainerBuilder $container, MetadataInterface $me
 
         $typehintClasses = array_merge(
             $factoryInterfaces,
-            [$factoryClass],
+            [$factoryClass, LegacyFactoryInterface::class],
             $factoryParents,
         );
 
+        if (in_array(TranslatableFactoryInterface::class, $factoryInterfaces, true)) {
+            $typehintClasses[] = LegacyTranslatableFactoryInterface::class;
+        }
+
         foreach ($typehintClasses as $typehintClass) {
             $container->registerAliasForArgument(
                 $metadata->getServiceId('factory'),

src/Bundle/DependencyInjection/Driver/Doctrine/DoctrineORMDriver.php

@@ -21,6 +21,7 @@
 use Doctrine\Persistence\ObjectManager;
 use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;
 use Sylius\Bundle\ResourceBundle\SyliusResourceBundle;
+use Sylius\Component\Resource\Repository\RepositoryInterface as LegacyRepositoryInterface;
 use Sylius\Resource\Metadata\MetadataInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
@@ -95,7 +96,7 @@ protected function addRepository(ContainerBuilder $container, MetadataInterface
 
         $typehintClasses = array_merge(
             $repositoryInterfaces,
-            [$repositoryClass],
+            [$repositoryClass, LegacyRepositoryInterface::class],
             $repositoryParents,
         );
 

tests/Application/config/services.yaml

@@ -80,6 +80,7 @@ services:
                 connection: default
 
     App\Repository\ComicBookRepository: null
+    App\Repository\LegacyBookRepository: null
 
     App\Shared\:
         resource: '../src/Shared'
@@ -92,3 +93,15 @@ services:
 
     App\Subscription\Factory\SubscriptionFactory:
         decorates: 'app.factory.subscription'
+
+    app.service.legacy_autowired_repository:
+        class: App\Service\LegacyAutowiredRepositoryService
+        autowire: true
+
+    app.service.legacy_autowired_factory:
+        class: App\Service\LegacyAutowiredFactoryService
+        autowire: true
+
+    app.service.legacy_autowired_translatable_factory:
+        class: App\Service\LegacyAutowiredTranslatableFactoryService
+        autowire: true

tests/Application/config/sylius/resources.yaml

@@ -29,6 +29,14 @@ sylius_resource:
             classes:
                 model: App\Entity\ComicBook
 
+        app.legacy_book:
+            classes:
+                model: App\Entity\LegacyBook
+                factory: App\Factory\LegacyBookFactory
+            translation:
+                classes:
+                    model: App\Entity\LegacyBookTranslation
+
         app.science_book:
             classes:
                 model: App\Entity\ScienceBook

tests/Application/src/Entity/LegacyBook.php

@@ -13,12 +13,13 @@
 
 namespace App\Entity;
 
+use App\Repository\LegacyBookRepository;
 use Doctrine\ORM\Mapping as ORM;
 use Sylius\Component\Resource\Model\ResourceInterface;
 use Sylius\Component\Resource\Model\TranslatableInterface;
 use Sylius\Component\Resource\Model\TranslatableTrait;
 
-#[ORM\Entity]
+#[ORM\Entity(repositoryClass: LegacyBookRepository::class)]
 #[ORM\MappedSuperclass]
 #[ORM\Table(name: 'app_legacy_book')]
 class LegacyBook implements ResourceInterface, TranslatableInterface

tests/Application/src/Factory/BookFactory.php

@@ -14,11 +14,12 @@
 namespace App\Factory;
 
 use Sylius\Component\Resource\Exception\UnexpectedTypeException;
+use Sylius\Component\Resource\Factory\FactoryInterface;
+use Sylius\Component\Resource\Factory\TranslatableFactoryInterface;
+use Sylius\Component\Resource\Model\TranslatableInterface;
 use Sylius\Component\Resource\Translation\Provider\TranslationLocaleProviderInterface;
-use Sylius\Resource\Factory\FactoryInterface;
-use Sylius\Resource\Model\TranslatableInterface;
 
-final class BookFactory implements BookFactoryInterface
+final class BookFactory implements TranslatableFactoryInterface
 {
     private FactoryInterface $factory;
 

tests/Application/src/Factory/LegacyBookFactory.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace App\Factory;
+
+use Sylius\Component\Resource\Exception\UnexpectedTypeException;
+use Sylius\Component\Resource\Translation\Provider\TranslationLocaleProviderInterface;
+use Sylius\Resource\Factory\FactoryInterface;
+use Sylius\Resource\Model\TranslatableInterface;
+
+final class LegacyBookFactory implements BookFactoryInterface
+{
+    private FactoryInterface $factory;
+
+    private TranslationLocaleProviderInterface $localeProvider;
+
+    public function __construct(FactoryInterface $factory, TranslationLocaleProviderInterface $localeProvider)
+    {
+        $this->factory = $factory;
+        $this->localeProvider = $localeProvider;
+    }
+
+    public function createNew()
+    {
+        $book = $this->factory->createNew();
+
+        if (!$book instanceof TranslatableInterface) {
+            throw new UnexpectedTypeException($book, TranslatableInterface::class);
+        }
+
+        $book->setCurrentLocale($this->localeProvider->getDefaultLocaleCode());
+        $book->setFallbackLocale($this->localeProvider->getDefaultLocaleCode());
+
+        return $book;
+    }
+}

tests/Application/src/Repository/LegacyBookRepository.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace App\Repository;
+
+use App\Entity\LegacyBook;
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Doctrine\Persistence\ManagerRegistry;
+use Sylius\Bundle\ResourceBundle\Doctrine\ORM\ResourceRepositoryTrait;
+use Sylius\Component\Resource\Repository\RepositoryInterface;
+
+final class LegacyBookRepository extends ServiceEntityRepository implements RepositoryInterface
+{
+    use ResourceRepositoryTrait;
+
+    public function __construct(ManagerRegistry $registry)
+    {
+        parent::__construct($registry, LegacyBook::class);
+    }
+}

tests/Application/src/Service/LegacyAutowiredFactoryService.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace App\Service;
+
+use Sylius\Component\Resource\Factory\FactoryInterface;
+
+final class LegacyAutowiredFactoryService
+{
+    public function __construct(
+        private FactoryInterface $legacyBookFactory,
+    ) {
+    }
+}