re2 2.24.0-aarch64-linux-gnu → 2.25.0-aarch64-linux-gnu

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 255b04c539840989cbd6d55541e6a1c5b45e12995a1033f13956d504e2d9b57d
-  data.tar.gz: 251b2090a90446026d5e0696989f323650dec160a947f41ef4f7ef97aaea92af
+  metadata.gz: 992dc0b6a56f177c1e6a6421737779cd45981071f3afe62a788930c6e1c3a390
+  data.tar.gz: 1bb490277db9d2801c246b599303f39ad475fc56be4bf2abf2c11c860e6db277
 SHA512:
-  metadata.gz: f284d2f266e98b37d2560a61e7039cd392bf14abb8e85517c4776245cd3f9a7571f0735d7143296594a18ca1ef2712e9a8bcd17f9815c8982d53548ce201d95a
-  data.tar.gz: a8afe6761590e34e2bdb2cbcf50afea52b6a4a3801a8cf598eda3a0d7b33b7be81bcfbbae34e9ef60c1675c0eda13a4a4df9d47e81128be89053a8ba8a276b3a
+  metadata.gz: 856d8832fe492ecc9a140fc2ba4c81725b3827e21c58145e896c360c7679f7e293d4fe03427ff2f54066667632dea1d93314c655e8460999b12622567109fda9
+  data.tar.gz: d3ee08fd8464252e5f674fa59c8d3d9da2fc0b093db659ec108f99a6392c70b6a020af2cb2f7abbaa7622a5d77a3f8102a52ed1ccd886690ff3a55cdfa39d11d

data/README.md

@@ -6,7 +6,7 @@ Python".
 
 [![Build Status](https://github.com/mudge/re2/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/mudge/re2/actions)
 
-**Current version:** 2.24.0  
+**Current version:** 2.25.0  
 **Bundled RE2 version:** libre2.11 (2025-11-05)  
 
 ```ruby
@@ -27,6 +27,8 @@ RE2('(\w+):(\d+)').full_match("ruby:1234")
     * [Submatch extraction](#submatch-extraction)
     * [Scanning text incrementally](#scanning-text-incrementally)
     * [Searching simultaneously](#searching-simultaneously)
+    * [Replacing and extracting](#replacing-and-extracting)
+    * [Escaping](#escaping)
     * [Encoding](#encoding)
 * [Requirements](#requirements)
     * [Native gems](#native-gems)
@@ -165,7 +167,72 @@ m["word"]   #=> "ruby"
 m["number"] #=> "1234"
 ```
 
-They can also be used with Ruby's [pattern matching](https://docs.ruby-lang.org/en/3.2/syntax/pattern_matching_rdoc.html):
+Multiple submatches can be retrieved at the same time by numeric index or name with [`values_at`](https://mudge.name/re2/RE2/MatchData.html#values_at-instance_method):
+
+```ruby
+m = RE2('(?P<word>\w+):(?P<number>\d+):(\d+)').full_match("ruby:1234:5678")
+#=> #<RE2::MatchData "ruby:1234:5678" 1:"ruby" 2:"1234" 3:"5678">
+
+m.values_at("word", :number, 3)
+#=> ["ruby", "1234", "5678"]
+```
+
+All captures can be returned as an array with [`captures`](https://mudge.name/re2/RE2/MatchData.html#captures-instance_method):
+
+```ruby
+m = RE2('(?P<word>\w+):(?P<number>\d+):(\d+)').full_match("ruby:1234:5678")
+#=> #<RE2::MatchData "ruby:1234:5678" 1:"ruby" 2:"1234" 3:"5678">
+
+m.captures #=> ["ruby", "1234", "5678"]
+```
+
+Capturing group names are available on both `RE2::Regexp` and `RE2::MatchData`:
+
+```ruby
+re = RE2('(?P<word>\w+):(?P<number>\d+):(\d+)')
+re.names           #=> ["number", "word"]
+
+m = re.full_match("ruby:1234:5678")
+m.names            #=> ["number", "word"]
+```
+
+Named captures can be returned as a hash with [`named_captures`](https://mudge.name/re2/RE2/MatchData.html#named_captures-instance_method):
+
+```ruby
+m = RE2('(?P<word>\w+):(?P<number>\d+):(\d+)').full_match("ruby:1234:5678")
+#=> #<RE2::MatchData "ruby:1234:5678" 1:"ruby" 2:"1234" 3:"5678">
+
+m.named_captures
+#=> {"number" => "1234", "word" => "ruby"}
+m.named_captures(symbolize_names: true)
+#=> {number: "1234", word: "ruby"}
+```
+
+This is [also available](https://mudge.name/re2/RE2/Regexp.html#named_captures-instance_method) on the original `RE2::Regexp` but will return the corresponding numerical index for each group:
+
+```ruby
+re = RE2('(?P<word>\w+):(?P<number>\d+):(\d+)')
+re.named_captures
+#=> {"number" => 2, "word" => 1}
+```
+
+The strings before and after a match can be returned with [`pre_match`](https://mudge.name/re2/RE2/MatchData.html#pre_match-instance_method) and [`post_match`](https://mudge.name/re2/RE2/MatchData.html#post_match-instance_method):
+
+```ruby
+m = RE2::Regexp.new('(\d+)').partial_match("bob 123 456")
+m.pre_match  #=> "bob "
+m.post_match #=> " 456"
+```
+
+The [`offset`](https://mudge.name/re2/RE2/MatchData.html#offset-instance_method) and [`match_length`](https://mudge.name/re2/RE2/MatchData.html#match_length-instance_method) of a match can be retrieved by index or name:
+
+```ruby
+m = RE2::Regexp.new('(\d+)').partial_match("bob 123 456")
+m.offset(1)       #=> [4, 7]
+m.match_length(1) #=> 3
+```
+
+`RE2::MatchData` objects can also be used with Ruby's [pattern matching](https://docs.ruby-lang.org/en/3.2/syntax/pattern_matching_rdoc.html):
 
 ```ruby
 case RE2('(\w+):(\d+)').full_match("ruby:1234")
@@ -238,6 +305,42 @@ set.match("abcdefghi") #=> [0, 1, 2]
 set.match("ghidefabc") #=> [2, 1, 0]
 ```
 
+### Replacing and extracting
+
+[`RE2.replace`](https://mudge.name/re2/RE2.html#replace-class_method) returns a copy of a given string with the first occurrence of a pattern replaced with a given rewrite string:
+
+```ruby
+RE2.replace("hello there", "hello", "howdy") #=> "howdy there"
+```
+
+The pattern can be given as either a string or an `RE2::Regexp`:
+
+```ruby
+re = RE2('hel+o')
+RE2.replace("hello there", re, "yo") #=> "yo there"
+```
+
+To replace _all_ matches and not just the first, use [`RE2.global_replace`](https://mudge.name/re2/RE2.html#global_replace-class_method):
+
+```ruby
+RE2.global_replace("hallo thare", "a", "e")  #=> "hello there"
+```
+
+To extract matches with a given rewrite string including substitutions, use [`RE2.extract`](https://mudge.name/re2/RE2.html#extract-class_method):
+
+```ruby
+RE2.extract("alice@example.com", '(\w+)@(\w+)', '\2-\1')
+#=> "example-alice"
+```
+
+### Escaping
+
+To escape all potentially meaningful regexp characters in a string, use [`RE2.escape`](https://mudge.name/re2/RE2.html#escape-class_method):
+
+```ruby
+RE2.escape("1.5-2.0?") #=> "1\\.5\\-2\\.0\\?"
+```
+
 ### Encoding
 
 > [!WARNING]
@@ -250,10 +353,10 @@ the right encoding so this is the responsibility of the caller, e.g.
 
 ```ruby
 # By default, RE2 will process patterns and text as UTF-8
-RE2(non_utf8_pattern.encode("UTF-8")).match(non_utf8_text.encode("UTF-8"))
+RE2(non_utf8_pattern.encode("UTF-8")).partial_match(non_utf8_text.encode("UTF-8"))
 
 # If the :utf8 option is false, RE2 will process patterns and text as ISO-8859-1
-RE2(non_latin1_pattern.encode("ISO-8859-1"), utf8: false).match(non_latin1_text.encode("ISO-8859-1"))
+RE2(non_latin1_pattern.encode("ISO-8859-1"), utf8: false).partial_match(non_latin1_text.encode("ISO-8859-1"))
 ```
 
 ## Requirements