Ruby Academy · Leçon

Écrire le code

Organisez un gem

Écrire le code est une leçon Ruby Academy gratuite sur CoddyKit. Ceci est la leçon 2 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Ruby Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Ruby Academy comprend 4 leçons au total.

Organisation du code d’une gemme

Le code d’une bonne gemme est facile à lire, facile à charger et placé dans un espace de noms afin de ne jamais entrer en conflit avec d’autres bibliothèques. L’outil essentiel est un module de niveau supérieur qui englobe tout.

Un module d’espace de noms par gemme.
Un fichier par classe, en reproduisant l’espace de noms.
Une interface publique réduite.

Le module d’espace de noms

Placez toutes les classes dans un module portant le nom de votre gemme. Cela empêche votre Client d’entrer en conflit avec le Client d’une autre personne.

module Greeter
  class Hello
    def message
      "Hi there"
    end
  end
end

puts Greeter::Hello.new.message

Convention de nommage des fichiers

Les outils Ruby s’attendent à ce que les chemins des fichiers correspondent aux noms des constantes :

Greeter se trouve dans lib/greeter.rb.
Greeter::Hello se trouve dans lib/greeter/hello.rb.

Cette convention permet aux chargeurs automatiques de trouver les fichiers automatiquement.

Chargement des fichiers internes

Le fichier d’entrée relie tout avec require_relative. Chaque fichier de classe est chargé une seule fois, de sorte que toute la bibliothèque se charge avec un seul require 'greeter'.

Une interface publique claire

Exposez un petit ensemble de méthodes que les utilisateurs appellent réellement. Un modèle courant consiste à utiliser des méthodes utilitaires au niveau du module qui délèguent le travail aux classes internes.

module Greeter
  def self.say(name)
    "Hello, " + name + "!"
  end
end

puts Greeter.say("Ada")

Masquage des éléments internes

Marquez les méthodes utilitaires comme private afin qu’elles ne fassent pas partie de votre contrat public. Tout ce qui est public constitue une promesse faite aux utilisateurs ; gardez donc cette interface volontairement réduite.

class Calculator
  def total(a, b)
    add(a, b)
  end

  private

  def add(x, y)
    x + y
  end
end

puts Calculator.new.total(2, 3)

Modèle de configuration

De nombreuses gemmes proposent un bloc de configuration afin que les utilisateurs puissent définir leurs options une seule fois. Une version simple stocke les paramètres dans un objet de configuration.

module App
  class Config
    attr_accessor :api_key
  end

  def self.config
    @config ||= Config.new
  end

  def self.configure
    yield(config)
  end
end

App.configure { |c| c.api_key = "secret" }
puts App.config.api_key

Erreurs personnalisées

Définissez des classes d’erreur propres à la gemme sous votre espace de noms afin que les utilisateurs puissent intercepter exactement vos erreurs. Faites-les hériter de StandardError.

module Payment
  class Error < StandardError; end
  class DeclinedError < Error; end
end

begin
  raise Payment::DeclinedError, "card declined"
rescue Payment::Error => e
  puts "Handled: " + e.message
end

Éviter la modification dynamique des classes

Évitez de modifier globalement des classes fondamentales comme String. Cela provoque des surprises dans les autres codes. Si vous devez les étendre, utilisez des raffinements afin de limiter la modification à une portée donnée, ou ajoutez des méthodes utilitaires dans vos propres classes.

Limiter les dépendances

Chaque dépendance à l’exécution que vous ajoutez devient une dépendance pour tous vos utilisateurs. Privilégiez la bibliothèque standard lorsque c’est raisonnable, et n’ajoutez une gemme que si son utilité le justifie.

Moins de dépendances signifie moins de conflits de versions et des installations plus rapides.

Documenter l’interface publique

Ajoutez des commentaires décrivant les arguments et la valeur de retour de chaque méthode publique. Des outils comme YARD transforment ces commentaires en documentation consultable, et un bon README accompagné d’exemples est souvent déterminant pour convaincre les utilisateurs d’adopter votre gemme.

Vérification rapide

Vérifiez votre compréhension de l’organisation du code d’une gemme.

Récapitulatif : écrire le code

Vous avez appris à organiser les éléments internes d’une gemme :

Placez tout dans un module d’espace de noms.
Faites correspondre les chemins des fichiers aux noms des constantes.
Conservez une interface publique réduite et marquez les méthodes utilitaires comme private.
Définissez des classes d’erreur personnalisées et évitez les modifications dynamiques globales.
Limitez les dépendances et documentez l’interface.

Vous allez maintenant ajouter les tests et le versionnage.

Questions Fréquemment Posées

La leçon « Écrire le code » est-elle gratuite ?

Oui — le texte complet de « Écrire le code » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Ruby Academy, passe à CoddyKit PRO. Le cours Ruby Academy comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « Écrire le code » ?

Organisez un gem Tu pratiques Ruby Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer Ruby Academy ?

Aucune expérience préalable n'est requise. Ruby Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 2 sur 4.

Combien de temps prend la leçon « Écrire le code » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon Ruby Academy ?

Oui. Chaque leçon Ruby Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

← Retour à Ruby Academy