feat: added the ability to override existing policies

Author: Given Ncube

src/Commands/LaravelAuthorizerCommand.php

@@ -13,10 +13,24 @@
 
 class LaravelAuthorizerCommand extends Command
 {
-    public $signature = 'authorizer:generate {name? : The name of the policy to generate} {--m|model= : The model to use for the policy}';
-
+    /**
+     * The name and signature of the console 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}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
     public $description = 'Generate authorizations for your application';
 
+    /**
+     * Run the command.
+     * @return int
+     */
     public function handle(): int
     {
         $this->comment('Generating policies...');
@@ -45,6 +59,11 @@ public function handle(): int
         return self::SUCCESS;
     }
 
+    /**
+     * Generate policies for all models.
+     *
+     * @return void
+     */
     public function generateAllPolicies(): void
     {
         $models = collect(File::allFiles(app_path()))
@@ -70,16 +89,26 @@ public function generateAllPolicies(): void
             ->map(fn($model) => Str::afterLast($model, '\\'));
 
         $models->each(function (string $model) {
-            if (file_exists($this->getPolicyPath($model))) {
-                return;
-            }
-
             $this->generatePolicy($model, $model);
         });
     }
 
+    /**
+     * Generate a plain policy without a model.
+     *
+     * @param string $name
+     * @return void
+     */
     public function generatePlainPolicy(string $name): void
     {
+        if (
+            file_exists($this->getPolicyPath($name)) &&
+            !$this->option('force')
+        ) {
+            $this->error(sprintf('Policy "%s" already exists!', $name));
+            return;
+        }
+
         $compiled = collect([
             'namespacedUserModel' => $this->getNamespacedUserModel(),
             'namespace' => $this->getNamespace(),
@@ -95,14 +124,20 @@ public function generatePlainPolicy(string $name): void
         (new Filesystem())->dumpFile($this->getPolicyPath($name), $compiled);
     }
 
-    public function getPolicyPath(string $name): string
-    {
-        return app_path('Policies/' . $this->getClassName($name) . '.php');
-    }
-
+    /**
+     * Generate a policy for a given model.
+     *
+     * @param string $name
+     * @param string $model
+     * @return void
+     */
     private function generatePolicy(string $name, string $model): void
     {
-        if (file_exists($this->getPolicyPath($name))) {
+        if (
+            file_exists($this->getPolicyPath($name)) &&
+            !$this->option('force')
+        ) {
+            $this->error(sprintf('Policy "%s" already exists!', $name));
             return;
         }
 
@@ -135,11 +170,32 @@ private function generatePolicy(string $name, string $model): void
         (new Filesystem())->dumpFile($this->getPolicyPath($name), $compiled);
     }
 
+    /**
+     * Get the path to the policy.
+     *
+     * @return string
+     */
+    public function getPolicyPath(string $name): string
+    {
+        return app_path('Policies/' . $this->getClassName($name) . '.php');
+    }
+
+    /**
+     * Get the policies namespace.
+     *
+     * @return string
+     */
     public function getNamespace(): string
     {
         return app()->getNamespace() . 'Policies';
     }
 
+    /**
+     * Get the class name for the policy.
+     *
+     * @param string $name The name of the policy
+     * @return string
+     */
     public function getClassName(string $name): string
     {
         if (Str::endsWith(Str::lower($name), 'policy')) {
@@ -149,16 +205,32 @@ public function getClassName(string $name): string
         return Str::studly($name) . 'Policy';
     }
 
+    /**
+     * Get the namespace for the model.
+     *
+     * @param string $model The name of the model
+     * @return string
+     */
     public function getNamespacedModel(string $model): string
     {
         return app()->getNamespace() . 'Models\\' . Str::studly($model);
     }
 
+    /**
+     * Get the namespace for the User model.
+     *
+     * @return string
+     */
     public function getNamespacedUserModel(): string
     {
         return config('auth.providers.users.model');
     }
 
+    /**
+     * Get the path to the stub.
+     *
+     * @return string
+     */
     public function getStub(): string
     {
         return __DIR__ . '/stubs/policy.stub';

src/LaravelAuthorizerServiceProvider.php

@@ -2,11 +2,8 @@
 
 namespace FlixtechsLabs\LaravelAuthorizer;
 
-<<<<<<< HEAD
 use Illuminate\Foundation\Console\AboutCommand;
-=======
 use FlixtechsLabs\LaravelAuthorizer\Commands\LaravelAuthorizerCommand;
->>>>>>> 75fcbe42c60682fff2220c3af0c2a1ce820a8c88
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -31,10 +28,13 @@ public function boot()
     {
         parent::boot();
 
-        AboutCommand::add('Laravel Authorizer', fn() => [
-            'version' => '0.0.1',
-            'author' => 'Flixtechs Labs',
-            'license' => 'MIT',
-        ]);
+        AboutCommand::add(
+            'Laravel Authorizer',
+            fn() => [
+                'version' => '0.0.1',
+                'author' => 'Flixtechs Labs',
+                'license' => 'MIT',
+            ]
+        );
     }
 }

tests/LaravelAuthorizerTest.php

@@ -1,8 +1,8 @@
 <?php
 
 use FlixtechsLabs\LaravelAuthorizer\Commands\LaravelAuthorizerCommand;
-use Illuminate\Support\Facades\Artisan;
 use function PHPUnit\Framework\assertFileExists;
+use function PHPUnit\Framework\assertStringContainsString;
 
 it('can run the command successfully', function () {
     $this->artisan(LaravelAuthorizerCommand::class, [
@@ -76,3 +76,28 @@ function () {
         '--model' => 'User',
     ])->assertSuccessful();
 });
+
+it('can force create policy even if it exists', function () {
+    $this->artisan(LaravelAuthorizerCommand::class, [
+        'name' => 'User',
+        '--model' => 'User',
+    ])->assertSuccessful();
+
+    assertStringContainsString(
+        'create user',
+        file_get_contents(base_path('app/Policies/UserPolicy.php'))
+    );
+
+    $this->artisan(LaravelAuthorizerCommand::class, [
+        'name' => 'User',
+        '--model' => 'Post',
+        '--force' => true,
+    ])->assertSuccessful();
+
+    assertFileExists(app_path('Policies/UserPolicy.php'));
+
+    assertStringContainsString(
+        'create post',
+        file_get_contents(app_path('Policies/UserPolicy.php'))
+    );
+});