printers: Add HTMLWriter

Add HTMLWriter class to enable writing HTML files. Also include HTMLWriterTest to enable testing of the class methods. Also derived work from WIP by Lasse Schuirmann (@sils1297)
coala · Mar 29, 2015 · 41f5e4a · 41f5e4a · sils · Mar 29, 2015
1 parent 9d56ef0
commit 41f5e4a
Show file tree

Hide file tree

Showing 2 changed files with 203 additions and 0 deletions.
diff --git a/coalib/output/printers/HTMLWriter.py b/coalib/output/printers/HTMLWriter.py
@@ -0,0 +1,98 @@
+class HTMLWriter:
+    """
+    Printer for outputting HTML Log files.
+
+    :param filename:            the name of the file to put the data into
+                                (string).
+    :param indentation_per_tag: spaces used to indent every subsequent HTML
+                                tag.
+    :raises TypeError:          if directory of given file doesn't exist or in
+                                case of access problems.
+    """
+
+    def __init__(self, filename, indentation_per_tag=2, indentation=0):
+        self.indentation_per_tag = indentation_per_tag
+        self.indentation = indentation
+        self.file = None
+        self.filename = filename
+
+        if not isinstance(filename, str):
+            raise TypeError("filename must be a string")
+
+        self.file = open(filename, 'w+')
+        self.__write_header()
+
+    def __del__(self):
+        # Check if the file object is NoneType, trying to close a None object
+        # does not make sense
+        if self.file is not None:
+            self.__write_footer()
+            self.file.close()
+
+    def __write_header(self):
+        self.write("<!DOCTYPE html>")
+        self.open_tag("html")
+
+    def __write_footer(self):
+        self.close_tag("html")
+
+    def write_comment(self, *comments):
+        """
+        Function for writing HTML comments in the output HTML log files.
+
+        :param comments: an arbitrary number of comments to add to the HTML
+                         log file
+        """
+        for comment in comments:
+            self.write("<!-- " + comment + " -->")
+
+    def write_tag(self, tag, content="", **tagargs):
+        """
+        Function for writing an HTML tag, along with the required tag
+        attributes and content.
+
+        :param tag:     HTML Tag for formatting the content.
+        :param content: content to output into the HTML Log file.
+        :param tagargs: arbitrary HTML tag attributes mapped to their
+                        respective values. Ordering of the tags is
+                        not preserved.
+        """
+        name = tag
+        for arg in tagargs:
+            name += " " + arg + "=\"" + tagargs[arg] + "\""
+
+        if content == "":
+            self.write("<"+name+"/>")
+            return
+
+        self.open_tag(name)
+        self.write(content)
+        self.close_tag(tag)
+
+    def open_tag(self, tag_name):
+        """
+        Function to open HTML tag. e.g. <p>
+
+        :param tag_name: the name of HTML Tag to written in the output logfile.
+        """
+        self.write("<"+tag_name+">")
+        self.indentation += 4
+
+    def close_tag(self, tag_name):
+        """
+        Function to close an open HTML tag. e.g. </p>
+
+        :param tag_name: the name of HTML Tag to be written to output logfile.
+        """
+        self.indentation -= 4
+        self.write("</"+tag_name+">")
+
+    def write(self, *args):
+        """
+        Function to write in the given output HTML log file.
+
+        :param args: arbitrary number of arguments to be written to output
+                     logfile.
+        """
+        for line in args:
+            self.file.write(" "*self.indentation + line + "\n")
diff --git a/coalib/tests/output/printers/HTMLWriterTest.py b/coalib/tests/output/printers/HTMLWriterTest.py
@@ -0,0 +1,105 @@
+import sys
+import os
+import tempfile
+import unittest
+
+sys.path.insert(0, ".")
+from coalib.output.printers.HTMLWriter import HTMLWriter
+
+
+class HTMLWriterTest(unittest.TestCase):
+    def setUp(self):
+        handle, self.filename = tempfile.mkstemp()
+        os.close(handle)  # We don't need the handle provided by mkstemp
+        self.uut = HTMLWriter(self.filename)
+
+    def tearDown(self):
+        os.remove(self.filename)
+
+    def test_construction(self):
+        self.assertRaises(TypeError, HTMLWriter, 5)
+
+    def test_printing_header_footer(self):
+        del self.uut
+        with open(self.filename) as file:
+            lines = file.readlines()
+            self.assertEqual(lines,
+                             ['<!DOCTYPE html>\n',
+                              '<html>\n',
+                              '</html>\n'])
+
+    def test_write_comment(self):
+        # Test for single comment
+        self.uut.write_comment("testing comments")
+        del self.uut
+        with open(self.filename) as file:
+            lines = file.readlines()
+
+            self.assertEqual(lines,
+                             ['<!DOCTYPE html>\n',
+                              '<html>\n',
+                              '    <!-- testing comments -->\n',
+                              '</html>\n'])
+
+        # Test for multiple comments
+        self.uut = HTMLWriter(self.filename)
+        self.uut.write_comment("test1")
+        self.uut.write_comment("test2", "test3")
+        del self.uut
+        with open(self.filename) as file:
+            lines = file.readlines()
+
+            self.assertEqual(lines,
+                             ['<!DOCTYPE html>\n',
+                              '<html>\n',
+                              '    <!-- test1 -->\n',
+                              '    <!-- test2 -->\n',
+                              '    <!-- test3 -->\n',
+                              '</html>\n'])
+
+        # Test for no comments
+        self.uut = HTMLWriter(self.filename)
+        self.uut.write_comment()
+        del self.uut
+        with open(self.filename) as file:
+            lines = file.readlines()
+
+            self.assertEqual(lines,
+                             ['<!DOCTYPE html>\n',
+                              '<html>\n',
+                              '</html>\n'])
+
+    def test_write_tag(self):
+        self.tag = "p"
+        self.content = "test"
+        self.uut.write_tag(self.tag, self.content, style="color:Yellow")
+        del self.uut
+
+        with open(self.filename) as file:
+            lines = file.readlines()
+
+            self.assertEqual(lines,
+                             ['<!DOCTYPE html>\n',
+                              '<html>\n',
+                              '    <p style="color:Yellow">\n',
+                              '        test\n',
+                              '    </p>\n',
+                              '</html>\n'])
+
+        self.uut = HTMLWriter(self.filename)
+        self.tag = "br"
+        self.content = ""
+        self.uut.write_tag(self.tag, self.content)
+        del self.uut
+
+        with open(self.filename) as file:
+            lines = file.readlines()
+
+            self.assertEqual(lines,
+                             ['<!DOCTYPE html>\n',
+                              '<html>\n',
+                              '    <br/>\n',
+                              '</html>\n'])
+
+if __name__ == '__main__':
+    unittest.main(verbosity=2)