Updated event name, updated docs

Author: luisdalmolin

README.md

@@ -168,6 +168,13 @@ class User extends Model implements Commenter
 }
 ```
 
+### Events
+
+Two events are dispatched when a comment is created or reacted to:
+
+- `Kirschbaum\Commentions\Events\UserWasMentionedEvent`
+- `Kirschbaum\Commentions\Events\CommentWasReactedEvent`
+
 ### Sending notifications when a user is mentioned
 
 Every time a user is mentioned, the `Kirschbaum\Commentions\Events\UserWasMentionedEvent` is dispatched. You can listen to this event and send notifications to the mentioned user.

src/Actions/ToggleCommentReaction.php

@@ -6,7 +6,7 @@
 use Kirschbaum\Commentions\Comment;
 use Kirschbaum\Commentions\CommentReaction;
 use Kirschbaum\Commentions\Contracts\Commenter;
-use Kirschbaum\Commentions\Events\CommentReactionToggledEvent;
+use Kirschbaum\Commentions\Events\CommentWasReactedEvent;
 
 class ToggleCommentReaction
 {
@@ -30,27 +30,16 @@ public static function run(Comment $comment, string $reaction, ?Commenter $user
 
         if ($existingReaction) {
             $existingReaction->delete();
-
-            event(new CommentReactionToggledEvent(
-                comment: $comment,
-                reaction: $existingReaction,
-                user: $user,
-                reactionType: $reaction,
-                wasCreated: false
-            ));
         } else {
-            $newReaction = $comment->reactions()->create([
+            $reaction = $comment->reactions()->create([
                 'reactor_id' => $user->getKey(),
                 'reactor_type' => $user->getMorphClass(),
                 'reaction' => $reaction,
             ]);
 
-            event(new CommentReactionToggledEvent(
+            event(new CommentWasReactedEvent(
                 comment: $comment,
-                reaction: $newReaction,
-                user: $user,
-                reactionType: $reaction,
-                wasCreated: true
+                reaction: $reaction,
             ));
         }
     }

src/CommentReaction.php

@@ -3,9 +3,14 @@
 namespace Kirschbaum\Commentions;
 
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Kirschbaum\Commentions\Contracts\Commenter;
 use Illuminate\Database\Eloquent\Relations\MorphTo;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
+/**
+ * @property-read Comment $comment
+ * @property-read Commenter $reactor
+ */
 class CommentReaction extends Model
 {
     protected $fillable = [
@@ -15,11 +20,13 @@ class CommentReaction extends Model
         'reaction',
     ];
 
+    /** @return BelongsTo<Comment> */
     public function comment(): BelongsTo
     {
         return $this->belongsTo(Comment::class);
     }
 
+    /** @return MorphTo<Commenter> */
     public function reactor(): MorphTo
     {
         return $this->morphTo();

…c/Events/CommentReactionToggledEvent.php src/Events/CommentWasReactedEvent.phpsrc/Events/CommentReactionToggledEvent.php renamed to src/Events/CommentWasReactedEvent.php src/Events/CommentReactionToggledEvent.php renamed to src/Events/CommentWasReactedEvent.php

@@ -8,16 +8,13 @@
 use Kirschbaum\Commentions\CommentReaction;
 use Kirschbaum\Commentions\Contracts\Commenter;
 
-class CommentReactionToggledEvent
+class CommentWasReactedEvent
 {
     use Dispatchable, SerializesModels;
 
     public function __construct(
         public Comment $comment,
-        public ?CommentReaction $reaction,
-        public Commenter $user,
-        public string $reactionType,
-        public bool $wasCreated
+        public CommentReaction $reaction,
     ) {
     }
 }

tests/Livewire/CommentReactionTest.php

@@ -5,7 +5,7 @@
 use Kirschbaum\Commentions\Comment as CommentModel;
 use Kirschbaum\Commentions\Config;
 use Kirschbaum\Commentions\Database\Factories\CommentFactory;
-use Kirschbaum\Commentions\Events\CommentReactionToggledEvent;
+use Kirschbaum\Commentions\Events\CommentWasReactedEvent;
 use Kirschbaum\Commentions\Livewire\Comment as CommentComponent;
 use Kirschbaum\Commentions\Livewire\Reactions;
 use Tests\Database\Factories\PostFactory;
@@ -32,11 +32,8 @@
     livewire(CommentComponent::class, ['comment' => $comment])
         ->call('toggleReaction', $reactionEmoji);
 
-    Event::assertDispatched(CommentReactionToggledEvent::class, function (CommentReactionToggledEvent $event) use ($comment, $user, $reactionEmoji) {
+    Event::assertDispatched(CommentWasReactedEvent::class, function (CommentWasReactedEvent $event) use ($comment, $user, $reactionEmoji) {
         return $event->comment->is($comment)
-            && $event->user->is($user)
-            && $event->reactionType === $reactionEmoji
-            && $event->wasCreated === true
             && $event->reaction !== null
             && $event->reaction->reaction === $reactionEmoji;
     });
@@ -77,15 +74,6 @@
     livewire(CommentComponent::class, ['comment' => $comment])
         ->call('toggleReaction', $reactionEmoji);
 
-    Event::assertDispatched(CommentReactionToggledEvent::class, function (CommentReactionToggledEvent $event) use ($comment, $user, $reactionEmoji, $reaction) {
-        return $event->comment->is($comment)
-            && $event->user->is($user)
-            && $event->reactionType === $reactionEmoji
-            && $event->wasCreated === false
-            && $event->reaction !== null // The deleted reaction model is passed
-            && $event->reaction->is($reaction);
-    });
-
     $this->assertDatabaseMissing('comment_reactions', [
         'comment_id' => $comment->id,
         'reactor_id' => $user->id,