each_with_objectの使い方

each_with_object は便利だがあまり知られていなさそう、かつ個人的には少し理解するのに時間がかかったので使い方をまとめた。

まずは公式ドキュメント見ようぜのURLを貼っておく
https://docs.ruby-lang.org/ja/latest/method/Enumerable/i/each_with_object.html

早速、こんな時は each_with_object使えるぜ！！な例を上げていく

例１

こんな時、

ruby

langs = ["ruby", "python", "go"]
lang_hash = {}
langs.each do |lang|
  lang_hash[lang] = lang.upcase
end

return lang_hash
#=> {"ruby"=>"RUBY", "python"=>"PYTHON", "go"=>"GO"}

each_with_object を使うと

ruby

langs = ["ruby", "python", "go"]
lang_hash = langs.each_with_object({}) do |lang, hash|
  hash[lang] = lang.upcase
end

return lang_hash
#=> {"ruby"=>"RUBY", "python"=>"PYTHON", "go"=>"GO"}

lang_hash = {}

が不要になる。

例２

こんな時、

ruby

posts = [
  { id: 1, title: 'hoge-1', category: 1 },
  { id: 2, title: 'hoge-2', category: 2 },
  { id: 3, title: 'hoge-3', category: 2 },
  { id: 4, title: 'hoge-4', category: 1 },
]

# hashの初期化
post_hash_by_category_id = {}
posts.each do |post|
  # categoryごとの配列初期化
  post_hash_by_category_id[post[:category]] = [] if post_hash_by_category_id[post[:category]].nil?
  post_hash_by_category_id[post[:category]] << { title: post[:title] }
end

return post_hash_by_category_id
#=> {1=>[{:title=>"hoge-1"}, {:title=>"hoge-4"}], 2=>[{:title=>"hoge-2"}, {:title=>"hoge-3"}]}

これを　each_with_object　で実装すると、

ruby

posts = [
  { id: 1, title: 'hoge-1', category: 1 },
  { id: 2, title: 'hoge-2', category: 2 },
  { id: 3, title: 'hoge-3', category: 2 },
  { id: 4, title: 'hoge-4', category: 1 },
]

post_hash_by_category_id = posts.each_with_object(Hash.new { |v, k| v[k] = []}) do |post, hash|
  hash[post[:category]] << { title: post[:title] }
end

return post_hash_by_category_id
#=> {1=>[{:title=>"hoge-1"}, {:title=>"hoge-4"}], 2=>[{:title=>"hoge-2"}, {:title=>"hoge-3"}]}

# hashの初期化
post_hash_by_category_id = {}
と
# categoryごとの配列初期化
post_hash_by_category_id[post[:category]] = [] if post_hash_by_category_id[post[:category]].nil?

が不要になる。

ぜひ、手を動かして、実務でリファクタリングしてみてください。

---

余談1

これを書くきっかけが、実は　レビューで　Hash.new { |v, k| v[k] = []})使うといいよーって言われて、どんなふうに使うと良くなるかなーと考えて色々調べたら each_with_object というメソッドを使うといいらしいというところに行き着いた。（例２のパターン）

余談２

公式ドキュメントは使い方としてはいい例かもしれないが、用途としてはダメな例。
まーみればわかる通り、これ map 使った方がええやろーって感じなので、ドキュメントで書かれてるから、これで！！とはしないように・・・

each_with_objectとmapを使った時の比較

evens = (1..10).each_with_object([]) {|i, a| a << i*2 }
evens = (1..10).map{ |i| i*2 }