namespace を使ってコントローラーをグループ化する

こんにちは、たわらです。

本記事は、namespace を使ったときのディレクトリ構成の情報をまとめたものです。

名前空間をつくるメリット

名前空間を使うメリットはざっくりふたつあるみたいです。wikipedia によれば、

名前空間（なまえくうかん）はNamespaceの訳語で、名前の集合を分割することで衝突の可能性を低減しつつ参照を容易にする概念である。

とあります。

１　集合を分けることで同じ名前を使うことができる

たとえば管理者用のログイン機能を実装するときに、user_sessions_controller という名前を使おうとします。ただし、既にサービスのログイン機能の実装の際に、その名前のコントローラー名を使用していると、アプリの挙動がおかしくなってしまう可能性があります。

２　参照が簡単になる

ディレクトリを見たときに、名前空間でファイルを分けておくと、人間も管理しやすいし、アプリケーションもファイルの参照が用意になります。たぶん。

routes.rb にこのように記載します。

namespace :admin do
  resources :articles
end

そして、ディレクトリを下記のようにつくってあげます。名前空間名のところにはこの場合、adminが入ります。

─ app 　├ controllers 　│└ 【名前空間名】 　│　└
【コントローラ名】_controller.rb 　└ views 　　└ 【名前空間名】 　　　└
【コントローラ名】 　　　　└ 【アクション名】.html.erb

コントローラーはこんな感じで記載します。

class 【名前空間名】::【コントローラ名】Controller < ApplicationController
  def 【アクション名】
　　hoge
  end
end

管理者じゃないとログインできない、などのメソッドをつくり、before_action メソッドなどを作るとよいですね。

ディレクトリの構造を俯瞰で眺めるって大事ですね。

読んでくださったかた、ありがとうございました。

nemespace の箇所