UrlGenerator implemented, Phpunit: implements test

Author: Asisyas

src/Business/Generator/UrlGenerator.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <[email protected]>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Business\Generator;
+
+use Micro\Plugin\Http\Business\Route\RouteCollectionInterface;
+
+/**
+ * @author Stanislau Komar <[email protected]>
+ */
+readonly class UrlGenerator implements UrlGeneratorInterface
+{
+    public function __construct(private RouteCollectionInterface $routeCollection)
+    {
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function generateUrlByRouteName(string $routeName, array|null $parameters = []): string
+    {
+        $route = $this->routeCollection->getRouteByName($routeName);
+        $uri = $route->getUri();
+        $routeParameters = $route->getParameters() ?? [];
+        $parameters = $parameters ?? [];
+        $parametersKeys = array_keys($parameters);
+
+        sort($routeParameters);
+        sort($parametersKeys);
+
+        if ($routeParameters !== $parametersKeys) {
+            throw new \RuntimeException('Route parameters mismatch. Parameters available: '.json_encode($routeParameters));
+        }
+
+        foreach ($parameters as $key => $value) {
+            $uri = str_replace(sprintf('{%s}', $key), $value, $uri);
+        }
+
+        return $uri;
+    }
+}

src/Business/Generator/UrlGeneratorFactory.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <[email protected]>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Business\Generator;
+
+use Micro\Plugin\Http\Business\Route\RouteCollectionFactoryInterface;
+
+/**
+ * @author Stanislau Komar <[email protected]>
+ */
+readonly class UrlGeneratorFactory implements UrlGeneratorFactoryInterface
+{
+    public function __construct(
+        private RouteCollectionFactoryInterface $routeCollectionFactory
+    ) {
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function create(): UrlGeneratorInterface
+    {
+        return new UrlGenerator($this->routeCollectionFactory->create());
+    }
+}

src/Business/Generator/UrlGeneratorFactoryInterface.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <[email protected]>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Business\Generator;
+
+/**
+ * @author Stanislau Komar <[email protected]>
+ */
+interface UrlGeneratorFactoryInterface
+{
+    public function create(): UrlGeneratorInterface;
+}

src/Business/Generator/UrlGeneratorInterface.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <[email protected]>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Business\Generator;
+
+use Micro\Plugin\Http\Exception\RouteNotFoundException;
+
+/**
+ * @author Stanislau Komar <[email protected]>
+ */
+interface UrlGeneratorInterface
+{
+    /**
+     * @param array<string, mixed>|null $parameters
+     *
+     * @throws RouteNotFoundException
+     * @throws \RuntimeException
+     */
+    public function generateUrlByRouteName(string $routeName, array|null $parameters = []): string;
+}

src/Business/Route/RouteCollectionFactory.php

@@ -18,25 +18,32 @@
 /**
  * @author Stanislau Komar <[email protected]>
  */
-readonly class RouteCollectionFactory implements RouteCollectionFactoryInterface
+class RouteCollectionFactory implements RouteCollectionFactoryInterface
 {
+    private RouteCollectionInterface|null $routeCollection;
+
     public function __construct(
-        private RouteLocatorFactoryInterface $routeLocatorFactory
+        private readonly RouteLocatorFactoryInterface $routeLocatorFactory
     ) {
+        $this->routeCollection = null;
     }
 
     /**
      * {@inheritDoc}
      */
     public function create(): RouteCollectionInterface
     {
+        if ($this->routeCollection) {
+            return $this->routeCollection;
+        }
+
         $collection = new RouteCollection();
 
         $locator = $this->routeLocatorFactory->create();
         foreach ($locator->locate() as $route) {
             $collection->addRoute($route);
         }
 
-        return $collection;
+        return $this->routeCollection = $collection;
     }
 }

src/Facade/HttpFacade.php

@@ -14,6 +14,7 @@
 namespace Micro\Plugin\Http\Facade;
 
 use Micro\Plugin\Http\Business\Executor\RouteExecutorFactoryInterface;
+use Micro\Plugin\Http\Business\Generator\UrlGeneratorFactoryInterface;
 use Micro\Plugin\Http\Business\Matcher\UrlMatcherFactoryInterface;
 use Micro\Plugin\Http\Business\Route\RouteBuilderFactoryInterface;
 use Micro\Plugin\Http\Business\Route\RouteBuilderInterface;
@@ -31,7 +32,8 @@ public function __construct(
         private UrlMatcherFactoryInterface $urlMatcherFactory,
         private RouteCollectionFactoryInterface $routeCollectionFactory,
         private RouteExecutorFactoryInterface $routeExecutorFactory,
-        private RouteBuilderFactoryInterface $routeBuilderFactory
+        private RouteBuilderFactoryInterface $routeBuilderFactory,
+        private UrlGeneratorFactoryInterface $urlGeneratorFactory
     ) {
     }
 
@@ -72,4 +74,14 @@ public function execute(Request $request, bool $flush = true): Response
             ->create()
             ->execute($request, $flush);
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function generateUrlByRouteName(string $routeName, array|null $parameters = []): string
+    {
+        return $this->urlGeneratorFactory
+            ->create()
+            ->generateUrlByRouteName($routeName, $parameters);
+    }
 }

src/Facade/HttpFacadeInterface.php

@@ -14,13 +14,14 @@
 namespace Micro\Plugin\Http\Facade;
 
 use Micro\Plugin\Http\Business\Executor\RouteExecutorInterface;
+use Micro\Plugin\Http\Business\Generator\UrlGeneratorInterface;
 use Micro\Plugin\Http\Business\Matcher\UrlMatcherInterface;
 use Micro\Plugin\Http\Business\Route\RouteBuilderInterface;
 
 /**
  * @author Stanislau Komar <[email protected]>
  */
-interface HttpFacadeInterface extends UrlMatcherInterface, RouteExecutorInterface
+interface HttpFacadeInterface extends UrlMatcherInterface, RouteExecutorInterface, UrlGeneratorInterface
 {
     /**
      * @return string[]

src/HttpCorePlugin.php

@@ -22,6 +22,8 @@
 use Micro\Framework\Kernel\Plugin\PluginConfigurationTrait;
 use Micro\Plugin\Http\Business\Executor\RouteExecutorFactory;
 use Micro\Plugin\Http\Business\Executor\RouteExecutorFactoryInterface;
+use Micro\Plugin\Http\Business\Generator\UrlGeneratorFactory;
+use Micro\Plugin\Http\Business\Generator\UrlGeneratorFactoryInterface;
 use Micro\Plugin\Http\Business\Locator\RouteLocatorFactory;
 use Micro\Plugin\Http\Business\Locator\RouteLocatorFactoryInterface;
 use Micro\Plugin\Http\Business\Matcher\Route\RouteMatcherFactory;
@@ -82,9 +84,15 @@ protected function createFacade(): HttpFacadeInterface
             $routeCollectionFactory,
             $this->createRouteExecutorFactory($urlMatcherFactory),
             $this->createRouteBuilderFactory(),
+            $this->createUrlGeneratorFactory($routeCollectionFactory)
         );
     }
 
+    protected function createUrlGeneratorFactory(RouteCollectionFactoryInterface $routeCollectionFactory): UrlGeneratorFactoryInterface
+    {
+        return new UrlGeneratorFactory($routeCollectionFactory);
+    }
+
     protected function createRouteBuilderFactory(): RouteBuilderFactoryInterface
     {
         return new RouteBuilderFactory();

tests/Unit/Business/Generator/UrlGeneratorFactoryTest.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <[email protected]>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Unit\Business\Generator;
+
+use Micro\Plugin\Http\Business\Generator\UrlGeneratorFactory;
+use Micro\Plugin\Http\Business\Generator\UrlGeneratorInterface;
+use Micro\Plugin\Http\Business\Route\RouteCollectionFactoryInterface;
+use PHPUnit\Framework\TestCase;
+
+class UrlGeneratorFactoryTest extends TestCase
+{
+    public function testCreate()
+    {
+        $urlGeneratorFactory = new UrlGeneratorFactory(
+            $this->createMock(RouteCollectionFactoryInterface::class),
+        );
+
+        $this->assertInstanceOf(UrlGeneratorInterface::class, $urlGeneratorFactory->create());
+    }
+}

tests/Unit/Business/Generator/UrlGeneratorTest.php

@@ -0,0 +1,69 @@
+<?php
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <[email protected]>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Unit\Business\Generator;
+
+use Micro\Plugin\Http\Business\Generator\UrlGenerator;
+use Micro\Plugin\Http\Business\Route\RouteCollectionInterface;
+use Micro\Plugin\Http\Business\Route\RouteInterface;
+use PHPUnit\Framework\TestCase;
+
+class UrlGeneratorTest extends TestCase
+{
+    /**
+     * @dataProvider dataProvider
+     */
+    public function testGenerateUrlByRouteName(
+        string $routeUri,
+        array $routeParameters,
+        array|null $parameters,
+        string $exceptedRoute,
+        string|null $exceptionExcepted
+    ) {
+        $route = $this->createMock(RouteInterface::class);
+        $route
+            ->expects($this->once())
+            ->method('getUri')
+            ->willReturn($routeUri);
+
+        $route
+            ->expects($this->once())
+            ->method('getParameters')
+            ->willReturn($routeParameters);
+
+        $collection = $this->createMock(RouteCollectionInterface::class);
+        $collection
+            ->expects($this->once())
+            ->method('getRouteByName')
+            ->with('test_route')
+            ->willReturn($route);
+
+        $generator = new UrlGenerator($collection);
+
+        if ($exceptionExcepted) {
+            $this->expectException($exceptionExcepted);
+        }
+
+        $generated = $generator->generateUrlByRouteName('test_route', $parameters);
+
+        $this->assertEquals($exceptedRoute, $generated);
+    }
+
+    public function dataProvider()
+    {
+        return [
+            ['/test', [], [], '/test', null],
+            ['/{parameter}', ['parameter'], ['parameter' => 'dynamic'], '/dynamic', null],
+            ['/{parameter}', ['parameter'], ['parameter' => 'dynamic', 'invalid_parameter' => 'test'], '', \RuntimeException::class],
+            ['/{parameter}', ['parameter'], [], '', \RuntimeException::class],
+        ];
+    }
+}