Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Workflow] Add EventNameTrait to compute event name strings
- Loading branch information
Showing
9 changed files
with
154 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
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,59 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Workflow\Event; | ||
|
||
use Symfony\Component\Workflow\Exception\InvalidArgumentException; | ||
|
||
/** | ||
* @author Nicolas Rigaud <squrious@protonmail.com> | ||
*/ | ||
trait EventNameTrait | ||
{ | ||
/** | ||
* Get the event name as lowercase string. | ||
* | ||
* Example: EnterEvent => enter | ||
*/ | ||
public static function getName(): string | ||
{ | ||
return strtolower(substr(substr(static::class, strrpos(static::class, '\\') + 1), 0, -5)); | ||
} | ||
|
||
/** | ||
* Get event name for workflow and transition. | ||
* | ||
* @throws InvalidArgumentException If $transitionName is provided without $workflowName | ||
*/ | ||
private static function getNameForTransition(?string $workflowName, ?string $transitionName): string | ||
{ | ||
return self::computeName($workflowName, $transitionName); | ||
} | ||
|
||
/** | ||
* Get event name for workflow and place. | ||
* | ||
* @throws InvalidArgumentException If $placeName is provided without $workflowName | ||
*/ | ||
private static function getNameForPlace(?string $workflowName, ?string $placeName): string | ||
{ | ||
return self::computeName($workflowName, $placeName); | ||
} | ||
|
||
private static function computeName(?string $workflowName, ?string $transitionOrPlaceName): string | ||
{ | ||
if (null !== $transitionOrPlaceName && null === $workflowName) { | ||
throw new \InvalidArgumentException('Missing workflow name.'); | ||
} | ||
|
||
return implode('.', array_filter(['workflow', $workflowName, self::getName(), $transitionOrPlaceName], \is_string(...))); | ||
} | ||
} |
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
73 changes: 73 additions & 0 deletions
73
src/Symfony/Component/Workflow/Tests/Event/EventNameTraitTest.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,73 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Workflow\Tests\Event; | ||
|
||
use PHPUnit\Framework\TestCase; | ||
use Symfony\Component\Workflow\Event\AnnounceEvent; | ||
use Symfony\Component\Workflow\Event\CompletedEvent; | ||
use Symfony\Component\Workflow\Event\EnteredEvent; | ||
use Symfony\Component\Workflow\Event\EnterEvent; | ||
use Symfony\Component\Workflow\Event\GuardEvent; | ||
use Symfony\Component\Workflow\Event\LeaveEvent; | ||
use Symfony\Component\Workflow\Event\TransitionEvent; | ||
|
||
class EventNameTraitTest extends TestCase | ||
{ | ||
/** | ||
* @dataProvider getEvents | ||
* | ||
* @param class-string $class | ||
*/ | ||
public function testEventNames(string $class, ?string $workflowName, ?string $transitionOrPlaceName, string $expected) | ||
{ | ||
$name = $class::get($workflowName, $transitionOrPlaceName); | ||
$this->assertEquals($expected, $name); | ||
} | ||
|
||
public static function getEvents(): iterable | ||
{ | ||
yield [AnnounceEvent::class, null, null, 'workflow.announce']; | ||
yield [AnnounceEvent::class, 'post', null, 'workflow.post.announce']; | ||
yield [AnnounceEvent::class, 'post', 'publish', 'workflow.post.announce.publish']; | ||
|
||
yield [CompletedEvent::class, null, null, 'workflow.completed']; | ||
yield [CompletedEvent::class, 'post', null, 'workflow.post.completed']; | ||
yield [CompletedEvent::class, 'post', 'publish', 'workflow.post.completed.publish']; | ||
|
||
yield [EnteredEvent::class, null, null, 'workflow.entered']; | ||
yield [EnteredEvent::class, 'post', null, 'workflow.post.entered']; | ||
yield [EnteredEvent::class, 'post', 'published', 'workflow.post.entered.published']; | ||
|
||
yield [EnterEvent::class, null, null, 'workflow.enter']; | ||
yield [EnterEvent::class, 'post', null, 'workflow.post.enter']; | ||
yield [EnterEvent::class, 'post', 'published', 'workflow.post.enter.published']; | ||
|
||
yield [GuardEvent::class, null, null, 'workflow.guard']; | ||
yield [GuardEvent::class, 'post', null, 'workflow.post.guard']; | ||
yield [GuardEvent::class, 'post', 'publish', 'workflow.post.guard.publish']; | ||
|
||
yield [LeaveEvent::class, null, null, 'workflow.leave']; | ||
yield [LeaveEvent::class, 'post', null, 'workflow.post.leave']; | ||
yield [LeaveEvent::class, 'post', 'published', 'workflow.post.leave.published']; | ||
|
||
yield [TransitionEvent::class, null, null, 'workflow.transition']; | ||
yield [TransitionEvent::class, 'post', null, 'workflow.post.transition']; | ||
yield [TransitionEvent::class, 'post', 'publish', 'workflow.post.transition.publish']; | ||
} | ||
|
||
public function testInvalidArgumentExceptionIsThrownIfWorkflowNameIsMissing() | ||
{ | ||
$this->expectException(\InvalidArgumentException::class); | ||
|
||
EnterEvent::get(null, 'place'); | ||
} | ||
} |