-
-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(generation): add
ClassManipulator (#531)
- Loading branch information
Showing
26 changed files
with
749 additions
and
0 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
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,10 @@ | ||
| # Exclude build/test files from the release | ||
| .github/ export-ignore | ||
| tests/ export-ignore | ||
| .gitattributes export-ignore | ||
| .gitignore export-ignore | ||
| phpunit.xml export-ignore | ||
| README.md export-ignore | ||
|
|
||
| # Configure diff output for .php and .phar files. | ||
| *.php diff=php |
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,9 @@ | ||
| The MIT License (MIT) | ||
|
|
||
| Copyright (c) 2024 Brent Roose [email protected] | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
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,24 @@ | ||
| { | ||
| "name": "tempest/generation", | ||
| "description": "A component for generating PHP.", | ||
| "license": "MIT", | ||
| "minimum-stability": "dev", | ||
| "require": { | ||
| "php": "^8.3", | ||
| "nette/php-generator": "^4.1.6", | ||
| "nikic/php-parser": "^5.3" | ||
| }, | ||
| "autoload": { | ||
| "psr-4": { | ||
| "Tempest\\Generation\\": "src" | ||
| } | ||
| }, | ||
| "autoload-dev": { | ||
| "psr-4": { | ||
| "Tempest\\Generation\\Tests\\": "tests" | ||
| } | ||
| }, | ||
| "require-dev": { | ||
| "spatie/phpunit-snapshot-assertions": "^5.1.6" | ||
| } | ||
| } |
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,13 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" beStrictAboutOutputDuringTests="true" displayDetailsOnPhpunitDeprecations="true" failOnPhpunitDeprecation="false" failOnRisky="true" failOnWarning="true"> | ||
| <testsuites> | ||
| <testsuite name="Tempest Generation"> | ||
| <directory>tests</directory> | ||
| </testsuite> | ||
| </testsuites> | ||
| <source restrictNotices="true" restrictWarnings="true" ignoreIndirectDeprecations="true"> | ||
| <include> | ||
| <directory>src</directory> | ||
| </include> | ||
| </source> | ||
| </phpunit> |
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,175 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Tempest\Generation; | ||
|
|
||
| use Nette\PhpGenerator\ClassType; | ||
| use Nette\PhpGenerator\PhpFile; | ||
| use Nette\PhpGenerator\PsrPrinter; | ||
| use ReflectionClass; | ||
|
|
||
| final class ClassManipulator | ||
| { | ||
| private ClassType $classType; | ||
|
|
||
| private PhpFile $file; | ||
|
|
||
| private string $namespace; | ||
|
|
||
| private bool $simplifyImplements = false; | ||
|
|
||
| private array $aliases = []; | ||
|
|
||
| public function __construct(string|ReflectionClass $className) | ||
| { | ||
| $reflection = is_string($className) | ||
| ? new ReflectionClass($className) | ||
| : $className; | ||
|
|
||
| $this->file = new PhpFile(); | ||
| $this->classType = ClassType::from($reflection->getName(), withBodies: true); // @phpstan-ignore-line | ||
| $this->namespace = $reflection->getNamespaceName(); | ||
| } | ||
|
|
||
| public function removeClassAttribute(string $attributeName): self | ||
| { | ||
| $attributes = $this->classType->getAttributes(); | ||
|
|
||
| foreach ($attributes as $key => $attribute) { | ||
| if ($attribute->getName() === $attributeName) { | ||
| unset($attributes[$key]); | ||
| } | ||
| } | ||
|
|
||
| $this->classType->setAttributes($attributes); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function setFinal(bool $final = true): self | ||
| { | ||
| $this->classType->setFinal($final); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function setReadOnly(bool $readonly = true): self | ||
| { | ||
| $this->classType->setReadOnly($readonly); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function setStrictTypes(bool $strictTypes = true): self | ||
| { | ||
| $this->file->setStrictTypes($strictTypes); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function updateNamespace(string $namespace): self | ||
| { | ||
| $this->namespace = $namespace; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function print(): string | ||
| { | ||
| $printer = new PsrPrinter(); | ||
|
|
||
| $file = clone $this->file; | ||
| $namespace = $file->addNamespace($this->namespace); | ||
| $namespace->add($this->classType); | ||
|
|
||
| $this->simplifyClassNames($file); | ||
|
|
||
| return $printer->printFile($file); | ||
| } | ||
|
|
||
| public function simplifyImplements(): self | ||
| { | ||
| $this->simplifyImplements = true; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function setAlias(string $class, string $alias): self | ||
| { | ||
| if (isset($this->aliases[$class])) { | ||
| unset($this->aliases[$class]); | ||
| } | ||
|
|
||
| $this->aliases[$class] = $alias; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| private function simplifyClassNames(PhpFile $file): PhpFile | ||
| { | ||
| foreach ($file->getNamespaces() as $namespace) { | ||
| foreach ($namespace->getClasses() as $class) { | ||
| $types = []; | ||
|
|
||
| if ($this->simplifyImplements) { | ||
| foreach ($class->getImplements() as $implement) { | ||
| $types[] = $implement; | ||
| } | ||
| } | ||
|
|
||
| foreach ($class->getAttributes() as $attribute) { | ||
| $types[] = $attribute->getName(); | ||
| } | ||
|
|
||
| foreach ($class->getMethods() as $method) { | ||
| $types[] = $method->getReturnType(true); | ||
|
|
||
| array_map(function ($param) use (&$types): void { | ||
| $types[] = $param->getType(true); | ||
| }, $method->getParameters()); | ||
|
|
||
| $methodBody = $method->getBody(); | ||
| $fqcnMatches = $this->extractFqcnFromBody($methodBody); | ||
|
|
||
| foreach (array_filter($fqcnMatches) as $fqcn) { | ||
| $namespace->addUse($fqcn); | ||
| } | ||
| } | ||
|
|
||
| array_map(function ($param) use (&$types): void { | ||
| $types[] = $param->getType(true); | ||
| }, $class->getProperties()); | ||
|
|
||
| foreach ($this->aliases as $class => $alias) { | ||
| $namespace->addUse($class, $alias); | ||
| } | ||
|
|
||
| foreach (array_filter($types) as $type) { | ||
| if (is_string($type)) { | ||
| $namespace->addUse($type); | ||
|
|
||
| continue; | ||
| } | ||
|
|
||
| foreach ($type->getTypes() as $subtype) { | ||
| if ($subtype->isClass() && ! $subtype->isClassKeyword()) { | ||
| $namespace->addUse((string) $subtype); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return $file; | ||
| } | ||
|
|
||
| private function extractFqcnFromBody(string $body): array | ||
| { | ||
| preg_match_all('/(?:\\\\?[A-Za-z_][\w\d_]*\\\\)+[A-Za-z_][\w\d_]*/', $body, $matches); | ||
|
|
||
| return array_filter(array_unique( | ||
| array_map(fn (string $fqcn) => rtrim(ltrim($fqcn, '\\'), ':'), $matches[0]) | ||
| )); | ||
| } | ||
| } |
Oops, something went wrong.