RankCommiters

Com esta gem é possível montar um rank de commiters, pela quantidade de commits dos autores, de determinado projeto que esteja no GitHub.

Instalação

$ git clone [email protected]:rmoura/rank-commiters.git
$ gem install rank-commiters-0.1.0.gem

Utilização

Para maiores detalhes de utilização:

Usage: rank-commiters [options]

Specific options:
    -r, --repository ["owner/repo"]  [Obrigatório] Projeto a ser analisado (Ex.: "Dinda-com-br/braspag-rest")
    -t, --access_token [token]       Token de Acesso do GitHub
    -o, --output_path [path]         Caminho do diretório onde o arquivo será salvo

Common options:
    -h, --help                       Show this message

O parâmetro repositório é obrigatório.

Exemplo de utilização:

$ rank-commiters -r Dinda-com-br/braspag-rest -t xyzyzxzxyyxz -o /tmp

Este comando irá gerar uma mensagem indicando que o arquivo de saída com os commiters ordenados por quantidade de commits foi gerado com sucesso da seguinte forma:

Arquivo de saída gerado com sucesso. O arquivo está localizado em Dinda-com-br_braspag-rest_YYYYmmddHHMMSS.txt.

A estrutura deste arquivo será semelhante a:

Rodrigo;[email protected];rodrigosimoes;https://github.com/RodrigoSimoesAraujo­Dinda;300;
Jose;[email protected];josedascouves;https://github.com/joselinho;14;

Observação:

O rank é montado com base no login do commiter no Github. Não foi adotado o email para o cálculo pois a cada momento o commiter pode utilizar um email diferente. Os commits sem login serão ignorados pois o próprio Github não consegue vincular o commit a uma conta de usuário.

Casos que nenhum arquivo será gerado:

Repositório inexistente:

Ops! Repositório Não Encontrado.

Repositório vázio, sem commits:

Ops! Repositório Vázio (Sem Commits).

Quando limite de acessos permitido pelo GitHub for excedido:

Ops! Limite de Acessos Excedido.

Quando token de acesso a API do GitHub não for válido:

Ops! Acesso Não Autorizado.

License

Esta gem está disponível como código aberto sob os termos de Licença MIT.