fix: [Auto Routing Improved] feature testing may not find controller/method#7543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 9 commits into from
Jun 13, 2023
Merged

fix: [Auto Routing Improved] feature testing may not find controller/method #7543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d4bcffd
test: add test for feature testing and auto routing improved
kenjis Jun 6, 2023
7dbf0d1
fix: [BC] feature testing may use incorrect HTTP verb for auto routin…
kenjis Jun 6, 2023
a932dc1
test: update test code
kenjis Jun 6, 2023
3410ea9
fix: ensure HTTP verb is lower case
kenjis Jun 6, 2023
c32182e
refactor: remove unused private property
kenjis Jun 6, 2023
ab0ebb9
docs: add docs
kenjis Jun 6, 2023
27729b1
chore: add skip rule for deprecated constructor param
kenjis Jun 7, 2023
fbff5a2
docs: add deprecation
kenjis Jun 10, 2023
f22139b
docs: add value examples
kenjis Jun 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions rector.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
use Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector;
use Rector\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector;
Expand DownExpand Up@@ -88,6 +89,11 @@
__DIR__ . '/tests/system/Test/ReflectionHelperTest.php',
],

RemoveUnusedConstructorParamRector::class => [
// @TODO remove if deprecated $httpVerb is removed
__DIR__ . '/system/Router/AutoRouterImproved.php',
],

// call on purpose for nothing happen check
RemoveEmptyMethodCallRector::class => [
__DIR__ . '/tests',
Expand Down
2 changes: 1 addition & 1 deletion system/Router/AutoRouter.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function __construct(
*
* @return array [directory_name, controller_name, controller_method, params]
*/
public function getRoute(string $uri): array
public function getRoute(string $uri, string $httpVerb): array
{
$segments = explode('/', $uri);

Expand Down
24 changes: 11 additions & 13 deletions system/Router/AutoRouterImproved.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,11 +58,6 @@ final class AutoRouterImproved implements AutoRouterInterface
*/
private bool $translateURIDashes;

/**
* HTTP verb for the request.
*/
private string $httpVerb;

/**
* The namespace for controllers.
*/
Expand All@@ -74,15 +69,17 @@ final class AutoRouterImproved implements AutoRouterInterface
private string $defaultController;

/**
* The name of the default method
* The name of the default method without HTTP verb prefix.
*/
private string $defaultMethod;

/**
* @param class-string[] $protectedControllers
* @param string $defaultController Short classname
*
* @deprecated $httpVerb is deprecated. No longer used.
*/
public function __construct(
public function __construct(// @phpstan-ignore-line
array $protectedControllers,
string $namespace,
string $defaultController,
Expand All@@ -93,22 +90,23 @@ public function __construct(
$this->protectedControllers = $protectedControllers;
$this->namespace = rtrim($namespace, '\\') . '\\';
$this->translateURIDashes = $translateURIDashes;
$this->httpVerb = $httpVerb;
$this->defaultController = $defaultController;
$this->defaultMethod = $httpVerb . ucfirst($defaultMethod);
$this->defaultMethod = $defaultMethod;

// Set the default values
$this->controller = $this->defaultController;
$this->method = $this->defaultMethod;
}

/**
* Finds controller, method and params from the URI.
*
* @return array [directory_name, controller_name, controller_method, params]
*/
public function getRoute(string $uri): array
public function getRoute(string $uri, string $httpVerb): array
{
$defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
$this->method = $defaultMethod;

$segments = explode('/', $uri);

// WARNING: Directories get shifted out of the segments array.
Expand DownExpand Up@@ -144,10 +142,10 @@ public function getRoute(string $uri): array
$methodSegment = $this->translateURIDashes(array_shift($nonDirSegments));

// Prefix HTTP verb
$this->method = $this->httpVerb . ucfirst($methodSegment);
$this->method = $httpVerb . ucfirst($methodSegment);

// Prevent access to default method path
if (strtolower($this->method) === strtolower($this->defaultMethod)) {
if (strtolower($this->method) === strtolower($defaultMethod)) {
throw new PageNotFoundException(
'Cannot access the default method "' . $this->method . '" with the method name URI path.'
);
Expand Down
2 changes: 1 addition & 1 deletion system/Router/AutoRouterInterface.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,5 +21,5 @@ interface AutoRouterInterface
*
* @return array [directory_name, controller_name, controller_method, params]
*/
public function getRoute(string $uri): array;
public function getRoute(string $uri, string $httpVerb): array;
}
6 changes: 4 additions & 2 deletions system/Router/RouteCollection.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,7 @@ class RouteCollection implements RouteCollectionInterface
/**
* The current method that the script is being called by.
*
* @var string
* @var string HTTP verb (lower case) like `get`,`post` or `*`
*/
protected $HTTPVerb = '*';

Expand DownExpand Up@@ -550,11 +550,13 @@ public function getHTTPVerb(): string
* Sets the current HTTP verb.
* Used primarily for testing.
*
* @param string $verb HTTP verb
*
* @return $this
*/
public function setHTTPVerb(string $verb)
{
$this->HTTPVerb = $verb;
$this->HTTPVerb = strtolower($verb);

return $this;
}
Expand Down
4 changes: 2 additions & 2 deletions system/Router/Router.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,7 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
$this->controller = $this->collection->getDefaultController();
$this->method = $this->collection->getDefaultMethod();

$this->collection->setHTTPVerb(strtolower($request->getMethod() ?? $_SERVER['REQUEST_METHOD']));
$this->collection->setHTTPVerb($request->getMethod() ?? $_SERVER['REQUEST_METHOD']);

$this->translateURIDashes = $this->collection->shouldTranslateURIDashes();

Expand DownExpand Up@@ -504,7 +504,7 @@ protected function checkRoutes(string $uri): bool
public function autoRoute(string $uri)
{
[$this->directory, $this->controller, $this->method, $this->params]
= $this->autoRouter->getRoute($uri);
= $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb());
}

/**
Expand Down
36 changes: 18 additions & 18 deletions tests/system/Router/AutoRouterImprovedTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodGet()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('/');
= $router->getRoute('/', 'get');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
Expand All@@ -72,7 +72,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodPost()
$router = $this->createNewAutoRouter('post');

[$directory, $controller, $method, $params]
= $router->getRoute('/');
= $router->getRoute('/', 'post');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
Expand All@@ -85,7 +85,7 @@ public function testAutoRouteFindsControllerWithFileAndMethod()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('mycontroller/somemethod');
= $router->getRoute('mycontroller/somemethod', 'get');

$this->assertNull($directory);
$this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -98,7 +98,7 @@ public function testFindsControllerAndMethodAndParam()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('mycontroller/somemethod/a');
= $router->getRoute('mycontroller/somemethod/a', 'get');

$this->assertNull($directory);
$this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -115,15 +115,15 @@ public function testUriParamCountIsGreaterThanMethodParams()

$router = $this->createNewAutoRouter();

$router->getRoute('mycontroller/somemethod/a/b');
$router->getRoute('mycontroller/somemethod/a/b', 'get');
}

public function testAutoRouteFindsControllerWithFile()
{
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('mycontroller');
= $router->getRoute('mycontroller', 'get');

$this->assertNull($directory);
$this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -136,7 +136,7 @@ public function testAutoRouteFindsControllerWithSubfolder()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('subfolder/mycontroller/somemethod');
= $router->getRoute('subfolder/mycontroller/somemethod', 'get');

$this->assertSame('Subfolder/', $directory);
$this->assertSame('\\' . \CodeIgniter\Router\Controllers\Subfolder\Mycontroller::class, $controller);
Expand All@@ -149,7 +149,7 @@ public function testAutoRouteFindsDashedSubfolder()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('dash-folder/mycontroller/somemethod');
= $router->getRoute('dash-folder/mycontroller/somemethod', 'get');

$this->assertSame('Dash_folder/', $directory);
$this->assertSame(
Expand All@@ -165,7 +165,7 @@ public function testAutoRouteFindsDashedController()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('dash-folder/dash-controller/somemethod');
= $router->getRoute('dash-folder/dash-controller/somemethod', 'get');

$this->assertSame('Dash_folder/', $directory);
$this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -178,7 +178,7 @@ public function testAutoRouteFindsDashedMethod()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('dash-folder/dash-controller/dash-method');
= $router->getRoute('dash-folder/dash-controller/dash-method', 'get');

$this->assertSame('Dash_folder/', $directory);
$this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -191,7 +191,7 @@ public function testAutoRouteFindsDefaultDashFolder()
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('dash-folder');
= $router->getRoute('dash-folder', 'get');

$this->assertSame('Dash_folder/', $directory);
$this->assertSame('\\' . Home::class, $controller);
Expand All@@ -205,7 +205,7 @@ public function testAutoRouteRejectsSingleDot()

$router = $this->createNewAutoRouter();

$router->getRoute('.');
$router->getRoute('.', 'get');
}

public function testAutoRouteRejectsDoubleDot()
Expand All@@ -214,7 +214,7 @@ public function testAutoRouteRejectsDoubleDot()

$router = $this->createNewAutoRouter();

$router->getRoute('..');
$router->getRoute('..', 'get');
}

public function testAutoRouteRejectsMidDot()
Expand All@@ -223,7 +223,7 @@ public function testAutoRouteRejectsMidDot()

$router = $this->createNewAutoRouter();

$router->getRoute('foo.bar');
$router->getRoute('foo.bar', 'get');
}

public function testRejectsDefaultControllerPath()
Expand All@@ -232,7 +232,7 @@ public function testRejectsDefaultControllerPath()

$router = $this->createNewAutoRouter();

$router->getRoute('home');
$router->getRoute('home', 'get');
}

public function testRejectsDefaultControllerAndDefaultMethodPath()
Expand All@@ -241,7 +241,7 @@ public function testRejectsDefaultControllerAndDefaultMethodPath()

$router = $this->createNewAutoRouter();

$router->getRoute('home/index');
$router->getRoute('home/index', 'get');
}

public function testRejectsDefaultMethodPath()
Expand All@@ -250,7 +250,7 @@ public function testRejectsDefaultMethodPath()

$router = $this->createNewAutoRouter();

$router->getRoute('mycontroller/index');
$router->getRoute('mycontroller/index', 'get');
}

public function testRejectsControllerWithRemapMethod()
Expand All@@ -262,6 +262,6 @@ public function testRejectsControllerWithRemapMethod()

$router = $this->createNewAutoRouter();

$router->getRoute('remap/test');
$router->getRoute('remap/test', 'get');
}
}
75 changes: 75 additions & 0 deletions tests/system/Test/FeatureTestAutoRoutingImprovedTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Test;

use CodeIgniter\Events\Events;
use Config\Feature;
use Config\Services;

/**
* @group Others
*
* @internal
*/
final class FeatureTestAutoRoutingImprovedTest extends CIUnitTestCase
{
use FeatureTestTrait;

public static function setUpBeforeClass(): void
{
parent::setUpBeforeClass();

Events::simulate(true);

self::initializeRouter();
}

public static function tearDownAfterClass(): void
{
parent::tearDownAfterClass();

Events::simulate(false);

Services::reset();
}

private static function initializeRouter(): void
{
$routes = Services::routes();
$routes->resetRoutes();
$routes->loadRoutes();

$routes->setAutoRoute(true);
config(Feature::class)->autoRoutesImproved = true;

$namespace = 'Tests\Support\Controllers';
$routes->setDefaultNamespace($namespace);

$router = Services::router($routes);

Services::injectMock('router', $router);
}

public function testCallGet()
{
$response = $this->get('newautorouting');

$response->assertSee('Hello');
}

public function testCallPost()
{
$response = $this->post('newautorouting/save/1/a/b');

$response->assertSee('Saved');
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix: [Auto Routing Improved] feature testing may not find controller/method#7543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 9 commits into

from

Jun 13, 2023
 Merged


fix: [Auto Routing Improved] feature testing may not find controller/method
#7543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4bcffd

test: add test for feature testing and auto routing improved


kenjis Jun 6, 2023
7dbf0d1

fix: [BC] feature testing may use incorrect HTTP verb for auto routin…


kenjis Jun 6, 2023
a932dc1

test: update test code


kenjis Jun 6, 2023
3410ea9

fix: ensure HTTP verb is lower case


kenjis Jun 6, 2023
c32182e

refactor: remove unused private property


kenjis Jun 6, 2023
ab0ebb9

docs: add docs


kenjis Jun 6, 2023
27729b1

chore: add skip rule for deprecated constructor param


kenjis Jun 7, 2023
fbff5a2

docs: add deprecation


kenjis Jun 10, 2023
f22139b

docs: add value examples


kenjis Jun 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
rector.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
use Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector;
use Rector\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector;
Expand DownExpand Up@@ -88,6 +89,11 @@
 __DIR__ . '/tests/system/Test/ReflectionHelperTest.php',
 ],

 RemoveUnusedConstructorParamRector::class => [
 // @TODO remove if deprecated $httpVerb is removed
 __DIR__ . '/system/Router/AutoRouterImproved.php',
 ],

 // call on purpose for nothing happen check
 RemoveEmptyMethodCallRector::class => [
 __DIR__ . '/tests',
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function __construct(
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $segments = explode('/', $uri);

Expand Down

24 changes: 11 additions & 13 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,11 +58,6 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private bool $translateURIDashes;

 /**
 * HTTP verb for the request.
 */
 private string $httpVerb;

 /**
 * The namespace for controllers.
 */
Expand All@@ -74,15 +69,17 @@ final class AutoRouterImproved implements AutoRouterInterface
 private string $defaultController;

 /**
 * The name of the default method
 * The name of the default method without HTTP verb prefix.
 */
 private string $defaultMethod;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
 *
 * @deprecated $httpVerb is deprecated. No longer used.
 */
 public function __construct(
 public function __construct(// @phpstan-ignore-line
 array $protectedControllers,
 string $namespace,
 string $defaultController,
Expand All@@ -93,22 +90,23 @@ public function __construct(
 $this->protectedControllers = $protectedControllers;
 $this->namespace = rtrim($namespace, '\\') . '\\';
 $this->translateURIDashes = $translateURIDashes;
 $this->httpVerb = $httpVerb;
 $this->defaultController = $defaultController;
 $this->defaultMethod = $httpVerb . ucfirst($defaultMethod);
 $this->defaultMethod = $defaultMethod;

 // Set the default values
 $this->controller = $this->defaultController;
 $this->method = $this->defaultMethod;
 }

 /**
 * Finds controller, method and params from the URI.
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = explode('/', $uri);

 // WARNING: Directories get shifted out of the segments array.
Expand DownExpand Up@@ -144,10 +142,10 @@ public function getRoute(string $uri): array
 $methodSegment = $this->translateURIDashes(array_shift($nonDirSegments));

 // Prefix HTTP verb
 $this->method = $this->httpVerb . ucfirst($methodSegment);
 $this->method = $httpVerb . ucfirst($methodSegment);

 // Prevent access to default method path
 if (strtolower($this->method) === strtolower($this->defaultMethod)) {
 if (strtolower($this->method) === strtolower($defaultMethod)) {
 throw new PageNotFoundException(
 'Cannot access the default method "' . $this->method . '" with the method name URI path.'
 );
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouterInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,5 +21,5 @@ interface AutoRouterInterface
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array;
 public function getRoute(string $uri, string $httpVerb): array;
}

6 changes: 4 additions & 2 deletions
system/Router/RouteCollection.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,7 @@ class RouteCollection implements RouteCollectionInterface
 /**
 * The current method that the script is being called by.
 *
 * @var string
 * @var string HTTP verb (lower case) like `get`,`post` or `*`
 */
 protected $HTTPVerb = '*';

Expand DownExpand Up@@ -550,11 +550,13 @@ public function getHTTPVerb(): string
 * Sets the current HTTP verb.
 * Used primarily for testing.
 *
 * @param string $verb HTTP verb
 *
 * @return $this
 */
 public function setHTTPVerb(string $verb)
 {
 $this->HTTPVerb = $verb;
 $this->HTTPVerb = strtolower($verb);

 return $this;
 }
Expand Down

4 changes: 2 additions & 2 deletions
system/Router/Router.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,7 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
 $this->controller = $this->collection->getDefaultController();
 $this->method = $this->collection->getDefaultMethod();

 $this->collection->setHTTPVerb(strtolower($request->getMethod() ?? $_SERVER['REQUEST_METHOD']));
 $this->collection->setHTTPVerb($request->getMethod() ?? $_SERVER['REQUEST_METHOD']);

 $this->translateURIDashes = $this->collection->shouldTranslateURIDashes();

Expand DownExpand Up@@ -504,7 +504,7 @@ protected function checkRoutes(string $uri): bool
 public function autoRoute(string $uri)
 {
 [$this->directory, $this->controller, $this->method, $this->params]
 = $this->autoRouter->getRoute($uri);
 = $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb());
 }

 /**
Expand Down

36 changes: 18 additions & 18 deletions
tests/system/Router/AutoRouterImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodGet()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -72,7 +72,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodPost()
 $router = $this->createNewAutoRouter('post');

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'post');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -85,7 +85,7 @@ public function testAutoRouteFindsControllerWithFileAndMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod');
 = $router->getRoute('mycontroller/somemethod', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -98,7 +98,7 @@ public function testFindsControllerAndMethodAndParam()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod/a');
 = $router->getRoute('mycontroller/somemethod/a', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -115,15 +115,15 @@ public function testUriParamCountIsGreaterThanMethodParams()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/somemethod/a/b');
 $router->getRoute('mycontroller/somemethod/a/b', 'get');
 }

 public function testAutoRouteFindsControllerWithFile()
 {
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller');
 = $router->getRoute('mycontroller', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -136,7 +136,7 @@ public function testAutoRouteFindsControllerWithSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('subfolder/mycontroller/somemethod');
 = $router->getRoute('subfolder/mycontroller/somemethod', 'get');

 $this->assertSame('Subfolder/', $directory);
 $this->assertSame('\\' . \CodeIgniter\Router\Controllers\Subfolder\Mycontroller::class, $controller);
Expand All@@ -149,7 +149,7 @@ public function testAutoRouteFindsDashedSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/mycontroller/somemethod');
 = $router->getRoute('dash-folder/mycontroller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame(
Expand All@@ -165,7 +165,7 @@ public function testAutoRouteFindsDashedController()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/somemethod');
 = $router->getRoute('dash-folder/dash-controller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -178,7 +178,7 @@ public function testAutoRouteFindsDashedMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/dash-method');
 = $router->getRoute('dash-folder/dash-controller/dash-method', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -191,7 +191,7 @@ public function testAutoRouteFindsDefaultDashFolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder');
 = $router->getRoute('dash-folder', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Home::class, $controller);
Expand All@@ -205,7 +205,7 @@ public function testAutoRouteRejectsSingleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('.');
 $router->getRoute('.', 'get');
 }

 public function testAutoRouteRejectsDoubleDot()
Expand All@@ -214,7 +214,7 @@ public function testAutoRouteRejectsDoubleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('..');
 $router->getRoute('..', 'get');
 }

 public function testAutoRouteRejectsMidDot()
Expand All@@ -223,7 +223,7 @@ public function testAutoRouteRejectsMidDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('foo.bar');
 $router->getRoute('foo.bar', 'get');
 }

 public function testRejectsDefaultControllerPath()
Expand All@@ -232,7 +232,7 @@ public function testRejectsDefaultControllerPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home');
 $router->getRoute('home', 'get');
 }

 public function testRejectsDefaultControllerAndDefaultMethodPath()
Expand All@@ -241,7 +241,7 @@ public function testRejectsDefaultControllerAndDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home/index');
 $router->getRoute('home/index', 'get');
 }

 public function testRejectsDefaultMethodPath()
Expand All@@ -250,7 +250,7 @@ public function testRejectsDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/index');
 $router->getRoute('mycontroller/index', 'get');
 }

 public function testRejectsControllerWithRemapMethod()
Expand All@@ -262,6 +262,6 @@ public function testRejectsControllerWithRemapMethod()

 $router = $this->createNewAutoRouter();

 $router->getRoute('remap/test');
 $router->getRoute('remap/test', 'get');
 }
}

75 changes: 75 additions & 0 deletions
tests/system/Test/FeatureTestAutoRoutingImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use CodeIgniter\Events\Events;
use Config\Feature;
use Config\Services;

/**
 * @group Others
 *
 * @internal
 */
final class FeatureTestAutoRoutingImprovedTest extends CIUnitTestCase
{
 use FeatureTestTrait;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 Events::simulate(true);

 self::initializeRouter();
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 Events::simulate(false);

 Services::reset();
 }

 private static function initializeRouter(): void
 {
 $routes = Services::routes();
 $routes->resetRoutes();
 $routes->loadRoutes();

 $routes->setAutoRoute(true);
 config(Feature::class)->autoRoutesImproved = true;

 $namespace = 'Tests\Support\Controllers';
 $routes->setDefaultNamespace($namespace);

 $router = Services::router($routes);

 Services::injectMock('router', $router);
 }

 public function testCallGet()
 {
 $response = $this->get('newautorouting');

 $response->assertSee('Hello');
 }

 public function testCallPost()
 {
 $response = $this->post('newautorouting/save/1/a/b');

 $response->assertSee('Saved');
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: [Auto Routing Improved] feature testing may not find controller/method#7543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 9 commits into

from

Jun 13, 2023
 Merged


fix: [Auto Routing Improved] feature testing may not find controller/method
#7543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4bcffd

test: add test for feature testing and auto routing improved


kenjis Jun 6, 2023
7dbf0d1

fix: [BC] feature testing may use incorrect HTTP verb for auto routin…


kenjis Jun 6, 2023
a932dc1

test: update test code


kenjis Jun 6, 2023
3410ea9

fix: ensure HTTP verb is lower case


kenjis Jun 6, 2023
c32182e

refactor: remove unused private property


kenjis Jun 6, 2023
ab0ebb9

docs: add docs


kenjis Jun 6, 2023
27729b1

chore: add skip rule for deprecated constructor param


kenjis Jun 7, 2023
fbff5a2

docs: add deprecation


kenjis Jun 10, 2023
f22139b

docs: add value examples


kenjis Jun 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
rector.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
use Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector;
use Rector\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector;
Expand DownExpand Up@@ -88,6 +89,11 @@
 __DIR__ . '/tests/system/Test/ReflectionHelperTest.php',
 ],

 RemoveUnusedConstructorParamRector::class => [
 // @TODO remove if deprecated $httpVerb is removed
 __DIR__ . '/system/Router/AutoRouterImproved.php',
 ],

 // call on purpose for nothing happen check
 RemoveEmptyMethodCallRector::class => [
 __DIR__ . '/tests',
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function __construct(
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $segments = explode('/', $uri);

Expand Down

24 changes: 11 additions & 13 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,11 +58,6 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private bool $translateURIDashes;

 /**
 * HTTP verb for the request.
 */
 private string $httpVerb;

 /**
 * The namespace for controllers.
 */
Expand All@@ -74,15 +69,17 @@ final class AutoRouterImproved implements AutoRouterInterface
 private string $defaultController;

 /**
 * The name of the default method
 * The name of the default method without HTTP verb prefix.
 */
 private string $defaultMethod;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
 *
 * @deprecated $httpVerb is deprecated. No longer used.
 */
 public function __construct(
 public function __construct(// @phpstan-ignore-line
 array $protectedControllers,
 string $namespace,
 string $defaultController,
Expand All@@ -93,22 +90,23 @@ public function __construct(
 $this->protectedControllers = $protectedControllers;
 $this->namespace = rtrim($namespace, '\\') . '\\';
 $this->translateURIDashes = $translateURIDashes;
 $this->httpVerb = $httpVerb;
 $this->defaultController = $defaultController;
 $this->defaultMethod = $httpVerb . ucfirst($defaultMethod);
 $this->defaultMethod = $defaultMethod;

 // Set the default values
 $this->controller = $this->defaultController;
 $this->method = $this->defaultMethod;
 }

 /**
 * Finds controller, method and params from the URI.
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = explode('/', $uri);

 // WARNING: Directories get shifted out of the segments array.
Expand DownExpand Up@@ -144,10 +142,10 @@ public function getRoute(string $uri): array
 $methodSegment = $this->translateURIDashes(array_shift($nonDirSegments));

 // Prefix HTTP verb
 $this->method = $this->httpVerb . ucfirst($methodSegment);
 $this->method = $httpVerb . ucfirst($methodSegment);

 // Prevent access to default method path
 if (strtolower($this->method) === strtolower($this->defaultMethod)) {
 if (strtolower($this->method) === strtolower($defaultMethod)) {
 throw new PageNotFoundException(
 'Cannot access the default method "' . $this->method . '" with the method name URI path.'
 );
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouterInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,5 +21,5 @@ interface AutoRouterInterface
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array;
 public function getRoute(string $uri, string $httpVerb): array;
}

6 changes: 4 additions & 2 deletions
system/Router/RouteCollection.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,7 @@ class RouteCollection implements RouteCollectionInterface
 /**
 * The current method that the script is being called by.
 *
 * @var string
 * @var string HTTP verb (lower case) like `get`,`post` or `*`
 */
 protected $HTTPVerb = '*';

Expand DownExpand Up@@ -550,11 +550,13 @@ public function getHTTPVerb(): string
 * Sets the current HTTP verb.
 * Used primarily for testing.
 *
 * @param string $verb HTTP verb
 *
 * @return $this
 */
 public function setHTTPVerb(string $verb)
 {
 $this->HTTPVerb = $verb;
 $this->HTTPVerb = strtolower($verb);

 return $this;
 }
Expand Down

4 changes: 2 additions & 2 deletions
system/Router/Router.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,7 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
 $this->controller = $this->collection->getDefaultController();
 $this->method = $this->collection->getDefaultMethod();

 $this->collection->setHTTPVerb(strtolower($request->getMethod() ?? $_SERVER['REQUEST_METHOD']));
 $this->collection->setHTTPVerb($request->getMethod() ?? $_SERVER['REQUEST_METHOD']);

 $this->translateURIDashes = $this->collection->shouldTranslateURIDashes();

Expand DownExpand Up@@ -504,7 +504,7 @@ protected function checkRoutes(string $uri): bool
 public function autoRoute(string $uri)
 {
 [$this->directory, $this->controller, $this->method, $this->params]
 = $this->autoRouter->getRoute($uri);
 = $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb());
 }

 /**
Expand Down

36 changes: 18 additions & 18 deletions
tests/system/Router/AutoRouterImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodGet()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -72,7 +72,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodPost()
 $router = $this->createNewAutoRouter('post');

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'post');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -85,7 +85,7 @@ public function testAutoRouteFindsControllerWithFileAndMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod');
 = $router->getRoute('mycontroller/somemethod', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -98,7 +98,7 @@ public function testFindsControllerAndMethodAndParam()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod/a');
 = $router->getRoute('mycontroller/somemethod/a', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -115,15 +115,15 @@ public function testUriParamCountIsGreaterThanMethodParams()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/somemethod/a/b');
 $router->getRoute('mycontroller/somemethod/a/b', 'get');
 }

 public function testAutoRouteFindsControllerWithFile()
 {
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller');
 = $router->getRoute('mycontroller', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -136,7 +136,7 @@ public function testAutoRouteFindsControllerWithSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('subfolder/mycontroller/somemethod');
 = $router->getRoute('subfolder/mycontroller/somemethod', 'get');

 $this->assertSame('Subfolder/', $directory);
 $this->assertSame('\\' . \CodeIgniter\Router\Controllers\Subfolder\Mycontroller::class, $controller);
Expand All@@ -149,7 +149,7 @@ public function testAutoRouteFindsDashedSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/mycontroller/somemethod');
 = $router->getRoute('dash-folder/mycontroller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame(
Expand All@@ -165,7 +165,7 @@ public function testAutoRouteFindsDashedController()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/somemethod');
 = $router->getRoute('dash-folder/dash-controller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -178,7 +178,7 @@ public function testAutoRouteFindsDashedMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/dash-method');
 = $router->getRoute('dash-folder/dash-controller/dash-method', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -191,7 +191,7 @@ public function testAutoRouteFindsDefaultDashFolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder');
 = $router->getRoute('dash-folder', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Home::class, $controller);
Expand All@@ -205,7 +205,7 @@ public function testAutoRouteRejectsSingleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('.');
 $router->getRoute('.', 'get');
 }

 public function testAutoRouteRejectsDoubleDot()
Expand All@@ -214,7 +214,7 @@ public function testAutoRouteRejectsDoubleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('..');
 $router->getRoute('..', 'get');
 }

 public function testAutoRouteRejectsMidDot()
Expand All@@ -223,7 +223,7 @@ public function testAutoRouteRejectsMidDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('foo.bar');
 $router->getRoute('foo.bar', 'get');
 }

 public function testRejectsDefaultControllerPath()
Expand All@@ -232,7 +232,7 @@ public function testRejectsDefaultControllerPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home');
 $router->getRoute('home', 'get');
 }

 public function testRejectsDefaultControllerAndDefaultMethodPath()
Expand All@@ -241,7 +241,7 @@ public function testRejectsDefaultControllerAndDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home/index');
 $router->getRoute('home/index', 'get');
 }

 public function testRejectsDefaultMethodPath()
Expand All@@ -250,7 +250,7 @@ public function testRejectsDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/index');
 $router->getRoute('mycontroller/index', 'get');
 }

 public function testRejectsControllerWithRemapMethod()
Expand All@@ -262,6 +262,6 @@ public function testRejectsControllerWithRemapMethod()

 $router = $this->createNewAutoRouter();

 $router->getRoute('remap/test');
 $router->getRoute('remap/test', 'get');
 }
}

75 changes: 75 additions & 0 deletions
tests/system/Test/FeatureTestAutoRoutingImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use CodeIgniter\Events\Events;
use Config\Feature;
use Config\Services;

/**
 * @group Others
 *
 * @internal
 */
final class FeatureTestAutoRoutingImprovedTest extends CIUnitTestCase
{
 use FeatureTestTrait;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 Events::simulate(true);

 self::initializeRouter();
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 Events::simulate(false);

 Services::reset();
 }

 private static function initializeRouter(): void
 {
 $routes = Services::routes();
 $routes->resetRoutes();
 $routes->loadRoutes();

 $routes->setAutoRoute(true);
 config(Feature::class)->autoRoutesImproved = true;

 $namespace = 'Tests\Support\Controllers';
 $routes->setDefaultNamespace($namespace);

 $router = Services::router($routes);

 Services::injectMock('router', $router);
 }

 public function testCallGet()
 {
 $response = $this->get('newautorouting');

 $response->assertSee('Hello');
 }

 public function testCallPost()
 {
 $response = $this->post('newautorouting/save/1/a/b');

 $response->assertSee('Saved');
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: [Auto Routing Improved] feature testing may not find controller/method#7543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 9 commits into

from

Jun 13, 2023
 Merged


fix: [Auto Routing Improved] feature testing may not find controller/method
#7543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4bcffd

test: add test for feature testing and auto routing improved


kenjis Jun 6, 2023
7dbf0d1

fix: [BC] feature testing may use incorrect HTTP verb for auto routin…


kenjis Jun 6, 2023
a932dc1

test: update test code


kenjis Jun 6, 2023
3410ea9

fix: ensure HTTP verb is lower case


kenjis Jun 6, 2023
c32182e

refactor: remove unused private property


kenjis Jun 6, 2023
ab0ebb9

docs: add docs


kenjis Jun 6, 2023
27729b1

chore: add skip rule for deprecated constructor param


kenjis Jun 7, 2023
fbff5a2

docs: add deprecation


kenjis Jun 10, 2023
f22139b

docs: add value examples


kenjis Jun 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
rector.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
use Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector;
use Rector\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector;
Expand DownExpand Up@@ -88,6 +89,11 @@
 __DIR__ . '/tests/system/Test/ReflectionHelperTest.php',
 ],

 RemoveUnusedConstructorParamRector::class => [
 // @TODO remove if deprecated $httpVerb is removed
 __DIR__ . '/system/Router/AutoRouterImproved.php',
 ],

 // call on purpose for nothing happen check
 RemoveEmptyMethodCallRector::class => [
 __DIR__ . '/tests',
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function __construct(
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $segments = explode('/', $uri);

Expand Down

24 changes: 11 additions & 13 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,11 +58,6 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private bool $translateURIDashes;

 /**
 * HTTP verb for the request.
 */
 private string $httpVerb;

 /**
 * The namespace for controllers.
 */
Expand All@@ -74,15 +69,17 @@ final class AutoRouterImproved implements AutoRouterInterface
 private string $defaultController;

 /**
 * The name of the default method
 * The name of the default method without HTTP verb prefix.
 */
 private string $defaultMethod;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
 *
 * @deprecated $httpVerb is deprecated. No longer used.
 */
 public function __construct(
 public function __construct(// @phpstan-ignore-line
 array $protectedControllers,
 string $namespace,
 string $defaultController,
Expand All@@ -93,22 +90,23 @@ public function __construct(
 $this->protectedControllers = $protectedControllers;
 $this->namespace = rtrim($namespace, '\\') . '\\';
 $this->translateURIDashes = $translateURIDashes;
 $this->httpVerb = $httpVerb;
 $this->defaultController = $defaultController;
 $this->defaultMethod = $httpVerb . ucfirst($defaultMethod);
 $this->defaultMethod = $defaultMethod;

 // Set the default values
 $this->controller = $this->defaultController;
 $this->method = $this->defaultMethod;
 }

 /**
 * Finds controller, method and params from the URI.
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = explode('/', $uri);

 // WARNING: Directories get shifted out of the segments array.
Expand DownExpand Up@@ -144,10 +142,10 @@ public function getRoute(string $uri): array
 $methodSegment = $this->translateURIDashes(array_shift($nonDirSegments));

 // Prefix HTTP verb
 $this->method = $this->httpVerb . ucfirst($methodSegment);
 $this->method = $httpVerb . ucfirst($methodSegment);

 // Prevent access to default method path
 if (strtolower($this->method) === strtolower($this->defaultMethod)) {
 if (strtolower($this->method) === strtolower($defaultMethod)) {
 throw new PageNotFoundException(
 'Cannot access the default method "' . $this->method . '" with the method name URI path.'
 );
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouterInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,5 +21,5 @@ interface AutoRouterInterface
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array;
 public function getRoute(string $uri, string $httpVerb): array;
}

6 changes: 4 additions & 2 deletions
system/Router/RouteCollection.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,7 @@ class RouteCollection implements RouteCollectionInterface
 /**
 * The current method that the script is being called by.
 *
 * @var string
 * @var string HTTP verb (lower case) like `get`,`post` or `*`
 */
 protected $HTTPVerb = '*';

Expand DownExpand Up@@ -550,11 +550,13 @@ public function getHTTPVerb(): string
 * Sets the current HTTP verb.
 * Used primarily for testing.
 *
 * @param string $verb HTTP verb
 *
 * @return $this
 */
 public function setHTTPVerb(string $verb)
 {
 $this->HTTPVerb = $verb;
 $this->HTTPVerb = strtolower($verb);

 return $this;
 }
Expand Down

4 changes: 2 additions & 2 deletions
system/Router/Router.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,7 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
 $this->controller = $this->collection->getDefaultController();
 $this->method = $this->collection->getDefaultMethod();

 $this->collection->setHTTPVerb(strtolower($request->getMethod() ?? $_SERVER['REQUEST_METHOD']));
 $this->collection->setHTTPVerb($request->getMethod() ?? $_SERVER['REQUEST_METHOD']);

 $this->translateURIDashes = $this->collection->shouldTranslateURIDashes();

Expand DownExpand Up@@ -504,7 +504,7 @@ protected function checkRoutes(string $uri): bool
 public function autoRoute(string $uri)
 {
 [$this->directory, $this->controller, $this->method, $this->params]
 = $this->autoRouter->getRoute($uri);
 = $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb());
 }

 /**
Expand Down

36 changes: 18 additions & 18 deletions
tests/system/Router/AutoRouterImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodGet()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -72,7 +72,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodPost()
 $router = $this->createNewAutoRouter('post');

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'post');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -85,7 +85,7 @@ public function testAutoRouteFindsControllerWithFileAndMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod');
 = $router->getRoute('mycontroller/somemethod', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -98,7 +98,7 @@ public function testFindsControllerAndMethodAndParam()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod/a');
 = $router->getRoute('mycontroller/somemethod/a', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -115,15 +115,15 @@ public function testUriParamCountIsGreaterThanMethodParams()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/somemethod/a/b');
 $router->getRoute('mycontroller/somemethod/a/b', 'get');
 }

 public function testAutoRouteFindsControllerWithFile()
 {
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller');
 = $router->getRoute('mycontroller', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -136,7 +136,7 @@ public function testAutoRouteFindsControllerWithSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('subfolder/mycontroller/somemethod');
 = $router->getRoute('subfolder/mycontroller/somemethod', 'get');

 $this->assertSame('Subfolder/', $directory);
 $this->assertSame('\\' . \CodeIgniter\Router\Controllers\Subfolder\Mycontroller::class, $controller);
Expand All@@ -149,7 +149,7 @@ public function testAutoRouteFindsDashedSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/mycontroller/somemethod');
 = $router->getRoute('dash-folder/mycontroller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame(
Expand All@@ -165,7 +165,7 @@ public function testAutoRouteFindsDashedController()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/somemethod');
 = $router->getRoute('dash-folder/dash-controller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -178,7 +178,7 @@ public function testAutoRouteFindsDashedMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/dash-method');
 = $router->getRoute('dash-folder/dash-controller/dash-method', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -191,7 +191,7 @@ public function testAutoRouteFindsDefaultDashFolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder');
 = $router->getRoute('dash-folder', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Home::class, $controller);
Expand All@@ -205,7 +205,7 @@ public function testAutoRouteRejectsSingleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('.');
 $router->getRoute('.', 'get');
 }

 public function testAutoRouteRejectsDoubleDot()
Expand All@@ -214,7 +214,7 @@ public function testAutoRouteRejectsDoubleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('..');
 $router->getRoute('..', 'get');
 }

 public function testAutoRouteRejectsMidDot()
Expand All@@ -223,7 +223,7 @@ public function testAutoRouteRejectsMidDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('foo.bar');
 $router->getRoute('foo.bar', 'get');
 }

 public function testRejectsDefaultControllerPath()
Expand All@@ -232,7 +232,7 @@ public function testRejectsDefaultControllerPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home');
 $router->getRoute('home', 'get');
 }

 public function testRejectsDefaultControllerAndDefaultMethodPath()
Expand All@@ -241,7 +241,7 @@ public function testRejectsDefaultControllerAndDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home/index');
 $router->getRoute('home/index', 'get');
 }

 public function testRejectsDefaultMethodPath()
Expand All@@ -250,7 +250,7 @@ public function testRejectsDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/index');
 $router->getRoute('mycontroller/index', 'get');
 }

 public function testRejectsControllerWithRemapMethod()
Expand All@@ -262,6 +262,6 @@ public function testRejectsControllerWithRemapMethod()

 $router = $this->createNewAutoRouter();

 $router->getRoute('remap/test');
 $router->getRoute('remap/test', 'get');
 }
}

75 changes: 75 additions & 0 deletions
tests/system/Test/FeatureTestAutoRoutingImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use CodeIgniter\Events\Events;
use Config\Feature;
use Config\Services;

/**
 * @group Others
 *
 * @internal
 */
final class FeatureTestAutoRoutingImprovedTest extends CIUnitTestCase
{
 use FeatureTestTrait;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 Events::simulate(true);

 self::initializeRouter();
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 Events::simulate(false);

 Services::reset();
 }

 private static function initializeRouter(): void
 {
 $routes = Services::routes();
 $routes->resetRoutes();
 $routes->loadRoutes();

 $routes->setAutoRoute(true);
 config(Feature::class)->autoRoutesImproved = true;

 $namespace = 'Tests\Support\Controllers';
 $routes->setDefaultNamespace($namespace);

 $router = Services::router($routes);

 Services::injectMock('router', $router);
 }

 public function testCallGet()
 {
 $response = $this->get('newautorouting');

 $response->assertSee('Hello');
 }

 public function testCallPost()
 {
 $response = $this->post('newautorouting/save/1/a/b');

 $response->assertSee('Saved');
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix: [Auto Routing Improved] feature testing may not find controller/method#7543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 9 commits into

from

Jun 13, 2023
 Merged


fix: [Auto Routing Improved] feature testing may not find controller/method
#7543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4bcffd

test: add test for feature testing and auto routing improved


kenjis Jun 6, 2023
7dbf0d1

fix: [BC] feature testing may use incorrect HTTP verb for auto routin…


kenjis Jun 6, 2023
a932dc1

test: update test code


kenjis Jun 6, 2023
3410ea9

fix: ensure HTTP verb is lower case


kenjis Jun 6, 2023
c32182e

refactor: remove unused private property


kenjis Jun 6, 2023
ab0ebb9

docs: add docs


kenjis Jun 6, 2023
27729b1

chore: add skip rule for deprecated constructor param


kenjis Jun 7, 2023
fbff5a2

docs: add deprecation


kenjis Jun 10, 2023
f22139b

docs: add value examples


kenjis Jun 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
rector.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
use Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector;
use Rector\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector;
Expand DownExpand Up@@ -88,6 +89,11 @@
 __DIR__ . '/tests/system/Test/ReflectionHelperTest.php',
 ],

 RemoveUnusedConstructorParamRector::class => [
 // @TODO remove if deprecated $httpVerb is removed
 __DIR__ . '/system/Router/AutoRouterImproved.php',
 ],

 // call on purpose for nothing happen check
 RemoveEmptyMethodCallRector::class => [
 __DIR__ . '/tests',
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function __construct(
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $segments = explode('/', $uri);

Expand Down

24 changes: 11 additions & 13 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,11 +58,6 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private bool $translateURIDashes;

 /**
 * HTTP verb for the request.
 */
 private string $httpVerb;

 /**
 * The namespace for controllers.
 */
Expand All@@ -74,15 +69,17 @@ final class AutoRouterImproved implements AutoRouterInterface
 private string $defaultController;

 /**
 * The name of the default method
 * The name of the default method without HTTP verb prefix.
 */
 private string $defaultMethod;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
 *
 * @deprecated $httpVerb is deprecated. No longer used.
 */
 public function __construct(
 public function __construct(// @phpstan-ignore-line
 array $protectedControllers,
 string $namespace,
 string $defaultController,
Expand All@@ -93,22 +90,23 @@ public function __construct(
 $this->protectedControllers = $protectedControllers;
 $this->namespace = rtrim($namespace, '\\') . '\\';
 $this->translateURIDashes = $translateURIDashes;
 $this->httpVerb = $httpVerb;
 $this->defaultController = $defaultController;
 $this->defaultMethod = $httpVerb . ucfirst($defaultMethod);
 $this->defaultMethod = $defaultMethod;

 // Set the default values
 $this->controller = $this->defaultController;
 $this->method = $this->defaultMethod;
 }

 /**
 * Finds controller, method and params from the URI.
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = explode('/', $uri);

 // WARNING: Directories get shifted out of the segments array.
Expand DownExpand Up@@ -144,10 +142,10 @@ public function getRoute(string $uri): array
 $methodSegment = $this->translateURIDashes(array_shift($nonDirSegments));

 // Prefix HTTP verb
 $this->method = $this->httpVerb . ucfirst($methodSegment);
 $this->method = $httpVerb . ucfirst($methodSegment);

 // Prevent access to default method path
 if (strtolower($this->method) === strtolower($this->defaultMethod)) {
 if (strtolower($this->method) === strtolower($defaultMethod)) {
 throw new PageNotFoundException(
 'Cannot access the default method "' . $this->method . '" with the method name URI path.'
 );
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouterInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,5 +21,5 @@ interface AutoRouterInterface
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array;
 public function getRoute(string $uri, string $httpVerb): array;
}

6 changes: 4 additions & 2 deletions
system/Router/RouteCollection.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,7 @@ class RouteCollection implements RouteCollectionInterface
 /**
 * The current method that the script is being called by.
 *
 * @var string
 * @var string HTTP verb (lower case) like `get`,`post` or `*`
 */
 protected $HTTPVerb = '*';

Expand DownExpand Up@@ -550,11 +550,13 @@ public function getHTTPVerb(): string
 * Sets the current HTTP verb.
 * Used primarily for testing.
 *
 * @param string $verb HTTP verb
 *
 * @return $this
 */
 public function setHTTPVerb(string $verb)
 {
 $this->HTTPVerb = $verb;
 $this->HTTPVerb = strtolower($verb);

 return $this;
 }
Expand Down

4 changes: 2 additions & 2 deletions
system/Router/Router.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,7 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
 $this->controller = $this->collection->getDefaultController();
 $this->method = $this->collection->getDefaultMethod();

 $this->collection->setHTTPVerb(strtolower($request->getMethod() ?? $_SERVER['REQUEST_METHOD']));
 $this->collection->setHTTPVerb($request->getMethod() ?? $_SERVER['REQUEST_METHOD']);

 $this->translateURIDashes = $this->collection->shouldTranslateURIDashes();

Expand DownExpand Up@@ -504,7 +504,7 @@ protected function checkRoutes(string $uri): bool
 public function autoRoute(string $uri)
 {
 [$this->directory, $this->controller, $this->method, $this->params]
 = $this->autoRouter->getRoute($uri);
 = $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb());
 }

 /**
Expand Down

36 changes: 18 additions & 18 deletions
tests/system/Router/AutoRouterImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodGet()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -72,7 +72,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodPost()
 $router = $this->createNewAutoRouter('post');

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'post');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -85,7 +85,7 @@ public function testAutoRouteFindsControllerWithFileAndMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod');
 = $router->getRoute('mycontroller/somemethod', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -98,7 +98,7 @@ public function testFindsControllerAndMethodAndParam()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod/a');
 = $router->getRoute('mycontroller/somemethod/a', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -115,15 +115,15 @@ public function testUriParamCountIsGreaterThanMethodParams()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/somemethod/a/b');
 $router->getRoute('mycontroller/somemethod/a/b', 'get');
 }

 public function testAutoRouteFindsControllerWithFile()
 {
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller');
 = $router->getRoute('mycontroller', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -136,7 +136,7 @@ public function testAutoRouteFindsControllerWithSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('subfolder/mycontroller/somemethod');
 = $router->getRoute('subfolder/mycontroller/somemethod', 'get');

 $this->assertSame('Subfolder/', $directory);
 $this->assertSame('\\' . \CodeIgniter\Router\Controllers\Subfolder\Mycontroller::class, $controller);
Expand All@@ -149,7 +149,7 @@ public function testAutoRouteFindsDashedSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/mycontroller/somemethod');
 = $router->getRoute('dash-folder/mycontroller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame(
Expand All@@ -165,7 +165,7 @@ public function testAutoRouteFindsDashedController()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/somemethod');
 = $router->getRoute('dash-folder/dash-controller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -178,7 +178,7 @@ public function testAutoRouteFindsDashedMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/dash-method');
 = $router->getRoute('dash-folder/dash-controller/dash-method', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -191,7 +191,7 @@ public function testAutoRouteFindsDefaultDashFolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder');
 = $router->getRoute('dash-folder', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Home::class, $controller);
Expand All@@ -205,7 +205,7 @@ public function testAutoRouteRejectsSingleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('.');
 $router->getRoute('.', 'get');
 }

 public function testAutoRouteRejectsDoubleDot()
Expand All@@ -214,7 +214,7 @@ public function testAutoRouteRejectsDoubleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('..');
 $router->getRoute('..', 'get');
 }

 public function testAutoRouteRejectsMidDot()
Expand All@@ -223,7 +223,7 @@ public function testAutoRouteRejectsMidDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('foo.bar');
 $router->getRoute('foo.bar', 'get');
 }

 public function testRejectsDefaultControllerPath()
Expand All@@ -232,7 +232,7 @@ public function testRejectsDefaultControllerPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home');
 $router->getRoute('home', 'get');
 }

 public function testRejectsDefaultControllerAndDefaultMethodPath()
Expand All@@ -241,7 +241,7 @@ public function testRejectsDefaultControllerAndDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home/index');
 $router->getRoute('home/index', 'get');
 }

 public function testRejectsDefaultMethodPath()
Expand All@@ -250,7 +250,7 @@ public function testRejectsDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/index');
 $router->getRoute('mycontroller/index', 'get');
 }

 public function testRejectsControllerWithRemapMethod()
Expand All@@ -262,6 +262,6 @@ public function testRejectsControllerWithRemapMethod()

 $router = $this->createNewAutoRouter();

 $router->getRoute('remap/test');
 $router->getRoute('remap/test', 'get');
 }
}

75 changes: 75 additions & 0 deletions
tests/system/Test/FeatureTestAutoRoutingImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use CodeIgniter\Events\Events;
use Config\Feature;
use Config\Services;

/**
 * @group Others
 *
 * @internal
 */
final class FeatureTestAutoRoutingImprovedTest extends CIUnitTestCase
{
 use FeatureTestTrait;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 Events::simulate(true);

 self::initializeRouter();
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 Events::simulate(false);

 Services::reset();
 }

 private static function initializeRouter(): void
 {
 $routes = Services::routes();
 $routes->resetRoutes();
 $routes->loadRoutes();

 $routes->setAutoRoute(true);
 config(Feature::class)->autoRoutesImproved = true;

 $namespace = 'Tests\Support\Controllers';
 $routes->setDefaultNamespace($namespace);

 $router = Services::router($routes);

 Services::injectMock('router', $router);
 }

 public function testCallGet()
 {
 $response = $this->get('newautorouting');

 $response->assertSee('Hello');
 }

 public function testCallPost()
 {
 $response = $this->post('newautorouting/save/1/a/b');

 $response->assertSee('Saved');
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: [Auto Routing Improved] feature testing may not find controller/method#7543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 9 commits into

from

Jun 13, 2023
 Merged


fix: [Auto Routing Improved] feature testing may not find controller/method
#7543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4bcffd

test: add test for feature testing and auto routing improved


kenjis Jun 6, 2023
7dbf0d1

fix: [BC] feature testing may use incorrect HTTP verb for auto routin…


kenjis Jun 6, 2023
a932dc1

test: update test code


kenjis Jun 6, 2023
3410ea9

fix: ensure HTTP verb is lower case


kenjis Jun 6, 2023
c32182e

refactor: remove unused private property


kenjis Jun 6, 2023
ab0ebb9

docs: add docs


kenjis Jun 6, 2023
27729b1

chore: add skip rule for deprecated constructor param


kenjis Jun 7, 2023
fbff5a2

docs: add deprecation


kenjis Jun 10, 2023
f22139b

docs: add value examples


kenjis Jun 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
rector.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
use Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector;
use Rector\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector;
Expand DownExpand Up@@ -88,6 +89,11 @@
 __DIR__ . '/tests/system/Test/ReflectionHelperTest.php',
 ],

 RemoveUnusedConstructorParamRector::class => [
 // @TODO remove if deprecated $httpVerb is removed
 __DIR__ . '/system/Router/AutoRouterImproved.php',
 ],

 // call on purpose for nothing happen check
 RemoveEmptyMethodCallRector::class => [
 __DIR__ . '/tests',
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function __construct(
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $segments = explode('/', $uri);

Expand Down

24 changes: 11 additions & 13 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,11 +58,6 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private bool $translateURIDashes;

 /**
 * HTTP verb for the request.
 */
 private string $httpVerb;

 /**
 * The namespace for controllers.
 */
Expand All@@ -74,15 +69,17 @@ final class AutoRouterImproved implements AutoRouterInterface
 private string $defaultController;

 /**
 * The name of the default method
 * The name of the default method without HTTP verb prefix.
 */
 private string $defaultMethod;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
 *
 * @deprecated $httpVerb is deprecated. No longer used.
 */
 public function __construct(
 public function __construct(// @phpstan-ignore-line
 array $protectedControllers,
 string $namespace,
 string $defaultController,
Expand All@@ -93,22 +90,23 @@ public function __construct(
 $this->protectedControllers = $protectedControllers;
 $this->namespace = rtrim($namespace, '\\') . '\\';
 $this->translateURIDashes = $translateURIDashes;
 $this->httpVerb = $httpVerb;
 $this->defaultController = $defaultController;
 $this->defaultMethod = $httpVerb . ucfirst($defaultMethod);
 $this->defaultMethod = $defaultMethod;

 // Set the default values
 $this->controller = $this->defaultController;
 $this->method = $this->defaultMethod;
 }

 /**
 * Finds controller, method and params from the URI.
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = explode('/', $uri);

 // WARNING: Directories get shifted out of the segments array.
Expand DownExpand Up@@ -144,10 +142,10 @@ public function getRoute(string $uri): array
 $methodSegment = $this->translateURIDashes(array_shift($nonDirSegments));

 // Prefix HTTP verb
 $this->method = $this->httpVerb . ucfirst($methodSegment);
 $this->method = $httpVerb . ucfirst($methodSegment);

 // Prevent access to default method path
 if (strtolower($this->method) === strtolower($this->defaultMethod)) {
 if (strtolower($this->method) === strtolower($defaultMethod)) {
 throw new PageNotFoundException(
 'Cannot access the default method "' . $this->method . '" with the method name URI path.'
 );
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouterInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,5 +21,5 @@ interface AutoRouterInterface
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array;
 public function getRoute(string $uri, string $httpVerb): array;
}

6 changes: 4 additions & 2 deletions
system/Router/RouteCollection.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,7 @@ class RouteCollection implements RouteCollectionInterface
 /**
 * The current method that the script is being called by.
 *
 * @var string
 * @var string HTTP verb (lower case) like `get`,`post` or `*`
 */
 protected $HTTPVerb = '*';

Expand DownExpand Up@@ -550,11 +550,13 @@ public function getHTTPVerb(): string
 * Sets the current HTTP verb.
 * Used primarily for testing.
 *
 * @param string $verb HTTP verb
 *
 * @return $this
 */
 public function setHTTPVerb(string $verb)
 {
 $this->HTTPVerb = $verb;
 $this->HTTPVerb = strtolower($verb);

 return $this;
 }
Expand Down

4 changes: 2 additions & 2 deletions
system/Router/Router.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,7 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
 $this->controller = $this->collection->getDefaultController();
 $this->method = $this->collection->getDefaultMethod();

 $this->collection->setHTTPVerb(strtolower($request->getMethod() ?? $_SERVER['REQUEST_METHOD']));
 $this->collection->setHTTPVerb($request->getMethod() ?? $_SERVER['REQUEST_METHOD']);

 $this->translateURIDashes = $this->collection->shouldTranslateURIDashes();

Expand DownExpand Up@@ -504,7 +504,7 @@ protected function checkRoutes(string $uri): bool
 public function autoRoute(string $uri)
 {
 [$this->directory, $this->controller, $this->method, $this->params]
 = $this->autoRouter->getRoute($uri);
 = $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb());
 }

 /**
Expand Down

36 changes: 18 additions & 18 deletions
tests/system/Router/AutoRouterImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodGet()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -72,7 +72,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodPost()
 $router = $this->createNewAutoRouter('post');

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'post');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -85,7 +85,7 @@ public function testAutoRouteFindsControllerWithFileAndMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod');
 = $router->getRoute('mycontroller/somemethod', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -98,7 +98,7 @@ public function testFindsControllerAndMethodAndParam()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod/a');
 = $router->getRoute('mycontroller/somemethod/a', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -115,15 +115,15 @@ public function testUriParamCountIsGreaterThanMethodParams()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/somemethod/a/b');
 $router->getRoute('mycontroller/somemethod/a/b', 'get');
 }

 public function testAutoRouteFindsControllerWithFile()
 {
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller');
 = $router->getRoute('mycontroller', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -136,7 +136,7 @@ public function testAutoRouteFindsControllerWithSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('subfolder/mycontroller/somemethod');
 = $router->getRoute('subfolder/mycontroller/somemethod', 'get');

 $this->assertSame('Subfolder/', $directory);
 $this->assertSame('\\' . \CodeIgniter\Router\Controllers\Subfolder\Mycontroller::class, $controller);
Expand All@@ -149,7 +149,7 @@ public function testAutoRouteFindsDashedSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/mycontroller/somemethod');
 = $router->getRoute('dash-folder/mycontroller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame(
Expand All@@ -165,7 +165,7 @@ public function testAutoRouteFindsDashedController()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/somemethod');
 = $router->getRoute('dash-folder/dash-controller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -178,7 +178,7 @@ public function testAutoRouteFindsDashedMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/dash-method');
 = $router->getRoute('dash-folder/dash-controller/dash-method', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -191,7 +191,7 @@ public function testAutoRouteFindsDefaultDashFolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder');
 = $router->getRoute('dash-folder', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Home::class, $controller);
Expand All@@ -205,7 +205,7 @@ public function testAutoRouteRejectsSingleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('.');
 $router->getRoute('.', 'get');
 }

 public function testAutoRouteRejectsDoubleDot()
Expand All@@ -214,7 +214,7 @@ public function testAutoRouteRejectsDoubleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('..');
 $router->getRoute('..', 'get');
 }

 public function testAutoRouteRejectsMidDot()
Expand All@@ -223,7 +223,7 @@ public function testAutoRouteRejectsMidDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('foo.bar');
 $router->getRoute('foo.bar', 'get');
 }

 public function testRejectsDefaultControllerPath()
Expand All@@ -232,7 +232,7 @@ public function testRejectsDefaultControllerPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home');
 $router->getRoute('home', 'get');
 }

 public function testRejectsDefaultControllerAndDefaultMethodPath()
Expand All@@ -241,7 +241,7 @@ public function testRejectsDefaultControllerAndDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home/index');
 $router->getRoute('home/index', 'get');
 }

 public function testRejectsDefaultMethodPath()
Expand All@@ -250,7 +250,7 @@ public function testRejectsDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/index');
 $router->getRoute('mycontroller/index', 'get');
 }

 public function testRejectsControllerWithRemapMethod()
Expand All@@ -262,6 +262,6 @@ public function testRejectsControllerWithRemapMethod()

 $router = $this->createNewAutoRouter();

 $router->getRoute('remap/test');
 $router->getRoute('remap/test', 'get');
 }
}

75 changes: 75 additions & 0 deletions
tests/system/Test/FeatureTestAutoRoutingImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use CodeIgniter\Events\Events;
use Config\Feature;
use Config\Services;

/**
 * @group Others
 *
 * @internal
 */
final class FeatureTestAutoRoutingImprovedTest extends CIUnitTestCase
{
 use FeatureTestTrait;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 Events::simulate(true);

 self::initializeRouter();
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 Events::simulate(false);

 Services::reset();
 }

 private static function initializeRouter(): void
 {
 $routes = Services::routes();
 $routes->resetRoutes();
 $routes->loadRoutes();

 $routes->setAutoRoute(true);
 config(Feature::class)->autoRoutesImproved = true;

 $namespace = 'Tests\Support\Controllers';
 $routes->setDefaultNamespace($namespace);

 $router = Services::router($routes);

 Services::injectMock('router', $router);
 }

 public function testCallGet()
 {
 $response = $this->get('newautorouting');

 $response->assertSee('Hello');
 }

 public function testCallPost()
 {
 $response = $this->post('newautorouting/save/1/a/b');

 $response->assertSee('Saved');
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: [Auto Routing Improved] feature testing may not find controller/method#7543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 9 commits into

from

Jun 13, 2023
 Merged


fix: [Auto Routing Improved] feature testing may not find controller/method
#7543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4bcffd

test: add test for feature testing and auto routing improved


kenjis Jun 6, 2023
7dbf0d1

fix: [BC] feature testing may use incorrect HTTP verb for auto routin…


kenjis Jun 6, 2023
a932dc1

test: update test code


kenjis Jun 6, 2023
3410ea9

fix: ensure HTTP verb is lower case


kenjis Jun 6, 2023
c32182e

refactor: remove unused private property


kenjis Jun 6, 2023
ab0ebb9

docs: add docs


kenjis Jun 6, 2023
27729b1

chore: add skip rule for deprecated constructor param


kenjis Jun 7, 2023
fbff5a2

docs: add deprecation


kenjis Jun 10, 2023
f22139b

docs: add value examples


kenjis Jun 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
rector.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
use Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector;
use Rector\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector;
Expand DownExpand Up@@ -88,6 +89,11 @@
 __DIR__ . '/tests/system/Test/ReflectionHelperTest.php',
 ],

 RemoveUnusedConstructorParamRector::class => [
 // @TODO remove if deprecated $httpVerb is removed
 __DIR__ . '/system/Router/AutoRouterImproved.php',
 ],

 // call on purpose for nothing happen check
 RemoveEmptyMethodCallRector::class => [
 __DIR__ . '/tests',
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function __construct(
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $segments = explode('/', $uri);

Expand Down

24 changes: 11 additions & 13 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,11 +58,6 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private bool $translateURIDashes;

 /**
 * HTTP verb for the request.
 */
 private string $httpVerb;

 /**
 * The namespace for controllers.
 */
Expand All@@ -74,15 +69,17 @@ final class AutoRouterImproved implements AutoRouterInterface
 private string $defaultController;

 /**
 * The name of the default method
 * The name of the default method without HTTP verb prefix.
 */
 private string $defaultMethod;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
 *
 * @deprecated $httpVerb is deprecated. No longer used.
 */
 public function __construct(
 public function __construct(// @phpstan-ignore-line
 array $protectedControllers,
 string $namespace,
 string $defaultController,
Expand All@@ -93,22 +90,23 @@ public function __construct(
 $this->protectedControllers = $protectedControllers;
 $this->namespace = rtrim($namespace, '\\') . '\\';
 $this->translateURIDashes = $translateURIDashes;
 $this->httpVerb = $httpVerb;
 $this->defaultController = $defaultController;
 $this->defaultMethod = $httpVerb . ucfirst($defaultMethod);
 $this->defaultMethod = $defaultMethod;

 // Set the default values
 $this->controller = $this->defaultController;
 $this->method = $this->defaultMethod;
 }

 /**
 * Finds controller, method and params from the URI.
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = explode('/', $uri);

 // WARNING: Directories get shifted out of the segments array.
Expand DownExpand Up@@ -144,10 +142,10 @@ public function getRoute(string $uri): array
 $methodSegment = $this->translateURIDashes(array_shift($nonDirSegments));

 // Prefix HTTP verb
 $this->method = $this->httpVerb . ucfirst($methodSegment);
 $this->method = $httpVerb . ucfirst($methodSegment);

 // Prevent access to default method path
 if (strtolower($this->method) === strtolower($this->defaultMethod)) {
 if (strtolower($this->method) === strtolower($defaultMethod)) {
 throw new PageNotFoundException(
 'Cannot access the default method "' . $this->method . '" with the method name URI path.'
 );
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouterInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,5 +21,5 @@ interface AutoRouterInterface
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array;
 public function getRoute(string $uri, string $httpVerb): array;
}

6 changes: 4 additions & 2 deletions
system/Router/RouteCollection.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,7 @@ class RouteCollection implements RouteCollectionInterface
 /**
 * The current method that the script is being called by.
 *
 * @var string
 * @var string HTTP verb (lower case) like `get`,`post` or `*`
 */
 protected $HTTPVerb = '*';

Expand DownExpand Up@@ -550,11 +550,13 @@ public function getHTTPVerb(): string
 * Sets the current HTTP verb.
 * Used primarily for testing.
 *
 * @param string $verb HTTP verb
 *
 * @return $this
 */
 public function setHTTPVerb(string $verb)
 {
 $this->HTTPVerb = $verb;
 $this->HTTPVerb = strtolower($verb);

 return $this;
 }
Expand Down

4 changes: 2 additions & 2 deletions
system/Router/Router.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,7 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
 $this->controller = $this->collection->getDefaultController();
 $this->method = $this->collection->getDefaultMethod();

 $this->collection->setHTTPVerb(strtolower($request->getMethod() ?? $_SERVER['REQUEST_METHOD']));
 $this->collection->setHTTPVerb($request->getMethod() ?? $_SERVER['REQUEST_METHOD']);

 $this->translateURIDashes = $this->collection->shouldTranslateURIDashes();

Expand DownExpand Up@@ -504,7 +504,7 @@ protected function checkRoutes(string $uri): bool
 public function autoRoute(string $uri)
 {
 [$this->directory, $this->controller, $this->method, $this->params]
 = $this->autoRouter->getRoute($uri);
 = $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb());
 }

 /**
Expand Down

36 changes: 18 additions & 18 deletions
tests/system/Router/AutoRouterImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodGet()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -72,7 +72,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodPost()
 $router = $this->createNewAutoRouter('post');

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'post');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -85,7 +85,7 @@ public function testAutoRouteFindsControllerWithFileAndMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod');
 = $router->getRoute('mycontroller/somemethod', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -98,7 +98,7 @@ public function testFindsControllerAndMethodAndParam()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod/a');
 = $router->getRoute('mycontroller/somemethod/a', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -115,15 +115,15 @@ public function testUriParamCountIsGreaterThanMethodParams()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/somemethod/a/b');
 $router->getRoute('mycontroller/somemethod/a/b', 'get');
 }

 public function testAutoRouteFindsControllerWithFile()
 {
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller');
 = $router->getRoute('mycontroller', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -136,7 +136,7 @@ public function testAutoRouteFindsControllerWithSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('subfolder/mycontroller/somemethod');
 = $router->getRoute('subfolder/mycontroller/somemethod', 'get');

 $this->assertSame('Subfolder/', $directory);
 $this->assertSame('\\' . \CodeIgniter\Router\Controllers\Subfolder\Mycontroller::class, $controller);
Expand All@@ -149,7 +149,7 @@ public function testAutoRouteFindsDashedSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/mycontroller/somemethod');
 = $router->getRoute('dash-folder/mycontroller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame(
Expand All@@ -165,7 +165,7 @@ public function testAutoRouteFindsDashedController()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/somemethod');
 = $router->getRoute('dash-folder/dash-controller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -178,7 +178,7 @@ public function testAutoRouteFindsDashedMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/dash-method');
 = $router->getRoute('dash-folder/dash-controller/dash-method', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -191,7 +191,7 @@ public function testAutoRouteFindsDefaultDashFolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder');
 = $router->getRoute('dash-folder', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Home::class, $controller);
Expand All@@ -205,7 +205,7 @@ public function testAutoRouteRejectsSingleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('.');
 $router->getRoute('.', 'get');
 }

 public function testAutoRouteRejectsDoubleDot()
Expand All@@ -214,7 +214,7 @@ public function testAutoRouteRejectsDoubleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('..');
 $router->getRoute('..', 'get');
 }

 public function testAutoRouteRejectsMidDot()
Expand All@@ -223,7 +223,7 @@ public function testAutoRouteRejectsMidDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('foo.bar');
 $router->getRoute('foo.bar', 'get');
 }

 public function testRejectsDefaultControllerPath()
Expand All@@ -232,7 +232,7 @@ public function testRejectsDefaultControllerPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home');
 $router->getRoute('home', 'get');
 }

 public function testRejectsDefaultControllerAndDefaultMethodPath()
Expand All@@ -241,7 +241,7 @@ public function testRejectsDefaultControllerAndDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home/index');
 $router->getRoute('home/index', 'get');
 }

 public function testRejectsDefaultMethodPath()
Expand All@@ -250,7 +250,7 @@ public function testRejectsDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/index');
 $router->getRoute('mycontroller/index', 'get');
 }

 public function testRejectsControllerWithRemapMethod()
Expand All@@ -262,6 +262,6 @@ public function testRejectsControllerWithRemapMethod()

 $router = $this->createNewAutoRouter();

 $router->getRoute('remap/test');
 $router->getRoute('remap/test', 'get');
 }
}

75 changes: 75 additions & 0 deletions
tests/system/Test/FeatureTestAutoRoutingImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use CodeIgniter\Events\Events;
use Config\Feature;
use Config\Services;

/**
 * @group Others
 *
 * @internal
 */
final class FeatureTestAutoRoutingImprovedTest extends CIUnitTestCase
{
 use FeatureTestTrait;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 Events::simulate(true);

 self::initializeRouter();
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 Events::simulate(false);

 Services::reset();
 }

 private static function initializeRouter(): void
 {
 $routes = Services::routes();
 $routes->resetRoutes();
 $routes->loadRoutes();

 $routes->setAutoRoute(true);
 config(Feature::class)->autoRoutesImproved = true;

 $namespace = 'Tests\Support\Controllers';
 $routes->setDefaultNamespace($namespace);

 $router = Services::router($routes);

 Services::injectMock('router', $router);
 }

 public function testCallGet()
 {
 $response = $this->get('newautorouting');

 $response->assertSee('Hello');
 }

 public function testCallPost()
 {
 $response = $this->post('newautorouting/save/1/a/b');

 $response->assertSee('Saved');
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix: [Auto Routing Improved] feature testing may not find controller/method#7543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 9 commits into

from

Jun 13, 2023
 Merged


fix: [Auto Routing Improved] feature testing may not find controller/method
#7543
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
d4bcffd

test: add test for feature testing and auto routing improved


kenjis Jun 6, 2023
7dbf0d1

fix: [BC] feature testing may use incorrect HTTP verb for auto routin…


kenjis Jun 6, 2023
a932dc1

test: update test code


kenjis Jun 6, 2023
3410ea9

fix: ensure HTTP verb is lower case


kenjis Jun 6, 2023
c32182e

refactor: remove unused private property


kenjis Jun 6, 2023
ab0ebb9

docs: add docs


kenjis Jun 6, 2023
27729b1

chore: add skip rule for deprecated constructor param


kenjis Jun 7, 2023
fbff5a2

docs: add deprecation


kenjis Jun 10, 2023
f22139b

docs: add value examples


kenjis Jun 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
rector.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
use Rector\CodingStyle\Rector\ClassMethod\MakeInheritedMethodVisibilitySameAsParentRector;
use Rector\CodingStyle\Rector\FuncCall\CountArrayToEmptyArrayComparisonRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector;
use Rector\DeadCode\Rector\If_\UnwrapFutureCompatibleIfPhpVersionRector;
use Rector\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector;
Expand DownExpand Up@@ -88,6 +89,11 @@
 __DIR__ . '/tests/system/Test/ReflectionHelperTest.php',
 ],

 RemoveUnusedConstructorParamRector::class => [
 // @TODO remove if deprecated $httpVerb is removed
 __DIR__ . '/system/Router/AutoRouterImproved.php',
 ],

 // call on purpose for nothing happen check
 RemoveEmptyMethodCallRector::class => [
 __DIR__ . '/tests',
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouter.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ public function __construct(
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $segments = explode('/', $uri);

Expand Down

24 changes: 11 additions & 13 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,11 +58,6 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private bool $translateURIDashes;

 /**
 * HTTP verb for the request.
 */
 private string $httpVerb;

 /**
 * The namespace for controllers.
 */
Expand All@@ -74,15 +69,17 @@ final class AutoRouterImproved implements AutoRouterInterface
 private string $defaultController;

 /**
 * The name of the default method
 * The name of the default method without HTTP verb prefix.
 */
 private string $defaultMethod;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
 *
 * @deprecated $httpVerb is deprecated. No longer used.
 */
 public function __construct(
 public function __construct(// @phpstan-ignore-line
 array $protectedControllers,
 string $namespace,
 string $defaultController,
Expand All@@ -93,22 +90,23 @@ public function __construct(
 $this->protectedControllers = $protectedControllers;
 $this->namespace = rtrim($namespace, '\\') . '\\';
 $this->translateURIDashes = $translateURIDashes;
 $this->httpVerb = $httpVerb;
 $this->defaultController = $defaultController;
 $this->defaultMethod = $httpVerb . ucfirst($defaultMethod);
 $this->defaultMethod = $defaultMethod;

 // Set the default values
 $this->controller = $this->defaultController;
 $this->method = $this->defaultMethod;
 }

 /**
 * Finds controller, method and params from the URI.
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array
 public function getRoute(string $uri, string $httpVerb): array
 {
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = explode('/', $uri);

 // WARNING: Directories get shifted out of the segments array.
Expand DownExpand Up@@ -144,10 +142,10 @@ public function getRoute(string $uri): array
 $methodSegment = $this->translateURIDashes(array_shift($nonDirSegments));

 // Prefix HTTP verb
 $this->method = $this->httpVerb . ucfirst($methodSegment);
 $this->method = $httpVerb . ucfirst($methodSegment);

 // Prevent access to default method path
 if (strtolower($this->method) === strtolower($this->defaultMethod)) {
 if (strtolower($this->method) === strtolower($defaultMethod)) {
 throw new PageNotFoundException(
 'Cannot access the default method "' . $this->method . '" with the method name URI path.'
 );
Expand Down

2 changes: 1 addition & 1 deletion
system/Router/AutoRouterInterface.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,5 +21,5 @@ interface AutoRouterInterface
 *
 * @return array [directory_name, controller_name, controller_method, params]
 */
 public function getRoute(string $uri): array;
 public function getRoute(string $uri, string $httpVerb): array;
}

6 changes: 4 additions & 2 deletions
system/Router/RouteCollection.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,7 +150,7 @@ class RouteCollection implements RouteCollectionInterface
 /**
 * The current method that the script is being called by.
 *
 * @var string
 * @var string HTTP verb (lower case) like `get`,`post` or `*`
 */
 protected $HTTPVerb = '*';

Expand DownExpand Up@@ -550,11 +550,13 @@ public function getHTTPVerb(): string
 * Sets the current HTTP verb.
 * Used primarily for testing.
 *
 * @param string $verb HTTP verb
 *
 * @return $this
 */
 public function setHTTPVerb(string $verb)
 {
 $this->HTTPVerb = $verb;
 $this->HTTPVerb = strtolower($verb);

 return $this;
 }
Expand Down

4 changes: 2 additions & 2 deletions
system/Router/Router.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -126,7 +126,7 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
 $this->controller = $this->collection->getDefaultController();
 $this->method = $this->collection->getDefaultMethod();

 $this->collection->setHTTPVerb(strtolower($request->getMethod() ?? $_SERVER['REQUEST_METHOD']));
 $this->collection->setHTTPVerb($request->getMethod() ?? $_SERVER['REQUEST_METHOD']);

 $this->translateURIDashes = $this->collection->shouldTranslateURIDashes();

Expand DownExpand Up@@ -504,7 +504,7 @@ protected function checkRoutes(string $uri): bool
 public function autoRoute(string $uri)
 {
 [$this->directory, $this->controller, $this->method, $this->params]
 = $this->autoRouter->getRoute($uri);
 = $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb());
 }

 /**
Expand Down

36 changes: 18 additions & 18 deletions
tests/system/Router/AutoRouterImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,7 +57,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodGet()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -72,7 +72,7 @@ public function testAutoRouteFindsDefaultControllerAndMethodPost()
 $router = $this->createNewAutoRouter('post');

 [$directory, $controller, $method, $params]
 = $router->getRoute('/');
 = $router->getRoute('/', 'post');

 $this->assertNull($directory);
 $this->assertSame('\\' . Index::class, $controller);
Expand All@@ -85,7 +85,7 @@ public function testAutoRouteFindsControllerWithFileAndMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod');
 = $router->getRoute('mycontroller/somemethod', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -98,7 +98,7 @@ public function testFindsControllerAndMethodAndParam()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller/somemethod/a');
 = $router->getRoute('mycontroller/somemethod/a', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -115,15 +115,15 @@ public function testUriParamCountIsGreaterThanMethodParams()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/somemethod/a/b');
 $router->getRoute('mycontroller/somemethod/a/b', 'get');
 }

 public function testAutoRouteFindsControllerWithFile()
 {
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('mycontroller');
 = $router->getRoute('mycontroller', 'get');

 $this->assertNull($directory);
 $this->assertSame('\\' . Mycontroller::class, $controller);
Expand All@@ -136,7 +136,7 @@ public function testAutoRouteFindsControllerWithSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('subfolder/mycontroller/somemethod');
 = $router->getRoute('subfolder/mycontroller/somemethod', 'get');

 $this->assertSame('Subfolder/', $directory);
 $this->assertSame('\\' . \CodeIgniter\Router\Controllers\Subfolder\Mycontroller::class, $controller);
Expand All@@ -149,7 +149,7 @@ public function testAutoRouteFindsDashedSubfolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/mycontroller/somemethod');
 = $router->getRoute('dash-folder/mycontroller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame(
Expand All@@ -165,7 +165,7 @@ public function testAutoRouteFindsDashedController()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/somemethod');
 = $router->getRoute('dash-folder/dash-controller/somemethod', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -178,7 +178,7 @@ public function testAutoRouteFindsDashedMethod()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder/dash-controller/dash-method');
 = $router->getRoute('dash-folder/dash-controller/dash-method', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Dash_controller::class, $controller);
Expand All@@ -191,7 +191,7 @@ public function testAutoRouteFindsDefaultDashFolder()
 $router = $this->createNewAutoRouter();

 [$directory, $controller, $method, $params]
 = $router->getRoute('dash-folder');
 = $router->getRoute('dash-folder', 'get');

 $this->assertSame('Dash_folder/', $directory);
 $this->assertSame('\\' . Home::class, $controller);
Expand All@@ -205,7 +205,7 @@ public function testAutoRouteRejectsSingleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('.');
 $router->getRoute('.', 'get');
 }

 public function testAutoRouteRejectsDoubleDot()
Expand All@@ -214,7 +214,7 @@ public function testAutoRouteRejectsDoubleDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('..');
 $router->getRoute('..', 'get');
 }

 public function testAutoRouteRejectsMidDot()
Expand All@@ -223,7 +223,7 @@ public function testAutoRouteRejectsMidDot()

 $router = $this->createNewAutoRouter();

 $router->getRoute('foo.bar');
 $router->getRoute('foo.bar', 'get');
 }

 public function testRejectsDefaultControllerPath()
Expand All@@ -232,7 +232,7 @@ public function testRejectsDefaultControllerPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home');
 $router->getRoute('home', 'get');
 }

 public function testRejectsDefaultControllerAndDefaultMethodPath()
Expand All@@ -241,7 +241,7 @@ public function testRejectsDefaultControllerAndDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('home/index');
 $router->getRoute('home/index', 'get');
 }

 public function testRejectsDefaultMethodPath()
Expand All@@ -250,7 +250,7 @@ public function testRejectsDefaultMethodPath()

 $router = $this->createNewAutoRouter();

 $router->getRoute('mycontroller/index');
 $router->getRoute('mycontroller/index', 'get');
 }

 public function testRejectsControllerWithRemapMethod()
Expand All@@ -262,6 +262,6 @@ public function testRejectsControllerWithRemapMethod()

 $router = $this->createNewAutoRouter();

 $router->getRoute('remap/test');
 $router->getRoute('remap/test', 'get');
 }
}

75 changes: 75 additions & 0 deletions
tests/system/Test/FeatureTestAutoRoutingImprovedTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use CodeIgniter\Events\Events;
use Config\Feature;
use Config\Services;

/**
 * @group Others
 *
 * @internal
 */
final class FeatureTestAutoRoutingImprovedTest extends CIUnitTestCase
{
 use FeatureTestTrait;

 public static function setUpBeforeClass(): void
 {
 parent::setUpBeforeClass();

 Events::simulate(true);

 self::initializeRouter();
 }

 public static function tearDownAfterClass(): void
 {
 parent::tearDownAfterClass();

 Events::simulate(false);

 Services::reset();
 }

 private static function initializeRouter(): void
 {
 $routes = Services::routes();
 $routes->resetRoutes();
 $routes->loadRoutes();

 $routes->setAutoRoute(true);
 config(Feature::class)->autoRoutesImproved = true;

 $namespace = 'Tests\Support\Controllers';
 $routes->setDefaultNamespace($namespace);

 $router = Services::router($routes);

 Services::injectMock('router', $router);
 }

 public function testCallGet()
 {
 $response = $this->get('newautorouting');

 $response->assertSee('Hello');
 }

 public function testCallPost()
 {
 $response = $this->post('newautorouting/save/1/a/b');

 $response->assertSee('Saved');
 }
}
Loading