Skip to content

Commit

Permalink
Added Router unit test
Browse files Browse the repository at this point in the history 
Signed-off-by: dchill42 <dchill42@gmail.com>
  • Loading branch information
@dchill42
dchill42 committed Sep 16, 2012
1 parent 6f7b0b6 commit bcc5865
Show file tree
Hide file tree
Showing 7 changed files with 547 additions and 107 deletions.
104 changes: 48 additions & 56 deletions system/core/Router.php
View file
Expand Up @@ -9,7 +9,7 @@
* Licensed under the Open Software License version 3.0
*
* This source file is subject to the Open Software License (OSL 3.0) that is
* bundled with this package in the files license.txt / license.rst. It is
* bundled with this package in the files license.txt / license.rst. It is
* also available through the world wide web at this URL:
* http://opensource.org/licenses/OSL-3.0
* If you did not receive a copy of the license and are unable to obtain it
Expand Down Expand Up @@ -103,70 +103,52 @@ public function _set_routing()
// Load the routes.php file.
$route = $this->CI->config->get('routes.php', 'route');

// Set routes
// Set route remapping
$this->routes = is_array($route) ? $route : array();
unset($route);

// Set the default controller so we can display it in the event
// the URI doesn't correlate to a valid controller.
$this->default_controller = empty($this->routes['default_controller']) ? FALSE :
strtolower($this->routes['default_controller']);
strtolower($this->routes['default_controller']);

// Are query strings enabled in the config file? Normally CI doesn't utilize query strings
// since URI segments are more search-engine friendly, but they can optionally be used.
// If this feature is enabled, we will gather the directory/class/method a little differently
$uri =& $this->CI->uri;
$config =& $this->CI->config;
$ctl_trigger = $config->item('controller_trigger');
if ($config->item('enable_query_strings') === TRUE && isset($_GET[$ctl_trigger]))
$ctl_trigger = $this->CI->config->item('controller_trigger');
if ($this->CI->config->item('enable_query_strings') === TRUE && isset($_GET[$ctl_trigger]))
{
$segments = array();

// Add directory segment if provided
$dir_trigger = $config->item('directory_trigger');
$dir_trigger = $this->CI->config->item('directory_trigger');
if (isset($_GET[$dir_trigger]))
{
$segments[] = trim($uri->_filter_uri($_GET[$dir_trigger]));
$segments[] = trim($this->CI->uri->_filter_uri($_GET[$dir_trigger]));
}

// Add controller segment - this was qualified above
$class = trim($uri->_filter_uri($_GET[$ctl_trigger]));
$class = trim($this->CI->uri->_filter_uri($_GET[$ctl_trigger]));
$segments[] = $class;

// Add function segment if provided
$fun_trigger = $config->item('function_trigger');
$fun_trigger = $this->CI->config->item('function_trigger');
if (isset($_GET[$fun_trigger]))
{
$segments[] = trim($uri->_filter_uri($_GET[$fun_trigger]));
$segments[] = trim($this->CI->uri->_filter_uri($_GET[$fun_trigger]));
}

// Determine if segments point to a valid route
$route = $this->validate_route($segments);
if ($route === FALSE)
{
// Invalid request - show a 404
show_404($class);
}

// Set route stack and clean directory and class
$this->route_stack = $route;
$this->set_directory($route[self::SEG_SUBDIR]);
$this->set_class($route[self::SEG_CLASS]);
return;
}
else
{
// Fetch the complete URI string, remove the suffix, and explode
$this->CI->uri->_fetch_uri_string();
$this->CI->uri->_remove_url_suffix();
$this->CI->uri->_explode_segments();
$segments = $this->CI->uri->segments;
}

// Fetch the complete URI string
$uri->_fetch_uri_string();

// Do we need to remove the URL suffix?
$uri->_remove_url_suffix();

// Compile the segments into an array
$uri->_explode_segments();

// Parse any custom routing that may exist
// The default route will be applied if valid and necessary
$this->_parse_routes();
// Set the route stack
$this->_set_request($segments);
}

// --------------------------------------------------------------------
Expand All @@ -177,10 +159,10 @@ public function _set_routing()
* This function takes an array of URI segments as
* input, and sets the current class/method
*
* @param array
* @param array Route segments
* @return void
*/
protected function _set_request($segments = array())
protected function _set_request(array $segments)
{
// Determine if segments point to a valid route
$route = $this->validate_route($segments);
Expand Down Expand Up @@ -227,20 +209,25 @@ protected function _set_request($segments = array())
public function validate_route($route)
{
// If we don't have any segments, the default will have to do
if (count($route) == 0)
if (empty($route))
{
$route = $this->_default_segments();
if (empty($route)) {
if (empty($route))
{
// No default - fail
return FALSE;
}
}

// Explode route if not already segmented
if (!is_array($route)) {
if ( ! is_array($route))
{
$route = explode('/', $route);
}

// Parse any custom routing that may exist
$route = $this->_parse_routes($route);

// Search paths for controller
foreach ($this->CI->load->get_package_paths() as $path)
{
Expand Down Expand Up @@ -279,12 +266,12 @@ public function validate_route($route)
}

// Get class and method
$class = array_unshift($default);
$method = array_unshift($default);
$class = array_shift($default);
$method = array_shift($default);
}

// Does the requested controller exist in the sub-folder?
if (file_exists($path.'controllers/'.$route[0].$class.'.php'))
if (file_exists($path.'controllers/'.$route[0].'/'.$class.'.php'))
{
// Found it - assemble segments
if ( ! isset($route[1]))
Expand Down Expand Up @@ -320,18 +307,18 @@ public function validate_route($route)
* the config/routes.php file against the URI to
* determine if the class/method need to be remapped.
*
* @return void
* @param array Route segments
* @return array Remapped segments
*/
protected function _parse_routes()
protected function _parse_routes(array $segments)
{
// Turn the segment array into a URI string
$segments = $this->CI->uri->segments;
$uri = implode('/', $segments);

// Is there a literal match? If so we're done
if (isset($this->routes[$uri]))
{
return $this->_set_request(explode('/', $this->routes[$uri]));
return explode('/', $this->routes[$uri]);
}

// Loop through the route array looking for wild-cards
Expand All @@ -349,13 +336,13 @@ protected function _parse_routes()
$val = preg_replace('#^'.$key.'$#', $val, $uri);
}

return $this->_set_request(explode('/', $val));
return explode('/', $val);
}
}

// If we got this far it means we didn't encounter a
// matching route so we'll set the site default route
$this->_set_request($segments);
// matching route so we'll return the segments unchanged
return $segments;
}

// --------------------------------------------------------------------
Expand Down Expand Up @@ -482,11 +469,11 @@ public function fetch_route()
* @return mixed FALSE if route doesn't exist, otherwise array of 4+ segments
*/
public function get_error_route($is404 = FALSE)
{
{
// Select route
$route = ($is404 ? '404' : 'error').'_override';

// See if 404_override is defined
// See if error or 404 override is defined
if (empty($this->routes[$route])) {
// No override to apply
return FALSE;
Expand All @@ -511,6 +498,11 @@ public function _set_overrides($routing)
return;
}

if (isset($routing['path']))
{
$this->set_path($routing['path']);
}

if (isset($routing['directory']))
{
$this->set_directory($routing['directory']);
Expand Down Expand Up @@ -539,7 +531,7 @@ public function _set_overrides($routing)
protected function _default_segments()
{
// Check for default controller
if ($this->default_controller === FALSE)
if (empty($this->default_controller))
{
// Return empty array
return array();
Expand Down
9 changes: 7 additions & 2 deletions tests/codeigniter/core/CodeIgniter_test.php
View file
Expand Up @@ -174,7 +174,7 @@ public function test_sub_instance()
$class = 'Mock_Core_CodeIgniter';
$subclass = $pre.$class;
$content = '<?php class '.$subclass.' extends '.$class.' { }';
$this->ci_vfs_create($subclass, $content, $this->ci_vfs_root, $path, 'core');
$this->ci_vfs_create($subclass, $content, $this->ci_vfs_root, array($path, 'core'));

// Create instance
$CI = Mock_Core_CodeIgniter::instance($this->ci_base_path, $this->ci_app_path);
Expand Down Expand Up @@ -737,7 +737,12 @@ private function _create_config(array $config, $name = 'config', $sub = NULL)
$content = '<?php $'.$name.' = '.var_export($config, TRUE).';';

// Create file under subdirectory of app config dir
$this->ci_vfs_create($name, $content, $this->ci_app_root, 'config', $sub);
$path = array('config');
if ($sub)
{
$path[] = $sub;
}
$this->ci_vfs_create($name, $content, $this->ci_app_root, $path);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion tests/codeigniter/core/Config_test.php
View file
Expand Up @@ -245,7 +245,7 @@ public function test_get()
);
$dir = 'package';
$content = '<?php $'.$name.' = '.var_export($cfg2, TRUE).';';
$this->ci_vfs_create($file, $content, $this->ci_vfs_root, $dir, 'config');
$this->ci_vfs_create($file, $content, $this->ci_vfs_root, array($dir, 'config'));

// Add config path
array_push($this->config->_config_paths, $this->ci_vfs_path($dir.'/'));
Expand Down
13 changes: 7 additions & 6 deletions tests/codeigniter/core/Loader_test.php
View file
Expand Up @@ -116,7 +116,7 @@ public function test_library_config()
$class = 'CI_'.$lib;
$content = '<?php class '.$class.
' { public function __construct($params = NULL) { $this->config = $params; } } ';
$this->ci_vfs_create($lib, $content, $this->ci_base_root, 'libraries', $sub);
$this->ci_vfs_create($lib, $content, $this->ci_base_root, array('libraries', $sub));

// Create config to be loaded
// For isolation, we just set the contents in CI_TestConfig to be retrieved
Expand Down Expand Up @@ -200,7 +200,7 @@ public function test_driver()
$driver = 'unit_test_driver';
$dir = ucfirst($driver);
$class = 'CI_'.$dir;
$this->ci_vfs_create($driver, $this->_empty($class), $this->ci_base_root, 'libraries', $dir);
$this->ci_vfs_create($driver, $this->_empty($class), $this->ci_base_root, array('libraries', $dir));

// Test loading as an array.
$this->assertNull($this->load->driver(array($driver)));
Expand Down Expand Up @@ -265,7 +265,7 @@ public function test_model_subdir()
$base = 'CI_Model';
$class = ucfirst($model);
$subdir = 'cars';
$this->ci_vfs_create($model, $this->_empty($class, $base), $this->ci_app_root, 'models', $subdir);
$this->ci_vfs_create($model, $this->_empty($class, $base), $this->ci_app_root, array('models', $subdir));

// Load model
$name = 'testors';
Expand Down Expand Up @@ -401,7 +401,8 @@ public function test_controller_result()
$subdir = 'special';
$class = 'TestResultCtlr';
$method = 'result_handler';
$this->ci_vfs_create(strtolower($class), $this->_empty($class), $this->ci_app_root, 'controllers', $subdir);
$this->ci_vfs_create(strtolower($class), $this->_empty($class), $this->ci_app_root,
array('controllers', $subdir));

// Create route stack to pass
$route = array(
Expand Down Expand Up @@ -660,14 +661,14 @@ public function test_autoloader()
$drv = 'autodrv';
$subdir = ucfirst($drv);
$drv_class = 'CI_'.$subdir;
$this->ci_vfs_create($drv, $this->_empty($drv_class), $this->ci_base_root, 'libraries', $subdir);
$this->ci_vfs_create($drv, $this->_empty($drv_class), $this->ci_base_root, array('libraries', $subdir));

// Create package directory in app path with model
$dir = 'testdir';
$path = $this->ci_app_path.$dir.'/';
$model = 'automod';
$mod_class = ucfirst($model);
$this->ci_vfs_create($model, $this->_empty($mod_class), $this->ci_app_root, $dir, 'models');
$this->ci_vfs_create($model, $this->_empty($mod_class), $this->ci_app_root, array($dir, 'models'));

// Autoload path since autoloaded packages are handled during bootstrapping
$this->load->add_package_path($path);
Expand Down

0 comments on commit bcc5865

Please sign in to comment.