From 1453af5b103d9ee88c68f5f6e559a2563ea4e9ac Mon Sep 17 00:00:00 2001
From: Kris <git@k118.de>
Date: Wed, 22 Nov 2023 20:06:08 +0100
Subject: [PATCH] :sparkles: add TripSource for future purposes (#2154)

---
 app/Enum/TripSource.php                       | 17 ++++++++++++++
 app/Models/HafasTrip.php                      |  8 ++++---
 .../2023_11_22_000000_add_source_to_trips.php | 23 +++++++++++++++++++
 3 files changed, 45 insertions(+), 3 deletions(-)
 create mode 100644 app/Enum/TripSource.php
 create mode 100644 database/migrations/2023_11_22_000000_add_source_to_trips.php

diff --git a/app/Enum/TripSource.php b/app/Enum/TripSource.php
new file mode 100644
index 000000000..6e705d19f
--- /dev/null
+++ b/app/Enum/TripSource.php
@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace App\Enum;
+
+enum TripSource: string
+{
+    /**
+     * Trips created by data from DB-Rest (HAFAS Deutsche Bahn).
+     * @see https://v5.db.transport.rest/
+     */
+    case HAFAS = 'hafas';
+
+    /**
+     * Trips created by the user - with manual data.
+     */
+    case USER = 'user';
+}
diff --git a/app/Models/HafasTrip.php b/app/Models/HafasTrip.php
index 51005dd85..45d2f71f6 100644
--- a/app/Models/HafasTrip.php
+++ b/app/Models/HafasTrip.php
@@ -4,6 +4,7 @@
 
 use App\Casts\UTCDateTime;
 use App\Enum\HafasTravelType;
+use App\Enum\TripSource;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
@@ -11,10 +12,10 @@
 use Illuminate\Database\Eloquent\Relations\HasOne;
 
 /**
- * @property $stopovers
+ * @property          $stopovers
  * @property PolyLine $polyLine
  * @property PolyLine $polyline
- * @property $linename
+ * @property          $linename
  */
 class HafasTrip extends Model
 {
@@ -23,7 +24,7 @@ class HafasTrip extends Model
 
     protected $fillable = [
         'trip_id', 'category', 'number', 'linename', 'journey_number', 'operator_id', 'origin', 'destination',
-        'polyline_id', 'departure', 'arrival', 'delay', 'last_refreshed',
+        'polyline_id', 'departure', 'arrival', 'delay', 'source', 'last_refreshed',
     ];
     protected $hidden   = ['created_at', 'updated_at'];
     protected $casts    = [
@@ -38,6 +39,7 @@ class HafasTrip extends Model
         'departure'      => UTCDateTime::class,
         'arrival'        => UTCDateTime::class,
         'last_refreshed' => 'datetime',
+        'source'         => TripSource::class,
     ];
 
     public function polyline(): HasOne {
diff --git a/database/migrations/2023_11_22_000000_add_source_to_trips.php b/database/migrations/2023_11_22_000000_add_source_to_trips.php
new file mode 100644
index 000000000..da0640c2a
--- /dev/null
+++ b/database/migrations/2023_11_22_000000_add_source_to_trips.php
@@ -0,0 +1,23 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+
+    public function up(): void {
+        Schema::table('hafas_trips', static function(Blueprint $table) {
+            $table->string('source')
+                  ->default('hafas')
+                  ->after('delay');
+        });
+    }
+
+    public function down(): void {
+        Schema::table('hafas_trips', static function(Blueprint $table) {
+            $table->dropColumn('source');
+        });
+    }
+};