More than 5 years have passed since last update.

Ruby 命名規則まとめ

Last updated at 2017-10-09Posted at 2017-10-09

別言語からRubyに来た人にとって、最初に引っかかるポイントである言語の慣用について、今回はRubyらしくあるために、Rubyの命名規則をまとめてみました。

クラス名、モジュール名

キャメルケース(CamelCase)：各単語の頭文字を大文字にする、_は使用しない。
ただし、HTMLやFTPなどの略語はすべて大文字にします。

# NG
Foo_Class
barmodule
bazClass
ApiServer

# OK
FooClass
BarModule
BazClass
APIServer

スネークケース(snake_cace)：すべてを小文字にし、単語の区切りを_で繋ぐ

そして、ファイル名にはクラス名やモジュール名をスネークケースに変更した名前を使用し、ディレクトリ名にはモジュールの名前空間をスネークケースに変更した名前を使用します。

class FooClass
end

# ファイル名はスネークケース 
foo_class.rb

module HogeHoge
  module Foo
    class Bar
    end
  end
end

# ディレクトリ構造は名前空間と対応させる
hoge_hoge/foo/bar.rb

スネークケース(snake_cace)：すべてを小文字にし、単語の区切りを_で繋ぐ

# NG
Foomethod
barMethod

# OK
foo_method
bar_method

スクリーミングスネークケース(SCREAMING_SNAKE_CASE)：すべてを大文字にし、単語の区切りを_で繋ぐ

# NG
Max_Size

# OK
MAX_SIZE

真偽を返すメソッドであれば最後に?を付与します。冗長になるためメソッドの先頭にisやdoes、またcanなどの助動詞を置かないようにします。

# NG
class MotocrossGP
  def is_fast_rider?
    true
  end
end

# OK
class MotocrossGP
  def fast_rider?
    true
  end
end

selfや引数を変更するようなメソッドは最後に!を付与します。また可能であれば破壊的メソッドに対応する非破壊的なメソッドも用意します。

# NG
def update!
end

# OK
def update # 可能であれば非破壊的なメソッドも用意する
end

def update!
end