Update dependencies and permissions handling

Author: cyrillkalita

.php-cs-fixer.cache

@@ -1 +1 @@
-{"php":"8.2.7","version":"3.17.0","indent":"    ","lineEnding":"\n","rules":{"blank_line_after_opening_tag":true,"blank_line_between_import_groups":true,"class_definition":{"inline_constructor_arguments":false,"space_before_parenthesis":true},"compact_nullable_typehint":true,"curly_braces_position":{"allow_single_line_empty_anonymous_classes":true},"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"imports_order":["class","function","const"],"sort_algorithm":"none"},"return_type_declaration":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_import_per_statement":{"group_to_single_imports":false},"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"visibility_required":true,"blank_line_after_namespace":true,"constant_case":true,"control_structure_braces":true,"control_structure_continuation_position":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline"},"no_break_comment":true,"no_closing_tag":true,"no_multiple_statements_per_line":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_line_after_imports":true,"statement_indentation":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true},"hashes":{"workbench\/app\/Providers\/WorkbenchServiceProvider.php":"51d888d64251f27b21dc742900176529","src\/DefinedRole.php":"71113d4060a95d06d7d64406097189e2","src\/Actions\/StorePermission.php":"1ce86933a2586d1c914b4fb6033716d4","src\/RbacServiceProvider.php":"fe648a7d67e0abbe70c8bf62fc122ace","src\/Jobs\/ResetPermissions.php":"6d15e072f7995a2ae3918c9e61d239e9","src\/Jobs\/SyncDefinedRoles.php":"63e45566b000750caae57d0262e5dee7","src\/Jobs\/SyncDefinedRole.php":"a35d82845347a1a624d264b2cff0e7c7","src\/Jobs\/FlushPermissionCache.php":"7debb2c7438ca54691e0c80b411f4711","src\/Facades\/Rbac.php":"c6ae49d401c95f3548a578691c90fc49","src\/Commands\/AbilityMakeCommand.php":"e1cd4b78716621528c55f689ac418c34","src\/Commands\/DefinedRoleMakeCommand.php":"c905c1025929d3c7bab6ccec97612272","src\/Commands\/RbacResetCommand.php":"141dd7b73edaeb5c026d9080b8579533","src\/Contracts\/DefinedRole.php":"3affb28117a8d09dc1eca809aea53191","src\/Rbac.php":"0f1731d315fc0a3abe02917314e6c6d3","config\/rbac.php":"b1dbefb35ffd6e9e87461925f16d3fad","tests\/TestCase.php":"df7d551f35d646b7026bd85ae13d2793"}}
+{"php":"8.2.7","version":"3.17.0","indent":"    ","lineEnding":"\n","rules":{"blank_line_after_opening_tag":true,"blank_line_between_import_groups":true,"class_definition":{"inline_constructor_arguments":false,"space_before_parenthesis":true},"compact_nullable_typehint":true,"curly_braces_position":{"allow_single_line_empty_anonymous_classes":true},"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"imports_order":["class","function","const"],"sort_algorithm":"none"},"return_type_declaration":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_import_per_statement":{"group_to_single_imports":false},"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"visibility_required":true,"blank_line_after_namespace":true,"constant_case":true,"control_structure_braces":true,"control_structure_continuation_position":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline"},"no_break_comment":true,"no_closing_tag":true,"no_multiple_statements_per_line":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_line_after_imports":true,"statement_indentation":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true},"hashes":{"workbench\/app\/Providers\/WorkbenchServiceProvider.php":"51d888d64251f27b21dc742900176529","src\/DefinedRole.php":"bc1398a6e80ed7f6d6499187021641b8","src\/Actions\/StorePermission.php":"46bdc50406bc2a5d8c5aa01155ed184b","src\/RbacServiceProvider.php":"fe648a7d67e0abbe70c8bf62fc122ace","src\/Jobs\/ResetPermissions.php":"5806994862d76870ddb7ce2cb7490f58","src\/Jobs\/SyncDefinedRoles.php":"63e45566b000750caae57d0262e5dee7","src\/Jobs\/SyncDefinedRole.php":"a35d82845347a1a624d264b2cff0e7c7","src\/Jobs\/FlushPermissionCache.php":"7debb2c7438ca54691e0c80b411f4711","src\/Facades\/Rbac.php":"c6ae49d401c95f3548a578691c90fc49","src\/Commands\/AbilityMakeCommand.php":"e1cd4b78716621528c55f689ac418c34","src\/Commands\/DefinedRoleMakeCommand.php":"c905c1025929d3c7bab6ccec97612272","src\/Commands\/RbacResetCommand.php":"141dd7b73edaeb5c026d9080b8579533","src\/Contracts\/DefinedRole.php":"3affb28117a8d09dc1eca809aea53191","src\/Rbac.php":"0f1731d315fc0a3abe02917314e6c6d3","config\/rbac.php":"b1dbefb35ffd6e9e87461925f16d3fad","tests\/TestCase.php":"df7d551f35d646b7026bd85ae13d2793","src\/Actions\/SyncDefinedRole.php":"b2dc3a548bfadc39128adaf40fe60a52"}}

composer.json

@@ -20,14 +20,15 @@
         "php": "^8.2",
         "illuminate/contracts": "^11.0",
         "lorisleiva/laravel-actions": "^2.8",
-        "spatie/laravel-collection-macros": "*",
+        "spatie/laravel-collection-macros": "^7.0",
         "spatie/laravel-package-tools": "^1.16",
         "spatie/laravel-permission": "^6.4"
     },
     "require-dev": {
         "laravel/pint": "^1.14",
         "nunomaduro/collision": "^8.1",
-        "orchestra/testbench": "^9.0"
+        "orchestra/testbench": "^9.0",
+        "spatie/phpunit-snapshot-assertions": "^5.1"
     },
     "autoload": {
         "psr-4": {
@@ -37,34 +38,11 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "BinaryCats\\Rbac\\Tests\\": "tests/",
-            "Workbench\\App\\": "workbench/app/"
+            "BinaryCats\\Rbac\\Tests\\": "tests/"
         }
     },
-    "scripts": {
-        "post-autoload-dump": "@composer run prepare",
-        "clear": "@php vendor/bin/testbench package:purge-rbac --ansi",
-        "prepare": "@php vendor/bin/testbench package:discover --ansi",
-        "build": [
-            "@composer run prepare",
-            "@php vendor/bin/testbench workbench:build --ansi"
-        ],
-        "start": [
-            "Composer\\Config::disableProcessTimeout",
-            "@composer run build",
-            "@php vendor/bin/testbench serve"
-        ],
-        "analyse": "vendor/bin/phpstan analyse",
-        "test": "vendor/bin/pest",
-        "test-coverage": "vendor/bin/pest --coverage",
-        "format": "vendor/bin/pint"
-    },
     "config": {
-        "sort-packages": true,
-        "allow-plugins": {
-            "pestphp/pest-plugin": true,
-            "phpstan/extension-installer": true
-        }
+        "sort-packages": true
     },
     "extra": {
         "laravel": {

phpunit.xml.dist

@@ -35,4 +35,8 @@
             <directory suffix=".php">./src</directory>
         </include>
     </source>
+    <php>
+        <env name="CACHE_STORE" value="array"/>
+        <env name="SESSION_DRIVER" value="array"/>
+    </php>
 </phpunit>

src/Actions/StorePermission.php

@@ -2,38 +2,22 @@
 
 namespace BinaryCats\Rbac\Actions;
 
+use BackedEnum;
+use Illuminate\Support\Facades\Artisan;
 use Lorisleiva\Actions\Action;
-use Spatie\Permission\Contracts\Permission;
 
 class StorePermission extends Action
 {
     /**
-     * @param \Spatie\Permission\Contracts\Permission $permission
+     * @param \BackedEnum $permission
+     * @param string $guard
+     * @return void
      */
-    public function __construct(
-        protected Permission $permission
-    ) {
-    }
-
-    /**
-     * @return array[]
-     */
-    public function rules(): array
-    {
-        return [
-            'name' => ['required', 'string', 'min:2', 'max:125'],
-            'guard_name' => ['required', 'string', 'min:2', 'max:125'],
-        ];
-    }
-
-    /**
-     * @param array $attributes
-     * @return \Spatie\Permission\Contracts\Permission
-     */
-    public function handle(array $attributes): Permission
+    public function handle(BackedEnum $permission, string $guard): void
     {
-        $this->fill($attributes);
-
-        return $this->permission->firstOrCreate($this->validateAttributes());
+        Artisan::call('permission:create-permission', [
+            'name' => $permission->value,
+            'guard' => $guard,
+        ]);
     }
 }

src/Actions/SyncDefinedRole.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace BinaryCats\Rbac\Actions;
+
+use BackedEnum;
+use Illuminate\Support\Facades\Artisan;
+use Lorisleiva\Actions\Action;
+
+class SyncDefinedRole extends Action
+{
+    /**
+     * @return void
+     */
+    public function handle(string $name, string $guard, array $permissions): void
+    {
+        $permissions = collect($permissions)
+            ->map(fn ($permission) => match (true) {
+                $permission instanceof BackedEnum => $permission->value,
+                default => (string) $permission
+            })->implode('|');
+
+        Artisan::call('permission:create-role', [
+            'name' => $name,
+            'guard' => $guard,
+            'permissions' => $permissions,
+        ]);
+    }
+}

src/Commands/AbilityMakeCommand.php

@@ -26,7 +26,7 @@ class AbilityMakeCommand extends GeneratorCommand
      */
     protected function getStub()
     {
-        return __DIR__ . '/stubs/ability.stub';
+        return __DIR__ . '/../../stubs/ability.stub';
     }
 
     /**

src/Commands/DefinedRoleMakeCommand.php

@@ -26,7 +26,7 @@ class DefinedRoleMakeCommand extends GeneratorCommand
      */
     protected function getStub()
     {
-        return __DIR__ . '/stubs/defined-role.stub';
+        return __DIR__ . '/../../stubs/defined-role.stub';
     }
 
     /**

src/DefinedRole.php

@@ -2,6 +2,7 @@
 
 namespace BinaryCats\Rbac;
 
+use BinaryCats\Rbac\Actions\SyncDefinedRole;
 use BinaryCats\Rbac\Contracts\DefinedRole as DefinedRoleContract;
 use Illuminate\Support\Str;
 use ReflectionClass;
@@ -37,4 +38,12 @@ public function handle(): void
             SyncDefinedRole::run($this->name(), $guard, $this->{$guard}());
         }
     }
+
+    /**
+     * @return array|string[]
+     */
+    protected function guards(): array
+    {
+        return $this->guards;
+    }
 }

src/DiscoverAbilities.php

@@ -2,6 +2,7 @@
 
 namespace BinaryCats\Rbac;
 
+use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use ReflectionClass;
 use ReflectionException;
@@ -22,15 +23,13 @@ class DiscoverAbilities
      *
      * @param string $abilitiesPath
      * @param string $basePath
-     * @return \Illuminate\Support\Collection
+     * @return \Illuminate\Support\Collection<\BackedEnum>
      */
-    public static function within(string $abilitiesPath, string $basePath)
+    public static function within(string $abilitiesPath, string $basePath): Collection
     {
-        $abilities = collect(static::getAbilities(
+        return collect(static::getAbilities(
             Finder::create()->files()->in($abilitiesPath), $basePath
         ));
-
-        return $abilities;
     }
 
     protected static function getAbilities($abilities, $basePath)
@@ -43,7 +42,8 @@ protected static function getAbilities($abilities, $basePath)
                 $ability = new ReflectionClass(
                     static::classFromFile($ability, $basePath)
                 );
-            } catch (ReflectionException) {
+            } catch (ReflectionException $e) {
+                dd($e);
                 continue;
             }
 

src/Facades/Rbac.php

@@ -2,14 +2,14 @@
 
 namespace BinaryCats\Rbac\Jobs;
 
+use BinaryCats\Rbac\Actions\StorePermission;
 use BinaryCats\Rbac\DiscoverAbilities;
 use BackedEnum;
 use Illuminate\Bus\Queueable;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 use Illuminate\Support\Collection;
-use Illuminate\Support\Facades\Artisan;
 
 class ResetPermissions
 {
@@ -36,10 +36,7 @@ public function __construct(string $guard = null)
     public function handle(): void
     {
         $this->permissions()
-            ->each(fn (BackedEnum $ability) => Artisan::call('permission:create-permission', [
-                'name' => $ability->value,
-                'guard' => $this->guard,
-            ]));
+            ->each(fn (BackedEnum $ability) => StorePermission::run($ability, $this->guard));
     }
 
     /**

src/Jobs/ResetPermissions.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace BinaryCats\Rbac\Tests\Actions;
+
+use BinaryCats\Rbac\Actions\StorePermission;
+use BinaryCats\Rbac\Tests\Fixtures\Abilities\FooAbility;
+use BinaryCats\Rbac\Tests\TestCase;
+use Illuminate\Support\Facades\Artisan;
+use PHPUnit\Framework\Attributes\Test;
+
+class StorePermissionTest extends TestCase
+{
+    #[Test]
+    public function it_will_handle_creating_permission(): void
+    {
+        Artisan::expects('call')
+            ->once()
+            ->with(
+                'permission:create-permission', [
+                'name' => 'una',
+                'guard' => 'web',
+            ]);
+
+        StorePermission::run(FooAbility::One, 'web');
+    }
+}

src/Jobs/SyncDefinedRole.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace BinaryCats\Rbac\Tests\Actions;
+
+use BinaryCats\Rbac\Actions\SyncDefinedRole;
+use BinaryCats\Rbac\Tests\Fixtures\Abilities\FooAbility;
+use BinaryCats\Rbac\Tests\TestCase;
+use Illuminate\Support\Facades\Artisan;
+use PHPUnit\Framework\Attributes\Test;
+
+class SyncDefinedRoleTest extends TestCase
+{
+    #[Test]
+    public function it_will_defer_syncing_defined_role_to_artisan(): void
+    {
+        Artisan::expects('call')
+            ->once()
+            ->with(
+                'permission:create-role', [
+                'name' => 'foo role',
+                'guard' => 'web',
+                'permissions' => 'bar|una'
+            ]);
+
+        SyncDefinedRole::run('foo role', 'web', [
+            'bar',
+            FooAbility::One
+        ]);
+    }
+}