-
Notifications
You must be signed in to change notification settings - Fork 152
[TASK] Add trait for getArrayRepresentation to populate class
#1451
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.
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
Merged
+69
−0
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,31 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Sabberworm\CSS; | ||
|
|
||
| /** | ||
| * Provides a reusable implementation of `getArrayRepresentation()` which will populate the `class` element with the | ||
| * short name of the actual class. | ||
| * It is expected that this will be `use`d by (possibly-abstract) base classes, with extended classes calling on to the | ||
| * parent implementation then further populating the array. | ||
| * If a base class using this trait needs to further populate the array, the trait method can be `use`d `as`. | ||
| * | ||
| * @internal | ||
| * | ||
| * @phpstan-require-implements Renderable | ||
| */ | ||
| trait ArrayRepresentationClassProvider | ||
| { | ||
| /** | ||
| * @return array<string, bool|int|float|string|list<array<string, mixed>>> | ||
| * | ||
| * @internal | ||
| */ | ||
| public function getArrayRepresentation(): array | ||
| { | ||
| $reflect = new \ReflectionClass($this); | ||
|
|
||
| return ['class' => $reflect->getShortName()]; | ||
|
oliverklee marked this conversation as resolved.
Outdated
|
||
| } | ||
| } | ||
This file contains hidden or 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,27 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Sabberworm\CSS\Tests\Unit; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Sabberworm\CSS\Tests\Unit\Fixtures\ConcreteArrayRepresentationClassProvider; | ||
|
|
||
| /** | ||
| * @covers \Sabberworm\CSS\ArrayRepresentationClassProvider | ||
| */ | ||
| final class ArrayRepresentationClassProviderTest extends TestCase | ||
| { | ||
| /** | ||
| * @test | ||
| */ | ||
| public function getArrayRepresentationIncludesClassName(): void | ||
| { | ||
| $subject = new ConcreteArrayRepresentationClassProvider(); | ||
|
|
||
| $result = $subject->getArrayRepresentation(); | ||
|
|
||
| self::assertArrayHasKey('class', $result); | ||
| self::assertSame('ConcreteArrayRepresentationClassProvider', $result['class']); | ||
| } | ||
| } |
22 changes: 22 additions & 0 deletions
22
tests/Unit/Fixtures/ConcreteArrayRepresentationClassProvider.php
This file contains hidden or 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,22 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Sabberworm\CSS\Tests\Unit\Fixtures; | ||
|
|
||
| use Sabberworm\CSS\ArrayRepresentationClassProvider; | ||
| use Sabberworm\CSS\OutputFormat; | ||
| use Sabberworm\CSS\Renderable; | ||
|
|
||
| final class ConcreteArrayRepresentationClassProvider implements Renderable | ||
| { | ||
| use ArrayRepresentationClassProvider; | ||
|
|
||
| /** | ||
| * @return never | ||
| */ | ||
| public function render(OutputFormat $outputFormat): string | ||
| { | ||
| throw new \BadMethodCallException('Nothing to see here :/', 1767308395); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd strongly prefer the trait to not have an implementation of
getArrayRepresentationas this can lead to classes with an incomplete implementation if they implement the trait. (Also, I'd like to avoidparent::calls.)Instead, I suggest having a private method
getShortClassName(): non-empty-stringin the trait. Then we can also build the array from scratch ingetArrayRepresentationin the implementing classes, allowing for more concise code.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed as suggested. Also renamed the trait accordingly.
In cases where a subclass includes additional properties and the parent also has some properties, it would be more concise not to duplicate filling in the parent's properties in the subclass's implementation.