add support for routes with negative priority value

symfony · ghostika · Aug 24, 2014 · Aug 24, 2014 · Aug 25, 2014 · Aug 26, 2014
commit 992e38627d59b9e36d4c9134025a244a5471baf6
diff --git a/src/Symfony/Component/Routing/Loader/AnnotationClassLoader.php b/src/Symfony/Component/Routing/Loader/AnnotationClassLoader.php
@@ -97,11 +97,6 @@ public function setRouteAnnotationClass($class)
         $this->routeAnnotationClass = $class;
     }
 
-    public function hasRoutesWithPriority()
-    {
-        return !empty($this->routesWithPriority);
-    }
-
     /**
      * Loads from annotations from a class.
      *
@@ -132,40 +127,32 @@ public function load($class, $type = null)
             $this->defaultRouteIndex = 0;
             foreach ($this->reader->getMethodAnnotations($method) as $annot) {
                 if ($annot instanceof $this->routeAnnotationClass) {
-                    if ($annot->getOption('priority')) {
-                        //These routes will be added to the collection later in File or Directory Loader
-                        $this->routesWithPriority[$annot->getOption('priority')][]
-                            = array($annot, $globals, $class, $method);
-                        continue;
-                    }
-                    $this->addRoute($collection, $annot, $globals, $class, $method);
+                    $priority = (int) $annot->getOption('priority');
+                    $this->routesWithPriority[$priority][] = array($annot, $globals, $class, $method);
                 }
             }
         }
 
+        $collection = $this->addPriorityRoutes($collection);
+
         return $collection;
     }
 
     /**
-     * Create a new collection of routes with priority
-     * These routes will be already sorted by priority
-     * and after that append all the other routes which
-     * don't have any priority
+     * Add the prioritised routes to the collection
      *
-     * @param $originalCollection
+     * @param $collection
      * @return RouteCollection
      */
-    public function addPriorityRoutes($originalCollection)
+    public function addPriorityRoutes($collection)
     {
         krsort($this->routesWithPriority);
-        $collection = new RouteCollection();
 
         foreach ($this->routesWithPriority as $priorityGroup) {
             foreach ($priorityGroup as $route) {
                 $this->addRoute($collection, $route[0], $route[1], $route[2], $route[3]);
             }
         }
-        $collection->addCollection($originalCollection);
 
         return $collection;
     }

diff --git a/src/Symfony/Component/Routing/Loader/AnnotationDirectoryLoader.php b/src/Symfony/Component/Routing/Loader/AnnotationDirectoryLoader.php
@@ -58,9 +58,7 @@ public function load($path, $type = null)
             }
         }
 
-        if ($this->loader->hasRoutesWithPriority()) {
-            $collection = $this->loader->addPriorityRoutes($collection);
-        }
+        $collection = $this->loader->addPriorityRoutes($collection);
 
         return $collection;
     }

diff --git a/src/Symfony/Component/Routing/Loader/AnnotationFileLoader.php b/src/Symfony/Component/Routing/Loader/AnnotationFileLoader.php
@@ -65,9 +65,7 @@ public function load($file, $type = null)
             $collection->addCollection($this->loader->load($class, $type));
         }
 
-        if ($this->loader->hasRoutesWithPriority()) {
-            $collection = $this->loader->addPriorityRoutes($collection);
-        }
+        $collection = $this->loader->addPriorityRoutes($collection);
 
         return $collection;
     }

diff --git a/src/Symfony/Component/Routing/Tests/Loader/AnnotationClassLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/AnnotationClassLoaderTest.php
@@ -91,6 +91,11 @@ public function getLoadTests()
                 array('name' => 'route1', 'defaults' => array('arg2' => 'foo'), 'condition' => 'context.getMethod() == "GET"'),
                 array('arg2' => 'defaultValue2', 'arg3' =>'defaultValue3')
             ),
+            array(
+                'Symfony\Component\Routing\Tests\Fixtures\AnnotatedClasses\BarClass',
+                array('name' => 'route1', 'options' => array('priority' => 10)),
+                array('arg2' => 'defaultValue2', 'arg3' => 'defaultValue3'),
+            ),
         );
     }
 
@@ -121,7 +126,6 @@ public function testLoad($className, $routeDatas = array(), $methodArgs = array(
         $this->assertSame($routeDatas['path'], $route->getPath(), '->load preserves path annotation');
         $this->assertSame($routeDatas['requirements'],$route->getRequirements(), '->load preserves requirements annotation');
         $this->assertSame(count($routeDatas['options']), count(array_intersect($route->getOptions(), $routeDatas['options'])), '->load preserves options annotation');
-        $this->assertEquals(array_key_exists('priority', $routeDatas['options']), $this->loader->hasRoutesWithPriority());
         $this->assertSame(array_replace($methodArgs, $routeDa
9E88
tas['defaults']), $route->getDefaults(), '->load preserves defaults annotation');
         $this->assertEquals($routeDatas['condition'], $route->getCondition(), '->load preserves condition annotation');
     }

diff --git a/src/Symfony/Component/Routing/Tests/Loader/AnnotationDirectoryLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/AnnotationDirectoryLoaderTest.php
@@ -56,6 +56,7 @@ public function testRoutesWithPriority()
     {
         $routeDatas = array(
             'foo' => new Route(array('name' => 'foo', 'path' => '/foo')),
+            'unimportant' => new Route(array('name' => 'unimportant', 'path' => '/unimportant', 'options' => array('priority' => -10))),
             'bar' => new Route(array('name' => 'bar', 'path' => '/bar')),
             'static_id' => new Route(array('name' => 'static_id', 'path' => '/static/{id}', 'options' => array('priority' => 1))),
             'home' => new Route(array('name' => 'home', 'path' => '/home')),
@@ -70,7 +71,7 @@ public function testRoutesWithPriority()
             ->will($this->returnValue($routeDatas));
 
         $routeCollection = $this->loader->load(__DIR__.'/../Fixtures/AnnotatedClasses');
-        $expectedOrder = array( 'static_contact', 'static_location', 'static_id', 'foo', 'bar', 'home', 'login');
+        $expectedOrder = array( 'static_contact', 'static_location', 'static_id', 'foo', 'bar', 'home', 'login', 'unimportant');
         $this->assertEquals($expectedOrder, array_keys($routeCollection->all()));
     }
 }