Ruby - Adlandırma Kuralı - sınıf/modül adlarındaki kısaltmaların harf durumu?

Question

"SCM" adlı bir modülde "SVN" yi temsil eden bir sınıf oluşturmam gerekiyor. Ama Ruby'de kısaltmalar ile uğraşırken konvansiyonun ne olduğunu bilmiyorum ve "Camel case tercih edilir" dışında Google ile alakalı hiçbir şey bulamadım.

SCM::SVN veya Scm::Svn mu arayayım? Bunun için bir sözleşme var mı?

Answer 1

SCM::SVN bana en iyi görünüyor. Raylar, ERB, ORM ve OMFGIMATEAPOT gibi sınıflarla dolu. Ve bu JSONSerializer gibi şeylerden bahsetmiyor. Ruby'nin kaynağı da a bunch of acronyms. Bana en açık örnek, YAML. Gördüğüm gibi standart CamelCase için mektuplar açmak ama genellikle onları downcase için değil (Rails model isimleri hakkında fikirleri olmasına rağmen).

grep varsa ve kaynak kodu config/initializers/inflections.rb aşağıdakileri ekleyin

grep -r 'class [A-Z]\{3,\}' <path/to/source> 
# or, if you only want acronyms and nothing like YAMLColumn: 
grep -rw 'class [A-Z]\{3,\}' <path/to/source> 

Answer 2

Bence SCM::SVN daha iyi görünüyor (estetik olarak) ve aynı sözleşmeyi kullanan kütüphaneleri gördüm. Gerçekten düşündüğün şeyin daha iyi bir meselesi.

(Ancak, bir Raylar projeyi inşa ediyoruz eğer unutmayın ve bu modül/lib dizinden otomatik yüklenmesi olmak istiyorum, sen Scm::Svn kullanmak gerekebilir.)

Answer 3

gibi bir şeyle örnekler bol görebiliyorsanız.

ActiveSupport::Inflector.inflections(:en) do |inflect| 
    inflect.acronym 'SVN' 
end 

Şimdi $ rails g model SVN… çalışan svn.rb adlı bir dosyaya ve ilişkili bir tabloda svns yılında SVN adında bir sınıf oluşturur.