json-logic-js

Build complex rules, serialize them as JSON, and execute them in JavaScript

JSON
jwadhams/json-logic-jsjson-logic-js

README

json-logic-js


This parser accepts JsonLogic rules and executes them in JavaScript.

The JsonLogic format is designed to allow you to share rules (logic) between front-end and back-end code (regardless of language difference), even to store logic along with a record in a database.  JsonLogic is documented extensively at JsonLogic.com, including examples of every supported operation and a place to try out rules in your browser.

The same format can also be executed in PHP by the library json-logic-php

Installation


To parse JsonLogic rules in a JavaScript frontend, install this library is via Bower:

  1. ``` sh
  2. bower install --save json-logic-js
  3. ```

To parse JsonLogic rules in a JavaScript backend (like Node.js), install this library via NPM:

  1. ``` sh
  2. npm install json-logic-js
  3. ```

Note that this project uses a module loader that also makes it suitable for RequireJS projects.

If that doesn't suit you, and you want to manage updates yourself, the entire library is self-contained in logic.js and you can download it straight into your project as you see fit.

  1. ``` sh
  2. curl -O https://raw.githubusercontent.com/jwadhams/json-logic-js/master/logic.js
  3. ```

Examples


Simple

  1. ``` js
  2. jsonLogic.apply( { "==" : [1, 1] } );
  3. // true
  4. ```

This is a simple test, equivalent to 1 == 1.  A few things about the format:

  1. The operator is always in the "key" position. There is only one key per JsonLogic rule.
  1. The values are typically an array.
  1. Each value can be a string, number, boolean, array (non-associative), or null

Compound

Here we're beginning to nest rules.

  1. ``` js
  2. jsonLogic.apply(
  3.   {"and" : [
  4.     { ">" : [3,1] },
  5.     { "<" : [1,3] }
  6.   ] }
  7. );
  8. // true
  9. ```

In an infix language (like JavaScript) this could be written as:

  1. ``` js
  2. ( (3 > 1) && (1 < 3) )
  3. ```

Data-Driven


Obviously these rules aren't very interesting if they can only take static literal data. Typically jsonLogic will be called with a rule object and a data object. You can use the var operator to get attributes of the data object:

  1. ``` js
  2. jsonLogic.apply(
  3.   { "var" : ["a"] }, // Rule
  4.   { a : 1, b : 2 }   // Data
  5. );
  6. // 1
  7. ```

If you like, we support syntactic sugar on unary operators to skip the array around values:

  1. ``` js
  2. jsonLogic.apply(
  3.   { "var" : "a" },
  4.   { a : 1, b : 2 }
  5. );
  6. // 1
  7. ```

You can also use the var operator to access an array by numeric index:

  1. ``` js
  2. jsonLogic.apply(
  3.   {"var" : 1 },
  4.   [ "apple", "banana", "carrot" ]
  5. );
  6. // "banana"
  7. ```

Here's a complex rule that mixes literals and data. The pie isn't ready to eat unless it's cooler than 110 degrees, and filled with apples.

  1. ``` js
  2. var rules = { "and" : [
  3.   {"<" : [ { "var" : "temp" }, 110 ]},
  4.   {"==" : [ { "var" : "pie.filling" }, "apple" ] }
  5. ] };

  7. var data = { "temp" : 100, "pie" : { "filling" : "apple" } };

  9. jsonLogic.apply(rules, data);
  10. // true
  11. ```

Always and Never

Sometimes the rule you want to process is "Always" or "Never."  If the first parameter passed to jsonLogic is a non-object, non-associative-array, it is returned immediately.

  1. ``` js
  2. //Always
  3. jsonLogic.apply(true, data_will_be_ignored);
  4. // true

  6. //Never
  7. jsonLogic.apply(false, i_wasnt_even_supposed_to_be_here);
  8. // false
  9. ```

Compatibility


This library makes use of Array.map and Array.reduce, so it's not exactly Internet Explorer 8 friendly.

If you want to use JsonLogic and support deprecated browsers, you could easily use BabelJS's polyfill or directly incorporate the polyfills documented on MDN for map and reduce.

Customization


It's not possible to include everyone's excellent ideas without the core library bloating, bringing in a ton of outside dependencies, or occasionally causing use case conflicts (some people need to safely execute untrusted rules, some people need to change outside state).

Check out the documentation for adding custom operations and be sure to stop by the Wiki page of custom operations to see if someone has already solved your problem or to share your solution.