Feature Μerge core setup models (#316)

- Before this change there were 2 different models and parsers for the core and setup. The model was also JSOn structure. 

With this PR there is only one Parser and one model. Also the model is now a composite tree structure and has as value the JSON model.

Author: giorgosnty

.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: CI Workflow
+
+on:
+  pull_request:
+    branches: [feature-merge-core-setup-model]
+    paths:
+      - transpiler/**
+
+jobs:
+  test:
+    name: Build and Test transpiler
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: '☁️ checkout repository'
+        uses: actions/checkout@v2
+
+      - name: '🔧 setup node'
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Install Antlr
+        run: |
+          cd /usr/local/lib 
+          sudo curl -O https://www.antlr.org/download/antlr-4.10.1-complete.jar
+
+      - name: npm install
+        working-directory: ./transpiler
+        run: npm install
+
+      # - name: make antlr jar executable
+      #   run: chmod +x antlr-4.10.1-complete.jar
+
+      - name: 'Produce Antlr files'
+        working-directory: ./transpiler
+        run: npm run ant
+
+      - name: 'Build'
+        working-directory: ./transpiler
+        run: npm run build
+
+      - name: '🔍 run tests'
+        working-directory: ./transpiler
+        run: npm run test-silent

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "eslint.workingDirectories": ["transpiler", "cli"],
+  "cSpell.words": ["Bitloops"],
+  "javascript.preferences.importModuleSpecifierEnding": "js",
+  "typescript.preferences.importModuleSpecifierEnding": "js"
+}

transpiler/__tests__/parser/bitloopsFileToString.feature renamed to cli/__tests__/bitloopsFileToString.feature

@@ -0,0 +1,63 @@
+/**
+ *  Bitloops Language CLI
+ *  Copyright (C) 2022 Bitloops S.A.
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ *  For further information you can contact legal(at)bitloops.com.
+ */
+// import { defineFeature, loadFeature } from 'jest-cucumber';
+// import path from 'path';
+// import {
+//   getBitloopsModulesPreModelData,
+//   TGetUseCasesResponse,
+// } from '../../src/parser/bitloopsFilesToString/index.js';
+
+// const feature = loadFeature('./__tests__/parser/bitloopsFileToString.feature');
+
+// defineFeature(feature, (test) => {
+//   test.skip('Valid filepath produces valid string', ({ given, when, then }) => {
+//     let filePath: string;
+//     let result: {
+//       miscFilesString: string;
+//       useCases: TGetUseCasesResponse;
+//     };
+//     given(/^I am sending path (.*)$/, (modulePath: string) => {
+//       if (modulePath.includes('ABSOLUTE_PATH')) {
+//         filePath = modulePath.replaceAll('ABSOLUTE_PATH', process.cwd());
+//       } else {
+//         filePath = modulePath;
+//       }
+//       filePath = path.normalize(filePath);
+//     });
+
+//     when('I call the function', () => {
+//       result = getBitloopsModulesPreModelData(filePath);
+//     });
+
+//     // TODO add useCases handling
+//     then(/^I should get a string response not null (.*)$/, (response) => {
+//       const { miscFilesString } = result; //{, useCases}
+//       const editedResult = miscFilesString
+//         .replaceAll('`', '')
+//         .replaceAll('${', '{')
+//         .replaceAll('\t', '')
+//         .replaceAll('\n', ' ')
+//         .replaceAll('  ', '')
+//         .replaceAll('  ', '')
+//         .trim();
+//       expect(editedResult).toEqual(response);
+//     });
+//   });
+// });

cli/__tests__/bitloopsFileToString.steps.ts

@@ -0,0 +1,93 @@
+/**
+ *  Bitloops Language CLI
+ *  Copyright (C) 2022 Bitloops S.A.
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ *  For further information you can contact legal(at)bitloops.com.
+ */
+
+// import { defineFeature, loadFeature } from 'jest-cucumber';
+// import {
+//   TBitloopsClassesResult,
+//   getClassesBLStrings,
+// } from '../../src/parser/getClassesBLStrings.js';
+
+// const feature = loadFeature('./__tests__/parser/getClassesBLStrings.feature');
+
+// defineFeature(feature, (test) => {
+//   test('Empty string sent', ({ given, when, then }) => {
+//     let result: TBitloopsClassesResult;
+//     // eslint-disable-next-line @typescript-eslint/no-empty-function
+//     given('I am sending an empty string', () => {});
+
+//     when('I call the function', () => {
+//       result = getClassesBLStrings('');
+//     });
+
+//     then('I should get an empty array "[]"', () => {
+//       expect(result).toEqual([]);
+//     });
+//   });
+
+//   test('No classes found in string', ({ given, when, then }) => {
+//     let result: TBitloopsClassesResult;
+//     let wholeString = '';
+//     given(/^I am sending a string (.*) that doesn't contain any Bitloops classes$/, (string) => {
+//       wholeString = string;
+//     });
+
+//     when('I call the function', () => {
+//       result = getClassesBLStrings(wholeString);
+//     });
+
+//     then('I should get an empty array "[]"', () => {
+//       expect(result).toEqual([]);
+//     });
+//   });
+
+//   test('Class found in string', ({ given, when, then }) => {
+//     let result: TBitloopsClassesResult;
+//     let wholeString: { input: string; output: string };
+//     given(/^I am sending a string that contains one Bitloops class$/, (docString) => {
+//       const docStringArray = JSON.parse(docString);
+//       wholeString = { input: docStringArray[0], output: docStringArray[1] };
+//     });
+
+//     when('I call the function', () => {
+//       result = getClassesBLStrings(wholeString.input);
+//     });
+
+//     then('I should get a populated array with the expected class', () => {
+//       expect(result).toEqual(JSON.parse(wholeString.output));
+//     });
+//   });
+
+//   test('Multiple classes found in string', ({ given, when, then }) => {
+//     let result: TBitloopsClassesResult;
+//     let wholeString: { input: string; output: string };
+//     given(/^I am sending a string that contains multiple Bitloops classes$/, (docString) => {
+//       const docStringArray = JSON.parse(docString);
+//       wholeString = { input: docStringArray[0], output: docStringArray[1] };
+//     });
+
+//     when('I call the function', () => {
+//       result = getClassesBLStrings(wholeString.input);
+//     });
+
+//     then('I should get a populated array with the expected classes', () => {
+//       expect(result).toEqual(JSON.parse(wholeString.output));
+//     });
+//   });
+// });

transpiler/__tests__/parser/getClassesBLStrings.feature renamed to cli/__tests__/getClassesBLStrings.feature

@@ -13,12 +13,7 @@ export default {
   },
   testRegex: '(/__tests__/.*|(\\.|/)(test|spec|steps))\\.(m)?ts$',
   coverageDirectory: 'coverage',
-  collectCoverageFrom: [
-    'src/**/*.ts',
-    'src/**/*.mts',
-    '!src/**/*.d.ts',
-    '!src/**/*.d.mts',
-  ],
+  collectCoverageFrom: ['src/**/*.ts', 'src/**/*.mts', '!src/**/*.d.ts', '!src/**/*.d.mts'],
   setupFilesAfterEnv: ['jest-extended/all'],
   transform: {},
   // "extensionsToTreatAsEsm": [".ts"]

cli/__tests__/getClassesBLStrings.steps.ts

@@ -23,13 +23,7 @@ import ora, { Ora } from 'ora';
 
 import { copyrightSnippet } from './copyright.js';
 import { TBoundedContextName, TModuleName } from '../types.js';
-import {
-  generateBitloopsModel,
-  generateSetupDataModel,
-  generateTargetFiles,
-  getBoundedContextModules,
-} from '../functions/index.js';
-import { SupportedLanguages } from '../helpers/supportedLanguages.js';
+import { getBoundedContextModules } from '../functions/index.js';
 import { clearFolder } from '../helpers/fileOperations.js';
 import { purpleColor, stopSpinner, greenColor, TAB, redColor } from '../utils/oraUtils.js';
 import {
@@ -38,6 +32,8 @@ import {
   printError,
 } from '../utils/inquirer.js';
 import { Question } from 'inquirer';
+import { transpileCode } from '../functions/transpile.js';
+import { writeTranspiledCode } from '../functions/generateTargetFiles.js';
 
 interface ICollection {
   targetLanguage: string;
@@ -111,28 +107,22 @@ const transpile = async (source: ICollection): Promise<void> => {
     clearFolder(targetDirPath);
 
     throbber = ora(purpleColor('🔨 Transpiling... ')).start();
-    const setupData = generateSetupDataModel(sourceDirPath);
 
-    const bitloopsModel = generateBitloopsModel(boundedContextModules, sourceDirPath, setupData);
+    const transpiledCode = transpileCode(boundedContextModules, sourceDirPath);
 
     stopSpinner(throbber, greenColor('Transpiled'), '🔨');
 
     throbber = ora(purpleColor('🕒 Writing system files to disk...')).start();
-    generateTargetFiles({
-      boundedContextModules,
-      sourceDirPath: sourceDirPath,
-      outputDirPath: targetDirPath,
-      bitloopsModel,
-      setupData,
-      targetLanguage: SupportedLanguages.TypeScript,
-    });
+
+    writeTranspiledCode(transpiledCode, targetDirPath);
 
     stopSpinner(throbber, greenColor('System files written'), '⏰');
 
     // console.log(greenColor('Project generated successfully!'));
 
     console.log(greenColor(TAB + '🦎 Project generated successfully!\n'));
   } catch (err) {
+    console.log(err);
     console.error(redColor(TAB + '❌ ' + err));
     throbber.stop();
   }

cli/jest.config.js

@@ -18,35 +18,19 @@
  *  For further information you can contact legal(at)bitloops.com.
  */
 import { readFromFile } from '../helpers/fileOperations.js';
-import { ISetupData } from '../types.js';
-import {
-  BitloopsIntermediateSetupASTParser,
-  BitloopsLanguageSetupAST,
-  BitloopsSetupParser,
-  BitloopsSetupParserError,
-} from '@bitloops/bl-transpiler';
+import { TParserInputData } from '@bitloops/bl-transpiler';
 import path from 'path';
 const SETUP_FILE_NAME = 'setup.bl';
 
-const generateSetupDataModel = (sourceDirPath: string): ISetupData => {
+const readSetupData = (sourceDirPath: string): TParserInputData['setup'] => {
   // TODO handle possibly multiple setup files
   const setupFilePath = path.join(sourceDirPath, SETUP_FILE_NAME);
   const content = readFromFile(setupFilePath);
-  // const setupData = main(content);
-  const parser = new BitloopsSetupParser();
-  const initialModelOutput = parser.parse(content);
-
-  const intermediateParser = new BitloopsIntermediateSetupASTParser();
-  if (!(initialModelOutput instanceof BitloopsSetupParserError)) {
-    const result = intermediateParser.parse(
-      initialModelOutput as unknown as BitloopsLanguageSetupAST,
-    );
-    if (result instanceof BitloopsSetupParserError) {
-      console.log(result);
-      throw new Error('Error parsing setup file');
-    }
-    return result as ISetupData;
-  }
-  throw new Error('Error parsing setup file');
+  return [
+    {
+      fileId: SETUP_FILE_NAME,
+      fileContents: content,
+    },
+  ];
 };
-export { generateSetupDataModel };
+export { readSetupData };