re2 2.5.0-x86_64-linux → 2.6.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f8121a94b7e2269ade35ef639dceab4cdc916f2564b6f7ad7bb000817598462
-  data.tar.gz: 8fba5f95068f6462824a3dabc61bfbca38100757fa9c3f3301369aad124cddcd
+  metadata.gz: 74b01de44200dcb096df717921d0e2e7ee835fb0a9bcf9b9697a01cc3fa58dbf
+  data.tar.gz: a5f7ef8db88a43099991280d7b6e1a9ef653ea2e2cef672a6d0c3aea2db7fc81
 SHA512:
-  metadata.gz: ad63b08fbea8215fd07b717e2bfb4373d9d6b33a3d41f870f1a4b6a7c2c322c09788c144525f73c72abd246ea45d7a42f9f7bf2e999794f41c0f42e77cadae73
-  data.tar.gz: eaa9388853b95de6fc923f59b43b9638903900d06cb705af832b637adf62be1378cbe6c5e334d21b69d6a777d2e99ff14b9d426ca179b8ac2bba3dde01d131f7
+  metadata.gz: 86500fee5024515574291dfaee1dba2002a8e380b9f4723023a8516bbff631393d6436714189f2b32f9f03ad5cc1c5f9e12e9b0f27ff86f54fd1c98744489a80
+  data.tar.gz: 6d0d773ecbbecf0c52323a247f74616846388e2a1625b291a131ed6c9634d9793e943c8ceed502dfda8e997bf97ff47e161fe18232e3ea94bb42e68447696ad7

data/README.md

@@ -1,10 +1,12 @@
-# re2 [![Build Status](https://github.com/mudge/re2/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/mudge/re2/actions)
+# re2 - safer regular expressions in Ruby
 
 Ruby bindings to [RE2][], a "fast, safe, thread-friendly alternative to
 backtracking regular expression engines like those used in PCRE, Perl, and
 Python".
 
-**Current version:** 2.5.0  
+[![Build Status](https://github.com/mudge/re2/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/mudge/re2/actions)
+
+**Current version:** 2.6.0  
 **Bundled RE2 version:** libre2.11 (2023-11-01)  
 
 ```ruby
@@ -28,6 +30,7 @@ RE2('(\w+):(\d+)').full_match("ruby:1234")
     * [Encoding](#encoding)
 * [Requirements](#requirements)
     * [Native gems](#native-gems)
+    * [Verifying the gems](#verifying-the-gems)
     * [Installing the `ruby` platform gem](#installing-the-ruby-platform-gem)
     * [Using system libraries](#using-system-libraries)
 * [Thanks](#thanks)
@@ -37,6 +40,17 @@ RE2('(\w+):(\d+)').full_match("ruby:1234")
 
 ## Why RE2?
 
+While [recent
+versions](https://www.ruby-lang.org/en/news/2022/12/25/ruby-3-2-0-released/) of
+Ruby have improved defences against [regular expression denial of service
+(ReDoS) attacks](https://en.wikipedia.org/wiki/ReDoS), it is still possible for
+users to craft malicious patterns that take a long time to process by using
+syntactic features such as [back-references, lookaheads and possessive
+quantifiers](https://bugs.ruby-lang.org/issues/19104#note-3). RE2 aims to
+eliminate ReDoS by design:
+
+> **_Safety is RE2's raison d'être._**
+>
 > RE2 was designed and implemented with an explicit goal of being able to
 > handle regular expressions from untrusted users without risk. One of its
 > primary guarantees is that the match time is linear in the length of the
@@ -110,7 +124,7 @@ See the API documentation for [`RE2::Regexp#initialize`](https://mudge.name/re2/
 
 ### Matching interface
 
-There are two main methods for matching: [`RE2::Regexp#full_match?`](https://mudge.name/re2/RE2/Regexp.html#full_match%3F-instance_method) requires the regular expression to match the entire input text, and [`RE2::Regexp#partial_match?`](https://mudge.name/re2/RE2/Regexp.html#match%3F-instance_method) looks for a match for a substring of the input text, returning a boolean to indicate whether a match was successful or not.
+There are two main methods for matching: [`RE2::Regexp#full_match?`](https://mudge.name/re2/RE2/Regexp.html#full_match%3F-instance_method) requires the regular expression to match the entire input text, and [`RE2::Regexp#partial_match?`](https://mudge.name/re2/RE2/Regexp.html#partial_match%3F-instance_method) looks for a match for a substring of the input text, returning a boolean to indicate whether a match was successful or not.
 
 ```ruby
 RE2('h.*o').full_match?("hello")    #=> true
@@ -253,11 +267,40 @@ It supports the following RE2 ABI versions:
 
 Where possible, a pre-compiled native gem will be provided for the following platforms:
 
-* Linux `aarch64-linux` and `arm-linux` (requires [glibc](https://www.gnu.org/software/libc/) 2.29+)
-* Linux `x86-linux` and `x86_64-linux` (requires [glibc](https://www.gnu.org/software/libc/) 2.17+) including [musl](https://musl.libc.org/)-based systems such as [Alpine](https://alpinelinux.org)
+* Linux
+    * `aarch64-linux` and `arm-linux` (requires [glibc](https://www.gnu.org/software/libc/) 2.29+)
+    * `x86-linux` and `x86_64-linux` (requires [glibc](https://www.gnu.org/software/libc/) 2.17+)
+    * [musl](https://musl.libc.org/)-based systems such as [Alpine](https://alpinelinux.org) are supported as long as a [glibc-compatible library is installed](https://wiki.alpinelinux.org/wiki/Running_glibc_programs)
 * macOS `x86_64-darwin` and `arm64-darwin`
 * Windows `x64-mingw32` and `x64-mingw-ucrt`
 
+### Verifying the gems
+
+SHA256 checksums are included in the [release notes](https://github.com/mudge/re2/releases) for each version and can be checked with `sha256sum`, e.g.
+
+```console
+$ gem fetch re2 -v 2.5.0
+Fetching re2-2.5.0-arm64-darwin.gem
+Downloaded re2-2.5.0-arm64-darwin
+$ sha256sum re2-2.5.0-arm64-darwin.gem
+4b20c4539a12787102b22012e678968af23f87e35f88843744835bd13ac9f6bc  re2-2.5.0-arm64-darwin.gem
+```
+
+[GPG](https://www.gnupg.org/) signatures are attached to each release (the assets ending in `.sig`) and can be verified if you import [our signing key `0x39AC3530070E0F75`](https://mudge.name/39AC3530070E0F75.asc) (or fetch it from a public keyserver, e.g. `gpg --keyserver keyserver.ubuntu.com --recv-key 0x39AC3530070E0F75`):
+
+```console
+$ gpg --verify re2-2.5.0-arm64-darwin.gem.sig re2-2.5.0-arm64-darwin.gem
+gpg: Signature made Fri 15 Dec 2023 12:58:58 GMT
+gpg:                using RSA key 702609D9C790F45B577D7BEC39AC3530070E0F75
+gpg: Good signature from "Paul Mucur <mudge@mudge.name>" [unknown]
+gpg:                 aka "Paul Mucur <paul@ghostcassette.com>" [unknown]
+gpg: WARNING: This key is not certified with a trusted signature!
+gpg:          There is no indication that the signature belongs to the owner.
+Primary key fingerprint: 7026 09D9 C790 F45B 577D  7BEC 39AC 3530 070E 0F75
+```
+
+The fingerprint should be as shown above or you can independently verify it with the ones shown in the footer of https://mudge.name.
+
 ### Installing the `ruby` platform gem
 
 > [!WARNING]

data/Rakefile

@@ -33,7 +33,7 @@ Gem::PackageTask.new(RE2_GEM_SPEC) do |p|
   p.need_tar = false
 end
 
-CROSS_RUBY_VERSIONS = %w[3.2.0 3.1.0 3.0.0 2.7.0 2.6.0].join(':')
+CROSS_RUBY_VERSIONS = %w[3.3.0 3.2.0 3.1.0 3.0.0 2.7.0 2.6.0].join(':')
 CROSS_RUBY_PLATFORMS = %w[
   aarch64-linux
   arm-linux

data/ext/re2/re2.cc

@@ -1588,7 +1588,7 @@ static VALUE re2_regexp_full_match_p(const VALUE self, VALUE text) {
  *
  * @param [text] text the text to scan incrementally
  * @return [RE2::Scanner] an `Enumerable` {RE2::Scanner} object
- * @raises [TypeError] if `text` cannot be coerced to a `String`
+ * @raise [TypeError] if `text` cannot be coerced to a `String`
  * @example
  *   c = RE2::Regexp.new('(\w+)').scan("Foo bar baz")
  *   #=> #<RE2::Scanner:0x0000000000000001>
@@ -1652,7 +1652,7 @@ static VALUE re2_regexp_match_has_endpos_argument_p(VALUE) {
  * @param [String, RE2::Regexp] pattern a regexp matching text to be replaced
  * @param [String] rewrite the string to replace with
  * @return [String] the resulting string
- * @raises [TypeError] if the given rewrite or pattern (if not provided as a
+ * @raise [TypeError] if the given rewrite or pattern (if not provided as a
  *   {RE2::Regexp}) cannot be coerced to `String`s
  * @example
  *   RE2.Replace("hello there", "hello", "howdy") #=> "howdy there"
@@ -1700,7 +1700,7 @@ static VALUE re2_Replace(VALUE, VALUE str, VALUE pattern,
  * @param [String] str the string to modify
  * @param [String, RE2::Regexp] pattern a regexp matching text to be replaced
  * @param [String] rewrite the string to replace with
- * @raises [TypeError] if the given rewrite or pattern (if not provided as a
+ * @raise [TypeError] if the given rewrite or pattern (if not provided as a
  *   {RE2::Regexp}) cannot be coerced to `String`s
  * @return [String] the resulting string
  * @example
@@ -1745,7 +1745,7 @@ static VALUE re2_GlobalReplace(VALUE, VALUE str, VALUE pattern,
  * exactly match the original string.
  *
  * @param [String] unquoted the unquoted string
- * @raises [TypeError] if the given unquoted string cannot be coerced to a `String`
+ * @raise [TypeError] if the given unquoted string cannot be coerced to a `String`
  * @return [String] the escaped string
  * @example
  *   RE2::Regexp.escape("1.5-2.0?") #=> "1\.5\-2\.0\?"

data/lib/re2/regexp.rb

@@ -6,6 +6,7 @@
 # Copyright (c) 2010, Paul Mucur (https://mudge.name)
 # Released under the BSD Licence, please see LICENSE.txt
 
+
 module RE2
   class Regexp
     # Match the pattern against any substring of the given `text` and return a

data/lib/re2/scanner.rb

@@ -6,6 +6,7 @@
 # Copyright (c) 2010, Paul Mucur (https://mudge.name)
 # Released under the BSD Licence, please see LICENSE.txt
 
+
 module RE2
   class Scanner
     include Enumerable

data/lib/re2/string.rb

@@ -9,6 +9,7 @@
 require "re2"
 
 module RE2
+  # @deprecated Use methods on {RE2} and {RE2::Regexp} instead.
   module String
     # @deprecated Use {RE2.Replace} instead.
     def re2_sub(*args)

data/lib/re2/version.rb

@@ -8,6 +8,7 @@
 # Copyright (c) 2010, Paul Mucur (https://mudge.name)
 # Released under the BSD Licence, please see LICENSE.txt
 
+
 module RE2
-  VERSION = "2.5.0"
+  VERSION = "2.6.0"
 end

data/re2.gemspec

@@ -38,8 +38,8 @@ Gem::Specification.new do |s|
     "spec/re2/set_spec.rb",
     "spec/re2/scanner_spec.rb"
   ]
-  s.add_development_dependency("rake-compiler", "~> 1.2.1")
-  s.add_development_dependency("rake-compiler-dock", "~> 1.3.0")
+  s.add_development_dependency("rake-compiler", "~> 1.2.5")
+  s.add_development_dependency("rake-compiler-dock", "~> 1.4.0")
   s.add_development_dependency("rspec", "~> 3.2")
   s.add_runtime_dependency("mini_portile2", "~> 2.8.5") # keep version in sync with extconf.rb
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: re2
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: x86_64-linux
 authors:
 - Paul Mucur
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.5
 - !ruby/object:Gem::Dependency
   name: rake-compiler-dock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ files:
 - lib/3.0/re2.so
 - lib/3.1/re2.so
 - lib/3.2/re2.so
+- lib/3.3/re2.so
 - lib/re2.rb
 - lib/re2/regexp.rb
 - lib/re2/scanner.rb
@@ -104,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
   - - "<"
     - !ruby/object:Gem::Version
-      version: 3.3.dev
+      version: 3.4.dev
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="