sdoc.sdoc2.formatter.html.FigureHtmlFormatter

Complexity

Total Complexity

5

Size/Duplication

Total Lines	74
Duplicated Lines	82.43 %

Test Coverage

Coverage

46.15%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	FigureHtmlFormatter._write_caption()	17	17	3
A	FigureHtmlFormatter.write_into_file()	24	24	1
A	FigureHtmlFormatter.generate()	10	10	1

from typing import Any

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


class FigureHtmlFormatter(HtmlFormatter):

This code seems to be duplicated in your project.

    """
    HtmlFormatter for generating HTML code for figures.
    """

    # ------------------------------------------------------------------------------------------------------------------
    def generate(self, node: FigureNode, file: Any) -> None:
        """
        Generates the HTML code for a figure node.

        :param FigureNode node: The figure node.
        :param any file: The output file.
        """
        self.write_into_file(node, file)

        HtmlFormatter.generate(self, node, file)

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def _write_caption(node: FigureNode, file: Any) -> None:
        """
        Generates the caption for the table in HTML representation.

        :param FigureNode node: The figure node.
        :param any file: The output file.
        """
        if node.caption:
            figure_number = node.get_option_value('number')

            if figure_number:
                inner_text = 'Figuur {}: {}'.format(figure_number, node.caption)  # TODO Internationalization
            else:
                inner_text = node.caption

            file.write(Html.generate_element('figcaption', {}, inner_text))

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

        :param FigureNode node: The figure node.
        :param any file: The output file.
        """
        # Creating dicts with attributes for each type of element.
        figure_attributes = {'id': node.get_option_value('id')}

        img_attributes = {'src':    node.get_option_value('src'),
                          'width':  node.get_option_value('width'),
                          'height': node.get_option_value('height'),
                          'alt':    node.caption}

        # Creating elements.
        file.write(Html.generate_tag('figure', figure_attributes))

        file.write(Html.generate_void_element('img', img_attributes))

        FigureHtmlFormatter._write_caption(node, file)

        file.write('</figure>')


# ----------------------------------------------------------------------------------------------------------------------
NodeStore.register_formatter('figure', 'html', FigureHtmlFormatter)