Update to 4.0.x

.github/workflows/build_test.yml

@@ -11,11 +11,11 @@ jobs:
   build:
     strategy:
       matrix:
-        php_version: ['8.1', '8.2']
+        php_version: ['8.1', '8.2', '8.3']
         deps: ['--prefer-lowest --prefer-dist', '']
         include:
           - code-coverage: 'yes'
-            php_version: '8.2'
+            php_version: '8.3'
             deps: ''
     runs-on: ubuntu-latest
 

UPGRADE.md

@@ -1,5 +1,65 @@
 # Upgrade guide
 
+## From LmcRbacMvc v3 to LmcRbacMvc v4
+
+LmcRbacMvc v4 is a major upgrade with many breaking changes that prevent
+straightforward upgrading.
+
+LmcRbacMvc v3 and LmcRbac v1 shared a lot of code. LmcRbacMvc v2 is now based
+on LmcRbac v2 which was augmented such that common code is now part of LmcRbac.
+This has rendered many components of LmcRbacMvc unnecessary and they are deprecated
+
+### Namespace change
+
+In an effort to In an effort to normalize LM-Commons components into a common Lmc namespace, the namespace will 
+be refactored to Lmc\Rbac\Mvc.
+
+Please update your code to replace `LmcRbacMvc` by `Lmc\Rbac\Mvc`.
+
+### Deprecations
+
+The following components that were shared with LmcRbac are deprecated in LmcRbacMvc and should be replaced by their 
+LmcRbac equivalent:
+
+- Lmc\Rbac\Mvc\Exception\ExceptionInterface
+- Lmc\Rbac\Mvc\Exception\InvalidArgumentException
+- Lmc\Rbac\Mvc\Exception\RoleNotFoundException
+- Lmc\Rbac\Mvc\Exception\RuntimeException
+- Lmc\Rbac\Mvc\Permission\PermissionInterface
+- Lmc\Rbac\Mvc\Identity\IdentityInterface
+- Lmc\Rbac\Mvc\Role\RoleProviderInterface
+
+### Refactored and removed classes
+
+#### Factories
+- The factory classes were refactored from the `LmcRbacMvc\Factory` namespace to be colocated with
+the service that the factory is creating. All the factories that were in `LmcRbacMvc\Factory` namespace have been
+deleted.
+
+#### Role providers
+The former LmcRbacMvc v3 role providers are no longer available and replaced by LmcRbac equivalent. LmcRbac will throw
+an exception if your config file still refers to them. In addition, the role provider plugin manager
+was removed as it was not necessary.
+- LmcRbacMvc\Role\RoleProviderPluginManager *no longer used*
+- LmcRbacMvc\Role\InMemoryRoleProvider *replaced by a LmcRbac equivalent*
+- LmcRbacMvc\Role\ObjectRepositoryRoleProvider *replaced by a LmcRbac equivalent*
+
+#### Assertion
+- LMcRbacMvc\Assertion\AssertionPluginManagerFactory *no longer used*
+- LMcRbacMvc\Assertion\AssertionPluginManager *no longer used*
+
+### Assertions refactoring
+LmcRbacMvc is now using LmcRbac assertions and assertion plugin manager instead of its own.
+
+Therefore all previous assertions in LmcRbacMvc v3 must now implement the `\Lmc\Rbac\Assertion\AssertionInterface` 
+otherwise LmcRbac will throw an exception.
+
+`\Lmc\Rbac\Assertion\AssertionInterface` is a more generic interface for asserting permissions. An assertion under this 
+interface will be passed the permission, identity and context whereas in LmcRbacMvc v3, the assertion is
+passed the AuthorizationService from which one had to get the identity. Having the permission as a parameter allows to 
+reuse the same assertion to handle multiple permissions.
+
+
 ## From zfc-rbac v2.x to LmcRbacMvc v3.0
 
 - [BC] The namespace has been changed to `LmcRbacMvc`

composer.json

@@ -33,33 +33,22 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require": {
-        "php": "^8.1.0 | ^8.2.0",
+        "php": "~8.1.0 || ~8.2.0 || ~8.3.0",
         "laminas/laminas-config": "^3.1",
         "laminas/laminas-eventmanager": "^3.0",
         "laminas/laminas-mvc": "^3.0",
         "laminas/laminas-servicemanager": "^3.0",
-        "laminas/laminas-permissions-rbac": "^3.0",
-        "doctrine/persistence": "^2.1",
-        "lm-commons/lmc-rbac": "2.x-dev"
+        "lm-commons/lmc-rbac": "2.0.x-dev"
     },
     "require-dev": {
         "laminas/laminas-authentication": "^2.2",
         "laminas/laminas-developer-tools": "^2.1",
-        "laminas/laminas-log": "^2.2",
-        "laminas/laminas-http": "^2.2",
-        "laminas/laminas-i18n": "^2.7",
-        "laminas/laminas-serializer": "^2.2",
-        "laminas/laminas-view": "^2.12",
         "phpunit/phpunit": "10.5.11",
         "squizlabs/php_codesniffer": "^3.5.5",
-        "php-coveralls/php-coveralls": "^2.2",
-        "phpspec/prophecy-phpunit": "^2.0",
-        "doctrine/doctrine-orm-module": "^5.3",
-        "ext-mbstring": "*"
+        "phpspec/prophecy-phpunit": "^2.0"
     },
     "suggest": {
-        "laminas/laminas-developer-tools": "if you want to show information about the roles",
-        "doctrine/doctrine-module": "if you want to use Doctrine role provider"
+        "laminas/laminas-developer-tools": "if you want to show information about the roles"
     },
     "autoload": {
         "psr-4": {
@@ -79,8 +68,14 @@
     "scripts": {
         "test": "phpunit",
         "test-coverage": "phpunit --coverage-clover ./build/logs/clover.xml --exclude-group Functional",
-        "upload-coverage": "php-coveralls -v",
         "cs-check": "phpcs -n --standard=PSR2 ./src/",
-        "cs-fix": "phpcbf ./src/"
-    }
+        "cs-fix": "phpcbf ./src/",
+        "test-coverage-html": "phpunit --coverage-html ./build/html"
+    },
+    "repositories": [
+        {
+            "type": "github",
+            "url": "https://github.com/visto9259/LmcRbac.git"
+        }
+    ]
 }

config/lmc_rbac.global.php.dist

@@ -22,20 +22,6 @@
 
 return [
     'lmc_rbac' => [
-        /**
-         * Key that is used to fetch the identity provider
-         *
-         * Please note that when an identity is found, it MUST implements the LmcRbacMvc\Identity\IdentityProviderInterface
-         * interface, otherwise it will throw an exception.
-         */
-        // 'identity_provider' => 'LmcRbacMvc\Identity\AuthenticationIdentityProvider',
-
-        /**
-         * Set the guest role
-         *
-         * This role is used by the authorization service when the authentication service returns no identity
-         */
-        // 'guest_role' => 'guest',
 
         /**
          * Set the guards
@@ -62,31 +48,14 @@ return [
          */
         // 'protection_policy' => \LmcRbacMvc\Guard\GuardInterface::POLICY_ALLOW,
 
-        /**
-         * Configuration for role provider
-         *
-         * It must be an array that contains configuration for the role provider. The provider config
-         * must follow the following format:
-         *
-         *      'LmcRbacMvc\Role\InMemoryRoleProvider' => [
-         *          'role1' => [
-         *              'children'    => ['children1', 'children2'], // OPTIONAL
-         *              'permissions' => ['edit', 'read'] // OPTIONAL
-         *          ]
-         *      ]
-         *
-         * Supported options depend of the role provider, so please refer to the official documentation
-         */
-        'role_provider' => [],
-
         /**
          * Configure the unauthorized strategy. It is used to render a template whenever a user is unauthorized
          */
         'unauthorized_strategy' => [
             /**
              * Set the template name to render
              */
-            // 'template' => 'error/403'
+            // 'template' => 'lmcrbacmvc/error/403'
         ],
 
         /**
@@ -127,6 +96,5 @@ return [
          * plugin manager config format, and can be used to create your custom objects
          */
         // 'guard_manager'               => [],
-        // 'role_provider_manager'       => []
     ]
 ];