Adding voter web tests to MenuBundle

Author: dantleech

Tests/Resources/Controller/CmiTestController.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\MenuBundle\Tests\Resources\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Cmf\Bundle\RoutingBundle\Routing\DynamicRouter;
+
+/**
+ * Cmi Tests
+ *
+ * Tests actions for current menu item functionality.
+ */
+class CmiTestController extends Controller
+{
+    public function defaultAction(Request $request)
+    {
+        return $this->render('::tests/cmi/default.html.twig');
+    }
+
+    public function requestContentIdentityAction(Request $request)
+    {
+        $content = $request->get(DynamicRouter::CONTENT_KEY);
+        if (!$content) {
+            $content = $this->container->get('doctrine_phpcr.odm.document_manager')->find(null, '/test/content-1');
+            $request->query->set(DynamicRouter::CONTENT_KEY, $content);
+            return $this->render('::tests/cmi/requestContentVoterActive.html.twig', array('content' => $content));
+        }
+        return $this->render('::tests/cmi/requestContent.html.twig', array('content' => $content));
+    }
+}

Tests/Resources/DataFixtures/PHPCR/LoadMenuData.php

@@ -19,9 +19,13 @@
 use Symfony\Cmf\Bundle\MenuBundle\Doctrine\Phpcr\Menu;
 use Symfony\Cmf\Bundle\MenuBundle\Tests\Resources\Document\Content;
 use Doctrine\ODM\PHPCR\Document\Generic;
+use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\Route;
+use PHPCR\Util\NodeHelper;
 
 class LoadMenuData implements FixtureInterface, DependentFixtureInterface
 {
+    protected $root;
+
     public function getDependencies()
     {
         return array(
@@ -31,20 +35,29 @@ public function getDependencies()
 
     public function load(ObjectManager $manager)
     {
-        $content = new Content;
-        $content->setTitle('Content 1');
-        $content->setId('/test/content-1');
+        $this->root = $manager->find(null, '/test');
+
+        NodeHelper::createPath($manager->getPhpcrSession(), '/test/menus');
+        NodeHelper::createPath($manager->getPhpcrSession(), '/test/routes/contents');
+        $this->menuRoot = $manager->find(null, '/test/menus');
+        $this->routeRoot = $manager->find(null, '/test/routes');
+
+        $this->loadMainMenu($manager);
+        $this->loadSideMenu($manager);
 
-        $root = $manager->find(null, '/test');
-        $menuRoot = new Generic;
-        $menuRoot->setNodename('menus');
-        $menuRoot->setParent($root);
-        $manager->persist($menuRoot);
+        $manager->flush();
+    }
+
+    protected function loadMainMenu($manager)
+    {
+        $content = new Content;
+        $content->setTitle('Menu Item Content 1');
+        $content->setId('/test/content-menu-item-1');
 
         $menu = new Menu;
         $menu->setName('test-menu');
         $menu->setLabel('Test Menu');
-        $menu->setParent($menuRoot);
+        $menu->setParent($this->menuRoot);
         $manager->persist($menu);
 
         $menuNode = new MenuNode;
@@ -94,7 +107,7 @@ public function load(ObjectManager $manager)
         $menu = new Menu;
         $menu->setName('another-menu');
         $menu->setLabel('Another Menu');
-        $menu->setParent($menuRoot);
+        $menu->setParent($this->menuRoot);
         $manager->persist($menu);
 
         $menuNode = new MenuNode;
@@ -113,6 +126,56 @@ public function load(ObjectManager $manager)
         $manager->persist($menuNode);
 
         $manager->persist($content);
-        $manager->flush();
+    }
+
+    protected function loadSideMenu($manager)
+    {
+        $content = new Content;
+        $content->setTitle('Content 1');
+        $content->setId('/test/content-1');
+        $manager->persist($content);
+
+        $route = new Route();
+        $route->setContent($content);
+        $route->setId('/test/routes/contents/content-1');
+        $route->setDefault('_controller', 'Symfony\Cmf\Bundle\MenuBundle\Tests\Resources\Controller\CmiTestController::requestContentIdentityAction');
+        $manager->persist($route);
+
+        $content = new Content;
+        $content->setTitle('CMI Content 1');
+        $content->setId('/test/cmi-content-1');
+        $manager->persist($content);
+
+        $menu = new Menu;
+        $menu->setName('side-menu');
+        $menu->setLabel('Side Menu');
+        $menu->setParent($this->menuRoot);
+        $manager->persist($menu);
+
+        $menuNode = new MenuNode;
+        $menuNode->setParent($menu);
+        $menuNode->setLabel('Default Behavior');
+        $menuNode->setName('default');
+        $menuNode->setRoute('current_menu_item_default');
+        $manager->persist($menuNode);
+
+        $menuNode = new MenuNode;
+        $menuNode->setParent($menu);
+        $menuNode->setLabel('Request Content Identity Voter');
+        $menuNode->setName('request-content-identity-voter');
+        $menuNode->setContent($route);
+        $manager->persist($menuNode);
+
+        $menuNode = new MenuNode;
+        $menuNode->setParent($menu);
+        $menuNode->setLabel('URI Prefix Voter');
+        $menuNode->setName('uri-prefix-voter');
+        $manager->persist($menuNode);
+
+        $menuNode = new MenuNode;
+        $menuNode->setParent($menu);
+        $menuNode->setLabel('Request Parent Content Identity Voter');
+        $menuNode->setName('request-parent-content-identity-voter');
+        $manager->persist($menuNode);
     }
 }

Tests/Resources/app/Resources/views/index.html.twig

@@ -4,6 +4,7 @@
 <ul>
     <li><a href="{{ path('render_test') }}">Render test</a></li>
     <li>@todo: Publish Workflow</li>
+    <li><a href="{{ path('current_menu_item_default') }}">Current Menu Item</a></li>
 </ul>
 <h2>About</h2>
 <p>This test application is built into the MenuBundle. You can easily run

Tests/Resources/app/Resources/views/layout.html.twig

@@ -1,6 +1,24 @@
 <html>
     <head>
         <title>MenuBundle Test Application</title>
+    <style>
+        nav.side li {
+            border: 1px black dashed;
+            background-color: #eee;
+            margin: 2px;
+            width: 196px;
+            list-style: none;
+        }
+
+        nav.side li.current {
+            background-color: green;
+        }
+
+        nav.side li.current a {
+            font-weight: bold;
+            color: white;
+        }
+    </style>
     </head>
     <body>
         <section id="header">

Tests/Resources/app/Resources/views/tests/cmi/_sideMenu.html.twig

@@ -0,0 +1,3 @@
+<nav class="side">
+{{ knp_menu_render('side-menu') }}
+</nav>

Tests/Resources/app/Resources/views/tests/cmi/default.html.twig

@@ -0,0 +1,6 @@
+{% extends "::layout.html.twig" %}
+{% block content %}
+{% include "::tests/cmi/_sideMenu.html.twig" %}
+<h1>Current Menu Item Test</h1>
+<p>The request URI of this page matches the URI for the route associated with the "default behavior" menu item on the left.</p>
+{% endblock %}

Tests/Resources/app/Resources/views/tests/cmi/requestContent.html.twig

@@ -0,0 +1,10 @@
+{% extends "::layout.html.twig" %}
+{% block content %}
+{% include "::tests/cmi/_sideMenu.html.twig" %}
+<h1>Request Content</h1>
+This is the content: {{ content.title }}
+<p>
+This page does NOT use the content identity voter because the URI of the request matches that of the content.
+</p>
+{% endblock %}
+

Tests/Resources/app/Resources/views/tests/cmi/requestContentVoterActive.html.twig

@@ -0,0 +1,10 @@
+{% extends "::layout.html.twig" %}
+{% block content %}
+{% include "::tests/cmi/_sideMenu.html.twig" %}
+<h1>Request Content</h1>
+This is the content: {{ content.title }}
+<p>
+The content identity voter should now be in use and the "Request Content Identity" menu item should be hilighted.
+</p>
+{% endblock %}
+

Tests/Resources/app/config/cmf_menu.yml

@@ -16,6 +16,7 @@ cmf_routing:
         enabled: true
         persistence:
             phpcr:
+                route_basepath: /test/routes
                 enabled: true
     chain:
         routers_by_id:

Tests/Resources/app/config/routing/test.yml

@@ -17,3 +17,14 @@ link_test_route_with_params:
     pattern: /link_test_route/hello/{bar}/{foo}
     defaults:
         _controller: Symfony\Cmf\Bundle\MenuBundle\Tests\Resources\Controller\TestController::linkTestRouteAction
+
+current_menu_item_default:
+    pattern: /cmi/default
+    defaults:
+        _controller: Symfony\Cmf\Bundle\MenuBundle\Tests\Resources\Controller\CmiTestController::defaultAction
+
+current_menu_item_request_content_identity:
+    pattern: /cmi/request_content_identity
+    defaults:
+        _controller: Symfony\Cmf\Bundle\MenuBundle\Tests\Resources\Controller\CmiTestController::requestContentIdentityAction
+