Add improved stubs

Author: Neol3108

README.md

@@ -1,4 +1,24 @@
 # Laravel stubs
 
-Improved Laravel stubs with a command to keep them in sync
+Improved Laravel stubs.
 
+## Usage
+### Installation
+```bash
+composer require --dev recoded-dev/laravel-stubs
+```
+
+### Publishing stubs
+```bash
+php artisan stubs:publish
+```
+That's it! This packages handles everything else.
+
+## Contribution
+Development to this package requires tests, static analysis
+and conforming to the coding-standard.
+
+To validate these locally run the following with dev dependencies installed:
+```bash
+vendor/bin/phpunit && vendor/bin/phpstan && vendor/bin/phpcs
+```

composer.json

@@ -42,5 +42,12 @@
             "dealerdirect/phpcodesniffer-composer-installer": true
         },
         "sort-packages": true
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Recoded\\LaravelStubs\\Providers\\StubsServiceProvider"
+            ]
+        }
     }
 }

src/Listeners/OverwriteStubsListener.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Recoded\LaravelStubs\Listeners;
+
+use Illuminate\Foundation\Events\PublishingStubs;
+use Illuminate\Support\Collection;
+
+final class OverwriteStubsListener
+{
+    /**
+     * Handle the event.
+     *
+     * @param \Illuminate\Foundation\Events\PublishingStubs $event
+     * @return void
+     */
+    public function handle(PublishingStubs $event): void
+    {
+        $event->stubs = Collection::make($event->stubs)->mapWithKeys(function (string $filename, string $path) {
+            $localPath = realpath(sprintf('%s/../../stubs/%s', __DIR__, $filename));
+            $path = $localPath !== false ? $localPath : $path;
+
+            return [$path => $filename];
+        })->toArray();
+    }
+}

src/Providers/StubsServiceProvider.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Recoded\LaravelStubs\Providers;
+
+use Illuminate\Contracts\Events\Dispatcher;
+use Illuminate\Foundation\Events\PublishingStubs;
+use Illuminate\Support\ServiceProvider;
+use Recoded\LaravelStubs\Listeners\OverwriteStubsListener;
+
+final class StubsServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application events.
+     *
+     * @param \Illuminate\Contracts\Events\Dispatcher $dispatcher
+     * @return void
+     */
+    public function boot(Dispatcher $dispatcher): void
+    {
+        $dispatcher->listen(PublishingStubs::class, OverwriteStubsListener::class);
+    }
+}

stubs/cast.inbound.stub

@@ -0,0 +1,23 @@
+<?php
+
+namespace {{ namespace }};
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes;
+
+class {{ class }} implements CastsInboundAttributes
+{
+    /**
+     * Prepare the given value for storage.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string $key
+     * @param mixed $value
+     * @param array<string, mixed> $attributes
+     * @return mixed
+     */
+    public function set(Model $model, string $key, mixed $value, array $attributes): mixed
+    {
+        return $value;
+    }
+}

stubs/cast.stub

@@ -0,0 +1,40 @@
+<?php
+
+namespace {{ namespace }};
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+
+/**
+ * @implements \Illuminate\Contracts\Database\Eloquent\CastsAttributes<x, y>
+ */
+class {{ class }} implements CastsAttributes
+{
+    /**
+     * Cast the given value.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string $key
+     * @param mixed $value
+     * @param array<string, mixed> $attributes
+     * @return mixed
+     */
+    public function get(Model $model, string $key, mixed $value, array $attributes): mixed
+    {
+        return $value;
+    }
+
+    /**
+     * Prepare the given value for storage.
+     *
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @param string $key
+     * @param mixed $value
+     * @param array<string, mixed> $attributes
+     * @return mixed
+     */
+    public function set(Model $model, string $key, mixed $value, array $attributes): mixed
+    {
+        return $value;
+    }
+}

stubs/console.stub

@@ -0,0 +1,32 @@
+<?php
+
+namespace {{ namespace }};
+
+use Illuminate\Console\Command;
+
+class {{ class }} extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = '{{ command }}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Command description';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle(): int
+    {
+        //
+    }
+}

stubs/controller.api.stub

@@ -0,0 +1,69 @@
+<?php
+
+namespace {{ namespace }};
+
+use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
+use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Response;
+
+class {{ class }}
+{
+    use AuthorizesRequests;
+
+    /**
+     * Display a listing of the resource.
+     *
+     * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
+     */
+    public function index(): AnonymousResourceCollection
+    {
+        //
+    }
+
+    /**
+     * Store a newly created resource in storage.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\Resources\Json\JsonResource
+     */
+    public function store(Request $request): JsonResource
+    {
+        //
+    }
+
+    /**
+     * Display the specified resource.
+     *
+     * @param string $id
+     * @return \Illuminate\Http\Resources\Json\JsonResource
+     */
+    public function show(string $id): JsonResource
+    {
+        //
+    }
+
+    /**
+     * Update the specified resource in storage.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param string $id
+     * @return \Illuminate\Http\Resources\Json\JsonResource
+     */
+    public function update(Request $request, string $id): JsonResource
+    {
+        //
+    }
+
+    /**
+     * Remove the specified resource from storage.
+     *
+     * @param string $id
+     * @return \Illuminate\Http\Response
+     */
+    public function destroy(string $id): Response
+    {
+        return response()->noContent();
+    }
+}

stubs/controller.invokable.stub

@@ -0,0 +1,23 @@
+<?php
+
+namespace {{ namespace }};
+
+use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+
+class {{ class }}
+{
+    use AuthorizesRequests;
+
+    /**
+     * Handle the incoming request.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @return \Illuminate\Http\Response
+     */
+    public function __invoke(Request $request): Response
+    {
+        //
+    }
+}

stubs/controller.model.api.stub

@@ -0,0 +1,70 @@
+<?php
+
+namespace {{ namespace }};
+
+use {{ namespacedModel }};
+use {{ namespacedRequests }}
+use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
+use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Response;
+
+class {{ class }}
+{
+    use AuthorizesRequests;
+
+    /**
+     * Display a listing of the resource.
+     *
+     * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
+     */
+    public function index(): AnonymousResourceCollection
+    {
+        //
+    }
+
+    /**
+     * Store a newly created resource in storage.
+     *
+     * @param \{{ namespacedStoreRequest }} $request
+     * @return \Illuminate\Http\Resources\Json\JsonResource
+     */
+    public function store({{ storeRequest }} $request): JsonResource
+    {
+        //
+    }
+
+    /**
+     * Display the specified resource
+     *
+     * @param \{{ namespacedModel }} ${{ modelVariable }}
+     * @return \Illuminate\Http\Resources\Json\JsonResource
+     */
+    public function show({{ model }} ${{ modelVariable }}): JsonResource
+    {
+        //
+    }
+
+    /**
+     * Update the specified resource in storage.
+     *
+     * @param \{{ namespacedUpdateRequest }} $request
+     * @param \{{ namespacedModel }} ${{ modelVariable }}
+     * @return \Illuminate\Http\Resources\Json\JsonResource
+     */
+    public function update({{ updateRequest }} $request, {{ model }} ${{ modelVariable }}): JsonResource
+    {
+        //
+    }
+
+    /**
+     * Remove the specified resource from storage.
+     *
+     * @param \{{ namespacedModel }} ${{ modelVariable }}
+     * @return \Illuminate\Http\Response
+     */
+    public function destroy({{ model }} ${{ modelVariable }}): Response
+    {
+        return response()->noContent();
+    }
+}