rename reads table

Author: QuentinGab

config/conversations.php

@@ -5,7 +5,7 @@
 use Elegantly\Conversation\Conversation;
 use Elegantly\Conversation\ConversationUser;
 use Elegantly\Conversation\Message;
-use Elegantly\Conversation\Read;
+use Elegantly\Conversation\MessageRead;
 use Illuminate\Foundation\Auth\User;
 
 return [
@@ -21,7 +21,7 @@
 
     'model_conversation_user' => ConversationUser::class,
 
-    'model_read' => Read::class,
+    'model_read' => MessageRead::class,
 
     /**
      * When a User is deleted, his messages will be deleted

database/migrations/create_reads_table.php.stub renamed to database/migrations/create_message_reads_table.php.stub

@@ -13,7 +13,7 @@ return new class extends Migration
      */
     public function up()
     {
-        Schema::create('reads', function (Blueprint $table) {
+        Schema::create('message_reads', function (Blueprint $table) {
             $table->id();
             $table->uuid()->unique();
 
@@ -22,6 +22,8 @@ return new class extends Migration
             $table->foreignId('message_id');
             $table->foreignId('user_id');
 
+            $table->dateTime('read_at')->nullable();
+
             $table->timestamps();
 
             $table->unique(['message_id', 'user_id']);
@@ -35,6 +37,6 @@ return new class extends Migration
      */
     public function down()
     {
-        Schema::dropIfExists('reads');
+        Schema::dropIfExists('message_reads');
     }
 };

src/ConversationServiceProvider.php

@@ -23,7 +23,7 @@ public function configurePackage(Package $package): void
                 'create_conversations_table',
                 'create_messages_table',
                 'create_conversation_user_table',
-                'create_reads_table',
+                'create_message_reads_table',
             ]);
     }
 }

src/Message.php

@@ -24,7 +24,7 @@
 use League\CommonMark\MarkdownConverter;
 
 /**
- * @template TRead of Read
+ * @template TMessageRead of MessageRead
  * @template TConversation of Conversation
  * @template TUser of User
  *
@@ -37,7 +37,7 @@
  * @property TConversation $conversation
  * @property ?int $user_id
  * @property ?TUser $user
- * @property Collection<int, Read> $reads
+ * @property Collection<int, MessageRead> $reads
  * @property ?ArrayObject<array-key, mixed> $metadata
  * @property ?Carbon $created_at
  * @property ?Carbon $read_at
@@ -90,7 +90,7 @@ public static function getModelUser(): string
     }
 
     /**
-     * @return class-string<TRead>
+     * @return class-string<TMessageRead>
      */
     public static function getModelRead(): string
     {
@@ -114,7 +114,7 @@ public function user(): BelongsTo
     }
 
     /**
-     * @return HasMany<TRead, $this>
+     * @return HasMany<TMessageRead, $this>
      */
     public function reads(): HasMany
     {
@@ -139,7 +139,7 @@ public function markAsReadBy(User|int $user, ?Carbon $date = null): static
     {
         $userId = $user instanceof User ? $user->getKey() : $user;
 
-        $read = new Read;
+        $read = new MessageRead;
         $read->user_id = $userId;
 
         if ($date) {

src/Read.php renamed to src/MessageRead.php

@@ -16,19 +16,24 @@
  *
  * @property int $id
  * @property ?string $origin
+ * @property ?Carbon $read_at
  * @property int $message_id
  * @property TMessage $message
  * @property int $user_id
  * @property TUser $user
  * @property Carbon $updated_at
  * @property Carbon $created_at
  */
-class Read extends Model
+class MessageRead extends Model
 {
     use HasUuid;
 
     protected $guarded = [];
 
+    protected $casts = [
+        'read_at' => 'datetime',
+    ];
+
     /**
      * @return class-string<TUser>
      */

tests/TestCase.php

@@ -46,7 +46,7 @@ protected function defineDatabaseMigrations()
                 'create_conversations_table',
                 'create_messages_table',
                 'create_conversation_user_table',
-                'create_reads_table',
+                'create_message_reads_table',
             ] as $migration
         ) {
             (include package_path("database/migrations/{$migration}.php.stub"))->up();