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

• Status: Open
• Assignee: -
• Target version: -

[okkez (okkez _)]

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

以下のように 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を返すことについては書かれています。
http://www.ruby-doc.org/core-2.0.0/String.html#method-i-sub
http://www.ruby-doc.org/core-2.0.0/String.html#method-i-gsub

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

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

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

[jeremyevans0 (Jeremy Evans)]

• File string-sub-enumerator.patch string-sub-enumerator.patch added
• Tracker changed from Bug to Feature
• ruby -v deleted (ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-linux])
• Backport deleted (1.9.3: UNKNOWN, 2.0.0: UNKNOWN)

If I understand this correctly, this is a feature request to make String#sub and #sub! return an Enumerator if given a single argument and no block. I'm not sure how useful this would be. With #sub!, you can use the enumerator to mutate the string passing the replacement in via Enumerator#feed. However, with #sub, you cannot use the enumerator to modify anything, since the String#sub receiver is not modified, and you can't get access to the resulting string. However, assuming this is desired, the attached patch implements it.