Ruby yieldでのコードの書き方について

Question

yieldやProcについて学習をしているのですが、yieldの理解に苦しんでいます。

yieldはブロックを呼び出す、Procはブロックのオブジェクト化というのは理解しました。
ここでブロックがでてきたりして、yieldの事がよくわからなくなってきました。

どなたか、yieldを使ったコードの書き方の理由について詳しく教えてください。

宜しくお願いします。

Answer 1

「 yield を使ったコードの書き方の理由」の意味がよくわかりませんが、"どうして yield のような書き方をするのか" というような感じで説明してみます。

例えば、次のように配列の要素に順にアクセスして何らかの処理(p it)をするコードがあったとします。

ary = [1, 2, 3]
cnt = 0
while ( cnt < ary.size)
  it = ary[cnt]
  
  p it

  cnt += 1
end

ループカウンターを使うとしたら、同じようなコードを毎回書かないといけません。
そのような場合は、同じようなコードは関数にまとめて、変わる部分だけをパラメーターとして渡すようにした方が楽です。
ここでパラメーターとしたいのは配列と処理の部分 p it です。

def aryeach(ary, xxx)
  cnt = 0
  while ( cnt < ary.size)
    it = ary[cnt]
    
    # 処理 xxx を実行したい

    cnt += 1
  end
end

# p it の処理を渡したい
aryeach([1,2,3], xxx)

xxx としてますが、p it というコードを関数aryeachに渡たせれば、用途の広い関数になります。

まず渡す側を考えてみます。
処理を渡す場合には素直に考えると、関数にしてその関数を渡します。

def dumpfunc(it)
  p it
end

aryeach([1,2,3], dumpfunc)

しかし、 上記のコードではエラーになります。 Ruby では関数をそのままでは渡せないので、 コードを Proc オブジェクトにします。

dumpfunc = Proc.new{|it|
  p it
}

aryeach([1,2,3], dumpfunc)

処理を離して書くのも嫌ですし、いちいち dumpfunc の変数に入れるのも無駄なので処理を関数に直接渡します。

aryeach([1,2,3],
        Proc.new{|it|
          p it
        })

次に Proc の受け取り側 を考えます。
Proc は call で実行することができます。

def aryeach(ary, func)
  cnt = 0
  while ( cnt < ary.size)
    it = ary[cnt]

    func.call(it)   # p it を実行

    cnt += 1
  end
end

aryeach([1,2,3],
        Proc.new{|it|
          p it
        })

これが Proc を使って書きなおした場合です。
他の言語でも、 Proc ではなく function など関数定義になりますが、同じようなことができます。

しかし、処理のコードを引数として渡すと ) が後ろの方に来るなど、ちょっと汚いです。
Ruby では、一歩進んでもっとエレガントに書くことができます。それがブロックです。

ブロックを渡す側 では引数として渡していたのを関数の後ろにつけることができます。
これで ) も前にきますし、 Proc.new も書く必要がありません。

aryeach([1,2,3]){|it|
  p it
}

これで渡す側は綺麗に書けましたが、ブロックにしたことによって受け取り側も変える必要があります。
ブロックも同じような引数として受け取りますが、必ず最後の引数になりますし、ブロックのサインである & が付きます。

def aryeach(ary, &blk)
  cnt = 0
  while ( cnt < ary.size)
    it = ary[cnt]
    
    blk.call(it)   # p it を実行

    cnt += 1
  end
end

blk.call は引数の変数blkを使ってますが、ブロックは一つと決まっているので、もう少し簡単に書けます。
それが yield です。

def aryeach(ary, &blk)
  cnt = 0
  while ( cnt < ary.size)
    it = ary[cnt]
    
    yield(it)   # p it を実行

    cnt += 1
  end
end

Ruby では大抵 () は省略できます。また、 blk の引数も出てこなくなったので、省略できます。
最終的にブロック で書き直すと次のようになります。

def aryeach(ary)
  cnt = 0
  while ( cnt < ary.size)
    it = ary[cnt]
    
    yield it  # p it を実行

    cnt += 1
  end
end

aryeach([1,2,3]){|it|
  p it
}

結局のところ、 "ブロックと yield は Proc を綺麗に書けるようにしたもの" ということです。

Comments

[cmu2008]

とても親切な回答ありがとうございました！

Answer 2

ここ teratail でも何回も yield に関する質問がでています。
yield で検索して、回答を眺めてみるといいです。
(この質問ページに右側の 【関連した質問】にそれらが表示されていないのはちょっと不便ですね。)

Qiita にも yield についての投稿がたくさんあります。そのうちの１つを紹介します。
ブロックとProcをちゃんと理解する

yield について理解する方法として 私のおすすめは、書籍 "Ruby メタプログミング" を読む事です。
2010 年に日本語訳が出てますが、今年 原書のほうでは 新版がでました。
http://www.amazon.com/Metaprogramming-Ruby-Program-Like-Facets/dp/1941222129

teratail で この本の読んでみんなで質疑応答する なんて事ができないかなぁ...

Answer 3

yieldを使ったコードの書き方という表現が少しわかりにくいのですが、yieldの省略した形についてでしょうかね。

まず、ブロックはどういったものがわかりますでしょうか？
do end、{}で囲まれている引数になるためのまとまったものというのがブロックといいます。
ここで質問者様が仰っておられるように、yieldはブロックを呼び出し、Procはブロックをオブジェクト化したものです。

そこでyeildについて説明します。

（例１）

def gblock
yield
end

gblock do
p 'block'
end

そこで以下の書き方もできます。

（例２）

def gblock(&block)
block.call
end

gblock do
p 'block'
end

結果は同じです。
ここでの&は、&をつけることで、引数にブロックが渡ってきた時にProcオブジェクトに変換しています。
Procオブジェクトというのは、ブロックをオブジェクトしたものです。
またProcオブジェクトはcallで呼び出せます。さらに、ブロック引数は１つだけしか渡せません。

なので、以下のように編集できます。
（例３）

def gblock($block)
yield
end

gblock do
p 'block'
end

ここで&blockも実際必要がないということがわかります。

（例４）

def gblock
yield
end

gblock do
p 'block'
end

ということでyieldは（例４）の形になって使われています。