https://github.com/miguelcastillo/roolio
Composable rule matching
https://github.com/miguelcastillo/roolio
Last synced: about 1 month ago
JSON representation
Composable rule matching
- Host: GitHub
- URL: https://github.com/miguelcastillo/roolio
- Owner: MiguelCastillo
- License: mit
- Created: 2015-06-19T20:35:36.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-30T23:14:43.000Z (over 7 years ago)
- Last Synced: 2025-02-14T01:36:09.389Z (3 months ago)
- Language: JavaScript
- Size: 29.3 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/MiguelCastillo/roolio)
[](https://gitter.im/MiguelCastillo/roolio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# roolio
> Composable rule matcher
Create rules to check if data matches a particular criteria. Rules are built with one or more `matcher`s so that you can compose sequences of `matcher`s to test data against. There are a few built in `matcher`s to get you started with, but you can create your own as well.
# API
## addMatchers
Function that takes a single or array of matching rules that we refer to as `matchers`. `matchers` added with this method are aggregated.
``` javascript
var rule = new Rule();
// Register a matcher to verify if the input is a string or matches the pattern in the regexp
rule
.addMatchers(Rule.matcher.string)
.addMatchers(/hello world/);
```
## match || matchAny
Function that takes in data to be matched against the configured matching rules. Returns whether or not the input matches **one** of the matching rules.
``` javascript
var rule = new Rule();
// Match true
rule
.addMatchers(Rule.matcher.string)
.addMatchers(/hello world/);
.match('test');
```
## matchAll
Just like `match`, but it checks if the input matches **all** the matching rules.
``` javascript
var rule = new Rule();
// Match is false
rule
.addMatchers(Rule.matcher.string)
.addMatchers(/hello world/);
.matchAll('test');
// Match is true
rule
.matchAll('hello world');
```
## getLength
Function that returns the number of matchers in a particular rule.
``` javascript
var rule = new Rule();
// Length returns 2
rule
.addMatchers(Rule.matcher.string)
.addMatchers(/hello world/)
.getLength();
```
> You can also access `rule.matchers.length`
# matchers
Functions that check if input data matches a criteria. For example, you can check if input data is a string, or if the string is all CAPS.
This is what matchers looks like:
``` javascript
function strict_equality_matcher(match) {
return function(criteria) {
return match === criteria;
}
}
function all_caps_matcher() {
return function(criteria) {
return /[A-Z]/.test(criteria);
}
}
```
> `roolio` comes with a few default matchers that are detailed below.
## default
The default matcher will do a regexp test if a regexp is provided, otherwise it will do a strict equality comparison.
``` javascript
var rule = new Rule();
rule.addMatchers(['hello', /hola/]);
rule.match('hello'); // Will test true
rule.match('hola world'); // Will test true
rule.match('hello world'); // Will test false
rule.match('hi world'); // Will test false
```
## extension
File extension matcher, which verifies if an input string has particular file extensions. You can specify one or more file extensions in a single matcher.
``` javascript
var rule = new Rule();
rule.addMatchers(Rule.matcher.extension('js|jsx|json'));
rule.match('test.js'); // Will test true
rule.match('test.jsx'); // Will test true
rule.match('test.json'); // Will test true
rule.match('testjs'); // Will test false
rule.match('test.js.a'); // Will test false
```
## string
string matcher, which verifies if the input string matches one of the matching rules.
``` javascript
var rule = new Rule();
rule.addMatchers(Rule.matcher.string('test.js'));
rule.match('test.js'); // Will test true
rule.match('test.jsx'); // Will test false
rule.match('test.json'); // Will test false
rule.match('testjs'); // Will test false
rule.match('test.js.a'); // Will test false
```
You can actually just check if the input is a string.
``` javascript
var rule = new Rule();
rule.addMatchers(Rule.matcher.string);
rule.match('some randome string'); // Will test true
rule.match(''); // Will test true
rule.match(true); // Will test false
rule.match(null); // Will test false
```
## custom matchers
Rule matchers are just functions. So you can pass in your own functions if you want custom behavior. For example, you can create your own custom matcher to check objects properties.
Here is an arbitrary custom matcher that checks if the first letter of the input string is the same as the first letter of one of the matching rules:
``` javascript
function customMatcher(criteria) {
return function(match) {
return criteria[0] === match[0];
};
}
var rule = new Rule();
rule.addMatchers([customMatcher('Standing up'), customMatcher('Dont stand up')]);
rule.match('Some randome string'); // Will test true
rule.match('some randome string'); // Will test false
rule.match('Dance party'); // Will test true
rule.match('dance party'); // Will test false
```
# License
Licensed under MIT