Merge pull request #6 from andrew72ru/develop

Updates and refactoring

Author: andrew72ru

composer.json

@@ -12,31 +12,31 @@
   ],
   "require": {
     "php": "^7.2",
-    "doctrine/common": "^2.8",
+    "doctrine/common": "^2.12",
     "doctrine/doctrine-bundle": "^1.8|^2.0",
-    "doctrine/orm": "^2.6|^3.0",
-    "doctrine/persistence": "^1.0",
-    "ramsey/uuid": "^3.8 || ^4",
+    "doctrine/orm": "^2.7|^3.0",
+    "doctrine/persistence": "^1.3",
+    "ramsey/uuid": "^3.8|^4",
     "ramsey/uuid-doctrine": "^1.5",
-    "symfony/config": "^4.1|^5.0",
-    "symfony/dependency-injection": "^4.1|^5.0",
-    "symfony/doctrine-bridge": "^4.1|^5.0",
-    "symfony/finder": "^4.1|^5.0",
-    "symfony/framework-bundle": "^4.1|^5.0",
-    "symfony/polyfill-mbstring": "^1",
-    "symfony/translation": "^4.1|^5.0",
-    "symfony/twig-bridge": "^4.1|^5.0",
-    "symfony/twig-bundle": "^4.1|^5.0",
-    "twig/twig": "^2.4",
-    "symfony/yaml": "^4.1|^5.0"
+    "symfony/config": "^4.1|^5",
+    "symfony/dependency-injection": "^4.1|^5",
+    "symfony/doctrine-bridge": "^4.1|^5",
+    "symfony/finder": "^4.1|^5",
+    "symfony/framework-bundle": "^4.1|^5",
+    "symfony/polyfill-mbstring": "*",
+    "symfony/translation": "^4.1|^5",
+    "symfony/twig-bridge": "^4.1|^5",
+    "symfony/twig-bundle": "^4.1|^5",
+    "twig/twig": "^2.4|^3",
+    "symfony/yaml": "^4.1|^5"
   },
   "require-dev": {
     "phpunit/phpunit": "^8.1",
-    "symfony/console": "^4.1|^5.0",
-    "symfony/css-selector": "^4.1|^5.0",
-    "symfony/dom-crawler": "^4.1|^5.0",
-    "symfony/phpunit-bridge": "^4.1|^5.0",
-    "symfony/var-dumper": "^4.1|^5.0"
+    "symfony/console": "^4.1|^5",
+    "symfony/css-selector": "^4.1|^5",
+    "symfony/dom-crawler": "^4.1|^5",
+    "symfony/phpunit-bridge": "^4.1|^5",
+    "symfony/var-dumper": "^4.1|^5"
   },
   "extra": {
     "branch-alias": {

psalm.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="5"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/Command/MigrateToDatabaseCommand.php

@@ -16,7 +16,7 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
 use Symfony\Component\Translation\Translator;
 use Symfony\Contracts\Translation\TranslatorInterface;
 
@@ -47,7 +47,7 @@ class MigrateToDatabaseCommand extends Command
     protected static $defaultName = 'creative:db-i18n:migrate';
 
     /**
-     * @var ContainerInterface
+     * @var ParameterBagInterface
      */
     private $container;
 
@@ -74,17 +74,17 @@ class MigrateToDatabaseCommand extends Command
     /**
      * MigrateToDatabaseCommand constructor.
      *
-     * @param ContainerInterface  $container
-     * @param TranslatorInterface $translator
-     * @param ManagerRegistry     $doctrine
-     * @param string|null         $name
+     * @param ParameterBagInterface $container
+     * @param TranslatorInterface   $translator
+     * @param ManagerRegistry       $doctrine
+     * @param string|null           $name
      */
-    public function __construct(ContainerInterface $container, TranslatorInterface $translator, ManagerRegistry $doctrine, string $name = null)
+    public function __construct(ParameterBagInterface $container, TranslatorInterface $translator, ManagerRegistry $doctrine, string $name = null)
     {
         parent::__construct($name);
         $this->container = $container;
         $this->translator = $translator;
-        $this->entityClass = $this->container->getParameter('db_i18n.entity');
+        $this->entityClass = $this->container->get('db_i18n.entity');
         $this->doctrine = $doctrine;
     }
 
@@ -113,7 +113,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             throw new RuntimeException('Translator service of application has no \'getCatalogue\' method');
         }
 
-        if (!$this->container->hasParameter('locales') || !is_array($this->container->getParameter('locales'))) {
+        if (!$this->container->has('locales') || !is_array($this->container->get('locales'))) {
             throw new RuntimeException('Application container must have a \'locales\' parameter, and this parameter must be an array');
         }
 
@@ -125,7 +125,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $catalogue = $this->translator->getCatalogue($locale);
 
         $forExport = $catalogue->all($domain);
-        $exported = $this->exportToDatabase($forExport, $locale, $this->container->getParameter('db_i18n.domain'));
+        $exported = $this->exportToDatabase($forExport, $locale, $this->container->get('db_i18n.domain'));
 
         $io->writeln(sprintf(
             'Loaded form %s: %u messages, exported to database: %s',
@@ -210,7 +210,7 @@ protected function checkEntityExists(string $locale, string $key): EntityInterfa
      */
     protected function getLocale(string $filename): ?string
     {
-        $locales = $this->container->getParameter('locales');
+        $locales = $this->container->get('locales');
         $locale = null;
         foreach ($locales as $localeParam) {
             if (strpos($filename, $localeParam) !== false) {
@@ -236,7 +236,7 @@ protected function locateFile(string $path): string
         if (strpos($path, '/') === 0) {
             $realPath = $path;
         } else {
-            $realPath = $this->container->getParameter('kernel.root_dir') . '/../' . $path;
+            $realPath = $this->container->get('kernel.root_dir') . '/../' . $path;
         }
 
         if (!is_file($realPath) || !is_readable($realPath)) {

src/Loader/DbLoader.php

@@ -12,6 +12,7 @@
 use Creative\DbI18nBundle\Interfaces\TranslationRepositoryInterface;
 use Doctrine\Persistence\ManagerRegistry;
 use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
 use Symfony\Component\Translation\Exception\InvalidResourceException;
 use Symfony\Component\Translation\Exception\NotFoundResourceException;
 use Symfony\Component\Translation\Loader\LoaderInterface;
@@ -35,13 +36,13 @@ class DbLoader implements LoaderInterface, DbLoaderInterface
 
     /**
      * DbLoader constructor.
-     * @param ContainerInterface $container
-     * @param ManagerRegistry $doctrine
+     * @param ParameterBagInterface $container
+     * @param ManagerRegistry       $doctrine
      */
-    public function __construct(ContainerInterface $container, ManagerRegistry $doctrine)
+    public function __construct(ParameterBagInterface $container, ManagerRegistry $doctrine)
     {
         $this->doctrine = $doctrine;
-        $this->entityClass = $container->getParameter('db_i18n.entity');
+        $this->entityClass = $container->get('db_i18n.entity');
     }
 
     /**
@@ -56,7 +57,7 @@ public function __construct(ContainerInterface $container, ManagerRegistry $doct
      * @throws NotFoundResourceException when the resource cannot be found
      * @throws InvalidResourceException  when the resource cannot be loaded
      */
-    public function load($resource, $locale, $domain = 'messages')
+    public function load($resource, string $locale, string $domain = 'messages'): MessageCatalogue
     {
         $messages = $this->getRepository()->findByDomainAndLocale($domain, $locale);
 

src/Repository/TranslationRepository.php

@@ -3,9 +3,11 @@
 namespace Creative\DbI18nBundle\Repository;
 
 use Creative\DbI18nBundle\Entity\Translation;
+use Creative\DbI18nBundle\Interfaces\EntityInterface;
 use Creative\DbI18nBundle\Interfaces\TranslationRepositoryInterface;
 use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
 use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
 use Doctrine\Persistence\ManagerRegistry;
 
 /**
@@ -30,7 +32,8 @@ public function __construct(ManagerRegistry $registry)
      * @param string $domain
      * @param string $locale
      *
-     * @return array|\Creative\DbI18nBundle\Interfaces\EntityInterface[]|\Doctrine\Common\Collections\Collection|mixed
+     * @return EntityInterface[]|Collection
+     * @psalm-return Collection<array-key, EntityInterface[]>
      */
     public function findByDomainAndLocale(string $domain, string $locale)
     {

src/Resources/config/config.yaml

@@ -7,11 +7,16 @@ services:
     resource: '../../../src'
     exclude: '../../../src/{Entity,Resources}'
 
+  doctrine.orm.naming_strategy.underscore:
+    class: Doctrine\ORM\Mapping\UnderscoreNamingStrategy
+    arguments:
+      $numberAware: true
+
   translation.loader.db:
     class: Creative\DbI18nBundle\Loader\DbLoader
     public: '%kernel.debug%'
     arguments:
-      - '@service_container'
+      - '@parameter_bag'
       - '@doctrine'
     tags:
       - { name: translation.loader, alias: db }
@@ -23,7 +28,7 @@ services:
 
   Creative\DbI18nBundle\Command\MigrateToDatabaseCommand:
     arguments:
-      - '@service_container'
+      - '@parameter_bag'
       - '@translator.default'
       - '@doctrine'
     tags: [ console.command ]

tests/Kernel.php

@@ -29,13 +29,6 @@ public function registerBundles()
         ];
     }
 
-    /**
-     * @inheritDoc
-     */
-    protected function configureRoutes(\Symfony\Component\Routing\RouteCollectionBuilder $routes)
-    {
-    }
-
     /**
      * @inheritDoc
      */

tests/Loader/DbLoaderTest.php

@@ -19,7 +19,7 @@ class DbLoaderTest extends KernelTestCase
     public function testIsServiceConfigured(): void
     {
         self::bootKernel();
-        $this->assertInstanceOf(DbLoader::class, self::$container->get('translation.loader.db'));
+        self::assertInstanceOf(DbLoader::class, self::$container->get('translation.loader.db'));
     }
 
     protected function setUp(): void
@@ -51,7 +51,7 @@ public function testLoadCatalogue(): void
     {
         $service = self::$container->get('translation.loader.db');
         $cat = $service->load(null, 'en', 'db_messages');
-        $this->assertInstanceOf(MessageCatalogue::class, $cat);
-        $this->assertSame('This is a translation of key', $cat->get('translatable.key', 'db_messages'));
+        self::assertInstanceOf(MessageCatalogue::class, $cat);
+        self::assertSame('This is a translation of key', $cat->get('translatable.key', 'db_messages'));
     }
 }

tests/TranslationTest.php

@@ -25,53 +25,53 @@ public function setUp(): void
 
     public function testGetId()
     {
-        $this->assertNull($this->entity->getId());
+        self::assertNull($this->entity->getId());
     }
 
     public function testSetDomain()
     {
-        $this->assertInstanceOf(Translation::class, $this->entity->setDomain('domain'));
+        self::assertInstanceOf(Translation::class, $this->entity->setDomain('domain'));
     }
 
     public function testSetLocale()
     {
-        $this->assertInstanceOf(Translation::class, $this->entity->setLocale('ru'));
+        self::assertInstanceOf(Translation::class, $this->entity->setLocale('ru'));
     }
 
     public function testGetKey()
     {
-        $this->assertNull($this->entity->getKey());
+        self::assertNull($this->entity->getKey());
     }
 
     public function testGetDomain()
     {
-        $this->assertNull($this->entity->getDomain());
+        self::assertNull($this->entity->getDomain());
         $this->entity->setDomain('domain');
-        $this->assertEquals('domain', $this->entity->getDomain());
+        self::assertEquals('domain', $this->entity->getDomain());
     }
 
     public function testGetTranslation()
     {
-        $this->assertNull($this->entity->getTranslation());
+        self::assertNull($this->entity->getTranslation());
         $this->entity->setTranslation('translation');
-        $this->assertEquals('translation', $this->entity->getTranslation());
+        self::assertEquals('translation', $this->entity->getTranslation());
     }
 
     public function testGetLocale()
     {
-        $this->assertNull($this->entity->getLocale());
+        self::assertNull($this->entity->getLocale());
         $this->entity->setLocale('en');
-        $this->assertEquals('en', $this->entity->getLocale());
+        self::assertEquals('en', $this->entity->getLocale());
     }
 
     public function testSetTranslation()
     {
-        $this->assertInstanceOf(Translation::class, $this->entity->setTranslation('translation'));
+        self::assertInstanceOf(Translation::class, $this->entity->setTranslation('translation'));
     }
 
     public function testSetKey()
     {
-        $this->assertInstanceOf(Translation::class, $this->entity->setKey('key'));
+        self::assertInstanceOf(Translation::class, $this->entity->setKey('key'));
     }
 
     public function testLoad()
@@ -83,10 +83,10 @@ public function testLoad()
             'domain' => 'domain',
         ];
 
-        $this->assertInstanceOf(Translation::class, $this->entity->load($params));
-        $this->assertEquals('en', $this->entity->getLocale());
-        $this->assertEquals('key', $this->entity->getKey());
-        $this->assertEquals('translation', $this->entity->getTranslation());
-        $this->assertEquals('domain', $this->entity->getDomain());
+        self::assertInstanceOf(Translation::class, $this->entity->load($params));
+        self::assertEquals('en', $this->entity->getLocale());
+        self::assertEquals('key', $this->entity->getKey());
+        self::assertEquals('translation', $this->entity->getTranslation());
+        self::assertEquals('domain', $this->entity->getDomain());
     }
 }