[Contracts] Add Translation\TranslatorInterface + decouple symfony/validator from symfony/translation

Author: nicolas-grekas

CHANGELOG.md

@@ -5,6 +5,8 @@ CHANGELOG
 -----
 
  * Started using ICU parent locales as fallback locales.
+ * deprecated `TranslatorInterface` in favor of `Symfony\Contracts\Translation\TranslatorInterface`
+ * deprecated `MessageSelector`, `Interval` and `PluralizationRules`; use `IdentityTranslator` instead
 
 4.1.0
 -----

DataCollectorTranslator.php

@@ -12,11 +12,13 @@
 namespace Symfony\Component\Translation;
 
 use Symfony\Component\Translation\Exception\InvalidArgumentException;
+use Symfony\Component\Translation\TranslatorInterface as LegacyTranslatorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 /**
  * @author Abdellatif Ait boudad <[email protected]>
  */
-class DataCollectorTranslator implements TranslatorInterface, TranslatorBagInterface
+class DataCollectorTranslator implements LegacyTranslatorInterface, TranslatorBagInterface
 {
     const MESSAGE_DEFINED = 0;
     const MESSAGE_MISSING = 1;

Formatter/MessageFormatter.php

@@ -11,21 +11,29 @@
 
 namespace Symfony\Component\Translation\Formatter;
 
+use Symfony\Component\Translation\IdentityTranslator;
 use Symfony\Component\Translation\MessageSelector;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 /**
  * @author Abdellatif Ait boudad <[email protected]>
  */
 class MessageFormatter implements MessageFormatterInterface, ChoiceMessageFormatterInterface
 {
-    private $selector;
+    private $translator;
 
     /**
-     * @param MessageSelector|null $selector The message selector for pluralization
+     * @param TranslatorInterface|null $translator An identity translator to use as selector for pluralization
      */
-    public function __construct(MessageSelector $selector = null)
+    public function __construct($translator = null)
     {
-        $this->selector = $selector ?: new MessageSelector();
+        if ($translator instanceof MessageSelector) {
+            $translator = new IdentityTranslator($translator);
+        } elseif (null !== $translator && !$translator instanceof TranslatorInterface) {
+            throw new \TypeError(sprintf('Argument 1 passed to %s() must be an instance of %s, %s given.', __METHOD__, TranslatorInterface::class, \is_object($translator) ? \get_class($translator) : \gettype($translator)));
+        }
+
+        $this->translator = $translator ?? new IdentityTranslator();
     }
 
     /**
@@ -43,6 +51,6 @@ public function choiceFormat($message, $number, $locale, array $parameters = arr
     {
         $parameters = array_merge(array('%count%' => $number), $parameters);
 
-        return $this->format($this->selector->choose($message, (int) $number, $locale), $locale, $parameters);
+        return $this->format($this->translator->transChoice($message, $number, array(), null, $locale), $locale, $parameters);
     }
 }

IdentityTranslator.php

@@ -11,53 +11,47 @@
 
 namespace Symfony\Component\Translation;
 
+use Symfony\Contracts\Translation\TranslatorTrait;
+
 /**
  * IdentityTranslator does not translate anything.
  *
  * @author Fabien Potencier <[email protected]>
  */
 class IdentityTranslator implements TranslatorInterface
 {
+    use TranslatorTrait {
+        transChoice as private doTransChoice;
+    }
+
     private $selector;
-    private $locale;
 
     /**
      * @param MessageSelector|null $selector The message selector for pluralization
      */
     public function __construct(MessageSelector $selector = null)
     {
-        $this->selector = $selector ?: new MessageSelector();
-    }
+        $this->selector = $selector;
 
-    /**
-     * {@inheritdoc}
-     */
-    public function setLocale($locale)
-    {
-        $this->locale = $locale;
+        if (\get_class($this) !== __CLASS__) {
+            @trigger_error(sprintf('Calling "%s()" is deprecated since Symfony 4.2.'), E_USER_DEPRECATED);
+        }
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getLocale()
+    public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null)
     {
-        return $this->locale ?: \Locale::getDefault();
-    }
+        if ($this->selector) {
+            return strtr($this->selector->choose((string) $id, (int) $number, $locale ?: $this->getLocale()), $parameters);
+        }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function trans($id, array $parameters = array(), $domain = null, $locale = null)
-    {
-        return strtr((string) $id, $parameters);
+        return $this->doTransChoice($id, $number, $parameters, $domain, $locale);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null)
+    private function getPluralizationRule(int $number, string $locale): int
     {
-        return strtr($this->selector->choose((string) $id, (int) $number, $locale ?: $this->getLocale()), $parameters);
+        return PluralizationRules::get($number, $locale, false);
     }
 }

Interval.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Translation;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.2, use IdentityTranslator instead.', Interval::class), E_USER_DEPRECATED);
+
 use Symfony\Component\Translation\Exception\InvalidArgumentException;
 
 /**
@@ -32,6 +34,7 @@
  * @author Fabien Potencier <[email protected]>
  *
  * @see    http://en.wikipedia.org/wiki/Interval_%28mathematics%29#The_ISO_notation
+ * @deprecated since Symfony 4.2, use IdentityTranslator instead
  */
 class Interval
 {

LoggingTranslator.php

@@ -13,11 +13,13 @@
 
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Translation\Exception\InvalidArgumentException;
+use Symfony\Component\Translation\TranslatorInterface as LegacyTranslatorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
 
 /**
  * @author Abdellatif Ait boudad <[email protected]>
  */
-class LoggingTranslator implements TranslatorInterface, TranslatorBagInterface
+class LoggingTranslator implements LegacyTranslatorInterface, TranslatorBagInterface
 {
     /**
      * @var TranslatorInterface|TranslatorBagInterface

MessageSelector.php

@@ -11,13 +11,17 @@
 
 namespace Symfony\Component\Translation;
 
+@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.2, use IdentityTranslator instead.', MessageSelector::class), E_USER_DEPRECATED);
+
 use Symfony\Component\Translation\Exception\InvalidArgumentException;
 
 /**
  * MessageSelector.
  *
  * @author Fabien Potencier <[email protected]>
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @deprecated since Symfony 4.2, use IdentityTranslator instead.
  */
 class MessageSelector
 {

PluralizationRules.php

@@ -15,6 +15,8 @@
  * Returns the plural rules for a given locale.
  *
  * @author Fabien Potencier <[email protected]>
+ *
+ * @deprecated since Symfony 4.2, use IdentityTranslator instead
  */
 class PluralizationRules
 {
@@ -28,8 +30,12 @@ class PluralizationRules
      *
      * @return int The plural position
      */
-    public static function get($number, $locale)
+    public static function get($number, $locale/*, bool $triggerDeprecation = true*/)
     {
+        if (3 > \func_num_args() || \func_get_arg(2)) {
+            @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.2.', __CLASS__), E_USER_DEPRECATED);
+        }
+
         if ('pt_BR' === $locale) {
             // temporary set a locale for brazilian
             $locale = 'xbr';
@@ -196,6 +202,8 @@ public static function get($number, $locale)
      */
     public static function set(callable $rule, $locale)
     {
+        @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.2.', __CLASS__), E_USER_DEPRECATED);
+
         if ('pt_BR' === $locale) {
             // temporary set a locale for brazilian
             $locale = 'xbr';

Tests/IdentityTranslatorTest.php

@@ -11,86 +11,13 @@
 
 namespace Symfony\Component\Translation\Tests;
 
-use PHPUnit\Framework\TestCase;
-use Symfony\Component\Intl\Util\IntlTestHelper;
 use Symfony\Component\Translation\IdentityTranslator;
+use Symfony\Contracts\Tests\Translation\TranslatorTest;
 
-class IdentityTranslatorTest extends TestCase
+class IdentityTranslatorTest extends TranslatorTest
 {
-    /**
-     * @dataProvider getTransTests
-     */
-    public function testTrans($expected, $id, $parameters)
+    public function getTranslator()
     {
-        $translator = new IdentityTranslator();
-
-        $this->assertEquals($expected, $translator->trans($id, $parameters));
-    }
-
-    /**
-     * @dataProvider getTransChoiceTests
-     */
-    public function testTransChoiceWithExplicitLocale($expected, $id, $number, $parameters)
-    {
-        $translator = new IdentityTranslator();
-        $translator->setLocale('en');
-
-        $this->assertEquals($expected, $translator->transChoice($id, $number, $parameters));
-    }
-
-    /**
-     * @dataProvider getTransChoiceTests
-     */
-    public function testTransChoiceWithDefaultLocale($expected, $id, $number, $parameters)
-    {
-        \Locale::setDefault('en');
-
-        $translator = new IdentityTranslator();
-
-        $this->assertEquals($expected, $translator->transChoice($id, $number, $parameters));
-    }
-
-    public function testGetSetLocale()
-    {
-        $translator = new IdentityTranslator();
-        $translator->setLocale('en');
-
-        $this->assertEquals('en', $translator->getLocale());
-    }
-
-    public function testGetLocaleReturnsDefaultLocaleIfNotSet()
-    {
-        // in order to test with "pt_BR"
-        IntlTestHelper::requireFullIntl($this, false);
-
-        $translator = new IdentityTranslator();
-
-        \Locale::setDefault('en');
-        $this->assertEquals('en', $translator->getLocale());
-
-        \Locale::setDefault('pt_BR');
-        $this->assertEquals('pt_BR', $translator->getLocale());
-    }
-
-    public function getTransTests()
-    {
-        return array(
-            array('Symfony is great!', 'Symfony is great!', array()),
-            array('Symfony is awesome!', 'Symfony is %what%!', array('%what%' => 'awesome')),
-        );
-    }
-
-    public function getTransChoiceTests()
-    {
-        return array(
-            array('There are no apples', '{0} There are no apples|{1} There is one apple|]1,Inf] There are %count% apples', 0, array('%count%' => 0)),
-            array('There is one apple', '{0} There are no apples|{1} There is one apple|]1,Inf] There are %count% apples', 1, array('%count%' => 1)),
-            array('There are 10 apples', '{0} There are no apples|{1} There is one apple|]1,Inf] There are %count% apples', 10, array('%count%' => 10)),
-            array('There are 0 apples', 'There is 1 apple|There are %count% apples', 0, array('%count%' => 0)),
-            array('There is 1 apple', 'There is 1 apple|There are %count% apples', 1, array('%count%' => 1)),
-            array('There are 10 apples', 'There is 1 apple|There are %count% apples', 10, array('%count%' => 10)),
-            // custom validation messages may be coded with a fixed value
-            array('There are 2 apples', 'There are 2 apples', 2, array('%count%' => 2)),
-        );
+        return new IdentityTranslator();
     }
 }

Tests/IntervalTest.php

@@ -14,6 +14,9 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Translation\Interval;
 
+/**
+ * @group legacy
+ */
 class IntervalTest extends TestCase
 {
     /**