Depurando WordPress com Ray, Parte 1
TL;DR: Este post fornece uma visão geral de alto nível de que tipo de aplicativo Ray é e como configurá-lo para uso no WordPress.
Desde que estou envolvido com o desenvolvimento do WordPress, tenho visto consistentemente desenvolvedores – inclusive eu – usar consistentemente [print_r](https://www.php.net/manual/en/function.print-r.php)e [var_dump](https://www.php.net/manual/en/function.var-dump.php)sempre que precisam ver o que está acontecendo em seu código.
E isso é bom para estruturas de dados menores, como olhares para objetos, matrizes e assim por diante. Então, na outra extremidade do espectro de depuração, se você precisar percorrer o código para ver quais argumentos estão sendo passados para uma determinada função de onde e com qual valor, usar algo como Xdebug é incrivelmente útil.
Até recentemente, eu não achava que havia um meio-termo. Mas então eu encontrei Ray e tenho usado desde então.
Depurando WordPress com Ray, Parte 1
O que é Raio?
Antes de falar sobre depuração do WordPress com Ray, vale a pena entender o que Ray é e o que não é.
A primeira é que não é algo exclusivamente WordPress, então se você se deparou com este post como outra pessoa na comunidade PHP mais ampla, é algo que ainda está funcionando.
Com isso dito, vamos supor que você seja um desenvolvedor baseado em WordPress e queira aprender mais sobre o que é o Ray.
Primeiro, embora forneça um exemplo elegante de como seu código se parece quando despejado em uma tela, ele oferece muito mais.
Observe que, ao usar o Ray, você precisará de algumas ferramentas adicionais, que abordarei um pouco mais em um momento, mas se você quiser continuar a despejar informações em um formato usando algo semelhante a var_dump, o Ray oferece suporte a isso. Só faz parecer mais bonito. 🙂
Em segundo lugar, quando você invoca o Ray de dentro do seu código, ele garante que você saiba de onde a chamada está vindo. Dessa forma, você sabe exatamente qual arquivo e em qual linha está olhando. Isso é útil especialmente quando você tem várias chamadas.
Terceiro, você pode realmente pausar a execução do seu código como faz sempre que está usando um depurador real. Isso significa que uma vez que ele atinge um certo ponto em seu código (e isso é útil se você estiver atingindo uma switchcondição ou ifcondição ou se estiver usando, digamos, uma fábrica em programação orientada a objetos e quiser saber qual instância de um objeto foi instanciado), então você pode interromper a execução e ter uma noção melhor do que está acontecendo com seu projeto.
Finalmente, você pode organizar os tipos de saída em várias cores. Isso significa que, se você atingir uma determinada ramificação no código e não quiser atingir essa ramificação, poderá categorizá-la como vermelha. Da mesma forma, você pode fazer o mesmo com verde, laranja, roxo e muito mais. Realmente depende de você e do que você pretende alcançar observando seus dados.
Usando Ray no WordPres
Se você ler os documentos para instalar o Ray no WordPress, pode parecer um pouco intimidador (especialmente dependendo da sua experiência com a CLI, com o Git e com plugins obrigatórios).
O bom é que não precisa ser assim. Em vez disso, você pode pegar o WordPress Ray Plugin do repositório de plugins (do site ou de dentro do WordPress, dependendo de suas permissões).
Depois que o plug-in for instalado, você poderá começar imediatamente a despejar informações no Ray.
Usando Git e Composer
Se você optar por usar o Git e o Composer, certifique-se de que essas duas ferramentas estejam instaladas em seu sistema e faça o seguinte.
Primeiro, clone o repositório em seu mu-pluginsdiretório emitindo o seguinte comando:
$git clone git@github.com:spatie/wordpress-ray
Em seguida, navegue até esse diretório em seu terminal e execute:
$ composer install
Quando esse processo terminar, abra wp-config.phpe adicione as duas linhas a seguir:
require_once ABSPATH. 'wp-content/mu-plugins/wordpress-ray/wp-ray.php';
define( 'WP_ENVIRONMENT_TYPE', 'local' );
Depois disso, você pode começar a usar a rayfunção em seu código. Por exemplo, tenho a seguinte linha de código em execução em um modelo que estou usando como demonstração para este artigo:
<?php ray( wp_get_current_user() ); ?>
Então, sempre que esta página for carregada, o aplicativo Ray exibirá o seguinte:
Esta é obviamente uma informação rica – informação que ainda pode ser lida por outros meios – mas de uma forma muito mais elegante.
Para a Parte 2
Na Parte 2 da série, abordarei como começar a depurar código usando o Ray e por que gosto de usar o aplicativo como meio termo entre algo [var_dump](https://www.php.net/manual/es/function.var-dump.php)como Xdebug.
Além disso, vou passar por alguns dos recursos específicos do WordPress do Ray para que você possa ver como isso é mais do que “uma maneira bonita de despejar variáveis".
Em última análise, acho que o Xdebug ainda é algo que deve ser usado, mas Ray é um meio-termo muito mais agradável que fornece muita funcionalidade de depuração sólida sem precisar do suporte completo de um depurador verdadeiro.