Merge branch 'master' into chore/antlr4ng

alessiostalla · alessiostalla · commit 9ad537228156 · 2024-02-27T14:43:15.000+01:00
# Conflicts:
#	CHANGELOG.md
#	package.json
#	src/interop/starlasu-v2-metamodel.ts
#	tests/interop/workspace-transpilation-trace.test.ts
#	yarn.lock
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -51,10 +51,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [1.5.0] – Not released
 
-## [1.4.7] – Not yet released
+## [1.4.8] – 2024-01-29
+
+### Fixed
+- When importing from Ecore, don't treat origins and destinations as children, as well as everything that's not a Node. 
+
+## [1.4.7] – 2024-01-18
 
 ### Added
 - Traversal functions `walkAncestors` and `findAncestorOfType` from Kolasu
+- Support for Ecore models with Kolasu's `SimpleOrigin` instances
 
 ### Changed
 - Aligned AST Transformers with Kolasu, and solved several issues in the previous implementation
diff --git a/package.json b/package.json
@@ -116,7 +116,7 @@
 	"devDependencies": {
 		"@tsconfig/recommended": "^1.0.3",
 		"@types/chai": "^4.3.11",
-		"@types/ecore": "^0.12.3",
+		"@types/ecore": "^0.12.5",
 		"@types/jest": "^29.5.10",
 		"@types/node": "^18.19.2",
 		"@typescript-eslint/eslint-plugin": "^6.13.2",
@@ -133,7 +133,7 @@
 		"rimraf": "^3.0.0",
 		"ts-jest": "^29.1.1",
 		"ts-node": "^10.9.1",
-		"typedoc": "^0.25.4",
+		"typedoc": "^0.25.7",
 		"typescript": "^5.3.2"
 	}
 }
diff --git a/src/interop/ecore.ts b/src/interop/ecore.ts
@@ -23,7 +23,7 @@ import {
     THE_NODE_ECLASS, THE_NODE_ORIGIN_ECLASS,
     THE_POINT_ECLASS,
     THE_POSITION_ECLASS, THE_REFERENCE_BY_NAME_ECLASS,
-    THE_RESULT_ECLASS, THE_TEXT_FILE_DESTINATION_ECLASS
+    THE_RESULT_ECLASS, THE_SIMPLE_ORIGIN_ECLASS, THE_TEXT_FILE_DESTINATION_ECLASS
 } from "./starlasu-v2-metamodel";
 import {KOLASU_URI_V1} from "./kolasu-v1-metamodel";
 import {EBigDecimal, EBigInteger} from "./ecore-patching";
@@ -303,6 +303,9 @@ export function fromEObject(obj: ECore.EObject | any, parent?: Node): ASTElement
     if(isBuiltInClass(eClass, THE_NODE_ORIGIN_ECLASS)) {
         return fromEObject(obj.get("node")) as Node;
     }
+    if(isBuiltInClass(eClass, THE_SIMPLE_ORIGIN_ECLASS)) {
+        return undefined;
+    }
     if(isBuiltInClass(eClass, THE_TEXT_FILE_DESTINATION_ECLASS)) {
         return fromEObject(obj.get("position")) as Position;
     }
diff --git a/src/interop/starlasu-v2-metamodel.ts b/src/interop/starlasu-v2-metamodel.ts
@@ -67,6 +67,21 @@ THE_ORIGIN_ECLASS.get("eStructuralFeatures").add(ECore.EReference.create({
     eType: THE_POSITION_ECLASS,
     containment: true
 }));
+export const THE_SIMPLE_ORIGIN_ECLASS = Ecore.EClass.create({
+    name: "SimpleOrigin"
+});
+THE_SIMPLE_ORIGIN_ECLASS.get("eSuperTypes").add(THE_ORIGIN_ECLASS);
+THE_SIMPLE_ORIGIN_ECLASS.get("eStructuralFeatures").add(Ecore.EAttribute.create({
+    name: "sourceText",
+    eType: Ecore.EString,
+    lowerBound: 0
+}));
+THE_SIMPLE_ORIGIN_ECLASS.get("eStructuralFeatures").add(Ecore.EReference.create({
+    name: "position",
+    eType: THE_POSITION_ECLASS,
+    lowerBound: 0,
+    containment: true
+}));
 THE_NODE_ECLASS.get("eStructuralFeatures").add(ECore.EReference.create({
     name: "destination",
     eType: THE_DESTINATION_INTERFACE,
@@ -286,6 +301,7 @@ THE_AST_EPACKAGE.get('eClassifiers').add(THE_ORIGIN_ECLASS);
 THE_AST_EPACKAGE.get('eClassifiers').add(THE_DESTINATION_INTERFACE);
 THE_AST_EPACKAGE.get('eClassifiers').add(THE_NODE_ECLASS);
 THE_AST_EPACKAGE.get('eClassifiers').add(THE_NODE_ORIGIN_ECLASS);
+THE_AST_EPACKAGE.get('eClassifiers').add(THE_SIMPLE_ORIGIN_ECLASS);
 THE_AST_EPACKAGE.get('eClassifiers').add(THE_POINT_ECLASS);
 THE_AST_EPACKAGE.get('eClassifiers').add(THE_POSITION_ECLASS);
 THE_AST_EPACKAGE.get('eClassifiers').add(THE_POSSIBLY_NAMED_INTERFACE);
diff --git a/src/interop/strumenta-playground.ts b/src/interop/strumenta-playground.ts
@@ -1,4 +1,4 @@
-import {ParsingResult} from "../parsing/parsing";
+import {ParsingResult} from "../parsing";
 import {EcoreMetamodelSupport, fromEObject, loadEObject, loadEPackages, Result, toEObject} from "./ecore";
 import {Node, NodeDefinition} from "../model/model";
 import ECore from "ecore/dist/ecore";
@@ -7,8 +7,7 @@ import {PARSER_EPACKAGE, PARSER_TRACE_ECLASS} from "./parser-package";
 import {
     THE_AST_EPACKAGE,
     THE_ENTITY_DECLARATION_INTERFACE,
-    THE_EXPRESSION_INTERFACE,
-    THE_NODE_ECLASS as THE_NODE_ECLASS_V2,
+    THE_EXPRESSION_INTERFACE, THE_NODE_ECLASS as THE_NODE_ECLASS_V2,
     THE_NODE_ORIGIN_ECLASS,
     THE_RESULT_ECLASS as THE_RESULT_ECLASS_V2,
     THE_STATEMENT_INTERFACE
@@ -180,6 +179,14 @@ export abstract class TraceNode extends Node {
     isStatement(): boolean {
         return this.eo.isKindOf(THE_STATEMENT_INTERFACE);
     }
+
+    protected getChildrenEObjects(role: string | undefined) {
+        return this.eo.eContents()
+            .filter((c) => c.isKindOf(THE_NODE_ECLASS_V2) || c.isKindOf(THE_NODE_ECLASS_V1))
+            .filter((c) => c.eContainingFeature.get("name") != "origin")
+            .filter((c) => c.eContainingFeature.get("name") != "destination")
+            .filter((c) => role == null || role == c.eContainingFeature.get("name"));
+    }
 }
 
 export class ParserNode extends TraceNode {
@@ -190,10 +197,7 @@ export class ParserNode extends TraceNode {
     }
 
     getChildren(role?: string): ParserNode[] {
-        return this.eo.eContents()
-            .filter((c) => c.eContainingFeature.get("name") != "position")
-            .filter((c) => role == null || role == c.eContainingFeature.get("name"))
-            .map((c) => new ParserNode(c, this, this.trace));
+        return this.getChildrenEObjects(role).map((c) => new ParserNode(c, this, this.trace));
     }
 
     get children(): Node[] {
@@ -418,10 +422,7 @@ export class SourceNode extends TraceNode {
     }
 
     getChildren(role?: string): SourceNode[] {
-        return this.eo.eContents()
-            .filter((c) => c.eContainingFeature.get("name") != "position")
-            .filter((c) => role == null || role == c.eContainingFeature.get("name"))
-            .map((c) => new SourceNode(c, this.trace, this.file));
+        return this.getChildrenEObjects(role).map((c) => new SourceNode(c, this.trace, this.file));
     }
 
     get children(): Node[] {
@@ -491,12 +492,7 @@ export class TargetNode extends TraceNode {
     }
 
     getChildren(role?: string): TargetNode[] {
-        return this.eo.eContents()
-            .filter((c) => c.eContainingFeature.get("name") != "position")
-            .filter((c) => c.eContainingFeature.get("name") != "origin")
-            .filter((c) => c.eContainingFeature.get("name") != "destination")
-            .filter((c) => role == null || role == c.eContainingFeature.get("name"))
-            .map((c) => new TargetNode(c, this.trace, this.file));
+        return this.getChildrenEObjects(role).map((c) => new TargetNode(c, this.trace, this.file));
     }
 
     get children(): Node[] {
diff --git a/src/model/model.ts b/src/model/model.ts
@@ -83,6 +83,20 @@ export abstract class Origin {
 
 }
 
+export class SimpleOrigin extends Origin {
+    constructor(public myPosition?: Position, public mySourceText?: string) {
+        super();
+    }
+
+    get position(): Position | undefined {
+        return this.myPosition
+    }
+
+    get sourceText(): string | undefined {
+        return this.mySourceText
+    }
+}
+
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface Destination {}
 
diff --git a/tests/data/playground/java/trace-with-simple-origins.json b/tests/data/playground/java/trace-with-simple-origins.json
@@ -0,0 +1,43 @@
+{
+  "eClass" : "https://strumenta.com/starlasu/transpilation/v2#//WorkspaceTranspilationTrace",
+  "originalFiles" : [ {
+    "path" : "CUS300.rpgle",
+    "code" : "     F**********************************************************************\n     F*                                                                    *\n     F* PROGRAM ID  : CUS200                                               *\n     F* PROGRAM NAME: SAMPLE PROGRAM                                       *\n     F*                                                                    *\n     F**********************************************************************\n     D DSP             S             50    INZ('CUSTOMER')\n     D TOTAL           S              9P 2 INZ(0)\n     D NUM             S              9P 2 INZ(1)\n     D CNT             S              9P 2 INZ(0)\n     FCUSTOMER  UF   E           K Disk\n     FORDERS    IF   E           K Disk\n     FORDSUM    IF   E           K Disk\n     C     *INZSR        BEGSR\n     C                   EVAL      DSP='CUSTOMER REPORT'\n     C                   DSPLY     DSP\n     C                   ENDSR\n      /free\n            CNT = 0;\n            TOTAL = 0;\n            EXSR $clrsum;\n            DSPLY '------  Forward  ------';\n            Setll *Loval CUSTOMER;\n            Dou NOT %EOF(CUSTOMER);\n                Read CUSTOMER;\n                If NOT %EOF(CUSTOMER);\n                   EXSR $calctotal;\n                   EXSR $DSPCUS;\n                   If TOTAL > 0;\n                       OSCUID = CUID;\n                       TOTAL *=  (TOTAL / CNT +1) * 0.1;\n                       OSTOT = TOTAL;\n                       OSCUNM = CUSTNM;\n                       Write  ORDSUM;\n                    EndIf;\n                EndIf;\n            EndDO;\n            DSPLY '------  Reverse  ------';\n            Setll *Hival ORDSUM;\n            Dou NOT %EOF(ORDSUM);\n                Readp ORDSUM;\n                If NOT %EOF(ORDSUM);\n                    DSPLY 'CUSTOMER: ' + OSCUNM + ' $' + OSTOT;\n\n                EndIf;\n            EndDO;\n\n            Begsr  $calctotal;\n                CNT = 0;\n                TOTAL = 0;\n                Setll *Loval ORDERS;\n                Dou NOT %EOF(ORDERS);\n                    Read ORDERS;\n                    If NOT %EOF(ORDERS);\n                        If CUID = ORCUID;\n                            TOTAL += ORTOT;\n                            CNT += 1;\n                        EndIf;\n                    EndIf;\n                EndDo;\n            EndSr;\n\n            Begsr  $dspcus;\n                If TOTAL > 0;\n                    eval DSP='CUSTOMER: ' + CUSTNM + ' $' + TOTAL;\n                    DSPLY     DSP;\n                EndIf;\n            EndSr;\n\n            Begsr  $clrsum;\n                CNT = 0;\n                DSPLY '------  Delete  ------';\n                Setll *Loval ORDSUM;\n                Dou NOT %EOF(ORDSUM);\n                    Read ORDSUM;\n                    If NOT %EOF(ORDSUM);\n                        delete ORDSUM;\n                        CNT+=1;\n                    EndIf;\n                EndDO;\n                DSPLY 'DELETED: ' + CNT +  ' RECORDS';\n            EndSr;",
+    "result" : {
+      "root" : {
+        "eClass" : "https://strumenta.com/rpg/model#//CompilationUnit",
+        "position" : {
+          "start" : {
+            "line" : 1
+          },
+          "end" : {
+            "line" : 82,
+            "column" : 18
+          }
+        },
+        "comments" : [],
+        "dataDefinitions" : [],
+        "externalDefinitions" : [],
+        "fileDescriptions" : [],
+        "mainStatements" : [],
+        "subroutines" : [],
+        "origin" : {
+          "eClass" : "https://strumenta.com/starlasu/v2#//SimpleOrigin",
+          "sourceText" : "Footext",
+          "position" : {
+            "start" : {
+              "line" : 1,
+              "column" : 20
+            },
+            "end" : {
+              "line" : 1,
+              "column" : 34
+            }
+          }
+        }
+      }
+    }
+  } ],
+  "generatedFiles" : [
+   ]
+}
diff --git a/tests/interop/parser-trace.test.ts b/tests/interop/parser-trace.test.ts
@@ -1,7 +1,7 @@
 import {expect} from "chai";
 import * as fs from "fs";
 import {findByPosition, IssueSeverity, IssueType, Point, pos, Position} from "../../src";
-import {ParserNode, ParserTraceLoader} from "../../src/interop/strumenta-playground";
+import {ParserNode, ParserTraceLoader, TraceNode} from "../../src/interop/strumenta-playground";
 
 describe('Parser traces – Kolasu metamodel V1', function() {
 
@@ -31,6 +31,10 @@ describe('Parser traces – Kolasu metamodel V1', function() {
             expect(trace.issues[0].message).to.eql("Physical line of type FileDescription are currently ignored");
             expect(trace.issues[0].severity).to.eql(IssueSeverity.WARNING);
             expect(trace.issues[0].position).to.eql(new Position(new Point(18, 0), new Point(18, 42)));
+
+            const updateStmt = trace.rootNode.findByPosition(pos(258, 30, 258, 30));
+            expect(updateStmt).not.to.be.undefined;
+            expect((updateStmt as TraceNode).getType()).to.eql("com.strumenta.rpgparser.model.UpdateRecordStatement");
         });
 
     it("Can load reference RPG parser trace: open-weather",
diff --git a/tests/interop/workspace-transpilation-trace.test.ts b/tests/interop/workspace-transpilation-trace.test.ts
@@ -1,10 +1,10 @@
 import {expect} from "chai";
 import * as fs from "fs";
-import {Point, Position} from "../../src";
+import {Point, pos, Position} from "../../src";
 import { loadEObject, loadEPackages } from "../../src/interop/ecore"
-import { TranspilationTraceLoader } from "../../src/interop/strumenta-playground"
+import {TraceNode, TranspilationTraceLoader} from "../../src/interop/strumenta-playground"
 import {THE_AST_EPACKAGE} from "../../src/interop/starlasu-v2-metamodel";
-import ECore from "ecore/dist/ecore";
+import ECore from "ecore";
 import {
         THE_WORKSPACE_TRANSPILATION_TRACE_ECLASS,
         TRANSPILATION_EPACKAGE
@@ -90,8 +90,8 @@ describe('Workspace Transpilation traces', function() {
                     ECore.EPackage.Registry.register(THE_AST_EPACKAGE);
                     ECore.EPackage.Registry.register(TRANSPILATION_EPACKAGE);
                     const loader = new TranspilationTraceLoader({
-                            name: "rpg2py",
-                            uri: "file://tests/data/playground/rpg/rpg2py-metamodels.json",
+                            name: "rpg2java",
+                            uri: "file://tests/data/playground/java/rpg2java-metamodels.json",
                             metamodel: JSON.parse(fs.readFileSync("tests/data/playground/java/rpg2java-metamodels.json").toString())
                     });
                     const example = fs.readFileSync("tests/data/playground/java/trace.json").toString();
@@ -117,4 +117,33 @@ describe('Workspace Transpilation traces', function() {
                     expect(destinationNodes.length).to.equal(1);
                     expect(destinationNodes[0].file?.path).to.equal("Cus300.java");
             });
+    it("Can load workspace transpilation trace produced by Kolasu with SimpleOrigin instances",
+        function () {
+            this.timeout(0);
+            Ecore.EPackage.Registry.register(THE_AST_EPACKAGE);
+            Ecore.EPackage.Registry.register(TRANSPILATION_EPACKAGE);
+            const loader = new TranspilationTraceLoader({
+                name: "rpg2java",
+                uri: "file://tests/data/playground/rpg/rpg2java-metamodels.json",
+                metamodel: JSON.parse(fs.readFileSync("tests/data/playground/java/rpg2java-metamodels.json").toString())
+            });
+            const example = fs.readFileSync("tests/data/playground/java/trace-with-simple-origins.json").toString();
+            const trace = loader.loadWorkspaceTranspilationTrace(example);
+
+            expect(trace.originalFiles.length).to.eql(1);
+            expect(trace.generatedFiles.length).to.eql(0);
+            expect(trace.transpilationIssues.length).to.eql(0);
+
+            const cus300File = trace.originalFiles[0];
+            expect(cus300File.path).to.eql("CUS300.rpgle")
+            expect(cus300File.issues.length).to.eql(0)
+            expect(cus300File.node.getType()).to.eql("com.strumenta.rpgparser.model.CompilationUnit")
+            expect(cus300File.node.getSimpleType()).to.eql("CompilationUnit")
+            // The origin is ignored. The position loaded is the explicit position
+            // The sourceText is not accessible anywhere, as it is irrelevant for the TranspilationTrace
+            expect(cus300File.node.getPosition()).to.eql(new Position(new Point(1, 0), new Point(82, 18)));
+
+            const byPosition = cus300File.node.findByPosition(pos(1, 21, 1, 21)) as TraceNode;
+            expect(byPosition.getType()).not.to.contain("SimpleOrigin");
+        });
 });
diff --git a/tests/processing.test.ts b/tests/processing.test.ts
@@ -13,8 +13,8 @@ const testCase = new Box(
         new Item("6")
     ]);
 
-const rootP = n => n instanceof Box && n.name == "root";
-const item1P = n => n instanceof Item && n.name == "1";
+const rootP = (n: any) => n instanceof Box && n.name == "root";
+const item1P = (n: any) => n instanceof Item && n.name == "1";
 
 describe('Tree processing', function() {
     it("find a node, depth-first",
@@ -36,4 +36,4 @@ describe('Tree processing', function() {
             expect(result).not.to.be.undefined;
             expect(result.name).to.equal("1");
         });
-});
+});
