Merge pull request #761 from danrot/media_controller_issue

added failing test case for uninflected resource

Author: lsmith77

Routing/Loader/Reader/RestActionReader.php

@@ -26,6 +26,8 @@
  */
 class RestActionReader
 {
+    const COLLECTION_ROUTE_PREFIX = 'c';
+
     private $annotationReader;
     private $paramReader;
     private $inflector;
@@ -150,8 +152,8 @@ public function read(RestRouteCollection $collection, \ReflectionMethod $method,
             return;
         }
 
-        list($httpMethod, $resources) = $httpMethodAndResources;
-        $arguments                    = $this->getMethodArguments($method);
+        list($httpMethod, $resources, $isCollection, $isInflectable) = $httpMethodAndResources;
+        $arguments                                                   = $this->getMethodArguments($method);
 
         // if we have only 1 resource & 1 argument passed, then it's object call, so
         // we can set collection singular name
@@ -234,8 +236,10 @@ public function read(RestRouteCollection $collection, \ReflectionMethod $method,
                     }
                 }
                 // add route to collection
-                $collection->add($routeName.$annotation->getName(), new Route(
-                    $pattern, $defaults, $requirements, $options, $host, $schemes, null, $condition));
+                $route = new Route(
+                    $pattern, $defaults, $requirements, $options, $host, $schemes, null, $condition
+                );
+                $this->addRoute($collection, $routeName, $route, $isCollection, $isInflectable, $annotation);
             }
 
         } else {
@@ -247,8 +251,10 @@ public function read(RestRouteCollection $collection, \ReflectionMethod $method,
                 }
             }
             // add route to collection
-            $collection->add($routeName, new Route(
-            $pattern, $defaults, $requirements, $options, $host, $schemes, null, $condition));
+            $route = new Route(
+                $pattern, $defaults, $requirements, $options, $host, $schemes, null, $condition
+            );
+            $this->addRoute($collection, $routeName, $route, $isCollection, $isInflectable);
         }
     }
 
@@ -300,19 +306,24 @@ private function getHttpMethodAndResourcesFromMethod(\ReflectionMethod $method,
         $resources  = preg_split(
             '/([A-Z][^A-Z]*)/', $matches[2], -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE
         );
+        $isCollection = false;
+        $isInflectable = true;
 
-        if (0 === strpos($httpMethod, 'c')
+        if (0 === strpos($httpMethod, self::COLLECTION_ROUTE_PREFIX)
             && in_array(substr($httpMethod, 1), $this->availableHTTPMethods)
         ) {
+            $isCollection = true;
             $httpMethod = substr($httpMethod, 1);
             if (!empty($resource)) {
-                $resource[count($resource)-1] = $this->inflector->pluralize(end($resource));
+                $resourcePluralized = $this->inflector->pluralize(end($resource));
+                $isInflectable = ($resourcePluralized != $resource[count($resource) - 1]);
+                $resource[count($resource)-1] = $resourcePluralized;
             }
         }
 
         $resources = array_merge($resource, $resources);
 
-        return array($httpMethod, $resources);
+        return array($httpMethod, $resources, $isCollection, $isInflectable);
     }
 
     /**
@@ -527,4 +538,27 @@ private function readMethodAnnotations(\ReflectionMethod $reflection, $annotatio
         }
         return $annotations;
     }
+
+    /**
+     * @param RestRouteCollection $collection
+     * @param $routeName
+     * @param $route
+     * @param $isCollection
+     * @param null $annotation
+     */
+    private function addRoute(RestRouteCollection $collection, $routeName, $route, $isCollection, $isInflectable, $annotation = null)
+    {
+        if ($annotation) {
+            $routeName = $routeName.$annotation->getName();
+        }
+
+        if ($isCollection && !$isInflectable) {
+            $collection->add(self::COLLECTION_ROUTE_PREFIX.$routeName, $route);
+            if (!$collection->get($routeName)) {
+                $collection->add($routeName, $route);
+            }
+        } else {
+            $collection->add($routeName, $route);
+        }
+    }
 }

Tests/Fixtures/Controller/InformationController.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Tests\Fixtures\Controller;
+
+use FOS\RestBundle\Controller\FOSRestController;
+use FOS\RestBundle\Routing\ClassResourceInterface;
+
+class InformationController extends FOSRestController implements ClassResourceInterface
+{
+    public function cgetAction()
+    {} // [GET] /information
+} 

Tests/Fixtures/Controller/MediaController.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Tests\Fixtures\Controller;
+
+use FOS\RestBundle\Controller\FOSRestController;
+use FOS\RestBundle\Routing\ClassResourceInterface;
+
+class MediaController extends FOSRestController implements ClassResourceInterface
+{
+    public function cgetAction()
+    {} // [GET] /media
+
+    public function getAction($slug)
+    {} // [GET] /media/{slug}
+} 

Tests/Routing/Loader/RestRouteLoaderTest.php

@@ -233,6 +233,35 @@ public function testCustomActionRoutesInDeveloperOrder()
         $this->assertLessThan($pos['prefix_get_bars'], $pos['prefix_get_bars_custom']);
     }
 
+    /**
+     * Test if the routes are also working with uninflected words
+     *
+     * @see https://github.com/FriendsOfSymfony/FOSRestBundle/pull/761
+     */
+    public function testMediaFixture()
+    {
+        $expectedMethod = 'GET';
+        $collection = $this->loadFromControllerFixture('MediaController');
+
+        $this->assertCount(2, $collection->all());
+        $this->assertEquals($expectedMethod, $collection->get('get_media')->getRequirement('_method'));
+        $this->assertEquals($expectedMethod, $collection->get('cget_media')->getRequirement('_method'));
+
+    }
+
+    /**
+     * Test if the routes are also working with uninflected words
+     *
+     * @see https://github.com/FriendsOfSymfony/FOSRestBundle/pull/761
+     */
+    public function testInformationFixture()
+    {
+        $collection = $this->loadFromControllerFixture('InformationController');
+
+        $this->assertCount(2, $collection->all());
+        $this->assertSame($collection->get('get_information'), $collection->get('cget_information'));
+    }
+
     /**
      * Load routes collection from fixture class under Tests\Fixtures directory.
      *