Co to jest klejnot? – RubyGems Guides

Odkryj tajemnicę za tym, co jest w RubyGem.

Struktura Gem

Każdy gem ma nazwę, wersję i platformę. Na przykład, gem therake ma wersję 0.8.7 (z maja 2009). Platforma Rake’a to ruby, co oznacza, że działa na każdej platformie, na której działa Rubyruns.

Platformy są oparte na architekturze procesora, typie systemu operacyjnego i czasami wersji systemu operacyjnego. Przykłady to „x86-mingw32” lub „java”. Platforma wskazuje, że gem działa tylko z rubinem zbudowanym dla tej samej platformy. RubyGems automatycznie pobierze odpowiednią wersję dla twojej platformy. Zobacz gem help platform po pełne szczegóły.

Wewnątrz klejnotów znajdują się następujące komponenty:

• Kod (włączając w to testy i wspierające narzędzia)
• Dokumentacja
• gemspec

Każdy klejnot podąża za tą samą standardową strukturą organizacji kodu:

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

Tutaj możesz zobaczyć główne komponenty klejnotu:

• Katalog lib zawiera kod klejnotu
• Katalog test lub spec zawiera testy, w zależności od tego, jakiego frameworka testowego używa programista
• Klejnot gem zwykle ma Rakefile, którego program therake używa do automatyzacji testów,generowania kodu i wykonywania innych zadań.
• Ten gem zawiera również plik wykonywalny w katalogubin, który zostanie załadowany do PATH użytkownika, gdy gem zostanie zainstalowany.
• Dokumentacja jest zwykle zawarta w README i inline z kodem.Kiedy instalujesz gem, dokumentacja jest generowana automatycznie dla ciebie.Większość gemów zawiera dokumentację RDoc, ale niektóre używają YARD docs zamiast tego.
• Ostatnim elementem jest gemspec, który zawiera informacje o gemie.Pliki klejnotu, informacje o testach, platformie, numerze wersji i inne są tu wypisane wraz z adresem e-mail i nazwiskiem autora.

Więcej informacji o pliku gemspec

Budując własnego gema

Plik gemspec

Plik gemspec określa informacje o gemie, takie jak jego nazwa, wersja, opis, autorzy i strona domowa.

Tutaj znajduje się przykład pliku gemspec. Możesz dowiedzieć się więcej, jak zrobić agem.

% 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

.