test.py

import re
import unittest

from html_toc import HtmlTocParser


def html_same(html1, html2):
    return re.sub(r"\s", "", html1) == re.sub(r"\s", "", html2)


html_example = """
<h6>a <code>very</code> small title</h6>
<h1>Title</h1>
  <h2>Title</h2>
    <h4>Another title, <strong>yes</strong>!</h4>
    <h3>中文，标题 Title&amp;</h3>
      <p>a random paragraph...<br/></p>
      &amp; &#60;
      <!-- comment -->
<h1>Another-h1-1</h1>
  <h5>a very small title</h5>
"""


class Test(unittest.TestCase):
    def test_empty(self):
        parser = HtmlTocParser()
        parser.feed("")
        assert parser.toc() == []
        assert parser.toc_html() == ""

    def test_basic(self):
        parser = HtmlTocParser()
        parser.feed('<a href="#">no-effect</a>')
        assert html_same(parser.html, '<a href="#">no-effect</a>')

        parser.feed("<h1><strong>T</strong>itle</h1>")
        assert html_same(
            parser.html,
            '<a href="#">no-effect</a><h1><a id="Title" href="#Title" '
            'class="anchor"></a><strong>T</strong>itle</h1>',
        )

    def test_complex(self):
        parser = HtmlTocParser()
        parser.feed(html_example)
        expected_toc = [
            {
                "level": 6,
                "id": "a-very-small-title",
                "text": "a very small title",
                "inner_html": "a <code>very</code> small title",
                "children": [],
            },
            {
                "level": 1,
                "id": "Title",
                "text": "Title",
                "inner_html": "Title",
                "children": [
                    {
                        "level": 2,
                        "id": "Title_1",
                        "text": "Title",
                        "inner_html": "Title",
                        "children": [
                            {
                                "level": 4,
                                "id": "Another-title-yes",
                                "text": "Another title, yes!",
                                "inner_html": "Another title, <strong>yes</strong>!",
                                "children": [],
                            },
                            {
                                "level": 3,
                                "id": "中文-标题-Title-amp",
                                "text": "中文，标题 Title&amp;",
                                "inner_html": "中文，标题 Title&amp;",
                                "children": [],
                            },
                        ],
                    }
                ],
            },
            {
                "level": 1,
                "id": "Another-h1-1",
                "text": "Another-h1-1",
                "inner_html": "Another-h1-1",
                "children": [
                    {
                        "level": 5,
                        "id": "a-very-small-title_1",
                        "text": "a very small title",
                        "inner_html": "a very small title",
                        "children": [],
                    }
                ],
            },
        ]
        assert parser.toc() == expected_toc

        expected_toc_html = """
        <ul>
        <li><a href="#Title">Title</a>
            <ul>
            <li><a href="#Title_1">Title</a></li>
            </ul>
        </li>
        <li><a href="#Another-h1-1">Another-h1-1</a>
            <ul>
            <li><a href="#a-very-small-title_1">a very small title</a></li>
            </ul>
        </li>
        </ul>
        """
        assert html_same(parser.toc_html(depth=2, lowest_level=5), expected_toc_html)


if __name__ == "__main__":
    unittest.main()