@fraczak/k 1.3.4 → 2.0.1

package/INTRO.md

@@ -1,160 +0,0 @@
-# k - the way of building and manipulating JSON-like data
-
-Technically, `k` is a notation for defining __first-order partial functions__.
-
-An example of a _partial function_ is the _projection_, e.g., "`.toto`", 
-which maps an object to its property named `toto`, or it is not defined if 
-the property doesn't exist. E.g.,
-
-    .toto :
-        {"toto": 5, "titi": 10}  --> 5
-        {"titi": 10}             ... undefined // it is not a value!
-
----
-
-## Combining "partial functions"
-
-There are three ways of combining functions:
-
-1. __composition__: `(f1 f2 ...)`, e.g. `(.toto .titi)` extracts
-   nested field.
-
-        (.toto .titi) :
-            {"toto": {"titi": 10}}   --> 10
-            {"toto": 10 }            ... undefined
-            {}                       ... undefined
-
-2. __merge__: `< f1, f2,... >`, e.g., `<.toto, .titi>` extracts field
-   `toto` if present; otherwise extracts `titi`.
-
-        <.toto, .titi> :
-            {"toto": 5, "titi": 10}  --> 5
-            {"titi": 10 }            --> 10
-            {}                       ... undefined
-
-3. __product__: `{ f1 label1, f2 label2, ...}`, e.g., `{.toto TOTO,
-   .titi TITI}` extracts two fields and builds a record out of them.
-
-        {.toto TOTO, .titi TITI} :
-            {"toto": 5, "titi": 10}  --> {"TOTO": 5, "TITI": 10}
-            {"titi": 10 }            ... undefined
-
----
-
-__QUIZ__: What is:
-
- - empty composition: `()` ?
- - empty merge: `<>` ?
- - empty product: `{}` ?
- - `{{{{} s} s} s}` ?
- - `({{{() a} b} c} .c .b .a)` ?
-
----
-
-#### Syntactic sugar: 
-
- - parenthesis can be omitted, except for the empty composition `()`,
- - dot (`.`) in "projection" acts as a separator so the space around it can be omitted.
-
-For example, `[(.toto .titi (.0 .1))]` can be written as `[.toto.titi.0.1]`.
-
-
-## Basic extensions
-
-### Constants, i.e., literals for `strings`, `integers`, `booleans`, and `null`
-
-A constant defines a function which ignores its argument and produces
-the constant value. E.g.:
-
-    {123 int, "kScript" str, true bool, null null} :
-        <any>  --> {"int":123,"str":"kScript","bool":true,"null":null}
-
-### Vector product
-
-Vector product can be used as an abbreviation for product whose field
-names are integers starting from zero. E.g., `{.toto "0", .titi "1",
-123 "2"}` can be written as `[.toto, .titi, 123]`.
-
-    [.toto, .titi, 12] :
-        {"toto": 5, "titi": 10 }  --> [5, 10, 12]  // {"0":5,"1":10,"2":12}
-
-    .1 :
-        ["A","B","C"]  --> "B"
-        ["a"]          ... undefined
----
-
-## Pragmatic extensions, aka "standard library"
-
-- `GT` : -- identity for lists of decreasing elements; undefined otherwise  
-
-        [4,3]     --> [4,3]
-        [3,4]     ... undefined
-        []        --> []
-        [4,3,0]   --> [4,3,0]
-
-- `EQ` : -- identity for lists of equal elements; undefined otherwise
-
-        [4,4]     --> [4,4]
-        [4,5]     ... undefined
-        [4,4,4]   --> [4,4,4]
-        []        --> []
-
-- `{PLUS plus, TIMES times}` : 
-
-        [1,2]     --> {"plus":3,"times":2}
-        [2,2,2]   --> {"plus":6,"times":8}
-        []        --> {"plus":0,"times":1}
-
-- `CONCAT` :
-
-        ["a","bc","d"] --> "abcd"
-
-- `toJSON` :
-
-        {"a": 12} --> "{\"a\":12}"
-
-- `fromJSON` : 
- 
-        "{\"a\":12}" --> {"a":12}
-
-- other predefined parial functions are: `DIV`, `FDIV`, `CONS`, `SNOC`, `toDateMsec`,
-  `toDateStr`, and `_log!`.
-
----
-
-## Recursive definitions
-
-      -- factorial.k
-      dec = [(),-1] PLUS;
-      zero? = [(),0] EQ 0;
-      factorial = <
-        zero? 1, 
-        [dec factorial, ()] TIMES
-      >;
-      { () x, factorial "x!" }
-
-## Codes (_types_)
-
-_Codes_ (prefixed by `$`) can be defined by taged union and product. E.g.:
-
-      $nat = <nat 1, {} 0>;
-      $pair = {nat x, nat y};
-      
-      suc = {$nat 1};
-      add = $pair <{.x.1 x, .y suc y} add, .y>;
-
-### Basic extension codes
-
-Since _basic extension_ introduces integers, booleans, and strings, there are three 
-predefined types: `int`, `bool`, and `string`. A vector product code can also be defined 
-by `[ codeExp ]`.  All members of the vector are the same code. E.g.,
-
-     $intVector = [ int ];
-     $boolVector = [ bool ];
-     $tree = [ tree ];
-
-     emptyList? = $intVector $[ string ]; -- as only an empty vector can be a vector 
-                                          -- of integers and a vector of strings
-
-
-

package/codes.coffee

@@ -1,81 +0,0 @@
-
-are_different = (classes, representatives, name1, name2, codes) ->
-  # console.log {classes, representatives, name1, name2, codes}
-  return false if name1 is name2
-  code1 = codes[name1]
-  code2 = codes[name2]
-  # console.log {name1, code1, name2, code2}
-  return true unless code1.code is code2.code
-  switch code1.code
-    when "union", "product"
-      [fields1,fields2] = [code1, code2]. map (code) ->
-        do (arg = code[code.code]) ->
-          Object.keys(arg).reduce (fields, label) ->
-            fields[label] = representatives[arg[label]] ? arg[label]
-            fields
-          , {}
-      return true unless Object.keys(fields1).length is Object.keys(fields2).length
-      for field,rep of fields1 
-        # console.log {field,rep1:rep,rep2:fields2[field]}
-        return true unless fields2[field] is rep 
-    when "vector"
-      [arg1,arg2] = [code1, code2]. map ({vector}) ->
-        representatives[vector] ? vector
-      return true unless arg1 is arg2
-  false
-
-minimize = (codes) ->
-  names = Object.keys codes
-  classes = {}
-  classes["{}"] = names
-  representatives = names.reduce (representatives, name) ->
-    representatives[name] = "{}"
-    representatives
-  , {}
-  changed = true
-  while changed
-    changed = false
-    for name1, eq_names of classes
-      code = codes[name1]
-      [eq_names, dif_names] = eq_names.reduce ([eq_names, dif_names], name2) ->
-        if are_different(classes, representatives, name1, name2, codes)
-          dif_names.push name2
-        else
-          eq_names.push name2
-        [eq_names,dif_names]
-      , [[],[]]
-      classes[name1] = eq_names
-      do (new_rep = dif_names[0]) ->
-        if new_rep?
-          changed = true
-          classes[new_rep] = dif_names
-          for x in dif_names
-            representatives[x] = new_rep
-  {classes,representatives}
-
-normalize = (label_ref_map, representatives) ->
-  # console.log {label_ref_map, representatives}
-  Object.keys(label_ref_map).reduce (result, label) ->
-    result[label] = do (name = label_ref_map[label]) ->
-      representatives[name] ? name
-    result
-  , {}
-
-normalizeAll = (codes,representatives) ->
-  names = Object.keys codes
-  normalized = names.reduce (normalized, name) ->
-    if name is representatives[name]
-      do (code = codes[name]) ->
-        switch code.code
-          when "union", "product"
-            normalized[name] = { code: code.code } 
-            normalized[name][code.code] = normalize code[code.code], representatives
-          when "vector"
-            normalized[name] = {code:"vector", vector: representatives[code.vector] ? code.vector}
-  
-    normalized    
-  , {}
-
-module.exports = {minimize,normalize,normalizeAll}
-
-

package/codes.js

@@ -1,134 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-(function() {
-  var are_different, minimize, normalize, normalizeAll;
-
-  are_different = function(classes, representatives, name1, name2, codes) {
-    var arg1, arg2, code1, code2, field, fields1, fields2, rep;
-    if (name1 === name2) {
-      // console.log {classes, representatives, name1, name2, codes}
-      return false;
-    }
-    code1 = codes[name1];
-    code2 = codes[name2];
-    if (code1.code !== code2.code) {
-      // console.log {name1, code1, name2, code2}
-      return true;
-    }
-    switch (code1.code) {
-      case "union":
-      case "product":
-        [fields1, fields2] = [code1, code2].map(function(code) {
-          return (function(arg) {
-            return Object.keys(arg).reduce(function(fields, label) {
-              var ref;
-              fields[label] = (ref = representatives[arg[label]]) != null ? ref : arg[label];
-              return fields;
-            }, {});
-          })(code[code.code]);
-        });
-        if (Object.keys(fields1).length !== Object.keys(fields2).length) {
-          return true;
-        }
-        for (field in fields1) {
-          rep = fields1[field];
-          if (fields2[field] !== rep) {
-            
-            // console.log {field,rep1:rep,rep2:fields2[field]}
-            return true;
-          }
-        }
-        break;
-      case "vector":
-        [arg1, arg2] = [code1, code2].map(function({vector}) {
-          var ref;
-          return (ref = representatives[vector]) != null ? ref : vector;
-        });
-        if (arg1 !== arg2) {
-          return true;
-        }
-    }
-    return false;
-  };
-
-  minimize = function(codes) {
-    var changed, classes, code, dif_names, eq_names, name1, names, representatives;
-    names = Object.keys(codes);
-    classes = {};
-    classes["{}"] = names;
-    representatives = names.reduce(function(representatives, name) {
-      representatives[name] = "{}";
-      return representatives;
-    }, {});
-    changed = true;
-    while (changed) {
-      changed = false;
-      for (name1 in classes) {
-        eq_names = classes[name1];
-        code = codes[name1];
-        [eq_names, dif_names] = eq_names.reduce(function([eq_names, dif_names], name2) {
-          if (are_different(classes, representatives, name1, name2, codes)) {
-            dif_names.push(name2);
-          } else {
-            eq_names.push(name2);
-          }
-          return [eq_names, dif_names];
-        }, [[], []]);
-        classes[name1] = eq_names;
-        (function(new_rep) {
-          var i, len, results, x;
-          if (new_rep != null) {
-            changed = true;
-            classes[new_rep] = dif_names;
-            results = [];
-            for (i = 0, len = dif_names.length; i < len; i++) {
-              x = dif_names[i];
-              results.push(representatives[x] = new_rep);
-            }
-            return results;
-          }
-        })(dif_names[0]);
-      }
-    }
-    return {classes, representatives};
-  };
-
-  normalize = function(label_ref_map, representatives) {
-    // console.log {label_ref_map, representatives}
-    return Object.keys(label_ref_map).reduce(function(result, label) {
-      result[label] = (function(name) {
-        var ref;
-        return (ref = representatives[name]) != null ? ref : name;
-      })(label_ref_map[label]);
-      return result;
-    }, {});
-  };
-
-  normalizeAll = function(codes, representatives) {
-    var names, normalized;
-    names = Object.keys(codes);
-    return normalized = names.reduce(function(normalized, name) {
-      if (name === representatives[name]) {
-        (function(code) {
-          var ref;
-          switch (code.code) {
-            case "union":
-            case "product":
-              normalized[name] = {
-                code: code.code
-              };
-              return normalized[name][code.code] = normalize(code[code.code], representatives);
-            case "vector":
-              return normalized[name] = {
-                code: "vector",
-                vector: (ref = representatives[code.vector]) != null ? ref : code.vector
-              };
-          }
-        })(codes[name]);
-      }
-      return normalized;
-    }, {});
-  };
-
-  module.exports = {minimize, normalize, normalizeAll};
-
-}).call(this);

package/index.coffee

@@ -1,28 +0,0 @@
-{parse} = require "./parser.js"
-run = require "./run"
-t = require "./codes"
-
-
-finalize = (codes) ->
-  representatives = t.minimize(codes).representatives
-  codes = t.normalizeAll codes, representatives
-
-  {codes, representatives}
-
-
-compile = (script) ->
-  do ({defs,exp} = parse script) ->
-    # console.log defs
-    {codes, representatives} = finalize defs.codes
-    # console.log {codes, representatives}
-    run.defs = {codes, representatives, rels: defs.rels}
-    
-    (data) -> run exp, data
-    
-compile.doc = "Transforms k-script (string) into a function"
-
-runScriptOnData = (script, data) ->
-  compile(script) data
-runScriptOnData.doc = "Run 'script' (string) on 'data': (script,data) -> data"
-
-module.exports = {compile, run: runScriptOnData, parse}

package/index.js

@@ -1,49 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-(function() {
-  var compile, finalize, parse, run, runScriptOnData, t;
-
-  ({parse} = require("./parser.js"));
-
-  run = require("./run");
-
-  t = require("./codes");
-
-  finalize = function(codes) {
-    var representatives;
-    representatives = t.minimize(codes).representatives;
-    codes = t.normalizeAll(codes, representatives);
-    return {codes, representatives};
-  };
-
-  compile = function(script) {
-    return (function({defs, exp}) {
-      var codes, representatives;
-      // console.log defs
-      ({codes, representatives} = finalize(defs.codes));
-      // console.log {codes, representatives}
-      run.defs = {
-        codes,
-        representatives,
-        rels: defs.rels
-      };
-      return function(data) {
-        return run(exp, data);
-      };
-    })(parse(script));
-  };
-
-  compile.doc = "Transforms k-script (string) into a function";
-
-  runScriptOnData = function(script, data) {
-    return compile(script)(data);
-  };
-
-  runScriptOnData.doc = "Run 'script' (string) on 'data': (script,data) -> data";
-
-  module.exports = {
-    compile,
-    run: runScriptOnData,
-    parse
-  };
-
-}).call(this);

package/k.coffee

@@ -1,59 +0,0 @@
-#!/usr/bin/env coffee
-fs = require "fs"
-k = require "./"
-
-prog = process.argv[1]
-
-{kScript,jsonStream,oneJson} =
-do (oneJson = false, args = process.argv.slice(2)) ->
-  try 
-    kScript = do (arg = args.shift()) ->
-      throw new Error() unless arg?
-      if arg is "-k"
-        fs.readFileSync(args.shift()).toString "utf8"
-      else
-        arg
-
-    kScript = k.compile kScript
-    
-    jsonStream = do (arg = args.shift()) ->
-      if arg is "-1"
-        oneJson = true
-        arg = args.shift()      
-      return process.stdin unless arg?
-      fs.createReadStream arg
-
-    {kScript, jsonStream, oneJson}
-  catch e
-    console.error e
-    console.error "Usage: #{prog} ( k-expr | -k k-file ) [ -1 ] [ json-file ]"
-    console.error "       E.g.,  echo '{\"a\": 12}' | #{prog} '[(),()]'"
-    process.exit -1 
-
-if oneJson
-  do (buffer = []) ->
-    jsonStream.on 'data', (data) ->
-      buffer.push data
-    jsonStream.on 'end', ->
-      try
-        console.log JSON.stringify kScript JSON.parse buffer.join('')
-      catch e
-        console.error e
-else
-  do (buffer = [], line = 0) ->
-    jsonStream.on 'data', (data) ->
-      [first, rest...] = data.toString("utf8").split "\n"
-      buffer.push first
-      if rest.length > 0
-        todo = buffer.join ""
-        [rest..., last] = rest
-        buffer = [last]
-        todo = [todo, rest...]
-        for json in todo
-          if not json.match /^[ \n\t]*(?:#.*)?$/
-            try
-              console.log JSON.stringify kScript JSON.parse json
-            catch e 
-              console.error "Problem [line #{line}]: '#{json}'"
-              console.error e
-          line = line + 1

package/k.js

@@ -1,93 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-(function() {
-  //!/usr/bin/env coffee
-  var fs, jsonStream, k, kScript, oneJson, prog,
-    splice = [].splice;
-
-  fs = require("fs");
-
-  k = require("./");
-
-  prog = process.argv[1];
-
-  ({kScript, jsonStream, oneJson} = (function(oneJson, args) {
-    var e;
-    try {
-      kScript = (function(arg) {
-        if (arg == null) {
-          throw new Error();
-        }
-        if (arg === "-k") {
-          return fs.readFileSync(args.shift()).toString("utf8");
-        } else {
-          return arg;
-        }
-      })(args.shift());
-      kScript = k.compile(kScript);
-      jsonStream = (function(arg) {
-        if (arg === "-1") {
-          oneJson = true;
-          arg = args.shift();
-        }
-        if (arg == null) {
-          return process.stdin;
-        }
-        return fs.createReadStream(arg);
-      })(args.shift());
-      return {kScript, jsonStream, oneJson};
-    } catch (error) {
-      e = error;
-      console.error(e);
-      console.error(`Usage: ${prog} ( k-expr | -k k-file ) [ -1 ] [ json-file ]`);
-      console.error(`       E.g.,  echo '{\"a\": 12}' | ${prog} '[(),()]'`);
-      return process.exit(-1);
-    }
-  })(false, process.argv.slice(2)));
-
-  if (oneJson) {
-    (function(buffer) {
-      jsonStream.on('data', function(data) {
-        return buffer.push(data);
-      });
-      return jsonStream.on('end', function() {
-        var e;
-        try {
-          return console.log(JSON.stringify(kScript(JSON.parse(buffer.join('')))));
-        } catch (error) {
-          e = error;
-          return console.error(e);
-        }
-      });
-    })([]);
-  } else {
-    (function(buffer, line) {
-      return jsonStream.on('data', function(data) {
-        var e, first, i, json, last, len, ref, rest, results, todo;
-        [first, ...rest] = data.toString("utf8").split("\n");
-        buffer.push(first);
-        if (rest.length > 0) {
-          todo = buffer.join("");
-          ref = rest, [...rest] = ref, [last] = splice.call(rest, -1);
-          buffer = [last];
-          todo = [todo, ...rest];
-          results = [];
-          for (i = 0, len = todo.length; i < len; i++) {
-            json = todo[i];
-            if (!json.match(/^[ \n\t]*(?:#.*)?$/)) {
-              try {
-                console.log(JSON.stringify(kScript(JSON.parse(json))));
-              } catch (error) {
-                e = error;
-                console.error(`Problem [line ${line}]: '${json}'`);
-                console.error(e);
-              }
-            }
-            results.push(line = line + 1);
-          }
-          return results;
-        }
-      });
-    })([], 0);
-  }
-
-}).call(this);

package/k.sh

@@ -1,94 +0,0 @@
-#!/usr/bin/env node
-// Generated by CoffeeScript 2.7.0
-(function() {
-  //!/usr/bin/env coffee
-  var fs, jsonStream, k, kScript, oneJson, prog,
-    splice = [].splice;
-
-  fs = require("fs");
-
-  k = require("./");
-
-  prog = process.argv[1];
-
-  ({kScript, jsonStream, oneJson} = (function(oneJson, args) {
-    var e;
-    try {
-      kScript = (function(arg) {
-        if (arg == null) {
-          throw new Error();
-        }
-        if (arg === "-k") {
-          return fs.readFileSync(args.shift()).toString("utf8");
-        } else {
-          return arg;
-        }
-      })(args.shift());
-      kScript = k.compile(kScript);
-      jsonStream = (function(arg) {
-        if (arg === "-1") {
-          oneJson = true;
-          arg = args.shift();
-        }
-        if (arg == null) {
-          return process.stdin;
-        }
-        return fs.createReadStream(arg);
-      })(args.shift());
-      return {kScript, jsonStream, oneJson};
-    } catch (error) {
-      e = error;
-      console.error(e);
-      console.error(`Usage: ${prog} ( k-expr | -k k-file ) [ -1 ] [ json-file ]`);
-      console.error(`       E.g.,  echo '{\"a\": 12}' | ${prog} '[(),()]'`);
-      return process.exit(-1);
-    }
-  })(false, process.argv.slice(2)));
-
-  if (oneJson) {
-    (function(buffer) {
-      jsonStream.on('data', function(data) {
-        return buffer.push(data);
-      });
-      return jsonStream.on('end', function() {
-        var e;
-        try {
-          return console.log(JSON.stringify(kScript(JSON.parse(buffer.join('')))));
-        } catch (error) {
-          e = error;
-          return console.error(e);
-        }
-      });
-    })([]);
-  } else {
-    (function(buffer, line) {
-      return jsonStream.on('data', function(data) {
-        var e, first, i, json, last, len, ref, rest, results, todo;
-        [first, ...rest] = data.toString("utf8").split("\n");
-        buffer.push(first);
-        if (rest.length > 0) {
-          todo = buffer.join("");
-          ref = rest, [...rest] = ref, [last] = splice.call(rest, -1);
-          buffer = [last];
-          todo = [todo, ...rest];
-          results = [];
-          for (i = 0, len = todo.length; i < len; i++) {
-            json = todo[i];
-            if (!json.match(/^[ \n\t]*(?:#.*)?$/)) {
-              try {
-                console.log(JSON.stringify(kScript(JSON.parse(json))));
-              } catch (error) {
-                e = error;
-                console.error(`Problem [line ${line}]: '${json}'`);
-                console.error(e);
-              }
-            }
-            results.push(line = line + 1);
-          }
-          return results;
-        }
-      });
-    })([], 0);
-  }
-
-}).call(this);