Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linuxbozo/brij-spec
Business Rules in JSON - A DSL for common rule definitions parseable by any rule engine
https://github.com/linuxbozo/brij-spec
Last synced: 2 months ago
JSON representation
Business Rules in JSON - A DSL for common rule definitions parseable by any rule engine
- Host: GitHub
- URL: https://github.com/linuxbozo/brij-spec
- Owner: LinuxBozo
- License: cc0-1.0
- Created: 2014-11-14T00:47:04.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-01T21:15:28.000Z (about 9 years ago)
- Last Synced: 2024-10-13T04:31:02.419Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 32.2 KB
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# brij-spec
[](https://travis-ci.org/LinuxBozo/brij-spec)
[](https://coveralls.io/r/LinuxBozo/brij-spec)
Business Rules in JSON. A standard, specification and schema.
> We are currently in 0.x.x [versioning](#versioning): some core changes are still being pushed out. A version 1.0.0 will be released following best practices when identified as final.
## Specification Basics
A BRIJ compliant file is a JSON document that contains an array that is a list of objects for each of your rule definitions. In the simplest form, a BRIJ compliant document looks like this:
```json
[
{
"rule": {
"condition": "email_address",
"property": "user.email"
}
}
]
```
Each rule object in the array is defined by the following main properties:
- id: *optional*
- description: *optional*
- rule: **required**
- property: **required**
- condition: **required**
- actions: *optional*
Unless custom actions are defined, the engine should simply evaluate the defined rule as boolean true or false.
### Defining a Rule
#### Valid Conditions
##### Custom function call
- call
- function
##### Formatting
- email_address
- zipcode
- yyyy_mm_dd_hh_mm_ss
- yyyy_mm_dd_hh_mm
- yyyy_mm_dd
- mm_dd_yyyy
- yyyy
- hh_mm
- hh_mm_ss
- matches_regex
- value
##### Value Comparison
###### Numeric
- is_integer
- is_float
- equal
- value
- equal_property
- value
- not_equal
- value
- not_equal_property
- value
- greater_than
- value
- greater_than_property
- value
- less_than
- value
- less_than_property
- value
- greater_than_or_equal
- value
- greater_than_or_equal_property
- value
- less_than_or_equal
- value
- less_than_or_equal_property
- value
- between
- start
- end
###### String
- equal
- value
- equal_property
- value
- not_equal
- value
- not_equal_property
- value
- starts_with
- value
- ends_with
- value
- contains
- value
- not_empty
- is_empty
###### Boolean
- is_true
- is_false
###### List
- in
- values
- not_in
- values
- contains
- value
- does_not_contain
- value
- includes_all
- values
- includes_none
- values
#### Combining Conditions
- if
- then
- and
- or
### Defining Actions
- callOnTrue
- args
- callOnFalse
- args
- returnOnTrue
- returnOnFalse
## Examples
- [simple_example.json](../../raw/master/examples/simple_example.json)
- [advanced_example.json](../../raw/master/examples/advanced_example.json)
## Validation
You'll probably want to validate that your rules are written correctly, so that an engine that adheres to the BRIJ specification can accurately parse, and evaluate your rules.
### As a node library
```shell
npm install --save brij-spec
```
To validate your rule
```javascript
var brijSpec = require('brij-spec');
var result = brijSpec.validate([{rule: {condition: "equal", property: "myProp"}}]);
```
More likely though, you'll want to validate a file with your rules defined
```javascript
var fs = require('fs'),
brijSpec = require('brij-spec');
var ruleData = fs.readFileSync('my-rule-file.json', 'utf8').toString();
var result = brijSpec.validate(ruleData);
```
### Command line
There is also a command line client for your convenience.
```shell
npm install -g brij-spec
```
See `brij-validate --help` for usage:
```shell
Options:
--filename, -f JSON rules file to validate
--quiet, -q less output [default: false]
--help, -h, -? this help message
```
## Getting Involved
We encourage anyone who's interested in participating in the formation of this standard to join the [discussions here on GitHub](../../issues). Also feel free to fork this project and submit new ideas to add to the `brij-spec` standard.
## Versioning
`brij-spec` adheres to [Semantic Versioning 2.0.0](SemVer.org). If there is a violation of this scheme, report it as a bug. Specifically, if a patch or minor version is released and breaks backward compatibility, that version should be immediately yanked and/or a new version should be immediately released that restores compatibility. Any change that breaks the public API will only be introduced at a major-version release. As a result of this policy, you can (and should) specify any dependency on `brij-spec` by using the Pessimistic Version Constraint with two digits of precision.