Handle images with MsOffice by permitting using Description field for

Variable.
Add Unit test for images

Author: cyrilus

README.md

@@ -346,7 +346,7 @@ Limitation : Html is not interpreted into "shape content". For example for a tex
 
 ### image variables
 
-Add any image in the document, and put in the title of the alt text of the image
+Add any image in the document, and put in the title of the alt text of the image (If your are using MsOffice you can use the Description field)
 (properties) '$' followed by the desired name ('$image' for example to add the image 'image')
 
 ### dynamic arrays

lotemplate/Statement/ImageStatement.py

@@ -6,7 +6,6 @@
 from lotemplate.utils import get_file_url, is_network_based
 from com.sun.star.awt import Size
 
-
 class ImageStatement:
     image_regex = regex.compile(r'\$\w+')
 
@@ -17,12 +16,13 @@ def scan_image(doc: XComponent) -> dict[str, dict[str, str]]:
         :param doc: the document to scan
         :return: the scanned variables
         """
-
-        return {
-            elem.LinkDisplayName[1:]: {'type': 'image', 'value': ''}
-            for elem in doc.getGraphicObjects()
-            if ImageStatement.image_regex.fullmatch(elem.LinkDisplayName)
-        }
+        imgs = {}
+        for img in doc.getGraphicObjects():
+            if ImageStatement.image_regex.fullmatch(img.LinkDisplayName): 
+                imgs[ImageStatement.image_regex.match(img.LinkDisplayName).group(0)[1:]] = {'type': 'image', 'value': ''}
+            elif ImageStatement.image_regex.fullmatch(img.Description):
+                imgs[ImageStatement.image_regex.match(img.Description).group(0)[1:]] = {'type': 'image', 'value': ''}
+        return imgs
 
     def image_fill(doc: XComponent, graphic_provider, variable: str, path: str, should_resize=True) -> None:
         """
@@ -40,7 +40,7 @@ def image_fill(doc: XComponent, graphic_provider, variable: str, path: str, shou
             return
 
         for graphic_object in doc.getGraphicObjects():
-            if graphic_object.LinkDisplayName != variable:
+            if graphic_object.LinkDisplayName != variable and graphic_object.Description != variable :
                 continue
 
             new_image = graphic_provider.queryGraphic((PropertyValue('URL', 0, get_file_url(path), 0),))
@@ -54,4 +54,3 @@ def image_fill(doc: XComponent, graphic_provider, variable: str, path: str, shou
                 graphic_object.setSize(new_size)
 
             graphic_object.Graphic = new_image
-

lotemplate/unittest/files/content/image_docx.docx

@@ -0,0 +1,14 @@
+{
+    "Test": {
+        "type": "text",
+        "value": "OK OK"
+    },
+    "var2": {
+        "type": "image",
+        "value": "lotemplate/unittest/files/jsons/Yami_Yugi.png"
+    },
+    "var1": {
+        "type": "image",
+        "value": "lotemplate/unittest/files/jsons/Yami_Yugi.png"
+    }
+}

lotemplate/unittest/files/content/image_docx.json

@@ -0,0 +1 @@
+{"image": {"type": "image", "value": "lotemplate/unittest/files/jsons/Yami_Yugi.png"}}

lotemplate/unittest/files/content/image_odt.json

@@ -5,7 +5,7 @@
 import unittest
 import lotemplate as ot
 from lotemplate.unittest.test_function import to_data  
-
+from lotemplate.unittest.test_function import compare_image
 cnx=ot.start_multi_office()
 
 
@@ -75,7 +75,12 @@ def test_invalid_unknown_variable(self):
         Check that there is no exception anymore where there is an unknown variable in the json
         """
         self.temp.search_error(to_data("lotemplate/unittest/files/comparaison/img_vars_invalid_other_image.json"))
+    def test_image_odt(self):
+        self.assertTrue(compare_image('image_odt',cnx))
+    temp.close()
 
+    def test_image_doc(self):
+        self.assertTrue(compare_image('image_docx',cnx))
     temp.close()
 
 

lotemplate/unittest/files/content/image_odt.odt

@@ -8,7 +8,7 @@
 import os
 import json
 from pypdf import PdfReader
-
+import glob
 
 
 def file_to_dict(file_path: str) -> dict:
@@ -20,6 +20,39 @@ def file_to_dict(file_path: str) -> dict:
 def to_data(file: str):
     return ot.convert_to_datas_template(file_to_dict(file))
 
+def compare_image(name: str, cnx) :
+    base_path = 'lotemplate/unittest/files/content'
+    def get_filename(ext: str):
+        return base_path + '/' + name + '.' + ext
+
+    temp = None
+    if os.path.isfile(get_filename('ods')):
+        temp = ot.TemplateFromExt(get_filename('ods'), ot.randomConnexion(cnx), True)
+    if os.path.isfile(get_filename('odt')):
+        temp = ot.TemplateFromExt(get_filename('odt'), ot.randomConnexion(cnx), True)
+    if os.path.isfile(get_filename('docx')):
+        temp = ot.TemplateFromExt(get_filename('docx'), ot.randomConnexion(cnx), True)
+
+    if temp is None:
+        if name == 'debug':
+            return True
+        else:
+            raise FileNotFoundError('No file found for ' + name)
+
+    temp.scan()
+    temp.search_error(to_data(get_filename('json')))
+    temp.fill(file_to_dict(get_filename('json')))
+    if os.path.isfile(get_filename('unittest.html')):
+        os.remove(get_filename('unittest.html'))
+    temp.export(name+'.unittest.html',base_path, True)
+    temp.close()
+    response = filecmp.cmp(
+    "lotemplate/unittest/files/jsons/Yami_Yugi.png",
+    list(glob.iglob(base_path + '/' + name +'.unittest_html*.png'))[0],
+    shallow=False
+    )
+    return response
+
 
 def compare_files_html(name: str, cnx ):
 
@@ -31,6 +64,10 @@ def get_filename(ext: str):
     temp = None
     if os.path.isfile(get_filename('ods')):
         temp = ot.TemplateFromExt(get_filename('ods'), ot.randomConnexion(cnx), True)
+    if os.path.isfile(get_filename('odt')):
+        temp = ot.TemplateFromExt(get_filename('odt'), ot.randomConnexion(cnx), True)
+    if os.path.isfile(get_filename('docx')):
+        temp = ot.TemplateFromExt(get_filename('docx'), ot.randomConnexion(cnx), True)
 
     if temp is None:
         if name == 'debug':