# Guia de Referência: Template Method (Comportamental)


Este guia orienta a aplicação do padrão **Template Method** em projetos de software. **Objetivo:** Definir o esqueleto fixo de um algoritmo na classe base e permitir que subclasses variem etapas específicas. O padrão deve ser usado somente quando as forças do problema o justificarem.

---

## 1. Problema que resolve

Vários fluxos têm a mesma sequência geral, mas diferem em alguns passos.

### Sinais no código/arquitetura
- Métodos quase duplicados diferem em poucas etapas.
- A ordem do algoritmo deve permanecer invariável.
- Herança já é uma escolha aceitável no contexto.

## 2. Quando usar
- Pipelines de importação/processamento com sequência fixa.
- Framework hooks.
- Algoritmos em que algumas etapas são extensíveis por subclasses.

## 3. Quando NÃO usar
- Quando composição/Strategy oferece flexibilidade melhor.
- Quando subclasses precisariam sobrescrever muitas etapas ou violar LSP.

## 4. Estrutura e participantes
- AbstractClass: template method final/não sobrescrevível e hooks.
- ConcreteClass: implementa passos variáveis.

## 5. Procedimento de implementação
1. Identifique o esqueleto comum.
2. Extraia passos variáveis para métodos protegidos/abstratos.
3. Mantenha a ordem no template.
4. Use hooks opcionais com defaults claros.
5. Evite expor detalhes internos demais às subclasses.

## 6. Exemplo mental

`ImportJob.run()` faz load → validate → transform → persist; subclasses implementam `load` e `transform` para CSV/JSON.

## 7. Benefícios esperados
- Elimina duplicação de fluxo.
- Controla invariantes de sequência.

## 8. Custos e trade-offs
- Acoplamento por herança.
- Subclasses podem ficar dependentes de detalhes da base.

## 9. Encaixe com Clean Architecture e SOLID

Use com cautela; composição geralmente preserva melhor independência. Se o algoritmo é regra central e variações são políticas, Strategy costuma ser mais flexível.

**Regras para a IA:**
- Dependa de abstrações quando a variação justificar uma fronteira.
- Não faça o domínio importar SDKs, frameworks, banco de dados ou UI.
- Mantenha cada participante com responsabilidade coesa.
- Prefira composição quando ela reduzir acoplamento; não crie hierarquias artificiais.
- Registre a decisão arquitetural quando o padrão afetar muitos módulos.

## 10. Caminho de refatoração

Aplique a métodos duplicados com mesma ordem e poucos pontos de variação.

Ao refatorar um sistema existente:
1. Proteja o comportamento atual com testes.
2. Faça passos pequenos e reversíveis.
3. Introduza primeiro a abstração/contrato.
4. Migre um fluxo por vez.
5. Remova código antigo apenas após equivalência comportamental comprovada.

## 11. Estratégia de testes

Teste o algoritmo base com uma subclasse fake e cada passo concreto; valide que a ordem não muda.

Checklist mínimo:
- [ ] caminho feliz
- [ ] entradas/estados de limite
- [ ] erros e falhas de dependências
- [ ] comportamento de cada implementação concreta
- [ ] teste de contrato quando houver múltiplas implementações
- [ ] teste de integração apenas onde a fronteira externa for relevante

## 12. Padrões relacionados
- Strategy
- Factory Method
- Hook Method

## 13. Perguntas de diagnóstico para a IA

1. Qual aspecto do sistema realmente varia?
2. Essa variação já está causando duplicação, condicionais ou acoplamento?
3. Uma função/composição simples resolveria com menos abstrações?
4. O padrão reduz o custo de uma mudança concreta que já é provável?
5. Qual é o custo de introduzir novas classes, indireção e configuração?
6. Como a decisão será testada e observada em produção?

## 14. Prompt pronto

```text
Você é o arquiteto do projeto. Avalie se o padrão **Template Method** é adequado para o problema abaixo.

Contexto: [DESCREVA o sistema, stack/arquitetura, estado atual e o problema observado]
Objetivo: [DESCREVA o resultado esperado ao avaliar ou aplicar este padrão]
Restrições: [DESCREVA prazo, legado, performance, testes, compatibilidade e o que não pode mudar]

Antes de codificar:
1. Identifique as forças que justificam ou rejeitam Template Method.
2. Compare pelo menos uma alternativa mais simples e um padrão relacionado (Strategy, Factory Method, Hook Method).
3. Se o padrão for justificado, mostre participantes, dependências e fluxo.
4. Preserve Clean Architecture/SOLID: regras centrais não dependem de infraestrutura.
5. Implemente incrementalmente, com testes.
6. Ao final, liste trade-offs e sinais de overengineering.

Não aplique o padrão apenas porque foi solicitado; rejeite-o se não houver variação/complexidade que o justifique.
```

### Como preencher os campos

- **Contexto:** descreva o tipo de sistema, stack/versões, arquitetura atual, onde a mudança acontece e o comportamento relevante já existente.
- **Objetivo:** descreva o resultado observável que deve existir ao final, não apenas a tecnologia que você quer usar.
- **Restrições:** informe o que não pode mudar, compatibilidade, prazo, segurança, acessibilidade, performance, legado, dependências e limites de escopo.

### Exemplo preenchido

```text
Contexto: Importadores de CSV e XLSX seguem o mesmo fluxo geral, mas leitura e validação específica variam.
Objetivo: Fixar o esqueleto do processo e permitir variar etapas específicas.
Restrições: Cuidado com herança rígida; preferir Strategy/composição se etapas precisarem variar em runtime.
```


## 15. Critério de aceite

A aplicação de **Template Method** só está concluída quando:
- [ ] o problema que motivou o padrão está explicitamente documentado;
- [ ] o código cliente depende do contrato correto, não de detalhes acidentais;
- [ ] adicionar a variação-alvo exige menos mudanças que antes;
- [ ] testes protegem a extensão/refatoração;
- [ ] não houve vazamento de infraestrutura para o núcleo;
- [ ] a solução ficou mais compreensível para manutenção, não apenas “mais orientada a padrões”.

## 16. Base Conceitual e Relações

- Catálogo Refactoring.Guru em português — escopo de 22 padrões.
- *Design Patterns: Elements of Reusable Object-Oriented Software* (Gamma, Helm, Johnson e Vlissides) — intenção, aplicabilidade, participantes, consequências e relações entre padrões.
- Guias de Clean Architecture, princípios de design, refatoração e código limpo deste pacote.