Merge pull request #4 from zentlix/feature/voters

Adding RouteVoter
zentlix · May 14, 2023 · a3244b8 · a3244b8
2 parents fc26503 + 629ed88
commit a3244b8
Show file tree

Hide file tree

Showing 17 changed files with 362 additions and 104 deletions.
diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml
diff --git a/.github/workflows/cs.yml b/.github/workflows/cs.yml
@@ -0,0 +1,16 @@
+on:
+    pull_request: null
+    push:
+        branches:
+            - '*.*'
+
+name: coding-standards
+
+jobs:
+    psalm:
+        uses: spiral/gh-actions/.github/workflows/cs.yml@master
+        with:
+            os: >-
+                ['ubuntu-latest']
+            php: >-
+                ['8.1']
diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml
@@ -2,7 +2,7 @@ on:
     pull_request: null
     push:
         branches:
-            - master
+            - '*.*'
 
 name: phpunit
 

diff --git a/.github/workflows/psalm.yml b/.github/workflows/psalm.yml
@@ -2,7 +2,7 @@ on:
     pull_request: null
     push:
         branches:
-            - master
+            - '*.*'
 
 name: static analysis
 

diff --git a/.github/workflows/security.yml b/.github/workflows/security.yml
@@ -2,7 +2,7 @@ on:
     pull_request: null
     push:
         branches:
-            - master
+            - '*.*'
 
 name: build
 

diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -8,16 +8,8 @@
 
 return (new PhpCsFixer\Config())
     ->setRules([
-        '@PHP71Migration' => true,
-        '@PHPUnit75Migration:risky' => true,
-        '@Symfony' => true,
-        '@Symfony:risky' => true,
-        'protected_to_private' => false,
-        'phpdoc_to_comment' => false,
-        'single_line_throw' => false,
-        'native_constant_invocation' => ['strict' => false],
-        'nullable_type_declaration_for_default_null_value' => ['use_nullable_type_declaration' => false],
-        'modernize_strpos' => true,
+        '@PSR12' => true,
+        'ternary_operator_spaces' => false,
     ])
     ->setRiskyAllowed(true)
     ->setFinder(

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Changelog
 
-## 1.0.0 - 2022-01-08
+## Unreleased
+- **Bug Fixes**
+- **Medium Impact Changes**
+- **Other Features**
+
+## 1.1.0 - 2223-05-14
+- **Other Features**
+  - Added `Spiral\KnpMenu\Matcher\Voter\RouteVoter`. It is added to the `Knp\Menu\Matcher\Matcher` by default.
+
+## 1.0.0 - 2023-01-08
 
 - initial release
diff --git a/composer.json b/composer.json
@@ -19,11 +19,12 @@
     "require-dev": {
         "spiral/framework": "^3.5",
         "roave/security-advisories": "dev-latest",
-        "phpunit/phpunit": "^9.5.27",
+        "phpunit/phpunit": "^10.1",
         "friendsofphp/php-cs-fixer": "^3.8",
-        "spiral/testing": "^2.2.0",
-        "vimeo/psalm": "^4.30",
-        "spiral/twig-bridge": "^2.0"
+        "spiral/testing": "^2.3",
+        "vimeo/psalm": "^5.11",
+        "spiral/twig-bridge": "^2.0",
+        "spiral/nyholm-bridge": "^1.3"
     },
     "autoload": {
         "psr-4": {

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,37 +1,31 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
-         backupGlobals="false"
-         colors="true"
-         verbose="true"
-         bootstrap="./vendor/autoload.php"
-         failOnRisky="true"
-         failOnWarning="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         stopOnFailure="false"
-         executionOrder="random"
-         resolveDependencies="true"
->
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd" backupGlobals="false" colors="true" bootstrap="./vendor/autoload.php" failOnRisky="true" failOnWarning="true" stopOnFailure="false" executionOrder="random" resolveDependencies="true" cacheDirectory=".phpunit.cache">
     <php>
-        <ini name="display_errors" value="On" />
-        <ini name="error_reporting" value="-1" />
-        <ini name="memory_limit" value="-1" />
+        <ini name="display_errors" value="On"/>
+        <ini name="error_reporting" value="-1"/>
+        <ini name="memory_limit" value="-1"/>
     </php>
-
+    <coverage>
+        <report>
+            <html outputDirectory="build/coverage"/>
+            <text outputFile="build/coverage.txt"/>
+            <clover outputFile="build/logs/clover.xml"/>
+        </report>
+    </coverage>
+    <logging>
+        <junit outputFile="build/report.junit.xml"/>
+    </logging>
     <testsuites>
         <testsuite name="Knp Menu Test Suite">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>
-
-    <coverage>
+    <source>
         <include>
             <directory>src</directory>
         </include>
         <exclude>
             <directory>./tests</directory>
         </exclude>
-    </coverage>
+    </source>
 </phpunit>
diff --git a/psalm.xml b/psalm.xml
@@ -4,6 +4,8 @@
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="https://getpsalm.org/schema/config"
         xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+        findUnusedBaselineEntry="true"
+        findUnusedCode="false"
 >
     <projectFiles>
         <directory name="src" />

diff --git a/src/Bootloader/KnpMenuBootloader.php b/src/Bootloader/KnpMenuBootloader.php
@@ -7,6 +7,7 @@
 use Knp\Menu\FactoryInterface;
 use Knp\Menu\Matcher\Matcher;
 use Knp\Menu\Matcher\MatcherInterface;
+use Knp\Menu\Matcher\Voter\VoterInterface;
 use Knp\Menu\MenuFactory;
 use Knp\Menu\Provider\MenuProviderInterface;
 use Knp\Menu\Renderer\PsrProvider;
@@ -17,8 +18,10 @@
 use Spiral\Boot\DirectoriesInterface;
 use Spiral\Config\ConfiguratorInterface;
 use Spiral\Core\Container;
+use Spiral\Core\Container\Autowire;
 use Spiral\KnpMenu\Config\KnpMenuConfig;
 use Spiral\KnpMenu\Extension\RoutingExtension;
+use Spiral\KnpMenu\Matcher\Voter\RouteVoter;
 use Spiral\KnpMenu\MenuInterface;
 use Spiral\KnpMenu\MenuRegistry;
 use Spiral\KnpMenu\Renderer\SpiralRenderer;
@@ -34,7 +37,7 @@ final class KnpMenuBootloader extends Bootloader
     protected const SINGLETONS = [
         FactoryInterface::class => MenuFactory::class,
         MenuFactory::class => MenuFactory::class,
-        MatcherInterface::class => Matcher::class,
+        MatcherInterface::class => [self::class, 'initMatcher'],
         MenuProviderInterface::class => [self::class, 'initMenuProvider'],
         MenuRegistry::class => MenuProviderInterface::class,
         RendererProviderInterface::class => [self::class, 'initRenderer'],
@@ -71,6 +74,9 @@ private function initConfig(): void
                 'template' => class_exists(TwigBootloader::class) ? 'knpMenu:knp_menu' : '',
                 'template_options' => [],
                 'menus' => [],
+                'voters' => [
+                    RouteVoter::class
+                ]
             ]
         );
     }
@@ -96,15 +102,34 @@ private function initMenuProvider(KnpMenuConfig $config, Container $container):
         $registry = new MenuRegistry();
 
         foreach ($config->getMenus() as $name => $menu) {
-            if (!$menu instanceof MenuInterface) {
-                $menu = $container->get($menu);
-            }
-
+            $menu = $this->wire($menu, $container);
             \assert($menu instanceof MenuInterface);
 
             $registry->add(array_is_list($config->getMenus()) ? $menu::class : $name, $menu);
         }
 
         return $registry;
     }
+
+    private function initMatcher(KnpMenuConfig $config, Container $container): MatcherInterface
+    {
+        $voters = [];
+        foreach ($config->getVoters() as $voter) {
+            $voter = $this->wire($voter, $container);
+            \assert($voter instanceof VoterInterface);
+
+            $voters[] = $voter;
+        }
+
+        return new Matcher($voters);
+    }
+
+    private function wire(mixed $alias, Container $container): mixed
+    {
+        return match (true) {
+            \is_string($alias) => $container->make($alias),
+            $alias instanceof Autowire => $alias->resolve($container),
+            default => $alias
+        };
+    }
 }
diff --git a/src/Config/KnpMenuConfig.php b/src/Config/KnpMenuConfig.php
@@ -4,10 +4,23 @@
 
 namespace Spiral\KnpMenu\Config;
 
+use Knp\Menu\Matcher\Voter\VoterInterface;
 use Spiral\Core\Container\Autowire;
 use Spiral\Core\InjectableConfig;
+use Spiral\KnpMenu\Matcher\Voter\RouteVoter;
 use Spiral\KnpMenu\MenuInterface;
 
+/**
+ * @psalm-type TMenu = MenuInterface|class-string<MenuInterface>|Autowire<MenuInterface>
+ * @psalm-type TVoter = VoterInterface|class-string<VoterInterface>|Autowire<VoterInterface>
+ *
+ * @property array{
+ *     template: non-empty-string,
+ *     template_options: array<array-key, mixed>,
+ *     menus: TMenu[],
+ *     voters: TVoter[]
+ * } $config
+ */
 final class KnpMenuConfig extends InjectableConfig
 {
     public const CONFIG = 'knp-menu';
@@ -16,16 +29,27 @@ final class KnpMenuConfig extends InjectableConfig
         'template' => '',
         'template_options' => [],
         'menus' => [],
+        'voters' => [
+            RouteVoter::class
+        ]
     ];
 
     /**
-     * @return array<MenuInterface|class-string|Autowire>
+     * @return TMenu[]
      */
     public function getMenus(): array
     {
         return $this->config['menus'];
     }
 
+    /**
+     * @return TVoter[]
+     */
+    public function getVoters(): array
+    {
+        return $this->config['voters'];
+    }
+
     /**
      * @return non-empty-string
      */

diff --git a/src/Extension/RoutingExtension.php b/src/Extension/RoutingExtension.php
@@ -21,6 +21,10 @@ public function buildOptions(array $options): array
             $params = $options['routeParameters'] ?? [];
 
             $options['uri'] = (string) $this->router->uri($options['route'], $params);
+
+            // adding the item route to the extras for the RouteVoter
+            $options['extras']['route'] = $options['route'];
+            $options['extras']['routeParameters'] = $params;
         }
 
         return $options;