FQCN bugfix when writing external eloquent builder methods inside models. (#1113)

* Fix code that was causing the test to break and fix bug with not built in types

* Run cs fixer

* Remove fetching the doc block type and the putting it as a type hint as a php doc block is sufficient

* Revert doc block type hinting

* Enchance doc block type hinting

* Combine replacements

* Use the full builder class instead of the parsed one after the getClassName function and remove in array check

* Get the builder from the model itself instead of passing a string directly the function

* Use the full builder class to get the builder methods and reflection, but use the parsed builder class after setting its method in the doc

* Add test for fqn support on external eloquent builder

* Use the external builder if necessary when building the magic wheres

* Use the default eloquent builder if the user has disabled the external builder option

Author: KaloyanYosifov

src/Console/ModelsCommand.php

@@ -490,9 +490,13 @@ protected function getPropertiesFromTable($model)
                 !$column->getNotnull()
             );
             if ($this->write_model_magic_where) {
+                $builderClass = $this->write_model_external_builder_methods
+                    ? get_class($model->newModelQuery())
+                    : '\Illuminate\Database\Eloquent\Builder';
+
                 $this->setMethod(
                     Str::camel('where_' . $name),
-                    $this->getClassNameInDestinationFile($model, \Illuminate\Database\Eloquent\Builder::class)
+                    $this->getClassNameInDestinationFile($model, $builderClass)
                     . '|'
                     . $this->getClassNameInDestinationFile($model, get_class($model)),
                     ['$value']
@@ -562,7 +566,7 @@ protected function getPropertiesFromMethods($model)
                     );
 
                     if ($this->write_model_external_builder_methods) {
-                        $this->writeModelExternalBuilderMethods($builder, $model);
+                        $this->writeModelExternalBuilderMethods($model);
                     }
                 } elseif (
                     !method_exists('Illuminate\Database\Eloquent\Model', $method)
@@ -1149,26 +1153,31 @@ protected function getUsedClassNames(ReflectionClass $reflection): array
         return $namespaceAliases;
     }
 
-    protected function writeModelExternalBuilderMethods(string $builder, Model $model): void
+    protected function writeModelExternalBuilderMethods(Model $model): void
     {
-        if (in_array($builder, ['\Illuminate\Database\Eloquent\Builder', 'EloquentBuilder'])) {
-            return;
-        }
-
-        $newBuilderMethods = get_class_methods($builder);
+        $fullBuilderClass = '\\' . get_class($model->newModelQuery());
+        $newBuilderMethods = get_class_methods($fullBuilderClass);
         $originalBuilderMethods = get_class_methods('\Illuminate\Database\Eloquent\Builder');
 
         // diff the methods between the new builder and original one
         // and create helpers for the ones that are new
         $newMethodsFromNewBuilder = array_diff($newBuilderMethods, $originalBuilderMethods);
 
+        if (!$newMethodsFromNewBuilder) {
+            return;
+        }
+
+        // after we have retrieved the builder's methods
+        // get the class of the builder based on the FQCN option
+        $builderClassBasedOnFQCNOption = $this->getClassNameInDestinationFile($model, get_class($model->newModelQuery()));
+
         foreach ($newMethodsFromNewBuilder as $builderMethod) {
-            $reflection = new \ReflectionMethod($builder, $builderMethod);
+            $reflection = new \ReflectionMethod($fullBuilderClass, $builderMethod);
             $args = $this->getParameters($reflection);
 
             $this->setMethod(
                 $builderMethod,
-                $builder . '|' . $this->getClassNameInDestinationFile($model, get_class($model)),
+                $builderClassBasedOnFQCNOption . '|' . $this->getClassNameInDestinationFile($model, get_class($model)),
                 $args
             );
         }

tests/Console/ModelsCommand/GeneratePhpdocWithExternalEloquentBuilder/__snapshots__/Test__test__1.php

@@ -0,0 +1,109 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithExternalEloquentBuilderWithFqn\Builders;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Illuminate\Database\Eloquent\Builder;
+
+class PostExternalQueryBuilder extends Builder
+{
+    public function isActive(): self
+    {
+        return $this;
+    }
+
+    public function isStatus(string $status): self
+    {
+        return $this;
+    }
+
+    public function isLoadingWith(?string $with): self
+    {
+        return $this;
+    }
+
+    /**
+     * @param int|null $number
+     * @return $this
+     */
+    public function withTheNumber($number): self
+    {
+        return $this;
+    }
+
+    /**
+     * @param integer|null $number
+     * @return $this
+     */
+    public function withTheNumberDifferently($number): self
+    {
+        return $this;
+    }
+
+    /**
+     * @param bool|null $number
+     * @return $this
+     */
+    public function withBool($booleanVar): self
+    {
+        return $this;
+    }
+
+    /**
+     * @param bool|null $number
+     * @return $this
+     */
+    public function withBoolDifferently($booleanVar): self
+    {
+        return $this;
+    }
+
+    public function withBoolTypeHinted(bool $booleanVar): self
+    {
+        return $this;
+    }
+
+    /**
+     * @param int|string $someone
+     * @return $this
+     */
+    public function withSomeone($someone): self
+    {
+        return $this;
+    }
+
+    /**
+     * @param mixed $option
+     * @return $this
+     */
+    public function withMixedOption($option): self
+    {
+        return $this;
+    }
+
+    public function withTestCommand(ModelsCommand $testCommand): self
+    {
+        return $this;
+    }
+
+    public function withNullTestCommand(?ModelsCommand $testCommand): self
+    {
+        return $this;
+    }
+
+    public function withNullAndAssignmentTestCommand(?ModelsCommand $testCommand = null): self
+    {
+        return $this;
+    }
+
+    /**
+     * @param ModelsCommand $testCommand
+     * @return $this
+     */
+    public function withNullTestCommandInDocBlock($testCommand): self
+    {
+        return $this;
+    }
+}

tests/Console/ModelsCommand/GeneratePhpdocWithExternalEloquentBuilderWithFqn/Builders/PostExternalQueryBuilder.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithExternalEloquentBuilderWithFqn\Models;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithExternalEloquentBuilderWithFqn\Builders\PostExternalQueryBuilder;
+use Illuminate\Database\Eloquent\Model;
+
+class Post extends Model
+{
+    public function newEloquentBuilder($query): PostExternalQueryBuilder
+    {
+        return new PostExternalQueryBuilder($query);
+    }
+}

tests/Console/ModelsCommand/GeneratePhpdocWithExternalEloquentBuilderWithFqn/Models/Post.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithExternalEloquentBuilderWithFqn;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+
+class Test extends AbstractModelsCommand
+{
+    public function test(): void
+    {
+        $command = $this->app->make(ModelsCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--write' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertMatchesMockedSnapshot();
+    }
+}