NN2024010801/vendor/league/commonmark/tests/unit/Extension/Footnote/Renderer/FootnoteRendererTest.php

<?php

/*
 * This file is part of the league/commonmark package.
 *
 * (c) Colin O'Dell <colinodell@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace League\CommonMark\Tests\Unit\Extension\Footnote\Renderer;

use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\Footnote\FootnoteExtension;
use League\CommonMark\Extension\Footnote\Node\Footnote;
use League\CommonMark\Extension\Footnote\Renderer\FootnoteRenderer;
use League\CommonMark\Reference\Reference;
use League\CommonMark\Tests\Unit\Renderer\FakeChildNodeRenderer;
use League\Config\ConfigurationInterface;
use PHPUnit\Framework\TestCase;

final class FootnoteRendererTest extends TestCase
{
    public function testDefaultAttributes(): void
    {
        $renderer = new FootnoteRenderer();
        $renderer->setConfiguration($this->createConfiguration());

        $fakeReference = new Reference('label', 'dest', 'title');
        $footnote      = new Footnote($fakeReference);

        $output = $renderer->render($footnote, new FakeChildNodeRenderer());

        $this->assertSame('footnote', $output->getAttribute('class'));
        $this->assertSame('fn:label', $output->getAttribute('id'));
        $this->assertSame('doc-endnote', $output->getAttribute('role'));
    }

    public function testCustomClassAddedViaAST(): void
    {
        $renderer = new FootnoteRenderer();
        $renderer->setConfiguration($this->createConfiguration());

        $fakeReference = new Reference('label', 'dest', 'title');
        $footnote      = new Footnote($fakeReference);

        $footnote->data->set('attributes/class', 'custom class');

        $output = $renderer->render($footnote, new FakeChildNodeRenderer());

        $this->assertSame('custom class footnote', $output->getAttribute('class'));
    }

    public function testClassConfiguration(): void
    {
        $renderer = new FootnoteRenderer();
        $renderer->setConfiguration($this->createConfiguration(['footnote' => ['footnote_class' => 'my-custom-class']]));

        $fakeReference = new Reference('label', 'dest', 'title');
        $footnote      = new Footnote($fakeReference);

        $output = $renderer->render($footnote, new FakeChildNodeRenderer());

        $this->assertSame('my-custom-class', $output->getAttribute('class'));
    }

    public function testIdPrefixConfiguration(): void
    {
        $renderer = new FootnoteRenderer();
        $renderer->setConfiguration($this->createConfiguration(['footnote' => ['footnote_id_prefix' => 'custom-']]));

        $fakeReference = new Reference('label', 'dest', 'title');
        $footnote      = new Footnote($fakeReference);

        $output = $renderer->render($footnote, new FakeChildNodeRenderer());

        $this->assertSame('custom-label', $output->getAttribute('id'));
    }

    /**
     * @param array<string, mixed> $values
     */
    private function createConfiguration(array $values = []): ConfigurationInterface
    {
        $config = Environment::createDefaultConfiguration();
        (new FootnoteExtension())->configureSchema($config);
        $config->merge($values);

        return $config->reader();
    }
}