Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve and add more unit tests for the sidebar table of contents generator #1342

Merged
merged 15 commits into from
Mar 22, 2023
Merged

Improve and add more unit tests for the sidebar table of contents generator #1342

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
9496b81
Convert string literals to NOWDOCs
caendesilva Mar 22, 2023
963d4af
Use assertSame
caendesilva Mar 22, 2023
de2fdb9
Remove newline removals
caendesilva Mar 22, 2023
480e67d
Format HTML
caendesilva Mar 22, 2023
e96e701
Add testing helpers to strip formatting for comparison
caendesilva Mar 22, 2023
f167f19
Supress 'Unresolved fragment in a link' inspection for test file
caendesilva Mar 22, 2023
990c1c0
Inline variable
caendesilva Mar 22, 2023
5d33462
Formatting
caendesilva Mar 22, 2023
062a21d
Remove newline and trim compared values
caendesilva Mar 22, 2023
b135770
Void return
caendesilva Mar 22, 2023
bb323de
Remove newline
caendesilva Mar 22, 2023
d310118
Test non heading Markdown is removed
caendesilva Mar 22, 2023
7084563
Test with no level one heading
caendesilva Mar 22, 2023
f1a84cd
Test with multiple nested headings
caendesilva Mar 22, 2023
8400b44
Test with multiple level one headings
caendesilva Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 167 additions & 4 deletions packages/framework/tests/Feature/Actions/GeneratesSidebarTableOfContentsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<?php

/** @noinspection HtmlUnknownAnchorTarget */

declare(strict_types=1);

namespace Hyde\Framework\Testing\Feature\Actions;
Expand Down Expand Up @@ -30,11 +32,172 @@ public function testCanGenerateTableOfContents()

public function testReturnStringContainsExpectedContent()
{
$markdown = "# Level 1\n## Level 2\n### Level 3\n";
$result = (new GeneratesTableOfContents($markdown))->execute();
$markdown = <<<'MARKDOWN'
# Level 1
## Level 2
### Level 3
MARKDOWN;

$this->assertSameIgnoringIndentation(<<<'HTML'
<ul class="table-of-contents">
<li>
<a href="#level-2">Level 2</a>
<ul>
<li>
<a href="#level-3">Level 3</a>
</li>
</ul>
</li>
</ul>
HTML, (new GeneratesTableOfContents($markdown))->execute()
);
}

public function testNonHeadingMarkdownIsRemoved()
{
$expected = <<<'MARKDOWN'
# Level 1
## Level 2
### Level 3
MARKDOWN;

$actual = <<<'MARKDOWN'
# Level 1
Foo bar
## Level 2
Bar baz
### Level 3
Baz foo
MARKDOWN;

$this->assertSame(
(new GeneratesTableOfContents($expected))->execute(),
(new GeneratesTableOfContents($actual))->execute()
);
}

public function testWithNoLevelOneHeading()
{
$markdown = <<<'MARKDOWN'
## Level 2
### Level 3
MARKDOWN;

$this->assertSameIgnoringIndentation(<<<'HTML'
<ul class="table-of-contents">
<li>
<a href="#level-2">Level 2</a>
<ul>
<li>
<a href="#level-3">Level 3</a>
</li>
</ul>
</li>
</ul>
HTML, (new GeneratesTableOfContents($markdown))->execute()
);
}

public function testWithMultipleNestedHeadings()
{
$markdown = <<<'MARKDOWN'
# Level 1
## Level 2
### Level 3
#### Level 4
##### Level 5
###### Level 6

## Level 2B
### Level 3B
### Level 3C
## Level 2C
### Level 3D
MARKDOWN;

$this->assertSameIgnoringIndentation(<<<'HTML'
<ul class="table-of-contents">
<li>
<a href="#level-2">Level 2</a>
<ul>
<li>
<a href="#level-3">Level 3</a>
<ul>
<li>
<a href="#level-4">Level 4</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#level-2b">Level 2B</a>
<ul>
<li>
<a href="#level-3b">Level 3B</a>
</li>
<li>
<a href="#level-3c">Level 3C</a>
</li>
</ul>
</li>
<li>
<a href="#level-2c">Level 2C</a>
<ul>
<li>
<a href="#level-3d">Level 3D</a>
</li>
</ul>
</li>
</ul>
HTML, (new GeneratesTableOfContents($markdown))->execute()
);
}

public function testWithMultipleLevelOneHeadings()
{
$markdown = <<<'MARKDOWN'
# Level 1
## Level 2
### Level 3
# Level 1B
## Level 2B
### Level 3B
MARKDOWN;

$this->assertEquals('<ul class="table-of-contents"><li><a href="#level-2">Level 2</a><ul><li><a href="#level-3">Level 3</a></li></ul></li></ul>',
str_replace("\n", '', $result)
$this->assertSameIgnoringIndentation(<<<'HTML'
<ul class="table-of-contents">
<li>
<a href="#level-2">Level 2</a>
<ul>
<li>
<a href="#level-3">Level 3</a>
</li>
</ul>
</li>
<li>
<a href="#level-2b">Level 2B</a>
<ul>
<li>
<a href="#level-3b">Level 3B</a>
</li>
</ul>
</li>
</ul>
HTML, (new GeneratesTableOfContents($markdown))->execute()
);
}

protected function assertSameIgnoringIndentation(string $expected, string $actual): void
{
$this->assertSame(
$this->removeIndentation(trim($expected)),
$this->removeIndentation(trim($actual))
);
}

protected function removeIndentation(string $actual): string
{
return implode("\n", array_map('trim', explode("\n", $actual)));
}
}