sdoc.sdoc2.node.FigureNode

Complexity

Total Complexity

9

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

7 Methods

Rating	Name	Duplication	Size	Complexity
A	FigureNode.get_command()	0	7	1
A	FigureNode._get_numeration()	0	19	3
A	FigureNode.__init__()	0	8	1
A	FigureNode.is_block_command()	0	7	1
A	FigureNode._increment_last_level()	0	11	1
A	FigureNode.number()	0	12	1
A	FigureNode.is_inline_command()	0	7	1

"""
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


class FigureNode(Node):
    """
    A stub for SDoc2 node for figures.
    """
    # ------------------------------------------------------------------------------------------------------------------
    def __init__(self, options, argument):
        """
        Object constructor.

        :param dict[str,str] options: The options of this figure.
        :param str argument: Not used.
        """
        super().__init__('figure', options, argument)

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

        :rtype: str
        """
        return 'figure'

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

        :rtype: bool
        """
        return False

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

        :rtype: bool
        """
        return True

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def _get_numeration(enumerable_numbers):
        """
        Returns the current enumeration of figures.

        :param dict[str,str] enumerable_numbers: The current numbers of enumerable nodes.
        """
        chapter = HeadingNode.get_numeration(enumerable_numbers, 1)

        if 'figures' not in enumerable_numbers:
            enumerable_numbers['figures'] = '{0!s}.{1!s}'.format(chapter, '0')

        else:
            numbers_level = enumerable_numbers['figures'].split('.')
            if chapter > numbers_level[0]:
                numbers_level[0] = chapter
                numbers_level[-1] = '0'

            enumerable_numbers['figures'] = '.'.join(numbers_level)

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def _increment_last_level(enumerable_numbers):
        """
        Increments the last level of figures enumeration.

        :param dict[str,str] enumerable_numbers: The current numbers of enumerable nodes.
        """
        heading_numbers = enumerable_numbers['figures'].split('.')
        heading_numbers[-1] = str(int(heading_numbers[-1]) + 1)

        enumerable_numbers['figures'] = '.'.join(heading_numbers)

    # ------------------------------------------------------------------------------------------------------------------
    def number(self, enumerable_numbers):
        """
        Sets the number of this figure node.

        :param dict[str,str] enumerable_numbers: The current numbers of enumerable nodes.
        """
        self._get_numeration(enumerable_numbers)
        self._increment_last_level(enumerable_numbers)

        self._options['number'] = enumerable_numbers['figures']

        super().number(enumerable_numbers)

# ----------------------------------------------------------------------------------------------------------------------
node_store.register_inline_command('figure', FigureNode)