[IMP] mis_builder_kpi_code: make account code column optional

WesleyOliveira98 · WesleyOliveira98 · commit 6b7140bec604 · 2024-11-06T13:54:13.000-03:00
diff --git a/mis_builder_kpi_code/README.rst b/mis_builder_kpi_code/README.rst
@@ -7,7 +7,7 @@ MIS Builder KPI Code
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:de0015ad668a8823ac2513115d7e71cae0d60124519c91a708190607873cbf07
+   !! source digest: sha256:e08acc01e952349ee396d1373c87c16382a8be1e691f86542925bd92451a4eb9
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -22,7 +22,9 @@ MIS Builder KPI Code
 
 |badge1| |badge2| |badge3|
 
-This module includes the option to fill in the code field when creating a KPI in the MIS Report Template. This code field will be visible in the MIS Report Preview in the first column and will also be included when exporting documents to PDF or XLSX formats.
+This module includes the option to use the account code column in MIS Report.
+The column will be visible in the Preview and will also be included
+when exporting documents to PDF or XLSX formats.
 
 **Table of contents**
 
@@ -34,8 +36,9 @@ Usage
 
 To use this module, you need to:
 
-1. Fill in the code field when creating or editing a KPI in a MIS Report Template.
-2. Open a MIS Report using this Template and see the new column in Preview Mode or in the exported PDF or XLSX files.
+1. Create a MIS Report and mark the field Use Code Column.
+2. Fill in the account code in the description when creating a KPI in a MIS Report.
+3. Open a MIS Report Instance Preview and see the new column in it, or in the exported PDF or XLSX files.
 
 Bug Tracker
 ===========
diff --git a/mis_builder_kpi_code/models/mis_report.py b/mis_builder_kpi_code/models/mis_report.py
@@ -9,3 +9,19 @@ class MisReportKpi(models.Model):
     _inherit = "mis.report.kpi"
 
     code = fields.Char()
+    use_code_column = fields.Boolean(related="report_id.use_code_column")
+
+
+class MisReport(models.Model):
+
+    _inherit = "mis.report"
+
+    use_code_column = fields.Boolean(default=False)
+
+    def computed_code(self, description):
+        code = ""
+        if description:
+            first_character = description[0]
+            if first_character.isdigit():
+                code = description.split(" ")[0]
+        return code
diff --git a/mis_builder_kpi_code/models/mis_report_instance.py b/mis_builder_kpi_code/models/mis_report_instance.py
@@ -1,30 +1,41 @@
 # Copyright 2024 - TODAY, Wesley Oliveira <wesley.oliveira@escodoo.com.br>
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 
-from odoo import models
+from odoo import fields, models
 
 
 class MisReportInstance(models.Model):
 
     _inherit = "mis.report.instance"
 
+    use_code_column = fields.Boolean(related="report_id.use_code_column")
+
     def compute(self):
         self.ensure_one()
-        kpi_matrix = self._compute_matrix()
-        kpi_matrix_dict = kpi_matrix.as_dict()
-
-        empty_col = [{"label": "", "description": "", "colspan": 1}]
-        kpi_matrix_dict["header"][0]["cols"] = (
-            empty_col + kpi_matrix_dict["header"][0]["cols"]
-        )
-        kpi_matrix_dict["header"][1]["cols"] = (
-            empty_col + kpi_matrix_dict["header"][1]["cols"]
-        )
-
-        for idx, row in enumerate(kpi_matrix_dict["body"]):
-            code = self.report_id.kpi_ids.filtered(
-                lambda k: k.name == row["row_id"]
-            ).code
-            kpi_matrix_dict["body"][idx].update({"code": code})
-
-        return kpi_matrix_dict
+        if not self.use_code_column:
+            return super(MisReportInstance, self).compute()
+        else:
+            kpi_matrix = self._compute_matrix()
+            kpi_matrix_dict = kpi_matrix.as_dict()
+
+            empty_col = [{"label": "", "description": "", "colspan": 1}]
+            kpi_matrix_dict["header"][0]["cols"] = (
+                empty_col + kpi_matrix_dict["header"][0]["cols"]
+            )
+            kpi_matrix_dict["header"][1]["cols"] = (
+                empty_col + kpi_matrix_dict["header"][1]["cols"]
+            )
+
+            for idx, row in enumerate(kpi_matrix_dict["body"]):
+                label = row["label"]
+                code = self.report_id.computed_code(row["label"])
+                if code:
+                    label = label.split(" ")[1]
+                    kpi_matrix_dict["body"][idx].update(
+                        {
+                            "code": code,
+                            "label": label,
+                        }
+                    )
+
+            return kpi_matrix_dict
diff --git a/mis_builder_kpi_code/readme/DESCRIPTION.rst b/mis_builder_kpi_code/readme/DESCRIPTION.rst
@@ -1 +1,3 @@
-This module includes the option to fill in the code field when creating a KPI in the MIS Report Template. This code field will be visible in the MIS Report Preview in the first column and will also be included when exporting documents to PDF or XLSX formats.
+This module includes the option to use the account code column in MIS Report.
+The column will be visible in the Preview and will also be included
+when exporting documents to PDF or XLSX formats.
diff --git a/mis_builder_kpi_code/readme/USAGE.rst b/mis_builder_kpi_code/readme/USAGE.rst
@@ -1,4 +1,5 @@
 To use this module, you need to:
 
-1. Fill in the code field when creating or editing a KPI in a MIS Report Template.
-2. Open a MIS Report using this Template and see the new column in Preview Mode or in the exported PDF or XLSX files.
+1. Create a MIS Report and mark the field Use Code Column.
+2. Fill in the account code in the description when creating a KPI in a MIS Report.
+3. Open a MIS Report Instance Preview and see the new column in it, or in the exported PDF or XLSX files.
diff --git a/mis_builder_kpi_code/report/mis_report_instance_qweb.xml b/mis_builder_kpi_code/report/mis_report_instance_qweb.xml
@@ -22,28 +22,52 @@
             expr="//div[hasclass('mis_thead')]/div[hasclass('mis_row')][1]/div[hasclass('mis_collabel')][1]"
             position="before"
         >
-            <div class="mis_cell mis_collabel" />
+            <t t-if="o.report_id.use_code_column">
+                <div class="mis_cell mis_collabel" />
+            </t>
         </xpath>
         <xpath
             expr="//div[hasclass('mis_thead')]/div[hasclass('mis_row')][2]/div[hasclass('mis_collabel')][1]"
             position="before"
         >
-            <div class="mis_cell mis_collabel" />
+            <t t-if="o.report_id.use_code_column">
+                <div class="mis_cell mis_collabel" />
+            </t>
         </xpath>
         <xpath
             expr="//div[hasclass('mis_tbody')]/t[@t-as='row']/div[hasclass('mis_row')]/div[hasclass('mis_rowlabel')]"
-            position="before"
+            position="replace"
         >
             <div
                 t-att-style="style_obj.to_css_style(row.style_props)"
                 class="mis_cell mis_rowlabel"
             >
                 <t
-                    t-set="code"
-                    t-value="o.report_id.kpi_ids.filtered(lambda k: k.id == row.kpi.id).code"
-                />
-                <t t-esc="code or ''" />
+                    t-if="o.report_id.use_code_column and o.report_id.computed_code(row.label)"
+                >
+                    <t t-esc="row.label.split(' ')[1]" />
+                </t>
+                <t t-else="">
+                    <t t-esc="row.label" />
+                    <t t-if="row.description">
+                        <br />
+                        <t t-esc="row.description" />
+                    </t>
+                </t>
             </div>
         </xpath>
+        <xpath
+            expr="//div[hasclass('mis_tbody')]/t[@t-as='row']/div[hasclass('mis_row')]/div[hasclass('mis_rowlabel')]"
+            position="before"
+        >
+            <t t-if="o.report_id.use_code_column">
+                <div
+                    t-att-style="style_obj.to_css_style(row.style_props)"
+                    class="mis_cell mis_rowlabel"
+                >
+                    <t t-esc="o.report_id.computed_code(row.label)" />
+                </div>
+            </t>
+        </xpath>
     </template>
 </odoo>
diff --git a/mis_builder_kpi_code/report/mis_report_instance_xlsx.py b/mis_builder_kpi_code/report/mis_report_instance_xlsx.py
@@ -24,15 +24,20 @@
 class MisBuilderXlsx(models.AbstractModel):
     _inherit = "report.mis_builder.mis_report_instance_xlsx"
 
+    # flake8: noqa: C901
     def generate_xlsx_report(self, workbook, data, objects):
-
+        if not objects[0].report_id.use_code_column:
+            return super(MisBuilderXlsx, self).generate_xlsx_report(
+                workbook, data, objects
+            )
         # get the computed result of the report
         matrix = objects._compute_matrix()
         style_obj = self.env["mis.report.style"]
 
         # create worksheet
         report_name = "{} - {}".format(
-            objects[0].name, ", ".join([a.name for a in objects[0].query_company_ids])
+            objects[0].name,
+            ", ".join([a.name for a in objects[0].query_company_ids]),
         )
         sheet = workbook.add_worksheet(report_name[:31])
         row_pos = 0
@@ -78,7 +83,9 @@ def generate_xlsx_report(self, workbook, data, objects):
             else:
                 sheet.write(row_pos, col_pos, label, header_format)
                 col_width[col_pos] = max(
-                    col_width[col_pos], len(col.label or ""), len(col.description or "")
+                    col_width[col_pos],
+                    len(col.label or ""),
+                    len(col.description or ""),
                 )
             col_pos += col.colspan
         row_pos += 1
@@ -111,13 +118,13 @@ def generate_xlsx_report(self, workbook, data, objects):
             row_format = workbook.add_format(row_xlsx_style)
             col_pos = 0
 
-            code = (
-                objects[0].report_id.kpi_ids.filtered(lambda k: k.id == row.kpi.id).code
-            )
+            code = objects[0].report_id.computed_code(row.label)
             sheet.write(row_pos, col_pos, code, row_format)
             col_pos += 1
 
             label = row.label
+            if code:
+                label = label.split(" ")[1]
             if row.description:
                 label += "\n" + row.description
                 sheet.set_row(row_pos, ROW_HEIGHT * 2)
diff --git a/mis_builder_kpi_code/static/description/index.html b/mis_builder_kpi_code/static/description/index.html
@@ -367,10 +367,12 @@ <h1 class="title">MIS Builder KPI Code</h1>
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! source digest: sha256:de0015ad668a8823ac2513115d7e71cae0d60124519c91a708190607873cbf07
+!! source digest: sha256:e08acc01e952349ee396d1373c87c16382a8be1e691f86542925bd92451a4eb9
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/Escodoo/account-addons/tree/14.0/mis_builder_kpi_code"><img alt="Escodoo/account-addons" src="https://img.shields.io/badge/github-Escodoo%2Faccount--addons-lightgray.png?logo=github" /></a></p>
-<p>This module includes the option to fill in the code field when creating a KPI in the MIS Report Template. This code field will be visible in the MIS Report Preview in the first column and will also be included when exporting documents to PDF or XLSX formats.</p>
+<p>This module includes the option to use the account code column in MIS Report.
+The column will be visible in the Preview and will also be included
+when exporting documents to PDF or XLSX formats.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -388,8 +390,9 @@ <h1 class="title">MIS Builder KPI Code</h1>
 <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
 <p>To use this module, you need to:</p>
 <ol class="arabic simple">
-<li>Fill in the code field when creating or editing a KPI in a MIS Report Template.</li>
-<li>Open a MIS Report using this Template and see the new column in Preview Mode or in the exported PDF or XLSX files.</li>
+<li>Create a MIS Report and mark the field Use Code Column.</li>
+<li>Fill in the account code in the description when creating a KPI in a MIS Report.</li>
+<li>Open a MIS Report Instance Preview and see the new column in it, or in the exported PDF or XLSX files.</li>
 </ol>
 </div>
 <div class="section" id="bug-tracker">
diff --git a/mis_builder_kpi_code/views/mis_report.xml b/mis_builder_kpi_code/views/mis_report.xml
@@ -20,22 +20,8 @@
         <field name="model">mis.report</field>
         <field name="inherit_id" ref="mis_builder.mis_report_view_form" />
         <field name="arch" type="xml">
-            <xpath
-                expr="//field[@name='kpi_ids']/tree/field[@name='description']"
-                position="before"
-            >
-                <field name="code" />
-            </xpath>
-        </field>
-    </record>
-
-    <record model="ir.ui.view" id="mis_report_view_kpi_form">
-        <field name="name">mis.report.view.kpi.form (in mis_builder_kpi_code)</field>
-        <field name="model">mis.report.kpi</field>
-        <field name="inherit_id" ref="mis_builder.mis_report_view_kpi_form" />
-        <field name="arch" type="xml">
-            <xpath expr="//field[@name='description']" position="before">
-                <field name="code" />
+            <xpath expr="//field[@name='move_lines_source']" position="after">
+                <field name="use_code_column" />
             </xpath>
         </field>
     </record>
