Resolve minor code inspections (Case 183951) (#77)

- Fix grammar
- Split workflows to reduce indentation/complexity
- Improve tests: Add types, remove unnecessary expects-any constraint,
use class constant

Author: MalteWunsch

src/Doctrine/PersistentTranslatable.php

@@ -65,7 +65,7 @@ final class PersistentTranslatable implements TranslatableInterface
      * @param class-string          $class                 The class of the entity containing this PersistentTranslatable instance
      * @param object                $entity                The entity containing this PersistentTranslatable instance
      * @param string                $primaryLocale         The locale for which the translated value will be persisted in the "main" entity
-     * @param DefaultLocaleProvider $defaultLocaleProvider DefaultLocaleProvider that provides the locale to use when no explicit locale is passed to e. g. translate()
+     * @param DefaultLocaleProvider $defaultLocaleProvider DefaultLocaleProvider that provides the locale to use when no explicit locale is passed to e.g. translate()
      * @param ReflectionProperty    $translationProperty   ReflectionProperty pointing to the field in the translations class that holds the translated value to use
      * @param ReflectionProperty    $translationCollection ReflectionProperty pointing to the collection in the main class that holds translation instances
      * @param ReflectionClass       $translationClass      ReflectionClass for the class holding translated values

src/Doctrine/PolyglotListener.php

@@ -145,13 +145,13 @@ private function loadTranslationMetadataForClass($className, EntityManager $em):
                 $this->translatedClasses[$className] = null;
 
                 return null;
-            } else {
-                $wakeup = TranslatableClassMetadata::wakeup($data, $this->reflectionService);
-                $wakeup->setLogger($this->logger);
-                $this->translatedClasses[$className] = $wakeup;
-
-                return $wakeup;
             }
+
+            $wakeup = TranslatableClassMetadata::wakeup($data, $this->reflectionService);
+            $wakeup->setLogger($this->logger);
+            $this->translatedClasses[$className] = $wakeup;
+
+            return $wakeup;
         }
 
         // Load/parse

src/EventListener/LocaleListener.php

@@ -15,7 +15,7 @@
 use Webfactory\Bundle\PolyglotBundle\Locale\DefaultLocaleProvider;
 
 /**
- * This listeners sets the current locale for the TranslatableListener.
+ * This listener sets the current locale for the TranslatableListener.
  * Taken from Christophe COEVOET's Doctrine Extensions Bundle.
  *
  * @author Christophe COEVOET

tests/Doctrine/PersistentTranslatableTest.php

@@ -2,6 +2,7 @@
 
 namespace Webfactory\Bundle\PolyglotBundle\Tests\Doctrine;
 
+use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\UnitOfWork;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
@@ -17,7 +18,7 @@
 
 class PersistentTranslatableTest extends TestCase
 {
-    public function testToStringReturnsTranslatedMessage()
+    public function testToStringReturnsTranslatedMessage(): void
     {
         $entity = new TestEntity('foo');
         $proxy = $this->createProxy($entity);
@@ -31,7 +32,7 @@ public function testToStringReturnsTranslatedMessage()
         self::assertEquals('bar', $translation);
     }
 
-    public function testToStringReturnsStringIfExceptionOccurredAndNoLoggerIsAvailable()
+    public function testToStringReturnsStringIfExceptionOccurredAndNoLoggerIsAvailable(): void
     {
         $entity = new TestEntity('foo');
         $proxy = $this->createProxy($entity);
@@ -41,7 +42,7 @@ public function testToStringReturnsStringIfExceptionOccurredAndNoLoggerIsAvailab
         self::assertIsString($translation);
     }
 
-    public function testToStringReturnsStringIfExceptionOccurredAndLoggerIsAvailable()
+    public function testToStringReturnsStringIfExceptionOccurredAndLoggerIsAvailable(): void
     {
         $entity = new TestEntity('foo');
         $proxy = $this->createProxy($entity, new NullLogger());
@@ -51,7 +52,7 @@ public function testToStringReturnsStringIfExceptionOccurredAndLoggerIsAvailable
         self::assertIsString($translation);
     }
 
-    public function testToStringLogsExceptionIfLoggerIsAvailable()
+    public function testToStringLogsExceptionIfLoggerIsAvailable(): void
     {
         $entity = new TestEntity('foo');
 
@@ -64,7 +65,7 @@ public function testToStringLogsExceptionIfLoggerIsAvailable()
         self::assertGreaterThan(0, \count($logger->cleanLogs()), 'Expected at least one log message');
     }
 
-    public function testLoggedMessageContainsInformationAboutTranslatedProperty()
+    public function testLoggedMessageContainsInformationAboutTranslatedProperty(): void
     {
         $entity = new TestEntity('foo');
 
@@ -84,7 +85,7 @@ public function testLoggedMessageContainsInformationAboutTranslatedProperty()
         self::assertStringContainsString('de', $logMessage, 'Missing locale.');
     }
 
-    public function testLoggedMessageContainsOriginalException()
+    public function testLoggedMessageContainsOriginalException(): void
     {
         $entity = new TestEntity('foo');
 
@@ -103,7 +104,7 @@ public function testLoggedMessageContainsOriginalException()
     }
 
     /** @test */
-    public function isTranslatedInto_returns_true_for_primary_translation_if_set()
+    public function isTranslatedInto_returns_true_for_primary_translation_if_set(): void
     {
         $entity = new TestEntity('foo');
         $proxy = $this->createProxy($entity);
@@ -114,7 +115,7 @@ public function isTranslatedInto_returns_true_for_primary_translation_if_set()
     }
 
     /** @test */
-    public function isTranslatedInto_returns_true_for_translation_if_set()
+    public function isTranslatedInto_returns_true_for_translation_if_set(): void
     {
         $entity = new TestEntity('foo');
         $proxy = $this->createProxy($entity);
@@ -125,7 +126,7 @@ public function isTranslatedInto_returns_true_for_translation_if_set()
     }
 
     /** @test */
-    public function isTranslatedInto_returns_false_if_primary_translation_is_empty()
+    public function isTranslatedInto_returns_false_if_primary_translation_is_empty(): void
     {
         $entity = new TestEntity('foo');
         $proxy = $this->createProxy($entity);
@@ -137,7 +138,7 @@ public function isTranslatedInto_returns_false_if_primary_translation_is_empty()
     }
 
     /** @test */
-    public function isTranslatedInto_returns_false_if_translation_is_not_set()
+    public function isTranslatedInto_returns_false_if_translation_is_not_set(): void
     {
         $entity = new TestEntity('foo');
         $proxy = $this->createProxy($entity);
@@ -147,10 +148,7 @@ public function isTranslatedInto_returns_false_if_translation_is_not_set()
         self::assertFalse($proxy->isTranslatedInto('fr'));
     }
 
-    /**
-     * @return PersistentTranslatable
-     */
-    private function createProxy(TestEntity $entity, ?LoggerInterface $logger = null)
+    private function createProxy(TestEntity $entity, ?LoggerInterface $logger = null): PersistentTranslatable
     {
         $localeProvider = new DefaultLocaleProvider();
         $localeProvider->setDefaultLocale('de');
@@ -174,10 +172,10 @@ private function createProxy(TestEntity $entity, ?LoggerInterface $logger = null
         );
     }
 
-    private function breakEntity(TestEntity $entity)
+    private function breakEntity(TestEntity $entity): void
     {
-        $brokenCollection = $this->getMockBuilder('Doctrine\Common\Collections\ArrayCollection')->getMock();
-        $brokenCollection->expects($this->any())
+        $brokenCollection = $this->getMockBuilder(ArrayCollection::class)->getMock();
+        $brokenCollection
             ->method('matching')
             ->will($this->throwException(new RuntimeException('Cannot find translations')));
         $property = new ReflectionProperty($entity, 'translations');

tests/Fixtures/Entity/TestEntity.php

@@ -10,6 +10,7 @@
 namespace Webfactory\Bundle\PolyglotBundle\Tests\Fixtures\Entity;
 
 use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 use Webfactory\Bundle\PolyglotBundle\Attribute as Polyglot;
 use Webfactory\Bundle\PolyglotBundle\TranslatableInterface;
@@ -36,7 +37,7 @@ class TestEntity
 
     #[Polyglot\TranslationCollection]
     #[ORM\OneToMany(targetEntity: TestEntityTranslation::class, mappedBy: 'entity')] // This property is currently not typed to avoid an error in the \Webfactory\Bundle\PolyglotBundle\Tests\Doctrine\TranslatableClassMetadataTest::can_be_serialized_and_retrieved
-    private $translations;
+    private Collection $translations;
 
     public function __construct($text)
     {

tests/Fixtures/Entity/TestEntityTranslation.php

@@ -28,16 +28,11 @@ class TestEntityTranslation extends BaseTranslation
      * Contains the translation.
      *
      * Must be protected to be usable when this class is used as base for a mock.
-     *
-     * @var string
      */
     #[ORM\Column(type: 'string')]
-    protected $text;
+    protected ?string $text;
 
-    /**
-     * @param string|null $text
-     */
-    public function __construct($locale = null, $text = null, ?TestEntity $entity = null)
+    public function __construct($locale = null, ?string $text = null, ?TestEntity $entity = null)
     {
         $this->locale = $locale;
         $this->text = $text;

tests/Functional/TranslatingUnmappedPropertiesTest.php

@@ -12,7 +12,7 @@
  * This test covers that also properties which are not mapped Doctrine fields
  * can be marked as translatable and will be handled by the PolyglotListener.
  *
- * This is useful when these fields are managed or updated by e. g. lifecycle callbacks
+ * This is useful when these fields are managed or updated by e.g. lifecycle callbacks
  * or other Doctrine event listeners.
  */
 class TranslatingUnmappedPropertiesTest extends FunctionalTestBase

tests/Functional/UndeclaredBaseClassTest.php

@@ -85,7 +85,7 @@ public function testUpdateTranslations(): void
 
 /**
  * Fields in this class cannot be "private" - otherwise, they would not be picked up by the
- * Doctrine mapping drivers when processing the entity sub-class (UndeclaredBaseClassTest_EntityClass).
+ * Doctrine mapping drivers when processing the entity subclass (UndeclaredBaseClassTest_EntityClass).
  */
 class UndeclaredBaseClassTest_BaseClass
 {