Structural entity: Link

[SzymCode]

Fields:

• id: number (given by default)
• download: string|null
• href: string
• src: string|null
• icon: string|null
• category: string
• hreflang: string|null
• media: string|null
• ping: string|null
• referrerpolicy: string|null
• rel: string|null
• target: string|null
• type: string|null
• start_date: string
• end_date: string

For frontend interfaces use types from attributes list on site: https://www.w3schools.com/tags/tag_a.asp

Keep fields order in all files and methods like migrations, models fields, instance methods etc.

First commit

• add your branch alphabetically in .husky/prepare-commit-msg with final message "🔗 Link: $ORIGINAL_MSG"
• git commit -m "prepare-commit-msg"

Second commit

Migration

• create migration with php artisan make:migration create_links_table
• add all fields given above (id is added by default)
• run php artisan migrate:fresh and check if the migrations ran successful
• create file LinkMigrationsTest.php in tests/Database/Migrations/Structural folder and write tests like other entities - example
• run tests with ./vendor/bin/pest --group=migrations

Model

• create model Link.php in app/Models/Structural folder
• create array protected $fillable with all fields, except id because Laravel handles it automatically
• create instance methods getId etc. with full typings as other entities in the project - example
• create scope methods scopeGetById etc.
• add PHPDocs for this model
• create file LinkTest.php in tests/Database/Models/Structural folder and write tests for instance and scope methods like other entities - example
• run tests with ./vendor/bin/pest --group=models

Factory

• create factory LinkFactory.php in database/factories/Structural folder
• faker all fields except id, based on other entities - example
• you can also add validator with reasonable rules
• create file LinkFactoryTest.php in tests/Database/Factories/Structural folder and write tests for instance and scope methods like other entities - example
• run tests with ./vendor/bin/pest --group=factories

Seeder

• create seeder LinkSeeder.php in database/seeders/Structural folder and call factories - example
• call LinkSeeder in StructuralSeeder.php
• run php artisan migrate:fresh --seed and check if LinkSeeder ran successful

• git commit -m "Migration, model, factory, seeder + tests"

Third commit

Contract

• create LinkContract.php in app/Contracts

Transformer

• create LinkTransformer.php in app/Transformers

Controller

• create LinkController.php in app/Http/Controllers/Structural
• create file LinkControllerTest.php in tests/Feature/Controllers/Structural folder and write tests for all methods like other entities - example

Service

• create LinkService.php in app/Services/Structural

Routes

• create API routes for link entity like for other structural entities in routes/api.php

Tests

• create API tests for HTTP 200, 302, 401, 405, 422, 500 - example

• git commit -m "Contract, transformer, controller, service, routes + tests"