Merge pull request #6 from TheDragonCode/1.x

Added command to generate helper files for IDE

Author: andrey-helldar

.github/images/ide-helper.png

@@ -61,7 +61,7 @@ Http::get()->toData(...); // will be method not found exception
 ```
 
 > Note
-> 
+>
 > Please note that IDE hints will not work in this case.
 
 ## Usage
@@ -176,6 +176,18 @@ class SomeData
 return Http::get()->toDataCollection(SomeData::class);
 ```
 
+### Generate IDE Helper files
+
+You can generate helper files for the IDE using the console command:
+
+```Bash
+php artisan http:macros-helper
+```
+
+This will help your IDE suggest methods.
+
+![IDE Helper](.github\images\ide-helper.png)
+
 ## License
 
 This package is licensed under the [MIT License](LICENSE).

README.md

@@ -24,13 +24,15 @@
     },
     "require": {
         "php": "^8.2",
+        "dragon-code/support": "^6.13",
         "illuminate/http": "^10.0 || ^11.0",
         "illuminate/support": "^10.0 || ^11.0"
     },
     "require-dev": {
         "guzzlehttp/guzzle": "^7.8",
         "orchestra/testbench": "^8.0 || ^9.0",
         "pestphp/pest": "^2.34",
+        "pestphp/pest-plugin-laravel": "^2.4",
         "spatie/laravel-data": "^4.8"
     },
     "minimum-stability": "stable",

composer.json

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelHttpMacros\Commands;
+
+use DragonCode\LaravelHttpMacros\Macros\Macro;
+use DragonCode\Support\Facades\Filesystem\Directory;
+use DragonCode\Support\Facades\Filesystem\File;
+use Illuminate\Console\Command;
+use Illuminate\Support\Str;
+
+class GenerateHelperCommand extends Command
+{
+    protected $signature = 'http:macros-helper';
+
+    protected $description = 'Generates correct PHPDocs for Http facade macros';
+
+    public function handle(): void
+    {
+        $names = $this->names();
+
+        $static  = $this->make($names, true);
+        $dynamic = $this->make($names);
+
+        $this->cleanUp();
+        $this->store($static, true);
+        $this->store($dynamic);
+    }
+
+    protected function make(array $names, bool $isStatic = false): array
+    {
+        return array_map(
+            fn (string $name) => sprintf(
+                '     * @method %s $this %s(\Closure|string $class, int|string|null $key = null)',
+                $isStatic ? 'static' : '',
+                $name
+            ),
+            $names
+        );
+    }
+
+    protected function store(array $methods, bool $isStatic = false): void
+    {
+        File::store(
+            $this->path($this->filename($isStatic)),
+            $this->makeDocBlock($methods)
+        );
+    }
+
+    protected function makeDocBlock(array $methods): string
+    {
+        return Str::replace('{methods}', implode(PHP_EOL, $methods), $this->template());
+    }
+
+    protected function names(): array
+    {
+        return collect($this->macros())->map(
+            fn (Macro|string $macro, int|string $name) => is_string($name) ? $name : $macro::name()
+        )->all();
+    }
+
+    protected function path(?string $filename = null): string
+    {
+        return base_path('vendor/_http_macros/' . $filename);
+    }
+
+    protected function filename(bool $isStatic): string
+    {
+        return $isStatic
+            ? '_ide_helper_macro_static.php'
+            : '_ide_helper_macro.php';
+    }
+
+    protected function cleanUp(): void
+    {
+        Directory::ensureDelete($this->path());
+    }
+
+    protected function macros(): array
+    {
+        return config('http.macros.response', []);
+    }
+
+    protected function template(): string
+    {
+        return file_get_contents(__DIR__ . '/../../stubs/helper.stub');
+    }
+}

src/Commands/GenerateHelperCommand.php

@@ -4,6 +4,7 @@
 
 namespace DragonCode\LaravelHttpMacros;
 
+use DragonCode\LaravelHttpMacros\Commands\GenerateHelperCommand;
 use Illuminate\Http\Client\Response;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 
@@ -18,6 +19,16 @@ public function boot(): void
     {
         $this->publishConfig();
         $this->bootMacros();
+        $this->bootCommands();
+    }
+
+    protected function bootCommands(): void
+    {
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                GenerateHelperCommand::class,
+            ]);
+        }
     }
 
     protected function bootMacros(): void

src/ServiceProvider.php

@@ -0,0 +1,10 @@
+<?php
+
+/** @noinspection all */
+
+namespace Illuminate\Http\Client {
+    /**
+{methods}
+     */
+    class Response {}
+}

stubs/helper.stub

@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+dataset('types', [
+    ['static', '_static'],
+    ['dynamic', ''],
+]);

tests/Datasets/types.php

@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+function content(string $filename): string
+{
+    return trim(file_get_contents($filename));
+}

tests/Helpers/content.php

@@ -0,0 +1,12 @@
+<?php
+
+/** @noinspection all */
+
+namespace Illuminate\Http\Client {
+    /**
+     * @method  $this toData(\Closure|string $class, int|string|null $key = null)
+     * @method  $this toDataCollection(\Closure|string $class, int|string|null $key = null)
+     * @method  $this toFoo(\Closure|string $class, int|string|null $key = null)
+     */
+    class Response {}
+}

tests/Snapshots/dynamic

@@ -0,0 +1,12 @@
+<?php
+
+/** @noinspection all */
+
+namespace Illuminate\Http\Client {
+    /**
+     * @method static $this toData(\Closure|string $class, int|string|null $key = null)
+     * @method static $this toDataCollection(\Closure|string $class, int|string|null $key = null)
+     * @method static $this toFoo(\Closure|string $class, int|string|null $key = null)
+     */
+    class Response {}
+}