Módulo:Temporada/Utils/doc

Módulo:Temporada/Utils

O Módulo:Temporada/Utils concentra funções utilitárias reutilizáveis utilizadas pelos módulos de temporada do projeto Wiki Galo Digital.

Este módulo **não gera saída visual** e existe para:

• Evitar repetição de código
• Padronizar cálculos e validações
• Centralizar regras simples e transversais

---

Escopo e responsabilidades

Este módulo é responsável por:

• Conversões seguras de tipos (string, número, boolean)
• Normalização básica de valores vindos da wiki
• Cálculos genéricos utilizados em estatísticas e campanhas
• Regras auxiliares de comparação de resultados
• Apoio à padronização visual indireta (classes CSS)

---

Dependências

Este módulo utiliza funções nativas do MediaWiki:

• mw.text.trim
• mw.ustring.lower

Não possui dependência direta de outros módulos do projeto.

---

Funções públicas

toNumber(value, default)

Converte um valor para número de forma defensiva.

• Parâmetros
  • value – valor a ser convertido
  • default (opcional) – valor padrão em caso de falha

• Retorno
  • Número convertido ou valor padrão
  • Retorna 0 caso nenhum padrão seja informado

• Uso típico
• Tratamento de parâmetros vindos de templates
• Cálculos estatísticos

---

normalizeString(valor)

Normaliza uma string removendo espaços excedentes.

• Parâmetro
  • valor (string)

• Retorno
  • String normalizada
  • Retorna string vazia se o valor não for string

---

isAtletico(nome)

Verifica se um nome se refere ao Clube Atlético Mineiro.

• Parâmetro
  • nome (string)

• Retorno
  • true se identificar “atlético” ou “atletico”
  • false caso contrário

---

resultadoPartida(golsTime, golsAdversario)

Compara o placar de uma partida.

• Parâmetros
  • golsTime
  • golsAdversario

• Retorno
  • "V" – vitória
  • "E" – empate
  • "D" – derrota

---

cssResultado(resultado)

Retorna a classe CSS associada ao resultado da partida.

• Parâmetro
  • resultado (V, E, D)

• Retorno
  • Classe CSS correspondente
  • String vazia se inválido

• Classes utilizadas
  • gd-result-win
  • gd-result-draw
  • gd-result-loss

---

aproveitamento(pontosObtidos, pontosPossiveis)

Calcula o aproveitamento percentual.

• Parâmetros
  • pontosObtidos
  • pontosPossiveis

• Retorno
  • Número percentual (0 a 100)
  • Retorna 0 se pontosPossiveis for zero

---

pontosResultado(resultado)

Converte o resultado da partida em pontuação padrão (3-1-0).

• Parâmetro
  • resultado (V, E, D)

• Retorno
  • 3, 1 ou 0

---

toBoolean(value)

Converte parâmetros vindos da wiki ou Lua para booleano real.

• Parâmetro
  • value

• Reconhece como verdadeiro
  • true (boolean)
  • "sim"
  • "true"
  • "1"

• Retorno
  • true ou false

---

Boas práticas

• Não adicionar renderização visual
• Não incluir lógica específica de domínio
• Manter funções pequenas e previsíveis
• Centralizar aqui regras simples reutilizáveis
• Documentar qualquer nova função adicionada

---

Páginas relacionadas

• Módulo:Temporada
• Módulo:Temporada/Estatisticas
• Módulo:Temporada/Campanha
• Módulo:Temporada/Partidas

---

Histórico

• Módulo criado como base utilitária do sistema de temporadas
• Projetado para reduzir duplicação de código e facilitar manutenção