Deprecate GetModelIsPrivate, replace with extender (#2587)

2025-07-30 21:20:24 +02:00 · 2021-02-04 10:56:10 -05:00
parent 9ff3afbdc5
commit 2a2abfb3fa
6 changed files with 236 additions and 14 deletions
--- a/framework/core/tests/integration/extenders/ModelPrivateTest.php
+++ b/framework/core/tests/integration/extenders/ModelPrivateTest.php
@@ -0,0 +1,121 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * For detailed copyright and license information, please view the
+ * LICENSE file that was distributed with this source code.
+ */
+
+namespace Flarum\Tests\integration\extenders;
+
+use Flarum\Discussion\Discussion;
+use Flarum\Extend;
+use Flarum\Tests\integration\RetrievesAuthorizedUsers;
+use Flarum\Tests\integration\TestCase;
+use Flarum\User\User;
+
+class ModelPrivateTest extends TestCase
+{
+    use RetrievesAuthorizedUsers;
+
+    /**
+     * @test
+     */
+    public function discussion_isnt_saved_as_private_by_default()
+    {
+        $this->app();
+
+        $user = User::find(1);
+
+        $discussion = Discussion::start('Some Discussion', $user);
+        $discussion->save();
+
+        $this->assertFalse($discussion->is_private);
+    }
+
+    /**
+     * @test
+     */
+    public function discussion_is_saved_as_private_if_privacy_checker_added()
+    {
+        $this->extend(
+            (new Extend\ModelPrivate(Discussion::class))
+                ->checker(function ($discussion) {
+                    return $discussion->title === 'Private Discussion';
+                })
+        );
+
+        $this->app();
+
+        $user = User::find(1);
+
+        $privateDiscussion = Discussion::start('Private Discussion', $user);
+        $publicDiscussion = Discussion::start('Public Discussion', $user);
+        $privateDiscussion->save();
+        $publicDiscussion->save();
+
+        $this->assertTrue($privateDiscussion->is_private);
+        $this->assertFalse($publicDiscussion->is_private);
+    }
+
+    /**
+     * @test
+     */
+    public function discussion_is_saved_as_private_if_privacy_checker_added_via_invokable_class()
+    {
+        $this->extend(
+            (new Extend\ModelPrivate(Discussion::class))
+                ->checker(CustomPrivateChecker::class)
+        );
+
+        $this->app();
+
+        $user = User::find(1);
+
+        $privateDiscussion = Discussion::start('Private Discussion', $user);
+        $publicDiscussion = Discussion::start('Public Discussion', $user);
+        $privateDiscussion->save();
+        $publicDiscussion->save();
+
+        $this->assertTrue($privateDiscussion->is_private);
+        $this->assertFalse($publicDiscussion->is_private);
+    }
+
+    /**
+     * @test
+     */
+    public function private_checkers_that_return_false_dont_matter()
+    {
+        $this->extend(
+            (new Extend\ModelPrivate(Discussion::class))
+                ->checker(function ($discussion) {
+                    return false;
+                })
+                ->checker(CustomPrivateChecker::class)
+                ->checker(function ($discussion) {
+                    return false;
+                })
+        );
+
+        $this->app();
+
+        $user = User::find(1);
+
+        $privateDiscussion = Discussion::start('Private Discussion', $user);
+        $publicDiscussion = Discussion::start('Public Discussion', $user);
+        $privateDiscussion->save();
+        $publicDiscussion->save();
+
+        $this->assertTrue($privateDiscussion->is_private);
+        $this->assertFalse($publicDiscussion->is_private);
+    }
+}
+
+class CustomPrivateChecker
+{
+    public function __invoke($discussion)
+    {
+        return $discussion->title === 'Private Discussion';
+    }
+}