[ruby-list:29604] Importing eachdelegator.rb

　少し前に登場した、岡田さん作の EachDelegator:

	http://www.ruby-lang.org/en/raa-list.rhtml?name=EachDelegator

ですが、これをどうやって標準仕様に取り入れようかという話です。


　前の議論を反映して巧妙に実現されており、ぜひとも洗練した形で
標準機能として取り込みたいところです。

(添付ドキュメントより)
============================================================

- EachDelegatorとは?

EachDelegatorとは、ブロックを引数に取る既存のメソッドにEnumerable能力を
あとから追加するためのライブラリです。

rubyには、ひとつのクラスにeach_*と名前のついたメソッドがいくつかあるケー
スが見られます。Stringに対するeach_lineとeach_byteなどがその例です。

こうした複数のeach_*メソッドを持つクラスについて、eachに対してしか 
Enumerableなメソッドを適用できないのはいかにも不便です。こうしたジレンマ
を解消するためにこのライブラリが生まれました。

- 簡単な使い方

eachdelegator.rbをrequireすると、each_*、または*_eachと名前のついたあら
ゆるメソッドが、自動的にEnumerableなメソッドを呼び出せるようになります。

eachdelegator.rbは本来ブロックと共に呼び出さなければいけないこれらのメソッ
ドを、ブロック無しで呼び出した場合にEachDelegatorオブジェクトを返すよう
に再定義します。

EachDelegatorは、eachメソッドを元のオブジェクトの元のメソッドに転送する
Enumerableなクラスです。このクラスのオブジェクトに対して collect、grepな
どのEnumerableモジュールの各種の操作を実行すると、それらを元のメソッドに
対して適用したのと同じ結果が得られます。

例えばString#each_byteをindex付きで呼び出し、その結果をcollect するとい
うような処理を、次のようなシンプルな形で記述できます。

  p "hoge".each_byte.each_with_index.collect{|a, i| [ i, a ]}
   => [[0, 104], [1, 111], [2, 103], [3, 101]]

- 高度な使い方

自動的に再定義されるのは、each_*または*_eachという名前で定義されているメ
ソッドのみです。それ以外のメソッドについては手動で
Module#each_delegatorを使って、メソッドの再定義をしてやる必要があります。

例えば、 Arrayに隣あった要素のペアをiterateするall_pairメソッドを追加し
て、それぞれの要素の差を配列に出力したいといった場合は、次のように書きま
す。
  
  require 'eachdelegator'

  class Array
    def all_pair
      for i in 0...(size - 1) 
        yield at(i), at(i + 1)
      end 
      self
    end


    each_delegator :all_pair
  end
  

  p [1, 3, 5, 7, 13].all_pair.collect{|a, b| b - a}
   => [ 2, 2, 2, 6]

============================================================

と、 Enumerable が本来備えていてもいいような素晴らしい仕様拡張
なのですが、全モジュールを検索して each_*/*_each を自動的に登録
するところと、 method_added を乗っ取って each_*/*_each が追加
されたときに自動的に登録するところが標準に入れるにはちょっと
トリッキー過ぎるきらいがあります。


　そこで考えた案です。

1. 原則的に each_*/*_each のようなメソッドはモジュール(の作者)が
自分で登録することとする。ただし、未対応のモジュールを対応させる
救済用モジュールという位置付けで、自動登録機能のみを独立させた
lib/eachdelegator.rb を提供する。(名称は別途検討)

2. 一方、 each_delegator メソッドや EachDelegator クラスは標準
組み込みとし、標準添付のクラス・モジュールが持つ each_*/*_each
メソッド群はみな最初から each_delegator で登録しておくようにする。
(標準クラス・モジュールを使うだけなら require 'eachdelegator' は
不要)

　さて、これで「ふつー each_*.collect 可能」となるわけですが、
標準組み込みの際に考えた方がいいと思うことを二つ。

3. each_delegator メソッドは、　class Module ではなく module
Enumerable に持たせた方がよいのではないか？階層的にその方が断然
しっくりきて標準採用しやすいと思う。困るのは each_delegator に
登録したいメソッドがあるが each がなく include Enumerable して
いない、という特異なケースだが、 その場合は each と alias して
include Enumerable するのが自然だろう。

4. 名称については、 delegate/delegator というのはちょっとものもの
しい感じがするので、より簡単に:

	EachDelegator -> Enumerable::Enumerator
	each_delegate -> enumerator_method

とするのはどうか？クラス名の方は、ただ each のみを提供する
Enumerable なクラスだから、 Enumerator 以上でも以下でもないという
感じ。外で使うものではないので、 Enumerable の内部クラスとするのが
適当と思われる。登録メソッド名の方は、はっきりと enumerate する
メソッドだと宣言しているように見えるのでこの方がよさそう。


　どんなもんでしょうか？ (早く現実に実装してみたい。:)

-- 
                     /
                    /__  __            Akinori.org / MUSHA.org
                   / )  )  ) )  /     FreeBSD.org / Ruby-lang.org
Akinori MUSHA aka / (_ /  ( (__(  @ iDaemons.org / and.or.jp

"Freeze this moment a little bit longer, make each impression
  a little bit stronger..  Experience slips away -- Time stand still"