Merge pull request #41 from beyondcode/updates

mechelon · web-flow · commit 9605cd854556 · 2024-10-11T18:47:15.000+02:00
1.6.0
diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ php artisan vendor:publish --provider="BeyondCode\Comments\CommentsServiceProvid
 
 To let your models be able to receive comments, add the `HasComments` trait to the model classes.
 
-``` php
+```php
 namespace App\Models;
 
 use Illuminate\Database\Eloquent\Model;
@@ -146,10 +146,18 @@ $comment = BeyondCode\Comments\Comment::first();
 $comment->commentAsUser($user, "Hey there!");
 ```
 
+#### Deleting Replies
+
+When you delete a comment, you may optionally want to delete all its nested comments (replies). To optionally enable this feature, set the `delete_replies_along_comments` config property in the `config/comments.php` file to `true`.
+
+### Events
+
+When a new comment is added the `BeyondCode\Comments\Events\CommentAdded` event will be dispatched.
+When a comment is deleted the `BeyondCode\Comments\Events\CommentDeleted` event will be dispatched.
 
 ### Testing
 
-``` bash
+```bash
 composer test
 ```
 
@@ -167,8 +175,8 @@ If you discover any security related issues, please email marcel@beyondco.de ins
 
 ## Credits
 
-- [Marcel Pociot](https://github.com/mpociot)
-- [All Contributors](../../contributors)
+-   [Marcel Pociot](https://github.com/mpociot)
+-   [All Contributors](../../contributors)
 
 ## License
 
diff --git a/config/config.php b/config/config.php
@@ -15,4 +15,8 @@
      */
     'user_model' => null,
 
-];
+    /**
+     * Determines if replies will be deleted when comments are deleted
+     */
+    'delete_replies_along_comments' => false,
+];
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,28 +1,33 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    bootstrap="vendor/autoload.php"
+    backupGlobals="false"
+    backupStaticAttributes="false"
+    colors="true"
+    verbose="true"
+    convertErrorsToExceptions="true"
+    convertNoticesToExceptions="true"
+    convertWarningsToExceptions="true"
+    processIsolation="false"
+    stopOnFailure="false"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+    <coverage>
+        <include>
+            <directory suffix=".php">src/</directory>
+        </include>
+        <report>
+            <clover outputFile="build/logs/clover.xml" />
+            <html outputDirectory="build/coverage" />
+            <text outputFile="build/coverage.txt" />
+        </report>
+    </coverage>
     <testsuites>
         <testsuite name="BeyondCode Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
     <logging>
-        <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage" />
-        <log type="coverage-text" target="build/coverage.txt"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
+        <junit outputFile="build/report.junit.xml" />
     </logging>
 </phpunit>
diff --git a/phpunit.xml.dist.bak b/phpunit.xml.dist.bak
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    bootstrap="vendor/autoload.php"
+    backupGlobals="false"
+    backupStaticAttributes="false"
+    colors="true"
+    verbose="true"
+    convertErrorsToExceptions="true"
+    convertNoticesToExceptions="true"
+    convertWarningsToExceptions="true"
+    processIsolation="false"
+    stopOnFailure="false">
+    <testsuites>
+        <testsuite name="BeyondCode Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="junit" target="build/report.junit.xml" />
+        <log type="coverage-html" target="build/coverage" />
+        <log type="coverage-text" target="build/coverage.txt" />
+        <log type="coverage-clover" target="build/logs/clover.xml" />
+    </logging>
+</phpunit>
diff --git a/src/Comment.php b/src/Comment.php
@@ -2,9 +2,11 @@
 
 namespace BeyondCode\Comments;
 
+use BeyondCode\Comments\Events\CommentAdded;
+use BeyondCode\Comments\Events\CommentDeleted;
+use BeyondCode\Comments\Traits\HasComments;
 use Exception;
 use Illuminate\Database\Eloquent\Model;
-use BeyondCode\Comments\Traits\HasComments;
 
 class Comment extends Model
 {
@@ -13,13 +15,32 @@ class Comment extends Model
     protected $fillable = [
         'comment',
         'user_id',
-        'is_approved'
+        'is_approved',
     ];
 
     protected $casts = [
-        'is_approved' => 'boolean'
+        'is_approved' => 'boolean',
     ];
 
+    public static function boot(): void
+    {
+        parent::boot();
+
+        static::deleting(function (self $model) {
+            if (config('comments.delete_replies_along_comments')) {
+                $model->comments()->delete();
+            }
+        });
+
+        static::deleted(function (self $model) {
+            CommentDeleted::dispatch($model);
+        });
+
+        static::created(function (self $model) {
+            CommentAdded::dispatch($model);
+        });
+    }
+
     public function scopeApproved($query)
     {
         return $query->where('is_approved', true);
@@ -43,7 +64,7 @@ public function approve()
 
         return $this;
     }
-  
+
     public function disapprove()
     {
         $this->update([
@@ -59,11 +80,10 @@ protected function getAuthModelName()
             return config('comments.user_model');
         }
 
-        if (!is_null(config('auth.providers.users.model'))) {
+        if (! is_null(config('auth.providers.users.model'))) {
             return config('auth.providers.users.model');
         }
 
         throw new Exception('Could not determine the commentator model name.');
     }
-
 }
diff --git a/src/CommentsServiceProvider.php b/src/CommentsServiceProvider.php
@@ -16,7 +16,6 @@ public function boot()
                 __DIR__.'/../config/config.php' => config_path('comments.php'),
             ], 'config');
 
-
             if (! class_exists('CreateCommentsTable')) {
                 $this->publishes([
                     __DIR__.'/../database/migrations/create_comments_table.php.stub' => database_path('migrations/'.date('Y_m_d_His', time()).'_create_comments_table.php'),
diff --git a/src/Contracts/Commentator.php b/src/Contracts/Commentator.php
@@ -2,14 +2,12 @@
 
 namespace BeyondCode\Comments\Contracts;
 
-
 interface Commentator
 {
     /**
      * Check if a comment for a specific model needs to be approved.
-     * @param mixed $model
-     * @return bool
+     *
+     * @param  mixed  $model
      */
     public function needsCommentApproval($model): bool;
-
-}
+}
diff --git a/src/Events/CommentAdded.php b/src/Events/CommentAdded.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace BeyondCode\Comments\Events;
+
+use BeyondCode\Comments\Comment;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Contracts\Events\ShouldDispatchAfterCommit;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class CommentAdded implements ShouldDispatchAfterCommit
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(
+        public Comment $comment,
+    ) {
+    }
+}
diff --git a/src/Events/CommentDeleted.php b/src/Events/CommentDeleted.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace BeyondCode\Comments\Events;
+
+use BeyondCode\Comments\Comment;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Contracts\Events\ShouldDispatchAfterCommit;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class CommentDeleted implements ShouldDispatchAfterCommit
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(
+        public Comment $comment,
+    ) {
+    }
+}
diff --git a/src/Traits/CanComment.php b/src/Traits/CanComment.php
@@ -2,16 +2,15 @@
 
 namespace BeyondCode\Comments\Traits;
 
-
 trait CanComment
 {
     /**
      * Check if a comment for a specific model needs to be approved.
-     * @param mixed $model
-     * @return bool
+     *
+     * @param  mixed  $model
      */
     public function needsCommentApproval($model): bool
     {
         return true;
     }
-}
+}
diff --git a/src/Traits/HasComments.php b/src/Traits/HasComments.php
@@ -2,9 +2,8 @@
 
 namespace BeyondCode\Comments\Traits;
 
-
-use Illuminate\Database\Eloquent\Model;
 use BeyondCode\Comments\Contracts\Commentator;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 
 trait HasComments
@@ -22,7 +21,6 @@ public function comments()
     /**
      * Attach a comment to this model.
      *
-     * @param string $comment
      * @return \Illuminate\Database\Eloquent\Model
      */
     public function comment(string $comment)
@@ -33,8 +31,6 @@ public function comment(string $comment)
     /**
      * Attach a comment to this model as a specific user.
      *
-     * @param Model|null $user
-     * @param string $comment
      * @return \Illuminate\Database\Eloquent\Model
      */
     public function commentAsUser(?Model $user, string $comment)
@@ -46,10 +42,9 @@ public function commentAsUser(?Model $user, string $comment)
             'is_approved' => ($user instanceof Commentator) ? ! $user->needsCommentApproval($this) : false,
             'user_id' => is_null($user) ? null : $user->getKey(),
             'commentable_id' => $this->getKey(),
-            'commentable_type' => get_class(),
+            'commentable_type' => get_class($this),
         ]);
 
         return $this->comments()->save($comment);
     }
-
-}
+}
diff --git a/tests/CommentsTest.php b/tests/CommentsTest.php
diff --git a/tests/Models/ApprovedUser.php b/tests/Models/ApprovedUser.php
diff --git a/tests/Models/Post.php b/tests/Models/Post.php
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -2,16 +2,15 @@`
`2`	`2`
`3`	`3`	`namespace BeyondCode\Comments\Traits;`
`4`	`4`
`5`		`-`
`6`	`5`	`trait CanComment`
`7`	`6`	`{`
`8`	`7`	`/**`
`9`	`8`	`* Check if a comment for a specific model needs to be approved.`
`10`		`- * @param mixed $model`
`11`		`- * @return bool`
	`9`	`+ *`
	`10`	`+ * @param mixed $model`
`12`	`11`	`*/`
`13`	`12`	`public function needsCommentApproval($model): bool`
`14`	`13`	`{`
`15`	`14`	`return true;`
`16`	`15`	`}`
`17`		`-}`
	`16`	`+}`