Merge branch '6.x' into 7.x

orchestral · Sep 1, 2023 · 4ee85a2 · 4ee85a2
2 parents 2bd23b0 + 66420a8
commit 4ee85a2
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 27 deletions.
diff --git a/pint.json b/pint.json
@@ -6,7 +6,7 @@
             "scope": "namespaced",
             "strict": true
         },
-        "no_superfluous_phpdoc_tags": false,
+        "no_superfluous_phpdoc_tags": true,
         "php_unit_method_casing": false,
         "nullable_type_declaration_for_default_null_value": {
             "use_nullable_type_declaration": true

diff --git a/src/CodeGenerator.php b/src/CodeGenerator.php
@@ -14,7 +14,6 @@ trait CodeGenerator
     /**
      * Set Preset for generator.
      *
-     * @param  \Orchestra\Canvas\Core\Presets\Preset  $preset
      * @return $this
      */
     public function setPreset(Presets\Preset $preset)

diff --git a/src/Commands/Generator.php b/src/Commands/Generator.php
@@ -91,9 +91,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
     }
 
     /**
-     * Code successfully generated.
-     *
-     * @return string
+     * Handle generating code.
      */
     public function generatingCode(string $stub, string $className): string
     {

diff --git a/src/CommandsProvider.php b/src/CommandsProvider.php
@@ -8,8 +8,6 @@ trait CommandsProvider
 {
     /**
      * Setup preset for laravel.
-     *
-     * @return \Orchestra\Canvas\Core\Presets\Preset
      */
     protected function presetForLaravel(Container $app): Presets\Preset
     {

diff --git a/src/Contracts/GeneratesCodeListener.php b/src/Contracts/GeneratesCodeListener.php
@@ -12,9 +12,7 @@ interface GeneratesCodeListener
     public function codeAlreadyExists(string $className);
 
     /**
-     * Code successfully generated.
-     *
-     * @return string
+     * Handle generating code.
      */
     public function generatingCode(string $stub, string $className): string;
 

diff --git a/src/GeneratesCode.php b/src/GeneratesCode.php
@@ -129,8 +129,16 @@ protected function makeDirectory(string $path): string
      */
     protected function buildClass(string $name): string
     {
-        $stub = $this->files->get($this->getListenerStubFile());
+        return $this->generatingCode(
+            $this->files->get($this->getListenerStubFile()), $name
+        );
+    }
 
+    /**
+     * Handle generating code.
+     */
+    protected function generatingCode(string $stub, string $name): string
+    {
         return $this->listener->generatingCode(
             $this->replaceClass(
                 $this->replaceNamespace($stub, $name), $name

diff --git a/src/GeneratesCodeWithComponent.php b/src/GeneratesCodeWithComponent.php
@@ -11,11 +11,11 @@
 class GeneratesCodeWithComponent extends GeneratesCode
 {
     /**
-     * Replace the namespace for the given stub.
+     * Handle generating code.
      */
-    protected function replaceNamespace(string $stub, string $name): string
+    protected function generatingCode(string $stub, string $name): string
     {
-        $stub = parent::replaceNamespace($stub, $name);
+        $stub = parent::generatingCode($stub, $name);
 
         if (! empty($this->options['inline'])) {
             $stub = str_replace(

diff --git a/src/GeneratesCodeWithEloquent.php b/src/GeneratesCodeWithEloquent.php
@@ -11,11 +11,11 @@
 class GeneratesCodeWithEloquent extends GeneratesCode
 {
     /**
-     * Replace the namespace for the given stub.
+     * Handle generating code.
      */
-    protected function replaceNamespace(string $stub, string $name): string
+    protected function generatingCode(string $stub, string $name): string
     {
-        $stub = parent::replaceNamespace($stub, $name);
+        $stub = parent::generatingCode($stub, $name);
 
         $model = $this->options['model'];
 

diff --git a/src/GeneratesCodeWithMarkdown.php b/src/GeneratesCodeWithMarkdown.php
@@ -5,11 +5,11 @@
 class GeneratesCodeWithMarkdown extends GeneratesCode
 {
     /**
-     * Replace the namespace for the given stub.
+     * Handle generating code.
      */
-    protected function replaceNamespace(string $stub, string $name): string
+    protected function generatingCode(string $stub, string $name): string
     {
-        $stub = parent::replaceNamespace($stub, $name);
+        $stub = parent::generatingCode($stub, $name);
 
         if (! empty($this->options['view'])) {
             $stub = str_replace(['DummyView', '{{ view }}', '{{view}}'], $this->options['view'], $stub);

diff --git a/src/GeneratesCommandCode.php b/src/GeneratesCommandCode.php
@@ -8,13 +8,11 @@
 class GeneratesCommandCode extends GeneratesCode
 {
     /**
-     * Replace the class name for the given stub.
-     *
-     * @todo need to be updated
+     * Handle generating code.
      */
-    protected function replaceClass(string $stub, string $name): string
+    protected function generatingCode(string $stub, string $name): string
     {
-        $stub = parent::replaceClass($stub, $name);
+        $stub = parent::generatingCode($stub, $name);
 
         return str_replace(['dummy:command', '{{ command }}', '{{command}}'], $this->options['command'], $stub);
     }

diff --git a/src/Presets/Laravel.php b/src/Presets/Laravel.php
@@ -18,7 +18,6 @@ class Laravel extends Preset
      * Add global command.
      *
      * @param  array<int, class-string<\Symfony\Component\Console\Command\Command>>  $generators
-     * @return void
      */
     public static function commands(array $generators): void
     {

diff --git a/src/Presets/Package.php b/src/Presets/Package.php
@@ -19,7 +19,6 @@ class Package extends Preset
      * Add global command.
      *
      * @param  array<int, class-string<\Symfony\Component\Console\Command\Command>>  $generators
-     * @return void
      */
     public static function commands(array $generators): void
     {