File: CallbackGeneratorTest.php

package info (click to toggle)
php-league-commonmark 2.7.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 8,264 kB
  • sloc: php: 20,396; xml: 1,988; ruby: 45; makefile: 21; javascript: 15
file content (111 lines) | stat: -rw-r--r-- 3,812 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<?php

declare(strict_types=1);

/*
 * 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.
 */

namespace League\CommonMark\Tests\Unit\Extension\Mention\Generator;

use League\CommonMark\Exception\LogicException;
use League\CommonMark\Extension\CommonMark\Node\Inline\Emphasis;
use League\CommonMark\Extension\Mention\Generator\CallbackGenerator;
use League\CommonMark\Extension\Mention\Mention;
use League\CommonMark\Node\Inline\Text;
use PHPUnit\Framework\TestCase;

final class CallbackGeneratorTest extends TestCase
{
    public function testWithStringReturn(): void
    {
        $generator = new CallbackGenerator(static function (Mention $mention) {
            // Stuff the three params into the URL just to prove we received them all properly
            $mention->setUrl(\sprintf('https://www.example.com/%s/%s/%s', $mention->getIdentifier(), $mention->getLabel(), $mention->getPrefix()));
            // Change the label
            $mention->setLabel('New Label');

            return $mention;
        });

        $mention = $generator->generateMention(new Mention('test', '@', 'colinodell'));

        $this->assertSame('https://www.example.com/colinodell/@colinodell/@', $mention->getUrl());

        $label = $mention->firstChild();
        \assert($label instanceof Text);
        $this->assertSame('New Label', $label->getLiteral());
    }

    public function testWithNullReturn(): void
    {
        $generator = new CallbackGenerator(static function (Mention $mention) {
            return null;
        });

        $mention = $generator->generateMention(new Mention('test', '@', 'colinodell'));

        $this->assertNull($mention);
    }

    public function testWithAbstractInlineReturn(): void
    {
        $emphasis = new Emphasis('_');
        $emphasis->appendChild(new Text('[members only]'));

        $generator = new CallbackGenerator(static function (Mention $mention) use ($emphasis) {
            // Pretend callback does some access logic to determine visibility.
            return $emphasis;
        });

        $mention = $generator->generateMention(new Mention('test', '@', 'colinodell'));

        $this->assertSame($emphasis, $mention);

        $label = $mention->firstChild();
        \assert($label instanceof Text);
        $this->assertSame('[members only]', $label->getLiteral());
    }

    public function testWithNoUrlMentionReturn(): void
    {
        $this->expectException(LogicException::class);

        $generator = new CallbackGenerator(static function (Mention $mention) {
            // This ensures that if the URL is not set, but the mention is
            // returned (which is inherited from AbstractInline, then an
            // exception is properly thrown.
            return $mention;
        });

        $generator->generateMention(new Mention('test', '@', 'colinodell'));
    }

    public function testWithNewMentionButNoUrlReturn(): void
    {
        $this->expectException(LogicException::class);

        $generator = new CallbackGenerator(static function (Mention $mention) {
            // Test what happens when returning a new mention without a URL
            return new Mention('test', '@', 'foo');
        });

        $generator->generateMention(new Mention('test', '@', 'colinodell'));
    }

    public function testWithInvalidReturn(): void
    {
        $this->expectException(LogicException::class);

        $generator = new CallbackGenerator(static function () {
            return new \stdClass(); // something that is not a string or null
        });

        $generator->generateMention(new Mention('test', '@', 'colinodell'));
    }
}