Completed
Push — master ( 793cf7...172351 )
by P.R.
04:33
created

HyperlinkHtmlFormatter.generate()   A

Complexity

Conditions 1

Size

Total Lines 8

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 1
CRAP Score 1.125

Importance

Changes 1
Bugs 0 Features 0
Metric Value
dl 0
loc 8
ccs 1
cts 2
cp 0.5
rs 9.4285
c 1
b 0
f 0
cc 1
crap 1.125
1
"""
2
SDoc
3
4
Copyright 2016 Set Based IT Consultancy
5
6
Licence MIT
7
"""
8
# ----------------------------------------------------------------------------------------------------------------------
9 1
from sdoc.helper.Html import Html
10 1
from sdoc.sdoc2 import node_store
11 1
from sdoc.sdoc2.formatter.html.HtmlFormatter import HtmlFormatter
12
13
14 1
class HyperlinkHtmlFormatter(HtmlFormatter):
15
    """
16
    HtmlFormatter for generating HTML code for hyperlinks.
17
    """
18
    # ------------------------------------------------------------------------------------------------------------------
19 1
    def generate(self, node, file):
20
        """
21
        Generates the HTML code for a hyperlink node.
22
23
        :param sdoc.sdoc2.node.HyperlinkNode.HyperlinkNode node: The hyperlink node.
24
        :param file file: The output file.
25
        """
26
        file.write(HyperlinkHtmlFormatter.get_html(node))
27
28
    # ------------------------------------------------------------------------------------------------------------------
29 1
    @staticmethod
30
    def get_html(node):
31
        """
32
        Returns string with generated HTML tag.
33
34
        :param sdoc.sdoc2.node.HyperlinkNode.HyperlinkNode node: The hyperlink node.
35
36
        :rtype: str
37
        """
38
        return Html.generate_element('a', node.get_html_attributes(), node.argument)
39
40
# ----------------------------------------------------------------------------------------------------------------------
41
node_store.register_formatter('hyperlink', 'html', HyperlinkHtmlFormatter)
42