Simplesmente refatorando código baseado em WordPress
Em 2011, eu estava lendo muito sobre como trabalhar com código legado, qualidade de código e refatoração.
Há uma citação de Martin Fowler (que literalmente escreveu o livro sobre refatoração) atribuída ao tio Bob que ficou comigo – e tenho certeza que muitos, muitos programadores – desde então:
sempre deixe o código para trás em um estado melhor do que você o encontrou
A coisa sobre essa ideia em particular é que eu acho que pode soar um pouco mais idealista até você realmente começar a tentar praticá-la em tudo o que você faz.
Ou seja, se você considerar o valor nominal, parece que a qualquer momento você precisa trabalhar em uma base de código, então você precisa deixar a base de código inteira melhor do que quando a encontrou. Mas quanto mais eu tentei aplicar essa regra no meu trabalho diário, mais prático, mais limpo e mais fácil de manter o código específico do WordPress se tornou.
Então, quando se trata de refatorar código baseado em WordPress, como é isso?
Este não será um post longo. Em vez disso, vou simplesmente compartilhar alguns pontos que sigo quando se trata de trabalhar no código que escrevi anteriormente, que encontrei de outras pessoas ou que é de uma base de código na qual trabalhei com outras pessoas no passado.
Em nenhuma ordem particular:
- Não seja idealista; Seja prático. Refatorar uma base de código inteira não é uma prática, especialmente se a base de código não estiver envolvida em testes de unidade. Observe o código em que você está trabalhando e veja quais pequenas modificações você pode fazer para melhorá-lo.
- Use os padrões mais recentes. Você não precisa configurar um ambiente de desenvolvimento totalmente novo para código antigo. Em vez disso, apenas certifique-se de ter bons sniffers de código no lugar. Se você mudou dos Padrões de Codificação do WordPress para o PSR, observe os avisos ou avisos que os sniffers lançam e tente atualizar o código apenas nesse arquivo (ou conjunto de arquivos).
- Funções Auxiliares de Gravação. Se suas funções forem muito longas, procure maneiras de torná-las mais fáceis de trabalhar. Primeiro, atualize quaisquer estruturas de controle, como loops ou condicionais, e escreva funções auxiliares para facilitar a leitura.
- Adicionar testes (quando possível). Se você já tiver uma estrutura de teste de unidade, adicione testes para seu novo código. Se você não tem tempo ou não tem estrutura, não se preocupe. Por mais que os programadores pragmáticos preguem, nem sempre há tempo para adicionar testes. (Isso não é para ser uma declaração de que eles não são úteis ou não devem ser incluídos, mas que nem sempre é prático incorporá-los a qualquer momento).
Algumas das coisas que me vi fazendo em projetos recentes também incluem coisas simples:
- atualizando nomes de variáveis e funções para seguir o PSR,
- mudando tabs para espaços,
- adicionando funções auxiliares para tornar as condições e os loops mais legíveis,
- dividir as classes para que elas tenham um maior grau de coesão,
- melhorar os docblocks de cada função
Estes são apenas alguns exemplos e esta não é claramente uma lista exaustiva. Mas esse não é o ponto. Em vez disso, estou procurando simplesmente compartilhar como você pode aplicar refatoração de código baseado em WordPress ao mesmo tempo em que realiza seu trabalho diário de maneira gerenciável.
Todas as alterações ou recomendações acima são coisas que geralmente podem ser feitas com a ajuda do IDE, alguns atalhos e talvez meia hora de tempo extra (e estou sendo liberal com essa estimativa).
Então, não, você não precisa reescrever uma base de código inteira. Eu nem sei se esse é um objetivo prático para o qual almejar. Mas você pode consertar uma pequena parte do sistema geral pelo qual você é responsável?
E por que não, pelo menos, apontar para isso?