refactor: Gt->GT compatibility

Author: g105b

gt-namespace-compatibility.php

@@ -1,3 +1,4 @@
+
 <?php
 /**
  * Namespace compatibility layer for Gt -> GT transition.
@@ -9,6 +10,12 @@
 spl_autoload_register(function(string $class):void {
 	if(str_starts_with($class, 'GT\\')) {
 		$legacyClass = 'Gt' . substr($class, 2);
-		class_alias($legacyClass, $class, true);
+		// Trigger autoloading for the legacy class
+		spl_autoload_call($legacyClass);
+		// Only create alias if it was loaded and target doesn't already exist
+		if((class_exists($legacyClass, false) || interface_exists($legacyClass, false) || trait_exists($legacyClass, false))
+			&& !class_exists($class, false) && !interface_exists($class, false) && !trait_exists($class, false)) {
+			class_alias($legacyClass, $class);
+		}
 	}
-}, true, false);
+}, true, true);

src/Application.php

@@ -1,18 +1,21 @@
 <?php
 namespace GT\WebEngine;
 
-use GT\Config\Config;
-use GT\Config\ConfigFactory;
-use GT\Http\Response;
-use Gt\Http\ServerRequest;
-use GT\Http\Stream;
-use GT\ProtectedGlobal\Protection;
+use Closure;
+use Throwable;
+use ErrorException;
 use GT\WebEngine\Debug\OutputBuffer;
 use GT\WebEngine\Debug\Timer;
 use GT\WebEngine\Redirection\Redirect;
-use GT\Http\RequestFactory;
-use ErrorException;
-use Throwable;
+use GT\WebEngine\Dispatch\Dispatcher;
+use GT\WebEngine\Dispatch\DispatcherFactory;
+use Gt\Config\Config;
+use Gt\Config\ConfigFactory;
+use Gt\Http\RequestFactory;
+use Gt\Http\Response;
+use Gt\Http\ServerRequest;
+use Gt\Http\Stream;
+use Gt\ProtectedGlobal\Protection;
 
 /**
  * The fundamental purpose of any PHP framework is to provide a mechanism for
@@ -26,9 +29,11 @@ class Application {
 	private Redirect $redirect;
 	private Timer $timer;
 	private OutputBuffer $outputBuffer;
+	private RequestFactory $requestFactory;
 	/** @var array<string, array<string, string>> */
 	private array $globals;
 	private Config $config;
+	private DispatcherFactory $dispatcherFactory;
 	private Dispatcher $dispatcher;
 	private bool $finished = false;
 
@@ -39,13 +44,25 @@ class Application {
 	public function __construct(
 		?Redirect $redirect = null,
 		?Config $config = null,
+		?Timer $timer = null,
+		?OutputBuffer $outputBuffer = null,
+		?RequestFactory $requestFactory = null,
+		?DispatcherFactory $dispatcherFactory = null,
 		?array $globals = null,
+		?Closure $handleShutdown = null,
 	) {
 		$this->gtCompatibility();
-		$this->config = $config ?? $this->loadConfig();
 		$this->redirect = $redirect ?? new Redirect();
+		$this->config = $config ?? $this->loadConfig();
+		$this->timer = $timer ?? new Timer(
+			$this->config->getFloat("app.slow_delta"),
+			$this->config->getFloat("app.very_slow_delta"),
+		);
+		$this->outputBuffer = $outputBuffer ?? new OutputBuffer();
+		$this->requestFactory = $requestFactory ?? new RequestFactory();
+		$this->dispatcherFactory = $dispatcherFactory ?? new DispatcherFactory();
 		$this->globals = $globals ?? $GLOBALS;
-		register_shutdown_function($this->handleShutdown(...));
+		register_shutdown_function($handleShutdown ?? $this->handleShutdown(...));
 	}
 
 	public function start():void {
@@ -56,37 +73,32 @@ public function start():void {
 // This timer is only used again at the end of the call, when finish() is
 // called - at which point the entire duration of the request is logged out (and
 // slow requests are highlighted as a NOTICE).
-		$this->timer = new Timer(
-			$this->config->getFloat("app.slow_delta"),
-			$this->config->getFloat("app.very_slow_delta"),
-		);
+		$this->timer->start();
 
 // Starting the output buffer is done before any logic is executed, so any calls
 // to any area of code will not accidentally send output to the web browser.
-		$this->outputBuffer = new OutputBuffer();
+		$this->outputBuffer->start();
 
 // PHP.GT provides object-oriented interfaces to all values stored in $_SERVER,
 // $_FILES, $_GET, and $_POST - to enforce good encapsulation and safe variable
 // usage, the globals are protected against accidental misuse.
 		$this->protectGlobals();
 
-		$requestFactory = new RequestFactory();
-
 		/** @var ServerRequest $request */
-		$request = $requestFactory->createServerRequestFromGlobalState(
-			$this->globals["server"],
-			$this->globals["files"],
-			$this->globals["get"],
-			$this->globals["post"],
+		$request = $this->requestFactory->createServerRequestFromGlobalState(
+			$this->globals["_SERVER"] ?? [],
+			$this->globals["_FILES"] ?? [],
+			$this->globals["_GET"] ?? [],
+			$this->globals["_POST"] ?? [],
 		);
 
-		$this->dispatcher = new Dispatcher(
+		$this->dispatcher = $this->dispatcherFactory->create(
 			$this->config,
 			$request,
-			$this->globals["get"],
-			$this->globals["post"],
-			$this->globals["files"],
-			$this->globals["server"],
+			$this->globals["_GET"],
+			$this->globals["_POST"],
+			$this->globals["_FILES"],
+			$this->globals["_SERVER"],
 		);
 
 		try {

src/Debug/OutputBuffer.php

@@ -21,6 +21,9 @@ public function __construct(
 	) {
 		$this->obStartHandler = $obStartHandler ?? fn() => ob_start();
 		$this->obGetCleanHandler = $obGetCleanHandler ?? fn() => ob_get_clean();
+	}
+
+	public function start():void {
 		($this->obStartHandler)();
 	}
 

src/Debug/Timer.php

@@ -32,6 +32,9 @@ public function __construct(
 		}
 
 		$this->timeGetter = $timeGetter ?? fn() => microtime(true);
+	}
+
+	public function start():void {
 		$this->startTime = ($this->timeGetter)();
 	}
 

src/Dispatcher.php src/Dispatch/Dispatcher.phpsrc/Dispatcher.php renamed to src/Dispatch/Dispatcher.php

@@ -1,5 +1,5 @@
 <?php
-namespace GT\WebEngine;
+namespace GT\WebEngine\Dispatch;
 
 use Gt\Config\Config;
 use Gt\Http\Request;

src/Dispatch/DispatcherFactory.php

@@ -0,0 +1,25 @@
+<?php
+namespace GT\WebEngine\Dispatch;
+
+use Gt\Config\Config;
+use Gt\Http\Request;
+
+class DispatcherFactory {
+	public function create(
+		Config $config,
+		Request $request,
+		array $globalGet,
+		array $globalPost,
+		array $globalFiles,
+		array $globalServer,
+	):Dispatcher {
+		return new Dispatcher(
+			$config,
+			$request,
+			$globalGet,
+			$globalPost,
+			$globalFiles,
+			$globalServer,
+		);
+	}
+}

test/phpunit/ApplicationTest.php

@@ -1,8 +1,95 @@
 <?php
 namespace GT\WebEngine\Test;
 
+use GT\Http\RequestFactory;
+use GT\Http\Response;
+use GT\WebEngine\Application;
+use GT\WebEngine\Debug\OutputBuffer;
+use GT\WebEngine\Debug\Timer;
+use GT\WebEngine\Dispatch\Dispatcher;
+use GT\WebEngine\Dispatch\DispatcherFactory;
+use GT\WebEngine\Redirection\Redirect;
 use PHPUnit\Framework\TestCase;
 
 class ApplicationTest extends TestCase {
+	public function testStart_callsRedirectExecute():void {
+		$redirect = self::createMock(Redirect::class);
+		$redirect->expects(self::once())
+			->method("execute");
 
+		$sut = new Application(
+			redirect: $redirect,
+		);
+		$sut->start();
+	}
+
+	public function testStart_callsTimerFunctions():void {
+		$timer = self::createMock(Timer::class);
+		$timer->expects(self::once())
+			->method("start");
+		$timer->expects(self::once())
+			->method("stop");
+		$timer->expects(self::once())
+			->method("logDelta");
+
+		$sut = new Application(
+			timer: $timer,
+		);
+		$sut->start();
+	}
+
+	public function testStart_callsOutputBufferFunctions():void {
+		$outputBuffer = self::createMock(OutputBuffer::class);
+		$outputBuffer->expects(self::once())
+			->method("start");
+		$outputBuffer->expects(self::once())
+			->method("debugOutput");
+
+		$sut = new Application(
+			outputBuffer: $outputBuffer,
+		);
+		$sut->start();
+	}
+
+	public function testStart_callsRequestFactoryFunctions():void {
+		$requestFactory = self::createMock(RequestFactory::class);
+		$requestFactory->expects(self::once())
+			->method("createServerRequestFromGlobalState");
+
+		$sut = new Application(
+			requestFactory: $requestFactory,
+		);
+		$sut->start();
+	}
+
+	/**
+	 * This test is really important because it shows that all of the
+	 * components that make up the request/response can be injected into the
+	 * application, so everything can be meticulously tested in detail.
+	 */
+	public function testStart_callsDispatcherFactoryFunctions():void {
+		$response = self::createMock(Response::class);
+		$dispatcher = self::createMock(Dispatcher::class);
+
+		$dispatcherFactory = self::createMock(DispatcherFactory::class);
+		$dispatcherFactory->expects(self::once())
+			->method("create")
+			->willReturn($dispatcher);
+
+		$dispatcher->expects(self::once())
+			->method("generateResponse")
+			->willReturn($response);
+
+		$response->expects(self::once())
+			->method("getStatusCode");
+		$response->expects(self::once())
+			->method("getHeaders");
+		$response->expects(self::once())
+			->method("getBody");
+
+		$sut = new Application(
+			dispatcherFactory: $dispatcherFactory,
+		);
+		$sut->start();
+	}
 }

test/phpunit/Debug/OutputBufferTest.php

@@ -7,13 +7,15 @@
 class OutputBufferTest extends TestCase {
 	public function testEchoIsCaptured():void {
 		$sut = new OutputBuffer();
+		$sut->start();
 		echo "Hello world";
 		$buffer = $sut->getBuffer();
 		self::assertSame("Hello world", $buffer);
 	}
 
 	public function testVarDumpIsCaptured():void {
 		$sut = new OutputBuffer();
+		$sut->start();
 		$var = ["a" => 1, "b" => 2];
 		var_dump($var);
 		$buffer = $sut->getBuffer();

test/phpunit/Debug/TimerTest.php

@@ -15,12 +15,13 @@ public function testDeltaWithInjectedTimeGetter():void {
 		};
 
 		$sut = new Timer(timeGetter: $timeGetter);
+		$sut->start();
 		$sut->stop();
 		self::assertSame(2.5, $sut->getDelta());
 	}
 
 	public function testStopMultipleTimesUsesLatestEndTime():void {
-		$times = [10.0, 15.0, 20.0];
+		$times = [10.0, 20.0, 40.0, 80.0, 160.0];
 		$index = 0;
 		$timeGetter = function() use (&$times, &$index) {
 			$value = $times[$index] ?? end($times);
@@ -29,10 +30,12 @@ public function testStopMultipleTimesUsesLatestEndTime():void {
 		};
 
 		$sut = new Timer(timeGetter: $timeGetter);
+		$sut->start();
 		$sut->stop();
-		self::assertSame(5.0, $sut->getDelta());
+		self::assertSame(10.0, $sut->getDelta());
 
+		$sut->start();
 		$sut->stop();
-		self::assertSame(10.0, $sut->getDelta());
+		self::assertSame(40.0, $sut->getDelta());
 	}
 }