Ruby - 命名規則 - クラス/モジュール名の頭字語の大文字小文字？

Question

「SCM」と呼ばれるモジュールの中に「SVN」を表すクラスを作成する必要があります。しかし、私はRubyの頭文字語を扱う際の規約は何か分かりません。「Camelの場合が好ましい」を除き、Googleに関連するものは見つかりませんでした。

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.rbという名前のファイルと関連テーブルsvnsでSVNという名前のクラスを作成します。