feature: add subscription definition in database

Author: mascam97

app/Models/Subscription.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Models;
+
+use Database\Factories\SubscriptionFactory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Collection;
+
+/**
+ * @property-read int $id
+ * @property string $name
+ * @property array $rules
+ * @property Carbon $created_at
+ * @property Carbon $updated_at
+ *
+ * @property-read Collection $users
+ *
+ * @method static SubscriptionFactory factory(...$parameters)
+ */
+class Subscription extends Model
+{
+    use HasFactory;
+
+    protected $fillable = [
+        'name',
+        'rules'
+    ];
+
+    protected $casts = [
+        'rules' => 'array',
+    ];
+
+    public function users(): HasMany
+    {
+        return $this->hasMany(User::class);
+    }
+}

app/Models/User.php

@@ -4,6 +4,7 @@
 
 use Database\Factories\UserFactory;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
@@ -18,11 +19,13 @@
  * @property string $name
  * @property string $email
  * @property string $password
+ * @property ?int $subscription_id
  * @property ?Carbon $email_verified_at
  * @property Carbon $created_at
  * @property Carbon $updated_at
  *
  * @property-read Collection $notes
+ * @property-read Subscription $subscription
  *
  * @method static UserFactory factory(...$parameters)
  */
@@ -75,6 +78,11 @@ class User extends Authenticatable
         'profile_photo_url',
     ];
 
+    public function subscription(): BelongsTo
+    {
+        return $this->belongsTo(Subscription::class);
+    }
+
     public function notes(): HasMany
     {
         return $this->hasMany(Note::class);

database/factories/SubscriptionFactory.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Database\Factories;
+
+use App\Models\Subscription;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends Factory<Subscription>
+ * @method Subscription create($attributes = [])
+ */
+class SubscriptionFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var string
+     */
+    protected $model = Subscription::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+            'name' => $this->faker->name,
+            'rules' => [
+                'notes_maximum_amount' => array_rand([null, 100, 1000])
+            ],
+        ];
+    }
+}

database/migrations/2023_05_01_210509_create_subscriptions_table.php

@@ -0,0 +1,33 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateSubscriptionsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('subscriptions', function (Blueprint $table) {
+            $table->id();
+            $table->string('name', 80);
+            $table->json('rules')->nullable();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('subscriptions');
+    }
+}

database/migrations/2023_05_01_220509_add_subscription_id_to_users_table.php

@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddSubscriptionIdToUsersTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->foreignId('subscription_id')->after('password')->nullable()->constrained();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->dropColumn('subscription_id');
+        });
+    }
+}

database/seeders/DatabaseSeeder.php

@@ -2,21 +2,16 @@
 
 namespace Database\Seeders;
 
+use App\Models\Subscription;
 use App\Models\User;
 use App\Models\Note;
 use Illuminate\Database\Seeder;
-use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Hash;
 
 class DatabaseSeeder extends Seeder
 {
-    /**
-     * Seed the application's database.
-     *
-     * @return void
-     */
-    public function run()
+    public function run(): void
     {
         $admin = new User();
         $admin->name = config('admin.name');
@@ -25,16 +20,30 @@ public function run()
         $admin->save();
 
         if (! App::environment('production')) {
-            User::factory(9)->create();
+            $premiumSubscription = Subscription::factory()->create([
+                'name' => 'Premium subscription',
+                'rules' => ['notes_maximum_amount' => null]
+            ]);
 
-            /** @var Collection $usersId */
-            $usersId = User::query()
-                ->whereNot('id', $admin->getKey())
+            $admin->subscription()->associate($premiumSubscription)->save();
+
+            $freeSubscription = Subscription::factory()->create([
+                'name' => 'Free subscription',
+                'rules' => ['notes_maximum_amount' => 100]
+            ]);
+
+            User::factory(100)->create([
+                'subscription_id' => $freeSubscription->getKey()
+            ]);
+
+            User::query()
                 ->select('id')
                 ->get()
-                ->pluck('id');
-
-            Note::factory(200)->create(['user_id' => $usersId->random()]);
+                ->each(function (User $user){
+                    Note::factory(50)->create([
+                        'user_id' => $user->getKey()
+                    ]);
+                });
         }
     }
 }