fix: TranslationService not available publicly; add: tests for TranslationService

Author: philipp-riddle

src/Command/TranslationReloadCommand.php

@@ -85,7 +85,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
  $io->success(sprintf('Yay, a total success! Added %s translations in total.', $translationsTotal));
 
  return 0;
- } 
+ }
 
  $io->error(sprintf('Uh oh. Something went wrong. Please try again in a few seconds (updated translations: %s)', $translationsTotal));
 

src/Resources/config/services.xml

@@ -14,12 +14,12 @@
  <argument>%googlesheets_translations.sheet.publicId%</argument>
  <argument>%googlesheets_translations.sheet.mode%</argument>
  </service>
- <service id="Phiil\GoogleSheetsTranslationBundle\Service\GoogleSheetsService" alias="phil_googlesheets_translations_bundle.googlesheets_service" public="false" />
+ <service id="Phiil\GoogleSheetsTranslationBundle\Service\GoogleSheetsService" alias="phil_googlesheets_translations_bundle.googlesheets_service" public="true" />
 
- <service id="phil_googlesheets_translations_bundle.translation_service" class="Phiil\GoogleSheetsTranslationBundle\Service\TranslationService" public="false">
+ <service id="phil_googlesheets_translations_bundle.translation_service" class="Phiil\GoogleSheetsTranslationBundle\Service\TranslationService" public="true">
  <argument type="service" id="Phiil\GoogleSheetsTranslationBundle\Service\GoogleSheetsService"/>
  </service>
- <service id="Phiil\GoogleSheetsTranslationBundle\Service\TranslationService" alias="phil_googlesheets_translations_bundle.translation_service" public="false" />
+ <service id="Phiil\GoogleSheetsTranslationBundle\Service\TranslationService" alias="phil_googlesheets_translations_bundle.translation_service" public="true" />
 
  <service id="phil_googlesheets_translations_bundle.translation_loader" class="Phiil\GoogleSheetsTranslationBundle\Translation\TranslationLoader" public="true">
  <argument type="service" id="Phiil\GoogleSheetsTranslationBundle\Service\GoogleSheetsService"/>

src/Service/TranslationService.php

@@ -3,23 +3,20 @@
 namespace Phiil\GoogleSheetsTranslationBundle\Service;
 
 use Phiil\GoogleSheetsTranslationBundle\Service\GoogleSheetsService;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 class TranslationService
 {
- private $sheetsService;
+ protected $sheetsService;
+ protected $translator;
 
  public function __construct(GoogleSheetsService $sheetsService)
  {
  $this->sheetsService = $sheetsService;
  }
 
- public function localeIsSupported($locale)
+ public function localeIsSupported(string $locale): bool
  {
  return in_array($locale, array_values($this->sheetsService->getLocales()));
  }
-
- public function trans($string)
- {
- return $this->translator->trans($string);
- }
 }

tests/Fixtures/PhiilSheetTestCase.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Phiil\GoogleSheetsTranslationBundle\Tests\Fixtures;
+
+class PhiilSheetTestCase extends PhiilTestCase
+{
+ protected function getContainer()
+ {
+ $kernel = new TestSheetKernel('test', true);
+ $kernel->boot();
+ 
+ return $kernel->getContainer();
+ }
+}

tests/Fixtures/TestSheetKernel.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Phiil\GoogleSheetsTranslationBundle\Tests\Fixtures;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class TestSheetKernel extends TestKernel
+{
+ /**
+ * Add kernel.secret because some packages depend on it
+ */
+ public function build(ContainerBuilder $container)
+ {
+ parent::build($container); // TODO: Change the autogenerated stub
+ $container->setParameter('googlesheets_translations.sheet.publicId', '1E9r6LCSeQV6rrEVq2YuSnm1OEbbTjgc50G9OHHUvihk');
+ }
+}

tests/Service/TranslationServiceTest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Phiil\GoogleSheetsTranslationBundle\Tests\Service;
+
+use Phiil\GoogleSheetsTranslationBundle\Service\TranslationService;
+use Phiil\GoogleSheetsTranslationBundle\Tests\Fixtures\PhiilSheetTestCase;
+
+class TranslationServiceTest extends PhiilSheetTestCase
+{
+ public function testLocaleIsSupported_supportedLocales()
+ {
+ $service = $this->_getService();
+
+ $this->assertTrue($service->localeIsSupported('en'), 'Translation service returned that locale "en" is not supported.');
+ $this->assertTrue($service->localeIsSupported('de'), 'Translation service returned that locale "de" is not supported.');
+ }
+
+ public function testLocaleIsSupported_unsupportedLocales()
+ {
+ $service = $this->_getService();
+
+ $this->assertFalse($service->localeIsSupported('cats'), 'Translation service returned that locale "cats" is supported.');
+ $this->assertFalse($service->localeIsSupported('nomnom'), 'Translation service returned that locale "nomnom" is supported.');
+ }
+
+ public function testLocaleIsSupported_emptyLocale()
+ {
+ $service = $this->_getService();
+
+ $this->assertFalse($service->localeIsSupported(''), 'Translation service returned that empty locale is supported.');
+ }
+
+ /**
+ * HELPER FUNCTIONS TO EXECUTE THE TESTS
+ */
+
+ private function _getService(): TranslationService
+ {
+ return $this->get('phil_googlesheets_translations_bundle.translation_service');
+ }
+}