はじめに
プログラミングスクールで、Railsの管理画面を作るカリキュラムを進めていました。
手順どおりにコードを書けば、画面はちゃんと動きます。
でも、ふと手が止まりました。
うーん🧐
class Staff::DashboardsController < Staff::BaseController
def index; end
end
index しか書いていないのに、ログインしていない人や、スタッフでない人はちゃんと弾かれる。
で、「どこにそんなチェックが書いてあるの?」と聞かれたら、答えられない。
正直に言うと、いつものごとく、なんとなくで進めていた ことに気づきました。
技術面談で質問しようと思い、聞きたいことを整理し始めたのですが、
「何がわからないのか」すらうまく言葉にできませんでした。
そんなとき、講師の方からこの仕組みを 秘密組織の掟 にたとえてもらったら、
バラバラだった before_action・継承・skip_before_action が一本の線でつながりました。
この記事は、そのときの整理を自分の言葉でまとめ直したものです。
小さな組織図を何度も出しながら、「この掟が、ここにかかる → だからコードはこうなる」 を一緒にやっていきます!
※記事中のコードは、カリキュラムのものではなく「スタッフ用画面」という例に置き換えています。
この記事で分かること
- 子の Controller に何も書いていないのに、チェックがかかる理由
- before_action がかかる順番
- skip_before_action で「外す」場所と、その理由
- メソッドを上書きしたのに効かないときの考え方
対象読者
- before_action を書いたことはある人
- 「継承」と聞くと、なんとなくわかった気になって止まる人(私です)
この記事の流れ
| STEP | 組織で言うと | Railsで言うと |
|---|---|---|
| 1 | 掟を1つ決める | before_action |
| 2 | 掟は下の階に受け継がれる | Controller の継承 |
| 3 | 掟は上の階から順に確かめる | before_action の順番 |
| 4 | 受付だけ掟を外す | skip_before_action |
| 5 | 案内係の台本を書き換えたのに出番がない | 上書きしたメソッドが呼ばれない |
今回の例:スタッフ用画面
| Controller | 役割 |
|---|---|
ApplicationController |
すべての Controller の親 |
Staff::BaseController |
スタッフ用画面の親 |
Staff::SessionsController |
スタッフ用のログイン画面 |
Staff::DashboardsController |
スタッフ用のトップページ |
登場人物(秘密組織のみなさん)
| 人物 | Railsで言うと |
|---|---|
| 🕴️ 門番 |
require_login(組織の人間か確かめる) |
| 🎩 幹部 |
check_staff(幹部かどうか確かめる) |
| 🛎️ 受付係 |
Staff::SessionsController(名乗ってもらう場所) |
| 📋 案内係 |
not_authenticated(追い返すときの行き先を伝える) |
| 🔰 新入り | 私(たぶんあなたも) |
全体図はこうなります。今は分からなくて大丈夫です。最後にもう一度見ます。
STEP 1:掟を1つ決める(before_action)
🕴️ 門番「止まれ。組織の人間か? ……名乗れない者は、ここから先には通さない」
まずは組織全体に、掟を1つだけ決めます。
# app/controllers/application_controller.rb
class ApplicationController < ActionController::Base
before_action :require_login
private
def require_login
redirect_to login_path unless logged_in?
end
end
| 組織で言うと | Railsで言うと |
|---|---|
| 「組織の人間以外は入れるな」という掟 | before_action :require_login |
| 門の前での身元確認 |
require_login メソッドの中身 |
before_action は「どの部屋(アクション)に入る前にも、この確認をしてね」という掟です。
確認に通らなければ、その場で追い返されます(redirect_to)。
ここまでは、たぶん大丈夫ですよね。私もここまでは「わかってるつもり」でした。
💡小ネタ:before_action は「確認の名前」を登録しているだけ
before_action :require_loginの:require_loginはメソッドの名前です。
掟の中身(どう確かめるか)は、下のdef require_loginに書きます。
STEP 2:掟は下の階に受け継がれる(継承)
次に、幹部フロア(スタッフ用画面)を作ります。
# app/controllers/staff/base_controller.rb
class Staff::BaseController < ApplicationController
before_action :check_staff
private
def check_staff
redirect_to root_path, alert: '権限がありません' unless current_user.staff?
end
end
読む
① Staff::BaseController < ApplicationController の < は「親は ApplicationController だよ」という意味
② 子は、親の before_action を 全部受け継ぐ
③ だから幹部フロアには、組織全体の掟と幹部フロアの掟の2つがかかる
だからコードはこう
# app/controllers/staff/dashboards_controller.rb
class Staff::DashboardsController < Staff::BaseController
def index; end
end
🔰 新入り「あの……会議室のドアには、何の張り紙もないんですけど。誰がチェックしてるんですか?」
🎩 幹部「張り紙なら、このフロアの入口に1枚あるだろう。組織全体の掟と、このフロアの掟。会議室にいちいち貼る必要はない」
会議室(DashboardsController)には、自分では何も書いていません。
それでも < Staff::BaseController の1行で、2つの掟がかかります。
そう、冒頭の「どこにチェックが書いてあるの?」の答えは、「親に書いてある」 でした。
……言われてみれば当たり前なんですが、私はここで「あっ」となりました😳
💡小ネタ:かかっている掟を一覧で見る
rails console で、その Controller にかかっている before_action を確かめられます。Staff::DashboardsController._process_action_callbacks.map(&:filter) # => [..., :require_login, :check_staff](設定によっては、Rails が自動で入れている確認も一緒に並びます)
たとえの限界
組織では幹部が下っ端より偉いですが、Rails の継承は「偉さ」ではなく ルールをコピーしてもらう関係 です。
STEP 3:掟は上の階から順に確かめる(順番)
会議室に入ろうとすると、2つの掟がこの順番でかかります。
🕴️ 門番「まずは俺が、組織の人間かどうかを確かめる」
🎩 幹部「私が確かめるのは、そのあとだ。名乗れない者に、肩書きを聞いても仕方がないからな」
順番が「組織 → 幹部」なのは、親の before_action が先に登録されている からです。
そして、この順番にはちゃんと意味があります。
check_staff は current_user.staff? を呼ぶので、ログインしていない人(current_user が nil)がここまで来るとエラーになります。
先に require_login が止めてくれるから、check_staff は安心して current_user を使えるわけです。
STEP 4:受付だけ掟を外す(skip_before_action)
ここで問題が起きます。幹部フロアの 受付(ログイン画面)にも、2つの掟がかかってしまうのです。
🛎️ 受付係「いらっしゃいませ。お名前を……」
🕴️ 門番「待て。組織の人間か?」
🔰 新入り「いや、だから今から名乗るところなんですけど……」
受付は「これから名乗る人」が来る場所。
名乗る前の人に「組織の人間か?」「幹部か?」と聞いても、答えられるわけがありません。
だからコードはこう
# app/controllers/staff/sessions_controller.rb
class Staff::SessionsController < Staff::BaseController
skip_before_action :require_login, only: %i[new create]
skip_before_action :check_staff, only: %i[new create]
def new; end # ログイン画面を表示
def create # メールアドレスとパスワードを確かめて、ログインさせる
end
end
🛎️ 受付係「受付の中だけは、門番さんと幹部さんにはご遠慮いただいております」
| 部品 | 意味 |
|---|---|
skip_before_action :require_login |
受け継いだ掟「組織の人間か?」を外す |
skip_before_action :check_staff |
受け継いだ掟「幹部か?」を外す |
only: %i[new create] |
外すのは、ログイン画面とログイン処理だけ |
💡小ネタ:
%i[new create]って何?
[:new, :create](シンボルの配列)の省略形です。今は「new と create のこと」で十分です。
わざと skip を消してみる
check_staff の skip だけを消して、ログアウトした状態でログイン画面を開くと、こうなります。
NoMethodError: undefined method 'staff?' for nil
🎩 幹部「君は幹部か?」
🔰 新入り「……(まだ誰でもない)」
「まだ名乗っていない人(nil)に、幹部かどうか聞いちゃった」様子が、そのまま書いてありますね。
よくある勘違い:受付ではログインできてしまう
受付(create)では、メールアドレスとパスワードしか確かめていません。
つまり、スタッフではない一般ユーザーでも、ログイン自体は成功します。
🛎️ 受付係「お名前と合言葉、確認できました。どうぞ奥へ」
🎩 幹部「……待て。君は幹部ではないな。お帰りはあちらだ」
追い返されるのは、受付ではなく 会議室の前 です。
私はずっと「受付で止めるんでしょ?」と思っていたので、ここでようやく理解がつながりました。
STEP 5:案内係の台本を書き換えたのに、出番がない
最後は、私がいちばんハマったところです。
ログインしていない人が幹部フロアに来たとき、
「一般の入口」ではなく「幹部フロアの受付」に案内したくなりました。
そこで、追い返すときの 案内係 にあたるメソッドを、幹部フロアで書き換えました。
# app/controllers/staff/base_controller.rb
def not_authenticated
redirect_to staff_login_path # 幹部フロアの受付へ
end
📋 案内係「台本、受け取りました。幹部フロアに迷い込んだ方は、幹部フロアの受付へご案内しますね!」
よし、これで完璧!……と思ったら、ログアウトした状態で /staff を開くと、一般のログイン画面に飛ばされる。
え、なんで?🤔
読む
組織全体の掟を見直すと、こうなっていました。
# app/controllers/application_controller.rb
def require_login
redirect_to login_path unless logged_in? # 案内係を呼んでいない
end
🕴️ 門番「組織の人間じゃない? じゃあ一般の入口へ行け」
📋 案内係「……あの、私の出番は? 台本まで用意したのに……」
門番が案内係を呼ばずに、自分で「一般の入口へ行け」と言ってしまっていたんです。
いくら案内係の台本を書き換えても、出番が来なければ意味がありません。
書き換えたメソッドは、誰かに呼ばれて初めて動きます。
だからコードはこう
# app/controllers/application_controller.rb
def require_login
not_authenticated unless logged_in?
end
def not_authenticated
redirect_to login_path # 一般側は今までどおり
end
🕴️ 門番「組織の人間じゃない? ……案内係、頼んだ」
📋 案内係「お任せください! ここは幹部フロアなので、幹部フロアの受付へどうぞ〜」
| どこで | 使われる案内係 | 行き先 |
|---|---|---|
| 一般の Controller | ApplicationController のもの | 一般のログイン画面 |
Staff:: の Controller |
Staff::BaseController で書き換えたもの | 幹部フロアの受付 |
たとえの限界
「台本を書き換える」と言っていますが、実際には親のメソッドはそのまま残っています。
Ruby は子のメソッドを先に探すので、同じ名前のメソッドを子に置くと、そちらが先に見つかるだけです。
もう一度、全体図を読む
最初に「今は分からなくて大丈夫」と言った図です。今ならどうでしょう?
| 図 | 組織で読むと | コード |
|---|---|---|
| ApplicationController | 組織全体の掟 | before_action :require_login |
| → Staff::BaseController | 掟を受け継ぎ、幹部フロアの掟を足す |
< ApplicationController + before_action :check_staff
|
| → Staff::SessionsController | 受付だけ、2つの掟を外す | skip_before_action ..., only: %i[new create] |
| → Staff::DashboardsController | 何も書かなくても、2つの掟がかかる | < Staff::BaseController |
🔰 新入り「会議室のドアに張り紙がなかったのは、フロアの入口で全部確かめてたからなんですね」
🎩 幹部「ようやくわかったか。ようこそ、組織へ」
まとめ
- before_action は「部屋に入る前の掟」。子の Controller は、親の掟を全部受け継ぐ
- 掟は親から順にかかる。だから
require_login→check_staffの順で安全に確かめられる - 名乗る前の人が使うアクション(ログイン画面・ログイン処理)だけ、skip_before_action で外す
- 書き換えたメソッドは、呼ばれなければ動かない
おわりに
before_action も継承も、それぞれは知っていました。
でも「掟が上から下に受け継がれて、受付だけ外す」という一枚の絵になったとき、
なんとなく写していた < Staff::BaseController の1行が、ちゃんと意味のある1行になりました。
「何がわからないのかわからない」ときは、自分の言葉で一回たとえ直してみると、意外と見えてくるかもしれません。
同じところでモヤモヤしている方の助けになればうれしいです!