Skip to content

Commit efffbe0

Browse files
kratobkratob
committed
add back 3rd argument to Regexp.new
1 parent a745864 commit efffbe0

File tree

6 files changed

+159
-0
lines changed

6 files changed

+159
-0
lines changed

‎CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
## [Unreleased]
22

3+
- Ruby 3.2+: Add back third argument to Regexp.new, to allow passing "n" to set `Regexp::NOENCODING`.
4+
35
## [1.2.0] - 2024-04-10
46

57
- First release with dedicated suport to Ruby 3.3.

‎README.md

+11
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,17 @@ To add them back as no-ops, use
142142
require 'ruby3_backward_compatibility/compatibility/object'
143143
```
144144

145+
### Regexp (Ruby 3.2+)
146+
147+
It was possible to instantiate a Regexp with `Regexp.new('foo', Regexp::IGNORECASE, 'n')`. The last argument used to indicate the encoding in Ruby 1.8. Up to Ruby 3.2 an argument of "n" or "N" indicated a regexp that ignores encoding (same as the Regexp::NOENCODING flag).
148+
149+
In Ruby 3 this raises an `ArgumentError`.
150+
151+
To bring back the old behavior, use
152+
153+
```
154+
require 'ruby3_backward_compatibility/compatibility/regexp'
155+
```
145156

146157
### YAML (Psych)
147158

‎lib/ruby3_backward_compatibility/compatibility/all.rb

+1
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@
77
require 'ruby3_backward_compatibility/compatibility/i18n' if defined?(I18n)
88
require 'ruby3_backward_compatibility/compatibility/object'
99
require 'ruby3_backward_compatibility/compatibility/psych' if defined?(Psych)
10+
require 'ruby3_backward_compatibility/compatibility/regexp'
1011
require 'ruby3_backward_compatibility/compatibility/string'
1112
require 'ruby3_backward_compatibility/compatibility/uri' if defined?(URI)

‎lib/ruby3_backward_compatibility/compatibility/regexp.rb

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
if RUBY_VERSION >= '3.2'
2+
# on 3.2 exactly, we get deprecation errors
3+
# however, this is somewhat hard to fix, since 3.2 added some different ways to pass "options" that we do not want to rebuild
4+
5+
module Ruby3BackwardCompatibility
6+
module RegexpCompatibility
7+
LEGITIMATE_FLAGS = /\A[mix]+\z/
8+
9+
def self.prepended(by)
10+
by.singleton_class.prepend ClassMethods
11+
end
12+
13+
module ClassMethods
14+
def new(regexp_or_string, options = NOT_GIVEN, n_flag = NOT_GIVEN, **kwargs)
15+
if options == NOT_GIVEN
16+
super(regexp_or_string, **kwargs)
17+
elsif n_flag == 'n' || n_flag == 'N'
18+
if !options.is_a?(Integer)
19+
if RUBY_VERSION < '3.3' && options.is_a?(String) && options =~ LEGITIMATE_FLAGS
20+
# on Ruby 3.2 we can legitimately have options "mix" treated as flags, so parse them
21+
new_options = 0
22+
new_options |= Regexp::MULTILINE if options.include?('m')
23+
new_options |= Regexp::IGNORECASE if options.include?('i')
24+
new_options |= Regexp::EXTENDED if options.include?('x')
25+
options = new_options
26+
else
27+
# on all other Ruby, truish is IGNORECASE
28+
options = options ? Regexp::IGNORECASE : 0
29+
end
30+
end
31+
super(regexp_or_string, options | Regexp::NOENCODING, **kwargs)
32+
elsif options.is_a?(String)
33+
if options =~ LEGITIMATE_FLAGS
34+
# this (like any trueish value) would have been "ignore case" in Ruby < 3.2, but now is not
35+
# we have to assume this is Ruby 3.2 syntax
36+
super(regexp_or_string, options, **kwargs)
37+
else
38+
# this crashes on Ruby 3.2, so assume it is < 3.2 syntax
39+
super(regexp_or_string, true, **kwargs)
40+
end
41+
else
42+
super(regexp_or_string, options, **kwargs)
43+
end
44+
end
45+
end
46+
end
47+
end
48+
49+
Regexp.prepend Ruby3BackwardCompatibility::RegexpCompatibility
50+
end

‎spec/isolated/ruby3_backward_compatibility/compatibility/all_spec.rb

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ def expand_require(path)
1717
expect($LOADED_FEATURES).to include(expand_require('ruby3_backward_compatibility/compatibility/i18n'))
1818
expect($LOADED_FEATURES).to include(expand_require('ruby3_backward_compatibility/compatibility/object'))
1919
expect($LOADED_FEATURES).to include(expand_require('ruby3_backward_compatibility/compatibility/psych'))
20+
expect($LOADED_FEATURES).to include(expand_require('ruby3_backward_compatibility/compatibility/regexp'))
2021
expect($LOADED_FEATURES).to include(expand_require('ruby3_backward_compatibility/compatibility/string'))
2122
expect($LOADED_FEATURES).to include(expand_require('ruby3_backward_compatibility/compatibility/uri'))
2223
end

‎spec/ruby3_backward_compatibility/compatibility/regexp_spec.rb

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
require 'ruby3_backward_compatibility/compatibility/regexp'
2+
3+
module Ruby3BackwardCompatibility
4+
describe Regexp do
5+
describe '.new' do
6+
it 'interprets a third argument "n" as Regexp::NOENCODING' do
7+
regexp = Regexp.new('test', Regexp::EXTENDED, 'n')
8+
expect(regexp).to eq(/test/xn)
9+
expect(regexp.options).to eq(Regexp::EXTENDED | Regexp::NOENCODING)
10+
end
11+
12+
it 'interprets a third argument "N" as Regexp::NOENCODING' do
13+
regexp = Regexp.new('test', Regexp::EXTENDED, 'N')
14+
expect(regexp).to eq(/test/xn)
15+
expect(regexp.options).to eq(Regexp::EXTENDED | Regexp::NOENCODING)
16+
end
17+
18+
it 'ignores a other third arguments' do
19+
regexp = Regexp.new('test', Regexp::EXTENDED, 'foo')
20+
expect(regexp).to eq(/test/xn)
21+
expect(regexp.options).to eq(Regexp::EXTENDED)
22+
end
23+
24+
it 'treats a string second argument as Regexp::IGNORECASE if a third argument is present' do
25+
regexp = Regexp.new('test', 'foo', 'N')
26+
expect(regexp).to eq(/test/in)
27+
expect(regexp.options).to eq(Regexp::IGNORECASE | Regexp::NOENCODING)
28+
end
29+
30+
it 'treats a truish second argument as Regexp::IGNORECASE if a third argument is present' do
31+
regexp = Regexp.new('test', true, 'N')
32+
expect(regexp).to eq(/test/in)
33+
expect(regexp.options).to eq(Regexp::IGNORECASE | Regexp::NOENCODING)
34+
end
35+
36+
it 'treats a falsish second argument as 0 if a third argument is present' do
37+
regexp = Regexp.new('test', false, 'N')
38+
expect(regexp).to eq(/test/n)
39+
expect(regexp.options).to eq(Regexp::NOENCODING)
40+
end
41+
42+
it 'can still build a Regexp from string and option' do
43+
regexp = Regexp.new('test', Regexp::IGNORECASE)
44+
expect(regexp).to eq(/test/i)
45+
expect(regexp.options).to eq(Regexp::IGNORECASE)
46+
end
47+
48+
it 'can still build a Regexp from another Regexp' do
49+
regexp = Regexp.new(/test/i)
50+
expect(regexp).to eq(/test/i)
51+
expect(regexp.options).to eq(Regexp::IGNORECASE)
52+
end
53+
54+
it 'can still build a Regexp with a boolean flag' do
55+
regexp = Regexp.new('test', true)
56+
expect(regexp).to eq(/test/i)
57+
expect(regexp.options).to eq(Regexp::IGNORECASE)
58+
end
59+
60+
if RUBY_VERSION >= '3.2'
61+
it 'can merge a third argument "n" with string flags' do
62+
regexp = Regexp.new('test', 'mi', 'n')
63+
expect(regexp.options).to eq(Regexp::IGNORECASE | Regexp::MULTILINE | Regexp::NOENCODING)
64+
65+
regexp = Regexp.new('test', 'ix', 'n')
66+
expect(regexp.options).to eq(Regexp::IGNORECASE | Regexp::EXTENDED | Regexp::NOENCODING)
67+
end
68+
end
69+
70+
if RUBY_VERSION >= '3.3'
71+
it 'treats options of the form "mix" as flags' do
72+
regexp = Regexp.new('test', 'mix')
73+
expect(regexp).to eq(/test/mix)
74+
end
75+
76+
it 'treats options with different chars as trueish' do
77+
regexp = Regexp.new('test', 'n')
78+
expect(regexp).to eq(/test/i)
79+
end
80+
81+
it 'sets timeout to nil by default' do
82+
regexp = Regexp.new('test')
83+
expect(regexp.timeout).to eq(nil)
84+
end
85+
86+
it 'can still build a Regexp with a timeout' do
87+
regexp = Regexp.new('test', timeout: 1)
88+
expect(regexp).to eq(/test/)
89+
expect(regexp.timeout).to eq(1)
90+
end
91+
end
92+
end
93+
end
94+
end

0 commit comments

Comments
 (0)