Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 66 |
|
0.00% |
0 / 4 |
CRAP | |
0.00% |
0 / 1 |
| FileEnumerator | |
0.00% |
0 / 66 |
|
0.00% |
0 / 4 |
506 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 8 |
|
0.00% |
0 / 1 |
2 | |||
| compileFileListForDependencies | |
0.00% |
0 / 35 |
|
0.00% |
0 / 1 |
210 | |||
| addFileWithDependency | |
0.00% |
0 / 17 |
|
0.00% |
0 / 1 |
30 | |||
| compileFileListForPaths | |
0.00% |
0 / 6 |
|
0.00% |
0 / 1 |
6 | |||
| 1 | <?php |
| 2 | /** |
| 3 | * Build a list of files from the composer autoloaders. |
| 4 | * |
| 5 | * Also record the `files` autoloaders. |
| 6 | */ |
| 7 | |
| 8 | namespace BrianHenryIE\Strauss\Pipeline; |
| 9 | |
| 10 | use BrianHenryIE\Strauss\Composer\ComposerPackage; |
| 11 | use BrianHenryIE\Strauss\Config\FileEnumeratorConfig; |
| 12 | use BrianHenryIE\Strauss\Files\DiscoveredFiles; |
| 13 | use BrianHenryIE\Strauss\Files\File; |
| 14 | use BrianHenryIE\Strauss\Files\FileWithDependency; |
| 15 | use BrianHenryIE\Strauss\Helpers\FileSystem; |
| 16 | use League\Flysystem\FilesystemException; |
| 17 | use Psr\Log\LoggerAwareTrait; |
| 18 | use Psr\Log\LoggerInterface; |
| 19 | use Psr\Log\NullLogger; |
| 20 | |
| 21 | class FileEnumerator |
| 22 | { |
| 23 | use LoggerAwareTrait; |
| 24 | |
| 25 | protected string $vendorDir; |
| 26 | |
| 27 | /** @var string[] */ |
| 28 | protected array $excludePackageNames = array(); |
| 29 | |
| 30 | /** @var string[] */ |
| 31 | protected array $excludeNamespaces = array(); |
| 32 | |
| 33 | /** @var string[] */ |
| 34 | protected array $excludeFilePatterns = array(); |
| 35 | |
| 36 | protected Filesystem $filesystem; |
| 37 | |
| 38 | protected DiscoveredFiles $discoveredFiles; |
| 39 | |
| 40 | /** |
| 41 | * Record the files autoloaders for later use in building our own autoloader. |
| 42 | * |
| 43 | * Package-name: [ dir1, file1, file2, ... ]. |
| 44 | * |
| 45 | * @var array<string, string[]> |
| 46 | */ |
| 47 | protected array $filesAutoloaders = []; |
| 48 | |
| 49 | protected FileEnumeratorConfig $config; |
| 50 | |
| 51 | /** |
| 52 | * Copier constructor. |
| 53 | */ |
| 54 | public function __construct( |
| 55 | FileEnumeratorConfig $config, |
| 56 | FileSystem $filesystem, |
| 57 | ?LoggerInterface $logger = null |
| 58 | ) { |
| 59 | $this->discoveredFiles = new DiscoveredFiles(); |
| 60 | |
| 61 | $this->vendorDir = $config->getVendorDirectory(); |
| 62 | |
| 63 | $this->config = $config; |
| 64 | |
| 65 | $this->excludeNamespaces = $config->getExcludeNamespacesFromCopy(); |
| 66 | $this->excludePackageNames = $config->getExcludePackagesFromCopy(); |
| 67 | $this->excludeFilePatterns = $config->getExcludeFilePatternsFromCopy(); |
| 68 | |
| 69 | $this->filesystem = $filesystem; |
| 70 | |
| 71 | $this->logger = $logger ?? new NullLogger(); |
| 72 | } |
| 73 | |
| 74 | /** |
| 75 | * Read the autoload keys of the dependencies and generate a list of the files referenced. |
| 76 | * |
| 77 | * Includes all files in the directories and subdirectories mentioned in the autoloaders. |
| 78 | * |
| 79 | * @param ComposerPackage[] $dependencies |
| 80 | */ |
| 81 | public function compileFileListForDependencies(array $dependencies): DiscoveredFiles |
| 82 | { |
| 83 | foreach ($dependencies as $dependency) { |
| 84 | if (in_array($dependency->getPackageName(), $this->excludePackageNames)) { |
| 85 | $this->logger->info("Excluding package " . $dependency->getPackageName()); |
| 86 | continue; |
| 87 | } |
| 88 | $this->logger->info("Scanning for files for package " . $dependency->getPackageName()); |
| 89 | |
| 90 | /** |
| 91 | * Where $dependency->autoload is ~ |
| 92 | * |
| 93 | * [ "psr-4" => [ "BrianHenryIE\Strauss" => "src" ] ] |
| 94 | * Exclude "exclude-from-classmap" |
| 95 | * @see https://getcomposer.org/doc/04-schema.md#exclude-files-from-classmaps |
| 96 | */ |
| 97 | $autoloaders = array_filter($dependency->getAutoload(), function ($type) { |
| 98 | return 'exclude-from-classmap' !== $type; |
| 99 | }, ARRAY_FILTER_USE_KEY); |
| 100 | |
| 101 | foreach ($autoloaders as $type => $value) { |
| 102 | // Might have to switch/case here. |
| 103 | |
| 104 | if ('files' === $type) { |
| 105 | // TODO: This is not in use. |
| 106 | $this->filesAutoloaders[$dependency->getRelativePath()] = $value; |
| 107 | } |
| 108 | |
| 109 | foreach ($value as $namespace => $namespace_relative_paths) { |
| 110 | if (!empty($namespace) && in_array($namespace, $this->excludeNamespaces)) { |
| 111 | $this->logger->info("Excluding namespace " . $namespace); |
| 112 | continue; |
| 113 | } |
| 114 | |
| 115 | $namespace_relative_paths = (array) $namespace_relative_paths; |
| 116 | // if (! is_array($namespace_relative_paths)) { |
| 117 | // $namespace_relative_paths = array( $namespace_relative_paths ); |
| 118 | // } |
| 119 | |
| 120 | foreach ($namespace_relative_paths as $namespaceRelativePath) { |
| 121 | $sourceAbsoluteDirPath = in_array($namespaceRelativePath, ['.','./']) |
| 122 | ? $dependency->getPackageAbsolutePath() |
| 123 | : $dependency->getPackageAbsolutePath() . $namespaceRelativePath; |
| 124 | |
| 125 | if ($this->filesystem->directoryExists($sourceAbsoluteDirPath)) { |
| 126 | $fileList = $this->filesystem->listContents($sourceAbsoluteDirPath, true); |
| 127 | $actualFileList = $fileList->toArray(); |
| 128 | |
| 129 | foreach ($actualFileList as $foundFile) { |
| 130 | $sourceAbsoluteFilepath = '/'. $foundFile->path(); |
| 131 | // No need to record the directory itself. |
| 132 | if (!$this->filesystem->fileExists($sourceAbsoluteFilepath) |
| 133 | || |
| 134 | $this->filesystem->directoryExists($sourceAbsoluteFilepath) |
| 135 | ) { |
| 136 | continue; |
| 137 | } |
| 138 | |
| 139 | $this->addFileWithDependency( |
| 140 | $dependency, |
| 141 | $sourceAbsoluteFilepath, |
| 142 | $type |
| 143 | ); |
| 144 | } |
| 145 | } else { |
| 146 | $this->addFileWithDependency($dependency, $sourceAbsoluteDirPath, $type); |
| 147 | } |
| 148 | } |
| 149 | } |
| 150 | } |
| 151 | } |
| 152 | |
| 153 | return $this->discoveredFiles; |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * @param ComposerPackage $dependency |
| 158 | * @param string $sourceAbsoluteFilepath |
| 159 | * @param string $autoloaderType |
| 160 | * |
| 161 | * @throws FilesystemException |
| 162 | * @uses \BrianHenryIE\Strauss\Files\DiscoveredFiles::add() |
| 163 | * |
| 164 | */ |
| 165 | protected function addFileWithDependency( |
| 166 | ComposerPackage $dependency, |
| 167 | string $sourceAbsoluteFilepath, |
| 168 | string $autoloaderType |
| 169 | ): void { |
| 170 | $vendorRelativePath = substr( |
| 171 | $sourceAbsoluteFilepath, |
| 172 | strpos($sourceAbsoluteFilepath, $dependency->getRelativePath() ?: 0) |
| 173 | ); |
| 174 | |
| 175 | if ($vendorRelativePath === $sourceAbsoluteFilepath) { |
| 176 | $vendorRelativePath = $dependency->getRelativePath() . str_replace($dependency->getPackageAbsolutePath(), '', $sourceAbsoluteFilepath); |
| 177 | } |
| 178 | |
| 179 | $isOutsideProjectDir = 0 !== strpos($sourceAbsoluteFilepath, $this->config->getVendorDirectory()); |
| 180 | |
| 181 | /** @var FileWithDependency $f */ |
| 182 | $f = $this->discoveredFiles->getFile($sourceAbsoluteFilepath) |
| 183 | ?? new FileWithDependency($dependency, $vendorRelativePath, $sourceAbsoluteFilepath); |
| 184 | |
| 185 | $f->setAbsoluteTargetPath($this->config->getVendorDirectory() . $vendorRelativePath); |
| 186 | |
| 187 | $f->addAutoloader($autoloaderType); |
| 188 | $f->setDoDelete($isOutsideProjectDir); |
| 189 | |
| 190 | foreach ($this->excludeFilePatterns as $excludePattern) { |
| 191 | if (1 === preg_match($excludePattern, $vendorRelativePath)) { |
| 192 | $f->setDoCopy(false); |
| 193 | } |
| 194 | } |
| 195 | |
| 196 | $this->discoveredFiles->add($f); |
| 197 | |
| 198 | $this->logger->info("Found file " . $f->getAbsoluteTargetPath()); |
| 199 | } |
| 200 | |
| 201 | /** |
| 202 | * @param string[] $paths |
| 203 | */ |
| 204 | public function compileFileListForPaths(array $paths): DiscoveredFiles |
| 205 | { |
| 206 | $absoluteFilePaths = $this->filesystem->findAllFilesAbsolutePaths($paths); |
| 207 | |
| 208 | foreach ($absoluteFilePaths as $sourceAbsolutePath) { |
| 209 | $f = $this->discoveredFiles->getFile($sourceAbsolutePath) |
| 210 | ?? new File($sourceAbsolutePath); |
| 211 | |
| 212 | $this->discoveredFiles->add($f); |
| 213 | } |
| 214 | |
| 215 | return $this->discoveredFiles; |
| 216 | } |
| 217 | } |