rails のクラスの命名規約について

Question

railsで他ファイルのクラスを扱えるのはどういう時ですか?
railsで他のファイルからクラスを扱うには
require "./app/form/staff/login_form.rb"
のように書く必要がありますが以下の場合だと書く必要がありません
どうしてですか？

/app/form/staff/login_form.rb

class Staff::LoginForm
    include ActiveModel::Model

    attr_accessor :email, :password
end

class Staff::SessionsController < ApplicationController
    def new
        @form = Staff::LoginForm.new
        render action: "new"
    end
end

Comments

[winterboum]

require "./app/form/staff/login_form.rb" が必要なのは
class LoginForm
のときですか？

[hase744]

そうです！

Answer 1

Rails は 未定義の class や module にであうと、それを定義したfileを探し出して自動で取り込んでくれますが、そのためには class,module名とfile path の間に厳密な関係があります。

先頭の大文字は小文字にする
以外の大文字は 小文字にしてその前に下線をつける
:: は / にする
大文字が2つ以上連続したら、、、、、

などです。

ですので、
class Staff::LoginForm が form/staff/login_form.rb で定義してあれば自動で取り込まれますが form/login_form.rb では探してくれません。
class LoginForm でしたらそこで見つけてくれます。

Comments

[hase744]

なるほど、名前空間だったんですね！

Answer 2

今回の質問は明示的にrequireをしなくてもクラスが使える条件という事でいいでしょうか？
Railsでは、app/任意のディレクトリ/.rbは自動的に読み込んでくれます。
したがって、app/form/.rbやapp/form//.rbはすでにrequire済みなのでそのまま使えます。

※ちなみに、app/models, app/controllersのようにapp/以下のディレクトリ名は複数形になっているので、app/formよりはapp/formsがおすすめだったりします。
動作には関係ありませんが。

Comments

[hase744]

そうだったんですね！
あとクラス名をStaff::LoginFormからLoginFormにして @form = LoginForm.newにした途端
ninitialized constant Staff::SessionsController::LoginForm Did you mean? Staff::LoginForm
とエラーが出ます
Staff::は親フォルダを表してるんですかね？
だとしたらForm::Staff::LoginFormではないのは何故ですか？
クラス名をForm::Staff::LoginFormにしたら
uninitialized constant Staff::SessionsController::Form
というエラーが起きます

[mingos]

> Staff::は親フォルダを表してるんですかね？
フォルダ名ではありません。
それはRubyの名前空間(namespace)です。

あなたがclass Staff::XXXと書いたからStaffという名前空間が定義されました。
これはRubyの中でのお話でフォルダは関係ないです。
Rubyの中での概念上のフォルダと考えてもいいです(正確ではないですが)。

例えば、app/models/login_form.rbにおいたとして、
その中身が、
class Staff::LoginForm
end
だったら、自動的にはrequireしてくれません。
しかし、require("./app/models/login_form.rb")と書いてやれば、Staff::LoginFormは認識されます。

でもこれはめちゃくちゃ使いづらい上に効率が悪い。
そこで、Railsでは、名前空間とファイルを配置する場所が一致した場合自動でrequire してくれます。

class Staff::LoginFormなら staff/login_form.rbという事になるので、
app/任意のフォルダ/staff/login_form.rbに置いてあれば自動でrequireしますよということです。
そういう事でしかないので、任意のフォルダはどうでもいいのです。
今回の場合app/formですが、app/formのformは任意のフォルダに相当するので、
クラス名にも名前空間にも関係ありません。

Form::Staff::LoginFormが使いたければ、上のルールに従ってlogin_fom.rbの中を
class Form::Staff::LoginForm
end
と書いて、app/form/form/staff/login_form.rbに配置すればOKです。

[hase744]

名前空間っていうのがあったんですね！
丁寧にありがとうございます