TocNode

Complexity

Total Complexity

8

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

37.5%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	is_inline_command()	0	7	1
A	get_command()	0	7	1
A	is_block_command()	0	7	1
A	__init__()	0	9	1
A	generate_toc()	0	16	4

"""
SDoc

Copyright 2016 Set Based IT Consultancy

Licence MIT
"""
# ----------------------------------------------------------------------------------------------------------------------
from sdoc.sdoc2 import node_store
from sdoc.sdoc2.node.Node import Node
from sdoc.sdoc2.node.HeadingNode import HeadingNode
from sdoc.sdoc2.node.ParagraphNode import ParagraphNode


class TocNode(Node):
    """
    SDoc2 node for table of contents.
    """

    # ------------------------------------------------------------------------------------------------------------------
    def __init__(self, io, options, argument):
        """
        Object constructor.

        :param None|cleo.styles.output_style.OutputStyle io: The IO object.
        :param dict[str,str] options: The options of this table of contents.
        :param str argument: The argument of this TOC.
        """
        super().__init__(io, 'toc', options, argument)

    # ------------------------------------------------------------------------------------------------------------------
    def get_command(self):
        """
        Returns the command of this node (i.e. toc).

        :rtype: str
        """
        return 'toc'

    # ------------------------------------------------------------------------------------------------------------------
    def is_block_command(self):
        """
        Returns False.

        :rtype: bool
        """
        return False

    # ------------------------------------------------------------------------------------------------------------------
    def is_inline_command(self):
        """
        Returns True.

        :rtype: bool
        """
        return True

    # ------------------------------------------------------------------------------------------------------------------
    def generate_toc(self):
        """
        Generates the table of contents.
        """
        self._options['ids'] = []

        for key, node in node_store.nodes.items():

The variable key seems to be unused.

            if not isinstance(node, ParagraphNode) and isinstance(node, HeadingNode):
                node.set_toc_id()

                data = {'id': node.get_option_value('id'),
                        'arg': node.argument,
                        'level': node.get_hierarchy_level(),
                        'number': node.get_option_value('number')}

                self._options['ids'].append(data)

# ----------------------------------------------------------------------------------------------------------------------
node_store.register_inline_command('toc', TocNode)