first commit

Author: sr2ds

Readme.md

@@ -0,0 +1,29 @@
+# Laravel Stubs
+
+This repository contains some stubs to simplify your life with Laravel.
+
+Is required that your application has L5-Swagger setuped to correct run. If necessary, you can check this repository with all configuration, fully works and video demonstrations:
+
+https://github.com/sr2ds/laravel-9-tutorial
+
+# How to usage
+
+## Download this files to your laravel application 
+
+```
+mkdir stubs
+cd stubs
+git clone https://github.com/sr2ds/laravel-api-stubs .
+```
+
+## To generate resource api
+
+```
+php artisan make:model -c -f -m --api -R --test Product
+```
+
+## Additional configuration - After files generated
+
+1. Is necessary change 3 `//@todo` lines in your tests files generated;
+2. Write your attributes in `migrations` and `Model`(fillable and on swagger block) and `Requests`;
+3. Create the route on `routes/api.php`

controller.model.api.stub

@@ -0,0 +1,165 @@
+<?php
+namespace {{ namespace }};
+
+use {{ namespacedModel }};
+use {{ rootNamespace }}Http\Controllers\Controller;
+use {{ namespacedRequests }}
+use Illuminate\Http\Response;
+
+/**
+ * Class {{ class }}Controller
+ * @package  {{ namespace }}
+ */
+class {{ class }} extends Controller
+{
+    /**
+     * @OA\Get(
+     *  path="/{{ modelVariable }}s",
+     *  operationId="index{{ model }}",
+     *  tags={"{{ model }}s"},
+     *  summary="Get list of {{ model }}",
+     *  description="Returns list of {{ model }}",
+     *  @OA\Response(response=200, description="Successful operation",
+     *    @OA\JsonContent(ref="#/components/schemas/{{ model }}s"),
+     *  ),
+     * )
+     *
+     * Display a listing of {{ model }}.
+     * @return JsonResponse
+     */
+    public function index()
+    {
+        ${{ modelVariable }}s = {{ model }}::all();
+        return response()->json(['data' => ${{ modelVariable }}s]);
+    }
+    
+    /**
+     * @OA\Post(
+     *  operationId="store{{ model }}",
+     *  summary="Insert a new {{ model }}",
+     *  description="Insert a new {{ model }}",
+     *  tags={"{{ model }}s"},
+     *  path="/{{ modelVariable }}s",
+     *  @OA\RequestBody(
+     *    description="{{ model }} to create",
+     *    required=true,
+     *    @OA\MediaType(
+     *      mediaType="application/json",
+     *      @OA\Schema(
+     *      @OA\Property(
+     *      title="data",
+     *      property="data",
+     *      type="object",
+     *      ref="#/components/schemas/{{ model }}")
+     *     )
+     *    )
+     *  ),
+     *  @OA\Response(response="201",description="{{ model }} created",
+     *     @OA\JsonContent(
+     *      @OA\Property(
+     *       title="data",
+     *       property="data",
+     *       type="object",
+     *       ref="#/components/schemas/{{ model }}"
+     *      ),
+     *    ),
+     *  ),
+     *  @OA\Response(response=422,description="Validation exception"),
+     * )
+     *
+     * @param {{ model }}Request $request
+     * @return JsonResponse
+     */
+    public function store({{ storeRequest }} $request)
+    {
+        $data = {{ model }}::create($request->validated('data'));
+        return response()->json(['data' => $data], RESPONSE::HTTP_CREATED);
+    }
+  
+    /**
+     * @OA\Get(
+     *   path="/{{ modelVariable }}s/{{{ modelVariable }}_id}",
+     *   summary="Show a {{ model }} from his Id",
+     *   description="Show a {{ model }} from his Id",
+     *   operationId="show{{ model }}",
+     *   tags={"{{ model }}s"},
+     *   @OA\Parameter(ref="#/components/parameters/{{ model }}--id"),
+     *   @OA\Response(
+     *     response=200,
+     *     description="Successful operation",
+     *       @OA\JsonContent(
+     *       @OA\Property(
+     *       title="data",
+     *       property="data",
+     *       type="object",
+     *       ref="#/components/schemas/{{ model }}"
+     *       ),
+     *     ),
+     *   ),
+     *   @OA\Response(response="404",description="{{ model }} not found"),
+     * )
+     *
+     * @param {{ model }} ${{ model }}
+     * @return JsonResponse
+     */
+    public function show({{ model }} ${{ modelVariable }})
+    {
+        return response()->json(['data' => ${{ modelVariable }}]);
+    }
+   
+    /**
+     * @OA\Patch(
+     *   operationId="update{{ model }}",
+     *   summary="Update an existing {{ model }}",
+     *   description="Update an existing {{ model }}",
+     *   tags={"{{ model }}s"},
+     *   path="/{{ modelVariable }}s/{{{ modelVariable }}_id}",
+     *   @OA\Parameter(ref="#/components/parameters/{{ model }}--id"),
+     *   @OA\Response(response="204",description="No content"),
+     *   @OA\RequestBody(
+     *     description="{{ model }} to update",
+     *     required=true,
+     *     @OA\MediaType(
+     *       mediaType="application/json",
+     *       @OA\Schema(
+     *        @OA\Property(
+     *        title="data",
+     *        property="data",
+     *        type="object",
+     *        ref="#/components/schemas/{{ model }}")
+     *      )
+     *     )
+     *   )
+     * )
+     *
+     * @param Request $request
+     * @param {{ model }} ${{ model }}
+     * @return Response|JsonResponse
+     */
+    public function update({{ updateRequest }} $request, {{ model }} ${{ modelVariable }})
+    {
+        ${{ modelVariable }}->update($request->validated('data'));
+        return response()->json(['data' => ${{ modelVariable }}->refresh()]);
+    }
+
+    /**
+     * @OA\Delete(
+     *  path="/{{ modelVariable }}s/{{{ modelVariable }}_id}",
+     *  summary="Delete a {{ model }}",
+     *  description="Delete a {{ model }}",
+     *  operationId="destroy{{ model }}",
+     *  tags={"{{ model }}s"},
+     *  @OA\Parameter(ref="#/components/parameters/{{ model }}--id"),
+     *  @OA\Response(response=204,description="No content"),
+     *  @OA\Response(response=404,description="{{ model }} not found"),
+     * )
+     *
+     * @param {{ model }} ${{ model }}
+     * @return Response|JsonResponse
+     */
+    public function destroy({{ model }} ${{ modelVariable }})
+    {
+        ${{ modelVariable }}->delete();
+        return response()->noContent();
+    }
+}

factory.stub

@@ -0,0 +1,23 @@
+<?php
+
+namespace {{ factoryNamespace }};
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\{{ namespacedModel }}>
+ */
+class {{ factory }}Factory extends Factory
+{
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition()
+    {
+        return [
+            //
+        ];
+    }
+}

model.stub

@@ -0,0 +1,48 @@
+<?php
+namespace {{ namespace }};
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @OA\Schema(
+ *   description="{{ class }} model",
+ *   title="{{ class }}",
+ *   required={},
+ *   @OA\Property(type="integer",description="id of {{ class }}",title="id",property="id",example="1",readOnly="true"),
+ *   @OA\Property(type="dateTime",title="created_at",property="created_at",example="2022-07-04T02:41:42.336Z",readOnly="true"),
+ *   @OA\Property(type="dateTime",title="updated_at",property="updated_at",example="2022-07-04T02:41:42.336Z",readOnly="true"),
+ * )
+ * 
+ * @OA\Schema(
+ *   schema="{{ class }}s",
+ *   title="{{ class }}s",
+ *   @OA\Property(title="data",property="data",type="array",
+ *     @OA\Items(type="object",ref="#/components/schemas/{{ class }}"),
+ *   )
+ * )
+ * 
+ * @OA\Parameter(
+ *      parameter="{{ class }}--id",
+ *      in="path",
+ *      name="{{ class }}_id",
+ *      required=true,
+ *      description="Id of {{ class }}",
+ *      @OA\Schema(
+ *          type="integer",
+ *          example="1",
+ *      )
+ * ),
+ */
+ 
+class {{ class }} extends Model
+{
+    use HasFactory;
+
+    protected $fillable = [
+        'created_at',
+        'updated_at',
+    ];
+    
+    protected $casts = [];
+}

request.stub

@@ -0,0 +1,30 @@
+<?php
+
+namespace {{ namespace }};
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class {{ class }} extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            //
+        ];
+    }
+}

test.stub

@@ -0,0 +1,59 @@
+<?php
+
+namespace {{ namespace }};
+
+use Tests\TestCase;
+
+class {{ class }} extends TestCase
+{
+    private $path = '/api/{{ class }}'; //@todo: set correct path
+    private $model = \App\Models\{{ class }}::class; //@todo: set correct model class
+    private $table = '{{ class }}'; //@todo: set correct table
+
+    public function test_create_{{ class }}()
+    {
+        $data = $this->model::factory()->make();
+
+        $this->postJson($this->path, ['data' => $data->toArray()])
+            ->assertCreated();
+
+        $this->assertDatabaseHas($this->table, $data->toArray());
+    }
+
+    public function test_show_{{ class }}()
+    {
+        $data = $this->model::factory()->create();
+
+        $response = $this->getJson($this->path . '/' .  $data->getRouteKey());
+        $response->assertOk();
+        $response->assertJsonFragment($data->toArray());
+    }
+
+    public function test_update_{{ class }}()
+    {
+        $data = $this->model::factory()->create();
+        $newData = $this->model::factory()->make();
+
+        $response = $this->putJson($this->path . '/' . $data->getRouteKey(), ['data' => $newData->toArray()]);
+        $response->assertOk();
+        $response->assertJsonFragment($newData->toArray());
+    }
+
+    public function test_list_{{ class }}()
+    {
+        $this->model::factory()->count(10)->create();
+
+        $response = $this->get($this->path);
+        $response->assertOk();
+        $response->assertJsonCount(10, 'data');
+    }
+
+    public function test_delete_{{ class }}()
+    {
+        $data = $this->model::factory()->create();
+        $this->delete($this->path . '/' . $data->getRouteKey())
+            ->assertNoContent();
+
+        $this->assertDatabaseCount($this->table, 0);
+    }
+}