-
-
Notifications
You must be signed in to change notification settings - Fork 834
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
feat: conditional extenders #3759
Merged
Merged
Changes from all commits
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 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,61 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of Flarum. | ||
| * | ||
| * For detailed copyright and license information, please view the | ||
| * LICENSE file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Flarum\Extend; | ||
|
|
||
| use Flarum\Extension\Extension; | ||
| use Flarum\Extension\ExtensionManager; | ||
| use Illuminate\Contracts\Container\Container; | ||
|
|
||
| class Conditional implements ExtenderInterface | ||
| { | ||
| /** | ||
| * @var array<array{condition: bool|callable, extenders: ExtenderInterface[]}> | ||
| */ | ||
| protected $conditions = []; | ||
|
|
||
| /** | ||
| * @param ExtenderInterface[] $extenders | ||
| */ | ||
| public function whenExtensionEnabled(string $extensionId, array $extenders): self | ||
| { | ||
| return $this->when(function (ExtensionManager $extensions) use ($extensionId) { | ||
| return $extensions->isEnabled($extensionId); | ||
| }, $extenders); | ||
| } | ||
|
|
||
| /** | ||
| * @param bool|callable $condition | ||
| * @param ExtenderInterface[] $extenders | ||
| */ | ||
| public function when($condition, array $extenders): self | ||
| { | ||
| $this->conditions[] = [ | ||
| 'condition' => $condition, | ||
| 'extenders' => $extenders, | ||
| ]; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function extend(Container $container, Extension $extension = null) | ||
| { | ||
| foreach ($this->conditions as $condition) { | ||
| if (is_callable($condition['condition'])) { | ||
| $condition['condition'] = $container->call($condition['condition']); | ||
| } | ||
|
|
||
| if ($condition['condition']) { | ||
| foreach ($condition['extenders'] as $extender) { | ||
| $extender->extend($container, $extension); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
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
162 changes: 162 additions & 0 deletions
162
framework/core/tests/integration/extenders/ConditionalTest.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,162 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of Flarum. | ||
| * | ||
| * For detailed copyright and license information, please view the | ||
| * LICENSE file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Flarum\Tests\integration\extenders; | ||
|
|
||
| use Exception; | ||
| use Flarum\Api\Serializer\ForumSerializer; | ||
| use Flarum\Extend; | ||
| use Flarum\Extension\ExtensionManager; | ||
| use Flarum\Testing\integration\RetrievesAuthorizedUsers; | ||
| use Flarum\Testing\integration\TestCase; | ||
|
|
||
| class ConditionalTest extends TestCase | ||
| { | ||
| use RetrievesAuthorizedUsers; | ||
|
|
||
| /** @test */ | ||
| public function conditional_works_if_condition_is_primitive_true() | ||
| { | ||
| $this->extend( | ||
| (new Extend\Conditional()) | ||
| ->when(true, [ | ||
| (new Extend\ApiSerializer(ForumSerializer::class)) | ||
| ->attributes(function () { | ||
| return [ | ||
| 'customConditionalAttribute' => true | ||
| ]; | ||
| }) | ||
| ]) | ||
| ); | ||
|
|
||
| $this->app(); | ||
|
|
||
| $response = $this->send( | ||
| $this->request('GET', '/api', [ | ||
| 'authenticatedAs' => 1, | ||
| ]) | ||
| ); | ||
|
|
||
| $payload = json_decode($response->getBody()->getContents(), true); | ||
|
|
||
| $this->assertArrayHasKey('customConditionalAttribute', $payload['data']['attributes']); | ||
| } | ||
|
|
||
| /** @test */ | ||
| public function conditional_does_not_work_if_condition_is_primitive_false() | ||
| { | ||
| $this->extend( | ||
| (new Extend\Conditional()) | ||
| ->when(false, [ | ||
| (new Extend\ApiSerializer(ForumSerializer::class)) | ||
| ->attributes(function () { | ||
| return [ | ||
| 'customConditionalAttribute' => true | ||
| ]; | ||
| }) | ||
| ]) | ||
| ); | ||
|
|
||
| $this->app(); | ||
|
|
||
| $response = $this->send( | ||
| $this->request('GET', '/api', [ | ||
| 'authenticatedAs' => 1, | ||
| ]) | ||
| ); | ||
|
|
||
| $payload = json_decode($response->getBody()->getContents(), true); | ||
|
|
||
| $this->assertArrayNotHasKey('customConditionalAttribute', $payload['data']['attributes']); | ||
| } | ||
|
|
||
| /** @test */ | ||
| public function conditional_works_if_condition_is_callable_true() | ||
| { | ||
| $this->extend( | ||
| (new Extend\Conditional()) | ||
| ->when(function () { | ||
| return true; | ||
| }, [ | ||
| (new Extend\ApiSerializer(ForumSerializer::class)) | ||
| ->attributes(function () { | ||
| return [ | ||
| 'customConditionalAttribute' => true | ||
| ]; | ||
| }) | ||
| ]) | ||
| ); | ||
|
|
||
| $this->app(); | ||
|
|
||
| $response = $this->send( | ||
| $this->request('GET', '/api', [ | ||
| 'authenticatedAs' => 1, | ||
| ]) | ||
| ); | ||
|
|
||
| $payload = json_decode($response->getBody()->getContents(), true); | ||
|
|
||
| $this->assertArrayHasKey('customConditionalAttribute', $payload['data']['attributes']); | ||
| } | ||
|
|
||
| /** @test */ | ||
| public function conditional_does_not_work_if_condition_is_callable_false() | ||
| { | ||
| $this->extend( | ||
| (new Extend\Conditional()) | ||
| ->when(function () { | ||
| return false; | ||
| }, [ | ||
| (new Extend\ApiSerializer(ForumSerializer::class)) | ||
| ->attributes(function () { | ||
| return [ | ||
| 'customConditionalAttribute' => true | ||
| ]; | ||
| }) | ||
| ]) | ||
| ); | ||
|
|
||
| $this->app(); | ||
|
|
||
| $response = $this->send( | ||
| $this->request('GET', '/api', [ | ||
| 'authenticatedAs' => 1, | ||
| ]) | ||
| ); | ||
|
|
||
| $payload = json_decode($response->getBody()->getContents(), true); | ||
|
|
||
| $this->assertArrayNotHasKey('customConditionalAttribute', $payload['data']['attributes']); | ||
| } | ||
|
|
||
| /** @test */ | ||
| public function conditional_injects_dependencies_to_condition_callable() | ||
| { | ||
| $this->expectNotToPerformAssertions(); | ||
|
|
||
| $this->extend( | ||
| (new Extend\Conditional()) | ||
| ->when(function (?ExtensionManager $extensions) { | ||
| if (! $extensions) { | ||
| throw new Exception('ExtensionManager not injected'); | ||
| } | ||
| }, [ | ||
| (new Extend\ApiSerializer(ForumSerializer::class)) | ||
| ->attributes(function () { | ||
| return [ | ||
| 'customConditionalAttribute' => true | ||
| ]; | ||
| }) | ||
| ]) | ||
| ); | ||
|
|
||
| $this->app(); | ||
| } | ||
| } |
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
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.
The signature doesn't match the PR comment example. Your example uses a callable as the second argument, not an array. The array is the return response from the callable yes. I assume your example is wrong then..
Also the phpdoc is incorrect, there are two args.
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.
yea updated the example thanks
phpdoc doesn't matter, we only add typings for what isn't typed, we can't vanilla type array as ExtenderInterface[], we've being doing this since 1.0 to avoid unnecessary duplication. And the phpdoc standard allows it.