framework/tests/integration/extenders/UserTest.php

<?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\Extend;
use Flarum\Tests\integration\RetrievesAuthorizedUsers;
use Flarum\Tests\integration\TestCase;
use Flarum\Tests\integration\UsesSettings;
use Flarum\User\DisplayName\DriverInterface;
use Flarum\User\User;
use Illuminate\Support\Arr;

class UserTest extends TestCase
{
    use RetrievesAuthorizedUsers;
    use UsesSettings;

    /**
     * @inheritDoc
     */
    protected function setUp(): void
    {
        parent::setUp();

        $this->prepareDatabase([
            'users' => [
                $this->normalUser(),
            ],
            'settings' => [
                ['key' => 'display_name_driver', 'value' => 'custom'],
            ]
        ]);
    }

    /**
     * Purge the settings cache and reset the new display name driver.
     */
    protected function recalculateDisplayNameDriver()
    {
        $this->purgeSettingsCache();
        $container = $this->app()->getContainer();
        $container->forgetInstance('flarum.user.display_name.driver');
        User::setDisplayNameDriver($container->make('flarum.user.display_name.driver'));
    }

    protected function registerTestPreference()
    {
        $this->extend(
            (new Extend\User())
                ->registerPreference('test', 'boolval', true)
        );
    }

    /**
     * @test
     */
    public function username_display_name_driver_used_by_default()
    {
        $this->app();
        $this->recalculateDisplayNameDriver();

        $user = User::find(1);

        $this->assertEquals('admin', $user->displayName);
    }

    /**
     * @test
     */
    public function can_use_custom_display_name_driver()
    {
        $this->extend(
            (new Extend\User)
                ->displayNameDriver('custom', CustomDisplayNameDriver::class)
        );

        $this->app();
        $this->recalculateDisplayNameDriver();

        $user = User::find(1);

        $this->assertEquals('admin@machine.local$$$suffix', $user->displayName);
    }

    /**
     * @test
     */
    public function user_has_permissions_for_expected_groups_if_no_processors_added()
    {
        $this->app();

        $user = User::find(2);

        $this->assertContains('viewUserList', $user->getPermissions());
    }

    /**
     * @test
     */
    public function processor_can_restrict_user_groups()
    {
        $this->extend((new Extend\User)->permissionGroups(function (User $user, array $groupIds) {
            return array_filter($groupIds, function ($id) {
                return $id != 3;
            });
        }));

        $this->app();

        $user = User::find(2);

        $this->assertNotContains('viewUserList', $user->getPermissions());
    }

    /**
     * @test
     */
    public function processor_can_be_invokable_class()
    {
        $this->extend((new Extend\User)->permissionGroups(CustomGroupProcessorClass::class));

        $this->app();

        $user = User::find(2);

        $this->assertNotContains('viewUserList', $user->getPermissions());
    }

    /**
     * @test
     */
    public function can_add_user_preference()
    {
        $this->registerTestPreference();

        $this->app();

        /** @var User $user */
        $user = User::find(2);
        $this->assertEquals(true, Arr::get($user->preferences, 'test'));
    }

    /**
     * @test
     */
    public function can_store_user_preference()
    {
        $this->registerTestPreference();

        $this->app();

        /** @var User $user */
        $user = User::find(2);

        $user->setPreference('test', false);

        $this->assertEquals(false, $user->getPreference('test'));
    }

    /**
     * @test
     */
    public function storing_user_preference_modified_by_transformer()
    {
        $this->registerTestPreference();

        $this->app();

        /** @var User $user */
        $user = User::find(2);

        $user->setPreference('test', []);

        $this->assertEquals(false, $user->getPreference('test'));
    }
}

class CustomDisplayNameDriver implements DriverInterface
{
    public function displayName(User $user): string
    {
        return $user->email.'$$$suffix';
    }
}

class CustomGroupProcessorClass
{
    public function __invoke(User $user, array $groupIds)
    {
        return array_filter($groupIds, function ($id) {
            return $id != 3;
        });
    }
}