Skip to content

feat: improve class map generator types #21

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

Closed
wants to merge 2 commits into from
Closed

feat: improve class map generator types #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33539d9
feat: improve class map generator types
shakaran May 27, 2025
473d727
fix: restore static used outside
shakaran May 27, 2025
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
61 changes: 34 additions & 27 deletions src/ClassMapGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@

namespace Composer\ClassMapGenerator;

use InvalidArgumentException;
use SplFileInfo;
use RuntimeException;
use LogicException;
use Traversable;
use Composer\Pcre\Preg;
use Symfony\Component\Finder\Finder;
use Composer\IO\IOInterface;
Expand All @@ -33,17 +38,17 @@ class ClassMapGenerator
/**
* @var list<string>
*/
private $extensions;
private array $extensions = [];

/**
* @var FileList|null
*/
private $scannedFiles = null;
private ?FileList $scannedFiles = null;

/**
* @var ClassMap
*/
private $classMap;
private ClassMap $classMap;

/**
* @var non-empty-string
Expand Down Expand Up @@ -77,10 +82,10 @@ public function avoidDuplicateScans(?FileList $scannedFiles = null): self
/**
* Iterate over all files in the given directory searching for classes
*
* @param string|\Traversable<\SplFileInfo>|array<\SplFileInfo> $path The path to search in or an array/traversable of SplFileInfo (e.g. symfony/finder instance)
* @param string|Traversable<SplFileInfo>|array<SplFileInfo> $path The path to search in or an array/traversable of SplFileInfo (e.g. symfony/finder instance)
* @return array<class-string, non-empty-string> A class map array
*
* @throws \RuntimeException When the path is neither an existing file nor directory
* @throws RuntimeException When the path is neither an existing file nor directory
*/
public static function createMap($path): array
{
Expand All @@ -99,33 +104,35 @@ public function getClassMap(): ClassMap
/**
* Iterate over all files in the given directory searching for classes
*
* @param string|\Traversable<\SplFileInfo>|array<\SplFileInfo> $path The path to search in or an array/traversable of SplFileInfo (e.g. symfony/finder instance)
* @param string|Traversable<SplFileInfo>|array<SplFileInfo> $path The path to search in or an array/traversable of SplFileInfo (e.g. symfony/finder instance)
* @param non-empty-string|null $excluded Regex that matches file paths to be excluded from the classmap
* @param 'classmap'|'psr-0'|'psr-4' $autoloadType Optional autoload standard to use mapping rules with the namespace instead of purely doing a classmap
* @param string|null $namespace Optional namespace prefix to filter by, only for psr-0/psr-4 autoloading
* @param array<string> $excludedDirs Optional dirs to exclude from search relative to $path
*
* @throws \RuntimeException When the path is neither an existing file nor directory
* @throws RuntimeException When the path is neither an existing file nor directory
*/
public function scanPaths($path, ?string $excluded = null, string $autoloadType = 'classmap', ?string $namespace = null, array $excludedDirs = []): void
{
if (!in_array($autoloadType, ['psr-0', 'psr-4', 'classmap'], true)) {
throw new \InvalidArgumentException('$autoloadType must be one of: "psr-0", "psr-4" or "classmap"');
throw new InvalidArgumentException('$autoloadType must be one of: "psr-0", "psr-4" or "classmap"');
}

if ('classmap' !== $autoloadType) {
if (!is_string($path)) {
throw new \InvalidArgumentException('$path must be a string when specifying a psr-0 or psr-4 autoload type');
throw new InvalidArgumentException('$path must be a string when specifying a psr-0 or psr-4 autoload type');
}

if (!is_string($namespace)) {
throw new \InvalidArgumentException('$namespace must be given (even if it is an empty string if you do not want to filter) when specifying a psr-0 or psr-4 autoload type');
throw new InvalidArgumentException('$namespace must be given (even if it is an empty string if you do not want to filter) when specifying a psr-0 or psr-4 autoload type');
}

$basePath = $path;
}

if (is_string($path)) {
if (is_file($path)) {
$path = [new \SplFileInfo($path)];
$path = [new SplFileInfo($path)];
} elseif (is_dir($path) || strpos($path, '*') !== false) {
$path = Finder::create()
->files()
Expand All @@ -134,7 +141,7 @@ public function scanPaths($path, ?string $excluded = null, string $autoloadType
->in($path)
->exclude($excludedDirs);
} else {
throw new \RuntimeException(
throw new RuntimeException(
'Could not scan for classes inside "'.$path.'" which does not appear to be a file nor a folder'
);
}
Expand All @@ -157,7 +164,7 @@ public function scanPaths($path, ?string $excluded = null, string $autoloadType
}

if ('' === $filePath) {
throw new \LogicException('Got an empty $filePath for '.$file->getPathname());
throw new LogicException('Got an empty $filePath for '.$file->getPathname());
}

$realPath = $isStreamWrapperPath
Expand All @@ -166,7 +173,7 @@ public function scanPaths($path, ?string $excluded = null, string $autoloadType

// fallback just in case but this really should not happen
if (false === $realPath) {
throw new \RuntimeException('realpath of '.$filePath.' failed to resolve, got false');
throw new RuntimeException('realpath of '.$filePath.' failed to resolve, got false');
}

// if a list of scanned files is given, avoid scanning twice the same file to save cycles and avoid generating warnings
Expand All @@ -179,6 +186,7 @@ public function scanPaths($path, ?string $excluded = null, string $autoloadType
if (null !== $excluded && Preg::isMatch($excluded, strtr($realPath, '\\', '/'))) {
continue;
}

// check non-realpath of file for directories symlink in project dir
if (null !== $excluded && Preg::isMatch($excluded, strtr($filePath, '\\', '/'))) {
continue;
Expand All @@ -189,7 +197,7 @@ public function scanPaths($path, ?string $excluded = null, string $autoloadType
$classes = $this->filterByNamespace($classes, $filePath, $namespace, $autoloadType, $basePath);

// if no valid class was found in the file then we do not mark it as scanned as it might still be matched by another rule later
if (\count($classes) > 0 && $this->scannedFiles !== null) {
if ($classes !== [] && $this->scannedFiles !== null) {
$this->scannedFiles->add($realPath);
}
} elseif ($this->scannedFiles !== null) {
Expand Down Expand Up @@ -217,7 +225,7 @@ public function scanPaths($path, ?string $excluded = null, string $autoloadType
* @param string $basePath root directory of given autoload mapping
* @return array<int, class-string> valid classes
*
* @throws \InvalidArgumentException When namespaceType is neither psr-0 nor psr-4
* @throws InvalidArgumentException When namespaceType is neither psr-0 nor psr-4
*/
private function filterByNamespace(array $classes, string $filePath, string $baseNamespace, string $namespaceType, string $basePath): array
{
Expand All @@ -244,26 +252,29 @@ private function filterByNamespace(array $classes, string $filePath, string $bas
$subNamespace = ('' !== $baseNamespace) ? substr($class, strlen($baseNamespace)) : $class;
$subPath = str_replace('\\', DIRECTORY_SEPARATOR, $subNamespace);
} else {
throw new \InvalidArgumentException('$namespaceType must be "psr-0" or "psr-4"');
throw new InvalidArgumentException('$namespaceType must be "psr-0" or "psr-4"');
}

if ($subPath === $realSubPath) {
$validClasses[] = $class;
} else {
$rejectedClasses[] = $class;
}
}

// warn only if no valid classes, else silently skip invalid
if (\count($validClasses) === 0) {
if ($validClasses === []) {
$cwd = realpath(self::getCwd());
if ($cwd === false) {
$cwd = self::getCwd();
}

$cwd = self::normalizePath($cwd);
$shortPath = Preg::replace('{^'.preg_quote($cwd).'}', '.', self::normalizePath($filePath), 1);
$shortBasePath = Preg::replace('{^'.preg_quote($cwd).'}', '.', self::normalizePath($basePath), 1);

foreach ($rejectedClasses as $class) {
$this->classMap->addPsrViolation("Class $class located in $shortPath does not comply with $namespaceType autoloading standard (rule: $baseNamespace => $shortBasePath). Skipping.", $class, $filePath);
$this->classMap->addPsrViolation(sprintf('Class %s located in %s does not comply with %s autoloading standard (rule: %s => %s). Skipping.', $class, $shortPath, $namespaceType, $baseNamespace, $shortBasePath), $class, $filePath);
}

return [];
Expand All @@ -276,11 +287,8 @@ private function filterByNamespace(array $classes, string $filePath, string $bas
* Checks if the given path is absolute
*
* @see Composer\Util\Filesystem::isAbsolutePath
*
* @param string $path
* @return bool
*/
private static function isAbsolutePath(string $path)
private static function isAbsolutePath(string $path): bool
{
return strpos($path, '/') === 0 || substr($path, 1, 1) === ':' || strpos($path, '\\\\') === 0;
}
Expand All @@ -292,9 +300,8 @@ private static function isAbsolutePath(string $path)
* @see Composer\Util\Filesystem::normalizePath
*
* @param string $path Path to the file or directory
* @return string
*/
private static function normalizePath(string $path)
private static function normalizePath(string $path): string
{
$parts = [];
$path = strtr($path, '\\', '/');
Expand Down Expand Up @@ -322,7 +329,7 @@ private static function normalizePath(string $path)
foreach (explode('/', $path) as $chunk) {
if ('..' === $chunk && (\strlen($absolute) > 0 || $up)) {
array_pop($parts);
$up = !(\count($parts) === 0 || '..' === end($parts));
$up = $parts !== [] && '..' !== end($parts);
} elseif ('.' !== $chunk && '' !== $chunk) {
$parts[] = $chunk;
$up = '..' !== $chunk;
Expand All @@ -343,7 +350,7 @@ private static function getCwd(): string
$cwd = getcwd();

if (false === $cwd) {
throw new \RuntimeException('Could not determine the current working directory');
throw new RuntimeException('Could not determine the current working directory');
}

return $cwd;
Expand Down
Loading