Minimum PHP 8.2 refactoring

Author: rotexdegba

.github/workflows/php.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
         matrix:
-            php: [8.4, 8.3, 8.2, 8.1]
+            php: [8.5, 8.4, 8.3, 8.2]
 # prefer-lowest is causing unit tests to fail when php 7.2 is run against PHPunit 7.x, 
 # PHPUnit 8.x is the latest stable release that supports PHP 7.2 and that runs fine
 #            dependency-version: [prefer-lowest, prefer-stable]
@@ -39,7 +39,7 @@ jobs:
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2

README.md

@@ -30,6 +30,7 @@ A simple, highly flexible and customizable access control package for PHP applic
 These are the branches in this repository:
 
 - **master:** contains code for the latest major version of this package.
+- **5.x:** contains code for the **5.x** version of this package. No new features, only bug fixes.
 - **4.x:** contains code for the **4.x** version of this package. No new features, only bug fixes.
 - **1.X:** contains code for the **1.X** version of this package. Abandoned.
 

composer.json

@@ -19,13 +19,13 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require": {
-        "php": ">=8.1.0"
+        "php": ">=8.2.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^10.0",
-        "php-coveralls/php-coveralls": "^2.0",
-        "vimeo/psalm": "^5.4 || ^6.0.0",
-        "rector/rector": "^1.0.0"
+        "rector/rector": "^2.0",
+        "vimeo/psalm" : "^6.0.0",
+        "phpunit/phpunit": "^12.0 || ^11.0",
+        "php-coveralls/php-coveralls": "^2.0"
     },
     "autoload": {
         "classmap": ["src/"]
@@ -35,8 +35,8 @@
         "files": [ ]
     },
     "scripts": {
-        "test": "vendor/bin/phpunit --coverage-text",
-        "rector": "vendor/bin/rector process src --dry-run -vvv",
+        "test": "vendor/bin/phpunit --coverage-text --display-all-issues",
+        "rector": "vendor/bin/rector process src --dry-run",
         "psalm": "vendor/bin/psalm --clear-cache && vendor/bin/psalm",
         "qa": "composer test && composer rector && composer psalm"
     }

rector.php

@@ -25,14 +25,17 @@
     $rectorConfigurator->import(SetList::PHP_74);
     $rectorConfigurator->import(SetList::PHP_80);
     $rectorConfigurator->import(SetList::PHP_81);
+    $rectorConfigurator->import(SetList::PHP_82);
     $rectorConfigurator->import(SetList::DEAD_CODE);
+    //$rectorConfigurator->import(SetList::CODE_QUALITY); // causing too much logic refactoring that may break existing functionality
     $rectorConfigurator->import(SetList::TYPE_DECLARATION);
 
     $skipables = [
         //\Rector\CodeQuality\Rector\If_\ShortenElseIfRector::class,
         //\Rector\CodingStyle\Rector\Catch_\CatchExceptionNameMatchingTypeRector::class,
         //\Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector::class,
         \Rector\DeadCode\Rector\PropertyProperty\RemoveNullPropertyInitializationRector::class,
+        \Rector\DeadCode\Rector\Concat\RemoveConcatAutocastRector::class,
     ];
 
     $rectorConfigurator->skip($skipables);

src/GenericBaseCollection.php

@@ -23,6 +23,7 @@ abstract class GenericBaseCollection implements CollectionInterface {
      * 
      * @link https://php.net/manual/en/iteratoraggregate.getiterator.php
      */
+    #[\Override]
     public function getIterator(): Traversable {
 
         return new ArrayIterator($this->storage);
@@ -35,6 +36,7 @@ public function getIterator(): Traversable {
      *
      * @return mixed the removed item
      */
+    #[\Override]
     public function removeByKey($key) {
 
         $item = null;
@@ -55,6 +57,7 @@ public function removeByKey($key) {
      *
      * @psalm-suppress RedundantConditionGivenDocblockType
      */
+    #[\Override]
     public function keyExists($key): bool {
 
         return (is_int($key) || is_string($key)) && array_key_exists($key, $this->storage);
@@ -67,6 +70,7 @@ public function keyExists($key): bool {
      * 
      * @return int The custom count as an integer.
      */
+    #[\Override]
     public function count(): int {
 
         return count($this->storage);

src/GenericPermission.php

@@ -11,6 +11,9 @@
 use function str_replace;
 use function var_export;
 
+/**
+ * @psalm-suppress ClassMustBeFinal
+ */
 class GenericPermission implements PermissionInterface {
 
     protected string $action = '';
@@ -38,7 +41,7 @@ class GenericPermission implements PermissionInterface {
      *                                            You must add default values for each parameter the callback accepts.
      * @param mixed ...$argsForCallback zero or more arguments to be used to invoke $additionalAssertions
      */
-    public function __construct(string $action, string $resource,  protected bool $allowActionOnResource = true, callable $additionalAssertions = null, mixed ...$argsForCallback) {
+    public function __construct(string $action, string $resource,  protected bool $allowActionOnResource = true, ?callable $additionalAssertions = null, mixed ...$argsForCallback) {
 
         $this->action = Utils::strToLower($action);
         $this->resource = Utils::strToLower($resource);
@@ -53,6 +56,7 @@ public function __construct(string $action, string $resource,  protected bool $a
      * 
      * @return PermissionsCollectionInterface a new and empty collection that is meant to house one or more instances of PermissionInterface
      */
+    #[\Override]
     public static function createCollection(PermissionInterface ...$permissions): PermissionsCollectionInterface {
 
         return new GenericPermissionsCollection(...$permissions);
@@ -65,6 +69,7 @@ public static function createCollection(PermissionInterface ...$permissions): Pe
      *
      * @return string a string representing an action that can be performed on a resource in the system
      */
+    #[\Override]
     public function getAction(): string {
 
         return $this->action;
@@ -80,6 +85,7 @@ public function getAction(): string {
      *
      * @return string a string value that represents all actions that can be performed on all resources in the system.
      */
+    #[\Override]
     public static function getAllActionsIdentifier(): string {
 
         return '*';
@@ -92,6 +98,7 @@ public static function getAllActionsIdentifier(): string {
      *
      * @return string a string representing a resource in the system
      */
+    #[\Override]
     public function getResource(): string {
 
         return $this->resource;
@@ -107,6 +114,7 @@ public function getResource(): string {
      *
      * @return string a string value that represents all resources in the system.
      */
+    #[\Override]
     public static function getAllResourcesIdentifier(): string {
 
         return '*';
@@ -119,6 +127,7 @@ public static function getAllResourcesIdentifier(): string {
      *
      * @return bool a boolean value indicating whether or not an instance of this class signifies that an action can be performed on a resource.
      */
+    #[\Override]
     public function getAllowActionOnResource(): bool {
 
         return $this->allowActionOnResource;
@@ -131,6 +140,7 @@ public function getAllowActionOnResource(): bool {
      * 
      * @return $this
      */
+    #[\Override]
     public function setAllowActionOnResource(bool $allowActionOnResource): PermissionInterface {
 
         $this->allowActionOnResource = $allowActionOnResource;
@@ -155,7 +165,8 @@ public function setAllowActionOnResource(bool $allowActionOnResource): Permissio
      * 
      * @return bool return true if an instance of this class signifies that a specified action can be performed on a specified resource, or false otherwise
      */
-    public function isAllowed(string $action, string $resource, callable $additionalAssertions = null, mixed ...$argsForCallback): bool {
+    #[\Override]
+    public function isAllowed(string $action, string $resource, ?callable $additionalAssertions = null, mixed ...$argsForCallback): bool {
 
         if( $additionalAssertions === null && $this->additionalAssertions !== null ) {
 
@@ -197,6 +208,7 @@ public function isAllowed(string $action, string $resource, callable $additional
      *
      *
      */
+    #[\Override]
     public function isEqualTo(PermissionInterface $permission): bool {
 
         return Utils::strSameIgnoreCase($this->getAction(), $permission->getAction())

src/GenericPermissionableEntitiesCollection.php

@@ -11,6 +11,7 @@
 
 /**
  * @property PermissionableEntityInterface[] $storage
+ * @psalm-suppress ClassMustBeFinal
  */
 class GenericPermissionableEntitiesCollection extends GenericBaseCollection implements PermissionableEntitiesCollectionInterface {
 
@@ -34,6 +35,7 @@ public function __construct(PermissionableEntityInterface ...$permissionEntities
      *
      * @return bool true if there is another entity `$x` in the current instance where $x->isEqualTo($entity) === true, otherwise return false
      */
+    #[\Override]
     public function has(PermissionableEntityInterface $entity): bool {
 
         /** @var PermissionableEntityInterface $other_entity **/
@@ -52,6 +54,7 @@ public function has(PermissionableEntityInterface $entity): bool {
      * 
      * @return $this
      */
+    #[\Override]
     public function add(PermissionableEntityInterface $permissionEntity): PermissionableEntitiesCollectionInterface {
 
         if( !$this->has($permissionEntity) ) {
@@ -74,6 +77,7 @@ public function add(PermissionableEntityInterface $permissionEntity): Permission
      *
      * @return string|int|null
      */
+    #[\Override]
     public function getKey(PermissionableEntityInterface $entity) {
 
         /** @var PermissionableEntityInterface $other_entity **/
@@ -92,6 +96,7 @@ public function getKey(PermissionableEntityInterface $entity) {
      * 
      * @return $this
      */
+    #[\Override]
     public function remove(PermissionableEntityInterface $permissionEntity): PermissionableEntitiesCollectionInterface {
 
         $key = $this->getKey($permissionEntity);
@@ -109,6 +114,7 @@ public function remove(PermissionableEntityInterface $permissionEntity): Permiss
      * 
      * @return $this
      */
+    #[\Override]
     public function removeAll(): PermissionableEntitiesCollectionInterface {
 
         $this->storage = [];
@@ -124,6 +130,7 @@ public function removeAll(): PermissionableEntitiesCollectionInterface {
      * 
      * @return $this
      */
+    #[\Override]
     public function put(PermissionableEntityInterface $permissionEntity, string $key): PermissionableEntitiesCollectionInterface {
 
         $this->storage[$key] = $permissionEntity;
@@ -135,6 +142,7 @@ public function put(PermissionableEntityInterface $permissionEntity, string $key
      * Retrieves the entity in the collection associated with the specified key.
      * If the key is not present in the collection, NULL should be returned
      */
+    #[\Override]
     public function get(string $key): ?PermissionableEntityInterface {
 
         return array_key_exists($key, $this->storage) ? $this->storage[$key] : null;
@@ -159,7 +167,8 @@ public function get(string $key): ?PermissionableEntityInterface {
      * 
      * @return $this
      */
-    public function sort(callable $comparator = null): PermissionableEntitiesCollectionInterface {
+    #[\Override]
+    public function sort(?callable $comparator = null): PermissionableEntitiesCollectionInterface {
 
         if( $comparator === null ) {
 
@@ -199,6 +208,7 @@ public function sort(callable $comparator = null): PermissionableEntitiesCollect
      * 
      * @return PermissionableEntityInterface|null an entity that matches the specified $entityId or NULL if such an entity was not found in the collection
      */
+    #[\Override]
     public function find(string $entityId): ?PermissionableEntityInterface {
 
         /** @var PermissionableEntityInterface $entity */