Merge branch 'master' of github.com:php-translation/symfony-bundle into Nyholm-patch-1

bocharsky-bw · bocharsky-bw · commit 7ebb1564e310 · 2019-06-26T10:45:26.000+03:00
diff --git a/.travis.yml b/.travis.yml
@@ -13,6 +13,7 @@ env:
   global:
     - TEST_COMMAND="composer test"
     - SYMFONY_PHPUNIT_VERSION="6.5"
+    - COMPOSER_MEMORY_LIMIT=-1
 
 matrix:
     fast_finish: true
@@ -35,7 +36,6 @@ matrix:
         - php: 7.2
           env: DEPENDENCIES="dunglas/symfony-lock:^4"
 
-
           # Latest commit to master
         - php: 7.2
           env: STABILITY="dev"
diff --git a/Command/DeleteObsoleteCommand.php b/Command/DeleteObsoleteCommand.php
@@ -28,7 +28,8 @@
  */
 class DeleteObsoleteCommand extends Command
 {
-    use BundleTrait, StorageTrait;
+    use BundleTrait;
+    use StorageTrait;
 
     protected static $defaultName = 'translation:delete-obsolete';
 
@@ -72,7 +73,7 @@ protected function configure()
             ->setName(self::$defaultName)
             ->setDescription('Delete all translations marked as obsolete.')
             ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
-            ->addArgument('locale', InputArgument::OPTIONAL, 'The locale ot use. If omitted, we use all configured locales.', null)
+            ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', null)
             ->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The bundle you want remove translations from.')
         ;
     }
diff --git a/Command/DownloadCommand.php b/Command/DownloadCommand.php
@@ -20,14 +20,14 @@
 use Translation\Bundle\Service\CacheClearer;
 use Translation\Bundle\Service\ConfigurationManager;
 use Translation\Bundle\Service\StorageManager;
-use Translation\Bundle\Model\Configuration;
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
 class DownloadCommand extends Command
 {
-    use BundleTrait, StorageTrait;
+    use BundleTrait;
+    use StorageTrait;
 
     protected static $defaultName = 'translation:download';
 
diff --git a/Command/ExtractCommand.php b/Command/ExtractCommand.php
@@ -89,7 +89,7 @@ protected function configure()
             ->setName(self::$defaultName)
             ->setDescription('Extract translations from source code.')
             ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
-            ->addArgument('locale', InputArgument::OPTIONAL, 'The locale ot use. If omitted, we use all configured locales.', false)
+            ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', false)
             ->addOption('hide-errors', null, InputOption::VALUE_NONE, 'If we should print error or not')
             ->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The bundle you want extract translations from.')
         ;
diff --git a/Command/StatusCommand.php b/Command/StatusCommand.php
@@ -68,9 +68,9 @@ protected function configure()
             ->setName(self::$defaultName)
             ->setDescription('Show status about your translations.')
             ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
-            ->addArgument('locale', InputArgument::OPTIONAL, 'The locale ot use. If omitted, we use all configured locales.', false)
+            ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', false)
             ->addOption('json', null, InputOption::VALUE_NONE, 'If we should output in Json format')
-            ->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The translations for bundle you want to check.')
+            ->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The bundle for which you want to check the translations.')
         ;
     }
 
diff --git a/Controller/WebUIController.php b/Controller/WebUIController.php
@@ -16,6 +16,7 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\Intl\Intl;
+use Symfony\Component\Intl\Locales;
 use Symfony\Component\Translation\MessageCatalogue;
 use Translation\Bundle\Exception\MessageValidationException;
 use Translation\Bundle\Service\StorageService;
@@ -250,7 +251,9 @@ private function getMessageFromRequest(Request $request)
     private function getLocale2LanguageMap()
     {
         $configuredLocales = $this->getParameter('php_translation.locales');
-        $names = Intl::getLocaleBundle()->getLocaleNames('en');
+        $names = class_exists(Locales::class)
+            ? Locales::getNames('en')
+            : Intl::getLocaleBundle()->getLocaleNames('en');
         $map = [];
         foreach ($configuredLocales as $l) {
             $map[$l] = isset($names[$l]) ? $names[$l] : $l;
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -187,7 +187,7 @@ private function addAutoTranslateNode(ArrayNodeDefinition $root)
             ->arrayNode('fallback_translation')
                 ->canBeEnabled()
                 ->children()
-                    ->enumNode('service')->values(['google', 'yandex'])->defaultValue('google')->end()
+                    ->enumNode('service')->values(['google', 'yandex', 'bing'])->defaultValue('google')->end()
                     ->scalarNode('api_key')->defaultNull()->end()
                 ->end()
             ->end()
diff --git a/Readme.md b/Readme.md
@@ -13,49 +13,56 @@
 
 ## Install
 
-Via Composer
+Install this bundle via Composer:
 
 ``` bash
 $ composer require php-translation/symfony-bundle
 ```
 
+If you're using [Symfony Flex][symfony_flex] - you're done! Symfony Flex will create default
+configuration for you, change it if needed. If you don't use Symfony Flex, you will need to do
+a few more simple steps.
+
+1. First, register the bundle:
+
 ```php
-class AppKernel extends Kernel
-{
-    public function registerBundles()
-    {
-        $bundles = array(
-            // ...
-            new Translation\Bundle\TranslationBundle(),
-        }
-    }
-}
+# config/bundles.php
+return [
+    // ...
+    Translation\Bundle\TranslationBundle::class => ['all' => true],
+];
 ```
 
-An example configuration looks like this: 
+2. Then, configure the bundle. An example configuration looks like this:
 
 ```yaml
-# config.yml
+# config/packages/php_translation.yaml
 translation:
-    locales: ["en", "sv"]
-    symfony_profiler: # must be placed in config_dev.yml
-        enabled: true
-    webui:
-        enabled: true
+    locales: ["en"]
     edit_in_place:
-        enabled: true
-        config_name: default # the first one or one of your configs
-        activator: php_translation.edit_in_place.activator
+        enabled: false
+        config_name: app
     configs:
         app:
-            dirs: ["%kernel.root_dir%/Resources/views", "%kernel.root_dir%/../src"]
-            output_dir: "%kernel.root_dir%/Resources/translations"
+            dirs: ["%kernel.project_dir%/templates", "%kernel.project_dir%/src"]
+            output_dir: "%kernel.project_dir%/translations"
             excluded_names: ["*TestCase.php", "*Test.php"]
             excluded_dirs: [cache, data, logs]
 ```
 
 ```yaml
-# routing_dev.yml
+# config/packages/dev/php_translation.yaml
+translation:
+    symfony_profiler:
+        enabled: true
+    webui:
+        enabled: true
+```
+
+3. And the last step, add new routes:
+
+```yaml
+# config/routes/dev/php_translation.yaml
 _translation_webui:
     resource: "@TranslationBundle/Resources/config/routing_webui.yml"
     prefix:  /admin
@@ -65,12 +72,15 @@ _translation_profiler:
 ```
 
 ```yaml
-# routing.yml
+# config/routes/php_translation.yaml
 _translation_edit_in_place:
     resource: '@TranslationBundle/Resources/config/routing_edit_in_place.yml'
     prefix:  /admin
 ```
 
 ## Documentation
 
-Read the full documentation at [http://php-translation.readthedocs.io](http://php-translation.readthedocs.io/en/latest/).
+Read the full documentation at [http://php-translation.readthedocs.io](https://php-translation.readthedocs.io/en/latest/).
+
+
+[symfony_flex]: https://github.com/symfony/flex
diff --git a/Resources/config/auto_translation.yml b/Resources/config/auto_translation.yml
@@ -23,3 +23,7 @@ services:
   php_translation.translator_service.yandex:
      class: Translation\Translator\Service\YandexTranslator
      arguments: ["%php_translation.translator_service.api_key%"]
+
+  php_translation.translator_service.bing:
+     class: Translation\Translator\Service\BingTranslator
+     arguments: ["%php_translation.translator_service.api_key%"]
diff --git a/Resources/views/SymfonyProfiler/translation.html.twig b/Resources/views/SymfonyProfiler/translation.html.twig
@@ -120,6 +120,10 @@
     {% include "@Translation/SymfonyProfiler/javascripts.html.twig" %}
 {% endblock %}
 
+{% block panel %}
+    {{ block('panelContent') }}
+{% endblock %}
+
 {% macro render_table(messages, checkedByDefault = false) %}
     <table>
         <thead>
diff --git a/Tests/Unit/Translator/EditInPlaceTranslatorTest.php b/Tests/Unit/Translator/EditInPlaceTranslatorTest.php
@@ -0,0 +1,106 @@
+<?php
+
+/*
+ * This file is part of the PHP Translation package.
+ *
+ * (c) PHP Translation team <tobias.nyholm@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Translation\Bundle\Tests\Unit\Translator;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Translation\Loader\ArrayLoader;
+use Symfony\Component\Translation\TranslatorInterface;
+use Translation\Bundle\EditInPlace\ActivatorInterface;
+use Translation\Bundle\Translator\EditInPlaceTranslator;
+
+/**
+ * @author Damien Alexandre <dalexandre@jolicode.com>
+ */
+final class EditInPlaceTranslatorTest extends TestCase
+{
+    public function testEnabled()
+    {
+        $symfonyTranslator = $this->getMockBuilder(TranslatorInterface::class)->getMock();
+
+        $request = new Request();
+        $requestStack = new RequestStack();
+        $requestStack->push($request);
+
+        $activator = new FakeActivator(true);
+        $service = new EditInPlaceTranslator($symfonyTranslator, $activator, $requestStack);
+
+        $this->assertSame(
+            '<x-trans data-key="messages|key" data-value="" data-plain="" data-domain="messages" data-locale=""></x-trans>',
+            $service->trans('key', [])
+        );
+    }
+
+    public function testDisabled()
+    {
+        $symfonyTranslator = $this->getMockBuilder(TranslatorInterface::class)->getMock();
+
+        $request = new Request();
+        $requestStack = new RequestStack();
+        $requestStack->push($request);
+
+        $activator = new FakeActivator(false);
+        $service = new EditInPlaceTranslator($symfonyTranslator, $activator, $requestStack);
+
+        $this->assertSame(
+            null,
+            $service->trans('key', [])
+        );
+    }
+
+    public function testHtmlTranslation()
+    {
+        $symfonyTranslator = new \Symfony\Component\Translation\Translator('en', null, null, true);
+        $symfonyTranslator->addLoader('array', new ArrayLoader());
+        $symfonyTranslator->addResource('array', ['foo' => 'Normal content.'], 'en');
+        $symfonyTranslator->addResource('array', ['bar' => 'Content with <b>HTML</b> in it.'], 'en');
+        $symfonyTranslator->addResource('array', ['bar.attr' => 'Content with <b class="alert">HTML</b> in it.'], 'en');
+
+        $request = new Request();
+        $requestStack = new RequestStack();
+        $requestStack->push($request);
+
+        $activator = new FakeActivator(true);
+        $service = new EditInPlaceTranslator($symfonyTranslator, $activator, $requestStack);
+
+        $this->assertSame(
+            '<x-trans data-key="messages|foo" data-value="Normal content." data-plain="Normal content." data-domain="messages" data-locale="en">Normal content.</x-trans>',
+            $service->trans('foo', [])
+        );
+
+        $this->assertSame(
+            '<x-trans data-key="messages|bar" data-value="Content with &lt;b&gt;HTML&lt;/b&gt; in it." data-plain="Content with &lt;b&gt;HTML&lt;/b&gt; in it." data-domain="messages" data-locale="en">Content with <b>HTML</b> in it.</x-trans>',
+            $service->trans('bar', [])
+        );
+
+        $this->assertSame(
+            '<x-trans data-key="messages|bar.attr" data-value="Content with &lt;b class=&quot;alert&quot;&gt;HTML&lt;/b&gt; in it." data-plain="Content with &lt;b class=&quot;alert&quot;&gt;HTML&lt;/b&gt; in it." data-domain="messages" data-locale="en">Content with <b class="alert">HTML</b> in it.</x-trans>',
+            $service->trans('bar.attr', [])
+        );
+    }
+}
+
+class FakeActivator implements ActivatorInterface
+{
+    private $enabled;
+
+    public function __construct($enabled = true)
+    {
+        $this->enabled = $enabled;
+    }
+
+    public function checkRequest(Request $request = null)
+    {
+        return $this->enabled;
+    }
+}
diff --git a/Tests/Unit/Twig/BaseTwigTestCase.php b/Tests/Unit/Twig/BaseTwigTestCase.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Translation\IdentityTranslator;
 use Symfony\Bridge\Twig\Extension\TranslationExtension as SymfonyTranslationExtension;
 use Translation\Bundle\Twig\TranslationExtension;
+use Twig\Loader\ArrayLoader;
 
 /**
  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
@@ -26,10 +27,13 @@ final protected function parse($file, $debug = false)
     {
         $content = file_get_contents(__DIR__.'/Fixture/'.$file);
 
-        $env = new \Twig_Environment(new \Twig_Loader_Array([]));
+        $loader = class_exists(ArrayLoader::class)
+            ? new ArrayLoader()
+            : new \Twig_Loader_Array([]);
+        $env = new \Twig_Environment($loader);
         $env->addExtension(new SymfonyTranslationExtension($translator = new IdentityTranslator(new MessageSelector())));
         $env->addExtension(new TranslationExtension($translator, $debug));
 
-        return $env->parse($env->tokenize(new \Twig_Source($content, null)))->getNode('body');
+        return $env->parse($env->tokenize(new \Twig_Source($content, '')))->getNode('body');
     }
 }
diff --git a/Translator/EditInPlaceTranslator.php b/Translator/EditInPlaceTranslator.php
@@ -76,8 +76,8 @@ public function trans($id, array $parameters = [], $domain = null, $locale = nul
         return sprintf('<x-trans data-key="%s|%s" data-value="%s" data-plain="%s" data-domain="%s" data-locale="%s">%s</x-trans>',
             $domain,
             $id,
-            $original,
-            $plain,
+            htmlspecialchars($original),
+            htmlspecialchars($plain),
             $domain,
             $locale,
             $original
diff --git a/composer.json b/composer.json
@@ -13,15 +13,16 @@
         "php": "^7.1",
         "symfony/framework-bundle": "^3.4 || ^4.0",
         "symfony/validator": "^3.4 || ^4.0",
-        "symfony/translation": "^3.4 || ^4.0",
+        "symfony/translation": "^3.4 || ^4.0,<4.2",
         "symfony/twig-bundle": "^3.4 || ^4.0",
         "symfony/finder": "^3.4 || ^4.0",
         "symfony/intl": "^3.4 || ^4.0",
 
         "php-translation/common": "^1.0",
         "php-translation/symfony-storage": "^1.0",
         "php-translation/extractor": "^1.3",
-        "nyholm/nsa": "^1.1"
+        "nyholm/nsa": "^1.1",
+        "twig/twig": "<1.39 || ^2.0,<2.8"
     },
     "require-dev": {
         "symfony/phpunit-bridge": "^4.2",
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -15,6 +15,7 @@
 
     <php>
         <env name="ENV" value="test" />
+        <env name="SYMFONY_DEPRECATIONS_HELPER" value="verbose=1" />
     </php>
 
     <formatter type="clover" usefile="false"/>

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,8 @@`
`28`	`28`	`*/`
`29`	`29`	`class DeleteObsoleteCommand extends Command`
`30`	`30`	`{`
`31`		`- use BundleTrait, StorageTrait;`
	`31`	`+ use BundleTrait;`
	`32`	`+ use StorageTrait;`
`32`	`33`
`33`	`34`	`protected static $defaultName = 'translation:delete-obsolete';`
`34`	`35`
`@@ -72,7 +73,7 @@ protected function configure()`
`72`	`73`	`->setName(self::$defaultName)`
`73`	`74`	`->setDescription('Delete all translations marked as obsolete.')`
`74`	`75`	`->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')`
`75`		`- ->addArgument('locale', InputArgument::OPTIONAL, 'The locale ot use. If omitted, we use all configured locales.', null)`
	`76`	`+ ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', null)`
`76`	`77`	`->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The bundle you want remove translations from.')`
`77`	`78`	`;`
`78`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ protected function configure()`
`89`	`89`	`->setName(self::$defaultName)`
`90`	`90`	`->setDescription('Extract translations from source code.')`
`91`	`91`	`->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')`
`92`		`- ->addArgument('locale', InputArgument::OPTIONAL, 'The locale ot use. If omitted, we use all configured locales.', false)`
	`92`	`+ ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', false)`
`93`	`93`	`->addOption('hide-errors', null, InputOption::VALUE_NONE, 'If we should print error or not')`
`94`	`94`	`->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The bundle you want extract translations from.')`
`95`	`95`	`;`
Original file line number	Diff line number	Diff line change
`@@ -68,9 +68,9 @@ protected function configure()`
`68`	`68`	`->setName(self::$defaultName)`
`69`	`69`	`->setDescription('Show status about your translations.')`
`70`	`70`	`->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')`
`71`		`- ->addArgument('locale', InputArgument::OPTIONAL, 'The locale ot use. If omitted, we use all configured locales.', false)`
	`71`	`+ ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', false)`
`72`	`72`	`->addOption('json', null, InputOption::VALUE_NONE, 'If we should output in Json format')`
`73`		`- ->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The translations for bundle you want to check.')`
	`73`	`+ ->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The bundle for which you want to check the translations.')`
`74`	`74`	`;`
`75`	`75`	`}`
`76`	`76`