Skip to content

Commit

Permalink
Update README and CHANGELOG for 2.0.0.beta1
Browse files Browse the repository at this point in the history
  • Loading branch information
mudge committed Sep 8, 2023
1 parent 9764272 commit 3185cbd
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 12 deletions.
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@ project adheres to [Semantic Versioning](http://semver.org/).
Older versions are detailed as [GitHub
releases](https://github.com/mudge/re2/releases) for this project.

## [2.0.0.beta1] - 2023-09-08
### Added
- The gem now comes bundled with the underlying re2 library and its dependency,
abseil. Installing the gem will compile those dependencies automatically. As
this can take a while, precompiled native gems are available for Linux,
Windows and macOS. (Thanks to Stan Hu for contributing this.)

### Changed
- By default, the gem will use its own bundled version of re2 rather than
looking for the library on the system. To opt back into that behaviour, pass
`--enable-system-libraries` when installing. (Thanks to Stan Hu for
contributing this.)

### Removed
- Due to the new dependency on MiniPortile2, the gem no longer supports Ruby
versions older than 2.7.

## [1.7.0] - 2023-07-04
### Added
- Added support for libre2.11 (thanks to Stan Hu for contributing this)
Expand Down Expand Up @@ -82,6 +99,7 @@ releases](https://github.com/mudge/re2/releases) for this project.
### Fixed
- In Ruby 1.9.2 and later, re2 will now set the correct encoding for strings

[2.0.0.beta1]: https://github.com/mudge/re2/releases/tag/v2.0.0.beta1
[1.7.0]: https://github.com/mudge/re2/releases/tag/v1.7.0
[1.6.0]: https://github.com/mudge/re2/releases/tag/v1.6.0
[1.5.0]: https://github.com/mudge/re2/releases/tag/v1.5.0
Expand Down
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,40 @@ re2 [![Build Status](https://github.com/mudge/re2/actions/workflows/tests.yml/ba
A Ruby binding to [re2][], an "efficient, principled regular expression
library".

**Current version:** 1.7.0
**Supported Ruby versions:** 1.8.7, 1.9.3, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2
**Current version:** 2.0.0.beta1
**Supported Ruby versions:** 2.7, 3.0, 3.1, 3.2
**Bundled re2 version:** libre2.11 (2023-07-01)
**Supported re2 versions:** libre2.0 (< 2020-03-02), libre2.1 (2020-03-02), libre2.6 (2020-03-03), libre2.7 (2020-05-01), libre2.8 (2020-07-06), libre2.9 (2020-11-01), libre2.10 (2022-12-01), libre2.11 (2023-07-01)

Installation
------------

You will need [re2][] installed as well as a C++ compiler such as [gcc][] (on
Debian and Ubuntu, this is provided by the [build-essential][] package). If
you are using Mac OS X, I recommend installing re2 with [Homebrew][] by
running the following:
The gem comes bundled with a version of [re2][] and will compile itself (and
any dependencies) on install. As compilation can take a while, precompiled
native gems are available for Linux, Windows and macOS.

If you wish to opt out of using the bundled libraries, you will need re2
installed as well as a C++ compiler such as [gcc][] (on Debian and Ubuntu, this
is provided by the [build-essential][] package). If you are using Mac OS X, I
recommend installing re2 with [Homebrew][] by running the following:

$ brew install re2

If you are using Debian, you can install the [libre2-dev][] package like so:

$ sudo apt-get install libre2-dev

Recent versions of re2 require a compiler with C++14 support such as [clang](http://clang.llvm.org/) 3.4 or [gcc](https://gcc.gnu.org/) 5.
Recent versions of re2 require a compiler with C++14 support such as
[clang](http://clang.llvm.org/) 3.4 or [gcc](https://gcc.gnu.org/) 5.

If you are using a packaged Ruby distribution, make sure you also have the
Ruby header files installed such as those provided by the [ruby-dev][] package
on Debian and Ubuntu.

You can then install the library via RubyGems with `gem install re2` or `gem
install re2 -- --with-re2-dir=/path/to/re2/prefix` if re2 is not installed in
any of the following default locations:
You can then install the library via RubyGems with `gem install re2 --
--enable-system-libraries` or `gem install re2 -- --enable-system-libraries
--with-re2-dir=/path/to/re2/prefix` if re2 is not installed in any of the
following default locations:

* `/usr/local`
* `/opt/homebrew`
Expand Down Expand Up @@ -214,7 +221,7 @@ Contributions
* Thanks to [Jason Woods](https://github.com/driskell) who contributed the
original implementations of `RE2::MatchData#begin` and `RE2::MatchData#end`;
* Thanks to [Stefano Rivera](https://github.com/stefanor) who first contributed C++11 support;
* Thanks to [Stan Hu](https://github.com/stanhu) for reporting a bug with empty patterns and `RE2::Regexp#scan` and for contributing support for libre2.11 (2023-07-01);
* Thanks to [Stan Hu](https://github.com/stanhu) for reporting a bug with empty patterns and `RE2::Regexp#scan`, contributing support for libre2.11 (2023-07-01) and for vendoring re2 and abseil and compiling native gems in 2.0;
* Thanks to [Sebastian Reitenbach](https://github.com/buzzdeee) for reporting
the deprecation and removal of the `utf8` encoding option in re2;
* Thanks to [Sergio Medina](https://github.com/serch) for reporting a bug when
Expand Down
2 changes: 1 addition & 1 deletion re2.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Gem::Specification.new do |s|
s.summary = "Ruby bindings to re2."
s.description = 'Ruby bindings to re2, "an efficient, principled regular expression library".'
s.version = RE2::VERSION
s.authors = ["Paul Mucur"]
s.authors = ["Paul Mucur", "Stan Hu"]
s.homepage = "https://github.com/mudge/re2"
s.extensions = ["ext/re2/extconf.rb"]
s.license = "BSD-3-Clause"
Expand Down

0 comments on commit 3185cbd

Please sign in to comment.