Merge branch 'php-translation:master' into handle-icu-domain

Author: snpy

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [ '7.2', '7.3', '7.4', '8.0' ]
+        php: [ '7.2', '7.3', '7.4', '8.0', '8.1' ]
         strategy: [ 'highest' ]
         sf_version: ['']
         include:
@@ -43,4 +43,3 @@ jobs:
 
       - name: Run tests
         run: ./vendor/bin/simple-phpunit
-

Changelog.md

@@ -2,6 +2,24 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+## 0.12.4
+
+### Fixed
+
+- Fix extractor parameters #438
+- Make Profiler service an optional argument for SymfonyProfilerController #440
+- Update ExtractCommand.php #435
+- Fix tests on Symfony 5.3 #443
+- Suppress getMasterRequest() deprecation message #444
+- Suppress deprecations on deprecating legacy services #445
+- Fix PHPUnit deprecations #447
+- Fix broken tests #458
+- Register visitor tag also for TranslateAnnotationVisitor and Knp visitors #451
+
+### Removed
+
+- Drop SensioLabs (Symfony) insight badge #441
+
 ## 0.12.3
 
 ### Fixed

Command/ExtractCommand.php

@@ -140,6 +140,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     private function getConfiguredFinder(Configuration $config): Finder
     {
         $finder = new Finder();
+        $finder->sortByName();
         $finder->in($config->getDirs());
 
         foreach ($config->getExcludedDirs() as $exclude) {

Controller/EditInPlaceController.php

@@ -11,7 +11,6 @@
 
 namespace Translation\Bundle\Controller;
 
-use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
@@ -25,7 +24,7 @@
 /**
  * @author Damien Alexandre <dalexandre@jolicode.com>
  */
-class EditInPlaceController extends AbstractController
+class EditInPlaceController
 {
     private $storageManager;
     private $cacheClearer;

Controller/SymfonyProfilerController.php

@@ -11,30 +11,40 @@
 
 namespace Translation\Bundle\Controller;
 
-use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\HttpKernel\Profiler\Profiler;
+use Symfony\Component\Routing\Exception\RouteNotFoundException;
+use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Translation\DataCollector\TranslationDataCollector;
 use Symfony\Component\Translation\DataCollectorTranslator;
 use Symfony\Component\VarDumper\Cloner\Data;
 use Translation\Bundle\Model\SfProfilerMessage;
 use Translation\Bundle\Service\StorageService;
 use Translation\Common\Model\MessageInterface;
+use Twig\Environment;
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class SymfonyProfilerController extends AbstractController
+class SymfonyProfilerController
 {
-    private $storage;
+    /**
+     * @var Profiler An optional dependency
+     */
     private $profiler;
+    private $storage;
+    private $twig;
+    private $router;
     private $isToolbarAllowEdit;
 
-    public function __construct(StorageService $storage, Profiler $profiler, bool $isToolbarAllowEdit)
+    public function __construct(StorageService $storage, Environment $twig, RouterInterface $router, bool $isToolbarAllowEdit)
     {
         $this->storage = $storage;
-        $this->profiler = $profiler;
+        $this->twig = $twig;
+        $this->router = $router;
         $this->isToolbarAllowEdit = $isToolbarAllowEdit;
     }
 
@@ -45,18 +55,20 @@ public function editAction(Request $request, string $token): Response
         }
 
         if (!$request->isXmlHttpRequest()) {
-            return $this->redirectToRoute('_profiler', ['token' => $token]);
+            return $this->redirectToProfiler($token);
         }
 
         $message = $this->getMessage($request, $token);
 
         if ($request->isMethod('GET')) {
             $translation = $this->storage->syncAndFetchMessage($message->getLocale(), $message->getDomain(), $message->getKey());
 
-            return $this->render('@Translation/SymfonyProfiler/edit.html.twig', [
+            $content = $this->twig->render('@Translation/SymfonyProfiler/edit.html.twig', [
                 'message' => $translation,
                 'key' => $request->query->get('message_id'),
             ]);
+
+            return new Response($content);
         }
 
         //Assert: This is a POST request
@@ -69,7 +81,7 @@ public function editAction(Request $request, string $token): Response
     public function syncAction(Request $request, string $token): Response
     {
         if (!$request->isXmlHttpRequest()) {
-            return $this->redirectToRoute('_profiler', ['token' => $token]);
+            return $this->redirectToProfiler($token);
         }
 
         $sfMessage = $this->getMessage($request, $token);
@@ -88,7 +100,7 @@ public function syncAction(Request $request, string $token): Response
     public function syncAllAction(Request $request, string $token): Response
     {
         if (!$request->isXmlHttpRequest()) {
-            return $this->redirectToRoute('_profiler', ['token' => $token]);
+            return $this->redirectToProfiler($token);
         }
 
         $this->storage->sync();
@@ -104,7 +116,7 @@ public function syncAllAction(Request $request, string $token): Response
     public function createAssetsAction(Request $request, string $token): Response
     {
         if (!$request->isXmlHttpRequest()) {
-            return $this->redirectToRoute('_profiler', ['token' => $token]);
+            return $this->redirectToProfiler($token);
         }
 
         $messages = $this->getSelectedMessages($request, $token);
@@ -123,20 +135,20 @@ public function createAssetsAction(Request $request, string $token): Response
 
     private function getMessage(Request $request, string $token): SfProfilerMessage
     {
-        $this->profiler->disable();
+        $this->getProfiler()->disable();
 
         $messageId = (string) $request->request->get('message_id', $request->query->get('message_id'));
 
         $collectorMessages = $this->getMessages($token);
 
         if (!isset($collectorMessages[$messageId])) {
-            throw $this->createNotFoundException(\sprintf('No message with key "%s" was found.', $messageId));
+            throw new NotFoundHttpException(\sprintf('No message with key "%s" was found.', $messageId));
         }
         $message = SfProfilerMessage::create($collectorMessages[$messageId]);
 
         if (DataCollectorTranslator::MESSAGE_EQUALS_FALLBACK === $message->getState()) {
             /** @var \Symfony\Component\HttpKernel\DataCollector\RequestDataCollector */
-            $requestCollector = $this->profiler->loadProfile($token)->getCollector('request');
+            $requestCollector = $this->getProfiler()->loadProfile($token)->getCollector('request');
 
             $message
                 ->setLocale($requestCollector->getLocale())
@@ -152,7 +164,7 @@ private function getMessage(Request $request, string $token): SfProfilerMessage
      */
     protected function getSelectedMessages(Request $request, string $token): array
     {
-        $this->profiler->disable();
+        $this->getProfiler()->disable();
 
         /** @var string[] $selected */
         $selected = (array) $request->request->get('selected');
@@ -172,13 +184,13 @@ protected function getSelectedMessages(Request $request, string $token): array
 
     private function getMessages(string $token, string $profileName = 'translation'): array
     {
-        $profile = $this->profiler->loadProfile($token);
+        $profile = $this->getProfiler()->loadProfile($token);
 
         if (null === $dataCollector = $profile->getCollector($profileName)) {
-            throw $this->createNotFoundException("No collector with name \"$profileName\" was found.");
+            throw new NotFoundHttpException("No collector with name \"$profileName\" was found.");
         }
         if (!$dataCollector instanceof TranslationDataCollector) {
-            throw $this->createNotFoundException("Collector with name \"$profileName\" is not an instance of TranslationDataCollector.");
+            throw new NotFoundHttpException("Collector with name \"$profileName\" is not an instance of TranslationDataCollector.");
         }
 
         $messages = $dataCollector->getMessages();
@@ -189,4 +201,29 @@ private function getMessages(string $token, string $profileName = 'translation')
 
         return $messages;
     }
+
+    public function setProfiler(Profiler $profiler): void
+    {
+        $this->profiler = $profiler;
+    }
+
+    private function getProfiler(): Profiler
+    {
+        if (!$this->profiler) {
+            throw new \Exception('The "profiler" service is missing. Please, run "composer require symfony/web-profiler-bundle" first to use this feature.');
+        }
+
+        return $this->profiler;
+    }
+
+    private function redirectToProfiler(string $token): RedirectResponse
+    {
+        try {
+            $targetUrl = $this->router->generate('_profiler', ['token' => $token]);
+
+            return new RedirectResponse($targetUrl);
+        } catch (RouteNotFoundException $e) {
+            throw new \Exception('Route to profiler page not found. Please, run "composer require symfony/web-profiler-bundle" first to use this feature.');
+        }
+    }
 }

Controller/WebUIController.php

@@ -11,7 +11,6 @@
 
 namespace Translation\Bundle\Controller;
 
-use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
@@ -29,17 +28,19 @@
 use Translation\Common\Exception\StorageException;
 use Translation\Common\Model\Message;
 use Translation\Common\Model\MessageInterface;
+use Twig\Environment;
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class WebUIController extends AbstractController
+class WebUIController
 {
     private $configurationManager;
     private $catalogueFetcher;
     private $catalogueManager;
     private $storageManager;
     private $validator;
+    private $twig;
     private $locales;
     private $isWebUIEnabled;
     private $isWebUIAllowCreate;
@@ -52,6 +53,7 @@ public function __construct(
         CatalogueManager $catalogueManager,
         StorageManager $storageManager,
         ValidatorInterface $validator,
+        Environment $twig,
         array $locales,
         bool $isWebUIEnabled,
         bool $isWebUIAllowCreate,
@@ -63,6 +65,7 @@ public function __construct(
         $this->catalogueManager = $catalogueManager;
         $this->storageManager = $storageManager;
         $this->validator = $validator;
+        $this->twig = $twig;
         $this->locales = $locales;
         $this->isWebUIEnabled = $isWebUIEnabled;
         $this->isWebUIAllowCreate = $isWebUIAllowCreate;
@@ -107,7 +110,7 @@ public function indexAction(?string $configName = null): Response
             }
         }
 
-        return $this->render('@Translation/WebUI/index.html.twig', [
+        $content = $this->twig->render('@Translation/WebUI/index.html.twig', [
             'catalogues' => $catalogues,
             'catalogueSize' => $catalogueSize,
             'maxDomainSize' => $maxDomainSize,
@@ -116,6 +119,8 @@ public function indexAction(?string $configName = null): Response
             'configName' => $config->getName(),
             'configNames' => $this->configurationManager->getNames(),
         ]);
+
+        return new Response($content);
     }
 
     /**
@@ -137,7 +142,7 @@ public function showAction(string $configName, string $locale, string $domain):
             return \strcmp($a->getKey(), $b->getKey());
         });
 
-        return $this->render('@Translation/WebUI/show.html.twig', [
+        $content = $this->twig->render('@Translation/WebUI/show.html.twig', [
             'messages' => $messages,
             'domains' => $this->catalogueManager->getDomains(),
             'currentDomain' => $domain,
@@ -149,6 +154,8 @@ public function showAction(string $configName, string $locale, string $domain):
             'allow_delete' => $this->isWebUIAllowDelete,
             'file_base_path' => $this->fileBasePath,
         ]);
+
+        return new Response($content);
     }
 
     public function createAction(Request $request, string $configName, string $locale, string $domain): Response
@@ -177,9 +184,11 @@ public function createAction(Request $request, string $configName, string $local
             return new Response($e->getMessage(), Response::HTTP_BAD_REQUEST);
         }
 
-        return $this->render('@Translation/WebUI/create.html.twig', [
+        $content = $this->twig->render('@Translation/WebUI/create.html.twig', [
             'message' => $message,
         ]);
+
+        return new Response($content);
     }
 
     public function editAction(Request $request, string $configName, string $locale, string $domain): Response

DependencyInjection/TranslationExtension.php

@@ -47,9 +47,12 @@ public function load(array $configs, ContainerBuilder $container): void
         $configuration = new Configuration($container);
         $config = $this->processConfiguration($configuration, $configs);
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $legacyLoader = new Loader\PhpFileLoader($container, new FileLocator(__DIR__.'/../Resources/config/legacy'));
 
         $loader->load('services.yaml');
+        $legacyLoader->load('services.php');
         $loader->load('extractors.yaml');
+        $legacyLoader->load('extractors.php');
 
         // Add major version to extractor
         $container->getDefinition(FormTypeChoices::class)
@@ -74,6 +77,7 @@ public function load(array $configs, ContainerBuilder $container): void
 
         if ($config['edit_in_place']['enabled']) {
             $loader->load('edit_in_place.yaml');
+            $legacyLoader->load('edit_in_place.php');
             $this->enableEditInPlace($container, $config);
         }
 
@@ -89,6 +93,7 @@ public function load(array $configs, ContainerBuilder $container): void
         }
 
         $loader->load('console.yaml');
+        $legacyLoader->load('console.php');
     }
 
     /**