Refactor on how to create translations

Runroom · May 26, 2021 · 97a9fad · 97a9fad
1 parent 445fa5f
commit 97a9fad
Show file tree

Hide file tree

Showing 13 changed files with 66 additions and 58 deletions.
diff --git a/packages/basic-page-bundle/src/Factory/BasicPageFactory.php b/packages/basic-page-bundle/src/Factory/BasicPageFactory.php
@@ -29,11 +29,20 @@ protected function getDefaults(): array
                 BasicPage::LOCATION_NONE,
             ]),
             'publish' => self::faker()->boolean(),
-            'translations' => BasicPageTranslationFactory::createMany(2),
             'metaInformation' => EntityMetaInformationFactory::createOne(),
         ];
     }
 
+    /** @param string[] $locales */
+    public function withTranslations(array $locales, array $defaultAttributes = []): self
+    {
+        return $this->addState([
+            'translations' => BasicPageTranslationFactory::createMany(count($locales), \array_merge($defaultAttributes, [
+                'locale' => self::faker()->unique()->randomElement($locales),
+            ])),
+        ]);
+    }
+
     protected static function getClass(): string
     {
         return BasicPage::class;

diff --git a/packages/basic-page-bundle/tests/Integration/BasicPageRepositoryTest.php b/packages/basic-page-bundle/tests/Integration/BasicPageRepositoryTest.php
@@ -15,7 +15,6 @@
 
 use Doctrine\ORM\NoResultException;
 use Runroom\BasicPageBundle\Factory\BasicPageFactory;
-use Runroom\BasicPageBundle\Factory\BasicPageTranslationFactory;
 use Runroom\BasicPageBundle\Repository\BasicPageRepository;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Zenstruck\Foundry\Test\Factories;
@@ -39,13 +38,9 @@ protected function setUp(): void
     /** @test */
     public function itFindsBasicPageGivenItsSlug(): void
     {
-        BasicPageFactory::createOne([
-            'translations' => BasicPageTranslationFactory::createMany(1, [
-                'locale' => 'en',
-                'slug' => 'slug',
-            ]),
-            'publish' => true,
-        ]);
+        BasicPageFactory::new(['publish' => true])->withTranslations(['en'], [
+            'slug' => 'slug',
+        ])->create();
 
         $basicPage = $this->repository->findBySlug('slug');
 

diff --git a/packages/basic-page-bundle/tests/Unit/BasicPageAlternateLinksProviderTest.php b/packages/basic-page-bundle/tests/Unit/BasicPageAlternateLinksProviderTest.php
@@ -47,11 +47,11 @@ public function itReturnsAvailableLocales(): void
     /** @test */
     public function itReturnsRouteParameters(): void
     {
-        $basicPage = BasicPageFactory::createOne()->object();
+        $basicPage = BasicPageFactory::new()->withTranslations(['en'])->create()->object();
         $model = new BasicPageViewModel();
         $model->setBasicPage($basicPage);
 
-        foreach ($basicPage->getTranslations()->getKeys() as $locale) {
+        foreach (['en'] as $locale) {
             self::assertSame(
                 ['slug' => $basicPage->translate($locale)->getSlug()],
                 $this->provider->getParameters($model, $locale)

diff --git a/packages/cookies-bundle/src/Factory/CookiesPageFactory.php b/packages/cookies-bundle/src/Factory/CookiesPageFactory.php
@@ -22,9 +22,17 @@ final class CookiesPageFactory extends ModelFactory
     /** @return array<string, mixed> */
     protected function getDefaults(): array
     {
-        return [
-            'translations' => CookiesPageTranslationFactory::createMany(2),
-        ];
+        return [];
+    }
+
+    /** @param string[] $locales */
+    public function withTranslations(array $locales, array $defaultAttributes = []): self
+    {
+        return $this->addState([
+            'translations' => CookiesPageTranslationFactory::createMany(count($locales), \array_merge($defaultAttributes, [
+                'locale' => self::faker()->unique()->randomElement($locales),
+            ])),
+        ]);
     }
 
     protected static function getClass(): string

diff --git a/packages/cookies-bundle/tests/Integration/CookiesPageRepositoryTest.php b/packages/cookies-bundle/tests/Integration/CookiesPageRepositoryTest.php
@@ -14,7 +14,6 @@
 namespace Runroom\CookiesBundle\Tests\Integration;
 
 use Runroom\CookiesBundle\Factory\CookiesPageFactory;
-use Runroom\CookiesBundle\Factory\CookiesPageTranslationFactory;
 use Runroom\CookiesBundle\Repository\CookiesPageRepository;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Zenstruck\Foundry\Test\Factories;
@@ -38,11 +37,7 @@ protected function setUp(): void
     /** @test */
     public function ifFindsCookiesPageById(): void
     {
-        CookiesPageFactory::createOne([
-            'translations' => CookiesPageTranslationFactory::createMany(1, [
-                'locale' => 'en',
-            ]),
-        ]);
+        CookiesPageFactory::new()->withTranslations(['en'])->create();
 
         $cookiesPage = $this->repository->find(1);
 

diff --git a/packages/seo-bundle/src/Factory/EntityMetaInformationFactory.php b/packages/seo-bundle/src/Factory/EntityMetaInformationFactory.php
@@ -22,9 +22,17 @@ final class EntityMetaInformationFactory extends ModelFactory
     /** @return array<string, mixed> */
     protected function getDefaults(): array
     {
-        return [
-            'translations' => EntityMetaInformationTranslationFactory::createMany(2),
-        ];
+        return [];
+    }
+
+    /** @param string[] $locales */
+    public function withTranslations(array $locales, array $defaultAttributes = []): self
+    {
+        return $this->addState([
+            'translations' => EntityMetaInformationTranslationFactory::createMany(count($locales), \array_merge($defaultAttributes, [
+                'locale' => self::faker()->unique()->randomElement($locales),
+            ])),
+        ]);
     }
 
     protected static function getClass(): string

diff --git a/packages/seo-bundle/src/Factory/MetaInformationFactory.php b/packages/seo-bundle/src/Factory/MetaInformationFactory.php
@@ -25,10 +25,19 @@ protected function getDefaults(): array
         return [
             'route' => self::faker()->unique()->word(),
             'routeName' => self::faker()->words(3, true),
-            'translations' => MetaInformationTranslationFactory::createMany(2),
         ];
     }
 
+    /** @param string[] $locales */
+    public function withTranslations(array $locales, array $defaultAttributes = []): self
+    {
+        return $this->addState([
+            'translations' => MetaInformationTranslationFactory::createMany(count($locales), \array_merge($defaultAttributes, [
+                'locale' => self::faker()->unique()->randomElement($locales),
+            ])),
+        ]);
+    }
+
     protected static function getClass(): string
     {
         return MetaInformation::class;

diff --git a/packages/seo-bundle/tests/Integration/MetaInformationRepositoryTest.php b/packages/seo-bundle/tests/Integration/MetaInformationRepositoryTest.php
@@ -14,7 +14,6 @@
 namespace Runroom\SeoBundle\Tests\Integration;
 
 use Runroom\SeoBundle\Factory\MetaInformationFactory;
-use Runroom\SeoBundle\Factory\MetaInformationTranslationFactory;
 use Runroom\SeoBundle\MetaInformation\MetaInformationBuilder;
 use Runroom\SeoBundle\Repository\MetaInformationRepository;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
@@ -39,12 +38,7 @@ protected function setUp(): void
     /** @test */
     public function itFindsDefaultMetaInformation(): void
     {
-        MetaInformationFactory::createOne([
-            'route' => MetaInformationBuilder::DEFAULT_ROUTE,
-            'translations' => MetaInformationTranslationFactory::createMany(1, [
-                'locale' => 'en',
-            ]),
-        ]);
+        MetaInformationFactory::new(['route' => MetaInformationBuilder::DEFAULT_ROUTE])->withTranslations(['en'])->create();
 
         $metaInformation = $this->repository->findOneBy(['route' => MetaInformationBuilder::DEFAULT_ROUTE]);
 

diff --git a/packages/seo-bundle/tests/Unit/EntityMetaInformationTest.php b/packages/seo-bundle/tests/Unit/EntityMetaInformationTest.php
@@ -15,7 +15,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Runroom\SeoBundle\Factory\EntityMetaInformationFactory;
-use Runroom\SeoBundle\Factory\MetaInformationTranslationFactory;
 use Zenstruck\Foundry\Test\Factories;
 
 class EntityMetaInformationTest extends TestCase
@@ -25,11 +24,7 @@ class EntityMetaInformationTest extends TestCase
     /** @test */
     public function itGetsProperties(): void
     {
-        $metaInformation = EntityMetaInformationFactory::createOne([
-            'translations' => MetaInformationTranslationFactory::createMany(1, [
-                'locale' => 'en',
-            ]),
-        ]);
+        $metaInformation = EntityMetaInformationFactory::new()->withTranslations(['en'])->create();
 
         self::assertNotEmpty((string) $metaInformation);
         self::assertNull($metaInformation->getId());

diff --git a/packages/seo-bundle/tests/Unit/MetaInformationBuilderTest.php b/packages/seo-bundle/tests/Unit/MetaInformationBuilderTest.php
@@ -16,7 +16,6 @@
 use PHPUnit\Framework\MockObject\Stub;
 use PHPUnit\Framework\TestCase;
 use Runroom\SeoBundle\Factory\MetaInformationFactory;
-use Runroom\SeoBundle\Factory\MetaInformationTranslationFactory;
 use Runroom\SeoBundle\MetaInformation\AbstractMetaInformationProvider;
 use Runroom\SeoBundle\MetaInformation\MetaInformationBuilder;
 use Runroom\SeoBundle\Repository\MetaInformationRepository;
@@ -49,13 +48,10 @@ public function itBuildsMetaInformationViewModel(): void
         $model = new \stdClass();
         $model->placeholder = 'test';
 
-        $metaInformation = MetaInformationFactory::createOne([
-            'translations' => MetaInformationTranslationFactory::createMany(1, [
-                'title' => '[placeholder] title',
-                'description' => '[missing] description',
-                'locale' => 'en',
-            ]),
-        ])->object();
+        $metaInformation = MetaInformationFactory::new()->withTranslations(['en'], [
+            'title' => '[placeholder] title',
+            'description' => '[missing] description',
+        ])->create()->object();
 
         $this->repository->method('findOneBy')->willReturn($metaInformation);
 

diff --git a/packages/translation-bundle/src/Factory/TranslationFactory.php b/packages/translation-bundle/src/Factory/TranslationFactory.php
@@ -24,10 +24,19 @@ protected function getDefaults(): array
     {
         return [
             'key' => self::faker()->unique()->word(),
-            'translations' => TranslationTranslationFactory::createMany(2),
         ];
     }
 
+    /** @param string[] $locales */
+    public function withTranslations(array $locales, array $defaultAttributes = []): self
+    {
+        return $this->addState([
+            'translations' => TranslationTranslationFactory::createMany(count($locales), \array_merge($defaultAttributes, [
+                'locale' => self::faker()->unique()->randomElement($locales),
+            ])),
+        ]);
+    }
+
     protected static function getClass(): string
     {
         return Translation::class;

diff --git a/packages/translation-bundle/tests/Integration/TranslationRepositoryTest.php b/packages/translation-bundle/tests/Integration/TranslationRepositoryTest.php
@@ -14,7 +14,6 @@
 namespace Runroom\TranslationBundle\Tests\Integration;
 
 use Runroom\TranslationBundle\Factory\TranslationFactory;
-use Runroom\TranslationBundle\Factory\TranslationTranslationFactory;
 use Runroom\TranslationBundle\Repository\TranslationRepository;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Zenstruck\Foundry\Test\Factories;
@@ -38,12 +37,7 @@ protected function setUp(): void
     /** @test */
     public function itFindsTranslationsByKey(): void
     {
-        TranslationFactory::createOne([
-            'key' => 'test',
-            'translations' => TranslationTranslationFactory::createMany(1, [
-                'locale' => 'en',
-            ]),
-        ]);
+        TranslationFactory::new(['key' => 'test'])->withTranslations(['en'])->create();
 
         $translation = $this->repository->findOneBy(['key' => 'test']);
 

diff --git a/packages/translation-bundle/tests/Unit/TranslationServiceTest.php b/packages/translation-bundle/tests/Unit/TranslationServiceTest.php
@@ -49,11 +49,7 @@ protected function setUp(): void
     /** @test */
     public function itReturnsAStringTranslatedByTheRepository(): void
     {
-        $translation = TranslationFactory::createOne([
-            'translations' => TranslationTranslationFactory::createMany(1, [
-                'locale' => 'en',
-            ]),
-        ]);
+        $translation = TranslationFactory::new(['key' => 'key'])->withTranslations(['en'])->create();
 
         $this->repository->method('findOneBy')->with(['key' => 'key'])->willReturn($translation);
         $this->translator->expects(self::never())->method('trans')->with('key', [], null, 'en');