sdoc.sdoc2.formatter.html.TocHtmlFormatter

Complexity

Total Complexity

10

Size/Duplication

Total Lines	89
Duplicated Lines	85.39 %

Test Coverage

Coverage

36.84%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	TocHtmlFormatter.write_into_file()	18	18	1
A	TocHtmlFormatter.write_contents()	16	16	5
A	TocHtmlFormatter.write_elements()	20	20	3
A	TocHtmlFormatter.generate()	10	10	1

from typing import Any, Dict

from sdoc.helper.Html import Html
from sdoc.sdoc2.formatter.html.HtmlFormatter import HtmlFormatter
from sdoc.sdoc2.node.TocNode import TocNode
from sdoc.sdoc2.NodeStore import NodeStore


class TocHtmlFormatter(HtmlFormatter):

This code seems to be duplicated in your project.

    """
    HtmlFormatter for generating HTML code for table of contents.
    """

    # ------------------------------------------------------------------------------------------------------------------
    def generate(self, node: TocNode, file: Any) -> None:
        """
        Generates the HTML code for a table of contents node.

        :param TocNode node: The table of contents node.
        :param any file: The output file.
        """
        self.write_into_file(node, file)

        HtmlFormatter.generate(self, node, file)

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def write_into_file(node: TocNode, file: Any) -> None:
        """
        Writes data into opened file.

        :param TocNode node: The table of contents node.
        :param any file: The output file.
        """
        attributes = {'role': 'navigation', 'class': 'table-of-contents'}

        file.write(Html.generate_tag('nav', attributes))
        file.write(Html.generate_element('h3', {}, node.argument))

        file.write('<ul>')
        TocHtmlFormatter.write_contents(node, file)
        file.write('</ul>')

        file.write('</nav>')

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def write_contents(node: TocNode, file: Any) -> None:
        """
        Writes the contents into file.

        :param TocNode node: The table of contents node.
        :param any file: The output file.
        """
        depth = node.get_option_value('depth')

        for item in node.get_option_value('ids'):
            if depth and item['level'] <= int(depth):
                TocHtmlFormatter.write_elements(item, file)

            elif not depth:
                TocHtmlFormatter.write_elements(item, file)

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def write_elements(item: Dict[str, str], file: Any) -> None:
        """
        Write the containing elements.

        :param dict[str,str] item: The item which we outputs.
        :param any file: The output file.
        """
        class_attr = 'level{}'.format(item['level'])
        file.write(Html.generate_tag('li', {'class': class_attr}))

        file.write(Html.generate_tag('a', {'href': '#{}'.format(item['id'])}))

        number = item['number'] if item['numbering'] else None
        if number:
            file.write(Html.generate_element('span', {}, str(number)))

        file.write(' {}'.format(item['arg']))
        file.write('</a>')
        file.write('</li>')


# ----------------------------------------------------------------------------------------------------------------------
NodeStore.register_formatter('toc', 'html', TocHtmlFormatter)