minor #1814 [Site] Add robots.txt & sitemap.xml (smnandre)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[Site] Add robots.txt & sitemap.xml

Commits
-------

446ff5c [Site] Add robots.txt & sitemap.xml

Author: kbond

ux.symfony.com/php.ini

@@ -1,5 +1,4 @@
 allow_url_include=off
-assert.active=off
 display_errors=off
 display_startup_errors=off
 max_execution_time=30

ux.symfony.com/src/Controller/MainController.php

@@ -14,6 +14,7 @@
 use App\Model\RecipeFileTree;
 use App\Service\UxPackageRepository;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
 
@@ -29,4 +30,13 @@ public function homepage(UxPackageRepository $packageRepository): Response
             'recipeFileTree' => new RecipeFileTree(),
         ]);
     }
+
+    #[Route(path: '/robots.txt', name: 'app_robots')]
+    public function __invoke(Request $request): Response
+    {
+        $response = $this->render('robots.txt.twig');
+        $response->headers->set('Content-Type', 'text/plain');
+
+        return $response;
+    }
 }

ux.symfony.com/src/Controller/SitemapController.php

@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Controller;
+
+use App\Service\LiveDemoRepository;
+use App\Service\UxPackageRepository;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+final class SitemapController extends AbstractController
+{
+    public function __construct(
+        private readonly UxPackageRepository $uxPackageRepository,
+        private readonly LiveDemoRepository $liveDemoRepository,
+    ) {
+    }
+
+    #[Route(path: '/sitemap.xml', name: 'app_sitemap')]
+    public function __invoke(Request $request): Response
+    {
+        $response = $this->render('sitemap.xml.twig', [
+            'urls' => $this->getSitemapUrls(),
+        ]);
+        $response->headers->set('Content-Type', 'application/xml');
+
+        return $response;
+    }
+
+    /**
+     * @return iterable<string>
+     */
+    private function getSitemapUrls(): iterable
+    {
+        // Static pages
+        yield $this->generateAbsoluteUrl('app_homepage');
+        yield $this->generateAbsoluteUrl('app_packages');
+        yield $this->generateAbsoluteUrl('app_icons');
+        yield $this->generateAbsoluteUrl('app_demos');
+        yield $this->generateAbsoluteUrl('app_changelog');
+
+        // UX Packages
+        foreach ($this->uxPackageRepository->findAll() as $package) {
+            yield $this->generateAbsoluteUrl($package->getRoute());
+        }
+
+        // Live Demos
+        foreach ($this->liveDemoRepository->findAll() as $demo) {
+            yield $this->generateAbsoluteUrl($demo->getRoute());
+        }
+    }
+
+    private function generateAbsoluteUrl(string $route, array $parameters = []): string
+    {
+        return $this->generateUrl($route, $parameters, UrlGeneratorInterface::ABSOLUTE_URL);
+    }
+}

ux.symfony.com/templates/robots.txt.twig

@@ -0,0 +1,4 @@
+User-agent: *
+Disallow:
+
+Sitemap: {{ url('app_sitemap') }}

ux.symfony.com/templates/sitemap.xml.twig

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
+    {%- for url in urls ~%}
+        <url>
+            <loc>{{ url }}</loc>
+        </url>
+    {%- endfor ~%}
+</urlset>

ux.symfony.com/tests/Functional/RobotsTest.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Functional;
+
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Zenstruck\Browser\Test\HasBrowser;
+
+class RobotsTest extends KernelTestCase
+{
+    use HasBrowser;
+
+    public function testSitemapContainsPages(): void
+    {
+        $browser = $this->browser([], [
+            'HTTP_HOST' => 'ux.symfony.com',
+        ])
+            ->visit('/robots.txt')
+            ->assertSuccessful()
+            ->assertContentType('text/plain');
+        $robot = $browser->content();
+
+        $this->assertStringStartsWith("User-agent: *\nDisallow:\n", $robot);
+        $this->assertStringContainsString('Sitemap: http://ux.symfony.com/sitemap.xml', $robot);
+    }
+}

ux.symfony.com/tests/Functional/SitemapTest.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Functional;
+
+use App\Service\LiveDemoRepository;
+use App\Service\UxPackageRepository;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Zenstruck\Browser\Test\HasBrowser;
+
+class SitemapTest extends KernelTestCase
+{
+    use HasBrowser;
+
+    public function testSitemapContainsPages(): void
+    {
+        $browser = $this->browser()
+            ->visit('/sitemap.xml')
+            ->assertSuccessful()
+            ->assertXml()
+        ;
+
+        $sitemap = $browser->content();
+        foreach ($this->getSmokeTests() as $url) {
+            $this->assertStringContainsString('<loc>'.$url.'</loc>', $sitemap);
+        }
+    }
+
+    private function getSmokeTests(): \Generator
+    {
+        $router = self::bootKernel()->getContainer()->get('router');
+
+        $demoRepository = new LiveDemoRepository();
+        foreach ($demoRepository->findAll() as $demo) {
+            yield $demo->getRoute() => $router->generate($demo->getRoute(), [], UrlGeneratorInterface::ABSOLUTE_URL);
+        }
+
+        $packageRepository = new UxPackageRepository();
+        foreach ($packageRepository->findAll() as $package) {
+            yield $package->getRoute() => $router->generate($package->getRoute(), [], UrlGeneratorInterface::ABSOLUTE_URL);
+        }
+    }
+}