new: ImportResolver trait to resolve use statements.

Author: hsehszroc

Src/Traits/ImportResolver.php

@@ -0,0 +1,54 @@
+<?php
+declare( strict_types = 1 );
+
+namespace TheWebSolver\Codegarage\Generator\Traits;
+
+use Nette\PhpGenerator\Helpers;
+use Nette\PhpGenerator\PhpNamespace;
+
+trait ImportResolver {
+	private PhpNamespace $namespace;
+
+	public function setNamespace( PhpNamespace $namespace = null ): static {
+		$this->namespace ??= $namespace ?? new PhpNamespace( '' );
+
+		return $this;
+	}
+
+	public function getNamespace(): PhpNamespace {
+		return $this->namespace;
+	}
+
+	/**
+	 * @param string $item
+	 * @return string The alias of the $item that is being imported. Mostly the classname only without the
+	 *                namespace part. If already has alias, alias is prefixed with last part of namespace.
+	 */
+	public function addUseStatementOf( string $item ): string {
+		$classnameOnly = $alias = Helpers::extractShortName( $item );
+
+		if ( $this->hasAlreadyImported( $item ) ) {
+			return $classnameOnly;
+		}
+
+		$lastPartOfNamespace = $this->hasAlreadyAliasedImportedItemAs( $classnameOnly )
+			? Helpers::extractShortName( Helpers::extractNamespace( $item ) )
+			: '';
+
+		$this->getNamespace()->addUse( $item, $alias = $lastPartOfNamespace . $classnameOnly );
+
+		return $alias;
+	}
+
+	private function hasAlreadyImported( string $item ): bool {
+		return in_array( $item, haystack: $this->getNamespace()->getUses(), strict: true );
+	}
+
+	private function hasAlreadyAliasedImportedItemAs( string $classnameOnly ): bool {
+		return ! empty( $uses = $this->getNamespace()->getUses() ) && array_filter(
+			array: $uses,
+			callback: static fn( string $alias ): bool => $alias === $classnameOnly,
+			mode: ARRAY_FILTER_USE_KEY
+		);
+	}
+}

Tests/Integration/ImportResolverTest.php

@@ -0,0 +1,54 @@
+<?php
+declare( strict_types = 1 );
+
+namespace TheWebSolver\Codegarage\Integration;
+
+use PHPUnit\Framework\TestCase;
+use Nette\PhpGenerator\PhpNamespace;
+use PHPUnit\Framework\Attributes\Test;
+use TheWebSolver\Codegarage\Generator\Traits\ImportResolver;
+
+class ImportResolverTest extends TestCase {
+	#[Test]
+	public function itEnsuresSetterGetterWorks(): void {
+		$import = new class() {
+			use ImportResolver;
+		};
+
+		$import->setNamespace( $namespace = new PhpNamespace( '' ) );
+
+		$this->assertSame( $namespace, $import->getNamespace() );
+	}
+
+	#[Test]
+	public function itEnsuresAliasesAreCreatedWhenImporting(): void {
+		$import = new class() {
+			use ImportResolver;
+		};
+
+		$import->setNamespace( new PhpNamespace( '' ) );
+
+		$import->addUseStatementOf( ImportResolver::class );
+		$import->addUseStatementOf( TestCase::class );
+
+		$this->assertCount( 2, $imports = $import->getNamespace()->getUses() );
+
+		foreach ( array( ImportResolver::class, TestCase::class ) as $item ) {
+			$this->assertContains( $item, $imports );
+		}
+
+		$import->addUseStatementOf( ImportResolver::class );
+
+		$this->assertCount( 2, $import->getNamespace()->getUses(), 'Must not add same import again.' );
+
+		$import->addUseStatementOf( 'DifferentNamespaced\\' . ImportResolver::class );
+
+		$this->assertCount( 3, $uses = $import->getNamespace()->getUses() );
+		$this->assertContains( 'DifferentNamespaced\\' . ImportResolver::class, $uses );
+		$this->assertArrayHasKey(
+			'TraitsImportResolver',
+			$uses,
+			'Must alias if already imported same classname that exists in another namespace.'
+		);
+	}
+}