generated from yiisoft/package-template
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
13 changed files
with
296 additions
and
23 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 |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # _____ Change Log | ||
| # Yii RBAC Rules Container Change Log | ||
|
|
||
| ## 1.0.0 under development | ||
|
|
||
|
|
||
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,18 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| use Yiisoft\Rbac\Rules\Container\RulesContainer; | ||
| use Yiisoft\Rbac\RuleFactoryInterface; | ||
|
|
||
| /* @var array $params */ | ||
|
|
||
| return [ | ||
| RuleFactoryInterface::class => [ | ||
| 'class' => RulesContainer::class, | ||
| '__construct()' => [ | ||
| 'definitions' => $params['yiisoft/rbac-rules-container']['rules'], | ||
| 'validate' => $params['yiisoft/rbac-rules-container']['validate'], | ||
| ], | ||
| ], | ||
| ]; |
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 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| return [ | ||
| 'yiisoft/rbac-rules-container' => [ | ||
| 'rules' => [], | ||
| 'validate' => true, | ||
| ], | ||
| ]; |
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
Empty file.
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,68 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Yiisoft\Rbac\Rules\Container; | ||
|
|
||
| use Psr\Container\ContainerInterface; | ||
| use Yiisoft\Definitions\Exception\CircularReferenceException; | ||
| use Yiisoft\Definitions\Exception\InvalidConfigException; | ||
| use Yiisoft\Definitions\Exception\NotInstantiableException; | ||
| use Yiisoft\Factory\Factory; | ||
| use Yiisoft\Factory\NotFoundException; | ||
| use Yiisoft\Rbac\Exception\RuleInterfaceNotImplementedException; | ||
| use Yiisoft\Rbac\Exception\RuleNotFoundException; | ||
| use Yiisoft\Rbac\RuleInterface; | ||
| use Yiisoft\Rbac\RuleFactoryInterface; | ||
|
|
||
| use function array_key_exists; | ||
|
|
||
| final class RulesContainer implements RuleFactoryInterface | ||
| { | ||
| private Factory $factory; | ||
|
|
||
| /** | ||
| * @var RuleInterface[] | ||
| * @psalm-var array<string,RuleInterface> | ||
| */ | ||
| private array $instances = []; | ||
|
|
||
| /** | ||
| * @psalm-param array<string, mixed> $definitions | ||
| * | ||
| * @throws InvalidConfigException | ||
| */ | ||
| public function __construct(ContainerInterface $container, array $definitions, bool $validate = true) | ||
| { | ||
| $this->factory = new Factory($container, $definitions, $validate); | ||
| } | ||
|
|
||
| /** | ||
| * @param string $name | ||
| * | ||
| * @return RuleInterface | ||
| * @throws RuleInterfaceNotImplementedException | ||
| * @throws RuleNotFoundException | ||
| * @throws CircularReferenceException | ||
| * @throws InvalidConfigException | ||
| * @throws NotInstantiableException | ||
| */ | ||
| public function create(string $name): RuleInterface | ||
| { | ||
| if (!array_key_exists($name, $this->instances)) { | ||
| try { | ||
| $rule = $this->factory->create($name); | ||
| } catch (NotFoundException $e) { | ||
| throw new RuleNotFoundException($name, 0, $e); | ||
| } | ||
|
|
||
| if (!$rule instanceof RuleInterface) { | ||
| throw new RuleInterfaceNotImplementedException($name); | ||
| } | ||
|
|
||
| $this->instances[$name] = $rule; | ||
| } | ||
|
|
||
| return $this->instances[$name]; | ||
| } | ||
| } |
Empty file.
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,75 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Yiisoft\Rbac\Rules\Container\Tests; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| use Yiisoft\Definitions\Exception\InvalidConfigException; | ||
| use Yiisoft\Di\Container; | ||
| use Yiisoft\Di\ContainerConfig; | ||
| use Yiisoft\Rbac\Rules\Container\RulesContainer; | ||
| use Yiisoft\Rbac\Rules\Container\Tests\Support\AuthorRule; | ||
| use Yiisoft\Rbac\RulesFactoryInterface; | ||
|
|
||
| use function dirname; | ||
|
|
||
| final class ConfigTest extends TestCase | ||
| { | ||
| public function testBase(): void | ||
| { | ||
| $container = $this->createContainer(); | ||
|
|
||
| $rulesContainer = $container->get(RulesFactoryInterface::class); | ||
|
|
||
| $this->assertInstanceOf(RulesContainer::class, $rulesContainer); | ||
| } | ||
|
|
||
| public function testDisableValidation(): void | ||
| { | ||
| $params = $this->getParams(); | ||
| $params['yiisoft/rbac-rules-container']['rules'] = ['rule' => 42]; | ||
| $params['yiisoft/rbac-rules-container']['validate'] = false; | ||
| $container = $this->createContainer($params); | ||
|
|
||
| $rulesContainer = $container->get(RulesFactoryInterface::class); | ||
|
|
||
| $this->expectException(InvalidConfigException::class); | ||
| $rulesContainer->create('rule'); | ||
| } | ||
|
|
||
| public function testRules(): void | ||
| { | ||
| $params = $this->getParams(); | ||
| $params['yiisoft/rbac-rules-container']['rules'] = ['rule' => AuthorRule::class]; | ||
| $container = $this->createContainer($params); | ||
|
|
||
| $rulesContainer = $container->get(RulesFactoryInterface::class); | ||
| $rule = $rulesContainer->create('rule'); | ||
|
|
||
| $this->assertInstanceOf(AuthorRule::class, $rule); | ||
| } | ||
|
|
||
| private function createContainer(?array $params = null): Container | ||
| { | ||
| return new Container( | ||
| ContainerConfig::create()->withDefinitions( | ||
| $this->getCommonDefinitions($params) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| private function getCommonDefinitions(?array $params = null): array | ||
| { | ||
| if ($params === null) { | ||
| $params = $this->getParams(); | ||
| } | ||
| return require dirname(__DIR__) . '/config/common.php'; | ||
| } | ||
|
|
||
| private function getParams(): array | ||
| { | ||
| return require dirname(__DIR__) . '/config/params.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,64 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Yiisoft\Rbac\Rules\Container\Tests; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use stdClass; | ||
| use Yiisoft\Definitions\Exception\InvalidConfigException; | ||
| use Yiisoft\Rbac\Exception\RuleInterfaceNotImplementedException; | ||
| use Yiisoft\Rbac\Exception\RuleNotFoundException; | ||
| use Yiisoft\Rbac\RuleInterface; | ||
| use Yiisoft\Rbac\Rules\Container\RulesContainer; | ||
| use Yiisoft\Rbac\Rules\Container\Tests\Support\AuthorRule; | ||
| use Yiisoft\Test\Support\Container\SimpleContainer; | ||
|
|
||
| final class RulesContainerTest extends TestCase | ||
| { | ||
| public function testCreate(): void | ||
| { | ||
| $rulesContainer = new RulesContainer(new SimpleContainer(), []); | ||
|
|
||
| $rule = $rulesContainer->create(AuthorRule::class); | ||
|
|
||
| $this->assertInstanceOf(AuthorRule::class, $rule); | ||
| } | ||
|
|
||
| public function testNotFound(): void | ||
| { | ||
| $rulesContainer = new RulesContainer(new SimpleContainer(), []); | ||
|
|
||
| $this->expectException(RuleNotFoundException::class); | ||
| $this->expectExceptionMessage('Rule "not-exists-rule" not found.'); | ||
| $this->expectExceptionCode(0); | ||
| $rulesContainer->create('not-exists-rule'); | ||
| } | ||
|
|
||
| public function testNotRuleInterface(): void | ||
| { | ||
| $rulesContainer = new RulesContainer(new SimpleContainer(), ['rule' => new stdClass()]); | ||
|
|
||
| $this->expectException(RuleInterfaceNotImplementedException::class); | ||
| $this->expectExceptionMessage('Rule "rule" should implement "' . RuleInterface::class . '".'); | ||
| $this->expectExceptionCode(0); | ||
| $rulesContainer->create('rule'); | ||
| } | ||
|
|
||
| public function testValidation(): void | ||
| { | ||
| $container = new SimpleContainer(); | ||
| $definitions = ['rule' => 42]; | ||
|
|
||
| $this->expectException(InvalidConfigException::class); | ||
| new RulesContainer($container, $definitions); | ||
| } | ||
|
|
||
| public function testDisableValidation(): void | ||
| { | ||
| $rulesContainer = new RulesContainer(new SimpleContainer(), ['rule' => 42], false); | ||
|
|
||
| $this->expectException(InvalidConfigException::class); | ||
| $rulesContainer->create('rule'); | ||
| } | ||
| } |
Oops, something went wrong.