【Rails】ネーミングのお作法：MVC編

Last updated at 2023-09-29Posted at 2023-09-29

はじめに

Railsでの一般的な命名規則について説明していきます。

表記法

キャメル（camel）はラクダのことで、コブに見立てて単語ごとの頭文字を大文字で表記します。
全体の先頭の文字は、大文字の場合と小文字の場合とがある。

主にクラス名、モジュール名で使用され
先頭が大文字のキャメルケースで表記します。

admin_user.rb

# 例
class AdminUser
end

主にJavaScriptの変数名などで使用され
先頭が小文字のキャメルケースで表記します。

.js

// 例
const helloWorld = "ハローワールド";
console.log(helloWorld);
...

主に変数名、ファイル名で使用され
単語の区切りを_アンダースコアで表記します。

users_controller.rb

# 例
class UsersController

    def set_user
    ...
    end

    def user_params
    ...
    end
end

変更しない定数などを表現する際に使用され、
全て大文字のスネークケースで表記します。

.rb

TAX_RATE = 0.1

主にHTMLのクラス名などで使用されるケバブケース。
棒に刺さった肉の様に単語の区切りを-ハイフンでで表記します。

.haml

.box
  .box-header.with-border
    %h3.box-title= "タイトル"

MVCアーキテクチャは、アプリケーションのコードを3つの主要なコンポーネントに分割します。
それぞれの命名規則を解説します。

モデルは単数形キャメルケースの名前を使用します。
テーブル名は複数形でなければなりません。
そしてモデルクラスのファイル名は単数形スネークケースを使用します。

ビューのテンプレートファイルはコントローラ名と対応するディレクトリ内に保存されます。

ビューファイルの名前はアクション名に対応し、スネークケースを使用します。
例：app/views/admin_users/index.html.haml
パーシャルビュー（再利用可能な部分ビュー）はアンダースコアで始まることが一般的です。
例：app/views/admin_users/_form.html.haml

ルーティングではRESTfulなルーティングを使用し、リソース名を複数形で表現します。

.rb

resources :admin_users

複数のアクションを管理するコントローラは複数形の名前を使用します。
コントローラクラスのファイル名も複数形スネークケースを使用します。

今回はMVCの命名についてお話しました。
次回はメソッド名や変数名などのネーミングについて書こうかと思います。