Merge pull request #1 from xhtml2pdf/develop

Develop

tests/test_tables.py

@@ -0,0 +1,342 @@
+import unittest
+from xml.dom import minidom
+
+from xhtml2pdf import tables
+from xhtml2pdf.context import pisaContext
+from xhtml2pdf.parser import AttrContainer
+
+
+class TablesWidthTestCase(unittest.TestCase):
+
+    def test_width_returns_none_if_value_passed_is_none(self):
+        result = tables._width(None)
+        self.assertEqual(result, None)
+
+    def test_width_returns_values_passed_if_string_and_ends_with_percent(self):
+        result = tables._width("100%")
+        self.assertEqual(result, "100%")
+
+    def test_width_will_convert_string_to_float_if_string_passed_in_doesnt_end_with_percent(self):
+        result = tables._width("100")
+        self.assertEqual(type(result), float)
+
+    def test_width_returns_float_if_string_contains_string_of_number(self):
+        result = tables._width("130")
+        self.assertEqual(result, 130.0)
+
+
+class TablesHeightTestCase(unittest.TestCase):
+
+    def test_width_returns_none_if_value_passed_is_none(self):
+        result = tables._height(None)
+        self.assertEqual(result, None)
+
+    def test_width_returns_values_passed_if_string_and_ends_with_percent(self):
+        result = tables._height("100%")
+        self.assertEqual(result, "100%")
+
+    def test_width_will_convert_string_to_float_if_string_passed_in_doesnt_end_with_percent(self):
+        result = tables._height("100")
+        self.assertEqual(type(result), float)
+
+    def test_width_returns_X_if_string(self):
+        result = tables._height("100")
+        self.assertEqual(result, 100.0)
+
+
+class TableDataTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.sut = tables.TableData
+
+    def test_init_defines_variables(self):
+        instance = self.sut()
+        self.assertEqual(instance.data, [])
+        self.assertEqual(instance.styles, [])
+        self.assertEqual(instance.span, [])
+        self.assertEqual(instance.mode, "")
+        self.assertEqual(instance.padding, 0)
+        self.assertEqual(instance.col, 0)
+
+    def test_add_cell_will_increment_col_and_append_data_to_instance_data(self):
+        instance = self.sut()
+        instance.data.append([])
+        instance.add_cell("Foo")
+        self.assertEqual(instance.data, [["Foo"]])
+        self.assertEqual(instance.col, 1)
+
+    def test_add_style_will_append_shallow_copy_of_passed_in_data(self):
+        instance = self.sut()
+        style_one = "bold"
+        style_two = "italic"
+        style_three = "foo"
+        instance.add_style(style_one)
+        self.assertEqual(instance.styles, ["bold"])
+        instance.add_style(style_two)
+        instance.add_style(style_three)
+        self.assertEqual(instance.styles, ["bold", "italic", "foo"])
+
+    def test_add_empty_will_add_tuple_of_args_to_span_instance_variable(self):
+        instance = self.sut()
+        instance.add_empty(1, 3)
+        self.assertEqual(instance.span, [(1, 3)])
+
+    def test_get_data_will_return_data_instance_variable_if_no_styles(self):
+        instance = self.sut()
+        instance.data.append([])
+        instance.add_cell("Foo")
+        data = instance.get_data()
+        self.assertEqual(data, [["Foo"]])
+
+    def test_get_data_will_add_empty_strings_where_they_have_been_defined_by_add_empty(self):
+        instance = self.sut()
+        instance.data.append([])
+        instance.add_cell("Foo")
+        instance.add_cell("Bar")
+        instance.add_empty(0, 0)
+        data = instance.get_data()
+        self.assertEqual(data, [["", "Foo", "Bar"]])
+
+    def test_get_data_will_fail_silently_if_invalid_empty_cell_found(self):
+        instance = self.sut()
+        instance.data.append([])
+        instance.add_cell("Foo")
+        instance.add_cell("Bar")
+        instance.add_empty(0, 2)
+        data = instance.get_data()
+        self.assertEqual(data, [["Foo", "Bar"]])
+
+    def test_add_cell_styles_will_add_padding_styles_based_on_frag_padding_attrs(self):
+        context = pisaContext([])
+        context.frag.paddingRight = 5
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="td")
+        self.assertEqual(instance.styles[0], ('LEFTPADDING', (0, 1), (3, 5), 0))
+        self.assertEqual(instance.styles[1], ('RIGHTPADDING', (0, 1), (3, 5), 5))
+        self.assertEqual(instance.styles[2], ('TOPPADDING', (0, 1), (3, 5), 0))
+        self.assertEqual(instance.styles[3], ('BOTTOMPADDING', (0, 1), (3, 5), 0))
+
+    def test_add_cell_styles_will_add_background_style_if_context_frag_has_backcolor_set_and_mode_is_not_tr(self):
+        context = pisaContext([])
+        context.frag.backColor = "green"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="td")
+        self.assertEqual(instance.styles[0], ('BACKGROUND', (0, 1), (3, 5), 'green'))
+
+    def test_add_cell_styles_will_not_add_background_style_if_context_frag_has_backcolor_set_and_mode_is_tr(self):
+        context = pisaContext([])
+        context.frag.backColor = "green"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0], ('BACKGROUND', (0, 1), (3, 5), 'green'))
+
+    def test_add_cell_styles_will_add_lineabove_style_if_bordertop_attrs_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderTopStyle = "solid"
+        context.frag.borderTopWidth = "3px"
+        context.frag.borderTopColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertEqual(instance.styles[0], ('LINEABOVE', (0, 1), (3, 1), '3px', 'black', 'squared'))
+
+    def test_add_cell_styles_will_not_add_lineabove_style_if_bordertop_style_not_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderTopWidth = "3px"
+        context.frag.borderTopColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEABOVE')
+
+    def test_add_cell_styles_will_not_add_lineabove_style_if_bordertop_width_not_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderTopStyle = "solid"
+        context.frag.borderTopWidth = 0
+        context.frag.borderTopColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEABOVE')
+
+    def test_add_cell_styles_will_not_add_lineabove_style_if_bordertop_color_not_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderTopStyle = "solid"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEABOVE')
+
+    def test_add_cell_styles_will_add_linebefore_style_if_borderleft_attrs_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderLeftStyle = "solid"
+        context.frag.borderLeftWidth = "3px"
+        context.frag.borderLeftColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertEqual(instance.styles[0], ('LINEBEFORE', (0, 1), (0, 5), '3px', 'black', 'squared'))
+
+    def test_add_cell_styles_will_not_add_linebefore_style_if_borderleft_style_not_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderLeftWidth = "3px"
+        context.frag.borderLeftColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEBEFORE')
+
+    def test_add_cell_styles_will_not_add_linebefore_style_if_borderleft_width_set_to_zero_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderLeftStyle = "solid"
+        context.frag.borderLeftWidth = 0
+        context.frag.borderLeftColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEBEFORE')
+
+    def test_add_cell_styles_will_not_add_linebefore_style_if_borderleft_width_not_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderLeftStyle = "solid"
+        context.frag.borderLeftWidth = "3px"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEBEFORE')
+
+    def test_add_cell_styles_will_add_lineafter_style_if_borderright_attrs_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderRightStyle = "solid"
+        context.frag.borderRightWidth = "3px"
+        context.frag.borderRightColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertEqual(instance.styles[0], ('LINEAFTER', (3, 1), (3, 5), '3px', 'black', 'squared'))
+
+    def test_add_cell_styles_will_not_add_lineafter_style_if_borderright_style_not_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderRightWidth = "3px"
+        context.frag.borderRightColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEAFTER')
+
+    def test_add_cell_styles_will_not_add_lineafter_style_if_borderright_width_set_to_zero_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderRightStyle = "solid"
+        context.frag.borderRightWidth = 0
+        context.frag.borderRightColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEAFTER')
+
+    def test_add_cell_styles_will_not_add_lineafter_style_if_borderright_color_not_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderRightStyle = "solid"
+        context.frag.borderRightWidth = "3px"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEAFTER')
+
+    def test_add_cell_styles_will_add_linebelow_style_if_borderbottom_attrs_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderBottomStyle = "solid"
+        context.frag.borderBottomWidth = "3px"
+        context.frag.borderBottomColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertEqual(instance.styles[0], ('LINEBELOW', (0, 5), (3, 5), '3px', 'black', 'squared'))
+
+    def test_add_cell_styles_will_not_add_linebelow_style_if_borderbottom_style_not_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderBottomWidth = "3px"
+        context.frag.borderBottomColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEBELOW')
+
+    def test_add_cell_styles_will_not_add_linebelow_style_if_borderbottom_width_set_to_zero_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderBottomStyle = "solid"
+        context.frag.borderBottomWidth = 0
+        context.frag.borderBottomColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEBELOW')
+
+    def test_add_cell_styles_will_not_add_linebelow_style_if_borderbottom_color_not_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderBottomStyle = "solid"
+        context.frag.borderBottomWidth = "3px"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertNotEqual(instance.styles[0][0], 'LINEBELOW')
+
+    def test_add_cell_styles_will_add_all_line_styles_if_all_border_attrs_set_on_context_frag(self):
+        context = pisaContext([])
+        context.frag.borderTopStyle = "solid"
+        context.frag.borderTopWidth = "3px"
+        context.frag.borderTopColor = "black"
+        context.frag.borderLeftStyle = "solid"
+        context.frag.borderLeftWidth = "3px"
+        context.frag.borderLeftColor = "black"
+        context.frag.borderRightStyle = "solid"
+        context.frag.borderRightWidth = "3px"
+        context.frag.borderRightColor = "black"
+        context.frag.borderBottomStyle = "solid"
+        context.frag.borderBottomWidth = "3px"
+        context.frag.borderBottomColor = "black"
+        instance = self.sut()
+        instance.add_cell_styles(context, (0, 1), (3, 5), mode="tr")
+        self.assertEqual(instance.styles[0], ('LINEABOVE', (0, 1), (3, 1), '3px', 'black', 'squared'))
+        self.assertEqual(instance.styles[1], ('LINEBEFORE', (0, 1), (0, 5), '3px', 'black', 'squared'))
+        self.assertEqual(instance.styles[2], ('LINEAFTER', (3, 1), (3, 5), '3px', 'black', 'squared'))
+        self.assertEqual(instance.styles[3], ('LINEBELOW', (0, 5), (3, 5), '3px', 'black', 'squared'))
+
+
+class PisaTagTableTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.element = self._getElement("rootElement")
+        self.attrs = AttrContainer({"border": "", "bordercolor": "", "cellpadding": "", "align": "", "repeat": "", "width": ""})
+
+    def _getElement(self, tagName, body="filler"):
+        dom = minidom.parseString("<{}>{}</{}>".format(tagName, body, tagName))
+        return dom.getElementsByTagName(tagName)[0]
+
+    def test_will_set_attrs_on_tabledata(self):
+        self.attrs.cellpadding = 4
+        self.attrs.align = "left"
+        self.attrs.repeat = True
+        self.attrs.width = 100
+        tag = tables.pisaTagTABLE(self.element, self.attrs)
+        context = pisaContext([])
+        tag.start(context)
+        self.assertEqual(context.tableData.padding, 4)
+        self.assertEqual(context.tableData.styles[0], ('LEFTPADDING', (0, 0), (-1, -1), 4))
+        self.assertEqual(context.tableData.styles[1], ('RIGHTPADDING', (0, 0), (-1, -1), 4))
+        self.assertEqual(context.tableData.styles[2], ('TOPPADDING', (0, 0), (-1, -1), 4))
+        self.assertEqual(context.tableData.styles[3], ('BOTTOMPADDING', (0, 0), (-1, -1), 4))
+        self.assertEqual(context.tableData.align, "LEFT")
+        self.assertEqual(context.tableData.col, 0)
+        self.assertEqual(context.tableData.row, 0)
+        self.assertEqual(context.tableData.colw, [])
+        self.assertEqual(context.tableData.rowh, [])
+        self.assertEqual(context.tableData.repeat, True)
+        self.assertEqual(context.tableData.width, 100.0)
+
+    def test_start_will_add_borders_if_border_and_border_color_set_in_attrs(self):
+        self.attrs.border = 2
+        self.attrs.bordercolor = "green"
+        tag = tables.pisaTagTABLE(self.element, self.attrs)
+        context = pisaContext([])
+        tag.start(context)
+        self.assertEqual(context.frag.borderLeftWidth, 2)
+        self.assertEqual(context.frag.borderRightWidth, 2)
+        self.assertEqual(context.frag.borderTopWidth, 2)
+        self.assertEqual(context.frag.borderBottomWidth, 2)
+        self.assertEqual(context.frag.borderLeftColor, "green")
+        self.assertEqual(context.frag.borderRightColor, "green")
+        self.assertEqual(context.frag.borderTopColor, "green")
+        self.assertEqual(context.frag.borderBottomColor, "green")
+        self.assertEqual(context.frag.borderLeftStyle, "solid")
+        self.assertEqual(context.frag.borderRightStyle, "solid")
+        self.assertEqual(context.frag.borderTopStyle, "solid")
+        self.assertEqual(context.frag.borderBottomStyle, "solid")
+
+
+if __name__ == "__main__":
+    unittest.main()

tests/test_tags.py

@@ -0,0 +1,17 @@
+import unittest
+from xml.dom import minidom
+
+from xhtml2pdf import tags
+from xhtml2pdf.parser import AttrContainer
+
+
+class PisaTagTestCase(unittest.TestCase):
+
+    def test_pisa_tag_will_set_attrs_on_init(self):
+        dom = minidom.parseString("<unit>test</unit>")
+        element = dom.getElementsByTagName("unit")[0]
+        attrs = AttrContainer({})
+        instance = tags.pisaTag(element, attrs)
+        self.assertEqual(instance.node, element)
+        self.assertEqual(instance.tag, "unit")
+        self.assertEqual(instance.attr, {})

tests/test_utils.py

@@ -2,7 +2,7 @@
 from reportlab.lib.colors import Color
 from unittest import TestCase
 from xhtml2pdf.util import getCoords, getColor, getSize, getFrameDimensions, \
-    getPos, getBox, pisaTempFile
+    getPos, getBox, pisaTempFile, getBorderStyle
 from xhtml2pdf.tags import int_to_roman
 
 class UtilsCoordTestCase(TestCase):
@@ -258,3 +258,18 @@ def test_unicode(self):
             src.write(value)
         except UnicodeDecodeError as error:
             self.fail(error)
+
+
+class GetBorderStyleTestCase(TestCase):
+
+    def test_will_return_value_if_passed_value_is_not_none_or_hidden(self):
+        style = getBorderStyle("foo", default="blah")
+        self.assertEqual(style, "foo")
+
+    def test_will_return_default_if_passed_value_is_non_case_sensitive_none(self):
+        style = getBorderStyle("None", default="blah")
+        self.assertEqual(style, "blah")
+
+    def test_will_return_default_if_passed_value_is_non_case_sensitive_hidden(self):
+        style = getBorderStyle("hidDen", default="defaultPassedArg")
+        self.assertEqual(style, "defaultPassedArg")