Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3338 from mhsdesign/feature/introduceFlowPackageK…
…eyValueObject TASK: Introduce internal flow package key value object
- Loading branch information
Showing
9 changed files
with
367 additions
and
150 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Neos\Flow\Package; | ||
|
|
||
| use Neos\Flow\Annotations as Flow; | ||
| use Neos\Flow\Composer\ComposerUtility; | ||
|
|
||
| /** | ||
| * (Legacy) Flow representation of a package key. | ||
| * | ||
| * With the rise of composer each package _has_ a key like "vendor/foo-bar". | ||
| * But before the adaption Flow already established the package keys like "Vendor.Foo.Bar", | ||
| * which is represented and validated by this value object. | ||
| * | ||
| * The Flow package keys are currently inferred from the composer manifest {@see FlowPackageKey::deriveFromManifestOrPath()}, | ||
| * and can also be tried to be reverse calculated: {@see FlowPackageKey::deriveComposerPackageName()} | ||
| * | ||
| * The idea around the Flow package key is obsolete since composer and will eventually be replaced. | ||
| * Still major parts of Flow depend on the concept. | ||
| * | ||
| * @internal Only meant to be used only inside the Flow package management code. Should NOT leak into public APIs. | ||
| */ | ||
| final readonly class FlowPackageKey | ||
| { | ||
| public const PATTERN = '/^[a-z0-9]+\.(?:[a-z0-9][\.a-z0-9]*)+$/i'; | ||
|
|
||
| /** | ||
| * @Flow\Autowiring(false) | ||
| */ | ||
| private function __construct( | ||
| public string $value | ||
| ) { | ||
| if (!self::isPackageKeyValid($value)) { | ||
| throw new Exception\InvalidPackageKeyException('The package key "' . $value . '" is invalid', 1220722210); | ||
| } | ||
| } | ||
|
|
||
| public static function fromString(string $value) | ||
| { | ||
| return new self($value); | ||
| } | ||
|
|
||
| /** | ||
| * Check the conformance of the given package key | ||
| * | ||
| * @param string $string The package key to validate | ||
| * @return boolean If the package key is valid, returns true otherwise false | ||
| * @internal please use {@see PackageManager::isPackageKeyValid()} | ||
| */ | ||
| public static function isPackageKeyValid(string $string): bool | ||
| { | ||
| return preg_match(self::PATTERN, $string) === 1; | ||
| } | ||
|
|
||
| /** | ||
| * Resolves package key from Composer manifest | ||
| * | ||
| * If it is a Flow package the name of the containing directory will be used. | ||
| * | ||
| * Else if the composer name of the package matches the first part of the lowercased namespace of the package, the mixed | ||
| * case version of the composer name / namespace will be used, with backslashes replaced by dots. | ||
| * | ||
| * Else the composer name will be used with the slash replaced by a dot | ||
| */ | ||
| public static function deriveFromManifestOrPath(array $manifest, string $packagePath): self | ||
| { | ||
| $definedFlowPackageKey = $manifest['extra']['neos']['package-key'] ?? null; | ||
|
|
||
| if ($definedFlowPackageKey && self::isPackageKeyValid($definedFlowPackageKey)) { | ||
| return new self($definedFlowPackageKey); | ||
| } | ||
|
|
||
| $composerName = $manifest['name']; | ||
| $autoloadNamespace = null; | ||
| $type = $manifest['type'] ?? null; | ||
| if (isset($manifest['autoload']['psr-0']) && is_array($manifest['autoload']['psr-0'])) { | ||
| $namespaces = array_keys($manifest['autoload']['psr-0']); | ||
| $autoloadNamespace = reset($namespaces); | ||
| } | ||
| return self::derivePackageKeyInternal($composerName, $type, $packagePath, $autoloadNamespace); | ||
| } | ||
|
|
||
| /** | ||
| * Derive a flow package key from the given information. | ||
| * The order of importance is: | ||
| * | ||
| * - package install path | ||
| * - first found autoload namespace | ||
| * - composer name | ||
| */ | ||
| private static function derivePackageKeyInternal(string $composerName, ?string $packageType, string $packagePath, ?string $autoloadNamespace): self | ||
| { | ||
| $packageKey = ''; | ||
|
|
||
| if ($packageType !== null && ComposerUtility::isFlowPackageType($packageType)) { | ||
| $lastSegmentOfPackagePath = substr(trim($packagePath, '/'), strrpos(trim($packagePath, '/'), '/') + 1); | ||
| if (str_contains($lastSegmentOfPackagePath, '.')) { | ||
| $packageKey = $lastSegmentOfPackagePath; | ||
| } | ||
| } | ||
|
|
||
| if ($autoloadNamespace !== null && (self::isPackageKeyValid($packageKey) === false)) { | ||
| $packageKey = str_replace('\\', '.', $autoloadNamespace); | ||
| } | ||
|
|
||
| if (self::isPackageKeyValid($packageKey) === false) { | ||
| $packageKey = str_replace('/', '.', $composerName); | ||
| } | ||
|
|
||
| $packageKey = trim($packageKey, '.'); | ||
| $packageKey = preg_replace('/[^A-Za-z0-9.]/', '', $packageKey); | ||
|
|
||
| return new self($packageKey); | ||
| } | ||
|
|
||
| /** | ||
| * Determines the composer package name ("vendor/foo-bar") from the Flow package key ("Vendor.Foo.Bar") | ||
| * | ||
| * WARNING: This is NOT necessary the reverse calculation when the package key was inferred via {@see self::deriveFromManifestOrPath()} | ||
| * For example vendor/foo-bar will become vendor.foobar which in turn will be converted via this method to vendor/foobar | ||
| */ | ||
| public function deriveComposerPackageName(): string | ||
| { | ||
| $nameParts = explode('.', $this->value); | ||
| $vendor = array_shift($nameParts); | ||
| return strtolower($vendor . '/' . implode('-', $nameParts)); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.