https://github.com/gfx/ruby-regexp_trie

Fast keyword matching with the Trie algorithm (a Ruby port of Perl's Regexp::Trie)
https://github.com/gfx/ruby-regexp_trie

regexp regexp-trie regular-expression ruby-library

Last synced: 9 days ago
JSON representation

Fast keyword matching with the Trie algorithm (a Ruby port of Perl's Regexp::Trie)

• Host: GitHub
• URL: https://github.com/gfx/ruby-regexp_trie
• Owner: gfx
• License: mit
• Created: 2016-01-21T15:47:59.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-09-21T00:35:48.000Z (about 2 years ago)
• Last Synced: 2024-10-11T21:09:54.822Z (25 days ago)
• Topics: regexp, regexp-trie, regular-expression, ruby-library
• Language: Ruby
• Homepage: https://rubygems.org/gems/regexp_trie
• Size: 5.03 MB
• Stars: 28
• Watchers: 2
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# RegexpTrie [![CI](https://github.com/gfx/ruby-regexp_trie/actions/workflows/CI.yml/badge.svg)](https://github.com/gfx/ruby-regexp_trie/actions/workflows/CI.yml) [![Gem Version](https://badge.fury.io/rb/regexp_trie.svg)](https://badge.fury.io/rb/regexp_trie)

## Synopsis

```ruby

#!/usr/bin/env ruby

require 'regexp_trie'

# like Regexp.union()

p RegexpTrie.union(%w(foobar fooxar foozap fooza)) # /foo(?:bar|xar|zap?)/

p RegexpTrie.union(%w(foobar fooxar foozap fooza), option: Regexp::IGNORECASE) # /foo(?:bar|xar|zap?)/i

# or object-oriented interface

rt = RegexpTrie.new

%w(foobar fooxar foozap fooza).each do |word|

  rt.add(word)

end

p rt.to_regexp # /foo(?:bar|xar|zap?)/

```

See also the original [Regexp::Trie in Perl](https://metacpan.org/pod/Regexp::Trie).

## Description

`RegexpTrie` takes an arbitrary number of regular expressions and assembles them into a single regular expression (or RE) that matches all that the individual REs match.

In other words, this library provides a limited but optimized version of `Regexp.union()`, even thouh there are some incompatibilities with it.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'regexp_trie'

```

## Incompatibilities with the built-in `Regexp.union()`

* `RegexpTrie` handles only literals. i.e. `RegexpTrie.union("foo.*bar")` produces `/foo\.\*bar/`, not `/foo.*bar/`

* `RegexpTrie` cannot handle empty strings.

* The order of words does not matter:

  * `Regexp.union("foo", "foobar").match("foobar") # => #`

  * `RegexpTrie.union("foo", "foobar").match("foobar") # => #`

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/gfx/regexp_trie.

## See Also

* https://metacpan.org/pod/Regexp::Assemble

* https://metacpan.org/pod/Regexp::Trie

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

The original code is @dankogai's [Regexp::Trie](https://metacpan.org/pod/Regexp::Trie).