MAGETWO-33075: Upgrade route class.

Author: Sergey Semenov

app/code/Magento/Webapi/Controller/Rest/Router/Route.php

@@ -7,22 +7,137 @@
  */
 namespace Magento\Webapi\Controller\Rest\Router;
 
-class Route extends \Zend_Controller_Router_Route
+use Magento\Framework\App\RequestInterface as Request;
+use Magento\Framework\App\RouterInterface;
+
+class Route implements RouterInterface
 {
-    /** @var string */
-    protected $_serviceClass;
+    /**
+     * @var string
+     */
+    protected $serviceClass;
+
+    /**
+     * @var string
+     */
+    protected $serviceMethod;
+
+    /**
+     * @var boolean
+     */
+    protected $secure;
 
-    /** @var string */
-    protected $_serviceMethod;
+    /**
+     * @var array
+     */
+    protected $aclResources = [];
+
+    /**
+     * @var array
+     */
+    protected $parameters = [];
 
-    /** @var boolean */
-    protected $_secure;
+    /**
+     * @var array
+     */
+    protected $variables = [];
 
-    /** @var array */
-    protected $_aclResources = [];
+    /**
+     * @var string
+     */
+    protected $route;
 
-    /** @var array */
-    protected $_parameters = [];
+    /**
+     * @param string $route
+     */
+    public function __construct($route = '')
+    {
+        $this->route = trim($route, '/');
+    }
+
+    /**
+     * Split route by parts and variables
+     *
+     * @return array
+     */
+    protected function getRouteParts()
+    {
+        $result = [];
+        $routeParts = explode('/', $this->route);
+        foreach ($routeParts as $key => $value) {
+            if ($this->isVariable($value)) {
+                $this->variables[$key] = substr($value, 1);
+                $value = null;
+            }
+            $result[$key] = strtolower($value);
+        }
+        return $result;
+    }
+
+    /**
+     * Check if current route part is a name of variable
+     *
+     * @param string $value
+     * @return bool
+     */
+    protected function isVariable($value)
+    {
+        if (substr($value, 0, 1) == ':'
+            && substr($value, 1, 1) != ':') {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Retrieve unified requested path
+     *
+     * Lowercase all path chunks, except variables names.
+     * E.g. the path '/V1/Categories/:categoryId' will be converted to '/v1/categories/:categoryId'.
+     *
+     * @param string $path
+     * @return array
+     */
+    protected function getPathParts($path)
+    {
+        $result = explode('/', trim($path, '/'));
+        array_walk($result, function (&$item) {
+            $item = substr($item, 0, 1) === ":" ? $item : strtolower($item);
+        });
+        return $result;
+    }
+
+    /**
+     * Check if current route matches the requested path
+     *
+     * @param Request $request
+     * @return array|bool
+     */
+    public function match(Request $request)
+    {
+        /** @var \Magento\Webapi\Controller\Rest\Request $request */
+        $pathParts = $this->getPathParts($request->getPathInfo());
+        $routeParts = $this->getRouteParts();
+        if (count($pathParts) <> count($routeParts)) {
+            return false;
+        }
+
+        $result = [];
+        foreach ($pathParts as $key => $value) {
+            if (!array_key_exists($key, $routeParts)) {
+                return false;
+            }
+            $variable = isset($this->variables[$key]) ? $this->variables[$key] : null;
+            if ($variable) {
+                $result[$variable] = urldecode($pathParts[$key]);
+            } else {
+                if ($value != $routeParts[$key]) {
+                    return false;
+                }
+            }
+        }
+        return $result;
+    }
 
     /**
      * Set service class.
@@ -32,7 +147,7 @@ class Route extends \Zend_Controller_Router_Route
      */
     public function setServiceClass($serviceClass)
     {
-        $this->_serviceClass = $serviceClass;
+        $this->serviceClass = $serviceClass;
         return $this;
     }
 
@@ -43,7 +158,7 @@ public function setServiceClass($serviceClass)
      */
     public function getServiceClass()
     {
-        return $this->_serviceClass;
+        return $this->serviceClass;
     }
 
     /**
@@ -54,7 +169,7 @@ public function getServiceClass()
      */
     public function setServiceMethod($serviceMethod)
     {
-        $this->_serviceMethod = $serviceMethod;
+        $this->serviceMethod = $serviceMethod;
         return $this;
     }
 
@@ -65,7 +180,7 @@ public function setServiceMethod($serviceMethod)
      */
     public function getServiceMethod()
     {
-        return $this->_serviceMethod;
+        return $this->serviceMethod;
     }
 
     /**
@@ -76,7 +191,7 @@ public function getServiceMethod()
      */
     public function setSecure($secure)
     {
-        $this->_secure = $secure;
+        $this->secure = $secure;
         return $this;
     }
 
@@ -87,7 +202,7 @@ public function setSecure($secure)
      */
     public function isSecure()
     {
-        return $this->_secure;
+        return $this->secure;
     }
 
     /**
@@ -98,7 +213,7 @@ public function isSecure()
      */
     public function setAclResources($aclResources)
     {
-        $this->_aclResources = $aclResources;
+        $this->aclResources = $aclResources;
         return $this;
     }
 
@@ -109,7 +224,7 @@ public function setAclResources($aclResources)
      */
     public function getAclResources()
     {
-        return $this->_aclResources;
+        return $this->aclResources;
     }
 
     /**
@@ -120,7 +235,7 @@ public function getAclResources()
      */
     public function setParameters($parameters)
     {
-        $this->_parameters = $parameters;
+        $this->parameters = $parameters;
         return $this;
     }
 
@@ -131,19 +246,6 @@ public function setParameters($parameters)
      */
     public function getParameters()
     {
-        return $this->_parameters;
-    }
-
-    /**
-     * Matches a Request with parts defined by a map. Assigns and
-     * returns an array of variables on a successful match.
-     *
-     * @param \Magento\Webapi\Controller\Request $request
-     * @param boolean $partial Partial path matching
-     * @return array|bool An array of assigned values or a boolean false on a mismatch
-     */
-    public function match($request, $partial = false)
-    {
-        return parent::match(strtolower(ltrim($request->getPathInfo(), $this->_urlDelimiter)), $partial);
+        return $this->parameters;
     }
 }

dev/tests/static/testsuite/Magento/Test/Legacy/_files/obsolete_classes.php

@@ -2855,4 +2855,6 @@
     ['Magento\Sales\Model\Quote\Address\Total\Nominal\Shipping'],
     ['Magento\Sales\Model\Quote\Address\Total\Nominal\Subtotal'],
     ['Magento\Core\Model\Validator\Factory', 'Magento\Framework\Validator\Factory'],
+    ['Zend_Controller_Router_Route'],
+    ['Zend_Controller_Router_Route_Interface'],
 ];

dev/tests/unit/testsuite/Magento/Framework/Controller/Router/Route/FactoryTest.php

@@ -6,73 +6,70 @@
 
 namespace Magento\Framework\Controller\Router\Route;
 
+use Magento\Framework\Controller\Router\Route\Factory as RouteFactory;
+use Magento\TestFramework\Helper\ObjectManager as ObjectManager;
+
 class FactoryTest extends \PHPUnit_Framework_TestCase
 {
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject|\Magento\Framework\ObjectManagerInterface
+     * @var ObjectManager|\PHPUnit_Framework_MockObject_MockObject
      */
     protected $objectManager;
 
+    /**
+     * @var RouteFactory|\PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $factory;
+
     public function setUp()
     {
         $this->objectManager = $this->getMock('Magento\Framework\ObjectManagerInterface');
+
+        $objectManager = new ObjectManager($this);
+        $this->factory = $objectManager->getObject(
+            'Magento\Framework\Controller\Router\Route\Factory',
+            [
+                'objectManager' => $this->objectManager,
+            ]
+        );
     }
 
     /**
      * @test
+     * @return void
      */
     public function testCreateRoute()
     {
-        $routerClass = 'router';
+        $routeClass = 'router';
+        $paramRoute = 'route';
 
-        $router = $this->getMockBuilder('Zend_Controller_Router_Route_Interface')
-            ->setMockClassName($routerClass)
+        $router = $this->getMockBuilder('Magento\Framework\App\RouterInterface')
+            ->setMockClassName($routeClass)
             ->getMock();
 
-        $parameterRoute    = 'route';
-        $parameterDefaults = 'defaults';
-        $parameterRegs     = 'regs';
-        $parameterLocale   = 'locale';
-
         $this->objectManager->expects($this->once())
             ->method('create')
-            ->with(
-                $this->logicalOr(
-                    $routerClass,
-                    [
-                        'route'    => $parameterRoute,
-                        'defaults' => $parameterDefaults,
-                        'regs'     => $parameterRegs,
-                        'locale'   => $parameterLocale,
-                    ]
-                )
-            )
+            ->with($routeClass, ['route' => $paramRoute])
             ->will($this->returnValue($router));
 
-        $object = new \Magento\Framework\Controller\Router\Route\Factory($this->objectManager);
-        $expectedRouter = $object->createRoute(
-            $routerClass,
-            $parameterRoute,
-            $parameterDefaults,
-            $parameterRegs,
-            $parameterLocale
-        );
+        $result = $this->factory->createRoute($routeClass, $paramRoute);
 
-        $this->assertInstanceOf($routerClass, $expectedRouter);
-        $this->assertInstanceOf('Zend_Controller_Router_Route_Interface', $expectedRouter);
+        $this->assertInstanceOf($routeClass, $result);
+        $this->assertInstanceOf('Magento\Framework\App\RouterInterface', $result);
     }
 
     /**
      * @test
      * @expectedException \LogicException
+     * @return void
      */
     public function testCreateRouteNegative()
     {
         $this->objectManager->expects($this->once())
             ->method('create')
             ->will($this->returnValue(new \StdClass()));
 
-        $object = new \Magento\Framework\Controller\Router\Route\Factory($this->objectManager);
+        $object = new Factory($this->objectManager);
         $object->createRoute(
             'routerClass',
             'router'