maintenance: phpmd/phpcs

Author: g105b

phpcs.xml

@@ -1,12 +1,14 @@
 <?xml version="1.0"?>
 <ruleset name="PHP.Gt Standard" namespace="Gt\CS\Standard">
-	<description>Created from PHP.GT/Styleguide</description>
+	<description>Created from PHP.Gt/Styleguide</description>
 	<arg name="extensions" value="php" />
 
 	<rule ref="Generic.Classes.DuplicateClassName" />
 	<rule ref="Generic.Classes.OpeningBraceSameLine" />
 	<rule ref="Generic.CodeAnalysis.EmptyPHPStatement" />
-	<rule ref="Generic.CodeAnalysis.EmptyStatement" />
+	<rule ref="Generic.CodeAnalysis.EmptyStatement">
+		<exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedCatch" />
+	</rule>
 	<rule ref="Generic.CodeAnalysis.ForLoopShouldBeWhileLoop" />
 	<rule ref="Generic.CodeAnalysis.ForLoopWithTestFunctionCall" />
 	<rule ref="Generic.CodeAnalysis.JumbledIncrementer" />
@@ -18,6 +20,13 @@
 	<rule ref="Generic.Files.EndFileNewline" />
 	<rule ref="Generic.Files.InlineHTML" />
 	<rule ref="Generic.Files.LineEndings" />
+	<rule ref="Generic.Files.LineLength">
+		<properties>
+			<property name="lineLimit" value="120" />
+			<property name="absoluteLineLimit" value="0" />
+			<property name="ignoreComments" value="true" />
+		</properties>
+	</rule>
 	<rule ref="Generic.Files.OneClassPerFile" />
 	<rule ref="Generic.Files.OneInterfacePerFile" />
 	<rule ref="Generic.Files.OneObjectStructurePerFile" />

phpmd.xml

@@ -6,7 +6,14 @@
 	 xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
 	<description>Custom ruleset</description>
 
+	<rule ref="rulesets/codesize.xml">
+		<exclude name="TooManyPublicMethods"/>
+		<exclude name="CyclomaticComplexity"/>
+		<exclude name="NPathComplexity"/>
+	</rule>
+
 	<rule ref="rulesets/cleancode.xml">
+		<exclude name="StaticAccess" />
 		<exclude name="ElseExpression" />
 		<exclude name="IfStatementAssignment" />
 	</rule>
@@ -16,22 +23,30 @@
 	</rule>
 
 	<rule ref="rulesets/design.xml">
+		<exclude name="CouplingBetweenObjects" />
 		<exclude name="NumberOfChildren" />
+		<exclude name="EmptyCatchBlock" />
 	</rule>
 
 	<rule ref="rulesets/naming.xml">
 		<exclude name="ShortVariable"/>
-		<exclude name="LongVariable"/>
 		<exclude name="LongClassName"/>
 	</rule>
 
 	<rule ref="rulesets/unusedcode.xml">
 		<exclude name="UnusedFormalParameter" />
 	</rule>
 
+	<rule ref="rulesets/codesize.xml/TooManyPublicMethods">
+		<priority>1</priority>
+		<properties>
+			<property name="maxmethods" value="20" />
+		</properties>
+	</rule>
+
 	<rule ref="rulesets/naming.xml/ShortVariable">
 		<properties>
-			<property name="exceptions" value="ch,mh,sh,id,tr,td,i,fh" />
+			<property name="exceptions" value="ch,mh,sh,id,tr,td,i" />
 		</properties>
 	</rule>
 </ruleset>

src/Application.php

@@ -33,7 +33,8 @@
  * The heavy lifting of converting Request to Response is performed in the
  * Dispatcher's generateResponse() method.
  *
-  * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
+ * @SuppressWarnings("PHPMD.ExcessiveClassComplexity")
  */
 class Application {
 	private Redirect $redirect;
@@ -48,7 +49,7 @@ class Application {
 	private Config $config;
 	private DispatcherFactory $dispatcherFactory;
 	private Dispatcher $dispatcher;
-	private static bool $loggerStreamsConfigured = false;
+	private static bool $loggerConfigured = false;
 	private bool $finished = false;
 
 	/**
@@ -259,6 +260,7 @@ private function protectGlobals():void {
 		);
 	}
 
+	/** @SuppressWarnings("PHPMD.Superglobals") */
 	public function restoreGlobals(): void {
 		foreach ($this->globals as $key => $value) {
 			$GLOBALS[$key] = $value;
@@ -285,7 +287,7 @@ private function loadConfig():Config {
 	}
 
 	private function configureLoggerStreams():void {
-		if(self::$loggerStreamsConfigured) {
+		if(self::$loggerConfigured) {
 			return;
 		}
 
@@ -318,7 +320,7 @@ private function configureLoggerStreams():void {
 			$stderrMinLevel,
 			LogLevel::EMERGENCY,
 		);
-		self::$loggerStreamsConfigured = true;
+		self::$loggerConfigured = true;
 	}
 
 	private function handleShutdown():void {
@@ -378,7 +380,7 @@ private function logError(Throwable $throwable):void {
 			return;
 		}
 
-		if(self::$loggerStreamsConfigured) {
+		if(self::$loggerConfigured) {
 			Log::error((string)$throwable);
 			return;
 		}
@@ -409,7 +411,10 @@ private function getStderrMinimumLogLevel():string {
 		return LogLevel::ERROR;
 	}
 
-	/** @return array<string, mixed> */
+	/**
+	 * @return array<string, mixed>
+	 * @SuppressWarnings("PHPMD.Superglobals")
+	 */
 	private function getLogContext():array {
 		$uri = $this->request->getUri();
 		$uriPath = $uri->getPath();

src/Debug/Timer.php

@@ -62,7 +62,11 @@ public function logDelta():void {
 			return;
 		}
 
-		$this->deltaLogCallback->call($this, "Timer ended with $message delta time: $delta seconds. https://www.php.gt/webengine/slow-delta");
+		$this->deltaLogCallback->call(
+			$this,
+			"Timer ended with $message delta time: $delta seconds. "
+			. "https://www.php.gt/webengine/slow-delta"
+		);
 	}
 
 }

src/Dispatch/Dispatcher.php

@@ -45,6 +45,10 @@
 use GT\WebEngine\View\ViewStreamer;
 use Throwable;
 
+/**
+ * @SuppressWarnings("PHPMD.TooManyFields")
+ * @SuppressWarnings("PHPMD.ExcessiveClassComplexity")
+ */
 class Dispatcher {
 	private Config $config;
 	private Request $request;
@@ -70,12 +74,15 @@ class Dispatcher {
 	private ViewStreamer $viewStreamer;
 
 	private HeaderManager $headerManager;
-	private Closure $viewModelInitCallback;
+	private Closure $viewInitCb;
 	private bool $redirectPrepared = false;
 
 	/**
 	 * @param array<string, array<string, string|array<string, string>>> $globals
+	 * @SuppressWarnings("PHPMD.ExcessiveMethodLength")
+	 * @SuppressWarnings("PHPMD.ExcessiveParameterList")
 	 */
+	// phpcs:disable Generic.Metrics.CyclomaticComplexity.TooHigh
 	public function __construct(
 		Config $config,
 		Request $request,
@@ -190,7 +197,7 @@ public function __construct(
 			$this->config->getString("view.partial_directory"),
 		);
 		$this->viewModelProcessor = $viewModelInit->getViewModelProcessor();
-		$this->viewModelInitCallback = $this->viewModel instanceof HTMLDocument
+		$this->viewInitCb = $this->viewModel instanceof HTMLDocument
 		? function()use($viewModelInit):void {
 			$documentBinder = $this->serviceContainer->get(Binder::class);
 			assert($documentBinder instanceof DocumentBinder);
@@ -215,6 +222,7 @@ public function __construct(
 		$this->viewStreamer = $viewStreamer ?? new ViewStreamer();
 		$this->headerManager = $headerManager ?? new HeaderManager();
 	}
+	// phpcs:enable Generic.Metrics.CyclomaticComplexity.TooHigh
 
 	public function generateResponse():Response {
 		if($this->redirectPrepared) {
@@ -251,7 +259,7 @@ public function generateErrorResponse(Throwable $throwable):Response {
 			throw new ErrorPageNotFoundException(code: $errorStatusCode);
 		}
 
-		$this->processResponse(true, $throwable);
+		$this->processResponse($throwable);
 		$this->response = $this->response->withStatus($errorStatusCode);
 		return $this->response;
 	}
@@ -273,7 +281,8 @@ public function generateBasicErrorResponse(
 				$errorMessage = "The server could not find the requested resource.";
 
 				if(!$this->config->getBool("app.production")) {
-					$detail .= " Additionally, there was no error page found in your application at <strong>$errorPageDir/$errorStatusCode.html</strong>";
+					$detail .= " Additionally, there was no error page found in your "
+						. "application at <strong>$errorPageDir/$errorStatusCode.html</strong>";
 				}
 			}
 		}
@@ -306,11 +315,13 @@ public function generateBasicErrorResponse(
 
 		$body = new Stream();
 		$body->write($html);
-		return new Response(request: $this->request)->withBody($body)->withStatus($errorStatusCode);
+		$response = new Response(null, null, $this->request);
+		$response = $response->withBody($body);
+		return $response->withStatus($errorStatusCode);
 	}
 
 	private function setupResponse():Response {
-		$response = new Response(request: $this->request);
+		$response = new Response(null, null, $this->request);
 		$response->setExitCallback(function() {
 			($this->finishCallback)($this->response);
 		});
@@ -343,7 +354,8 @@ private function handleLogicExecution(
 		}
 
 		foreach($this->logicExecutor->invoke($logicAssembly, "go_before", $extraArgs) as $file) {
-			// TODO: Hook up to debug output
+			// Force generator execution even when debug output is disabled.
+			continue;
 		}
 
 // TODO: No need to have the whole Input class. Just pass a nullable string in called $doMethod, from $input->getString("do")
@@ -356,25 +368,28 @@ function(InputData $data)use($logicAssembly, $extraArgs) {
 					);
 
 				foreach($this->logicExecutor->invoke($logicAssembly, $doName, $extraArgs) as $file) {
-					// TODO: Hook up to debug output
+					// Force generator execution even when debug output is disabled.
+					continue;
 				}
 			}
 		);
 
 		foreach($this->logicExecutor->invoke($logicAssembly, "go", $extraArgs) as $file) {
-			// TODO: Hook up to debug output
+			// Force generator execution even when debug output is disabled.
+			continue;
 		}
 
 		foreach($this->logicExecutor->invoke($logicAssembly, "go_after", $extraArgs) as $file) {
-			// TODO: Hook up to debug output
+			// Force generator execution even when debug output is disabled.
+			continue;
 		}
 	}
 
 	/**
 	 * @return void
 	 */
+	// phpcs:disable Generic.Metrics.CyclomaticComplexity.TooHigh
 	public function processResponse(
-		bool $processingError = false,
 		?Throwable $errorThrowable = null,
 	):void {
 		$dynamicPath = $this->serviceContainer->get(DynamicPath::class);
@@ -384,19 +399,19 @@ public function processResponse(
 			$dynamicPath,
 		);
 
-		$logicAssemblyComponentList = $this->viewModelProcessor?->processPartialContent(
+		$componentList = $this->viewModelProcessor?->processPartialContent(
 			$this->viewModel,
 		);
 
 // TODO: CSRF handling - needs to be done on any POST request.
-		($this->viewModelInitCallback)();
-		if($processingError && $errorThrowable) {
+		($this->viewInitCb)();
+		if($errorThrowable) {
 			$this->bindErrorDetails($errorThrowable);
 		}
 
-		foreach($logicAssemblyComponentList ?? [] as $logicAssemblyComponent) {
-			$assembly = $logicAssemblyComponent->assembly;
-			$componentElement = $logicAssemblyComponent->component;
+		foreach($componentList ?? [] as $componentLogic) {
+			$assembly = $componentLogic->assembly;
+			$componentElement = $componentLogic->component;
 			$this->serviceContainer->set($componentElement);
 
 			try {
@@ -407,7 +422,7 @@ public function processResponse(
 				);
 			}
 			catch(Throwable $throwable) {
-				if(!$processingError) {
+				if(!$errorThrowable) {
 					throw $throwable;
 				}
 			}
@@ -420,7 +435,7 @@ public function processResponse(
 			);
 		}
 		catch(Throwable $throwable) {
-			if(!$processingError) {
+			if(!$errorThrowable) {
 				throw $throwable;
 			}
 		}
@@ -438,6 +453,7 @@ public function processResponse(
 
 		$this->viewStreamer->stream($this->view, $this->viewModel);
 	}
+	// phpcs:enable Generic.Metrics.CyclomaticComplexity.TooHigh
 
 	public function getSessionInit():?SessionInit {
 		return $this->sessionInit;
@@ -452,6 +468,7 @@ private function isRedirectPrepared():bool {
 		return $this->response->hasHeader("Location");
 	}
 
+	// phpcs:disable Generic.Metrics.CyclomaticComplexity.TooHigh
 	private function bindErrorDetails(Throwable $throwable):void {
 		$trace = $throwable->getTrace();
 		array_unshift($trace, [
@@ -498,4 +515,5 @@ private function bindErrorDetails(Throwable $throwable):void {
 			$binder->bindKeyValue("trace", $traceString);
 		}
 	}
+	// phpcs:enable Generic.Metrics.CyclomaticComplexity.TooHigh
 }

src/Dispatch/RouterFactory.php

@@ -6,29 +6,30 @@
 use Gt\ServiceContainer\Container;
 
 class RouterFactory {
+	/** @SuppressWarnings("PHPMD.LongVariable") */
 	public function create(
 		Container $container,
-		string $configAppNamespace,
-		string $configAppRouterFile,
-		string $configAppRouterClass,
-		string $configDefaultRouterFile,
-		string $configDefaultRouterClass,
-		int $configRedirectResponseCode,
-		string $configDefaultContentType,
+		string $appNamespace,
+		string $appRouterFile,
+		string $appRouterClass,
+		string $defaultRouterFile,
+		string $defaultRouterClass,
+		int $redirectResponseCode,
+		string $defaultContentType,
 		?int $errorStatus = null,
 	):BaseRouter {
-		if(file_exists($configAppRouterFile)) {
-			require_once($configAppRouterFile);
-			$class = "\\$configAppNamespace\\$configAppRouterClass";
+		if(file_exists($appRouterFile)) {
+			require_once($appRouterFile);
+			$class = "\\$appNamespace\\$appRouterClass";
 		}
 		else {
-			require_once($configDefaultRouterFile);
-			$class = $configDefaultRouterClass;
+			require_once($defaultRouterFile);
+			$class = $defaultRouterClass;
 		}
 
 		$routerConfig = new RouterConfig(
-			$configRedirectResponseCode,
-			$configDefaultContentType,
+			$redirectResponseCode,
+			$defaultContentType,
 		);
 
 		/** @var BaseRouter $router */

src/Init/RouterInit.php

@@ -23,6 +23,7 @@ class RouterInit {
 	private Assembly $viewAssembly;
 	private Assembly $logicAssembly;
 
+	/** @SuppressWarnings("PHPMD.ExcessiveParameterList") */
 	public function __construct(
 		Request $request,
 		Response $response,