tap
メソッドの考えができてしばらくたつが、Ruby 1.9で標準Rubyライブラリに追加された。tap
の背景にある考えについてブログに書いたMenTaLguY氏(source)が、単純なコードを紹介してくれた。
class ObjectRuby 1.9では、
def tap
yield self
self
end
end
tapメソッド
はObject
で定義されており、デフォルトですべてのオブジェクトで使用可能である。そのメソッドは、Blockを引数として扱いself
で引数として呼び出し、オブジェクトは戻される。 tap
メソッドの間接化は、オブジェクトを使用して複雑な方法で何かをするようなものである。これの本当の意味での利点は、目的のオブジェクトが変数に アサインされずに、他のメソッドにパスされると明確になる。メソッドがつながっているとき、特にチェーンが長い場合、これは一般的である。例:
tap
がなく、一時的に変数が必要な場合(source)
xs = blah.sort.grep( /foo/ )
p xs
# do whatever we had been doing with the original expression
xs.map { |x| x.blah }
tap
がある場合、blah.sort.grep( /foo/ ).tap { |xs| p xs }.map { |x| x.blah }
以下の例は、
tap
が有用で、それなしでは目的のオブジェクトをローカルの変数にアサインして使用する必要がある場合で、tapを使用して、つながったメソッド間でハンドオーバーが発生するオブジェクトを適切に検査するBlockを挿入することが可能な場合である。いわゆるFluent Interfaceを公開するAPIのとき、特に有用となる。つまり、メソッドの連鎖を促進するAPIである。Martin FowlerのウェブサイトにあるJavaの例はここを参照(source)。
customer.newOrder()
.with(6, "TAL")
.with(5, "HPK").skippable()
.with(3, "LGV")
.priorityRush();
このコードにバグが見つかった場合、
tap
はtap
ブロックを挿入することで任意の段階(つまり、すべての呼び出し間)でオブジェクトを参照するようにする。これはデバッグツールで有用であるが、たいていメソッドの匿名の戻り値を参照するというサポートには未対応である。ここで言っておくべきことは、
tap
は通常オブジェクトを変更せずにある種の副作用をもたらす(Blockの戻り値は無視される)。しかしながら変更可能である限りは、もちろんオブジェクトの修正は可能である。Rails' ActiveSupportのユーザはすでに、メソッドの戻り(source)の形式で似たようなメソッドに詳しい。
もちろん、
tap
メソッドはRuby 1.9に限定されているわけではない。RubyのOpen Classesによりそれ以外のバージョンでも可能となっている。原文はこちらです:http://www.infoq.com/news/2008/02/tap-method-ruby19