Estiliza equações de depreciação e retira referências à ferramenta interna

Ross, K e Kd são equações editáveis com fração, expoente, subscrito e legendas de 8 pt. Remove menções à ferramenta e à versão do catálogo do laudo, preservando as fontes técnicas internas e os dados de origem. Validado com 113 testes e conferência visual.

document/equations.py

@@ -0,0 +1,64 @@
+"""Editable Word equations with compact legends for depreciation factors."""
+from docx.oxml import OxmlElement
+from docx.oxml.ns import qn
+from docx.enum.text import WD_ALIGN_PARAGRAPH
+from docx.shared import Pt, RGBColor
+
+from .formatters.paragraph import criar_paragrafo_formatado
+
+
+def _run(text, variable=False):
+    run = OxmlElement('m:r')
+    props = OxmlElement('m:rPr')
+    style = OxmlElement('m:sty'); style.set(qn('m:val'), 'i' if variable else 'p')
+    props.append(style); run.append(props)
+    font_props = OxmlElement('w:rPr')
+    font = OxmlElement('w:rFonts')
+    font.set(qn('w:ascii'), 'Cambria Math'); font.set(qn('w:hAnsi'), 'Cambria Math')
+    font_props.append(font)
+    size = OxmlElement('w:sz'); size.set(qn('w:val'), '28'); font_props.append(size)
+    run.append(font_props)
+    value = OxmlElement('m:t'); value.text = text
+    value.set(qn('xml:space'), 'preserve'); run.append(value)
+    return run
+
+
+def _fraction(numerator, denominator):
+    fraction = OxmlElement('m:f')
+    for name, children in [('num', numerator), ('den', denominator)]:
+        node = OxmlElement('m:' + name)
+        for child in children: node.append(child)
+        fraction.append(node)
+    return fraction
+
+
+def _script(kind, base, script):
+    node = OxmlElement('m:' + kind)
+    for name, child in [('e', base), ('sup' if kind=='sSup' else 'sub', script)]:
+        content = OxmlElement('m:' + name); content.append(child); node.append(content)
+    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.'),
+    ]
+    for index,(elements, legend) in enumerate(formulas):
+        paragraph = doc.add_paragraph()
+        paragraph.alignment = WD_ALIGN_PARAGRAPH.CENTER
+        paragraph.paragraph_format.space_before = Pt(10)
+        paragraph.paragraph_format.space_after = Pt(4)
+        paragraph.paragraph_format.keep_with_next = True
+        paragraph.paragraph_format.keep_together = True
+        math = OxmlElement('m:oMath')
+        for element in elements: math.append(element)
+        paragraph._p.append(math)
+        note = criar_paragrafo_formatado(doc,legend,tamanho=8,cor=RGBColor(70,70,70),
+                                        alinhamento=WD_ALIGN_PARAGRAPH.LEFT,espaco_depois=8)
+        note.paragraph_format.keep_together = True
+        note.paragraph_format.keep_with_next = index < len(formulas)-1

document/evolutivo.py

@@ -15,6 +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 .formatters.table import set_table_font_size
 from .formatters.table_fit import fit_table_to_page
 from .anexos.metodologia import (_gerar_variaveis, _adicionar_pesquisa,
@@ -247,14 +248,12 @@ def gerar_corpo_evolutivo(doc, imported, num, caracteristicas_refs=None):
     construction_cub_notes(doc,groups)
     heading(doc,num,'BDI e justificativa',4)
     definitions_for(doc,rows,['bdi'])
-    add_body_text(doc,'O BDI informado em percentual é convertido no multiplicador 1 + BDI/100. As referências gerais da MESA orientam a análise; não constituem, por si, uma composição de BDI efetivamente adotada.')
+    add_body_text(doc,'O BDI informado em percentual é convertido no multiplicador 1 + BDI/100. Os percentuais de referência orientam a análise; não constituem, por si, uma composição de BDI efetivamente adotada.')
     construction_bdi_notes(doc,groups)
     heading(doc,num,'Depreciação e conservação',4)
-    definitions_for(doc,rows,['depreciation','residual','kd','conservation'])
-    add_body_text(doc,'Na expressão de Ross-Heidecke, q é a fração de vida útil consumida e H é o coeficiente de conservação. K representa a depreciação; R é o residual em forma decimal; Kd é o fator remanescente aplicado ao custo.')
-    equation(doc,'q = percentual de vida útil / 100; Ross = q/2 + q²/2')
-    equation(doc,'K = 1 − (1 − Ross) × (1 − H); Kd = R + (1 − K) × (1 − R)')
-    add_body_text(doc,'A MESA registra a curva de Ross com seis casas decimais, K com quatro e Kd com três. Os resultados abaixo são transcritos dos registros salvos, sem recompor os valores a partir de coeficientes arredondados para exibição.')
+    add_body_text(doc,'A depreciação física considera a vida útil consumida e o estado de conservação, pelo método de Ross-Heidecke. O valor residual integra o fator remanescente aplicado ao custo de reedição.').paragraph_format.keep_with_next = True
+    depreciation_equations(doc)
+    add_body_text(doc,'Os resultados apresentados são os registrados na avaliação, sem recomposição a partir dos coeficientes arredondados para exibição.')
     construction_depreciation_notes(doc,groups)
     heading(doc,num,'Cálculo por construção e exercício',4)
     for entries in groups.values():
@@ -444,7 +443,7 @@ def construction_bdi_notes(doc, groups):
             notes.setdefault('Justificativa do BDI: '+note,[]).append((row,c,i))
             reference = next((item for item in content_for(source(row))['referencias'].get('bdiTiposConstrucao',[]) if item.get('tipo')==c.get('tipoConstrucao')),None)
             if reference:
-                notes.setdefault(f"Referência da MESA para {reference['tipo']}: BDI {reference['bdi']}. O percentual adotado consta no quadro de cálculo.",[]).append((row,c,i))
+                notes.setdefault(f"Referência técnica para {reference['tipo']}: BDI {reference['bdi']}. O percentual adotado consta no quadro de cálculo.",[]).append((row,c,i))
             composition = c.get('bdiComposicaoAdotada')
             if isinstance(composition,list) and composition:
                 details = [{key:item.get(key) for key in ('descricao','percentual')} for item in composition]
@@ -581,14 +580,6 @@ def gerar_especificacao_evolutivo(doc,imported,refs):
         first = foundations[rows[0]['id']][key] if key else foundations[rows[0]['id']]
         compared(doc,rows,[(item['label'],lambda row,i=index,k=key: (foundations[row['id']][k] if k else foundations[row['id']])['items'][i]['grade'] + ' / ' + str((foundations[row['id']][k] if k else foundations[row['id']])['items'][i]['points'] if (foundations[row['id']][k] if k else foundations[row['id']])['items'][i]['points'] is not None else '—') + ' ponto(s)') for index,item in enumerate(first['items'])])
         grouped_notes(doc,rows,lambda row,k=key: ' '.join(f"{item['label']}: {item['detail']}" for item in (foundations[row['id']][k] if k else foundations[row['id']])['items']),'Evidências e critérios')
-    content_versions = OrderedDict()
     for row in rows:
         f = foundations[row['id']]['terrain']
         if f.get('missingRequirements'): add_body_text(doc,f"{ref(row)} — o Grau III do terreno depende da declaração dos requisitos adicionais; enquadramento pendente.")
-        catalog = content_for(source(row))
-        saved = source(row).get('documentacaoTecnica')
-        note = f"Conteúdo técnico MESA, versão documental {catalog['versao']}, identificação {catalog['identificador']}. " + ('Pacote identificado na exportação; dados e referências históricas do cálculo preservados.' if saved and saved.get('origem') == 'catalogo_exportacao' else 'Pacote preservado na avaliação.' if saved else 'Arquivo sem pacote documental histórico identificado; utilizadas as explicações gerais do catálogo sincronizado, preservando os dados e as referências de cálculo salvos.')
-        content_versions.setdefault(note,[]).append(ref(row))
-    for note,references in content_versions.items():
-        paragraph = add_body_text(doc,note + (f" Aplicável a {', '.join(references)}." if len(content_versions)>1 else ''))
-        paragraph.paragraph_format.keep_together = True

document/footnotes.py

@@ -9,6 +9,7 @@ from docx.shared import Pt
 from docx.text.paragraph import Paragraph
 from copy import deepcopy
 import re
+from .public_text import public_text
 
 
 def add_first_footnote(doc, pattern, text):
@@ -72,6 +73,7 @@ def order_footnotes(doc):
 
 
 def add_footnote(doc, paragraph, text):
+    text = public_text(text)
     try:
         part = doc.part.part_related_by(RT.FOOTNOTES)
         root = parse_xml(part.blob)

document/formatters/paragraph.py

@@ -5,6 +5,7 @@ from docx import Document
 from docx.shared import Pt, Inches, Cm, RGBColor
 from docx.enum.text import WD_ALIGN_PARAGRAPH
 from typing import Optional, Tuple, Union
+from ..public_text import public_text
 
 
 def aplicar_cor_run(run, cor: Optional[Union[Tuple[int, int, int], RGBColor]]) -> None:
@@ -56,7 +57,7 @@ def criar_paragrafo_formatado(
         Parágrafo criado
     """
     p = doc.add_paragraph()
-    run = p.add_run(texto)
+    run = p.add_run(public_text(texto))
 
     run.bold = negrito
     run.underline = sublinhado

document/formatters/table.py

@@ -11,6 +11,7 @@ from collections.abc import Sequence as SequenceABC
 from typing import List, Optional, Sequence, Union, Dict, Any
 
 from .paragraph import aplicar_cor_run
+from ..public_text import public_text
 
 WD_ALIGN_VERTICAL = WD_CELL_VERTICAL_ALIGNMENT
 
@@ -89,7 +90,7 @@ def formatar_celula_tabela(cell, texto: str, negrito: bool = False, cor=None,
 
     cell.vertical_alignment = WD_ALIGN_VERTICAL.CENTER
 
-    run = p.add_run(texto)
+    run = p.add_run(public_text(texto))
     run.font.size = Pt(9)
     run.font.name = 'Arial'
     run.bold = negrito
@@ -266,7 +267,7 @@ def criar_celula_cabecalho_tabela(cell, texto: str, recuo_primeira_linha_cm: flo
     p.paragraph_format.first_line_indent = Cm(recuo_primeira_linha_cm)
     p.alignment = WD_ALIGN_PARAGRAPH.LEFT
 
-    run = p.add_run(texto)
+    run = p.add_run(public_text(texto))
     run.bold = True
     run.underline = True
     run.font.size = Pt(11)
@@ -292,7 +293,7 @@ def criar_celula_dados_tabela(cell, texto: str, is_label: bool = False) -> None:
     p.paragraph_format.space_before = Pt(0)
     p.paragraph_format.space_after = Pt(0)
 
-    run = p.add_run(texto)
+    run = p.add_run(public_text(texto))
     run.bold = is_label
     run.font.size = Pt(9)
     run.font.name = 'Arial'

document/public_text.py

@@ -0,0 +1,16 @@
+"""Public wording for report text; internal tool names stay out of the report."""
+import re
+
+
+def public_text(text):
+    text = str(text)
+    text = re.sub(r'\bmodelo MESA\b', 'modelo estatístico', text)
+    for original, replacement in [
+        ('da MESA', 'de referência'), ('do MESA', 'da avaliação de origem'),
+        ('no MESA', 'na avaliação de origem'), ('na MESA', 'na avaliação de origem'),
+        ('pela MESA', 'pela avaliação de origem'), ('pelo MESA', 'pela avaliação de origem'),
+        ('a MESA', 'a avaliação de origem'), ('A MESA', 'A avaliação de origem'),
+        ('o MESA', 'a avaliação de origem'), ('O MESA', 'A avaliação de origem'),
+    ]:
+        text = text.replace(original, replacement)
+    return re.sub(r'\bMESA\b', 'avaliação de origem', text)

tests/test_equations.py

@@ -0,0 +1,71 @@
+import copy
+import io
+import unittest
+import zipfile
+
+from docx import Document
+from docx.oxml import parse_xml
+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.generator import LaudoGenerator
+from document.public_text import public_text
+from document.footnotes import add_footnote
+from document.formatters import add_body_text
+from test_evolutivo_documento import fixture,resolved
+
+
+class DepreciationEquationTests(unittest.TestCase):
+    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)
+        reopened=Document(stream)
+        math=list(reopened.element.body.iter(qn('m:oMath')))
+        self.assertEqual(len(math),3)
+        self.assertEqual(len(list(math[0].iter(qn('m:f')))),1)
+        self.assertEqual(len(list(math[0].iter(qn('m:sSup')))),1)
+        self.assertEqual(len(list(math[2].iter(qn('m:sSub')))),1)
+        texts=[''.join(t.text or '' for t in formula.iter(qn('m:t'))) for formula in math]
+        self.assertEqual(texts,['Ross = q + q22','K = 1 − (1 − Ross) × (1 − H)','Kd = R + (1 − K) × (1 − R)'])
+        self.assertEqual(len(reopened.paragraphs),6)
+        for index in (0,2,4):
+            self.assertEqual(reopened.paragraphs[index].alignment,WD_ALIGN_PARAGRAPH.CENTER)
+            self.assertTrue(reopened.paragraphs[index].paragraph_format.keep_with_next)
+            legend=reopened.paragraphs[index+1]
+            self.assertEqual({r.font.size.pt for r in legend.runs},{8})
+        self.assertIn('dividindo o percentual',reopened.paragraphs[1].text)
+        self.assertIn('estado de conservação',reopened.paragraphs[3].text)
+        self.assertIn('percentual ÷ 100',reopened.paragraphs[5].text)
+
+    def test_internal_references_stay_out_of_body_tables_and_footnotes(self):
+        imported=resolved(fixture((2021,)))
+        row=imported['avaliacoes'][0]
+        row['observacoes']='Resultados preservados no MESA.'
+        row['complementos']={'justificativa_fc':'Condição registrada no modelo MESA.'}
+        original=copy.deepcopy(imported)
+        doc=Document()
+        with patch('document.evolutivo.matching_local',return_value=(None,'')):
+            LaudoGenerator()._gerar_corpo(doc,{'avaliacoes_importadas':imported},{})
+        LaudoGenerator()._gerar_cabecalho(doc,{'modelo_avaliacao':'modelo MESA'})
+        add_footnote(doc,add_body_text(doc,'Referência técnica'),'Coeficientes da MESA preservados na avaliação.')
+        stream=io.BytesIO();doc.save(stream)
+        with zipfile.ZipFile(stream) as archive:
+            for name in ['word/document.xml','word/footnotes.xml']:
+                root=parse_xml(archive.read(name))
+                text=' '.join(t.text or '' for t in root.iter(qn('w:t')))
+                self.assertNotIn('MESA',text)
+                self.assertNotIn('versão documental',text)
+                self.assertNotIn('catálogo sincronizado',text)
+        self.assertEqual(imported,original)
+
+    def test_public_wording_preserves_technical_names_and_ordinary_words(self):
+        self.assertEqual(public_text('Método de Ross-Heidecke; ABNT NBR 14653-2; CUB.'),'Método de Ross-Heidecke; ABNT NBR 14653-2; CUB.')
+        self.assertEqual(public_text('modelo MESA'),'modelo estatístico')
+        self.assertEqual(public_text('salvo no MESA'),'salvo na avaliação de origem')
+        self.assertEqual(public_text('mesa de apoio'),'mesa de apoio')
+
+
+if __name__=='__main__':
+    unittest.main()

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 = R +','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 = 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']:
             self.assertIn(part,text)
         self.assertNotIn('SEGREDO INTERNO',text)
         self.assertNotIn('11/2021',text)