feature #40575 [FrameworkBundle][HttpKernel][TwigBridge] Add an helper to generate fragments URL (dunglas)

This PR was squashed before being merged into the 5.3-dev branch.

Discussion
----------

[FrameworkBundle][HttpKernel][TwigBridge] Add an helper to generate fragments URL

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | no
| New feature?  | yes <!-- please update src/**/CHANGELOG.md files -->
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| Tickets       | Fix n/a
| License       | MIT
| Doc PR        | todo

This PR adds a new helper to generate raw fragment URL. Fragments will be useful to generate lazy frames with Symfony UX Turbo (symfony/ux#64). This will also be convenient when using hinclude, ESI etc in case you want full control over the generated HTML.
This is also more in sync with the new best practices we apply in the form component (generate the HTML by yourself instead of using Twig helpers hiding the HTML elements).

Example:

```html
<turbo-frame id="set_aside_tray" src="{{ fragment_uri(controller('Symfony\Bundle\FrameworkBundle\Controller', {template: "foo.html.twig"})) }}">
  <img src="/icons/spinner.gif">
</turbo-frame>
```

Commits
-------

5d29d76612 [FrameworkBundle][HttpKernel][TwigBridge] Add an helper to generate fragments URL

Author: chalasr

CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
 * Add a new `markAsPublic` method on `NotificationEmail` to change the `importance` context option to null after creation
+* Add a new `fragment_uri()` helper to generate the URI of a fragment
 
 5.3.0
 -----

Extension/HttpKernelExtension.php

@@ -30,6 +30,7 @@ public function getFunctions(): array
         return [
             new TwigFunction('render', [HttpKernelRuntime::class, 'renderFragment'], ['is_safe' => ['html']]),
             new TwigFunction('render_*', [HttpKernelRuntime::class, 'renderFragmentStrategy'], ['is_safe' => ['html']]),
+            new TwigFunction('fragment_uri', [HttpKernelRuntime::class, 'generateFragmentUri']),
             new TwigFunction('controller', static::class.'::controller'),
         ];
     }

Extension/HttpKernelRuntime.php

@@ -13,6 +13,7 @@
 
 use Symfony\Component\HttpKernel\Controller\ControllerReference;
 use Symfony\Component\HttpKernel\Fragment\FragmentHandler;
+use Symfony\Component\HttpKernel\Fragment\FragmentUriGeneratorInterface;
 
 /**
  * Provides integration with the HttpKernel component.
@@ -22,10 +23,12 @@
 final class HttpKernelRuntime
 {
     private $handler;
+    private $fragmentUriGenerator;
 
-    public function __construct(FragmentHandler $handler)
+    public function __construct(FragmentHandler $handler, FragmentUriGeneratorInterface $fragmentUriGenerator = null)
     {
         $this->handler = $handler;
+        $this->fragmentUriGenerator = $fragmentUriGenerator;
     }
 
     /**
@@ -54,4 +57,13 @@ public function renderFragmentStrategy(string $strategy, $uri, array $options =
     {
         return $this->handler->render($uri, $strategy, $options);
     }
+
+    public function generateFragmentUri(ControllerReference $controller, bool $absolute = false, bool $strict = true, bool $sign = true): string
+    {
+        if (null === $this->fragmentUriGenerator) {
+            throw new \LogicException(sprintf('An instance of "%s" must be provided to use "%s()".', FragmentUriGeneratorInterface::class, __METHOD__));
+        }
+
+        return $this->fragmentUriGenerator->generate($controller, null, $absolute, $strict, $sign);
+    }
 }

Tests/Extension/HttpKernelExtensionTest.php

@@ -14,11 +14,14 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Bridge\Twig\Extension\HttpKernelExtension;
 use Symfony\Bridge\Twig\Extension\HttpKernelRuntime;
+use Symfony\Bundle\FrameworkBundle\Controller\TemplateController;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Fragment\FragmentHandler;
 use Symfony\Component\HttpKernel\Fragment\FragmentRendererInterface;
+use Symfony\Component\HttpKernel\Fragment\FragmentUriGenerator;
+use Symfony\Component\HttpKernel\UriSigner;
 use Twig\Environment;
 use Twig\Loader\ArrayLoader;
 use Twig\RuntimeLoader\RuntimeLoaderInterface;
@@ -53,6 +56,37 @@ public function testUnknownFragmentRenderer()
         $renderer->render('/foo');
     }
 
+    public function testGenerateFragmentUri()
+    {
+        if (!class_exists(FragmentUriGenerator::class)) {
+            $this->markTestSkipped('HttpKernel 5.3+ is required');
+        }
+
+        $requestStack = new RequestStack();
+        $requestStack->push(Request::create('/'));
+
+        $fragmentHandler = new FragmentHandler($requestStack);
+        $fragmentUriGenerator = new FragmentUriGenerator('/_fragment', new UriSigner('s3cr3t'), $requestStack);
+
+        $kernelRuntime = new HttpKernelRuntime($fragmentHandler, $fragmentUriGenerator);
+
+        $loader = new ArrayLoader([
+            'index' => sprintf(<<<TWIG
+{{ fragment_uri(controller("%s::templateAction", {template: "foo.html.twig"})) }}
+TWIG
+            , TemplateController::class), ]);
+        $twig = new Environment($loader, ['debug' => true, 'cache' => false]);
+        $twig->addExtension(new HttpKernelExtension());
+
+        $loader = $this->createMock(RuntimeLoaderInterface::class);
+        $loader->expects($this->any())->method('load')->willReturnMap([
+            [HttpKernelRuntime::class, $kernelRuntime],
+        ]);
+        $twig->addRuntimeLoader($loader);
+
+        $this->assertSame('/_fragment?_hash=PP8%2FeEbn1pr27I9wmag%2FM6jYGVwUZ0l2h0vhh2OJ6CI%3D&amp;_path=template%3Dfoo.html.twig%26_format%3Dhtml%26_locale%3Den%26_controller%3DSymfonyBundleFrameworkBundleControllerTemplateController%253A%253AtemplateAction', $twig->render('index'));
+    }
+
     protected function getFragmentHandler($return)
     {
         $strategy = $this->createMock(FragmentRendererInterface::class);