Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Alias Import #20

Merged
merged 10 commits into from
Jul 4, 2024
Merged

feat: Alias Import #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
49158e4
feat: Concept for alias import added
salujajaskeerat May 22, 2024
90c70f2
feat: metamodel.json updated for alias imports
salujajaskeerat May 29, 2024
1f77cd9
fix: concept ImportAliasTypes merged into ImportTypes
salujajaskeerat May 30, 2024
7aba6de
feat(alias): variable renamed and test cases added
salujajaskeerat Jun 27, 2024
240e917
feat(alias import): metamodelutil updated
salujajaskeerat Jul 1, 2024
79390b4
feat(alias import): test cases updated
salujajaskeerat Jul 2, 2024
9a19b1a
feat(alias import): Pr changes
salujajaskeerat Jul 2, 2024
b035bbd
feat(import alias): Code refactored & Test Coverage
salujajaskeerat Jul 4, 2024
fb84212
feat(alias): Test case fixed
salujajaskeerat Jul 4, 2024
1f6bc61
feat(alias):code refactored & comments added
salujajaskeerat Jul 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions lib/metamodel.cto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,10 @@ concept LongDomainValidator {
o Long upper optional
}

concept AliasedType{
o String name
o String aliasedName
}
abstract concept Import {
o String namespace
o String uri optional
Expand All @@ -222,6 +226,7 @@ concept ImportType extends Import {

concept ImportTypes extends Import {
o String[] types
o AliasedType[] aliasedTypes optional
}

concept Model {
Expand Down
30 changes: 30 additions & 0 deletions lib/metamodel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -997,6 +997,25 @@
}
]
},
{
"$class":"[email protected]",
"name":"AliasedType",
"isAbstract":false,
"properties":[
{
"$class": "[email protected]",
"name": "name",
"isArray": false,
"isOptional": false
},
{
"$class": "[email protected]",
"name": "aliasedName",
"isArray": false,
"isOptional": false
}
]
},
{
"$class": "[email protected]",
"name": "Import",
Expand Down Expand Up @@ -1053,13 +1072,24 @@
"name": "types",
"isArray": true,
"isOptional": false
},
{
"$class": "[email protected]",
"name": "aliasedTypes",
"type": {
"$class": "[email protected]",
"name": "AliasedType"
},
"isArray": true,
"isOptional": true
}
],
"superType": {
"$class": "[email protected]",
"name": "Import"
}
},

{
"$class": "[email protected]",
"name": "Model",
Expand Down
15 changes: 12 additions & 3 deletions lib/metamodelutil.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,21 @@ function createNameTable(priorModels, metaModel) {
}
table[imp.name] = namespace;
} else if (imp.$class === `${MetaModelNamespace}.ImportTypes`) {
for (const type of imp.types) {
// Create a map of aliased types if they exist, otherwise initialize an empty map.
const aliasedMap = imp.aliasedTypes
? new Map(imp.aliasedTypes.map(({ name, aliasedName }) => [name, aliasedName]))
: new Map();
imp.types.forEach((type) => {
// 'localName' is the identifier used to refer to the imported type, as it can be aliased..
const localName = aliasedMap.get(type) || type;

// Verify if the type declaration exists in the model file.
// Here, 'type' refers to the actual declaration name within the model file that is being imported.
if (!findDeclaration(modelFile, type)) {
salujajaskeerat marked this conversation as resolved.
Show resolved Hide resolved
throw new Error(`Declaration ${type} in namespace ${namespace} not found`);
}
table[type] = namespace;
}
table[localName] = namespace;
});
} else {
(modelFile.declarations || []).forEach((decl) => {
table[decl.name] = namespace;
Expand Down
104 changes: 104 additions & 0 deletions test/cto/aliasedImport.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
{
"$class": "[email protected]",
"models": [
{
"$class": "[email protected]",
"decorators": [],
"namespace": "org.saluja",
"imports": [],
"declarations": [
{
"$class": "[email protected]",
"name": "doc",
"isAbstract": false,
"properties": [
{
"$class": "[email protected]",
"name": "name",
"isArray": false,
"isOptional": false,
"location": {
"$class": "[email protected]",
"start": {
"offset": 35,
"line": 4,
"column": 2,
"$class": "[email protected]"
},
"end": {
"offset": 49,
"line": 5,
"column": 1,
"$class": "[email protected]"
}
}
}
],
"location": {
"$class": "[email protected]",
"start": {
"offset": 22,
"line": 3,
"column": 1,
"$class": "[email protected]"
},
"end": {
"offset": 50,
"line": 5,
"column": 2,
"$class": "[email protected]"
}
}
}
]
},
{
"$class": "[email protected]",
"decorators": [],
"namespace": "org.test",
"imports": [
{
"$class": "[email protected]",
"namespace": "org.saluja",
"types": [
"doc"
],
"aliasedTypes": [
{
"$class": "[email protected]",
"name": "doc",
"aliasedName": "d"
}
]
}
],
"declarations": [
{
"$class": "[email protected]",
"name": "file",
"isAbstract": false,
"properties": [],
"location": {
"$class": "[email protected]",
"start": {
"offset": 50,
"line": 5,
"column": 1,
"$class": "[email protected]"
},
"end": {
"offset": 75,
"line": 6,
"column": 2,
"$class": "[email protected]"
}
},
"superType": {
"$class": "[email protected]",
"name": "d"
}
}
]
}
]
}
105 changes: 105 additions & 0 deletions test/cto/aliasedImportResolved.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
{
"$class": "[email protected]",
"models": [
{
"$class": "[email protected]",
"decorators": [],
"namespace": "org.saluja",
"imports": [],
"declarations": [
{
"$class": "[email protected]",
"name": "doc",
"isAbstract": false,
"properties": [
{
"$class": "[email protected]",
"name": "name",
"isArray": false,
"isOptional": false,
"location": {
"$class": "[email protected]",
"start": {
"offset": 35,
"line": 4,
"column": 2,
"$class": "[email protected]"
},
"end": {
"offset": 49,
"line": 5,
"column": 1,
"$class": "[email protected]"
}
}
}
],
"location": {
"$class": "[email protected]",
"start": {
"offset": 22,
"line": 3,
"column": 1,
"$class": "[email protected]"
},
"end": {
"offset": 50,
"line": 5,
"column": 2,
"$class": "[email protected]"
}
}
}
]
},
{
"$class": "[email protected]",
"decorators": [],
"namespace": "org.test",
"imports": [
{
"$class": "[email protected]",
"namespace": "org.saluja",
"types": [
"doc"
],
"aliasedTypes": [
{
"$class": "[email protected]",
"name": "doc",
"aliasedName": "d"
}
]
}
],
"declarations": [
{
"$class": "[email protected]",
"name": "file",
"isAbstract": false,
"properties": [],
"location": {
"$class": "[email protected]",
"start": {
"offset": 50,
"line": 5,
"column": 1,
"$class": "[email protected]"
},
"end": {
"offset": 75,
"line": 6,
"column": 2,
"$class": "[email protected]"
}
},
"superType": {
"$class": "[email protected]",
"name": "d",
"namespace": "org.saluja"
}
}
]
}
]
}
78 changes: 78 additions & 0 deletions test/metamodelutil.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,74 @@ describe('MetaModel (Car)', () => {
});
});

describe('MetaModel aliasing', () => {

it('should convert a CTO model to its metamodel with name resolution', async () => {
const ModelPath = path.resolve(__dirname, './cto/aliasedImport.json');
const Model = JSON.parse(fs.readFileSync(ModelPath, 'utf8'));
const MetaModelResolved = JSON.parse(fs.readFileSync(path.resolve(__dirname, './cto/aliasedImportResolved.json'), 'utf8'));

const mm1r = MetaModelUtil.resolveLocalNamesForAll(Model);
mm1r.should.deep.equal(MetaModelResolved);
});

it('Should throw if name not found',async()=>{
salujajaskeerat marked this conversation as resolved.
Show resolved Hide resolved
const model = {
'$class': '[email protected]',
'models': [
{
'$class': '[email protected]',
decorators: [],
namespace: 'org.vehicle',
imports: [],
declarations: []
},
{
'$class': '[email protected]',
decorators: [],
namespace: 'org.test',
imports: [
{
'$class': '[email protected]',
namespace: 'org.vehicle',
types: [
'wheel'
],
aliasedTypes: [
{
'$class': '[email protected]',
name: 'wheel',
aliasedName: 'w'
}
]
}
],
declarations: [
{
'$class': '[email protected]',
name: 'car',
isAbstract: false,
properties: [
{
'$class': '[email protected]',
name: 'wheels',
type: {
'$class': '[email protected]',
name: 'w'
},
isArray: true,
isOptional: false,
}
],
}
]
}
]

};
(()=>MetaModelUtil.resolveLocalNamesForAll(model)).should.throw();
});
});
describe('MetaModel (with Maps & Scalars)', () => {
process.env.ENABLE_MAP_TYPE = 'true'; // TODO Remove on release of MapType
const modelPath = path.resolve(__dirname, './cto/mapsImported.json');
Expand Down Expand Up @@ -186,6 +254,16 @@ describe('importFullyQualifiedNames', () => {
const result = MetaModelUtil.importFullyQualifiedNames(ast);
result.should.deep.equal(['test.Foo', 'test.Bar']);
});
it('should return imports when aliasing', async () => {
const ast = {
$class: '[email protected]',
namespace: 'test',
types: ['Foo', 'Bar'],
aliasedTypes:{'f':'Foo','b':'Bar'}
};
const result = MetaModelUtil.importFullyQualifiedNames(ast);
result.should.deep.equal(['test.Foo', 'test.Bar']);
ekarademir marked this conversation as resolved.
Show resolved Hide resolved
});
});

it('should throw for unrecognized import', async () => {
Expand Down
Loading