Ruby Academy · Lektion

Gem-struktur

Filer og gemspec

Lektion 1 af 413 trin

Gem-struktur er en gratis Ruby Academy-lektion på CoddyKit. Dette er lektion 1 af 4. Du kan læse alle 3 lektioner i dette læringsspor gratis i deres fulde længde — derefter låser CoddyKit PRO alle lektioner op samt praktiske øvelser med en indbygget kodeeditor og en AI-underviser døgnet rundt. Den er en del af læringsforløbet i Ruby Academy, og dine fremskridt synkroniseres på tværs af nettet og CoddyKit-appen. Ruby Academy-kurset indeholder 4 lektioner i alt.

Hvad er en gem?

En gem er et pakket Ruby-bibliotek eller en pakket Ruby-applikation, som kan installeres, versionsstyres og deles via RubyGems. Næsten alle Ruby-værktøjer, du bruger, er gems.

  • En gem samler kode, metadata og afhængigheder.
  • Metadataene ligger i en gemspec-fil.
  • Værktøjer som bundler og gem håndterer gems.

Opret et grundskelet

Den hurtigste start er bundle gem mygem. Den opretter standardmappestrukturen, en gemspec, en testmappe, en README-fil og en licens. Derefter udfylder du koden.

Standardstrukturen

En typisk gem med navnet mygem ser sådan ud:

  • lib/mygem.rb er startfilen.
  • lib/mygem/ indeholder yderligere kildefiler.
  • lib/mygem/version.rb indeholder versionskonstanten.
  • mygem.gemspec indeholder metadataene.
  • test/ eller spec/ indeholder testene.
  • README.md og en licensfil.

Startfilen

lib/mygem.rb indlæses, når nogen kører require 'mygem'. Den indlæser normalt versionsfilen og resten af biblioteket og definerer modulet på øverste niveau.

module Mygem
  def self.greet(name)
    "Hello, " + name
  end
end

puts Mygem.greet("world")

Versionsfilen

Hvis versionen ligger i sin egen fil, kan både gemspece-filen og koden læse den. Konventionen er en VERSION-konstant inde i gemmens modul.

module Mygem
  VERSION = "0.1.0"
end

puts "Current version: " + Mygem::VERSION

Hvad er en gemspec?

En gemspec er en Ruby-fil, der beskriver gemmen: dens navn, version, forfatter, resumé, filer og afhængigheder. RubyGems læser den for at bygge og udgive pakken.

Det er almindelig Ruby, så du kan beregne værdier, men hold den enkel og deklarativ.

En minimal gemspec

De centrale felter er navn, version, forfattere, resumé og filer. Her er strukturen skrevet som almindelig Ruby, som du kunne placere i mygem.gemspec.

require "ostruct"

spec = OpenStruct.new
spec.name = "mygem"
spec.version = "0.1.0"
spec.authors = ["Your Name"]
spec.summary = "A tiny example gem"

puts spec.name + " " + spec.version

Oplistning af filer

Gemspec-filen skal angive, hvilke filer der følger med gemmen. Mange gemspec-filer beder git om de sporede filer, så intet bliver glemt:

spec.files = Dir['lib/**/*.rb'] + ['README.md']

Kun de angivne filer pakkes, så en glemt fil medfører en installation, der ikke fungerer.

Angivelse af afhængigheder

Der findes to slags afhængigheder i gemspec-filen:

  • add_dependency til afhængigheder ved kørsel, som brugerne skal installere.
  • add_development_dependency til værktøjer, der kun bruges under udvikling, f.eks. testrammer.

Brug versionsbegrænsninger som '~> 1.2' for at bevare kompatibiliteten.

Påkrævet Ruby-version

Angiv spec.required_ruby_version, så brugere med en for gammel Ruby-version får en tydelig fejl i stedet for et forvirrende nedbrud. Udfyld også homepage, license og metadata for at gøre gemmen gennemarbejdet.

required = ">= 3.0.0"
current = RUBY_VERSION
puts "Requires Ruby " + required
puts "Running Ruby " + current

Byg gemmen

Når gemspec-filen er klar, opretter gem build mygem.gemspec en .gem-fil. Du kan installere den lokalt med gem install ./mygem-0.1.0.gem for at teste den før udgivelsen.

Hurtig test

Test din forståelse af en gemmes struktur.

Opsummering: Gemstruktur

Du har lært, hvordan en gem er opbygget:

  • bundle gem opretter grundstrukturen.
  • lib/mygem.rb er startpunktet.
  • Versionen ligger i sin egen fil.
  • gemspec-filen indeholder metadata, filer og afhængigheder.
  • gem build pakker den.

Nu organiserer vi den egentlige kode inde i gemmen.

Gratis at komme i gang

Lær Ruby med en AI-underviser — gratis

Skriv og kør rigtig kode i din browser, få øjeblikkelig hjælp fra en AI-underviser døgnet rundt, og fortsæt, hvor du slap, på web eller i appen.

Kurser
29
Lektioner
109

Ofte stillede spørgsmål

Er lektionen “Gem-struktur” gratis?

Ja — alle 3 lektioner i læringssporet Ruby Academy, inklusive “Gem-struktur”, kan læses gratis i deres fulde længde her på webstedet. Derefter låser CoddyKit PRO alle lektioner op samt interaktive øvelser med en indbygget kodeeditor og en AI-underviser døgnet rundt. Ruby Academy-kurset indeholder 4 lektioner i alt.

Hvad lærer jeg i “Gem-struktur”?

Filer og gemspec Du øver dig i Ruby Academy med praktisk kode, som du kører direkte i browseren, og en AI-vejleder døgnet rundt besvarer dine spørgsmål, mens du arbejder dig gennem lektionen.

Skal jeg have erfaring for at begynde på Ruby Academy?

Der kræves ingen tidligere erfaring. Ruby Academy på CoddyKit er tilrettelagt for både begyndere og øvede, så du kan starte her eller fra begyndelsen og lære i dit eget tempo. Dette er lektion 1 af 4.

Hvor lang tid tager lektionen “Gem-struktur”?

De fleste CoddyKit-lektioner tager cirka 5–10 minutter. Hver lektion er kort og interaktiv, så du gør løbende fremskridt og kan fortsætte, hvor du slap – på både web og app.

Kan jeg skrive og køre kode i denne Ruby Academy-lektion?

Ja. Alle Ruby Academy-lektioner har en indbygget kodeeditor, så du kan skrive og køre rigtig kode direkte i din browser og få øjeblikkelig feedback fra AI – uden lokal opsætning.

Alle lektioner i dette kursus

  1. Gem-struktur
  2. Skriv koden
  3. Test og versionsstyring
  4. Udgivelse til RubyGems
← Tilbage til Ruby Academy