@fraczak/k 1.3.2 → 1.3.4

package/INTRO.md

@@ -1,10 +1,10 @@
 # k - the way of building and manipulating JSON-like data
 
-Technically: notation for defining __first-order partial functions__.
+Technically, `k` is a notation for defining __first-order partial functions__.
 
-An example of a _partial function_ is "`.toto`", which maps an object
-to its property named `toto`, or it is not defined if the property
-doesn't exist. E.g.,
+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
@@ -51,6 +51,14 @@ __QUIZ__: What is:
 
 ---
 
+#### 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`
@@ -77,19 +85,25 @@ names are integers starting from zero. E.g., `{.toto "0", .titi "1",
 
 ## Pragmatic extensions, aka "standard library"
 
-- `GT` :
+- `GT` : -- identity for lists of decreasing elements; undefined otherwise  
 
+        [4,3]     --> [4,3]
+        [3,4]     ... undefined
+        []        --> []
         [4,3,0]   --> [4,3,0]
-        [5,8]     -   undefined
 
-- `EQ` :
+- `EQ` : -- identity for lists of equal elements; undefined otherwise
 
+        [4,4]     --> [4,4]
+        [4,5]     ... undefined
         [4,4,4]   --> [4,4,4]
-        [5,8]     -   undefined
+        []        --> []
 
-- `[PLUS, TIMES, MINUS]` :
+- `{PLUS plus, TIMES times}` : 
 
-        [2,2,2] --> [6,8,-2]
+        [1,2]     --> {"plus":3,"times":2}
+        [2,2,2]   --> {"plus":6,"times":8}
+        []        --> {"plus":0,"times":1}
 
 - `CONCAT` :
 
@@ -97,24 +111,25 @@ names are integers starting from zero. E.g., `{.toto "0", .titi "1",
 
 - `toJSON` :
 
-        {a: 12} --> "{\"a\":12}"
+        {"a": 12} --> "{\"a\":12}"
 
 - `fromJSON` : 
  
-        "{\"a\":12}" --> {a: 12}
+        "{\"a\":12}" --> {"a":12}
 
-- `DIV`, `FDIV`, `CONS`, `SNOC`, `_log!`
+- other predefined parial functions are: `DIV`, `FDIV`, `CONS`, `SNOC`, `toDateMsec`,
+  `toDateStr`, and `_log!`.
 
 ---
 
 ## Recursive definitions
 
       -- factorial.k
-      dec = ([(),-1] PLUS);
-      zero? = ([(),0] EQ 0);
+      dec = [(),-1] PLUS;
+      zero? = [(),0] EQ 0;
       factorial = <
-        (zero? 1), 
-        ([(dec factorial), ()] TIMES)
+        zero? 1, 
+        [dec factorial, ()] TIMES
       >;
       { () x, factorial "x!" }
 
@@ -122,10 +137,24 @@ names are integers starting from zero. E.g., `{.toto "0", .titi "1",
 
 _Codes_ (prefixed by `$`) can be defined by taged union and product. E.g.:
 
-      $nat = <nat s, {} z>;     -- e.g., {{{{} z} s} s}
-      $pair = {nat x, nat y};   -- e.g., {{{} z} x, {{{{} z} s} s} y}
+      $nat = <nat 1, {} 0>;
+      $pair = {nat x, nat y};
       
-      s = ($nat {() s} $nat);
-      add = ($pair <{(.x .s) x, (.y s) y} add, .y> $nat);
+      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/README.md

@@ -51,14 +51,14 @@ the field (or a vector with the index).
         false
         null
 
-6. There is a number of built-in functions: `GT`, `EQ`, `PLUS`,
-    `TIMES`, `MINUS`, `DIV`, `CONCAT`, `toJSON`, `fromJSON`, `CONS`,
-    `SNOC`, `_log!`, ... For example:
+6. The other "built-in" functions: `GT`, `EQ`, `PLUS`,
+    `TIMES`, `DIV`, `CONCAT`, `toJSON`, `fromJSON`, `CONS`,
+    `SNOC`, `toDateMsec`, `toDateStr`, and `_log!`. For example:
 
         [1, 2, 3] PLUS       --> integer constant function 6
         [4, 4] TIMES toJSON  --> string constant function "16"
         [3, 2] GT            --> vector constant function [3, 2]
-        [3, 4] GT            --> is not defined!
+        [3, 4] GT            ... is not defined!
 
     A more interesting example could be:
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fraczak/k",
-    "version": "1.3.2",
+    "version": "1.3.4",
     "description": "k-language for JSON-like data transformation",
     "main": "index.js",
     "scripts": {
@@ -21,6 +21,6 @@
     },
     "devDependencies": {
         "coffeescript": "^2.7.0",
-        "jiwson": "^0.0.1"
+        "jiwson": "^0.1.1"
     }
 }

package/parser.jison

@@ -2,6 +2,26 @@
 
 var s = require("./symbol-table");
 
+function fromEscString(escString) {
+  const isSingleQuoted = escString.startsWith("'");
+  let str = escString.substring(1, escString.length - 1);
+  if (isSingleQuoted) {
+    str = str.replace(/\\'/g, "'");
+  } else {
+    str = str.replace(/\\"/g, '"');
+  }
+  str = str.replace(/\\\\/g, '\\');
+  str = str.replace(/\\\//g, '/');
+  str = str.replace(/\\b/g, '\b');
+  str = str.replace(/\\f/g, '\f');
+  str = str.replace(/\\n/g, '\n');
+  str = str.replace(/\\r/g, '\r');
+  str = str.replace(/\\t/g, '\t');
+  str = str.replace(/\\u([\dA-F]{4})/gi, (match, p1) => String.fromCharCode(parseInt(p1, 16)));
+
+  return str;
+}
+
 %}
 
 %lex
@@ -24,7 +44,7 @@ var s = require("./symbol-table");
 ";"                                            return 'SC';
 ":"                                            return 'COL';
 "$"                                            return 'DOLLAR'; 
-\"[^\"\n]*\"|\'[^\'\n]*\'                      return 'STRING'
+\"([^"\\]|\\(.|\n))*\"|\'([^'\\]|\\(.|\n))*\'  return 'STRING';
 [a-zA-Z_][a-zA-Z0-9_?!]*                       return 'NAME';
 0|[-]?[1-9][0-9]*                              return 'INT';
 <<EOF>>                                        return 'EOF';
@@ -40,11 +60,11 @@ var s = require("./symbol-table");
 %%
 
 name: NAME                              { $$ = String(yytext); };
-str: STRING                             { $$ = String(yytext).slice(1,-1); };
+str: STRING                             { $$ = fromEscString(String(yytext)); };
 int: INT                                { $$ = parseInt(String(yytext)); };
 
 input_with_eof: defs comp EOF               {
-    result = {defs: {rels: s.rels, codes: s.codes}, exp: $2};
+    const result = {defs: {rels: s.rels, codes: s.codes}, exp: $2};
     // console.log(JSON.stringify(result, "", 2));
     return result;
 };

package/parser.js

@@ -1,4 +1,4 @@
-/* parser generated by jison 0.0.1 */
+/* parser generated by jison 0.1.1 */
 /*
   Returns a Parser object of the following structure:
 
@@ -76,6 +76,26 @@
 
 var s = require("./symbol-table");
 
+function fromEscString(escString) {
+  const isSingleQuoted = escString.startsWith("'");
+  let str = escString.substring(1, escString.length - 1);
+  if (isSingleQuoted) {
+    str = str.replace(/\\'/g, "'");
+  } else {
+    str = str.replace(/\\"/g, '"');
+  }
+  str = str.replace(/\\\\/g, '\\');
+  str = str.replace(/\\\//g, '/');
+  str = str.replace(/\\b/g, '\b');
+  str = str.replace(/\\f/g, '\f');
+  str = str.replace(/\\n/g, '\n');
+  str = str.replace(/\\r/g, '\r');
+  str = str.replace(/\\t/g, '\t');
+  str = str.replace(/\\u([\dA-F]{4})/gi, (match, p1) => String.fromCharCode(parseInt(p1, 16)));
+
+  return str;
+}
+
 
 
 var parser = (function(){
@@ -94,14 +114,14 @@ case 1:
  this.$ = String(yytext); 
 break;
 case 2:
- this.$ = String(yytext).slice(1,-1); 
+ this.$ = fromEscString(String(yytext)); 
 break;
 case 3:
  this.$ = parseInt(String(yytext)); 
 break;
 case 4:
 
-    result = {defs: {rels: s.rels, codes: s.codes}, exp: $$[$0-1]};
+    const result = {defs: {rels: s.rels, codes: s.codes}, exp: $$[$0-1]};
     // console.log(JSON.stringify(result, "", 2));
     return result;
 
@@ -713,7 +733,7 @@ case 15:return 28;
 break;
 case 16:return 15; 
 break;
-case 17:return 6
+case 17:return 6;
 break;
 case 18:return 4;
 break;
@@ -723,7 +743,7 @@ case 20:return 12;
 break;
 }
 },
-rules: [/^(?:[/][*]([*][^/]|[^*])*[*][/])/,/^(?:(\/\/|#|%|--)[^\n]*)/,/^(?:\s+)/,/^(?:<)/,/^(?:\{)/,/^(?:\[)/,/^(?:\()/,/^(?:>)/,/^(?:\})/,/^(?:\])/,/^(?:\))/,/^(?:=)/,/^(?:\.)/,/^(?:,)/,/^(?:;)/,/^(?::)/,/^(?:\$)/,/^(?:"[^\"\n]*"|'[^\'\n]*')/,/^(?:[a-zA-Z_][a-zA-Z0-9_?!]*)/,/^(?:0|[-]?[1-9][0-9]*)/,/^(?:$)/],
+rules: [/^(?:[/][*]([*][^/]|[^*])*[*][/])/,/^(?:(\/\/|#|%|--)[^\n]*)/,/^(?:\s+)/,/^(?:<)/,/^(?:\{)/,/^(?:\[)/,/^(?:\()/,/^(?:>)/,/^(?:\})/,/^(?:\])/,/^(?:\))/,/^(?:=)/,/^(?:\.)/,/^(?:,)/,/^(?:;)/,/^(?::)/,/^(?:\$)/,/^(?:"([^"\\]|\\(.|\n))*"|'([^'\\]|\\(.|\n))*')/,/^(?:[a-zA-Z_][a-zA-Z0-9_?!]*)/,/^(?:0|[-]?[1-9][0-9]*)/,/^(?:$)/],
 conditions: {"INITIAL":{"rules":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],"inclusive":true}}
 });
 return lexer;

package/run.coffee

@@ -20,11 +20,6 @@ builtin =
     return args if ok
   "PLUS": (args) -> valid args.reduce ((res, x) -> res + x), 0
   "TIMES": (args) -> valid args.reduce ((res, x) -> res * x), 1
-  "MINUS": (args) -> 
-    return valid(- args) if 'number' is typeof args 
-    do ([res,args...] = args) ->
-      return valid (- res) if args.length is 0
-      valid args.reduce ((res, x) -> res - x), res
   "DIV": ([x,y]) -> 
     div = x // y
     rem = x %% y

package/run.js

@@ -49,19 +49,6 @@
         return res * x;
       }), 1));
     },
-    "MINUS": function(args) {
-      if ('number' === typeof args) {
-        return valid(-args);
-      }
-      return (function([res, ...args]) {
-        if (args.length === 0) {
-          return valid(-res);
-        }
-        return valid(args.reduce((function(res, x) {
-          return res - x;
-        }), res));
-      })(args);
-    },
     "DIV": function([x, y]) {
       var div, rem;
       div = Math.floor(x / y);

package/symbol-table.coffee

@@ -7,21 +7,37 @@ identity = op: "identity"
 is_identity_rel = (rel) ->
   rel.op is "identity"
 
+is_constant_rel = (rel) ->
+  switch rel?.op
+    when "int", "str"
+      true
+    when "vector"
+      Object.values(rel[rel.op]).every is_constant_rel
+    when "product"
+      Object.values(rel[rel.op]).every ({exp}) -> 
+        is_constant_rel exp
+    else 
+      false
+
 is_empty_rel = (rel) ->
   rel.op is "union" and rel.union.length is 0
   
 is_full_rel = (rel) ->
+  return true if is_constant_rel rel
   switch rel.op
     when "int", "str", "identity"
       true
     when "comp"
       rel.comp.every is_full_rel
-    when "product", "vector"
+    when "vector"
       Object.values(rel[rel.op]).every is_full_rel
+    when "product"
+      Object.values(rel[rel.op]).every ({exp}) -> 
+        is_full_rel exp
     else  
       false
 
-comp = (e1, e2) ->
+comp_first = (e1, e2) ->
     return e2 if is_identity_rel e1
     return e1 if is_identity_rel e2
     return e1 if is_empty_rel e1
@@ -34,6 +50,16 @@ comp = (e1, e2) ->
       return {op: "comp", comp: [].concat([e1],e2.comp)}
     {op: "comp", comp: [e1,e2]}
 
+comp = (e1, e2) ->
+  result = comp_first e1, e2
+  return result unless result.op is "comp"
+  result.comp = result.comp.reduceRight (c, e) ->
+    if is_constant_rel(c[0]) and is_full_rel e
+      return c
+    return [e, c...]
+  , []
+  result
+
 union = (rels) ->
   list = []
   do ->

package/symbol-table.js

@@ -1,6 +1,6 @@
 // Generated by CoffeeScript 2.7.0
 (function() {
-  var add_code, add_rel, as_ref, codes, comp, identity, is_empty_rel, is_full_rel, is_identity_rel, rels, union;
+  var add_code, add_rel, as_ref, codes, comp, comp_first, identity, is_constant_rel, is_empty_rel, is_full_rel, is_identity_rel, rels, union;
 
   rels = Object.create(null);
 
@@ -19,11 +19,30 @@
     return rel.op === "identity";
   };
 
+  is_constant_rel = function(rel) {
+    switch (rel != null ? rel.op : void 0) {
+      case "int":
+      case "str":
+        return true;
+      case "vector":
+        return Object.values(rel[rel.op]).every(is_constant_rel);
+      case "product":
+        return Object.values(rel[rel.op]).every(function({exp}) {
+          return is_constant_rel(exp);
+        });
+      default:
+        return false;
+    }
+  };
+
   is_empty_rel = function(rel) {
     return rel.op === "union" && rel.union.length === 0;
   };
 
   is_full_rel = function(rel) {
+    if (is_constant_rel(rel)) {
+      return true;
+    }
     switch (rel.op) {
       case "int":
       case "str":
@@ -31,15 +50,18 @@
         return true;
       case "comp":
         return rel.comp.every(is_full_rel);
-      case "product":
       case "vector":
         return Object.values(rel[rel.op]).every(is_full_rel);
+      case "product":
+        return Object.values(rel[rel.op]).every(function({exp}) {
+          return is_full_rel(exp);
+        });
       default:
         return false;
     }
   };
 
-  comp = function(e1, e2) {
+  comp_first = function(e1, e2) {
     if (is_identity_rel(e1)) {
       return e2;
     }
@@ -76,6 +98,21 @@
     };
   };
 
+  comp = function(e1, e2) {
+    var result;
+    result = comp_first(e1, e2);
+    if (result.op !== "comp") {
+      return result;
+    }
+    result.comp = result.comp.reduceRight(function(c, e) {
+      if (is_constant_rel(c[0]) && is_full_rel(e)) {
+        return c;
+      }
+      return [e, ...c];
+    }, []);
+    return result;
+  };
+
   union = function(rels) {
     var list;
     list = [];

package/index.cjs

@@ -1,49 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-(async function() {
-  var compile, finalize, parse, run, runScriptOnData, t;
-
-  ({parse} = await import("./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/symbol-table.cjs

@@ -1,128 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-(function() {
-  var add_code, add_rel, as_ref, codes, comp, identity, is_empty_rel, is_full_rel, is_identity_rel, rels, union;
-
-  rels = Object.create(null);
-
-  codes = Object.create(null);
-
-  codes["{}"] = {
-    code: "product",
-    product: {}
-  };
-
-  identity = {
-    op: "identity"
-  };
-
-  is_identity_rel = function(rel) {
-    return rel.op === "identity";
-  };
-
-  is_empty_rel = function(rel) {
-    return rel.op === "union" && rel.union.length === 0;
-  };
-
-  is_full_rel = function(rel) {
-    switch (rel.op) {
-      case "int":
-      case "str":
-      case "identity":
-        return true;
-      case "comp":
-        return rel.comp.every(is_full_rel);
-      case "product":
-      case "vector":
-        return Object.values(rel[rel.op]).every(is_full_rel);
-      default:
-        return false;
-    }
-  };
-
-  comp = function(e1, e2) {
-    if (is_identity_rel(e1)) {
-      return e2;
-    }
-    if (is_identity_rel(e2)) {
-      return e1;
-    }
-    if (is_empty_rel(e1)) {
-      return e1;
-    }
-    if (is_empty_rel(e2)) {
-      return e2;
-    }
-    if (e1.op === "comp" && e2.op === "comp") {
-      return {
-        op: "comp",
-        comp: [].concat(e1.comp, e2.comp)
-      };
-    }
-    if (e1.op === "comp") {
-      return {
-        op: "comp",
-        comp: [].concat(e1.comp, [e2])
-      };
-    }
-    if (e2.op === "comp") {
-      return {
-        op: "comp",
-        comp: [].concat([e1], e2.comp)
-      };
-    }
-    return {
-      op: "comp",
-      comp: [e1, e2]
-    };
-  };
-
-  union = function(rels) {
-    var list;
-    list = [];
-    (function() {
-      var i, j, len, len1, new_rels, rel;
-      for (i = 0, len = rels.length; i < len; i++) {
-        rel = rels[i];
-        new_rels = rel.op === "union" ? rel.union : [rel];
-        for (j = 0, len1 = new_rels.length; j < len1; j++) {
-          rel = new_rels[j];
-          list.push(rel);
-          if (is_full_rel(rel)) {
-            return;
-          }
-        }
-      }
-    })();
-    if (list.length === 1) {
-      return list[0];
-    }
-    return {
-      op: "union",
-      union: list
-    };
-  };
-
-  as_ref = function(codeExp) {
-    var newName;
-    if (codeExp.code === "ref") {
-      return codeExp.ref;
-    }
-    newName = `:${Object.keys(codes).length}`;
-    codes[newName] = codeExp;
-    return newName;
-  };
-
-  add_rel = function(name, rel) {
-    if (rels[name] == null) {
-      rels[name] = [];
-    }
-    return rels[name].push(rel);
-  };
-
-  add_code = function(name, code) {
-    return codes[name] = code;
-  };
-
-  module.exports = {identity, comp, union, rels, codes, add_rel, add_code, as_ref};
-
-}).call(this);

package/test.cjs

@@ -1,162 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-(function() {
-  var k, k_expression, k_fn;
-
-  k = require("./index.cjs");
-  console.log(k);
-
-  console.log('var k = require("k");');
-
-  console.log("");
-
-  [
-    ["ANYTHING...",
-    '()'],
-    ["ANYTHING...",
-    '{"ala" name, 23 age}'],
-    [
-      {
-        year: 2002,
-        age: 19
-      },
-      '[.year, .age]'
-    ],
-    ["duplicate me",
-    '[(), ()]'],
-    ["nesting",
-    '[[[()]]]'],
-    ["nesting and accessing",
-    '[[()]] {() nested, .0.0 val}'],
-    [
-      {
-        test: "parse integer"
-      },
-      '0000'
-    ],
-    [
-      {
-        x: 3,
-        y: 4
-      },
-      '[.y,.x] PLUS'
-    ]
-  ].map(function([data, script]) {
-    console.log(`k_expression = '${script}';`);
-    console.log(`k.run(k_expression,${JSON.stringify(data)});`);
-    console.log(`// RETURNS: ${JSON.stringify(k.run(script, data))}`);
-    return console.log("");
-  });
-
-  k_expression = '{.name nom, <[.age, 18] GT .0, [.age, 12] GT "ado", "enfant"> age}';
-
-  k_fn = k.compile(k_expression);
-
-  console.log(`var k_fn = k.compile('${k_expression}');`);
-
-  console.log("");
-
-  [
-    {
-      age: 23,
-      name: "Emily"
-    },
-    {
-      age: 16,
-      name: "Katrina"
-    },
-    {
-      age: 2,
-      name: "Mark"
-    }
-  ].map(function(data) {
-    console.log(`k_fn(${JSON.stringify(data)});`);
-    console.log(`// RETURNS: ${JSON.stringify(k_fn(data))}`);
-    return console.log("");
-  });
-
-  k_expression = "$t = < i: int, t: [ t ] > ; <$t, $int>";
-
-  k_fn = k.compile(k_expression);
-
-  console.log(`var k_fn = k.compile('${k_expression}');`);
-
-  console.log("");
-
-  [
-    1,
-    {
-      i: 1
-    },
-    [
-      {
-        i: 2
-      },
-      {
-        i: 3
-      },
-      {
-        t: []
-      }
-    ],
-    {
-      "t": [
-        {
-          "i": 2
-        },
-        {
-          "i": 3
-        },
-        {
-          "t": []
-        }
-      ]
-    }
-  ].map(function(data) {
-    console.log(`k_fn(${JSON.stringify(data)});`);
-    console.log(`// RETURNS: ${JSON.stringify(k_fn(data))}`);
-    return console.log("");
-  });
-
-  k_expression = "$ < < [ int ] ints, [ bool ] bools > list, string None>";
-
-  k_fn = k.compile(k_expression);
-
-  console.log(`var k_fn = k.compile('${k_expression}');`);
-
-  console.log("");
-
-  [
-    {
-      None: "None"
-    },
-    {
-      list: {
-        ints: []
-      }
-    },
-    {
-      list: {
-        ints: [1,
-    2,
-    3]
-      }
-    },
-    {
-      list: {
-        bools: [true,
-    false]
-      }
-    },
-    {
-      list: {
-        bools: [true,
-    0]
-      }
-    }
-  ].map(function(data) {
-    console.log(`k_fn(${JSON.stringify(data)});`);
-    console.log(`// RETURNS: ${JSON.stringify(k_fn(data))}`);
-    return console.log("");
-  });
-
-}).call(this);