Como criar sua propria gem no RubyGems
O que são gems no ruby? Gems são pacotes de código Ruby que permitem que você distribua suas bibliotecas e ferramentas para outros desenvolvedores. Gems são usadas para adicionar funcionalidades aos aplicativos Ruby, e você pode encontrar milhares de gems disponíveis no site RubyGems.org. Como criar uma gem: Criar uma…
O que são gems no ruby?
Gems são pacotes de código Ruby que permitem que você distribua suas bibliotecas e ferramentas para outros desenvolvedores. Gems são usadas para adicionar funcionalidades aos aplicativos Ruby, e você pode encontrar milhares de gems disponíveis no site RubyGems.org.
Como criar uma gem:
Criar uma gem no Ruby é um processo simples que envolve a criação de alguns arquivos e pastas. Vamos ver um passo a passo básico:
1 – Instale o Bundler:
gem install bundler
2 – Rode o comando de criação da gem isso, criará a estrura basica de sua gem:
bundle gem nome_da_gem
3 – Modifique o arquivo gemspec
:
- Nesse arquivo contém toda a configuração da sua gem, é necessário modificar todas as configurações onde está escrito “To-do”. Que são os seguintes:
- summary -> Resumo de sua aplicação.
- description -> Descrição de toda a função de sua Gem.
- homepage -> Repositório no github ou website de sua Gem.
- allowed_push_host -> Url de hospedagem de sua Gem.
- source_code_uri -> Url do repositório de sua Gem.
- changelog_uri -> Url do changelog de sua Gem.
- É importante também nesse arquivo adicionar as dependências de sua gem caso seja necessário.
4 – Implemente a funcionalidade de sua Gem na pasta Lib. Nessa pasta precisara conter toda as classes e modulos necessários para a função de sua Gem.
5 – Rode o comando para construir sua gem, esse comando irá gerar o arquivo .gem
que pode ser distribuído.
gem build nome_da_gem.gemspec
Como publicar sua Gem no RubyGems:
1 – Entre no RubyGems.org e crie sua conta, é bem facil, só é necessário um email e uma senha, ele só pedirá esses dados.
2 – Com sua contra criada, agora você precisa fazer o login no terminal com o comando:
gem signin
3 – Agora você poderá publicar sua gem na versão que deseja com o comando:
gem push nome_da_gem-0.0.1.gem
4 – Com isso na URL você já conseguira ver sua gem publicada, como nessa foto abaixo:
Como gerar uma nova versão da sua gem com modificações:
1 – Faça as modificações necessárias, adicione ou modifique o código da sua gem conforme necessário.
2 – Atualize a versão de sua gem, no arquivo .gemspec
, atualize o numero da sua proxima versão de sua Gem:
spec.version = "0.0.2"
3 – Atualize a constante de versão, existe um arquivo criado automaticamente com a constante de versão de sua GEM, no caminho: lib/nome_da_gem/version.rb
module NomeDaGem
VERSION = "0.0.2"
end
4 – Construa a nova versão de sua gem:
gem build nome_da_gem.gemspec
5 – Por ultimo publique a nova versão de sua gem com o comando abaixo:
gem push nome_da_gem-0.0.2.gem
Considerações finais:
Nesses poucos passos, já temos uma GEM publicada no RubyGems.org, pronta para ser baixada e compartilhada com qualquer projeto ruby, é importante para manuntenção que você siga essas dicas adicionais para melhor mantenabilidade de sua aplicação.
Documentação: Considere adicionar uma boa documentação para sua gem, incluindo um README detalhado com exemplos de uso.
Versionamento: Siga uma convenção de versionamento (como SemVer) para manter o controle das mudanças em sua gem.
Colaboração: Se você espera contribuições de outros desenvolvedores, forneça um guia de contribuição e use um sistema de controle de versão como Git.