Como conseguir suas primeiras badges de RoR treinador

Você já deve ter visto repositórios com badges do github, certo? Acredito que você vai concordar comigo quando digo que tê-las no seu projeto é awesome!

Os controles automatizados para para exibição de badges não são só uma questão de perfumária, servem para que fique claro, bem a sua vista, como esta a saúde do seu código.

Ginásio da Qualidade

Para alcançar seus sonhos não basta somente desejar, você deve lutar por eles.
Para conseguir sua primeira badge seu desafio será medir e melhorar a qualidade do seu código.

A qualidade do código é importante, pois afeta a qualidade geral do software e a qualidade impacta na segurança, proteção e confiabilidade de sua base de informações.

Para medir a qualidade do seu código usaremos a ferramenta web codacy.com, para utiliza-la é muito fácil, sério, basta fazer uma conta, logar, conectar seu repositório github, escolher qual projeto deseja analisar e pronto, like magic:

Muito provavelmente, sua nota não será alta de cara, você precisará batalhar na qualidade do seu código.

Quando falamos em qualidade de código precisamos pensar na confiabilidade, manutabilidade (falaremos disso já), testabilidade (dessa também), portabilidade e capacidade de reutilização de códigos.
Esses e outros aspectos são considerados pelo codacy.
Os dados de erros coletados serão mostrados a você através da aba de Issues breakdown, no caso da imagem acima eram 39 problemas.

Aí você vai me dizer:
‘-Mas tá, meu repositório ainda não tem nenhuma badgezinha linda lá brilhando!’
Calma, eu entendo a ansiedade, sério!
Depois de avaliado seu código você só precisará copiar o markdown autogerado e colar no seu readme onde desejar.

Parabéns jovem RoR treinador, você acabou de ganhar sua primeira badge! -Esta feliz? -Ah, legal! Estou feliz por você, foi mais fácil que você imaginava, não é?

Ginásio da Manutabilidade

Seguimos então para nosso próximo desafio…

De forma geral, a capacidade de manutenção é inversamente proporcional ao tempo que um desenvolvedor leva para fazer uma alteração e ao risco de que a alteração danifique algo. Melhorar a legibilidade, o acoplamento ou a consistência contribuem para a capacidade de manutenção porque não demorará tanto para fazer qualquer alteração.

Para avaliar o quão merecedor seu código é, iremos usar a ferramenta web codeclimate.com.

Receber sua avaliação é fácil, basta fazer login no site, conectar seu repositório e escolher em qual dos seus projetos deseja fazer a avaliação.
Após isso a ferramenta irá fazer seu trabalho e te dará um atela assim, ou parecida:

No canto esquerdo é mostrada a quantidade de arquivos avaliados, logo a sua frente a nota de manutabilidade, no caso ‘A’.
Caso existam problemas que atrapalhem a manutenção do seu código a ferramenta indicará e você será deverá corrigir posteriormente.

Mais uma vez para colocar a badge no seu projeto você deverá buscar o código markdown da ferramenta para colocar no seu readme. Dentro das configurações do repositório você terá acesso ao que procura:

Parabéns jovem RoR treinador, você acabou de ganhar sua segunda badge!

Ginásio da Cobertura de Testes

Para esse desafio iremos precisar da gem codecov para que seja possível fazer a análise. Primeiramente é requerido que já exista uma suite de testes no seu projeto e que esta já esteja configurada, de preferência com todos seus testes passando.

Para entender melhor quando, onde e porquê testes? Recomendo este artigo: ‘A solução definitiva para monitorar seus 100% de cobertura de testes’ antes de continuarmos.

Já leu? Pronto? Legal!

Agora que você já entende o porque de testes automatizados vamos a nossa nova gem a codecov.
Adicione-a em seu projeto, através da seguinte linha:

gem 'codecov', require: false, group: 'test'

Depois disso adicione no topo do seu arquivo test_helper.rb as seguintes linhas:

require 'codecov'
SimpleCov.formatter = SimpleCov::Formatter::Codecov

Bom para completar o desafio teremos de ir ao site do Codecov, precisaremos fazer uma conta, vincular nossa github, como já fizemos anteriormente e pegar o token de segurança:

De posse de seu token adicione-o a uma váriavel de ambiente no seu projeto:

CODECOV_TOKEN="Seu token"

Após rodar a sua suíte de testes, os controles automatizados serão enviados para o codecov e estarão disponiveis para exibição no seu dashboard do site:

Para encontrar o código markdown da sua badge, vá em Settings e Badge, como mostra a image:

Mais uma vez parabéns pela nova badge jovem treinador RoR, parece que isto está virando rotina, não?

Hoje foi um dia de muitas conquitas para Ash, digo você, digo não sei seu nome, mas espero que hoje durma mais feliz com seu código, badge, ou ao menos mais consciente de como e por onde começar no trabalho duro de desenvolver códigos com qualidade, manutabilidade e testados devidamente.

Te vejo na próxima!