Merge branch 'hotfix/head-options-always' into develop

Forward port #27 Conflicts: CHANGELOG.md
zendframework · Dec 13, 2016 · 77a5054 · 77a5054
2 parents dfbaa6c + dc509c8
commit 77a5054
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,7 +21,7 @@ All notable changes to this project will be documented in this file, in reverse
 
 - Nothing.
 
-## 1.3.1 - TBD
+## 1.3.1 - 2016-12-13
 
 ### Added
 
@@ -37,7 +37,9 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- Nothing.
+- [#27](https://github.com/zendframework/zend-expressive-router/pull/27) fixes
+  the behavior of `Route` to _always_ register `HEAD` and `OPTIONS` as allowed
+  methods; this was the original intent of [#24](https://github.com/zendframework/zend-expressive-router/pull/24).
 
 ## 1.3.0 - 2016-12-13
 

diff --git a/src/Route.php b/src/Route.php
@@ -33,13 +33,13 @@ class Route
      * @var bool If HEAD was not provided to the Route instance, indicate
      *     support for the method is implicit.
      */
-    private $implicitHead = true;
+    private $implicitHead = false;
 
     /**
      * @var bool If OPTIONS was not provided to the Route instance, indicate
      *     support for the method is implicit.
      */
-    private $implicitOptions = true;
+    private $implicitOptions = false;
 
     /**
      * @var int|string[] HTTP methods allowed with this route.
@@ -99,14 +99,9 @@ public function __construct($path, $middleware, $methods = self::HTTP_METHOD_ANY
         if (empty($name)) {
             $name = ($this->methods === self::HTTP_METHOD_ANY)
                 ? $path
-                : $path . '^' . implode(self::HTTP_METHOD_SEPARATOR, $this->methods);
+                : $path . '^' . implode(self::HTTP_METHOD_SEPARATOR, $this->retrieveExplicitMethods($this->methods));
         }
         $this->name = $name;
-
-        $this->implicitHead = is_array($this->methods)
-            && ! in_array(RequestMethod::METHOD_HEAD, $this->methods, true);
-        $this->implicitOptions = is_array($this->methods)
-            && ! in_array(RequestMethod::METHOD_OPTIONS, $this->methods, true);
     }
 
     /**
@@ -160,9 +155,7 @@ public function getAllowedMethods()
     public function allowsMethod($method)
     {
         $method = strtoupper($method);
-        if (RequestMethod::METHOD_HEAD === $method
-            || RequestMethod::METHOD_OPTIONS === $method
-            || $this->methods === self::HTTP_METHOD_ANY
+        if ($this->methods === self::HTTP_METHOD_ANY
             || in_array($method, $this->methods, true)
         ) {
             return true;
@@ -236,6 +229,40 @@ private function validateHttpMethods(array $methods)
             throw new Exception\InvalidArgumentException('One or more HTTP methods were invalid');
         }
 
+        if (! in_array(RequestMethod::METHOD_HEAD, $methods, true)) {
+            $this->implicitHead = true;
+            $methods[] = RequestMethod::METHOD_HEAD;
+        }
+
+        if (! in_array(RequestMethod::METHOD_OPTIONS, $methods, true)) {
+            $this->implicitOptions = true;
+            $methods[] = RequestMethod::METHOD_OPTIONS;
+        }
+
         return array_map('strtoupper', $methods);
     }
+
+    /**
+     * Return a list of methods explicitly set when creating the route.
+     *
+     * Filters out HEAD and/or OPTIONS if they were set implicitly.
+     */
+    private function retrieveExplicitMethods(array $methods)
+    {
+        return array_filter($methods, function ($method) {
+            if (! in_array($method, [RequestMethod::METHOD_HEAD, RequestMethod::METHOD_OPTIONS], true)) {
+                return true;
+            }
+
+            if ($method === RequestMethod::METHOD_HEAD && ! $this->implicitHead) {
+                return true;
+            }
+
+            if ($method === RequestMethod::METHOD_OPTIONS && ! $this->implicitOptions) {
+                return true;
+            }
+
+            return false;
+        });
+    }
 }
diff --git a/test/RouteTest.php b/test/RouteTest.php
@@ -56,7 +56,9 @@ public function testRouteAllowsSpecifyingHttpMethods()
     {
         $methods = [RequestMethod::METHOD_GET, RequestMethod::METHOD_POST];
         $route = new Route('/foo', $this->noopMiddleware, $methods);
-        $this->assertSame($methods, $route->getAllowedMethods($methods));
+        foreach ($methods as $method) {
+            $this->assertContains($method, $route->getAllowedMethods());
+        }
     }
 
     public function testRouteCanMatchMethod()
@@ -183,6 +185,8 @@ public function testProvidingArrayOfMethodsWithoutHeadOrOptionsImpliesBoth()
         $route = new Route('/test', $this->noopMiddleware, [RequestMethod::METHOD_GET, RequestMethod::METHOD_POST]);
         $this->assertTrue($route->implicitHead());
         $this->assertTrue($route->implicitOptions());
+        $this->assertContains(RequestMethod::METHOD_HEAD, $route->getAllowedMethods());
+        $this->assertContains(RequestMethod::METHOD_OPTIONS, $route->getAllowedMethods());
     }
 
     public function headAndOptions()
@@ -200,6 +204,8 @@ public function testPassingHeadOrOptionsInMethodArrayDoesNotMarkAsImplicit($http
     {
         $route = new Route('/test', $this->noopMiddleware, [$httpMethod]);
         $this->assertFalse($route->{$implicitMethod}());
+        $this->assertContains(RequestMethod::METHOD_HEAD, $route->getAllowedMethods());
+        $this->assertContains(RequestMethod::METHOD_OPTIONS, $route->getAllowedMethods());
     }
 
     public function testPassingWildcardMethodDoesNotMarkAsImplicit()