feat: added the ability to setup and scaffold the package in one command

Author: Given Ncube

.github/workflows/run-tests.yml

@@ -40,7 +40,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          composer install --no-interaction --prefer-dist
+          composer install --no-interaction --prefer-dist --quiet
           composer update --${{ matrix.stability }} --prefer-dist --no-interaction
 
       - name: Execute tests

phpstan.neon.dist

@@ -11,4 +11,14 @@ parameters:
     checkOctaneCompatibility: true
     checkModelProperties: true
     checkMissingIterableValueType: false
+    reportUnmatchedIgnoredErrors: true
 
+    ignoreErrors:
+        - "#with a nullable type declaration#"
+        - "#type mixed is not subtype of native#"
+        - "#is not allowed to extend#"
+        - "#Language construct eval#"
+        - "# with null as default value#"
+        - "#has parameter \\$closure with default value.#"
+        - "#has parameter \\$description with default value.#"
+        - "#Method Pest\\\\Support\\\\Reflection::getParameterClassName\\(\\) has a nullable return type declaration.#"

src/Commands/LaravelAuthorizerCommand.php

@@ -16,7 +16,7 @@ class LaravelAuthorizerCommand extends Command
      *
      * @var string
      */
-    public $signature = 'authorizer:generate {name? : The name of the policy to generate} {--m|model= : The model to use for the policy} {--f|force : Overwrite existing files}';
+    public $signature = 'authorizer:policies:generate {name? : The name of the policy to generate} {--m|model= : The model to use for the policy} {--f|force : Overwrite existing files}';
 
     /**
      * The console command description.
@@ -66,7 +66,7 @@ public function handle(): int
     public function generateAllPolicies(): void
     {
         $this->getModels()->each(
-            fn (string $model) => $this->generatePolicy($model, $model)
+            fn(string $model) => $this->generatePolicy($model, $model)
         );
     }
 
@@ -80,7 +80,7 @@ public function generatePlainPolicy(string $name): void
     {
         if (
             file_exists($this->getPolicyPath($name)) &&
-            ! $this->option('force')
+            !$this->option('force')
         ) {
             $this->error(sprintf('Policy "%s" already exists!', $name));
 
@@ -92,8 +92,8 @@ public function generatePlainPolicy(string $name): void
             'namespace' => $this->getNamespace(),
             'class' => $this->getClassName($name),
         ])->reduce(
-            fn ($carry, $value, $key) => Str::replace(
-                '{{ '.$key.' }}',
+            fn($carry, $value, $key) => Str::replace(
+                '{{ ' . $key . ' }}',
                 $value,
                 $carry
             )
@@ -113,7 +113,7 @@ private function generatePolicy(string $name, string $model): void
     {
         if (
             file_exists($this->getPolicyPath($name)) &&
-            ! $this->option('force')
+            !$this->option('force')
         ) {
             $this->error(sprintf('Policy "%s" already exists!', $name));
 
@@ -123,7 +123,8 @@ private function generatePolicy(string $name, string $model): void
         $compiled = collect([
             'name' => $name,
             'model' => $model,
-            'modelVariable' => strtolower($model) ===
+            'modelVariable' =>
+                strtolower($model) ===
                 strtolower(
                     Str::afterLast($this->getNamespacedUserModel(), '\\')
                 )
@@ -137,8 +138,8 @@ private function generatePolicy(string $name, string $model): void
             'namespacedUserModel' => $this->getNamespacedUserModel(),
             'user' => Str::afterLast($this->getNamespacedUserModel(), '\\'),
         ])->reduce(
-            static fn ($old, $value, $key) => Str::replace(
-                '{{ '.$key.' }}',
+            static fn($old, $value, $key) => Str::replace(
+                '{{ ' . $key . ' }}',
                 $value,
                 $old
             ),
@@ -156,7 +157,7 @@ private function generatePolicy(string $name, string $model): void
      */
     public function getPolicyPath(string $name): string
     {
-        return app_path('Policies/'.$this->getClassName($name).'.php');
+        return app_path('Policies/' . $this->getClassName($name) . '.php');
     }
 
     /**
@@ -166,7 +167,7 @@ public function getPolicyPath(string $name): string
      */
     public function getNamespace(): string
     {
-        return app()->getNamespace().'Policies';
+        return app()->getNamespace() . 'Policies';
     }
 
     /**
@@ -181,7 +182,7 @@ public function getClassName(string $name): string
             return Str::studly($name);
         }
 
-        return Str::studly($name).'Policy';
+        return Str::studly($name) . 'Policy';
     }
 
     /**
@@ -192,7 +193,7 @@ public function getClassName(string $name): string
      */
     public function getNamespacedModel(string $model): string
     {
-        return app()->getNamespace().'Models\\'.Str::studly($model);
+        return app()->getNamespace() . 'Models\\' . Str::studly($model);
     }
 
     /**
@@ -212,6 +213,6 @@ public function getNamespacedUserModel(): string
      */
     public function getStub(): string
     {
-        return __DIR__.'/stubs/policy.stub';
+        return __DIR__ . '/stubs/policy.stub';
     }
 }

src/Commands/SetupCommand.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace FlixtechsLabs\LaravelAuthorizer\Commands;
+
+use Illuminate\Console\Command;
+use Spatie\Permission\PermissionServiceProvider;
+
+class SetupCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'authorizer:setup {--p|permissions : Generate all permissions} {--P|policies : Generate all policies}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Setup the authorizer package';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle(): int
+    {
+        $this->call('vendor:publish', [
+            '--provider' => PermissionServiceProvider::class,
+        ]);
+
+        $this->call('migrate');
+
+        if ($this->option('permissions')) {
+            $this->info('Generating permissions...');
+            $this->call('authorizer:permissions:generate');
+        }
+
+        if ($this->option('policies')) {
+            $this->info('Generating policies...');
+            $this->call('authorizer:policies:generate');
+        }
+
+        $this->info('Setup complete!');
+
+        return self::SUCCESS;
+    }
+}

src/LaravelAuthorizerServiceProvider.php

@@ -4,6 +4,7 @@
 
 use FlixtechsLabs\LaravelAuthorizer\Commands\GeneratePermissionsCommand;
 use FlixtechsLabs\LaravelAuthorizer\Commands\LaravelAuthorizerCommand;
+use FlixtechsLabs\LaravelAuthorizer\Commands\SetupCommand;
 use Illuminate\Foundation\Console\AboutCommand;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
@@ -23,6 +24,7 @@ public function configurePackage(Package $package): void
             ->hasCommands([
                 LaravelAuthorizerCommand::class,
                 GeneratePermissionsCommand::class,
+                SetupCommand::class,
             ]);
     }
 
@@ -32,7 +34,7 @@ public function boot()
 
         AboutCommand::add(
             'Laravel Authorizer',
-            fn () => [
+            fn() => [
                 'version' => '0.0.1',
                 'author' => 'Flixtechs Labs',
                 'license' => 'MIT',

tests/SetupTest.php

@@ -0,0 +1,31 @@
+<?php
+
+use FlixtechsLabs\LaravelAuthorizer\Commands\SetupCommand;
+
+it('can setup the authorizer package', function () {
+    $this->artisan(SetupCommand::class)
+        ->expectsOutput('Setup complete!')
+        ->assertSuccessful();
+});
+
+it('can generate permissions on setup', function () {
+    $this->artisan('make:model', ['name' => 'User'])->assertSuccessful();
+
+    $this->artisan(SetupCommand::class, [
+        '--permissions' => true,
+    ])->assertSuccessful();
+
+    $this->assertDatabaseHas('permissions', [
+        'name' => 'create user',
+    ]);
+});
+
+it('can generate policies on setup', function () {
+    $this->artisan('make:model', ['name' => 'User'])->assertSuccessful();
+
+    $this->artisan(SetupCommand::class, [
+        '--policies' => true,
+    ])->assertSuccessful();
+
+    $this->assertFileExists(app_path('Policies/UserPolicy.php'));
+});