/calc-compiler-js

http://abradley2.github.io/calc-compiler-js/

Primary LanguageJavaScript

THIS IS A WORK IN PROGRESS

JavaScript Calc-Compile

Simple interpreter for turning excel-style field calculation strings into JavaScript functions that can act on data-set collections.

Purpose

The purpose of this is to allow "excel style" table manipulation by users who are comfortable writing spreadsheet function strings. Useful in applications that allow the user to manipulate the data they are seeing (obvious examples: Microsoft Excel and LibreOffice Calc)

A humble example

// Create an instance of the generator
var c = new Jcalc()

var calcString = "=SUM(A, B)"

// Get a JSON-serializable representation of the function stack.
var stack = c.compile( calcString )

// Get a usable function from the stack
var func = c.generate( stack )

// you can now use the function on an object representing a table row
var row = {A: 1, B: 2}

row.C = func(row)

// return {A: 1, B: 2, C: 3}

Adding functions

TODO: finish documentation

Contributing

Open to pulls.

Follow the style guidelines of javascript-standard with these two exceptions

  1. Indentation is 4 spaces, not 2
  2. var declarations seperated by a comma are OK
// totally fine
var one = 1,
    two = 2,
    other = 'a string'