Merge pull request #14 from ijpatricio/develop

Add Links domain

Author: josepostiga

config/app.php

@@ -179,6 +179,7 @@
          * Domains Service Providers...
          */
         \Domains\Tags\TagsServiceProvider::class,
+        \Domains\Links\LinksServiceProvider::class,
     ],
 
     /*

domains/Links/Controllers/LinksIndexController.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Domains\Links\Controllers;
+
+use App\Http\Controllers\Controller;
+use Domains\Links\Models\Link;
+use Domains\Links\Resources\LinkResource;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
+
+class LinksIndexController extends Controller
+{
+    private Link $links;
+
+    public function __construct(Link $links)
+    {
+        $this->links = $links;
+    }
+
+    public function __invoke(Request $request): AnonymousResourceCollection
+    {
+        $links = $this->links
+            ->when($request->input('include'), static function (Builder $query, string $includes) {
+                return $query->with(
+                    explode(',', $includes)
+                );
+            })
+            ->approved()
+            ->simplePaginate();
+
+        return LinkResource::collection($links);
+    }
+}

domains/Links/Controllers/LinksStoreController.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Domains\Links\Controllers;
+
+use App\Http\Controllers\Controller;
+use Domains\Links\Models\Link;
+use Domains\Links\Requests\LinkStoreRequest;
+use Illuminate\Http\Response;
+
+class LinksStoreController extends Controller
+{
+    private Link $links;
+
+    public function __construct(Link $links)
+    {
+        $this->links = $links;
+    }
+
+    public function __invoke(LinkStoreRequest $request): Response
+    {
+        $link = $this->links->create([
+            'link' => $request->input('link'),
+            'description' => $request->input('description'),
+            'author_name' => $request->input('author_name'),
+            'author_email' => $request->input('author_email'),
+            'cover_image' => $request->file('cover_image')->store('cover_images'),
+        ]);
+
+        $link->tags()->attach($request->input('tags.*.id'));
+
+        return Response::create('', Response::HTTP_NO_CONTENT);
+    }
+}

domains/Links/Database/Factories/LinkFactory.php

@@ -0,0 +1,29 @@
+<?php
+
+use Domains\Links\Models\Link;
+use Domains\Tags\Models\Tag;
+use Illuminate\Database\Eloquent\Factory;
+use Illuminate\Http\UploadedFile;
+use Illuminate\Support\Carbon;
+
+/** @var Factory $factory */
+$factory->define(Link::class, static fn (\Faker\Generator $faker) => [
+    'link' => $faker->url,
+    'description' => $faker->paragraph,
+    'cover_image' => 'cover_images/' . UploadedFile::fake()->image('cover_image')->getFilename(),
+    'author_name' => $faker->name,
+    'author_email' => $faker->safeEmail,
+    'created_at' => Carbon::now(),
+    'approved_at' => null,
+]);
+
+$factory->afterCreating(Link::class, static function (Link $link) {
+    $link->tags()
+        ->attach(
+            factory(Tag::class)->create()
+        );
+});
+
+$factory->state(Link::class, 'approved', static fn () => [
+    'approved_at' => Carbon::now(),
+]);

domains/Links/Database/Migrations/2020_03_19_201343_add_links_table.php

@@ -0,0 +1,23 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddLinksTable extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('links', static function (Blueprint $table) {
+            $table->id();
+            $table->text('link');
+            $table->text('description');
+            $table->string('author_name');
+            $table->string('author_email');
+            $table->string('cover_image');
+            $table->timestamps();
+            $table->softDeletes();
+            $table->timestamp('approved_at')->nullable();
+        });
+    }
+}

domains/Links/Database/Migrations/2020_03_19_202800_add_link_tag_table.php

@@ -0,0 +1,17 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddLinkTagTable extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('link_tag', static function (Blueprint $table) {
+            $table->id();
+            $table->foreignId('link_id')->constrained();
+            $table->foreignId('tag_id')->constrained();
+        });
+    }
+}

domains/Links/LinksServiceProvider.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Domains\Links;
+
+use Illuminate\Support\Facades\Route;
+use Illuminate\Support\ServiceProvider;
+
+class LinksServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        $this->loadFactoriesFrom(__DIR__ . '/Database/Factories');
+
+        $this->loadMigrationsFrom(__DIR__ . '/Database/Migrations');
+
+        $this->bootRoutes();
+    }
+
+    private function bootRoutes(): void
+    {
+        Route::middleware(['api', 'throttle'])
+            ->group(fn () => $this->loadRoutesFrom(__DIR__ . '/Routes/api.php'));
+    }
+}

domains/Links/Models/Link.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Domains\Links\Models;
+
+use Domains\Tags\Models\Tag;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use Illuminate\Database\Eloquent\SoftDeletes;
+
+class Link extends Model
+{
+    use SoftDeletes;
+
+    protected $fillable = [
+        'link',
+        'description',
+        'author_name',
+        'author_email',
+        'cover_image',
+    ];
+
+    public function tags(): BelongsToMany
+    {
+        return $this->belongsToMany(Tag::class);
+    }
+
+    public function scopeApproved(Builder $query): Builder
+    {
+        return $query->whereNotNull('approved_at');
+    }
+}

domains/Links/Requests/LinkStoreRequest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Domains\Links\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class LinkStoreRequest extends FormRequest
+{
+    public function authorize(): bool
+    {
+        return true;
+    }
+
+    public function rules(): array
+    {
+        return [
+            'link' => ['required', 'string'],
+            'description' => ['required', 'string'],
+            'author_name' => ['required', 'string'],
+            'author_email' => ['required', 'email'],
+            'cover_image' => ['required', 'image'],
+            'tags' => ['required', 'array'],
+            'tags.*.id' => ['required', 'integer', 'exists:tags'],
+        ];
+    }
+}

domains/Links/Resources/LinkResource.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Domains\Links\Resources;
+
+use Domains\Tags\Resources\TagResource;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class LinkResource extends JsonResource
+{
+    public function toArray($request): array
+    {
+        return [
+            'id' => $this->id,
+            'link' => $this->link,
+            'description' => $this->description,
+            'author_name' => $this->author_name,
+            'author_email' => $this->author_email,
+            'cover_image' => $this->cover_image,
+            'created_at' => $this->created_at,
+            'updated_at' => $this->updated_at,
+            'approved_at' => $this->approved_at,
+            'tags' => TagResource::collection(
+                $this->whenLoaded('tags')
+            ),
+        ];
+    }
+}

domains/Links/Routes/api.php

@@ -0,0 +1,7 @@
+<?php
+
+use Domains\Links\Controllers\LinksIndexController;
+use Domains\Links\Controllers\LinksStoreController;
+
+Route::get('/links', LinksIndexController::class)->name('links.index');
+Route::post('/links', LinksStoreController::class)->name('links.store');

domains/Links/Tests/Feature/LinksIndexTest.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Domains\Links\Tests\Feature;
+
+use Domains\Links\Models\Link;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Tests\TestCase;
+
+class LinksIndexTest extends TestCase
+{
+    use RefreshDatabase;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        factory(Link::class, 20)->state('approved')->create();
+    }
+
+    /** @test */
+    public function it_lists_resources(): void
+    {
+        $this->getJson('/links')
+            ->assertSuccessful()
+            ->assertJsonStructure([
+                'data' => [
+                    [
+                        'id', 'link', 'description', 'cover_image', 'author_name', 'author_email', 'created_at',
+                    ],
+                ],
+                'links' => [
+                    'first', 'last', 'prev', 'next',
+                ],
+            ]);
+    }
+
+    /** @test */
+    public function it_includes_tags_relation(): void
+    {
+        $this->getJson('/links?include=tags')
+            ->assertSuccessful()
+            ->assertJsonStructure([
+                'data' => [
+                    [
+                        'tags',
+                    ],
+                ],
+            ])
+            ->assertJsonCount(1, 'data.0.tags');
+    }
+
+    /** @test */
+    public function it_doesnt_include_relations_if_not_required(): void
+    {
+        $response = $this->getJson('/links')
+            ->assertSuccessful()
+            ->decodeResponseJson();
+
+        $this->assertArrayNotHasKey('tags', $response['data'][0]);
+    }
+
+    /** @test */
+    public function it_supports_pagination_navigation(): void
+    {
+        $this->getJson('/links?page=2')
+            ->assertSuccessful()
+            ->assertJsonPath('meta.current_page', 2);
+    }
+}