Ruby Academy · Les

De code schrijven

Een gem organiseren

Les 2 van 413 stappen

De code schrijven is een gratis Ruby Academy-les op CoddyKit. Dit is les 2 van 4. Je kunt 3 lessen uit dit leerpad gratis volledig lezen — daarna ontgrendelt CoddyKit PRO alle lessen, plus praktische oefeningen met een ingebouwde code-editor en een AI-tutor die 24/7 beschikbaar is. Deze les maakt deel uit van het leertraject Ruby Academy. Je voortgang wordt gesynchroniseerd op het web en in de CoddyKit-app. De cursus Ruby Academy bevat in totaal 4 lessen.

De code van een gem organiseren

Goede gemcode is gemakkelijk te lezen en te laden en heeft een naamruimte, zodat deze nooit botst met andere bibliotheken. Het belangrijkste hulpmiddel is een module op het hoogste niveau die alles omvat.

Eén naamruimtemodule per gem.
Eén bestand per klasse, overeenkomstig de naamruimte.
Een kleine openbare interface.

De naamruimtemodule

Wikkel alle klassen in een module met de naam van je gem. Zo voorkom je dat jouw Client botst met de Client van iemand anders.

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

puts Greeter::Hello.new.message

Naamgevingsconventie voor bestanden

Ruby-hulpmiddelen verwachten dat bestandspaden overeenkomen met constantnamen:

Greeter staat in lib/greeter.rb.
Greeter::Hello staat in lib/greeter/hello.rb.

Dankzij deze conventie kunnen bestanden automatisch worden gevonden.

Interne bestanden laden

Het startbestand brengt alles samen met require_relative. Elk klassebestand wordt één keer geladen, zodat de hele bibliotheek met één require 'greeter' wordt geladen.

Een duidelijke openbare API

Stel een kleine verzameling methoden beschikbaar die gebruikers daadwerkelijk aanroepen. Een gebruikelijk patroon is om gemaksmethoden op moduleniveau te definiëren die het werk doorsturen naar interne klassen.

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

puts Greeter.say("Ada")

Interne onderdelen verbergen

Markeer hulpmethoden als private, zodat ze geen onderdeel zijn van je openbare contract. Alles wat openbaar is, is een belofte aan gebruikers; houd die interface bewust gekozen en klein.

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)

Configuratiepatroon

Veel gems bieden een configure-blok, zodat gebruikers opties één keer kunnen instellen. Een eenvoudige versie bewaart de instellingen in een configuratieobject.

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

Eigen fouten

Definieer foutklassen die specifiek zijn voor je gem onder je naamruimte, zodat gebruikers precies jouw fouten kunnen afvangen. Laat ze overerven van 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

Voorkom monkeypatching

Pas kernklassen zoals String liever niet overal aan. Dat veroorzaakt verrassingen in andere code. Als je toch moet uitbreiden, gebruik dan refinements zodat de wijziging beperkt blijft, of voeg hulpmethoden toe aan je eigen klassen.

Houd afhankelijkheden beperkt

Elke afhankelijkheid tijdens de uitvoering die je toevoegt, wordt een afhankelijkheid voor al je gebruikers. Geef waar redelijk de voorkeur aan de standaardbibliotheek en voeg alleen een gem toe als die de extra afhankelijkheid waard is.

Minder afhankelijkheden betekenen minder versieconflicten en snellere installaties.

Documenteer de openbare API

Voeg opmerkingen toe waarin je de argumenten en geretourneerde waarde van elke openbare methode beschrijft. Hulpmiddelen zoals YARD zetten deze om in doorzoekbare documentatie, en een goede README met voorbeelden bepaalt vaak of mensen je gem gaan gebruiken.

Korte controle

Controleer je begrip van het organiseren van gemcode.

Beantwoord dit in de interactieve les

Samenvatting: de code schrijven

Je hebt geleerd hoe je de interne onderdelen van een gem organiseert:

Wikkel alles in een naamruimtemodule.
Laat bestandspaden overeenkomen met constantnamen.
Houd de openbare API klein en markeer hulpmethoden met private.
Definieer eigen foutklassen en voorkom globale monkeypatching.
Houd afhankelijkheden beperkt en documenteer de API.

Vervolgens voegen we tests en versiebeheer toe.

Gratis beginnen

Leer Ruby met een AI-tutor — gratis

Schrijf echte code en voer die uit in je browser, krijg direct hulp van een AI-tutor die 24/7 beschikbaar is en ga verder waar je gebleven bent op het web of in de app.

Cursussen: 29
Lessen: 109

Gratis beginnen met leren Bekijk de volledige cursus

Veelgestelde vragen

Is de les “De code schrijven” gratis?

Ja — je kunt hier op het web alle 3 lessen van het leerpad Ruby Academy, waaronder “De code schrijven”, gratis volledig lezen. Daarna ontgrendelt CoddyKit PRO alle lessen, plus interactieve oefeningen met een ingebouwde code-editor en een AI-tutor die 24/7 beschikbaar is. De cursus Ruby Academy bevat in totaal 4 lessen.

Wat leer ik in “De code schrijven”?

Een gem organiseren Je oefent met Ruby Academy door code rechtstreeks in de browser uit te voeren. Een AI-begeleider die 24/7 beschikbaar is beantwoordt je vragen terwijl je de les doorwerkt.

Heb ik ervaring nodig om met Ruby Academy te beginnen?

Ervaring vooraf is niet nodig. Ruby Academy op CoddyKit is opgebouwd voor beginners tot gevorderden, zodat je hier of bij het begin kunt starten en in je eigen tempo kunt leren. Dit is les 2 van 4.

Hoe lang duurt de les “De code schrijven”?

De meeste lessen van CoddyKit duren ongeveer 5–10 minuten. Elke les is kort en interactief, zodat je gestaag vooruitgaat en op het web en in de app precies verdergaat waar je was gebleven.

Kan ik code schrijven en uitvoeren in deze les over Ruby Academy?

Ja. Elke les over Ruby Academy bevat een ingebouwde code-editor, zodat je rechtstreeks in je browser echte code kunt schrijven en uitvoeren en direct feedback van AI krijgt — lokale installatie is niet nodig.

Alle lessen in deze cursus

← Terug naar Ruby Academy