Feature #12969: Allow optional parameter in String#strip and related

• Status: Closed
• Assignee: -
• Target version: -

[herwinw (Herwin Quarantainenet)]

String#strip and related methods have a hardcoded match on whitespace, defined as "null, horizontal tab, line feed, vertical tab, form feed, carriage return, space". It would be nice to allow a parameter to specify the characters you want to strip.

This would result in a kind of marriage between String#delete and String#chomp. The first one is an example on how to specify character classes, the second one is an example on how to pass an optional parameter.

Examples how this would work:

"hellooo  ".rstrip          #=> "hellooo"
"hellooo  ".rstrip(" ")     #=> "hellooo"
"hellooo  ".rstrip(" o")    #=> "hell"
"hellooo  ".rstrip("o ")    #=> "hell"
"hellooo  ".rstrip("o")     #=> "hellooo  "
"hellooo  ".chomp(" ")      #=> "hellooo ", only replaces one character, thus not a sensible alternative

The same behaviour can be achieved by using String#sub and the correct anchors, but I think an optional parameter to String#strip is cleaner to read. It's probably faster too, since we don't have to initialize a regex state machine.

[shyouhei (Shyouhei Urabe)]

I think it's possible. Just wonder if there are cases where it is useful.

[herwinw (Herwin Quarantainenet)]

The concrete use case that I got was that I wanted to replace all trailing whitespace, but leave tabs/newlines etc untouched. The current code looks like this:

newstr = str.sub(/ +$/, '')

I tried to see if there was a more suitable method in String to do this, but both String#rstrip and String#chomp case close to what I needed here, but no cigar.

[matz (Yukihiro Matsumoto)]

Removing pattern may not be set of single character, or may be complex.
Considering that, using regular expression is the best way, I think.

Matz.

[naruse (Yui NARUSE)]

In the Unicode age the list of character is more and more complex.
Using a string as a list of characters is not a good idea now.

Though String#tr already exists, adding new one is not a good idea.

[duerst (Martin Dürst)]

Yukihiro Matsumoto wrote:

Removing pattern may not be set of single character, or may be complex.
Considering that, using regular expression is the best way, I think.

I agree. It would also allow to specify character ranges and character properties.

[Earlopain (Earlopain _)]

• Related to Feature #21552: allow String.strip and similar to take a parameter similar to String.delete added

[Earlopain (Earlopain _)]

• Status changed from Open to Closed

https://bugs.ruby-lang.org/issues/21552 implemented this