(fix) Add language information to metadata

jeromesimeon · jeromesimeon · commit a652a0850b66 · 2018-06-13T15:16:56.000-04:00
Signed-off-by: Jerome Simeon &lt;jeromesimeon@me.com&gt;
diff --git a/packages/cicero-cli/test/data/latedeliveryandpenalty/contract.json b/packages/cicero-cli/test/data/latedeliveryandpenalty/contract.json
@@ -1 +1 @@
-{"$class":"org.accordproject.latedeliveryandpenalty.TemplateModel","clauseId":"abfb8f76-69b5-480e-a530-7f5c87779a8c","forceMajeure":true,"penaltyDuration":{"$class":"org.accordproject.time.Duration","amount":9,"unit":"days"},"penaltyPercentage":7,"capPercentage":2,"termination":{"$class":"org.accordproject.time.Duration","amount":2,"unit":"weeks"},"fractionalPart":"days"}
+{"$class":"org.accordproject.latedeliveryandpenalty.TemplateModel","clauseId":"8084a7b3-28bb-4b69-9f97-f966fd8572d3","forceMajeure":true,"penaltyDuration":{"$class":"org.accordproject.time.Duration","amount":9,"unit":"days"},"penaltyPercentage":7,"capPercentage":2,"termination":{"$class":"org.accordproject.time.Duration","amount":2,"unit":"weeks"},"fractionalPart":"days"}
diff --git a/packages/cicero-cli/test/data/latedeliveryandpenalty/package.json b/packages/cicero-cli/test/data/latedeliveryandpenalty/package.json
@@ -4,6 +4,7 @@
     "description": "Late Delivery and Penalty. In case of delayed delivery except for Force Majeure cases, the Seller shall pay to the Buyer for every 9 DAY of delay penalty amounting to 7% of the total value of the Equipment whose delivery has been delayed. Any fractional part of a DAY is to be considered a full DAY. The total amount of penalty shall not however, exceed 2% of the total value of the Equipment involved in late delivery. If the delay is more than 2 WEEK, the Buyer is entitled to terminate this Contract.",
     "cicero": {
       "template": "clause",
+      "language": "ergo",
       "version": "^0.4.0"
     }
 }
diff --git a/packages/cicero-core/lib/metadata.js b/packages/cicero-core/lib/metadata.js
@@ -77,8 +77,14 @@ class Metadata {
             CLAUSE: 1
         };
 
+        const languageTypes = {
+            ERGO: 0,
+            JAVASCRIPT: 1
+        };
+
         // Set defaults
         this.type = templateTypes.CONTRACT;
+        this.language = languageTypes.ERGO;
         this.targetVersion = ciceroVersion;
 
         if (packageJson.cicero && packageJson.cicero.template) {
@@ -94,6 +100,19 @@ class Metadata {
             logger.warn('No cicero template type specified. Assuming that this is a contract template');
         }
 
+        if (packageJson.cicero && packageJson.cicero.language) {
+            if(packageJson.cicero.language !== 'ergo' &&
+            packageJson.cicero.language !== 'javascript'){
+                throw new Error('A cicero template language must be either "ergo" or "javascript".');
+            }
+
+            if(packageJson.cicero.language === 'javascript'){
+                this.language = templateTypes.JAVASCRIPT;
+            }
+        } else {
+            logger.warn('No cicero template language specified. Assuming that this is an ergo template');
+        }
+
         if (packageJson.cicero && packageJson.cicero.version) {
             if(!semver.valid(semver.coerce(packageJson.cicero.version))){
                 throw new Error('The cicero target version must be a valid semantic version (semver) number.');
@@ -141,6 +160,14 @@ class Metadata {
         return this.type;
     }
 
+    /**
+     * Returns either a 0 (for an ergo template), or 1 (for a javascript template)
+     * @returns {number} the template language
+     */
+    getLanguage(){
+        return this.language;
+    }
+
     /**
      * Returns the target semantic version for this template.
      * i.e. which version of cicero was this template built for?
diff --git a/packages/cicero-core/lib/template.js b/packages/cicero-core/lib/template.js
@@ -67,7 +67,6 @@ class Template {
      * @param {object} samples - the sample text for the template in different locales
      */
     constructor(packageJson, readme, samples) {
-
         this.modelManager = new ModelManager();
         this.scriptManager = new ScriptManager(this.modelManager);
         this.introspector = new Introspector(this.modelManager);
@@ -77,7 +76,6 @@ class Template {
         this.grammar = null;
         this.grammarAst = null;
         this.templatizedGrammar = null;
-        this.logicboth = false;
     }
 
     /**
@@ -901,6 +899,9 @@ class Template {
                     if (filePath.ext.toLowerCase() === '.ergo') {
                         logger.debug(method, 'Compiling Ergo to JavaScript ', path);
                         // re-get the updated modelfiles from the modelmanager (includes external dependencies)
+                        if (template.getMetadata().getLanguage() === 1) {
+                            logger.warn('Template is declared as javascript, but this is an ergo template');
+                        }
                         const newModelFiles = [];
                         for( const mf of template.getModelManager().getModelFiles() ) {
                             newModelFiles.push(mf.getDefinitions());
diff --git a/packages/cicero-core/test/data/bad-copyright-license/package.json b/packages/cicero-core/test/data/bad-copyright-license/package.json
@@ -3,6 +3,7 @@
     "version": "0.0.1",
     "cicero": {
       "template": "contract",
+      "language": "javascript",
       "version": "^0.4.0"
     }
 }
diff --git a/packages/cicero-core/test/data/bad-locale/package.json b/packages/cicero-core/test/data/bad-locale/package.json
@@ -4,6 +4,7 @@
     "description": "\"Dan Selman\" agrees to spend 100.0 conga coins on \"swag\"",
     "cicero": {
       "template": "clause",
+      "language": "javascript",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/bad-logic/package.json b/packages/cicero-core/test/data/bad-logic/package.json
@@ -4,6 +4,7 @@
     "description": "Late Delivery and Penalty. In case of delayed delivery except for Force Majeure cases, the Seller shall pay to the Buyer for every 9 DAY of delay penalty amounting to 7% of the total value of the Equipment whose delivery has been delayed. Any fractional part of a DAY is to be considered a full DAY. The total amount of penalty shall not however, exceed 2% of the total value of the Equipment involved in late delivery. If the delay is more than 2 WEEK, the Buyer is entitled to terminate this Contract.",
     "cicero": {
       "template": "clause",
+      "language": "ergo",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/bad-property/package.json b/packages/cicero-core/test/data/bad-property/package.json
@@ -4,6 +4,7 @@
     "description": "\"Dan Selman\" agrees to spend 100.0 conga coins on \"swag\"",
     "cicero": {
       "template": "clause",
+      "language": "javascript",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/conga/package.json b/packages/cicero-core/test/data/conga/package.json
@@ -4,6 +4,7 @@
     "description": "\"Dan Selman\" agrees to spend 100.0 conga coins on \"swag\"",
     "cicero": {
       "template": "clause",
+      "language": "javascript",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/copyright-license/package.json b/packages/cicero-core/test/data/copyright-license/package.json
@@ -3,6 +3,7 @@
     "version": "0.0.1",
     "cicero": {
       "template": "contract",
+      "language": "javascript",
       "version": "^0.4.0"
     }
 }
diff --git a/packages/cicero-core/test/data/helloemit/package.json b/packages/cicero-core/test/data/helloemit/package.json
@@ -4,6 +4,7 @@
     "description": "This is the Hello World of Accord Protocol Templates with Emit.",
     "cicero": {
       "template": "clause",
+      "language": "ergo",
       "version": "^0.4.0"
     },
     "scripts": {
diff --git a/packages/cicero-core/test/data/latedeliveryandpenalty.zip b/packages/cicero-core/test/data/latedeliveryandpenalty.zip
diff --git a/packages/cicero-core/test/data/latedeliveryandpenalty/package.json b/packages/cicero-core/test/data/latedeliveryandpenalty/package.json
@@ -4,6 +4,7 @@
     "description": "Late Delivery and Penalty. In case of delayed delivery except for Force Majeure cases, the Seller shall pay to the Buyer for every 9 DAY of delay penalty amounting to 7% of the total value of the Equipment whose delivery has been delayed. Any fractional part of a DAY is to be considered a full DAY. The total amount of penalty shall not however, exceed 2% of the total value of the Equipment involved in late delivery. If the delay is more than 2 WEEK, the Buyer is entitled to terminate this Contract.",
     "cicero": {
       "template": "clause",
+      "language": "ergo",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/locales-conga/package.json b/packages/cicero-core/test/data/locales-conga/package.json
@@ -4,6 +4,7 @@
     "description": "\"Dan Selman\" agrees to spend 100.0 conga coins on \"swag\"",
     "cicero": {
       "template": "clause",
+      "language": "javascript",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/mix-logic/package.json b/packages/cicero-core/test/data/mix-logic/package.json
@@ -4,6 +4,7 @@
     "description": "Late Delivery and Penalty. In case of delayed delivery except for Force Majeure cases, the Seller shall pay to the Buyer for every 9 DAY of delay penalty amounting to 7% of the total value of the Equipment whose delivery has been delayed. Any fractional part of a DAY is to be considered a full DAY. The total amount of penalty shall not however, exceed 2% of the total value of the Equipment involved in late delivery. If the delay is more than 2 WEEK, the Buyer is entitled to terminate this Contract.",
     "cicero": {
       "template": "clause",
+      "language": "javascript",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/multiple-concepts/package.json b/packages/cicero-core/test/data/multiple-concepts/package.json
@@ -4,6 +4,7 @@
     "description": "\"Dan Selman\" agrees to spend 100.0 conga coins on \"swag\"",
     "cicero": {
       "template": "clause",
+      "language": "javascript",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/no-concepts/package.json b/packages/cicero-core/test/data/no-concepts/package.json
@@ -4,6 +4,7 @@
     "description": "\"Dan Selman\" agrees to spend 100.0 conga coins on \"swag\"",
     "cicero": {
       "template": "clause",
+      "language": "javascript",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/no-logic/package.json b/packages/cicero-core/test/data/no-logic/package.json
@@ -4,6 +4,7 @@
     "description": "Late Delivery and Penalty. In case of delayed delivery except for Force Majeure cases, the Seller shall pay to the Buyer for every 9 DAY of delay penalty amounting to 7% of the total value of the Equipment whose delivery has been delayed. Any fractional part of a DAY is to be considered a full DAY. The total amount of penalty shall not however, exceed 2% of the total value of the Equipment involved in late delivery. If the delay is more than 2 WEEK, the Buyer is entitled to terminate this Contract.",
     "cicero": {
       "template": "clause",
+      "language": "javascript",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/no-sample/package.json b/packages/cicero-core/test/data/no-sample/package.json
@@ -4,6 +4,7 @@
     "description": "\"Dan Selman\" agrees to spend 100.0 conga coins on \"swag\"",
     "cicero": {
       "template": "clause",
+      "language": "javascript",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-core/test/data/with-node_modules/package.json b/packages/cicero-core/test/data/with-node_modules/package.json
diff --git a/packages/cicero-core/test/metadata.js b/packages/cicero-core/test/metadata.js
@@ -64,26 +64,42 @@ describe('Metadata', () => {
         it('should throw an error if template isn\'t contract or clause', () => {
             return (() => new Metadata({
                 name: 'template',
-                cicero: {template: 'other'},
+                cicero: {template: 'other',language:'ergo'},
             }, null, {})).should.throw('A cicero template must be either a "contract" or a "clause".');
         });
 
+        it('should throw an error if cicero version is missing', () => {
+            return (() => new Metadata({
+                name: 'template',
+                cicero: {template: 'contract',language:'ergo'},
+            }, null, {})).should.throw('package.json is missing the cicero.version property.');
+        });
+
+        it('should throw an error if template language isn\'t ergo or javascript', () => {
+            return (() => new Metadata({
+                name: 'template',
+                cicero: {template: 'clause',language:'BLAH'},
+            }, null, {})).should.throw('A cicero template language must be either "ergo" or "javascript".');
+        });
+
         it('should throw an error if target version is not valid semver ', () => {
             return (() => new Metadata({
                 name: 'template',
                 cicero: {
                     template: 'clause',
-                    version: 'BLAH'
+                    version: 'BLAH',
+                    language: 'ergo'
                 },
             }, null, {})).should.throw('The cicero target version must be a valid semantic version (semver) number.');
         });
 
-        it('should throw a warning if target version is not valid semver for current version of cicero', () => {
+        it('should throw an error if target version is not valid semver for current version of cicero', () => {
             return (() => new Metadata({
                 name: 'template',
                 cicero: {
                     template: 'clause',
-                    version: '0.0.0'
+                    version: '0.0.0',
+                    language: 'ergo'
                 },
             }, null, {})).should.throw('The template targets Cicero (0.0.0) but the Cicero version is ');
         });
@@ -94,7 +110,7 @@ describe('Metadata', () => {
         it('should return requested sample', () => {
             const md = new Metadata({
                 name: 'template',
-                cicero: {template: 'contract',version:'^0.4.0-0'}
+                cicero: {language:'ergo',version:'^0.4.0-0'}
             }, null, {
                 en: 'sample'
             });
@@ -103,7 +119,7 @@ describe('Metadata', () => {
         it('should return null if sample is not in the samples', () => {
             const md = new Metadata({
                 name: 'template',
-                cicero: {template: 'contract',version:'^0.4.0-0'}
+                cicero: {template: 'contract',language:'ergo',version:'^0.4.0-0'}
             }, null, {});
             should.not.exist(md.getSample('en'));
             should.not.exist(md.getSample());
@@ -113,7 +129,7 @@ describe('Metadata', () => {
         it('should return default sample if locale not specified', () => {
             const md = new Metadata({
                 name: 'template',
-                cicero: {template: 'contract',version:'^0.4.0-0'}
+                cicero: {template: 'contract',language:'ergo',version:'^0.4.0-0'}
             }, null, {
                 default: 'sample'
             });
@@ -126,21 +142,21 @@ describe('Metadata', () => {
         it('should return default type', () => {
             const md = new Metadata({
                 name: 'template',
-                cicero: {template: 'contract',version:'^0.4.0-0'}
+                cicero: {template: 'contract',language:'ergo',version:'^0.4.0-0'}
             }, null, {});
             md.getTemplateType().should.be.equal(0);
         });
         it('should return for explicit contract type', () => {
             const md = new Metadata({
                 name: 'template',
-                cicero: {template: 'contract',version:'^0.4.0-0'}
+                cicero: {template: 'contract',language:'ergo',version:'^0.4.0-0'}
             }, null, {});
             md.getTemplateType().should.be.equal(0);
         });
         it('should return default type', () => {
             const md = new Metadata({
                 name: 'template',
-                cicero: {template: 'clause',version:'^0.4.0-0'}
+                cicero: {template: 'clause',language:'ergo',version:'^0.4.0-0'}
             }, null, {});
             md.getTemplateType().should.be.equal(1);
         });
diff --git a/packages/cicero-core/test/template.js b/packages/cicero-core/test/template.js
@@ -181,6 +181,7 @@ describe('Template', () => {
                 'description': '"Dan Selman" agrees to spend 100.0 conga coins on "swag"',
                 'cicero': {
                     'template': 'clause',
+                    'language': 'ergo',
                     'version': '^0.4.0'
                 }
             },
diff --git a/packages/cicero-engine/test/data/helloemit/package.json b/packages/cicero-engine/test/data/helloemit/package.json
@@ -4,6 +4,7 @@
     "description": "This is the Hello World of Accord Protocol Templates with Emit.",
     "cicero": {
       "template": "clause",
+      "language": "ergo",
       "version": "^0.4.0"
     },
     "scripts": {
diff --git a/packages/cicero-engine/test/data/helloworld/package.json b/packages/cicero-engine/test/data/helloworld/package.json
@@ -4,6 +4,7 @@
     "description": "This is the Hello World of Accord Protocol Templates. Executing the clause will simply echo back the text that occurs after the string `Hello` prepended to text that is passed in the request.",
     "cicero": {
       "template": "clause",
+      "language": "ergo",
       "version": "^0.4.0"
     },
     "scripts": {
diff --git a/packages/cicero-engine/test/data/installment-sale-ergo/package.json b/packages/cicero-engine/test/data/installment-sale-ergo/package.json
@@ -6,6 +6,7 @@
     "license": "Apache-2.0",
     "cicero": {
         "template": "contract",
+        "language": "ergo",
         "version": "^0.4.1"
     }
 }
diff --git a/packages/cicero-engine/test/data/installment-sale/package.json b/packages/cicero-engine/test/data/installment-sale/package.json
@@ -6,6 +6,7 @@
     "license": "Apache-2.0",
     "cicero": {
         "template": "contract",
+        "language": "javascript",
         "version": "^0.4.1"
     }
 }
diff --git a/packages/cicero-engine/test/data/latedeliveryandpenalty/package.json b/packages/cicero-engine/test/data/latedeliveryandpenalty/package.json
@@ -4,6 +4,7 @@
     "description": "Late Delivery and Penalty. In case of delayed delivery except for Force Majeure cases, the Seller shall pay to the Buyer for every 9 DAY of delay penalty amounting to 7% of the total value of the Equipment whose delivery has been delayed. Any fractional part of a DAY is to be considered a full DAY. The total amount of penalty shall not however, exceed 2% of the total value of the Equipment involved in late delivery. If the delay is more than 2 WEEK, the Buyer is entitled to terminate this Contract.",
     "cicero": {
       "template": "clause",
+      "language": "ergo",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-engine/test/data/no-logic/package.json b/packages/cicero-engine/test/data/no-logic/package.json
@@ -4,6 +4,7 @@
     "description": "Late Delivery and Penalty. In case of delayed delivery except for Force Majeure cases, the Seller shall pay to the Buyer for every 9 DAY of delay penalty amounting to 7% of the total value of the Equipment whose delivery has been delayed. Any fractional part of a DAY is to be considered a full DAY. The total amount of penalty shall not however, exceed 2% of the total value of the Equipment involved in late delivery. If the delay is more than 2 WEEK, the Buyer is entitled to terminate this Contract.",
     "cicero": {
       "template": "clause",
+      "language": "javascript",
       "version": "^0.4.0"
     }
   }
diff --git a/packages/cicero-engine/test/data/saft/package.json b/packages/cicero-engine/test/data/saft/package.json
@@ -7,6 +7,7 @@
     },
     "cicero": {
       "template": "contract",
+      "language": "ergo",
       "version": "^0.4.0"
     },
     "devDependencies": {
diff --git a/packages/cicero-engine/test/data/volumediscount/package.json b/packages/cicero-engine/test/data/volumediscount/package.json
@@ -4,6 +4,7 @@
     "description": "A sample volume discount clause.",
     "cicero": {
       "template": "clause",
+      "language": "ergo",
       "version": "^0.4.0"
     },
     "scripts": {
diff --git a/packages/cicero-server/test/data/latedeliveryandpenalty-js/package.json b/packages/cicero-server/test/data/latedeliveryandpenalty-js/package.json
diff --git a/packages/cicero-server/test/data/latedeliveryandpenalty/package.json b/packages/cicero-server/test/data/latedeliveryandpenalty/package.json
diff --git a/packages/generator-cicero-template/generators/app/templates/package.json b/packages/generator-cicero-template/generators/app/templates/package.json

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"$class":"org.accordproject.latedeliveryandpenalty.TemplateModel","clauseId":"abfb8f76-69b5-480e-a530-7f5c87779a8c","forceMajeure":true,"penaltyDuration":{"$class":"org.accordproject.time.Duration","amount":9,"unit":"days"},"penaltyPercentage":7,"capPercentage":2,"termination":{"$class":"org.accordproject.time.Duration","amount":2,"unit":"weeks"},"fractionalPart":"days"}`
	`1`	`+{"$class":"org.accordproject.latedeliveryandpenalty.TemplateModel","clauseId":"8084a7b3-28bb-4b69-9f97-f966fd8572d3","forceMajeure":true,"penaltyDuration":{"$class":"org.accordproject.time.Duration","amount":9,"unit":"days"},"penaltyPercentage":7,"capPercentage":2,"termination":{"$class":"org.accordproject.time.Duration","amount":2,"unit":"weeks"},"fractionalPart":"days"}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	"description": "Late Delivery and Penalty. In case of delayed delivery except for Force Majeure cases, the Seller shall pay to the Buyer for every 9 DAY of delay penalty amounting to 7% of the total value of the Equipment whose delivery has been delayed. Any fractional part of a DAY is to be considered a full DAY. The total amount of penalty shall not however, exceed 2% of the total value of the Equipment involved in late delivery. If the delay is more than 2 WEEK, the Buyer is entitled to terminate this Contract.",
`5`	`5`	`"cicero": {`
`6`	`6`	`"template": "clause",`
	`7`	`+ "language": "ergo",`
`7`	`8`	`"version": "^0.4.0"`
`8`	`9`	`}`
`9`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`"version": "0.0.1",`
`4`	`4`	`"cicero": {`
`5`	`5`	`"template": "contract",`
	`6`	`+ "language": "javascript",`
`6`	`7`	`"version": "^0.4.0"`
`7`	`8`	`}`
`8`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`"description": "\"Dan Selman\" agrees to spend 100.0 conga coins on \"swag\"",`
`5`	`5`	`"cicero": {`
`6`	`6`	`"template": "clause",`
	`7`	`+ "language": "javascript",`
`7`	`8`	`"version": "^0.4.0"`
`8`	`9`	`}`
`9`	`10`	`}`