Completa as equações de custo com legendas compactas

Estende às equações de CUNIT e VC a apresentação editável com frações, subscrito e legendas de 8 pt. Preserva as notas do CUB na primeira ocorrência, inclusive junto a equações. Validado com 114 testes e renderização do corpo completo com cinco exercícios, três construções e nove tabelas comparativas.

document/equations.py

@@ -1,4 +1,4 @@
-"""Editable Word equations with compact legends for depreciation factors."""
+"""Editable Word equations with compact legends for cost and depreciation."""
 from docx.oxml import OxmlElement
 from docx.oxml.ns import qn
 from docx.enum.text import WD_ALIGN_PARAGRAPH
@@ -39,15 +39,7 @@ def _script(kind, base, script):
     return node
 
 
-def depreciation_equations(doc):
-    formulas = [
-        ([_run('Ross',True), _run(' = '), _fraction([_run('q',True), _run(' + '), _script('sSup',_run('q',True),_run('2'))],[_run('2')])],
-         'Ross: parcela de depreciação associada à idade; q: fração de vida útil consumida, obtida dividindo o percentual de vida útil consumida por 100.'),
-        ([_run('K',True),_run(' = 1 − (1 − '),_run('Ross',True),_run(') × (1 − '),_run('H',True),_run(')')],
-         'K: coeficiente de depreciação de Ross-Heidecke; H: coeficiente correspondente ao estado de conservação adotado.'),
-        ([_script('sSub',_run('K',True),_run('d',True)),_run(' = '),_run('R',True),_run(' + (1 − '),_run('K',True),_run(') × (1 − '),_run('R',True),_run(')')],
-         'Kd: fator remanescente aplicado ao custo de reedição, com consideração do valor residual; R: valor residual em forma decimal (percentual ÷ 100); K: coeficiente de depreciação.'),
-    ]
+def _formula_blocks(doc, formulas):
     for index,(elements, legend) in enumerate(formulas):
         paragraph = doc.add_paragraph()
         paragraph.alignment = WD_ALIGN_PARAGRAPH.CENTER
@@ -62,3 +54,26 @@ def depreciation_equations(doc):
                                         alinhamento=WD_ALIGN_PARAGRAPH.LEFT,espaco_depois=8)
         note.paragraph_format.keep_together = True
         note.paragraph_format.keep_with_next = index < len(formulas)-1
+
+
+def cost_equations(doc):
+    _formula_blocks(doc,[
+        ([_run('CUNIT'),_run(' = '),_run('CUB'),_run(' × '),
+          _fraction([_run('% CUB')],[_run('100')])],
+         'CUNIT: custo unitário após a adequação (R$/m²); CUB: custo unitário básico histórico (R$/m²); % CUB: percentual de adequação aplicado ao CUB.'),
+        ([_run('VC'),_run(' = '),_run('A',True),_run(' × '),_run('CUNIT'),_run(' × (1 + '),
+          _fraction([_run('BDI')],[_run('100')]),_run(') × '),_script('sSub',_run('K',True),_run('d',True))],
+         'VC: valor da construção após a depreciação (R$); A: área de cálculo (m²); CUNIT: custo unitário após a adequação (R$/m²); BDI: benefícios e despesas indiretas, em percentual; Kd: fator remanescente com consideração do valor residual.'),
+    ])
+
+
+def depreciation_equations(doc):
+    formulas = [
+        ([_run('Ross',True), _run(' = '), _fraction([_run('q',True), _run(' + '), _script('sSup',_run('q',True),_run('2'))],[_run('2')])],
+         'Ross: parcela de depreciação associada à idade; q: fração de vida útil consumida, obtida dividindo o percentual de vida útil consumida por 100.'),
+        ([_run('K',True),_run(' = 1 − (1 − '),_run('Ross',True),_run(') × (1 − '),_run('H',True),_run(')')],
+         'K: coeficiente de depreciação de Ross-Heidecke; H: coeficiente correspondente ao estado de conservação adotado.'),
+        ([_script('sSub',_run('K',True),_run('d',True)),_run(' = '),_run('R',True),_run(' + (1 − '),_run('K',True),_run(') × (1 − '),_run('R',True),_run(')')],
+         'Kd: fator remanescente aplicado ao custo de reedição, com consideração do valor residual; R: valor residual em forma decimal (percentual ÷ 100); K: coeficiente de depreciação.'),
+    ]
+    _formula_blocks(doc,formulas)

document/evolutivo.py

@@ -15,7 +15,7 @@ from .mesa_content import content_for
 from .evo_adjustments import REDUCERS, applied_reducers
 from .fundamentacao import number, global_foundation
 from .footnotes import add_footnote, add_first_footnote, order_footnotes
-from .equations import depreciation_equations
+from .equations import cost_equations, depreciation_equations
 from .formatters.table import set_table_font_size
 from .formatters.table_fit import fit_table_to_page
 from .anexos.metodologia import (_gerar_variaveis, _adicionar_pesquisa,
@@ -235,10 +235,8 @@ def gerar_corpo_evolutivo(doc, imported, num, caracteristicas_refs=None):
     refs['construcoes'] = heading(doc,num,'AVALIAÇÃO DAS CONSTRUÇÕES',2)
     heading(doc,num,'Aplicação do método da quantificação de custo',3)
     add_body_text(doc,'O custo de reedição é documentado a partir da área de cálculo, do custo unitário básico (CUB) histórico, das adequações adotadas, do BDI e da depreciação física com valor residual. Os valores e coeficientes são os registrados para cada sequência construtiva.')
-    equation(doc,'CUNIT = CUB × (% CUB / 100)')
-    equation(doc,'VC = área de cálculo × CUNIT × (1 + BDI / 100) × Kd')
+    cost_equations(doc)
     content = content_for(source(rows[0]))
-    definitions_for(doc,rows,['constructionValue','unitCost'])
     heading(doc,num,'Características das construções e áreas',4)
     for note in content.get('notas_area',[]): add_body_text(doc,note)
     groups = construction_groups(rows)

document/footnotes.py

@@ -16,6 +16,13 @@ def add_first_footnote(doc, pattern, text):
     """Attach a note immediately after the first body/table occurrence of a term."""
     for element in doc.element.body.iter(qn('w:p')):
         paragraph = Paragraph(element, doc._body)
+        if element.find('.//'+qn('m:oMath')) is not None:
+            display_text = ''.join(node.text or '' for node in element.iter()
+                                   if node.tag in (qn('w:t'),qn('m:t')))
+            if re.search(pattern,display_text):
+                # Word footnote references belong outside the math object.
+                # Keep the expression editable and place its marker after it.
+                return add_footnote(doc,paragraph,text)
         match = re.search(pattern, paragraph.text)
         if not match:
             continue

tests/test_equations.py

@@ -2,6 +2,7 @@ import copy
 import io
 import unittest
 import zipfile
+from lxml import etree
 
 from docx import Document
 from docx.oxml import parse_xml
@@ -9,15 +10,31 @@ from docx.oxml.ns import qn
 from docx.enum.text import WD_ALIGN_PARAGRAPH
 from unittest.mock import patch
 
-from document.equations import depreciation_equations
+from document.equations import cost_equations, depreciation_equations
 from document.generator import LaudoGenerator
 from document.public_text import public_text
-from document.footnotes import add_footnote
+from document.footnotes import add_footnote, add_first_footnote
 from document.formatters import add_body_text
 from test_evolutivo_documento import fixture,resolved
 
 
 class DepreciationEquationTests(unittest.TestCase):
+    def test_cost_formulas_preserve_percentage_conversion_and_first_occurrence_note(self):
+        doc=Document();cost_equations(doc)
+        formulas=list(doc.element.body.iter(qn('m:oMath')))
+        self.assertEqual(len(formulas),2)
+        self.assertEqual([''.join(t.text or '' for t in m.iter(qn('m:t'))) for m in formulas],
+                         ['CUNIT = CUB × % CUB100','VC = A × CUNIT × (1 + BDI100) × Kd'])
+        self.assertEqual(len(list(formulas[0].iter(qn('m:f')))),1)
+        self.assertEqual(len(list(formulas[1].iter(qn('m:f')))),1)
+        expression_xml=etree.tostring(formulas[0])
+        add_first_footnote(doc,r'%\s+CUB','Percentual de adequação do CUB.')
+        self.assertEqual(etree.tostring(formulas[0]),expression_xml)
+        self.assertEqual(len(list(doc.paragraphs[0]._p.iter(qn('w:footnoteReference')))),1)
+        self.assertEqual(len(list(doc.paragraphs[1]._p.iter(qn('w:footnoteReference')))),0)
+        for index in (1,3):
+            self.assertEqual({r.font.size.pt for r in doc.paragraphs[index].runs},{8})
+
     def test_editable_equations_keep_fraction_power_subscript_and_small_legends(self):
         doc=Document();depreciation_equations(doc)
         stream=io.BytesIO();doc.save(stream);stream.seek(0)

tests/test_evolutivo_documento.py

@@ -242,7 +242,7 @@ class EvolutivoDocumentTests(unittest.TestCase):
         conclusion_table(doc,imported)
         text = all_text(doc)
         for part in ['3.3 AVALIAÇÃO DO TERRENO','3.3.1.1 Variáveis','3.4 AVALIAÇÃO DAS CONSTRUÇÕES','3.4.1.3 BDI','3.5 AVALIAÇÃO DO IMÓVEL OBJETO',
-                     'Ross-Heidecke','CUNIT = CUB','Kd: fator remanescente','Unidade autônoma da gleba','Composição justificada do caso','50.000,00','4.126,73','10/2021','R$ 427.500,00','R$ 420.000,00','quatrocentos e vinte mil reais','Critério da adoção','CUB composto','Caracterização salva']:
+                     'Ross-Heidecke','CUNIT: custo unitário','Kd: fator remanescente','Unidade autônoma da gleba','Composição justificada do caso','50.000,00','4.126,73','10/2021','R$ 427.500,00','R$ 420.000,00','quatrocentos e vinte mil reais','Critério da adoção','CUB composto','Caracterização salva']:
             self.assertIn(part,text)
         self.assertNotIn('SEGREDO INTERNO',text)
         self.assertNotIn('11/2021',text)