2023.10.07 学習記録
ななな昨日の続きから。
- enum
- AdminTEQ
- dartsass
- ルーティングのnamespace
なななenumはユーザーのroleにgeneralかadminかで設定する感じだなたぶん。
AdminTEQはRUNTEQ独自の管理画面ライブラリで、ビューの下地として使ってねということかと。
dartsassはこれから確認。
なななDartSass自体はSassの実行環境の一つらしい。
指定のdartsassファイルを作成しadmin配下のscssをプリコンパイルできるようにせよ、とのことなので、アセットパイプライン関連ぽい。以前調べたマニフェストファイルというやつか？
ななないや、ちょっと違うっぽいな。そもそもrubyファイルだしな…。
なななこのページが参考になりそう。
なななSassコンパイラとしてDartSassを使うのでその設定ファイルを作ってね、その中でadmin配下のscssをプリコンパイルできるように設定を書いてね、ということだと今はざっくり認識しておく。
ななな次。ルーティングのnamespaceについて。
名前空間という概念がいまいちピンときてないんだよなあ…
なななまずはRailsガイド。
なななあーなるほどグループ化機能みたいなものなのか、名前空間。少なくともコントローラについて言えば。コントローラをネストできるみたいな。
なななルーティングでコントローラの名前空間使うのとリソースをネストする違いは、「コントローラ自体がネストしてるかどうか」かな？
なななよし、大体の把握はできた。初見時に思ったほど複雑ではなさそうだ。
なななタスクの洗い出しをするために、実際の操作を順番に追ってみる。
- 管理者ログイン画面にアクセス
- メールアドレスとパスワードでログイン
- 管理画面トップページ（ダッシュボード）が表示される
ななな大雑把にやるべきことを書き出す。
- 管理者ログイン画面にアクセス
- ルーティングの設定
- コントローラの作成
- ビューの作成
- メールアドレスとパスワードでログイン
- userモデルにroleカラムを追加
- ログイン周りのロジックを実装
- 管理画面トップページ（ダッシュボード）が表示される
- ビューの作成
なななタスク
- ルーティングの設定
- コントローラの作成
-
ビューの作成
- AdminTEQを導入
- 管理者ログイン画面
- 管理画面トップページ
-
userモデルにroleカラムを追加
- マイグレーション
- バリデーション設定
- ログイン周りのロジックを実装
なななログインロジックの分解とかdartsassの設定とかはやりながら考えることにてしてとりあえず始動！
なななまずはルーティング。namespaceを使ってネストしたadmin関連のコントローラを使えるようにする。
…と思ったけどよく課題の仕様みたらコントローラに関する指定が何もないな。これだと今回の内容だけならわざわざ「/controllers/admin」てしなくても良さそうだけど、ポイントにnamespaceを使ったルーティングが入っているってことは、たぶん次の課題で必要になるからそうしたほうがいいんだろうな。そうする。
なななとりあえず/controllers/adminにuser_sessionsコントローラを作ることにしてルーティング追加した。
なななお、いい情報載ってた。...と思ったけど再度見直したらやっぱり課題詳細内にコントローラに関する記述あった！なんとなく見た覚えはあるけどないなと思ったら単に見落としだった…。
なななapplication_controllerを継承したadmin/base_controllerを作って、更にそのadmin/base_controllerを継承元にしていろんなadmin系コントローラを作ればいいんだな。てことは
namespace :admin do
:base, :user_sessions
end
でいいのかなとりあえず。やってみよう。
なななuser_sessionsコントローラは一部のアクションしかいらないんだけど、onlyオプションとか使えるのかな。
なななresourcesが抜けてた😞こう↓か。
namespace :admin do
resources :base
resource :user_session, only %i[ new create destroy ]
end
ちゃう！こうか
namespace :admin do
get 'login', to: 'user_sessions#new'
post 'login', to: 'user_sessions#create'
delete 'logout', to: 'user_sessions#destroy'
end
管理画面トップページはURLが「/admin」になるようにとのことだけど、adminの名前スペースの中でrootに設定するとかでいけるんだろうか？とりあえずやってみる。
なななコンソールで確かめたところOKの模様。次はコントローラの生成。
ななな…の前に。
せっかく課題用のリポジトリを自分のGitHub上にも作ったんだからここでissue利用して実装タスク管理するのがいいんじゃないかと気づいた。
やってみるか。
ななな初めてissueを作ってみた。とりあえずこれで進めよう。
ななな気を取り直してコントローラの生成。/controllers/admin下にbase_controllerとuser_sessions_controllerを生成する。
なななnamespaceを使用して生成することもやはりできる模様。
なななbaseコントローラが無事できた。ディレクトリのネストもバッチリ。user_sessionsコントローラはどうしよう。rails gだとapplication_controllerを継承しちゃうんだよなあ。回避方法あるんだろうか。
なななぱっと出てこないな。まあいいや、rails gしてから継承元を手動で書き換えよう。
ななな生成OK。継承元も書き換えた。
ななな次はuserモデルにroleカラムを追加する。まずはマイグレーションファイルを生成。
なななnull: false以外になにか必要な制約あるかな…とりあえず思いつかないのでこのままマイグレーション実行する。,
なななOK。
ここでnull: falseにした以上既存のユーザーにもroleを付与しないとな気づいたので、seedsを編集して対応することにする。
なななseedsを書いていて更に気づいたが、先にenumの宣言をしたほうがいいかも？そっちからやるか。
なななと思ってenumの使い方について改めて調べたら、若干自分の理解と違う？ひょっとしたらカラムの追加やり直しかも。もうちょい調べてみる。
なななうーんRailsガイドに載ってるやり方と検索して出てくる記事に載ってるやり方が違うなあ。記事だと各値を整数もしくは真偽値に紐付けてるけど、Railsガイドではそのまま指定してる。どっちが主流なんだ？
なななあ、なるほど。こっち↓を読んだらちょっとわかった。 Railsガイドのやり方は各値に対応する整数の表記を省略してる（というかハッシュではなく配列を使って表記している？）だけなんだ。結局実態は整数であって、それを文字列で表現できるようにしてあるっていうところは同じ。
# これと、
class Task < ApplicationRecord
enum status: { todo: 0, in_progress: 1, done: 2 }
end
# これは同じ
class Task < ApplicationRecord
enum :status, [ :todo, :in_progress, :done ]
end
てことはやっぱりカラムの追加やり直しだな。ロールバック！
なななデータ型をintegerに変更、更にdefaultを0にして再度マイグレーション。
なななOK。改めてenum宣言する。
なななOK。seedsも改めて修正。
なななseedsを更新したのでdb:resetを実行。
ななな無事新しいユーザーデータが生成された。
モデル周りの準備ができたので、ビューの作成に入る。
なななまずはAdminTEQのインストール。指定のコマンドをコンテナ内で実行。
なななOK。ログインページのファイルを作成（とりあえず作るだけ、中身はあと）
ななな管理画面トップページはどこに配置するべきなんだろう？もう一回ヒント見てみるか。
なななそっかまずはレイアウトファイルを通常用とは別に作らなきゃだ。/layoutの中に/adminを作るべきか？
なななあとヒントの中の記述を見た感じ、トップページはbaseじゃなくて別のコントローラ（dashboards）作るべきっぽいな。base_controllerはapplication_controllerのadmin版ってイメージかな。
なななというわけでdashboardsコントローラを生成して、ルーティングを修正する。
なななOK。
ビューのディレクトリ構成については、/layouts下にadmin.html.erbというレイアウトファイルをとりあえず作ってみる。
なななここまでやって思ったけど、application.html.erb以外のレイアウトファイルを呼び出す方法が必要だな。調べる。
ななないちおうrenderメソッドのlayoutオプションで使うレンダリングに使うレイアウトファイルを指定できるらしい。
メソッド単位じゃなくもうちょっと広く適用できないかな。
なななあった。コントローラ単位でできるから、/admin/base_controllerに設定すればadmin関連全部に適用できるな。
2.2.14.1 コントローラ用のレイアウトを指定する
デフォルトのレイアウト名ルールは、以下のようにlayout宣言で上書きできます。class ProductsController < ApplicationController
layout "inventory"
#...
end
この宣言によって、上のコードのProductsControllerのレンダリングで>app/views/layouts/inventory.html.erb>レイアウトが使われるようになります。アプリケーション全体で特定のレイアウトを使いたい場合は、layoutをApplicationControllerクラスで宣言します。
class ApplicationController < ActionController::Base
layout "main"
#...
end
この宣言によって、アプリケーションのすべてのビューでapp/views/layouts/main.html.erbレイアウトが使われるようになります。
なななさっそく設定した。ログイン画面の方は完全に独立したオンリーワンのレイアウトだから個別指定にしよう。
ななな管理画面トップページは/view/admin/dashboards下に作ることにする。
なななAdmimTEQからコピペしたコードを貼り付けたので、とりあえず管理画面トップページにアクセスしてみる。
なななレイアウト指定のコードで表記ミスをしていてエラー、修正。
dashboardsコントローラにindexアクションを定義し忘れてエラー、修正。
で、次はこれが出た
TypeError at /admin
superclass mismatch for class DashboardsController
なななdashboardsコントローラのクラス名が「DashboardsController」になっていた。「Admin::DashboardsController」に修正。
ななな通常のログイン画面に飛ばされて「ログインしてください」というフラッシュメッセージが出た。そりゃそうだ。application_controllerを継承してるんだからそうなるわな。
とりあえず確認のためskip_before_actionする。
ななな内容はともかく表示はされた。というかこれ、ログイン画面用だった、間違えた。ログイン画面の方に移植する。
ついでにログイン画面の方もskip_before_actionしてアクセスできるか確認する。
なななOK。両方問題なく表示された。レイアウトの使い分けもできている。
なななあ、renderメソッドにオプションとして指定する場合はビューファイル名は省略してOKみたい。
修正。
なななログインフォーム含めログイン周りのロジックを作っていく。
まずはコールバックの設定。
- baseコントローラに
require_loginをroleがadminのユーザーのみという条件を加えてオーバーライドして定義 - user_sessionsコントローラのnewとcreateアクションは
skip_before_action
ななな↑はちょっと違うか。require_loginはオーバーライドせずそのまま残して、新たに管理者権限があるユーザーが確認するメソッドを定義しよう。
なななadmin_user?メソッドを定義してbaseコントローラにbefore_actionとして設定した。
次はログインフォームの作成。
ななな見た目はともかくログインフォームはできた。
休憩を挟んでTILを作成・プッシュしたら今日はおしまい。
明日はuser_sessionsコントローラのcreateアクションを作るところから始める。