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类。