Merge pull request #50 from visto9259/2.x

Refactored factories

composer.json

@@ -35,7 +35,7 @@
     }
   ],
   "require": {
-    "php": "^7.3 || ^8.0 || ^8.1 || ^8.2 || ^8.3",
+    "php": "^8.1 || ^8.2 || ^8.3",
     "laminas/laminas-servicemanager": "^3.3",
     "laminas/laminas-stdlib": "^3.1",
     "doctrine/persistence": "^2.0 || ^3.0"

src/Assertion/AssertionContainerFactory.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+declare(strict_types=1);
+
+namespace LmcRbac\Assertion;
+
+use LmcRbac\Assertion\AssertionContainer;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Factory to create a assertion plugin manager
+ *
+ * @author  Aeneas Rekkas
+ * @licence MIT
+ */
+final class AssertionContainerFactory
+{
+    public function __invoke(ContainerInterface $container): AssertionContainer
+    {
+        $config = $container->get('config')['lmc_rbac']['assertion_manager'];
+
+        return new AssertionContainer($container, $config);
+    }
+}

src/ConfigProvider.php

@@ -40,12 +40,12 @@ public function getDependencyConfig(): array
     {
         return [
             'factories' => [
-                \LmcRbac\Assertion\AssertionContainerInterface::class => \LmcRbac\Container\AssertionContainerFactory::class,
-                \LmcRbac\Options\ModuleOptions::class => \LmcRbac\Container\ModuleOptionsFactory::class,
-                \LmcRbac\Role\InMemoryRoleProvider::class => \LmcRbac\Container\InMemoryRoleProviderFactory::class,
-                \LmcRbac\Role\ObjectRepositoryRoleProvider::class => \LmcRbac\Container\ObjectRepositoryRoleProviderFactory::class,
-                \LmcRbac\Service\AuthorizationServiceInterface::class => \LmcRbac\Container\AuthorizationServiceFactory::class,
-                \LmcRbac\Service\RoleServiceInterface::class => \LmcRbac\Container\RoleServiceFactory::class,
+                \LmcRbac\Assertion\AssertionContainerInterface::class => \LmcRbac\Assertion\AssertionContainerFactory::class,
+                \LmcRbac\Options\ModuleOptions::class => \LmcRbac\Options\ModuleOptionsFactory::class,
+                \LmcRbac\Role\InMemoryRoleProvider::class => \LmcRbac\Role\InMemoryRoleProviderFactory::class,
+                \LmcRbac\Role\ObjectRepositoryRoleProvider::class => \LmcRbac\Role\ObjectRepositoryRoleProviderFactory::class,
+                \LmcRbac\Service\AuthorizationServiceInterface::class => \LmcRbac\Service\AuthorizationServiceFactory::class,
+                \LmcRbac\Service\RoleServiceInterface::class => \LmcRbac\Service\RoleServiceFactory::class,
                 \LmcRbac\Rbac::class => \Laminas\ServiceManager\Factory\InvokableFactory::class,
             ],
         ];

src/Container/AssertionContainerFactory.php

@@ -29,6 +29,7 @@
  *
  * @author  Aeneas Rekkas
  * @licence MIT
+ * @deprecated Replaced by LmcRbac\Assertion\AssertionContainerFactory
  */
 final class AssertionContainerFactory
 {

src/Container/AuthorizationServiceFactory.php

@@ -33,6 +33,7 @@
  *
  * @author  Michaël Gallego <[email protected]>
  * @licence MIT
+ * @deprecated Replaced by LmcRbac\Service\AuthorizationServiceFactory
  */
 final class AuthorizationServiceFactory
 {

src/Container/InMemoryRoleProviderFactory.php

@@ -30,6 +30,7 @@
  *
  * @author  Vytautas Stankus
  * @licence MIT
+ * @deprecated Replaced by LmcRbac\Role\InMemoryRoleProviderFactory
  */
 final class InMemoryRoleProviderFactory
 {

src/Container/ModuleOptionsFactory.php

@@ -29,6 +29,7 @@
  *
  * @author  Michaël Gallego <[email protected]>
  * @licence MIT
+ * @deprecated Replaced by LmcRbac\Options\ModuleOptionsFactory
  */
 final class ModuleOptionsFactory
 {

src/Container/ObjectRepositoryRoleProviderFactory.php

@@ -31,6 +31,7 @@
  *
  * @author  Michaël Gallego <[email protected]>
  * @licence MIT
+ * @deprecated Replaced by LmcRbac\Role\ObjectRepositoryRoleProviderFactory
  */
 final class ObjectRepositoryRoleProviderFactory
 {

src/Container/RoleServiceFactory.php

@@ -31,6 +31,7 @@
  *
  * @author  Michaël Gallego <[email protected]>
  * @licence MIT
+ * @deprecated Replaced by LmcRbac\Service\RoleServiceFactory
  */
 final class RoleServiceFactory
 {

src/Options/ModuleOptions.php

@@ -29,29 +29,29 @@
  * @author  Michaël Gallego <[email protected]>
  * @licence MIT
  */
-final class ModuleOptions extends AbstractOptions
+class ModuleOptions extends AbstractOptions
 {
     /**
      * Guest role (used when no identity is found)
      *
      * @var string
      */
-    protected $guestRole = 'guest';
+    protected string $guestRole = 'guest';
 
     /**
      * Assertion map
      *
      * @var array
      */
-    protected $assertionMap = [];
+    protected array $assertionMap = [];
 
     /**
      * A configuration for role provider
      * Defaults to InMemoryRoleProvider
      *
      * @var array
      */
-    protected $roleProvider = [
+    protected array $roleProvider = [
         'LmcRbac\Role\InMemoryRoleProvider' => [],
     ];
 

src/Options/ModuleOptionsFactory.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+declare(strict_types=1);
+
+namespace LmcRbac\Options;
+
+use LmcRbac\Options\ModuleOptions;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Factory for the module options
+ *
+ * @author  Michaël Gallego <[email protected]>
+ * @licence MIT
+ */
+final class ModuleOptionsFactory
+{
+    public function __invoke(ContainerInterface $container): ModuleOptions
+    {
+        return new ModuleOptions($container->get('config')['lmc_rbac']);
+    }
+}

src/Role/InMemoryRoleProviderFactory.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+declare(strict_types=1);
+
+namespace LmcRbac\Role;
+
+use LmcRbac\Options\ModuleOptions;
+use LmcRbac\Role\InMemoryRoleProvider;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Factory used to create an in memory role provider
+ *
+ * @author  Vytautas Stankus
+ * @licence MIT
+ */
+final class InMemoryRoleProviderFactory
+{
+    public function __invoke(ContainerInterface $container): InMemoryRoleProvider
+    {
+        $moduleOptions = $container->get(ModuleOptions::class);
+
+        return new InMemoryRoleProvider(
+            $moduleOptions->getRoleProvider()[InMemoryRoleProvider::class] ?? []
+        );
+    }
+}

src/Role/ObjectRepositoryRoleProviderFactory.php

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+declare(strict_types=1);
+
+namespace LmcRbac\Role;
+
+use LmcRbac\Exception;
+use LmcRbac\Options\ModuleOptions;
+use LmcRbac\Role\ObjectRepositoryRoleProvider;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Factory used to create an object repository role provider
+ *
+ * @author  Michaël Gallego <[email protected]>
+ * @licence MIT
+ */
+final class ObjectRepositoryRoleProviderFactory
+{
+    public function __invoke(ContainerInterface $container): ObjectRepositoryRoleProvider
+    {
+        $moduleOptions = $container->get(ModuleOptions::class);
+        $options = $moduleOptions->getRoleProvider()[ObjectRepositoryRoleProvider::class] ?? [];
+
+        if (! isset($options['role_name_property'])) {
+            throw new Exception\RuntimeException('The "role_name_property" option is missing');
+        }
+
+        if (isset($options['object_repository'])) {
+            $objectRepository = $container->get($options['object_repository']);
+
+            return new ObjectRepositoryRoleProvider($objectRepository, $options['role_name_property']);
+        }
+
+        if (isset($options['object_manager'], $options['class_name'])) {
+            $objectManager = $container->get($options['object_manager']);
+            $objectRepository = $objectManager->getRepository($options['class_name']);
+
+            return new ObjectRepositoryRoleProvider($objectRepository, $options['role_name_property']);
+        }
+
+        throw new Exception\RuntimeException(
+            'No object repository was found while creating the LmcRbac object repository role provider. Are
+             you sure you specified either the "object_repository" option or "object_manager"/"class_name" options?'
+        );
+    }
+}

src/Service/AuthorizationServiceFactory.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+declare(strict_types=1);
+
+namespace LmcRbac\Service;
+
+use LmcRbac\Assertion\AssertionContainerInterface;
+use LmcRbac\Options\ModuleOptions;
+use LmcRbac\Rbac;
+use LmcRbac\Service\AuthorizationService;
+use LmcRbac\Service\RoleServiceInterface;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Factory to create the authorization service
+ *
+ * @author  Michaël Gallego <[email protected]>
+ * @licence MIT
+ */
+final class AuthorizationServiceFactory
+{
+    public function __invoke(ContainerInterface $container): AuthorizationService
+    {
+        $moduleOptions = $container->get(ModuleOptions::class);
+
+        return new AuthorizationService(
+            $container->get(Rbac::class),
+            $container->get(RoleServiceInterface::class),
+            $container->get(AssertionContainerInterface::class),
+            $moduleOptions->getAssertionMap()
+        );
+    }
+}