リソース設計

[ham-cap]

Ver.3

Method	Path	Description
GET	/	未ログイン用のトップページを表示
GET	/auth/google_oauth2/callback	Google認証によるログイン
GET	/log_out	ログアウト
GET	/cards	フラッシュカードの一覧（ログイン後のトップページ）
GET	/cards/new	フラッシュカードの新規作成画面を表示
POST	/cards	フラッシュカードの新規作成
GET	/cards/:id	フラッシュカードの詳細画面を表示
GET	/cards/:id/edit	フラッシュカードの編集画面を表示
PATCH	/cards/:id	フラッシュカードの更新
DELETE	/cards/:id	フラッシュカードの削除
GET	/cards/review	復習モード画面を表示（2ページ目以降のカードでは/cards/review?id=2のようにクエリストリングでidを指定する）
DELETE	/users/:id	退会処理
GET	/terms	利用規約を表示
GET	/privacy	プライバシーポリシーを表示

Ver.2

Method | Path | Description -- | -- | -- GET | / | 未ログイン用のトップページを表示 GET | /auth/google_oauth2/callback | Google認証によるログイン GET | /log_out | ログアウト GET | /cards | フラッシュカードの一覧（ログイン後のトップページ） GET | /cards/new | フラッシュカードの新規作成画面を表示 POST | /cards | フラッシュカードの新規作成 GET | /cards/:id | フラッシュカードの詳細画面を表示 GET | /cards/:id/edit | フラッシュカードの編集画面を表示 PATCH | /cards/:id | フラッシュカードの更新 DELETE | /cards/:id | フラッシュカードの削除 GET | /cards/review | 復習モード画面を表示 DELETE | /users/:id | 退会処理 GET | /terms | 利用規約を表示 GET | /privacy | プライバシーポリシーを表示

Ver.1

Method | Path | Description -- | -- | -- GET | / | 未ログイン用のトップページを表示 GET | /auth/google_oauth2/callback | Google認証によるログイン GET | /log_out | ログアウト GET | /cards | フラッシュカードの一覧（ログイン後のトップページ） GET | /cards/new | フラッシュカードの新規作成画面を表示 POST | /cards | フラッシュカードの新規作成 GET | /cards/:id | フラッシュカードの詳細画面を表示 GET | /cards/:id/edit | フラッシュカードの編集画面を表示 PATCH | /cards/:id | フラッシュカードの更新 DELETE | /cards/:id | フラッシュカードの削除 GET | /cards/drill | 復習モード画面を表示 DELETE | /retirement | 退会処理 GET | /terms | 利用規約を表示 GET | /privacy | プライバシーポリシーを表示

[yoshitsugu]

• ログアウトや退会処理はどのように実装する予定ですか？もしdeviseを導入してその仕組みを使うなら、deviseの標準のPath( DELETE /user ) などのほうがよいかなと思います。
• 復習モードのとき、カードの切り替えはブラウザバックなどを使わないで同じPathで行うつもりなのでしょうか？
  • また一般的には「復習」をあらわす単語は review や revisit などのようです。そちらを踏まえた上で、できるだけRESTに沿ったPathにするとRailsとしても作りやすいかなと思います。

[ham-cap]

@yoshitsugu

• ログアウトについてはsessions#destroyにてセッションの削除をする予定で、パスは分かりやすいようにlog_outとしたいと思っています。 deviseは使用しない予定なのですが、よく考えると退会処理については普通にユーザーの削除なので仰るとおりDELETET user/:idにしたいと思います。変に難しく考えてしまいました💧

• 復習モードにおけるカードの切り替えについての説明ができておらずすみません🙇‍♂️。 まず前提として復習モードの画面は大部分が詳細画面と共通なので、詳細画面のビューを流用することを考えております。復習モードの時だけコントローラー（cads#show）にて前後のカードを取得し、それぞれに遷移できるリンクを表示させるイメージです。コントローラーでの復習モードか否かの判定はクエリパラメータを使用します。 流れとしては、まず/cards/drillにアクセスがあるとcards#drillで復習の起点となるカードを取得し、そのカードの詳細ページ（/cards/:id）へdrill=trueのようなパラメータを持たせたうえでリダイレクトします。リダイレクト先のcards#showではdrillパラメータがtrueの場合のみ、起点となるカードの前後のカードを取得してshowテンプレートの下部に前後のカードへ移動できるリンクを設置し、そのリンクでカードの切り替えを行う、という流れを考えています。 したがって、/cards/drillは復習モードへの入り口で、復習モード中のパスは各カードの詳細画面（/cards/:id）にdrill=trueが付与されたものになります。 事前に考えていた別案として、復習モードへ移行するボタンが押された時だけパラメータを付けてGET /cards/:idへ遷移するというのもあったのですが、復習モードへは一覧画面上部のボタンかメニューモーダルから遷移することを想定しているため、特定のカードのidを指定して遷移する/cards/:idを無理やり使うよりは別のルーティングを用意するほうがいいと考えました。 また、今後もし詳細画面に復習モードボタンを設置して、そのカードから復習を始められるようにしたいと思った時にもcards#drillの実装だけ変えれば対応できるようにしておきたいという意図もあります。

  • 「復習」を表す単語の選択について、単なる復習ではなく「反復練習」や「訓練」という意味合いで使用してほしいという考えがあったため、reviewがいいのかdrillなのかpracticeなのかという感じで、自分としては割と悩んでいる部分だったのですが、言われてみると変にこだわらずにreviewぐらいのほうがシンプルで良さそうなので、そうすることにします。

以上を踏まえて退会処理と復習モードのパスを修正し、最初のコメントに追記してみましたのでご確認をお願いいたします🙏

[yoshitsugu]

• 退会処理についてはいいと思います :+1: ログアウトが sessions#destroy になるならPathも DELETE /sessions とか DELETE /user/sessions とかのほうが直感的かなと思いました。
• /cards/drill はエントリポイントとなるだけで、実際は /cards/:id` が使われる、ということですね。理解しました。
  • ただ、本質的にはカードの詳細、というのと復習を行う、というのは別なのかなと思っていて、よくある「機能として同じだからといってまとめてしまう」というDRYの誤用になっていないかがちょっと気になりました。カードの詳細画面というのはあまり変化しないように思いますが、復習モードというのは今後もし開発が続いていくとしたら機能がどんどんリッチになっていきそうですよね。そうなるとカードの詳細画面としては関係ないデータを読み込む部分がどんどん増えていきそうに思いますし、UIとしてもそれぞれ最適なものが違うように思いました。どうでしょうか。

[ham-cap]

@yoshitsugu

ログアウトが sessions#destroy になるならPathも DELETE /sessions とか DELETE /user/sessions とかのほうが直感的かなと思いました。

たしかにわざわざ名前付きにしなくともそれで十分わかりやすいかもしれないですね👀 Railsガイドやチュートリアルなどでsessions#destroyへのパスとしてlogoutといった名称をつけているのを見たことがあったのでマネてみたのですが、実際の業務ではあまり一般的ではないのでしょうか？🤔

「機能として同じだからといってまとめてしまう」というDRYの誤用になっていないか

まさにその状態のような気がします🤔 たしかに詳細と復習では本質的に異なるものですね。 改めて考えてみたところ、GET /cards/reviewでcards#reviewへ行くのはそのままで、復習モード用のビューとしてreview.html.erbを用意して表示させるというのが一番素直かなと思うのですがいかがでしょうか？👀 一瞬GET /reviewでもいいのかなとも考えましたが、扱うリソースはあくまでもcardsで、showとは見せ方が違うというだけなので、以下のような形でcardsの中にreviewを生やしてあげるのがいいのではないかと考えました。

  resources :cards do
    get "review", on: :collection
  end

[yoshitsugu]

Railsガイドやチュートリアルなどでsessions#destroyへのパスとしてlogoutといった名称をつけているのを見たことがあったのでマネてみたのですが、実際の業務ではあまり一般的ではないのでしょうか？🤔

これは僕の書き方が悪かったですね。pathとcontrollerとの対応としては /sessions がはいっているほうが直感的ですが、特に logout でも悪くはないです。修正するかはお任せします。

改めて考えてみたところ、GET /cards/reviewでcards#reviewへ行くのはそのままで、復習モード用のビューとしてreview.html.erbを用意して表示させるというのが一番素直かなと思うのですがいかがでしょうか？👀

よいと思います :+1: この場合、2ページ目以降はどこに card_id をいれる想定ですか？クエリストリングにするならDescriptionに書いたほうがいいかなと思いますし、 pathに含めるなら別途そのpathも表に加えたほうがよいかなと思いました。どちらの方法でもこの場合はよいかなと思いますので、おまかせします。

[ham-cap]

@yoshitsugu

pathとcontrollerとの対応としては /sessions がはいっているほうが直感的ですが、特に logout でも悪くはないです。修正するかはお任せします。

理解しました👍 改めて考えてみたのですが、今回はlogoutとさせていただけると嬉しいです🙌

2ページ目以降はどこに card_id をいれる想定ですか？

現時点では/cards/review?id=2のような形でクエリストリングとして入れる想定なので、その旨Descriptionに追記しました🙌

[yoshitsugu]

よいと思います :+1: