Add ability to select measuring unit for attributes

tivaliy · tivaliy · commit c3aa06e1808b · 2017-09-15T11:50:33.000+03:00
This patch adds ability explicitly specify measuring units
(in requirements file) for paragraphs, sections and fonts size
diff --git a/examples/example_1.yaml b/examples/example_1.yaml
@@ -2,35 +2,41 @@
 styles:
   Heading 1:
     font:
-    - 14.0
-    - bold
-    - Times New Roman
+      unit: pt
+      attributes:
+      - 14
+      - bold
+      - Times New Roman
     paragraph:
-      alignment: 1
-      line_spacing: 1.0
+      unit: cm
+      attributes:
+        alignment: 1
+        line_spacing: 1
   Heading 2:
     font:
-    - 14.0
-    - bold
-    - Times New Roman
+      unit: pt
+      attributes:
+      - 14
+      - bold
+      - Times New Roman
     paragraph:
-      alignment: 0
-      line_spacing: 1.0
+      unit: cm
+      attributes:
+        alignment: 0
+        line_spacing: 1
   Normal:
     font:
-    - 14.0
-    - Times New Roman
+      unit: pt
+      attributes:
+      - 14
+      - Times New Roman
     paragraph:
-      alignment: 0
-      line_spacing: 1.0
+      unit: cm
+      attributes:
+        alignment: 0
+        line_spacing: 1
 sections:
-- right_margin: 1.0
-  start_type: 2
-  top_margin: 2.0
-  footer_distance: 1.25
-  header_distance: 1.25
-  left_margin: 2.0
-  bottom_margin: 2.0
-  orientation: 0
-  page_height: 29.7
-  page_width: 21.0
+- unit: cm
+  attributes:
+    right_margin: 1
+    start_type: 2
diff --git a/examples/example_2.yaml b/examples/example_2.yaml
@@ -2,37 +2,51 @@
 styles:
   papertitle:
     font:
-    - 14.0
-    - bold
-    - Times New Roman
+      unit: pt
+      attributes:
+      - 14.0
+      - bold
+      - Times New Roman
     paragraph:
-      alignment: 1
-      line_spacing: 0.635
-      first_line_indent: 0
+      unit: cm
+      attributes:
+        alignment: 1
+        line_spacing: 0.635
+        first_line_indent: 0
   heading1:
     font:
-    - 12.0
-    - cs_bold
-    - Times New Roman
+      unit: pt
+      attributes:
+      - 12.0
+      - cs_bold
+      - Times New Roman
     paragraph:
-      alignment: 0
-      line_spacing: 0.529
+      unit: cm
+      attributes:
+        alignment: 0
+        line_spacing: 0.529
   Normal:
     font:
-    - 10.0
-    - Times New Roman
+      unit: pt
+      attributes:
+      - 10.0
+      - Times New Roman
     paragraph:
-      alignment: 3
-      line_spacing: 1
-      first_line_indent: 0.4
+      unit: cm
+      attributes:
+        alignment: 3
+        line_spacing: 1
+        first_line_indent: 0.4
 sections:
-- right_margin: 4.4
-  start_type: 2
-  top_margin: 5.2
-  footer_distance: 4.1
-  header_distance: 0.0
-  left_margin: 4.4
-  bottom_margin: 5.2
-  orientation: 0
-  page_height: 29.7
-  page_width: 21.0
+- unit: cm
+  attributes:
+    right_margin: 4.4
+    start_type: 2
+    top_margin: 5.2
+    footer_distance: 4.1
+    header_distance: 0.0
+    left_margin: 4.4
+    bottom_margin: 5.2
+    orientation: 0
+    page_height: 29.7
+    page_width: 21.0
diff --git a/requirements.txt b/requirements.txt
@@ -3,5 +3,4 @@
 # process, which may cause wedges in the gate later.
 python-docx>=0.8.6
 PyYAML>=3.1.0 # MIT
-cliff!=1.16.0,!=1.17.0,>=1.15.0 # Apache-2.0
-jsonschema # MIT
+jsonschema # MIT
diff --git a/validocx/schema.py b/validocx/schema.py
@@ -28,17 +28,26 @@ def styles_schema(self):
                     "paragraph": {
                         "type": "object",
                         "properties": {
-                            "first_line_indent": {"type": "number"},
-                            "keep_together": {"type": "number"},
-                            "keep_with_next": {"type": "number"},
-                            "left_indent": {"type": "number"},
-                            "line_spacing": {"type": "number"},
-                            "line_spacing_rule": {"type": "number"},
-                            "page_break_before": {"type": "number"},
-                            "right_indent": {"type": "number"},
-                            "space_after": {"type": "number"},
-                            "space_before": {"type": "number"}
-                        }
+                            "unit": {"type": "string"},
+                            "attributes": {
+                                "type": "object",
+                                "properties": {
+                                    "alignment": {"type": "number"},
+                                    "first_line_indent": {"type": "number"},
+                                    "keep_together": {"type": "number"},
+                                    "keep_with_next": {"type": "number"},
+                                    "left_indent": {"type": "number"},
+                                    "line_spacing": {"type": "number"},
+                                    "line_spacing_rule": {"type": "number"},
+                                    "page_break_before": {"type": "number"},
+                                    "right_indent": {"type": "number"},
+                                    "space_after": {"type": "number"},
+                                    "space_before": {"type": "number"}
+                                },
+                                "additionalProperties": False
+                            }
+                        },
+                        "required": ["unit", "attributes"],
                     }
                 },
                 "required": ["font", "paragraph"],
@@ -52,24 +61,38 @@ def sections_schema(self):
             "items": {
                 "type": "object",
                 "properties": {
-                    "right_margin": {"type": "number"},
-                    "start_type": {"type": "number"},
-                    "top_margin": {"type": "number"},
-                    "footer_distance": {"type": "number"},
-                    "header_distance": {"type": "number"},
-                    "left_margin": {"type": "number"},
-                    "bottom_margin": {"type": "number"},
-                    "orientation": {"type": "number"},
-                    "page_height": {"type": "number"},
-                    "page_width": {"type": "number"}
+                    "unit": {"type": "string"},
+                    "attributes": {
+                        "type": "object",
+                        "properties": {
+                            "right_margin": {"type": "number"},
+                            "start_type": {"type": "number"},
+                            "top_margin": {"type": "number"},
+                            "footer_distance": {"type": "number"},
+                            "header_distance": {"type": "number"},
+                            "left_margin": {"type": "number"},
+                            "bottom_margin": {"type": "number"},
+                            "orientation": {"type": "number"},
+                            "page_height": {"type": "number"},
+                            "page_width": {"type": "number"}
+                        },
+                        "additionalProperties": False
+                    }
                 },
-                "additionalProperties": False
+                "required": ["unit", "attributes"],
             }
         }
 
     @property
     def font_schema(self):
         return {
-            "type": "array",
-            "uniqueItems": True
+            "type": "object",
+            "properties": {
+                "unit": {"type": "string"},
+                "attributes": {
+                    "type": "array",
+                    "uniqueItems": True
+                }
+            },
+            "required": ["unit", "attributes"],
         }
diff --git a/validocx/validator.py b/validocx/validator.py
@@ -30,15 +30,16 @@ def __init__(self, document):
     def validate_sections(self, section_requirements):
         """Validate sections of a document."""
 
-        for item, section in enumerate(self._docx.iter_sections()):
-            fetched_attr = self._docx.get_section_attributes(section)
-            for attr, value in section_requirements[item].items():
+        for i, section in enumerate(self._docx.iter_sections()):
+            unit = section_requirements[i]['unit']
+            fetched_attr = self._docx.get_section_attributes(section,
+                                                             unit=unit)
+            for attr, value in section_requirements[i]['attributes'].items():
                 if not math.isclose(fetched_attr[attr], value, rel_tol=1e-02):
                     msg = ("Section '{0}': attribute '{1}' with value {2} "
                            "does not match required value "
-                           "{3}".format(item, attr, fetched_attr[attr], value))
+                           "{3}".format(i, attr, fetched_attr[attr], value))
                     logger.error(msg)
-                    raise ValueError(msg)
 
     def validate_styles(self, style_requirements):
         """Validate styles of a document, i.e. font and paragraph."""
@@ -59,21 +60,25 @@ def validate_styles(self, style_requirements):
     def validate_font(self, paragraph, font_requirements):
         """Validate font in a specified paragraph."""
 
-        fetched_attr = self._docx.get_font_attributes(paragraph)
+        unit = font_requirements['unit']
+        requirements = font_requirements['attributes']
+        fetched_attr = self._docx.get_font_attributes(paragraph, unit=unit)
         for i, attr in enumerate(fetched_attr):
-            if set(attr) ^ set(font_requirements):
+            if set(attr) ^ set(requirements):
                 msg = ("Font attributes ({0}) mismatch required ({1}) in "
                        "paragraph with style '{2}':\n'{3}'".format(
                         ', '.join(str(a) for a in attr),
-                        ', '.join(str(r) for r in font_requirements),
+                        ', '.join(str(r) for r in requirements),
                         paragraph.style.name, paragraph.runs[i].text))
                 logger.error(msg)
 
     def validate_paragraph(self, paragraph, paragraph_requirements):
         """Validate paragraph."""
 
-        fetched_attr = self._docx.get_paragraph_attributes(paragraph)
-        for attr, value in paragraph_requirements.items():
+        unit = paragraph_requirements['unit']
+        fetched_attr = self._docx.get_paragraph_attributes(paragraph,
+                                                           unit=unit)
+        for attr, value in paragraph_requirements['attributes'].items():
             if fetched_attr[attr] is not None:
                 if not math.isclose(fetched_attr[attr], value, rel_tol=1e-02):
                     msg = ("The attribute of paragraph '{0}' ({1}) with value "
@@ -92,7 +97,6 @@ def validate(self, document_requirements):
 
         self._validate_schema(document_requirements,
                               self.schema.requirements_schema)
-
         logger.info("Start validating sections.")
         self.validate_sections(document_requirements['sections'])
         logger.info("Start validating styles.")
