fix(formulas) Create formula names that are valid identifiers

Signed-off-by: Jerome Simeon <[email protected]>

Author: jeromesimeon

packages/markdown-template/index.js

@@ -19,7 +19,8 @@
  * @module markdown-template
  */
 
+module.exports.util = require('./lib/util');
+module.exports.datetimeutil = require('./lib/datetimeutil');
+module.exports.normalizeNLs = require('./lib/normalize').normalizeNLs;
 module.exports.ParserManager = require('./lib/parsermanager');
 module.exports.TemplateMarkTransformer = require('./lib/TemplateMarkTransformer');
-module.exports.normalizeNLs = require('./lib/normalize').normalizeNLs;
-module.exports.datetimeutil = require('./lib/datetimeutil');

packages/markdown-template/lib/TemplateMarkTransformer.js

@@ -246,7 +246,6 @@ class TemplateMarkTransformer {
         input.accept(visitor, parameters);
         const result = Object.assign({}, templateMarkManager.serializer.toJSON(input));
 
-        //console.log('DRAFT ' + JSON.stringify(result));
         return result;
     }
 

packages/markdown-template/lib/ToCiceroMarkVisitor.js

@@ -14,7 +14,7 @@
 
 'use strict';
 
-const flatten = require('./templatemarkutil').flatten;
+const flatten = require('./util').flatten;
 const generateJSON = require('./templatemarkutil').generateJSON;
 const { NS_PREFIX_CommonMarkModel } = require('@accordproject/markdown-common').CommonMarkModel;
 const { NS_PREFIX_CiceroMarkModel } = require('@accordproject/markdown-cicero').CiceroMarkModel;

packages/markdown-template/lib/ToParserVisitor.js

@@ -16,7 +16,7 @@
 
 const P = require('parsimmon');
 
-const flatten = require('./templatemarkutil').flatten;
+const flatten = require('./util').flatten;
 const CommonMarkUtils = require('@accordproject/markdown-common').CommonMarkUtils;
 const FromCommonMarkVisitor = require('@accordproject/markdown-common').FromCommonMarkVisitor;
 const fromcommonmarkrules = require('@accordproject/markdown-common').fromcommonmarkrules;

packages/markdown-template/lib/combinators.js

@@ -17,7 +17,7 @@
 const P = require('parsimmon');
 const uuid = require('uuid');
 
-const flatten = require('./templatemarkutil').flatten;
+const flatten = require('./util').flatten;
 const CommonMarkUtils = require('@accordproject/markdown-common').CommonMarkUtils;
 
 /**

packages/markdown-template/lib/templatemarkutil.js

@@ -29,15 +29,6 @@ const MarkdownItTemplate = require('@accordproject/markdown-it-template');
 const FromMarkdownIt = require('@accordproject/markdown-common').FromMarkdownIt;
 const templaterules = require('./templaterules');
 
-/**
- * Flatten an array of array
- * @param {*[]} arr the input array
- * @return {*[]} the flattened array
- */
-function flatten(arr) {
-    return arr.reduce((acc, val) => acc.concat(val), []);
-}
-
 /**
  * Model manager for TemplateMark
  * @returns {object} model manager and utilities for TemplateMark
@@ -312,7 +303,6 @@ function generateJSON(modelManager,type) {
     }
 }
 
-module.exports.flatten = flatten;
 module.exports.findTemplateModel = findTemplateModel;
 module.exports.templateMarkManager = templateMarkManager;
 

packages/markdown-template/lib/templaterules.js

@@ -14,21 +14,10 @@
 
 'use strict';
 
-const crypto = require('crypto');
+const formulaName = require('./util').formulaName;
 const { getAttr } = require('@accordproject/markdown-common').CommonMarkUtils;
 const NS_PREFIX_TemplateMarkModel = require('./externalModels/TemplateMarkModel').NS_PREFIX_TemplateMarkModel;
 
-/**
- * Returns a unique chosen name for a formula
- * @param {string} code - the formula code
- * @return {string} the unique name
- */
-function formulaName(code) {
-    const hasher = crypto.createHash('sha256');
-    hasher.update(code);
-    return hasher.digest('hex');
-}
-
 // Inline rules
 const variableRule = {
     tag: NS_PREFIX_TemplateMarkModel + 'VariableDefinition',

packages/markdown-template/lib/util.js

@@ -0,0 +1,40 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+const crypto = require('crypto');
+
+/**
+ * Flatten an array of array
+ * @param {*[]} arr the input array
+ * @return {*[]} the flattened array
+ */
+function flatten(arr) {
+    return arr.reduce((acc, val) => acc.concat(val), []);
+}
+
+/**
+ * Returns a unique chosen name for a formula
+ * @param {string} code - the formula code
+ * @return {string} the unique name
+ */
+function formulaName(code) {
+    const hasher = crypto.createHash('sha256');
+    hasher.update(code);
+    return 'formula_' + hasher.digest('hex');
+}
+
+module.exports.flatten = flatten;
+module.exports.formulaName = formulaName;

packages/markdown-template/test/data/testFormula/grammar.json

@@ -1 +1 @@
-{"$class":"org.accordproject.commonmark.Document","xmlns":"http://commonmark.org/xml/1.0","nodes":[{"$class":"org.accordproject.templatemark.ContractDefinition","name":"top","elementType":"org.test.MyContract","nodes":[{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"This is contract text, followed by a clause:"}]},{"$class":"org.accordproject.templatemark.ClauseDefinition","name":"agreement","elementType":"org.test.MyClause","nodes":[{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"This is a contract between "},{"$class":"org.accordproject.templatemark.VariableDefinition","name":"seller","elementType":"String"},{"$class":"org.accordproject.commonmark.Text","text":" and "},{"$class":"org.accordproject.templatemark.VariableDefinition","name":"buyer","elementType":"String"},{"$class":"org.accordproject.commonmark.Text","text":" for the amount of "},{"$class":"org.accordproject.templatemark.VariableDefinition","name":"amount","elementType":"Double"},{"$class":"org.accordproject.commonmark.Text","text":" "},{"$class":"org.accordproject.templatemark.EnumVariableDefinition","enumValues":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"name":"currency","elementType":"org.accordproject.money.CurrencyCode"},{"$class":"org.accordproject.templatemark.ConditionalDefinition","whenTrue":[{"$class":"org.accordproject.commonmark.Text","text":", even in the presence of force majeure"}],"whenFalse":[],"name":"forceMajeure"},{"$class":"org.accordproject.commonmark.Text","text":"."}]}]},{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"There is a penalty of "},{"$class":"org.accordproject.templatemark.VariableDefinition","name":"penalty","elementType":"Double"},{"$class":"org.accordproject.commonmark.Text","text":"% for non compliance."},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.commonmark.Text","text":"And this: "},{"$class":"org.accordproject.templatemark.FormulaDefinition","dependencies":["seller","buyer","amount","currency","penalty"],"code":" 3.14+2.98 ","name":"f2fdbcfc705ed55d07f02e6ca8b5a9dc725eef44c32f77e4ce9307626fe09a63"},{"$class":"org.accordproject.commonmark.Text","text":" is a formula"}]},{"$class":"org.accordproject.commonmark.List","type":"bullet","tight":"true","nodes":[{"$class":"org.accordproject.commonmark.Item","nodes":[{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"And this is another formula in a list "},{"$class":"org.accordproject.templatemark.FormulaDefinition","dependencies":["seller","buyer","amount","currency","penalty"],"code":" firstName ++ \" \" ++ lastName ","name":"2906467fe4dc174f6c4bf9b01ea281014784c2a0581868fd5689675e367c362b"}]}]}]}]}]}
+{"$class":"org.accordproject.commonmark.Document","xmlns":"http://commonmark.org/xml/1.0","nodes":[{"$class":"org.accordproject.templatemark.ContractDefinition","name":"top","elementType":"org.test.MyContract","nodes":[{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"This is contract text, followed by a clause:"}]},{"$class":"org.accordproject.templatemark.ClauseDefinition","name":"agreement","elementType":"org.test.MyClause","nodes":[{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"This is a contract between "},{"$class":"org.accordproject.templatemark.VariableDefinition","name":"seller","elementType":"String"},{"$class":"org.accordproject.commonmark.Text","text":" and "},{"$class":"org.accordproject.templatemark.VariableDefinition","name":"buyer","elementType":"String"},{"$class":"org.accordproject.commonmark.Text","text":" for the amount of "},{"$class":"org.accordproject.templatemark.VariableDefinition","name":"amount","elementType":"Double"},{"$class":"org.accordproject.commonmark.Text","text":" "},{"$class":"org.accordproject.templatemark.EnumVariableDefinition","enumValues":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW","ZWL"],"name":"currency","elementType":"org.accordproject.money.CurrencyCode"},{"$class":"org.accordproject.templatemark.ConditionalDefinition","whenTrue":[{"$class":"org.accordproject.commonmark.Text","text":", even in the presence of force majeure"}],"whenFalse":[],"name":"forceMajeure"},{"$class":"org.accordproject.commonmark.Text","text":"."}]}]},{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"There is a penalty of "},{"$class":"org.accordproject.templatemark.VariableDefinition","name":"penalty","elementType":"Double"},{"$class":"org.accordproject.commonmark.Text","text":"% for non compliance."},{"$class":"org.accordproject.commonmark.Softbreak"},{"$class":"org.accordproject.commonmark.Text","text":"And this: "},{"$class":"org.accordproject.templatemark.FormulaDefinition","dependencies":["seller","buyer","amount","currency","penalty"],"code":" 3.14+2.98 ","name":"formula_f2fdbcfc705ed55d07f02e6ca8b5a9dc725eef44c32f77e4ce9307626fe09a63"},{"$class":"org.accordproject.commonmark.Text","text":" is a formula"}]},{"$class":"org.accordproject.commonmark.List","type":"bullet","tight":"true","nodes":[{"$class":"org.accordproject.commonmark.Item","nodes":[{"$class":"org.accordproject.commonmark.Paragraph","nodes":[{"$class":"org.accordproject.commonmark.Text","text":"And this is another formula in a list "},{"$class":"org.accordproject.templatemark.FormulaDefinition","dependencies":["seller","buyer","amount","currency","penalty"],"code":" firstName ++ \" \" ++ lastName ","name":"formula_2906467fe4dc174f6c4bf9b01ea281014784c2a0581868fd5689675e367c362b"}]}]}]}]}]}

packages/markdown-template/test/parsermanager.js

@@ -65,7 +65,7 @@ and monthly payments of {{% monthlyPaymentFormula(loanAmount,rate,loanDuration)
 `);
         parserManager.buildParser();
         parserManager.getFormulas().should.deep.equal([{
-            name:'d02c8642fa12d6ed08dea71f0af7a77b0c7893804d0b43b537eb18ea6f666463',
+            name:'formula_d02c8642fa12d6ed08dea71f0af7a77b0c7893804d0b43b537eb18ea6f666463',
             code:' monthlyPaymentFormula(loanAmount,rate,loanDuration) as "K0,0.00" ',
         }]);
     });
@@ -86,10 +86,10 @@ And this: {{% 3.14+2.98 %}} is a formula
 - And this is another formula in a list {{% firstName ++ " " ++ lastName %}}`);
         parserManager.buildParser();
         parserManager.getFormulas().should.deep.equal([{
-            name:'f2fdbcfc705ed55d07f02e6ca8b5a9dc725eef44c32f77e4ce9307626fe09a63',
+            name:'formula_f2fdbcfc705ed55d07f02e6ca8b5a9dc725eef44c32f77e4ce9307626fe09a63',
             code:' 3.14+2.98 ',
         },{
-            name:'2906467fe4dc174f6c4bf9b01ea281014784c2a0581868fd5689675e367c362b',
+            name:'formula_2906467fe4dc174f6c4bf9b01ea281014784c2a0581868fd5689675e367c362b',
             code:' firstName ++ " " ++ lastName ',
         }]);
     });