-
-
Notifications
You must be signed in to change notification settings - Fork 834
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
233 additions
and
10 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
| 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