Ruby Language
Création / gestion de gemmes
Recherche…
Fichiers Gemspec
Chaque gem a un fichier au format <gem name>.gemspec
qui contient des métadonnées sur la gemme et ses fichiers. Le format d'un gemspec est le suivant:
Gem::Specification.new do |s|
# Details about gem. They are added in the format:
s.<detail name> = <detail value>
end
Les champs requis par RubyGems sont:
Author author = string
ou authors = array
Utilisez author =
s'il n'y a qu'un seul auteur et authors =
lorsqu'il y en a plusieurs. Pour les authors=
utilisez un tableau qui énumère les noms des auteurs.
files = array
Ici, array
est une liste de tous les fichiers du joyau. Cela peut également être utilisé avec la fonction Dir[]
, par exemple si tous vos fichiers sont dans le répertoire /lib/
, alors vous pouvez utiliser files = Dir["/lib/"]
.
name = string
Ici, string est juste le nom de votre gemme. Rubygems recommande quelques règles à suivre pour nommer votre gem.
- Utilisez des traits de soulignement, AUCUN ESPACE
- Utilisez uniquement des lettres minuscules
- Utilisez hypens pour l'extension gem (par exemple, si votre gem est nommé
example
pour une extension, vous le nommeriezexample-extension
) de sorte que lorsque l'extension est requise, elle peut être requise commerequire "example/extension"
.
RubyGems ajoute également: «Si vous publiez un joyau sur rubygems.org, il peut être supprimé si le nom est répréhensible, viole la propriété intellectuelle ou si le contenu de la pierre satisfait à ces critères. Vous pouvez signaler un tel joyau sur le site de support RubyGems.
platform=
Je ne sais pas
require_paths=
Je ne sais pas
summary= string
String est un condensé du but des gemmes et de tout ce que vous souhaitez partager à propos du joyau.
version= string
Le numéro de version actuel de la gem
Les champs recommandés sont:
email = string
Une adresse e-mail qui sera associée à la gem
homepage= string
Le site où vit la gemme.
Soit license=
ou licenses=
Je ne sais pas
Construire un joyau
Une fois que vous avez créé votre gem pour le publier, vous devez suivre quelques étapes:
- Construisez votre gem avec
gem build <gem name>.gemspec
(le fichier gemspec doit exister) - Créez un compte RubyGems si vous n'en avez pas déjà un ici
- Vérifiez pour vous assurer qu'il n'existe pas de gemmes qui partagent votre nom de gemmes
- Publiez votre gem avec
gem publish <gem name>.<gem version number>.gem
Les dépendances
Pour répertorier l'arbre de dépendance:
gem dependency
Pour lister les gemmes qui dépendent d'un gem spécifique (bundler par exemple)
gem dependency bundler --reverse-dependencies