Mi az a drágakő? – RubyGems útmutatók
On október 24, 2021 by adminTöri fel a rejtélyt, hogy mi van egy RubyGemben.
A gem felépítése
Minden gemnek van neve, verziója és platformja. Például a therake gem-nek van egy 0.8.7
verziója (2009 májusától). A Rake platformja ruby
, ami azt jelenti, hogy bármilyen platformon működik a Rubyrun.
A platformok a CPU architektúrán, az operációs rendszer típusán és néha az operációs rendszer verzióján alapulnak. Ilyen például az “x86-mingw32” vagy a “java”. A platform azt jelzi, hogy a gem csak az ugyanarra a platformra épített rubyval működik. A RubyGems automatikusan letölti a megfelelő verziót az Ön platformjához. Lásd gem help platform
a teljes részleteket.
A gemek a következő komponensekből állnak:
- Kód (beleértve a teszteket és a támogató segédprogramokat)
- Dokumentáció
- gemspec
Minden gem ugyanazt a szabványos kódszervezési struktúrát követi:
% tree freewillfreewill/├── bin/│ └── freewill├── lib/│ └── freewill.rb├── test/│ └── test_freewill.rb├── README├── Rakefile└── freewill.gemspec
Itt láthatja a gem főbb összetevőit:
- A
lib
könyvtár tartalmazza a gem kódját - A
test
vagyspec
könyvtár tartalmazza a teszteket, attól függően, hogy a fejlesztő melyik tesztframework-t használja - A gem-hez általában tartozik egy
Rakefile
, amelyet a therake program a tesztek automatizálására,kódgenerálásra és egyéb feladatok elvégzésére használ. - Ez a gem tartalmaz egy futtatható fájlt is a
bin
könyvtárban, amely a gem telepítésekor betöltődik a felhasználóPATH
könyvtárába. - A dokumentáció általában a
README
-ben és a kóddal egy sorban található.Amikor telepítünk egy gem-et, a dokumentáció automatikusan generálódik a felhasználó számára.A legtöbb gem RDoc dokumentációt tartalmaz,de egyesek helyette YARD dokumentációt használnak. - Az utolsó darab a gemspec, amely a gem-ről szóló információkat tartalmazza.A gem fájljai, a tesztinformációk, a platform, a verziószám és még sok minden más itt található a szerző e-mail címével és nevével együtt.
Bővebb információ a gemspec fájlról
A saját gem építése
A gemspec
A gemspec meghatározza a gemre vonatkozó információkat, például a nevét, verzióját,leírását, szerzőit és honlapját.
Itt egy példa egy gemspec fájlra. Többet megtudhatsz a how to make 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
fejezetben.
Vélemény, hozzászólás?