Changeset 7525

Timestamp:

02/17/08 11:30:23 (9 months ago)

Author:

fabien

Message:

refactored sfPatternRouting

• everything is BC
  
• rewrote the connect(), parse() and generate() algorithm from scratch
  
  • the route parsing in connect() is much more robust now and extensible
    
  • removed all hacks related to the suffix and the first/last /
    
  • implemented sensible rules for optional segments
    
    • the last variable is optional
      
    • the n-1 variable is only optional if the n variable is optional
      
    • a static segment is not optional
      
    • a * segment is not optional
      
  • the generated regexes are easier to debug (indentation and embedded variable names)
    
  • an exception is thrown if the route is not parsable
    
  • all variables have specific requirements based on the current configuration (see below)
    
  • parse() and generate() have similar behaviors (defaults, requirements, ...)
    
  • parse() and generate() must be faster for typical cases (more optimizations to come)
    
  • parse() returns all variables in the array (null if the variable is optional and not provided)
    
• added more configurability to the system
  
  • the variable prefix is configurable via the variable_prefixes option (: by default)
    
  • the route segment separator is configurable via the segment_separators option (/ or . by default)
    
  • the acceptable character set for a variable is configurable via the variable_regex option ([\w\d_]+ by default)
    
  • so, routes like /foo/:bar.:format are now possible out of the box if you have the latest .htaccess
    
• merged unit tests suite from the routing/ branch (francois)
  
• added unit tests for some edge cases
  

You have to clear your project caches after upgrading because the internal format of the routes has changed.

Files:

• branches/1.1/lib/routing/sfNoRouting.class.php (modified) (2 diffs)
• branches/1.1/lib/routing/sfPathInfoRouting.class.php (modified) (1 diff)
• branches/1.1/lib/routing/sfPatternRouting.class.php (modified) (15 diffs)
• branches/1.1/lib/routing/sfRouting.class.php (modified) (1 diff)
• branches/1.1/test/unit/routing/sfPatternRoutingTest.php (modified) (10 diffs)

branches/1.1/lib/routing/sfNoRouting.class.php

@@ -24 +24 @@
-  public function getCurrentInternalUri($with_route_name = false)
-  {
-array_merge
+$this->mergeArrays
-    $action = sprintf('%s/%s', $parameters['module'], $parameters['action']);
-
@@ -40 +40 @@
-  public function generate($name, $params, $querydiv = '/', $divider = '/', $equals = '/')
-  {
-array_merge
+$this->mergeArrays
-
-    return '/'.($parameters ? '?'.$parameters : '');

branches/1.1/lib/routing/sfPathInfoRouting.class.php

@@ -43 +43 @@
-  {
-    $url = '';
-array_merge
+$this->mergeArrays
-    {
-      $url .= '/'.$key.'/'.$value;

branches/1.1/lib/routing/sfPatternRouting.class.php

@@ -3 +3 @@
-/*
- * This file is part of the symfony package.
-2004-2006 
+
- *
- * For the full copyright and license information, please view the LICENSE
@@ -13 +13 @@
- *
- * It maps an array of parameters to URLs definition. Each map is called a route.
- *
- * This class was initialy based on the Routes class of the Cake framework.
- *
- * @package    symfony
@@ -31 +29 @@
-
-  /**
+   * Initializes this Routing.
+   *
+   * Available options:
+   *
+   *  * suffix:             The default suffix
+   *  * variable_prefixes:  An array of characters that starts a variable name (: by default)
+   *  * segment_separators: An array of allowed characters for segment separators (/ and . by default)
+   *  * variable_regex:     A regex that match a valid variable name ([\w\d_]+ by default)
+   *
-   * @see sfRouting
-   */
-  public function initialize(sfEventDispatcher $dispatcher, $options = array())
-  {
+    if (!isset($options['variable_prefixes']))
+    {
+      $options['variable_prefixes'] = array(':');
+    }
+
+    if (!isset($options['segment_separators']))
+    {
+      $options['segment_separators'] = array('/', '.');
+    }
+
+    if (!isset($options['variable_regex']))
+    {
+      $options['variable_regex'] = '[\w\d_]+';
+    }
+
+    $options['variable_prefix_regex']    = '(?:'.implode('|', array_map(create_function('$a', 'return preg_quote($a, \'#\');'), $options['variable_prefixes'])).')';
+    $options['segment_separators_regex'] = '(?:'.implode('|', array_map(create_function('$a', 'return preg_quote($a, \'#\');'), $options['segment_separators'])).')';
+    $options['variable_content_regex']   = '[^'.implode('', array_map(create_function('$a', 'return str_replace(\'-\', \'\-\', preg_quote($a, \'#\'));'), $options['segment_separators'])).']+';
+
-    parent::initialize($dispatcher, $options);
-
@@ -69 +95 @@
-      $parameters = $this->currentRouteParameters;
-
-p, $names, $namesHash, $defaults, $requirements, $suffix
+, $variables, $defaults, $requirements
-
-      $internalUri = $withRouteName ? '@'.$this->currentRouteName : $parameters['module'].'/'.$parameters['action'];
@@ -76 +102 @@
-
-      // add parameters
-$names as $nam
-
-name == 'module' || $nam
+array_keys($variables) as $variabl
+
+variable == 'module' || $variabl
-        {
-          continue;
-        }
-
-name.'='.(isset($parameters[$name]) ? $parameters[$name] : (isset($defaults[$name]) ? $defaults[$nam
+variable.'='.(isset($parameters[$variable]) ? $parameters[$variable] : (isset($defaults[$variable]) ? $defaults[$variabl
-      }
-
-      // add * parameters if needed
-strpos($url, '*
+false !== strpos($regex, '_star
-      {
-        foreach ($parameters as $key => $value)
-        {
-n_array($key, $names
+sset($variables[$key]
-          {
-            continue;
@@ -205 +231 @@
-   *
-   * <code>
-
+default', '
-   * </code>
-   *
@@ -215 +241 @@
-   * @return array  current routes
-   */
-
+s
-  {
-    // route already exists?
@@ -223 +249 @@
-    }
-
-    $parsed = array();
-    $names  = array();
-    $suffix = $this->defaultSuffix;
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-    else
-    {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-          }
-          else
-          {
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-        else
-        {
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-
@@ -336 +417 @@
-      }
-
-
-
+
+
+
-
-      // all params must be given
-
-
-
-
-
-
+
+
+
-      }
-    }
@@ -354 +433 @@
-      foreach ($this->routes as $name => $route)
-      {
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-          {
-            continue 2;
@@ -382 +452 @@
-        }
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        $found = true;
-        break;
@@ -402 +478 @@
-    }
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-    {
-      $tmp = array();
-
-
-
-
+
+
-        if (is_array($value))
-        {
@@ -427 +504 @@
-      }
-      $tmp = implode($divider, $tmp);
-strlen($tmp) > 0
+$tmp
-      {
-        $tmp = $querydiv.$tmp;
-      }
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-    }
-
@@ -454 +521 @@
-  {
-    // an URL should start with a '/', mod_rewrite doesn't respect that, but no-mod_rewrite version does.
-$url && ('/' != $url[0])
+'/' != $url[0]
-    {
-      $url = '/'.$url;
@@ -460 +527 @@
-
-    // we remove the query string
-
+false !== 
-    {
-      $url = substr($url, 0, $pos);
-    }
-
-we 
+
-    $url = preg_replace('#/+#', '/', $url);
-
-break
+
+found
-    foreach ($this->routes as $routeName => $route)
-    {
-
-
-
-
+
+
+
+
+
+
-      $defaults = array_merge($defaults, $this->defaultParameters);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-
-    // no route found
-
-
-
-
-
-
-
-
-
+
+
-      throw new sfError404Exception(sprintf('No matching route found for "%s"', $url));
-    }
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-  }
-}

branches/1.1/lib/routing/sfRouting.class.php

@@ -180 +180 @@
-  }
-
+  protected function mergeArrays($arr1, $arr2)
+  {
+    foreach ($arr2 as $key => $value)
+    {
+      $arr1[$key] = $value;
+    }
+
+    return $arr1;
+  }
+
-  /**
-   * Listens to the user.change_culture event.

branches/1.1/test/unit/routing/sfPatternRoutingTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-74
+122
-
-class sfPatternRoutingTest extends sfPatternRouting
@@ -22 +22 @@
-
-// public methods
-, array('default_module' => 'default', 'default_action' => 'index')
-clearRoutes', 'connect', 'generate', 'getCurrentInternalUri', 'getCurrentRouteName', 'getRoutes', 'hasRoutes', 'parse', 'setRoutes
+
+initialize', 'getCurrentInternalUri', 'getRoutes', 'setRoutes', 'hasRoutes', 'clearRoutes', 'hasRouteName', 'prependRoute', 'appendRoute', 'connect', 'generate', 'parse
-{
-  $t->can_ok($r, $method, sprintf('"%s" is a method of sfRouting', $method));
@@ -63 +63 @@
-$t->is($r->hasRoutes(), true, '->hasRoutes() returns true if some routes are registered');
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-// simple routes
@@ -78 +101 @@
-$t->is($r->generate('', $params), $url, 'generate /:module/:action url');
-
+// order
+$t->diag('route order');
+$r->clearRoutes();
+$r->connect('test', '/test/:id', array('module' => 'default1', 'action' => 'index1'), array('id' => '\d+'));
+$r->connect('test1', '/test/:id', array('module' => 'default2', 'action' => 'index2'));
+$params = array('module' => 'default1', 'action' => 'index1', 'id' => '12');
+$url = '/test/12';
+$t->is($r->parse($url), $params, '->parse()    takes the first matching route');
+$t->is($r->generate('', $params), $url, '->generate() takes the first matching route');
+
+$params = array('module' => 'default2', 'action' => 'index2', 'id' => 'foo');
+$url = '/test/foo';
+$t->is($r->parse($url), $params, '->parse()    takes the first matching route');
+$t->is($r->generate('', $params), $url, '->generate() takes the first matching route');
+
+$r->clearRoutes();
+$r->connect('test', '/:module/:action/test/:id/:test', array('module' => 'default', 'action' => 'index'));
+$r->connect('test1', '/:module/:action/test/:id', array('module' => 'default', 'action' => 'index', 'id' => 'foo'));
+$params = array('module' => 'default', 'action' => 'index', 'id' => 'foo', 'test' => null);
+$url = '/default/index/test/foo';
+$t->is($r->parse($url), $params, '->parse()    takes the first matching route');
+$t->is($r->generate('', $params), $url, '->generate() takes the first matching route');
+
-// suffix
+$t->diag('suffix');
-$r->clearRoutes();
-$r->setDefaultSuffix('.html');
-', '/foo/:module/:action/:param.foo', array('module' => 'default', 'action' => 'index
-  = '/foo/default/index/foo.foo
+0', '/foo0/:module/:action/:param0', array('module' => 'default', 'action' => 'index0
+0 = '/foo0/default/index0/foo0.html
-$r->connect('foo1', '/foo1/:module/:action/:param1.', array('module' => 'default', 'action' => 'index1'));
-$url1 = '/foo1/default/index1/foo1';
-$r->connect('foo2', '/foo2/:module/:action/:param2/', array('module' => 'default', 'action' => 'index2'));
-$url2 = '/foo2/default/index2/foo2/';
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-$r->setDefaultSuffix('.');
-
-// duplicate names
-$msg = '->connect() throws an sfConfigurationException when a route already exists with same name';
-$r->clearRoutes();
-$r->connect('test', '/index.php/:module/:action', array('module' => 'default', 'action' => 'index'));
-try
-{
-  $r->connect('test', '/index.php/:module/:action', array('module' => 'default', 'action' => 'index'));
-
-  $t->fail($msg);
-}
-catch (sfConfigurationException $e)
-{
-  $t->pass($msg);
-}
-
-// query string
+$t->diag('query string');
-$r->clearRoutes();
-$r->connect('test', '/index.php/:module/:action', array('module' => 'default', 'action' => 'index'));
@@ -124 +163 @@
-
-// default values
+$t->diag('default values');
-$r->clearRoutes();
-$r->connect('test', '/:module/:action', array('module' => 'default', 'action' => 'index'));
+$t->is($r->generate('', array('module' => 'default')), '/default/index', 
+    '->generate() creates URL for route with missing parameter if parameter is set in the default values');
+$t->is($r->parse('/default'), array('module' => 'default', 'action' => 'index'), 
+    '->parse()    finds route for URL   with missing parameter if parameter is set in the default values');
+
+$r->clearRoutes();
+$r->connect('test', '/:module/:action/:foo', array('module' => 'default', 'action' => 'index', 'foo' => 'bar'));
+$t->is($r->generate('', array('module' => 'default')), '/default/index/bar', 
+    '->generate() creates URL for route with more than one missing parameter if default values are set');
+$t->is($r->parse('/default'), array('module' => 'default', 'action' => 'index', 'foo' => 'bar'), 
+    '->parse()    finds route for URL   with more than one missing parameter if default values are set');
+
+$r->clearRoutes();
+$r->connect('test', '/:module/:action', array('module' => 'default', 'action' => 'index'));
+$params = array('module' => 'foo', 'action' => 'bar');
+$url = '/foo/bar';
+$t->is($r->generate('', $params), $url, '->generate() parameters override the route default values');
+$t->is($r->parse($url), $params, '->parse()    finds route with parameters distinct from the default values');
+
+$r->clearRoutes();
+$r->connect('test', '/:module/:action', array('module' => 'default'));
-$params = array('module' => 'default', 'action' => 'index');
-$url = '/default/index';
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-$r->clearRoutes();
-$r->connect('test', '/:module/:action/:test/:id', array('module' => 'default', 'action' => 'index', 'id' => 'toto'));
-$params = array('module' => 'default', 'action' => 'index', 'test' => 'foo', 'id' => 'bar');
-$url = '/default/index/foo/bar';
-$t->is($r->parse($url), $params, '->parse() routes have default parameters value that can be overriden');
-$t->is($r->generate('', $params), $url, '->generate() routes have default parameters value that can be overriden');
+$t->is($r->parse($url), $params, '->parse()    routes have default parameters value that can be overriden');
-$params = array('module' => 'default', 'action' => 'index', 'test' => 'foo', 'id' => 'toto');
-$url = '/default/index/foo';
-
-
-
-
-
-
-
-
-
-
-
+
+
-
-$r->clearRoutes();
@@ -173 +208 @@
-$params = array('module' => 'default', 'action' => 'index', 'test' => 'foo', 'id' => 'bar');
-$url = '/default/index';
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-$r->clearRoutes();
-$r->connect('test', '/:module/:action/test/*', array('module' => 'default', 'action' => 'index'));
+$params = array('module' => 'default', 'action' => 'index');
+$url = '/default/index/test';
+$t->is($r->parse($url), $params, '->parse()    finds route for URL   with no additional parameters when route ends with unnamed wildcard *');
+$t->is($r->generate('', $params), $url, '->generate() creates URL for route with no additional parameters when route ends with unnamed wildcard *');
-$params = array('module' => 'default', 'action' => 'index', 'page' => '4.html', 'toto' => true, 'titi' => 'toto', 'OK' => true);
-$url = '/default/index/test/page/4.html/toto/1/titi/toto/OK/1';
-
-
-
-
-
+
+
+
+
+
+
-$r->clearRoutes();
-$r->connect('test',  '/:module', array('action' => 'index'));
@@ -191 +241 @@
-$params = array('module' => 'default', 'action' => 'index', 'toto' => 'titi');
-$url = '/default/index/toto/titi';
-
+   
-$t->is($r->generate('', $params), $url, '->generate() takes the first matching route but takes * into accounts');
-$params = array('module' => 'default', 'action' => 'index');
-$url = '/default';
-
+