Version 4 Plan - Features and Enhancements Roadmap

[visto9259]

Version 4 Plan - Features and Enhancements Roadmap

This is to document the enhancements, features and other changes to bring to LmcRbacMvc in a forthcoming version 4.

Rationale

LmcRbacMvc v3 is a port of ZF-Commons/ZfcRbac v2 to Laminas. ZfcRbac v2 was developed several years ago and was based on Zend Framework v2 and v3. The port of ZfcRbac to Laminas has not brought significant improvements or new features to the package. New frameworks based on Laminas MVC, such as Laminas API Tools have, come along and the Laminas Components have also evolved. It is long overdue to give it a serious upgrade.

LmcRbacMvc has been installed more than 100K times according to Packagist which is a good indication that the package has its usefulness in web application. We are looking for users of the package to provide inputs into the development roadmap for Version 4.

Process

• Comment on this issue if you want to add an enhancement or a feature to be included in Version 4.
• Issues will be created for enhancements/features selected for inclusion in V4 and will be added to the development Backlog and will be labeled as v4
• Development toward V4 will be done on the 4.x branch.
• A GitHub project for LmcRbacMvc was created and issues to be added to the project so that progress can be managed
• Issues will be assigned to contributors

Selected Enhancements

• Remove dependency on Zfr/Rbac (Remove dependency on Zfr/Rbac #3 )
• Move Developer Tools to a separate package (Move Developer Tools to a separate library #32)
• Add type declarations where missing (Add type declarations to function parameters and return values #38)
• Drop support for PHP 7.4 and 8.0 (Drop support for PHP 7 and PHP 8.0 #39)
• Use another CI provider (Find another provider for CI #37)
• Add support for PHP 8.2 (Add support for PHP 8.2 #40)
• Refactor factories (Proposed: Move factories to the same folder as the object they create #99)
• Improve documentation (better guides, better class description) (Update documentation for V4 #49)
• Remove the Authorization Service Initializer (Remove the Authorization Service Initializer #123 )

Proposed enhancements

Won't do

• Move Doctrine Support to a separate library (Move Doctrine Support to a separate companion library #44)

[visto9259]

LmcRbacMvc shares about 80% of the code with LmcRbac.

I believe the original intent of LmcRbac was to provide RBAC and roles services without the extra MVC component to make it a lighter weight package.

I propose to have LmcRbacMvc use the LmcRbac library and only keep MVC related components in LmcRbacMvc (guards, views, redirect strategies, etc.)

Install statistics for LmcRbac show that it is not used very much (2k installs since creation).

[visto9259]

Proposed enhancement:

In v3, the strategy to use to handle the Unauthorized Exception is not registered by default and one has to add the code in a Bootstrap event to add one of the built-in strategies or specify a custom strategy.

in v4, the strategy to use should be configurable in the lmc_rbac config array with the default being no strategy.

[visto9259]

Adding #37 to the list of enhancements

[visto9259]

Adding #39 to the list of enhancements

[visto9259]

Adding #40 to the list of enhancements

[visto9259]

Adding #44 to the list of selected enhancements

[visto9259]

Adding #38 to the list of selectec enhancements

[FabianKoestring]

Are there any plans for when the new version will be released?

[visto9259]

@FabianKoestring
Probably end of August to have an alpha release with updated docs.
Still a lot of work remaining to do.