https://github.com/cloud66-oss/glob_matcher
A Ruby Globmatcher
https://github.com/cloud66-oss/glob_matcher
gem glob regex ruby
Last synced: about 1 month ago
JSON representation
A Ruby Globmatcher
- Host: GitHub
- URL: https://github.com/cloud66-oss/glob_matcher
- Owner: cloud66-oss
- Created: 2020-04-12T13:13:27.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-18T21:45:34.000Z (about 5 years ago)
- Last Synced: 2025-03-24T21:42:26.771Z (about 2 months ago)
- Topics: gem, glob, regex, ruby
- Language: Ruby
- Size: 15.6 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GlobMatcher
GlobMatcher is a string matcher for Ruby. You can use it to check for matches using wildcards. It supports multiple patterns as well as negative patterns.
GlobMatcher is used in [Cloud 66 Skycap](https://www.cloud66.com/containers/skycap/) to filter git branches before deployment.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'glob_matcher'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install glob_matcher
## Usage
GlobMatcher checks strings against a pattern. A pattern is a space delimited list of single patterns to check against. Here are some patterns:
```
abc -> Matches abc
a* -> Matches ab, abc, azyz, ...
foo*bar -> Matches fooxbar, fooxxxxbar, ...
!abc -> Matches any value except for abc
!ab* -> Matches any value except for anything that matches ab*
foo{abc,xyz}bar -> Matches fooabcbar and fooxyzbar
```
You can use multiple patterns:
```
abc xyz -> Matches abc or xyz (OR)
!abc !xyz -> Matches anything expcet abc and xyz (AND)
foo bar !fuzz !buzz -> Matches foo or bar but not fuzz and buzz
```
```ruby
matcher = ::GlobMatcher::Matcher.new('hel*')
matcher.is_match? 'hello' # true
matcher = ::GlobMatcher::Matcher.new('fo* !bar')
matcher.is_match? 'foo' # true
matcher.is_match? 'bar' # false
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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/cloud66-oss/glob_matcher.