Tworzę rubinowy klejnot i zauważyłem, że nie istnieje (według mojej wiedzy) konwencja nazywania klejnotów. Na przykład, widziałem zarówno:Konwencje nazewnictwa klejnotów Ruby
gem 'foo-bar'
gem 'foo_bar'
Czy istnieje jakiś Definitive Guide/konwencji nazewnictwa kamieni Ruby?
Wersja przerywana jest dla rozszerzeń na innych forach, jak rspec-rails i podkreślenia jest za część normalnego nazwy gem i powinny być camelCased w swoich klasach.
Jeśli masz klejnot o nazwie foo_bar, klasa/moduł powinna mieć nazwę FooBar. Jeśli to klejnot powinien mieć rozszerzenie szynach, które statki jako inny gem należy nazwie foo_bar-rails a moduł powinien być nazywany FooBar::Rails i powinno być wymagane jako require "foo_bar/rails"
Ta konwencja jest również to, co Bundler stara się wymagać.
Prawdą jest, że ta konwencja nie zawsze jest przestrzegana. jquery_rails powinien faktycznie być jquery-rails i factory_girl_rails powinien być nazywany factory_girl-rails. Ale hej, nie wszystko jest idealne.
rubygems docs konwencji:
Jest to wzmocnione przez dokumentację wzorów rubygmatów [tutaj ] (http://guides.rubygems.org/patterns/). – turboladen
[Nazwa twojego klejnotu] (http://guides.rubygems.org/name-your-gem/) – rthbound
https://github.com/rails/jquery-rails;) – Volte
Jedną z korzyści jest konwencja polegająca na zawaleniu się foo_bar na moduł lub klasę FooBar, jeśli chodzi o autoloadery. foo-bar nie ma domyślnego odpowiednika.
Ogólnie wersja podkreślona jest preferowana z perspektywy require, ale wersja przerywana jest bardziej czytelna, więc często się jej używa.
Przerywana wersja jest bardziej czytelna‽ Wydaje mi się to całkowicie błędne, w jakim języku mogą w nim występować identyfikatory? – Nemo157
@ Nemo157 - e.i. w CLIPS. Kiedyś programowałem i posiadanie kresek w identyfikatorach było miłym dodatkiem. Nie trzeba było naciskać
W rekomendacji @svenfuchs:
https://twitter.com/svenfuchs/status/135773593526206464
Ale prawdą jest, że Nadal widzę zachowania niekoherencyjne, takie jak:
gem 'my_gem`, :require => 'my-gem'
okazuje się, że to zostanie odebrane dość jasno i zwięźle w rubygems docs: http://guides.rubygems.org/name-your-gem/
(Może to być ostatni dodatek do dokumentu, ponieważ pamiętam, jak szukałem tych informacji w przeszłości i nie mogłem ich znaleźć.)
możliwy duplikat [Czy należy używać kresek lub podkreślenia przy nazywaniu klejnotem więcej niż jednym słowem?] (Http://stackoverflow.com/questions/4687659/should-one-use-dashes-or-underscores- kiedy-nazywanie-a-gem-z-więcej niż jednym wyrazem) –