Ruby - 命名約定 - 類/模塊名稱中縮寫詞的字母大小寫？

Question

我需要在名爲「SCM」的模塊內創建一個代表「SVN」的類。但我不知道在Ruby中處理縮略詞時會有什麼約定，並且在Google中找不到任何與之相關的內容，除非「Camel case is preferred」。

我應該叫它SCM::SVN還是Scm::Svn？這是否有一個約定？

Answer 1

SCM::SVN看起來最好給我。 Rails充滿了類似ERB，ORM和OMFGIMATEAPOT的類。這並不是說像JSONSerializer這樣的東西。 Ruby的來源也有a bunch of acronyms。最明顯的例子是YAML。我見過的標準是爲CamelCase提供信件，但通常不會降低它們（儘管Rails對模型名稱有意見）。

如果你有grep和源代碼，你可以看到很多的例子有類似

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

我認爲SCM::SVN看起來更美觀（美學），我也見過使用相同約定的庫。這真的只是你認爲更好的問題。

（但請注意，如果你正在建設一個Rails項目，並希望該模塊從/ lib目錄被自動加載，您可能需要使用Scm::Svn）。

Answer 3

添加以下config/initializers/inflections.rb。

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

現在運行$ rails g model SVN…將創建一個名爲SVN在名爲svn.rb文件和相關的表svns類。