https://github.com/q-m/tiered_category_expressions
Work with TCEs in Ruby
https://github.com/q-m/tiered_category_expressions
categories expression language parser pattern-matching regular-expressions
Last synced: 8 months ago
JSON representation
Work with TCEs in Ruby
- Host: GitHub
- URL: https://github.com/q-m/tiered_category_expressions
- Owner: q-m
- License: mit
- Created: 2019-04-01T20:48:54.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-09-05T07:34:28.000Z (almost 3 years ago)
- Last Synced: 2025-02-02T19:46:29.963Z (over 1 year ago)
- Topics: categories, expression, language, parser, pattern-matching, regular-expressions
- Language: Ruby
- Size: 96.7 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Tiered Category Expressions
Work with TCE v1.1 in Ruby.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'tiered_category_expressions'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install tiered_category_expressions
And require with:
```ruby
require 'tiered_category_expressions'
```
Or, if you don't want the `TCE()` alias in the global namespace, require with:
```ruby
require 'tiered_category_expressions/core'
```
## Documentation
- [Library documentation](https://www.rubydoc.info/gems/tiered_category_expressions/)
- [TCE language reference](https://www.rubydoc.info/gems/tiered_category_expressions/file/LANGREF.md)
- [Introductory blogpost](https://developers.thequestionmark.org/2019/07/24/pattern-matching-expert-system-classification)
## Usage examples
```ruby
tce = TCE("groceries > nonfood | pharmacy >> !baby formula")
# => TieredCategoryExpressions::Expression
tce.matches?(["Groceries", "Non-food", "Cleaning", "Soap"])
# => true
tce.matches?(["Groceries", "Non-food", "Baby", "Baby formula"])
# => false
tce.matches?(["Groceries", "Pharmacy", "Baby", "Pacifiers"])
# => true
tce.to_regexp
# => Regexp
tce.as_regexp
# => String
TCE("groceries > nonfood") > TCE("baby") > ">> pacifiers"
# => TieredCategoryExpressions::Expression
```
## Development
Run `rake spec` to run the tests. You can also run `bundle 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 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/q-m/tiered_category_expressions.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).