Merge pull request #809 from egulias/718-forward-options

#718 forward route options

Author: lsmith77

Routing/Loader/RestXmlCollectionLoader.php

@@ -103,6 +103,7 @@ protected function parseNode(RouteCollection $collection, \DOMElement $node, $pa
      */
     protected function parseRoute(RouteCollection $collection, \DOMElement $node, $path)
     {
+
         // the Symfony Routing component uses a path attribute since Symfony 2.2
         // instead of the deprecated pattern attribute0
         if (!$node->hasAttribute('path')) {
@@ -150,9 +151,33 @@ protected function parseRoute(RouteCollection $collection, \DOMElement $node, $p
             $node->appendChild($defaultFormatNode);
         }
 
+        $options = $this->getOptions($node);
+
+        foreach ($options as $option) {
+            $node->appendChild($option);
+        }
+
         parent::parseRoute($collection, $node, $path);
     }
 
+    private function getOptions(\DOMElement $node)
+    {
+        $options = array();
+        foreach ($node->childNodes as $child) {
+            if ($child instanceof \DOMElement && $child->tagName === 'option') {
+                $option = $node->ownerDocument->createElementNs(
+                    self::NAMESPACE_URI,
+                    'option',
+                    $child->nodeValue
+                );
+                $option->setAttribute('key', $child->getAttribute('key'));
+                $options[] = $option;
+            }
+        }
+
+        return $options;
+    }
+
     /**
      * {@inheritDoc}
      */

Routing/Loader/RestYamlCollectionLoader.php

@@ -73,6 +73,7 @@ public function load($file, $type = null)
                 $namePrefix = isset($config['name_prefix']) ? $config['name_prefix']    : null;
                 $parent     = isset($config['parent'])      ? $config['parent']         : null;
                 $type       = isset($config['type'])        ? $config['type']           : null;
+                $options    = isset($config['options'])     ? $config['options']        : null;
                 $currentDir = dirname($path);
 
                 $parents = array();
@@ -93,6 +94,10 @@ public function load($file, $type = null)
                     $this->collectionParents[$name] = $parents;
                 }
 
+                if ($options) {
+                    $imported->addOptions($options);
+                }
+
                 $imported->addPrefix($prefix);
                 $collection->addCollection($imported);
             } elseif (isset($config['pattern']) || isset($config['path'])) {

Tests/Fixtures/Controller/AnnotatedUsersController.php

@@ -46,6 +46,12 @@ public function getUsersAction()
     public function getUserAction($slug)
     {} // [GET]     /users/{slug}
 
+    /**
+     * @Route(requirements={"slug" = "[a-z]+", "id" = "\d+"}, options={"expose"=true})
+     */
+    public function getUserPostAction($slug, $id)
+    {} // [GET]     /users/{slug}/posts/{id}
+
     /**
      * @Patch
      */

Tests/Fixtures/Etalon/annotated_users_controller.yml

@@ -23,6 +23,13 @@ get_user_comment:
   controller:   ::getUserCommentAction
   requirements: {_method: GET, slug: '[a-z]+', id: '\d+'}
 
+get_user_post:
+  pattern:      /users/{slug}/posts/{id}.{_format}
+  controller:   ::getUserPostAction
+  options:
+    expose: true
+  requirements: {_method: GET, slug: '[a-z]+', id: '\d+'}
+
 rate_user:
   pattern:      /users/{slug}/rate.{_format}
   controller:   ::rateUserAction

Tests/Fixtures/Routes/routes_with_options.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://friendsofsymfony.github.com/schema/rest"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://friendsofsymfony.github.com/schema/rest
+        http://friendsofsymfony.github.com/schema/rest/routing-1.0.xsd"
+>
+    <route id="get_users" pattern="/users">
+        <default key="_controller">FOSRestBundle:UsersController:getUsers</default>
+        <option key="expose">true</option>
+    </route>
+</routes>

Tests/Fixtures/Routes/routes_with_options.yml

@@ -0,0 +1,5 @@
+users:
+  type:     rest
+  resource: FOS\RestBundle\Tests\Fixtures\Controller\UsersController
+  options:
+    expose: true

Tests/Routing/Loader/RestRouteLoaderTest.php

@@ -94,7 +94,7 @@ public function testAnnotatedUsersFixture()
         $etalonRoutes   = $this->loadEtalonRoutesInfo('annotated_users_controller.yml');
 
         $this->assertTrue($collection instanceof RestRouteCollection);
-        $this->assertEquals(23, count($collection->all()));
+        $this->assertEquals(24, count($collection->all()));
 
         foreach ($etalonRoutes as $name => $params) {
             $route = $collection->get($name);
@@ -107,8 +107,14 @@ public function testAnnotatedUsersFixture()
                  $this->assertEquals($params['condition'], $route->getCondition(), 'condition failed to match for '.$name);
             }
 
+            if (isset($params['options'])) {
+                foreach ($params['options'] as $option => $value) {
+                    $this->assertEquals($value, $route->getOption($option));
+                }
+            }
         }
     }
+
     /**
      * Test that annotated UsersController RESTful class gets parsed correctly with condition option (expression-language).
      */

Tests/Routing/Loader/RestXmlCollectionLoaderTest.php

@@ -108,6 +108,23 @@ public function testManualRoutesWithDefaultFormat()
         $this->assertEquals('xml', $route->getDefault('_format'));
     }
 
+    public function testForwardOptions()
+    {
+        $collection = $this->loadFromXmlCollectionFixture(
+            'routes_with_options.xml',
+            true,
+            array(
+                'json' => false,
+                'xml'  => false,
+                'html' => true,
+            ),
+            'xml'
+        );
+
+        foreach ($collection as $route) {
+            $this->assertTrue('true' === $route->getOption('expose'));
+        }
+    }
     /**
      * Load routes collection from XML fixture routes under Tests\Fixtures directory.
      *

Tests/Routing/Loader/RestYamlCollectionLoaderTest.php

@@ -92,6 +92,15 @@ public function testNamedPrefixedReportsFixtureHasNoDuplicates()
         $this->assertEquals(count($names), count(array_unique($names)));
     }
 
+    public function testForwardOptions()
+    {
+        $collection = $this->loadFromYamlCollectionFixture('routes_with_options.yml');
+
+        foreach ($collection as $route) {
+            $this->assertTrue($route->getOption('expose'));
+        }
+    }
+
     public function testManualRoutes()
     {
         $collection = $this->loadFromYamlCollectionFixture('routes.yml');