Was ist ein Edelstein? – RubyGems Guides

Lüften Sie das Geheimnis, was in einem RubyGem steckt.

Struktur eines Gems

Jeder Gem hat einen Namen, eine Version und eine Plattform. Zum Beispiel hat das Gem von Rake eine 0.8.7 Version (vom Mai 2009). Die Plattform von Rake ist ruby, was bedeutet, dass es auf jeder Plattform funktioniert, auf der Rubyruns läuft.

Plattformen basieren auf der CPU-Architektur, dem Betriebssystemtyp und manchmal auch der Betriebssystemversion. Beispiele sind „x86-mingw32“ oder „java“. Die Plattform gibt an, dass das Gem nur mit einem Ruby funktioniert, das für dieselbe Plattform gebaut wurde. RubyGems lädt automatisch die richtige Version für deine Plattform herunter. Siehe gem help platform für weitere Details.

Innerhalb von Gems gibt es die folgenden Komponenten:

• Code (einschließlich Tests und unterstützende Hilfsprogramme)
• Dokumentation
• gemspec

Jeder Gem folgt der gleichen Standardstruktur der Codeorganisation:

% tree freewillfreewill/├── bin/│ └── freewill├── lib/│ └── freewill.rb├── test/│ └── test_freewill.rb├── README├── Rakefile└── freewill.gemspec

Hier siehst du die Hauptkomponenten eines Gems:

• Das lib-Verzeichnis enthält den Code für das Gem
• Das test– oder spec-Verzeichnis enthält Tests, je nachdem, welches Testframework der Entwickler verwendet
• Ein Gem hat in der Regel ein Rakefile, das vom Programm therake verwendet wird, um Tests zu automatisieren, Code zu generieren und andere Aufgaben durchzuführen.
• Dieses Gem enthält auch eine ausführbare Datei im Verzeichnis bin, die in das PATH des Benutzers geladen wird, wenn das Gem installiert wird.
• Dokumentation ist normalerweise im README und inline mit dem Code enthalten.
• Wenn Sie einen Edelstein installieren, wird die Dokumentation automatisch für Sie generiert.
• Die meisten Edelsteine enthalten RDoc-Dokumentation, aber einige verwenden stattdessen YARD-Dokumente.
• Der letzte Teil ist die Gemspec, die Informationen über den Edelstein enthält.Die Dateien des Edelsteins, die Testinformationen, die Plattform, die Versionsnummer und mehr werden hier zusammen mit der E-Mail und dem Namen des Autors aufgeführt.

Mehr Informationen über die gemspec Datei

Eigene Gems erstellen

Die Gemspec

Die gemspec spezifiziert die Informationen über einen Gem wie seinen Namen, Version, Beschreibung, Autoren und Homepage.

Hier ist ein Beispiel für eine gemspec Datei. Du kannst mehr darüber lernen, wie man agem macht.

% cat freewill.gemspecGem::Specification.new do |s| s.name = 'freewill' s.version = '1.0.0' s.summary = "Freewill!" s.description = "I will choose Freewill!" s.authors = s.email = '[email protected]' s.homepage = 'http://example.com/freewill' s.files = end