From c7662a3c8307122d2e5156e6ec8a6f4e07b875f7 Mon Sep 17 00:00:00 2001 From: Matt Isenhower Date: Thu, 19 Mar 2020 15:24:32 -0700 Subject: [PATCH] Make policy stubs customizable --- .../Foundation/Console/PolicyMakeCommand.php | 60 +++++++++++++------ .../Foundation/Console/StubPublishCommand.php | 2 + .../Console/stubs/policy.plain.stub | 6 +- .../Foundation/Console/stubs/policy.stub | 60 +++++++++---------- 4 files changed, 78 insertions(+), 50 deletions(-) diff --git a/src/Illuminate/Foundation/Console/PolicyMakeCommand.php b/src/Illuminate/Foundation/Console/PolicyMakeCommand.php index adc04d3c80a4..e13db3c49ac5 100644 --- a/src/Illuminate/Foundation/Console/PolicyMakeCommand.php +++ b/src/Illuminate/Foundation/Console/PolicyMakeCommand.php @@ -78,33 +78,46 @@ protected function replaceModel($stub, $model) { $model = str_replace('/', '\\', $model); - $namespaceModel = $this->laravel->getNamespace().$model; - if (Str::startsWith($model, '\\')) { - $stub = str_replace('NamespacedDummyModel', trim($model, '\\'), $stub); + $namespacedModel = trim($model, '\\'); } else { - $stub = str_replace('NamespacedDummyModel', $namespaceModel, $stub); + $namespacedModel = $this->laravel->getNamespace().$model; } - $stub = str_replace( - "use {$namespaceModel};\nuse {$namespaceModel};", "use {$namespaceModel};", $stub - ); - $model = class_basename(trim($model, '\\')); $dummyUser = class_basename($this->userProviderModel()); $dummyModel = Str::camel($model) === 'user' ? 'model' : $model; - $stub = str_replace('DocDummyModel', Str::snake($dummyModel, ' '), $stub); - - $stub = str_replace('DummyModel', $model, $stub); - - $stub = str_replace('dummyModel', Str::camel($dummyModel), $stub); + $replace = [ + 'NamespacedDummyModel' => $namespacedModel, + '{{ namespacedModel }}' => $namespacedModel, + '{{namespacedModel}}' => $namespacedModel, + 'DummyModel' => $model, + '{{ model }}' => $model, + '{{model}}' => $model, + 'dummyModel' => Str::camel($dummyModel), + '{{ modelVariable }}' => Str::camel($dummyModel), + '{{modelVariable}}' => Str::camel($dummyModel), + 'DocDummyModel' => Str::snake($dummyModel, ' '), + '{{ modelDoc }}' => Str::snake($dummyModel, ' '), + '{{modelDoc}}' => Str::snake($dummyModel, ' '), + 'DocDummyPluralModel' => Str::snake(Str::pluralStudly($dummyModel), ' '), + '{{ modelDocPlural }}' => Str::snake(Str::pluralStudly($dummyModel), ' '), + '{{modelDocPlural}}' => Str::snake(Str::pluralStudly($dummyModel), ' '), + 'DummyUser' => $dummyUser, + '{{ user }}' => $dummyUser, + '{{user}}' => $dummyUser, + ]; - $stub = str_replace('DummyUser', $dummyUser, $stub); + $stub = str_replace( + array_keys($replace), array_values($replace), $stub + ); - return str_replace('DocDummyPluralModel', Str::snake(Str::pluralStudly($dummyModel), ' '), $stub); + return str_replace( + "use {$namespacedModel};\nuse {$namespacedModel};", "use {$namespacedModel};", $stub + ); } /** @@ -115,8 +128,21 @@ protected function replaceModel($stub, $model) protected function getStub() { return $this->option('model') - ? __DIR__.'/stubs/policy.stub' - : __DIR__.'/stubs/policy.plain.stub'; + ? $this->resolveStubPath('/stubs/policy.stub') + : $this->resolveStubPath('/stubs/policy.plain.stub'); + } + + /** + * Resolve the fully-qualified path to the stub. + * + * @param string $stub + * @return string + */ + protected function resolveStubPath($stub) + { + return file_exists($customPath = $this->laravel->basePath(trim($stub, '/'))) + ? $customPath + : __DIR__.$stub; } /** diff --git a/src/Illuminate/Foundation/Console/StubPublishCommand.php b/src/Illuminate/Foundation/Console/StubPublishCommand.php index 2afc470ce5bb..e9587c88ddc4 100644 --- a/src/Illuminate/Foundation/Console/StubPublishCommand.php +++ b/src/Illuminate/Foundation/Console/StubPublishCommand.php @@ -43,6 +43,8 @@ public function handle() realpath(__DIR__.'/../../Database/Migrations/stubs/migration.create.stub') => $stubsPath.'/migration.create.stub', realpath(__DIR__.'/../../Database/Migrations/stubs/migration.stub') => $stubsPath.'/migration.stub', realpath(__DIR__.'/../../Database/Migrations/stubs/migration.update.stub') => $stubsPath.'/migration.update.stub', + realpath(__DIR__.'/../../Foundation/Console/stubs/policy.plain.stub') => $stubsPath.'/policy.plain.stub', + realpath(__DIR__.'/../../Foundation/Console/stubs/policy.stub') => $stubsPath.'/policy.stub', realpath(__DIR__.'/../../Routing/Console/stubs/controller.api.stub') => $stubsPath.'/controller.api.stub', realpath(__DIR__.'/../../Routing/Console/stubs/controller.invokable.stub') => $stubsPath.'/controller.invokable.stub', realpath(__DIR__.'/../../Routing/Console/stubs/controller.model.api.stub') => $stubsPath.'/controller.model.api.stub', diff --git a/src/Illuminate/Foundation/Console/stubs/policy.plain.stub b/src/Illuminate/Foundation/Console/stubs/policy.plain.stub index e0b9094d7610..b014d8591699 100644 --- a/src/Illuminate/Foundation/Console/stubs/policy.plain.stub +++ b/src/Illuminate/Foundation/Console/stubs/policy.plain.stub @@ -1,11 +1,11 @@