Merge pull request #232 from symfony-cmf/issue_230

Fix implementation of allowEmptyItems in QuietFactory

Author: lsmith77

.travis.yml

@@ -37,7 +37,7 @@ before_install:
   - if [ "$TRAVIS_PHP_VERSION" != "hhvm" ]; then echo "memory_limit = -1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini; fi
   - composer self-update
   - composer require symfony/symfony:${SYMFONY_VERSION} --no-update
-    
+
 install: composer update $COMPOSER_FLAGS --prefer-dist
 
 script: phpunit --coverage-text

QuietFactory.php

@@ -2,9 +2,7 @@
 
 namespace Symfony\Cmf\Bundle\MenuBundle;
 
-use Knp\Menu\Factory\ExtensionInterface;
 use Knp\Menu\FactoryInterface;
-use Knp\Menu\ItemInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Routing\Exception\RouteNotFoundException;
 
@@ -22,19 +20,20 @@ class QuietFactory implements FactoryInterface
     private $innerFactory;
 
     /**
-     * @var LoggerInterface
+     * @var LoggerInterface|null
      */
     private $logger;
 
     /**
-     * Whether to return null or a MenuItem without any URL if no URL can be
-     * found for a MenuNode.
+     * Whether to return null (if value is false) or a MenuItem
+     * without any URL (if value is true) if no URL can be found
+     * for a MenuNode.
      *
      * @var bool
      */
     private $allowEmptyItems;
 
-    public function __construct(FactoryInterface $innerFactory, LoggerInterface $logger, $allowEmptyItems = false)
+    public function __construct(FactoryInterface $innerFactory, LoggerInterface $logger = null, $allowEmptyItems = false)
     {
         $this->innerFactory = $innerFactory;
         $this->logger = $logger;
@@ -49,11 +48,22 @@ public function createItem($name, array $options = array())
         try {
             return $this->innerFactory->createItem($name, $options);
         } catch (RouteNotFoundException $e) {
-            $this->logger->error(sprintf('%s : %s', $name, $e->getMessage()));
+            if (null !== $this->logger) {
+                $this->logger->error(
+                    sprintf('An exception was thrown while creating a menu item called "%s"', $name),
+                    array('exception' => $e)
+                );
+            }
 
             if (!$this->allowEmptyItems) {
                 return null;
             }
+
+            // remove route and content options
+            unset($options['route']);
+            unset($options['content']);
+
+            return $this->innerFactory->createItem($name, $options);
         }
     }
 }

Resources/config/menu.xml

@@ -10,7 +10,7 @@
 
         <service id="cmf_menu.factory.quiet" class="Symfony\Cmf\Bundle\MenuBundle\QuietFactory" public="false">
             <argument type="service" id="cmf_menu.factory.quiet.inner" />
-            <argument type="service" id="logger"/>
+            <argument type="service" id="logger" on-invalid="ignore" />
             <argument>%cmf_menu.allow_empty_items%</argument>
         </service>
 

Tests/Unit/QuietFactoryTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\MenuBundle\Tests\Unit;
+
+use Symfony\Cmf\Bundle\MenuBundle\QuietFactory;
+
+class QuietFactoryTest extends \PHPUnit_Framework_TestCase
+{
+    private $innerFactory;
+    private $logger;
+
+    protected function setUp()
+    {
+        $this->innerFactory = $this->prophesize('Knp\Menu\FactoryInterface');
+        $this->logger = $this->prophesize('Psr\Log\LoggerInterface');
+    }
+
+    public function provideItemsWithNotExistingLinks()
+    {
+        return array(
+            array(array('route' => 'not_existent'), array('route' => 'not_existent')),
+            array(array('content' => 'not_existent'), array('content' => 'not_existent')),
+            array(array('linkType' => 'route', 'route' => 'not_existent'), array('linkType' => 'route')),
+        );
+    }
+
+    /** @dataProvider provideItemsWithNotExistingLinks */
+    public function testAllowEmptyItemsReturnsItemWithoutURL(array $firstOptions, array $secondOptions)
+    {
+        $this->innerFactory->createItem('Home', $firstOptions)
+            ->willThrow('Symfony\Component\Routing\Exception\RouteNotFoundException');
+
+        $homeMenuItem = new \stdClass();
+        $this->innerFactory->createItem('Home', $secondOptions)->willReturn($homeMenuItem);
+
+        $factory = new QuietFactory($this->innerFactory->reveal(), $this->logger->reveal(), true);
+
+        $this->assertEquals($homeMenuItem, $factory->createItem('Home', $firstOptions));
+    }
+
+    public function testDisallowEmptyItemsReturnsNull()
+    {
+        $this->innerFactory->createItem('Home', array('route' => 'not_existent'))
+            ->willThrow('Symfony\Component\Routing\Exception\RouteNotFoundException');
+
+        $factory = new QuietFactory($this->innerFactory->reveal(), $this->logger->reveal(), false);
+
+        $this->assertEquals(null, $factory->createItem('Home', array('route' => 'not_existent')));
+    }
+}