08/08/2020 Railsチュートリアル Ruby on Rails 学習メモ

らくだ🐫にもできるRailsチュートリアル｜14.3

14.3 ステータスフィード

ステータスフィードを実装する！
→フォローされているユーザーのマイクロポストとログイン中のユーザーのマイクロポストを合わせて表示する
見本はこちら→RoRT本文参照

14.3.1 動機と計画

現在のユーザーによってフォローされているユーザーに対応するユーザーidを持つマイクロポストを取り出し、同時に現在のユーザー自身のマイクロポストも一緒に取り出すことです。

図
テストの方が明確な雰囲気なのでテストから書いていく（テスト駆動開発！）

フィードのテスト

フォローしているユーザーのマイクロポストがフィードに含まれている
自分自身のマイクロポストもフィードに含まれている
フォローしていないユーザーのマイクロポストがフィードに含まれていない

上記3つの条件を満たすテストを定義していく

  test "feed should have the right posts" do
    # michaelはlanaをフォローしている　archerはフォローしていない
    # /sample_app/test/fixtures/relationships.yml参照
    michael = users(:michael)
    archer  = users(:archer)
    lana    = users(:lana)
    # フォローしているユーザーの投稿を確認
    # lanaのmicropostsを順に取り出してpost_followingに代入
    lana.microposts.each do |post_following|
      # michaelのfeedにpost_followingが含まれている
      assert michael.feed.include?(post_following)
    end
    # 自分自身の投稿を確認
    # michaelのmicropostsを順に取り出してpost_selfに代入
    michael.microposts.each do |post_self|
      # michaelのfeedにpost_selfが含まれている
      assert michael.feed.include?(post_self)
    end
    # フォローしていないユーザーの投稿を確認
    # archerのmicropostsを順に取り出してpost_unfollowedに代入
    archer.microposts.each do |post_unfollowed|
      # michaelのfeedにpost_unfollowedが含まれていない
      assert_not michael.feed.include?(post_unfollowed)
    end
  end
end

test "feed should have the right posts" do

# michaelはlanaをフォローしている　archerはフォローしていない

# /sample_app/test/fixtures/relationships.yml参照

michael = users(:michael)

archer = users(:archer)

lana = users(:lana)

# フォローしているユーザーの投稿を確認

# lanaのmicropostsを順に取り出してpost_followingに代入

lana.microposts.each do |post_following|

# michaelのfeedにpost_followingが含まれている

assert michael.feed.include?(post_following)

end

# 自分自身の投稿を確認

# michaelのmicropostsを順に取り出してpost_selfに代入

michael.microposts.each do |post_self|

# michaelのfeedにpost_selfが含まれている

assert michael.feed.include?(post_self)

end

# フォローしていないユーザーの投稿を確認

# archerのmicropostsを順に取り出してpost_unfollowedに代入

archer.microposts.each do |post_unfollowed|

# michaelのfeedにpost_unfollowedが含まれていない

assert_not michael.feed.include?(post_unfollowed)

end

feedに何も定義していないのでテストはRED

演習

マイクロポストのidが正しく並んでいると仮定して (すなわち若いidの投稿ほど古くなる前提で)、図 14.22のデータセットでuser.feed.map(&:id)を実行すると、どのような結果が表示されるでしょうか? 考えてみてください。ヒント: 13.1.4で実装したdefault_scopeを思い出してください。

user.feedのidを配列にして取り出す→[1,2,4,5,7,9,10]
投稿日時が古い順に並んでしまう

14.3.2 フィードを初めて実装する

ステータスフィードに対する要件定義はリスト 14.42のテストで明確になったので (つまりこのテストにパスすれば良いので)、早速フィードの実装に着手してみましょう。

要件定義 #とは
最終的な形は込み入っているのでパーツ毎に確認しつつ導入していくとの事。

フィードで必要なクエリ

micropostsテーブルから、あるユーザー (つまり自分自身) がフォローしているユーザーに対応するidを持つマイクロポストをすべて選択 (select) することです。

これをコードにするとこう↓

# micropostsテーブルを検索
SELECT * FROM microposts
# 取得条件　user_idに　<list of ids>か　user_id = <user id>　を含むもの
WHERE user_id IN (<list of ids>) OR user_id = <user id>

# micropostsテーブルを検索

SELECT * FROM microposts

# 取得条件　user_idに　<list of ids>か　user_id = <user id>　を含むもの

WHERE user_id IN (<list of ids>) OR user_id = <user id>

<>は例えの証でコードの一部じゃないんだって🐫
13.3.3でプロトタイプを作成した際は
現在のユーザーに対するユーザーidを持つマイクロポストを選択したけど

Micropost.where("user_id = ?", id)

1	Micropost.where("user_id = ?", id)

今回はもう少し複雑になる
例えばこう↓

Micropost.where("user_id IN (?) OR user_id = ?", following_ids, id)

1	Micropost.where("user_id IN (?) OR user_id = ?", following_ids, id)

（following_idsについては読み進めればわかる🐫よくあるパターン）
これらの条件から、フォローされているユーザーに対するidの配列が必要であることがわかる
→mapメソッドで実装可能！

このメソッドはすべての「列挙可能 (enumerable)」なオブジェクト (配列やハッシュなど、要素の集合で構成されるあらゆるオブジェクト) で使えます

例えばこんな事も

# 配列を文字列に変換してひとつづつ取り出す
>> [1, 2, 3, 4].map { |i| i.to_s }
=> ["1", "2", "3", "4"]

# 短縮表記が使える
>> [1, 2, 3, 4].map(&:to_s)
=> ["1", "2", "3", "4"]

# さらにjoinメソッドを繋げてidの集合をカンマで区切った文字列へ
>> [1, 2, 3, 4].map(&:to_s).join(', ')
=> "1, 2, 3, 4"

# 配列を文字列に変換してひとつづつ取り出す

>> [1, 2, 3, 4].map { |i| i.to_s }

=> ["1", "2", "3", "4"]

# 短縮表記が使える

>> [1, 2, 3, 4].map(&:to_s)

=> ["1", "2", "3", "4"]

# さらにjoinメソッドを繋げてidの集合をカンマで区切った文字列へ

>> [1, 2, 3, 4].map(&:to_s).join(', ')

=> "1, 2, 3, 4"

これによりuser.followingにある各要素のidを呼び出して、フォローしているユーザーのidを配列として扱うことができる
例えばこんな感じ

>> User.first.following.map(&:id)
=> [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,
23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41,
42, 43, 44, 45, 46, 47, 48, 49, 50, 51]

>> User.first.following.map(&:id)

=> [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,

23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41,

42, 43, 44, 45, 46, 47, 48, 49, 50, 51]

これはとても便利なのでActive Recordでは次のようなメソッドも用意されている

>> User.first.following_ids
=> [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,
23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41,
42, 43, 44, 45, 46, 47, 48, 49, 50, 51]

>> User.first.following_ids

=> [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,

23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41,

42, 43, 44, 45, 46, 47, 48, 49, 50, 51]

このfollowing_idsメソッドは、has_many :followingの関連付けをしたときにActive Recordが自動生成したものです (リスト 14.8)。これにより、user.followingコレクションに対応するidを得るためには、関連付けの名前の末尾に_idsを付け足すだけで済みます

結果、フォローしているユーザーidの文字列を取得するにはこう

>> User.first.following_ids.join(', ')
=> "3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,
23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41,
42, 43, 44, 45, 46, 47, 48, 49, 50, 51"

>> User.first.following_ids.join(', ')

=> "3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22,

23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41,

42, 43, 44, 45, 46, 47, 48, 49, 50, 51"

なんだけど、
実際はRailsがよしなにやってくれるのでfollowing_idsメソッドを使えばOK

Micropost.where("user_id IN (?) OR user_id = ?", following_ids, id)

1	Micropost.where("user_id IN (?) OR user_id = ?", following_ids, id)

実装するとこう↓

・
・
・
  # ユーザーのステータスフィードを返す
  def feed
    # Micropostテーブルから取得　条件→user_idにフォローしているユーザーのidか現在のユーザーのidを持つもの
    Micropost.where("user_id IN (?) OR user_id = ?", following_ids, id)
  end
・
・
・

・

# ユーザーのステータスフィードを返す

def feed

# Micropostテーブルから取得　条件→user_idにフォローしているユーザーのidか現在のユーザーのidを持つもの

Micropost.where("user_id IN (?) OR user_id = ?", following_ids, id)

end

・

いくつかのアプリケーションにおいては、この初期実装だけで目的が達成され、十分に思えるかもしれません。しかしリスト 14.44にはまだ足りないものがあります。それが何なのか、次に進む前に考えてみてください (ヒント: フォローしているユーザーが5,000人もいたらどうなるでしょうか?)。

→読み込みデータが多すぎて重たくなる？（？

演習

リスト 14.44において、現在のユーザー自身の投稿を含めないようにするにはどうすれば良いでしょうか? また、そのような変更を加えると、リスト 14.42のどのテストが失敗するでしょうか?

リスト 14.44において、フォローしているユーザーの投稿を含めないようにするにはどうすれば良いでしょうか? また、そのような変更を加えると、リスト 14.42のどのテストが失敗するでしょうか?

リスト 14.44において、フォローしていないユーザーの投稿を含めるためにはどうすれば良いでしょうか? また、そのような変更を加えると、リスト 14.42のどのテストが失敗するでしょうか? ヒント: 自分自身とフォローしているユーザー、そしてそれ以外という集合は、いったいどういった集合を表すのか考えてみてください。

# 現在のユーザー自身の投稿を含めない（フォローしているユーザーの投稿のみ）
def feed
  Micropost.where("user_id IN (?)", following_ids)
end

#テストが失敗するのはここらへん
# 自分自身の投稿を確認
# michaelのmicropostsを順に取り出してpost_selfに代入
michael.microposts.each do |post_self|
  # michaelのfeedにpost_selfが含まれている
  assert michael.feed.include?(post_self)
end

# エラーメッセージはこれ
 FAIL["test_feed_should_have_the_right_posts", UserTest, 0.8520699739983684]
 test_feed_should_have_the_right_posts#UserTest (0.85s)
        Expected false to be truthy.
        test/models/user_test.rb:125:in `block (2 levels) in <class:UserTest>'
        test/models/user_test.rb:123:in `block in <class:UserTest>'

# 現在のユーザー自身の投稿を含めない（フォローしているユーザーの投稿のみ）

def feed

Micropost.where("user_id IN (?)", following_ids)

end

#テストが失敗するのはここらへん

# 自分自身の投稿を確認

# michaelのmicropostsを順に取り出してpost_selfに代入

michael.microposts.each do |post_self|

# michaelのfeedにpost_selfが含まれている

assert michael.feed.include?(post_self)

end

# エラーメッセージはこれ

FAIL["test_feed_should_have_the_right_posts", UserTest, 0.8520699739983684]

test_feed_should_have_the_right_posts#UserTest (0.85s)

Expected false to be truthy.

test/models/user_test.rb:125:in `block (2 levels) in <class:UserTest>'

test/models/user_test.rb:123:in `block in <class:UserTest>'

# フォローしているユーザーの投稿を含めない（現在のユーザー自身の投稿のみ）
def feed
  Micropost.where("user_id = ?", id)
end

#テストが失敗するのはここらへん
# フォローしているユーザーの投稿を確認
# lanaのmicropostsを順に取り出してpost_followingに代入
lana.microposts.each do |post_following|
  # michaelのfeedにpost_followingが含まれている
  assert michael.feed.include?(post_following)
end

# エラーメッセージはこれ
 FAIL["test_feed_should_have_the_right_posts", UserTest, 0.8283004599998094]
 test_feed_should_have_the_right_posts#UserTest (0.83s)
        Expected false to be truthy.
        test/models/user_test.rb:119:in `block (2 levels) in <class:UserTest>'
        test/models/user_test.rb:117:in `block in <class:UserTest>'

# フォローしているユーザーの投稿を含めない（現在のユーザー自身の投稿のみ）

def feed

Micropost.where("user_id = ?", id)

end

#テストが失敗するのはここらへん

# フォローしているユーザーの投稿を確認

# lanaのmicropostsを順に取り出してpost_followingに代入

lana.microposts.each do |post_following|

# michaelのfeedにpost_followingが含まれている

assert michael.feed.include?(post_following)

end

# エラーメッセージはこれ

FAIL["test_feed_should_have_the_right_posts", UserTest, 0.8283004599998094]

test_feed_should_have_the_right_posts#UserTest (0.83s)

Expected false to be truthy.

test/models/user_test.rb:119:in `block (2 levels) in <class:UserTest>'

test/models/user_test.rb:117:in `block in <class:UserTest>'

#フォローしていないユーザーの投稿を含める（すべての投稿を含める）
def feed
  Micropost.all
end

#テストが失敗するのはここらへん
# フォローしていないユーザーの投稿を確認
# archerのmicropostsを順に取り出してpost_unfollowedに代入
archer.microposts.each do |post_unfollowed|
  # michaelのfeedにpost_unfollowedが含まれていない
  assert_not michael.feed.include?(post_unfollowed)
end

# エラーメッセージはこれ
 FAIL["test_feed_should_have_the_right_posts", UserTest, 0.8982799360001081]
 test_feed_should_have_the_right_posts#UserTest (0.90s)
        Expected true to be nil or false
        test/models/user_test.rb:131:in `block (2 levels) in <class:UserTest>'
        test/models/user_test.rb:129:in `block in <class:UserTest>'

#フォローしていないユーザーの投稿を含める（すべての投稿を含める）

def feed

Micropost.all

end

#テストが失敗するのはここらへん

# フォローしていないユーザーの投稿を確認

# archerのmicropostsを順に取り出してpost_unfollowedに代入

archer.microposts.each do |post_unfollowed|

# michaelのfeedにpost_unfollowedが含まれていない

assert_not michael.feed.include?(post_unfollowed)

end

# エラーメッセージはこれ

FAIL["test_feed_should_have_the_right_posts", UserTest, 0.8982799360001081]

test_feed_should_have_the_right_posts#UserTest (0.90s)

Expected true to be nil or false

test/models/user_test.rb:131:in `block (2 levels) in <class:UserTest>'

test/models/user_test.rb:129:in `block in <class:UserTest>'

14.3.3 サブセレクト

現在のフィードの設計では投稿されたマイクロポストの数が膨大になったときにWebサービス全体が遅くなるなどの弊害があるなどする。

14.3.2で示したコードの問題点は、following_idsでフォローしているすべてのユーザーをデータベースに問い合わせし、さらに、フォローしているユーザーの完全な配列を作るために再度データベースに問い合わせしている点です

もっと効率的なコードに置き換える→SQLのサブセレクト (subselect) を使うことで解決できる！！

サブセレクトとは何ぞ

わからないので調べたのだけど、
サブセレクトとサブクエリがごっちゃになって良くわかりません！ってなったので
にゅ〜ぶる会で質問したところ

サブクエリは、入れ子になってる子供のクエリの事。
サブセレクトは、入れ子になったセレクト文全体の事。
かな？

と、教えてもらいましてスッキリ感（いつもありがとうございますだねぇ🐫）
というわけでやっていく。

# これを
Micropost.where("user_id IN (?) OR user_id = ?", following_ids, id)

#こうする
Micropost.where("user_id IN (:following_ids) OR user_id = :user_id",
    following_ids: following_ids, user_id: id)

# これを

Micropost.where("user_id IN (?) OR user_id = ?", following_ids, id)

#こうする

Micropost.where("user_id IN (:following_ids) OR user_id = :user_id",

following_ids: following_ids, user_id: id)

同じ変数を複数の場所に挿入したい場合はプレースホルダー（？）ではなくハッシュで置き換えるほうが便利
ハッシュ形式で記述しておいてもSQLインジェクションを防げる！

コードの解説はこう↓

# following_idsをSQLに置き換えるとこうなる
following_ids = "SELECT followed_id FROM relationships
                 WHERE  follower_id = :user_id"

# 上のコードを使用したサブセレクトはこうなる
SELECT * FROM microposts
WHERE user_id IN (SELECT followed_id FROM relationships
                  WHERE  follower_id = :user_id)
      OR user_id = :user_id

# following_idsをSQLに置き換えるとこうなる

following_ids = "SELECT followed_id FROM relationships

WHERE follower_id = :user_id"

# 上のコードを使用したサブセレクトはこうなる

SELECT * FROM microposts

WHERE user_id IN (SELECT followed_id FROM relationships

WHERE follower_id = :user_id)

OR user_id = :user_id

このサブセレクトは集合のロジックを (Railsではなく) データベース内に保存するので、より効率的にデータを取得することができます。

これを実際のコードに落としこむとこう↓

・
・
・
・
# feedの定義
  def feed
    following_ids = "SELECT followed_id FROM relationships
                    WHERE follower_id = :user_id"
    Micropost.where("user_id IN (#{following_ids})
                     OR user_id = :user_id", user_id: id)
  end
・
・
・

・

# feedの定義

def feed

following_ids = "SELECT followed_id FROM relationships

WHERE follower_id = :user_id"

Micropost.where("user_id IN (#{following_ids})

OR user_id = :user_id", user_id: id)

end

・

※「following_ids」という文字列はエスケープされているのではなく、見やすさを重視して式展開の形にしている

もちろん、サブセレクトを使えばいくらでもスケールできるなどということはありません。大規模なWebサービスでは、バックグラウンド処理を使ってフィードを非同期で生成するなどのさらなる改善が必要でしょう。ただし、Webサービスをスケールさせる技術は非常に高度かつデリケートな問題なので、本書ではここまでの改善で止めておきます。

これにて完全なフィードが実装できた！！

いつもの流れでGitHubにpushとherokuにデプロイ！！

演習

Homeページで表示される1ページ目のフィードに対して、統合テストを書いてみましょう。リスト 14.49はそのテンプレートです。

リスト 14.49のコードでは、期待されるHTMLをCGI.escapeHTMLメソッドでエスケープしています (このメソッドは11.2.3で扱ったCGI.escapeと同じ用途です)。このコードでは、なぜHTMLをエスケープさせる必要があったのでしょうか? 考えてみてください。ヒント: 試しにエスケープ処理を外して、得られるHTMLの内容を注意深く調べてください。マイクロポストの内容が何かおかしいはずです。また、ターミナルの検索機能 (Cmd-FもしくはCtrl-F) を使って「sorry」を探すと原因の究明に役立つはずです。

require 'test_helper'

class FollowingTest < ActionDispatch::IntegrationTest
  # setupでmichaelを@userに代入、archerを@otherに代入しそれぞれログイン済とする
  def setup
    @user = users(:michael)
    # 関係ないけど本文のリストには@other抜けてる
    @other = users(:archer)
    log_in_as(@user)
  end
・
・
・
  test "feed on Home page" do
    # root_pathにgetのリクエスト
    get root_path
    # @userのfeedのページネートの1ページ目から配列をひとつづつ取り出してmicropostに代入
    @user.feed.paginate(page: 1).each do |micropost|
      # response.bodyに特殊文字をエスケープしたmicropost.contentが含まれている
      assert_match CGI.escapeHTML(micropost.content), response.body
    end
  end
end

require 'test_helper'

class FollowingTest < ActionDispatch::IntegrationTest

# setupでmichaelを@userに代入、archerを@otherに代入しそれぞれログイン済とする

def setup

@user = users(:michael)

# 関係ないけど本文のリストには@other抜けてる

@other = users(:archer)

log_in_as(@user)

end

・

test "feed on Home page" do

# root_pathにgetのリクエスト

get root_path

# @userのfeedのページネートの1ページ目から配列をひとつづつ取り出してmicropostに代入

@user.feed.paginate(page: 1).each do |micropost|

# response.bodyに特殊文字をエスケープしたmicropost.contentが含まれている

assert_match CGI.escapeHTML(micropost.content), response.body

end

2.
エスケープしないと記号が特殊文字で出力されてしまうため

# 「sorry」で検索すると出てくる　「'」が「&#39;」になっている
I&#39;m sorry. Your words made sense, but your sarcastic tone did not.

1 2	# 「sorry」で検索すると出てくる　「'」が「'」になっている I'm sorry. Your words made sense, but your sarcastic tone did not.

feedメソッドをリファクタリング

記事を書きあがって添削していただいた際に
「feedメソッドってこれで完成形じゃないよね？」というお話がありまして。
現状だと書かれているのはSQL文なんですね。
と、いう訳で考えました。

Active Record クエリインターフェイス - Railsガイド

https://railsguides.jp/active_record_querying.html#サブセット条件

Ruby on Rails に特化した 1,600 ページ超えの大型リファレンスガイド。プロダクト開発を生産的にする電子書籍や全文検索、法人向けサービスも提供しています。

Active Record クエリインターフェイス - Railsガイド

この辺を参考に、まずはフォローしている人のmicropostを取り出す方法を考える

def feed
  Micropost.where(user_id: active_relationships.select(:followed_id))
end

def feed

Micropost.where(user_id: active_relationships.select(:followed_id))

end

自身の投稿も含まれるようにする

Active Record クエリインターフェイス - Railsガイド

https://railsguides.jp/active_record_querying.html#or条件

Active Record クエリインターフェイス - Railsガイド

def feed
  Micropost.where(user_id: active_relationships.select(:followed_id))
           .or(Micropost.where(user_id: id))
end

def feed

Micropost.where(user_id: active_relationships.select(:followed_id))

.or(Micropost.where(user_id: id))

end

テストも通って良い感じにできたっぽい！
チェックしてもらうと、更にこんな形を教えていただきました！
よりすっきり！！

def feed
  Micropost.where(user: following).or(Micropost.where(user_id: id))
end

def feed

Micropost.where(user: following).or(Micropost.where(user_id: id))

end

14.4 最後に

まとめにつき割愛
機能拡張も割愛
ただ、I18nを使っての日本語化は随時やってましたです
あとはローカル環境を作ってテンプレートをslim&Sassで書いてみようと思っています。練習。

まとめとか感想

さあ！
これにてらくだ🐫にもできるRailsチュートリアルのまとめ、終了です！！
ブログにまとめながら、疑問をなるべく残さないように調べながらゆっくり進めた2週目。
理解度もかなり上がったと思うし、記録してあるので調べやすいｗ
今後は自分なりに何かを作ったりしていきたいと思います。
web（セルフ）サービス！

らくだ🐫にもできるRailsチュートリアルとは

「ド」が付く素人のらくだ🐫が勉強するRailsチュートリアルの学習記録です。
自分用に記録していますが、お役に立つことがあれば幸いです。

調べたとはいえらくだ🐫なりの解釈や説明が含まれます。間違っている部分もあるかと思います。そんな所は教えて頂けますと幸いなのですが、このブログにはコメント機能がありません💧お手数おかけしますがTwitterなどでご連絡いただければ幸いです