separate data from adoc in figures

Author: JavierCladellas

src/feelpp/benchmarking/json_report/figures/controller.py

@@ -1,54 +1,91 @@
+import os, zipfile
+from typing import List, Dict, Union
+import pandas as pd
+from uuid import uuid4
+
+from feelpp.benchmarking.json_report.figures.transformationFactory import TransformationFactory
 from feelpp.benchmarking.json_report.figures.figureFactory import FigureFactory
 from feelpp.benchmarking.json_report.figures.schemas.plot import Plot
-from typing import List, Dict, Union
 
 class Controller:
-    """ Controller component , it orchestrates the model with the view"""
-    def __init__(self, df, plots_config: Union[List[Dict],Dict,Plot,List[Plot]]):
+    def __init__(self, data:pd.DataFrame, plot_config: Union[Dict,Plot]):
         """
-        Args:
-            model (pd.DataFrame): The atomic report model component
-            view (AtomicReportView): The atomic report view component
         """
-        self.df = df
-        if isinstance(plots_config,Plot):
-            self.plots_config = [plots_config]
-        elif isinstance(plots_config,Dict):
-            self.plots_config = [Plot(**plots_config)]
-        elif isinstance(plots_config,List):
-            if all(isinstance(d,Plot) for d in plots_config):
-                self.plots_config = plots_config
-            else:
-                self.plots_config = [Plot(**d) for d in plots_config]
+        self.id = uuid4().hex
+        if not isinstance(data,pd.DataFrame):
+            raise NotImplementedError(f"Data type {type(data)} not supported for Figures")
+
+        if isinstance(plot_config,Plot):
+            self.plot_config = plot_config
+        elif isinstance(plot_config,Dict):
+            self.plot_config = Plot(**plot_config)
         else:
-            raise TypeError(f"plots_config must be a Dict or List of Dicts, got {type(plots_config)}")
-        self.figures = [FigureFactory.create(plot_config) for plot_config in self.plots_config]
-
-    def generateAll(self):
-        if self.df is None or self.df.empty:
-            return []
-        return [
-            self.generateFigure(figure,plot_config.plot_types)
-            for figure,plot_config in zip(self.figures,self.plots_config)
-        ]
-
-    def generateFigure(self,figure,plot_types):
-        return {
-            "plot_types": plot_types,
-            "subfigures": [self.generateSubfigure(subfigure) for subfigure in figure]
-        }
-
-    def generateSubfigure(self, subfigure):
-        return {
-            "exports": [
-                { "display_text":"CSV", "data":[
-                    { "format":"csv", "prefix":"data","content":subfigure.createCsvs(self.df)}
-                ]},
-                { "display_text":"LaTeX", "data":[
-                    {"format":"tex","content":[{ "data":subfigure.createTex(self.df), "title":"figures" }]},
-                    {"format":"csv","content":subfigure.createCsvs(self.df)}
-
-                ]},
-            ],
-            "html": subfigure.createFigureHtml(self.df)
-        }
+            raise TypeError(f"plot_config must be a Dict or a Plot model, got {type(plot_config)}")
+
+        self.data = data #TransformationFactory.create(self.plot_config).calculate(data)
+
+        self.figures = FigureFactory.create(self.plot_config)
+
+
+    def dumpFigureJsons(self,outdir:str = ".") -> str:
+        """ Returns the path relative to outdir """
+        plotly_figs = [fig.createFigure(self.data) for fig in self.figures]
+        filepaths = []
+        for plotly_fig,plot_type in zip(plotly_figs,self.plot_config.plot_types):
+            fig_relpath = os.path.join(self.id,f"{plot_type}.json")
+            filepath = os.path.join(outdir,fig_relpath)
+
+            os.makedirs(os.path.dirname(filepath),exist_ok=True)
+
+            with open(filepath,"w") as f:
+                f.write(plotly_fig.to_json())
+
+            filepaths.append(fig_relpath)
+        return filepaths
+
+
+    def dumpFigureCsvs(self, outdir:str = ".") -> str:
+        """ Returns the path relative to outdir """
+        filepaths = []
+        for figure,plot_type in zip(self.figures,self.plot_config.plot_types):
+            fig_relpath = os.path.join(self.id,f"{plot_type}.zip")
+            filepath = os.path.join(outdir,fig_relpath)
+
+            os.makedirs(os.path.dirname(filepath), exist_ok=True)
+
+            csvs = figure.createCsvs(self.data)
+            with zipfile.ZipFile( file=filepath, mode="w", compression=zipfile.ZIP_DEFLATED, compresslevel=9) as zip_archive:
+                for csv in csvs:
+                    zip_archive.writestr(zinfo_or_arcname=f"{csv["title"]}.csv",data=csv["data"])
+
+            filepaths.append(fig_relpath)
+        return filepaths
+
+    # def generateAll(self):
+    #     if self.df is None or self.df.empty:
+    #         return []
+    #     return [
+    #         self.generateFigure(figure,plot_config.plot_types)
+    #         for figure,plot_config in zip(self.figures,self.plots_config)
+    #     ]
+
+    # def generateFigure(self,figure,plot_types):
+    #     return {
+    #         "plot_types": plot_types,
+    #         "subfigures": [self.generateSubfigure(subfigure) for subfigure in figure]
+    #     }
+
+    # def generateSubfigure(self, subfigure):
+    #     return {
+    #         "exports": [
+    #             { "display_text":"CSV", "data":[
+    #                 { "format":"csv", "prefix":"data","content":subfigure.createCsvs(self.df)}
+    #             ]},
+    #             { "display_text":"LaTeX", "data":[
+    #                 {"format":"tex","content":[{ "data":subfigure.createTex(self.df), "title":"figures" }]},
+    #                 {"format":"csv","content":subfigure.createCsvs(self.df)}
+
+    #             ]},
+    #         ],
+    #         "html": subfigure.createFigureHtml(self.df)
+    #     }

src/feelpp/benchmarking/json_report/renderer.py

@@ -45,6 +45,7 @@ def initRenderer( self) -> TemplateRenderer:
         template_path, template_filename = self.getTemplatePath( )
         renderer = TemplateRenderer( template_paths=template_path, template_filename=template_filename )
         renderer.env.globals.update( {
+            "zip":zip,
             "FiguresController":FiguresController,
             "TableController":TableController,
             "TextController":TextController

src/feelpp/benchmarking/json_report/templates/adoc/json2adoc_report.adoc.j2

@@ -6,6 +6,11 @@
 :docdatetime: {{ report.datetime }}
 {% endif %}
 
-{% import "macros/section.adoc.j2"    as section %}
 
-{{ section.render(report, report_data, 1) }}
+{% set context = {
+    "attachments_dirpath": attachments_dirpath,
+    "attachments_base_url": attachments_base_url
+} %}
+
+{% import "macros/section.adoc.j2"    as section %}
+{{ section.render(report, report_data, 1, context=context) }}

src/feelpp/benchmarking/json_report/templates/adoc/macros/grid.adoc.j2

@@ -5,7 +5,7 @@
 {% import "macros/table.adoc.j2" as table %}
 {% import "macros/itemize.adoc.j2"  as itemize %}
 
-{% macro render(gridNode,report_data) %}
+{% macro render(gridNode,report_data, context={}) %}
 {% if gridNode.id %}
 [[{{gridNode.id}}]]
 {% endif %}
@@ -19,17 +19,17 @@
 :figure-caption!:
 {%for node in gridNode.contents%}
 {% if node.type == "image" %}
-{{ image.render(node,report_data.get(node.ref), make_block=False) }}
+{{ image.render(node,report_data.get(node.ref), make_block=False, context=context) }}
 {% elif node.type == "plot" %}
-{{ plot.render(node,report_data.get(node.ref), make_block=False) }}
+{{ plot.render(node,report_data.get(node.ref), make_block=False, context=context) }}
 {% elif node.type == "latex" %}
-{{ latex.render(node,report_data.get(node.ref)) }}
+{{ latex.render(node,report_data.get(node.ref), context=context) }}
 {% elif node.type == "text" %}
-{{ text.render(node,report_data.get(node.ref)) }}
+{{ text.render(node,report_data.get(node.ref), context=context) }}
 {% elif node.type == "table" %}
-{{ table.render(node,report_data.get(node.ref)) }}
+{{ table.render(node,report_data.get(node.ref), context=context) }}
 {% elif node.type == "itemize" %}
-{{ itemize.render(node,report_data.get(node.ref)) }}
+{{ itemize.render(node,report_data.get(node.ref), context=context) }}
 {% endif %}
 {% endfor %}
 :figure-caption: Figure

src/feelpp/benchmarking/json_report/templates/adoc/macros/image.adoc.j2

@@ -1,4 +1,4 @@
-{% macro render(imageNode,data,make_block = True) %}
+{% macro render(imageNode,data,make_block = True, context={}) %}
 {% set src = imageNode.src %}
 {% set alt = imageNode.alt or imageNode.caption or "" %}
 {% set styles = imageNode.style | join(' ')%}

src/feelpp/benchmarking/json_report/templates/adoc/macros/itemize.adoc.j2

@@ -1,12 +1,12 @@
 {% import "macros/text.adoc.j2"  as text %}
 
-{% macro render(listNode,data) %}
+{% macro render(listNode,data,context={}) %}
 
 {% if listNode.id %}
 [[{{listNode.id}}]]
 {% endif %}
 {% for item in listNode.items %}
-- {{text.render(item,data)}}
+- {{text.render(item,data,context=context)}}
 {% endfor %}
 
 {% endmacro %}

src/feelpp/benchmarking/json_report/templates/adoc/macros/latex.adoc.j2

@@ -1,4 +1,4 @@
-{% macro render(latexNode,data) %}
+{% macro render(latexNode,data,context={}) %}
 
 {% if latexNode.id %}
 [[{{latexNode.id}}]]

src/feelpp/benchmarking/json_report/templates/adoc/macros/plot.adoc.j2

@@ -1,4 +1,4 @@
-{% macro render(plotNode,data, make_block=True) %}
+{% macro render(plotNode,data, make_block=True, context={}) %}
 
 
 {% if plotNode.id %}
@@ -15,38 +15,45 @@
 {% endif %}
 ++++
 
-{% for figure in FiguresController(data.get(plotNode.ref),plotNode.plot).generateAll() %}
+{% set figure_ctrl = FiguresController(data.get(plotNode.ref),plotNode.plot) %}
+{% set figure_json_paths = figure_ctrl.dumpFigureJsons(context.attachments_dirpath) %}
+{% set figure_csv_paths = figure_ctrl.dumpFigureCsvs(context.attachments_dirpath) %}
 <div class='figure-container'>
-    {% if figure.plot_types | length > 1%}
+    {% if figure_ctrl.plot_config.plot_types | length > 1%}
     <div class='tabs-container'>
-    {% for plot_type in figure.plot_types %}
+    {% for plot_type in figure_ctrl.plot_config.plot_types %}
     {% set plot_type_i = loop.index %}
         <button class='figure-tab' onclick='switchTab(this, {{plot_type_i}})'>{{plot_type}}</button>
     {% endfor %}
     </div>
     {% endif %}
 
-    {% for subfigure in figure.subfigures %}
-      <div class="subfigure-container {% if loop.first %}active{% else %}inactive{% endif %}" data-subfigure="{{loop.index}}">
-        {{subfigure.html}}
-
-        <div class='export-container'>
-        {% for export in subfigure.exports %}
-            <button onclick='downloadData({{export.data | tojson | stripquotes}},"download.zip")' >
-                {{export.display_text}}
-            </button>
-        {% endfor %}
-        </div>
-
+{% for subfigure_json_path, subfigure_csv_path in zip(figure_json_paths,figure_csv_paths) %}
+    <div class="subfigure-container {% if loop.first %}active{% else %}inactive{% endif %}" data-subfigure="{{loop.index}}">
+        <div id="graph-div-{{figure_ctrl.id}}-{{loop.index}}"> </div>
     </div>
-    {% endfor %}
-
-    {%if plotNode.caption and make_block==False %}
-    <div class='plotly-figure-caption title'>{{plotNode.caption}}</div>
-    {% endif %}
+    <div class='export-container'>
+        <a href='{% if context.attachments_base_url %}{{context.attachments_base_url}}/{{subfigure_csv_path}}{% else %}{{context.attachments_dirpath}}/{{subfigure_csv_path}}{%endif%}' download>CSV<a/>
+    </div>
+{% endfor %}
 </div>
 
+
+<script>
+{% for subfigure_json_path in figure_json_paths %}
+    fetch('{% if context.attachments_base_url %}{{context.attachments_base_url}}/{{subfigure_json_path}}{% else %}{{context.attachments_dirpath}}/{{subfigure_json_path}}{%endif%}')
+    .then(response => response.json())
+    .then(figure_json => {
+        Plotly.newPlot('graph-div-{{figure_ctrl.id}}-{{loop.index}}',figure_json);
+    })
+    .catch(err => console.error(err));
 {% endfor %}
+</script>
+
+{%if plotNode.caption and make_block==False %}
+<div class='plotly-figure-caption title'>{{plotNode.caption}}</div>
+{% endif %}
+
 
 ++++
 {% if make_block %}

src/feelpp/benchmarking/json_report/templates/adoc/macros/section.adoc.j2

@@ -15,7 +15,7 @@
     "itemize": itemize.render
 } %}
 
-{% macro render(sectionNode, report_data, level=1) %}
+{% macro render(sectionNode, report_data, level=1, context={}) %}
 
 {% if sectionNode.id %}
 [[{{sectionNode.id}}]]
@@ -26,13 +26,13 @@
 
 {% for node in sectionNode.contents %}
 {% if node.type == "section" %}
-{{ render(node, report_data, level + 1) }}
+{{ render(node, report_data, level + 1,context=context) }}
 {% elif node.type == "grid" %}
-{{ grid.render(node, report_data ) }}
+{{ grid.render(node, report_data,context=context) }}
 {% else %}
 {% set handler = handlers.get(node.type) %}
 {% if handler %}
-{{ handler(node,report_data.get(node.ref)) }}
+{{ handler(node,report_data.get(node.ref),context=context) }}
 {% endif %}
 {% endif %}
 {% endfor %}

src/feelpp/benchmarking/json_report/templates/adoc/macros/table.adoc.j2

@@ -1,4 +1,4 @@
-{% macro render(tableNode, data) %}
+{% macro render(tableNode, data, context={}) %}
 
 {%set table_controller = TableController(data.get(tableNode.ref),tableNode.layout, tableNode.style) %}
 {%set table = table_controller.generate() %}