[ruby-trunk - Bug #8853][Open] Should String#sub(pattern) returns an Enumerator?

Issue #8853 has been reported by okkez (okkez _).


Bug #8853: Should String#sub(pattern) returns an Enumerator?

Author: okkez (okkez _)
Status: Open
Priority: Normal
Assignee:
Category:
Target version:
ruby -v: ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-linux]
Backport: 1.9.3: UNKNOWN, 2.0.0: UNKNOWN

調べてみたのですが、過去に同様の議論があったのかどうかわからなかったので起票します。

以下のように String#sub(pattern) と使うと ArgumentError が発生します。

$ ruby -e “p ‘’.sub(//)”
-e:1:in sub': wrong number of arguments (1 for 2) (ArgumentError) from -e:1:in

一方、 String#gsub(pattern) だと Enumerator を返します。

$ ruby -e “p ‘’.gsub(//)”
#<Enumerator: “”:gsub(//)>

RDoc ではこの挙動は説明されていませんでした。
String#gsub(pattern)がEnumeratorを返すことについては書かれています。

一貫性の観点から考えると、String#sub(pattern)もEnumeratorを返した方が良いように思いましたがいかがでしょうか。
まあ、String#sub だと置換は一回しか発生しないのでイマイチな感じはします。

  • String#sub(pattern) が Enumerator を返すようになる
  • RDoc に String#gsub(pattern) と違って String#sub(pattern) が ArgumentError
    を発生させることの記述が追加される

のどちらかが、満たされればいいと思っています。