feat(Tags): add tags' index endpoint

Author: José Postiga

config/app.php

@@ -175,6 +175,10 @@
         App\Providers\EventServiceProvider::class,
         App\Providers\RouteServiceProvider::class,
 
+        /*
+         * Domains Service Providers...
+         */
+        \Domains\Tags\TagsServiceProvider::class,
     ],
 
     /*

domains/Tags/Controllers/TagsIndexController.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Domains\Tags\Controllers;
+
+use App\Http\Controllers\Controller;
+use Domains\Tags\Models\Tag;
+use Domains\Tags\Resources\TagResource;
+
+class TagsIndexController extends Controller
+{
+    public function __invoke(Tag $tags)
+    {
+        return TagResource::collection($tags->all());
+    }
+}

domains/Tags/Database/Factories/TagFactory.php

@@ -0,0 +1,10 @@
+<?php
+
+use Carbon\Carbon;
+use Domains\Tags\Models\Tag;
+
+/** @var \Illuminate\Database\Eloquent\Factory $factory */
+$factory->define(Tag::class, static fn (\Faker\Generator $faker) => [
+    'name' => $faker->name,
+    'created_at' => Carbon::now(),
+]);

domains/Tags/Database/Migrations/2020_03_15_093618_add_tags_table.php

@@ -0,0 +1,18 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddTagsTable extends Migration
+{
+    public function up()
+    {
+        Schema::create('tags', static function (Blueprint $table) {
+            $table->id();
+            $table->string('name');
+            $table->timestamps();
+            $table->softDeletes();
+        });
+    }
+}

domains/Tags/Models/Tag.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Domains\Tags\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+
+class Tag extends Model
+{
+    use SoftDeletes;
+}

domains/Tags/Resources/TagResource.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Domains\Tags\Resources;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class TagResource extends JsonResource
+{
+    public function toArray($request): array
+    {
+        return [
+            'id' => $this->id,
+            'name' => $this->name,
+            'created_at' => $this->created_at,
+            'updated_at' => $this->updated_at,
+            'deleted_at' => $this->deleted_at,
+        ];
+    }
+}

domains/Tags/Routes/api.php

@@ -0,0 +1,5 @@
+<?php
+
+use Domains\Tags\Controllers\TagsIndexController;
+
+Route::get('/tags', TagsIndexController::class)->name('tags.index');

domains/Tags/TagsServiceProvider.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Domains\Tags;
+
+use Illuminate\Support\ServiceProvider;
+
+class TagsServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        $this->loadFactoriesFrom(__DIR__ . '/Database/Factories');
+
+        $this->loadMigrationsFrom(__DIR__ . '/Database/Migrations');
+
+        $this->loadRoutesFrom(__DIR__ . '/Routes/api.php');
+    }
+}

domains/Tags/Tests/Features/TagsIndexTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Domains\Tags\Tests\Features;
+
+use Domains\Tags\Models\Tag;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Tests\TestCase;
+
+class TagsIndexTest extends TestCase
+{
+    use DatabaseMigrations;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        factory(Tag::class, 2)->create();
+    }
+
+    /** @test */
+    public function it_lists_all_resources(): void
+    {
+        $response = $this->get('/tags')
+            ->assertSuccessful()
+            ->assertJsonStructure([
+                'data' => [
+                    [
+                        'id', 'name', 'created_at',
+                    ],
+                ],
+            ])
+            ->decodeResponseJson();
+
+        $this->assertCount(2, $response['data']);
+    }
+}

domains/Tags/Tests/Unit/TagModelTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Domains\Tags\Tests\Unit;
+
+use Carbon\Carbon;
+use Domains\Tags\Models\Tag;
+use Illuminate\Database\Eloquent\SoftDeletingScope;
+use Tests\TestCase;
+
+class TagModelTest extends TestCase
+{
+    private Tag $model;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->model = factory(Tag::class)->make();
+    }
+
+    /** @test */
+    public function it_contains_required_properties(): void
+    {
+        $this->assertNotNull($this->model->name);
+        $this->assertIsString($this->model->name);
+
+        $this->assertNotNull($this->model->created_at);
+        $this->assertInstanceOf(Carbon::class, $this->model->created_at);
+    }
+
+    /** @test */
+    public function it_uses_correct_table_name(): void
+    {
+        $this->assertEquals('tags', $this->model->getTable());
+    }
+
+    /** @test */
+    public function it_uses_soft_deletes(): void
+    {
+        $this->assertArrayHasKey(SoftDeletingScope::class, $this->model->getGlobalScopes());
+    }
+}