add chill_menu to render easily menu, refs #179

Resources/config/services.yml

@@ -4,8 +4,15 @@ parameters:
 services:
     chill.main.menu_composer:
         class: CL\Chill\MainBundle\Routing\MenuComposer
+        #must be set in function to avoid circular reference with chill.main.twig.chill_menu
+        calls:
+            -  [setRoute, ["@router"]]
+            
+    chill.main.twig.chill_menu:
+        class: CL\Chill\MainBundle\Routing\MenuTwig
         arguments:
-            -  "@router"
-#    cl_chill_main.example:
-#        class: %cl_chill_main.example.class%
-#        arguments: [@service_id, "plain_value", %parameter%]
+            - "@chill.main.menu_composer"
+        calls:
+            - [setContainer, ["@service_container"]]
+        tags:
+            - { name: twig.extension }

Resources/views/Menu/defaultMenu.html.twig

@@ -0,0 +1,5 @@
+<ul>
+{% for route in routes %}
+    <li><a href="{{ path(route.key, args ) }}" class="{%- if activeRouteKey == route.key -%}active{%- endif -%}">{{ route.label }}</a></li>
+{% endfor %}
+</ul>

Routing/MenuComposer.php

@@ -22,10 +22,16 @@ class MenuComposer
      */
     private $routeCollection;
 
-    public function __construct(RouterInterface $router)
+    /**
+     * 
+     * @internal must be set in function instead of controller to avoid circular reference 
+     * with MenuTwig
+     * @param RouterInterface $router
+     */
+    public function setRoute(RouterInterface $router)
     {
         //see remark in MenuComposer::setRouteCollection
-        $this->setRouteCollection($router->getRouteCollection());
+        $this->routeCollection = $router->getRouteCollection();
     }
 
     /**
@@ -41,6 +47,14 @@ class MenuComposer
         $this->routeCollection = $routeCollection;
     }
 
+    /**
+     * Return an array of routes added to $menuId,
+     * The array is aimed to build route with MenuTwig
+     * 
+     * @param string $menuId
+     * @param array $parameters see https://redmine.champs-libres.coop/issues/179
+     * @return array
+     */
     public function getRoutesFor($menuId, array $parameters = array())
     {
         $routes = array();

Routing/MenuTwig.php

@@ -0,0 +1,107 @@
+<?php
+
+/**
+ * 
+ * Copyright (C) 2014 Champs Libres Cooperative SCRLFS, 
+ * <http://www.champs-libres.coop>
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace CL\Chill\MainBundle\Routing;
+
+use CL\Chill\MainBundle\Routing\MenuComposer;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Add the filter 'chill_menu'
+ *
+ * @author Julien Fastré <julien arobase fastre point info>
+ */
+class MenuTwig extends \Twig_Extension implements ContainerAwareInterface
+{
+    
+    /**
+     *
+     * @var MenuComposer
+     */
+    private $menuComposer;
+    
+    /**
+     *
+     * @var \Symfony\Component\DependencyInjection\ContainerInterface
+     */
+    private $container;
+    
+    /**
+     * the default parameters for chillMenu
+     * 
+     * @var mixed[] 
+     */
+    private $defaultParams = array(
+        'layout' => 'CLChillMainBundle:Menu:defaultMenu.html.twig',
+        'args' => array(),
+        'activeRouteKey' => null
+    );
+    
+    public function __construct(MenuComposer $menuComposer)
+    {
+        $this->menuComposer = $menuComposer;
+    }
+    
+    public function getFunctions()
+    {
+        return [new \Twig_SimpleFunction('chill_menu', 
+                array($this, 'chillMenu'), array('is_safe' => array('html')))
+            ];
+    }
+    
+    /**
+     * Render a Menu corresponding to $menuId
+     * 
+     * Expected params : 
+     * - args: the arguments to build the path (i.e: if pattern is /something/{bar}, args must contain {'bar': 'foo'}
+     * - layout: the layout. Absolute path needed (i.e.: CLChillXyzBundle:section:foo.html.twig)
+     * - activeRouteKey : the key active, will render the menu differently.
+     * 
+     * see https://redmine.champs-libres.coop/issues/179 for more informations
+     * 
+     * @param string $menuId
+     * @param mixed[] $params
+     */
+    public function chillMenu($menuId, array $params = array())
+    {
+        $resolvedParams = array_merge($this->defaultParams, $params);
+
+        $layout = $resolvedParams['layout'];
+        unset($resolvedParams['layout']);
+        
+        $resolvedParams['routes'] = $this->menuComposer->getRoutesFor($menuId);
+        
+        return $this->container->get('templating')
+                ->render($layout, $resolvedParams);
+    }
+    
+    public function getName()
+    {
+        return 'chill_menu';
+    }
+
+    public function setContainer(ContainerInterface $container = null)
+    {
+        $this->container = $container;
+    }
+
+}

Tests/Fixtures/App/config/routing.yml

@@ -23,3 +23,12 @@ chill_main_dummy_1:
                 order: 50
                 label: 'test1'
                 helper: 'great helper'
+                
+chill_main_dummy_2:
+    pattern: /dummy2/{param}
+    defaults: {_controller: CLChillMainBundle:Default:index }
+    options:
+        menus:
+            dummy0:
+                order: 50
+                label: test2

Tests/Fixtures/Resources/views/menus/fakeTemplate.html.twig

@@ -0,0 +1 @@
+fake template

Tests/Fixtures/Resources/views/menus/normalMenu.html.twig

@@ -0,0 +1 @@
+{{ chill_menu('dummy0', {'args' : { 'param' :'fake' }, 'activeRouteKey': 'chill_main_dummy_0' }) }}

Tests/Fixtures/Resources/views/menus/overrideTemplate.html.twig

@@ -0,0 +1 @@
+{{ chill_menu('dummy1', {'layout' : '@tests/menus/fakeTemplate.html.twig' }) }}

Tests/Services/ChillMenuTwigFunctionTest.php

@@ -0,0 +1,86 @@
+<?php
+
+/*
+ * <one line to give the program's name and a brief idea of what it does.>
+ * Copyright (C) 2014, Champs Libres Cooperative SCRLFS, <http://www.champs-libres.coop>
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ *  License, or (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace CL\Chill\MainBundle\Tests\Services;
+
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\DomCrawler\Crawler;
+
+/**
+ * Test the Twig function 'chill_menu'
+ *
+ * @author Julien Fastré <julien.fastre@champs-libres.coop>
+ */
+class ChillMenuTwigFunctionTest extends KernelTestCase
+{
+    
+    private static $templating;
+    
+    public static function setUpBeforeClass()
+    {
+        self::bootKernel(array('environment' => 'test'));
+        static::$templating = static::$kernel
+                ->getContainer()->get('templating');
+        //load templates in Tests/Resources/views
+        static::$kernel->getContainer()->get('twig.loader')
+                ->addPath(__DIR__.'/../Fixtures/Resources/views/', $namespace = 'tests');
+    }
+    
+    public function testNormalMenu()
+    {
+        $content = static::$templating->render('@tests/menus/normalMenu.html.twig');
+        $crawler = new Crawler($content);
+        
+        $ul = $crawler->filter('ul')->getNode(0);
+        $this->assertEquals( 'ul', $ul->tagName);
+        
+        $lis = $crawler->filter('ul')->children();
+        $this->assertEquals(3, count($lis));
+        
+        $lis->each(function(Crawler $node, $i) {
+                $this->assertEquals('li', $node->getNode(0)->tagName);
+                
+                $a = $node->children()->getNode(0);
+                $this->assertEquals('a', $a->tagName);
+                switch($i) {
+                    case 0: 
+                        $this->assertEquals('/dummy?param=fake', $a->getAttribute('href'));
+                        $this->assertEquals('active', $a->getAttribute('class'));
+                        $this->assertEquals('test0', $a->nodeValue);
+                        break;
+                    case 1:
+                        $this->assertEquals('/dummy1?param=fake', $a->getAttribute('href'));
+                        $this->assertEmpty($a->getAttribute('class'));
+                        $this->assertEquals('test1', $a->nodeValue);
+                        break;
+                    case 3:
+                        $this->assertEquals('/dummy2/fake', $a->getAttribute('href'));
+                        $this->assertEmpty($a->getAttribute('class'));
+                        $this->assertEquals('test2', $a->nodeValue);
+                }
+        });
+    }
+    
+    public function testMenuOverrideTemplate()
+    {
+        $content = static::$templating->render('@tests/menus/overrideTemplate.html.twig');
+        $this->assertEquals('fake template', $content);
+    }
+}

Tests/Services/MenuComposerTest.php

@@ -3,7 +3,6 @@
 namespace CL\Chill\MainBundle\Tests\Services;
 
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
-use Symfony\Component\Routing\Loader\YamlFileLoader;
 use Symfony\Component\Routing\RouteCollection;
 
 /**
@@ -43,7 +42,7 @@ class MenuComposerTest extends KernelTestCase
         $routes = $this->menuComposer->getRoutesFor('dummy0');
         
         $this->assertInternalType('array', $routes);
-        $this->assertCount(2, $routes);
+        $this->assertCount(3, $routes);
         //check that the keys are sorted
         $orders = array_keys($routes);
         foreach ($orders as $key => $order){
@@ -65,6 +64,10 @@ class MenuComposerTest extends KernelTestCase
                 'key'   => 'chill_main_dummy_1',
                 'label' => 'test1',
                 'helper'=> 'great helper'
+            ),
+            52 => array(
+                'key'   => 'chill_main_dummy_2',
+                'label' => 'test2'
             ));
         
         

composer.json

@@ -22,5 +22,8 @@
         "symfony/framework-bundle": "2.5.*",
         "symfony/yaml": "2.5.*",
         "symfony/symfony": "2.5.*"
+    },
+    "require-dev": {
+        "symfony/dom-crawler": "2.5"
     }
 }