yini-parser 1.0.0-alpha.1 → 1.0.0-alpha.2

package/dist/tests/integration/2-file-structure-and-error/throw error parsing bad content.test.js

@@ -1,80 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const src_1 = __importDefault(require("../../../src"));
-const system_1 = require("../../../src/utils/system");
-const DIR_OF_FIXTURES = '../../fixtures/valid/single-section-member-w-mixed-casing';
-/**
- * Throw error when parsing bad file/inline content tests.
- */
-describe('Throw error when parsing bad file/inline content tests:', () => {
-    beforeAll(() => { });
-    beforeAll(() => {
-        (0, system_1.debugPrint)('beforeAll');
-        // const isDebug = !!process.env.IS_DEBUG
-        // if (!isDebug) {
-        //     console.log('process.env.IS_DEBUG is false, OK')
-        // } else {
-        //     console.error('process.env.IS_DEBUG is true, FAIL')
-        //     console.error(
-        //         'Detected that IS_DEBUG is true, is should be false when testing',
-        //     )
-        //     console.error('process.env.IS_DEBUG:')
-        //     console.error(process.env.IS_DEBUG)
-        //     throw Error('ERROR: A variable in ENV has wrong state')
-        // }
-    });
-    test('1. Should throw error if parsing some garbage.', () => {
-        // Arrange.
-        const fixture = `someGarbage`;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('2. Should throw error if parsing nothing ("").', () => {
-        // Arrange.
-        const fixture = ''; // (!) Blank!
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('3. Should throw error if parsing only whitespaces.', () => {
-        // Arrange.
-        const fixture = '      \t  \n  '; // (!) Only whitepaces!
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('4. Should throw error if parsing invalid characters (£ÆŁ).', () => {
-        // Arrange.
-        const fixture = `^ sectionTitle
-            key £ÆŁ 321 // Double = is an error!`;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('5. Should throw error if parsing unknown file name.', () => {
-        // Arrange.
-        const fullPath = './gibberish-file-name';
-        // Act & Assert.
-        expect(() => {
-            (0, system_1.debugPrint)('fullPath = ' + fullPath);
-            src_1.default.parseFile(fullPath);
-        }).toThrow();
-    });
-    test('6. Should throw error if parsing blank file name ("").', () => {
-        // Arrange.
-        const fullPath = ''; // (!) Blank!
-        // Act & Assert.
-        expect(() => {
-            (0, system_1.debugPrint)('fullPath = ' + fullPath);
-            src_1.default.parseFile(fullPath);
-        }).toThrow();
-    });
-});

package/dist/tests/smoke/A-general-smoke.test.js

@@ -1,259 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const src_1 = __importDefault(require("../../src"));
-const env_1 = require("../../src/config/env");
-const system_1 = require("../../src/utils/system");
-/**
- * General Smoke Tests.
- */
-describe('General Smoke Tests:', () => {
-    const DIR_OF_FIXTURES = '../fixtures/smoke-fixtures/strings-with-paths';
-    const baseDir = path_1.default.join(__dirname, DIR_OF_FIXTURES);
-    beforeAll(() => { });
-    beforeAll(() => {
-        (0, system_1.debugPrint)('beforeAll');
-        // const isDebug = !!process.env.IS_DEBUG
-        // if (!isDebug) {
-        //     console.log('process.env.IS_DEBUG is false, OK')
-        // } else {
-        //     console.error('process.env.IS_DEBUG is true, FAIL')
-        //     console.error(
-        //         'Detected that IS_DEBUG is true, is should be false when testing',
-        //     )
-        //     console.error('process.env.IS_DEBUG:')
-        //     console.error(process.env.IS_DEBUG)
-        //     throw Error('ERROR: A variable in ENV has wrong state')
-        // }
-    });
-    // Trivial test to see if everything is okey before moving on to "real" tests.
-    test('1. Trivial test case.', () => {
-        // Arrange.
-        const a = 3;
-        const b = 5;
-        // Act.
-        const result = a + b;
-        // Assert.
-        expect(result).toEqual(8);
-    });
-    test('2. Correctly parse a short YINI Example.', () => {
-        // Arrange.
-        const validYini = `^ sectionTitle
-            strVar = "Hello World!"
-            intVar = 98.21`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.sectionTitle.strVar).toEqual('Hello World!');
-        expect(result.sectionTitle.intVar).toEqual(98.21);
-    });
-    test('3. Should throw error if parsing some "garbage".', () => {
-        // Arrange.
-        const fixture = `someGarbage`;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('4. Should throw error if parsing lines of "invalid" content.', () => {
-        // Arrange.
-        const fixture = `
-            古池や蛙飛び込む水の音
-            ふるいけやかわずとびこむみずのおと
-            furu ike ya kawazu tobikomu mizu no oto
-        `;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('5. Should throw error if parsing unknown file name.', () => {
-        // Arrange.
-        const fullPath = 'gibberish-path-and-file-name';
-        // Act & Assert.
-        expect(() => {
-            (0, system_1.debugPrint)('fullPath = ' + fullPath);
-            src_1.default.parseFile(fullPath);
-        }).toThrow();
-    });
-    test('6. Should throw error if parsing "blank" content.', () => {
-        // Arrange.
-        const fixture = ' '; // NOTE: Only a blank space!
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture);
-        }).toThrow();
-    });
-    test('7. Correctly parse paths with forward slash "/".', () => {
-        // Arrange.
-        const fixture = `^ PathsWithSlash
-        path1 = '/'
-        path2 = '/etc'
-        path3 = 'etc/'
-        path4 = 'folder/subfolder'
-        path5 = '/usr/local/bin/'
-        `;
-        // Act.
-        const result = src_1.default.parse(fixture);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.PathsWithSlash.path1).toEqual('/');
-        expect(result.PathsWithSlash.path2).toEqual('/etc');
-        expect(result.PathsWithSlash.path3).toEqual('etc/');
-        expect(result.PathsWithSlash.path4).toEqual('folder/subfolder');
-        expect(result.PathsWithSlash.path5).toEqual('/usr/local/bin/');
-        expect(result.PathsWithSlash.path1).not.toEqual('*');
-    });
-    test('8. Correctly parse paths with backslash "\\".', () => {
-        // Arrange.
-        const fileName = 'PathsWithBackslash.yini';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act.
-        const result = src_1.default.parseFile(fullPath);
-        (0, system_1.debugPrint)('fullPath = ' + fullPath);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.PathsWithBackslash.path1).toEqual('\\');
-        expect(result.PathsWithBackslash.path2).toEqual('\\Temp');
-        expect(result.PathsWithBackslash.path3).toEqual('Temp\\');
-        expect(result.PathsWithBackslash.path4).toEqual('Windows\\System32');
-        expect(result.PathsWithBackslash.path5).toEqual('\\Users\\Public\\Documents\\');
-        expect(result.PathsWithBackslash.path1).not.toEqual('*');
-    });
-    test('9. Correctly parse paths with quotes and forward slash "/".', () => {
-        // Arrange.
-        const fileName = 'paths-w-quotes-and-slash.yini';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act.
-        const result = src_1.default.parseFile(fullPath);
-        (0, system_1.debugPrint)('fullPath = ' + fullPath);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.PathsWithQuotesSlash.path1).toEqual("/'My Folder'/Documents/file.txt");
-        expect(result.PathsWithQuotesSlash.path2).toEqual('/"data"/set.csv');
-        expect(result.PathsWithQuotesSlash.path3).toEqual('/`Projects`/Code/'); // NOTE: Has backticks!
-        expect(result.PathsWithQuotesSlash.path1).not.toEqual('*');
-    });
-    test('10. Correctly parse paths with quotes and backslash "\\".', () => {
-        const DIR_OF_FIXTURES = '../fixtures/smoke-fixtures/strings-with-paths';
-        const baseDir = path_1.default.join(__dirname, DIR_OF_FIXTURES);
-        // Arrange.
-        const fileName = 'paths-w-quotes-and-backslash.yini';
-        const fullPath = path_1.default.join(baseDir, fileName);
-        // Act.
-        const result = src_1.default.parseFile(fullPath);
-        (0, system_1.debugPrint)('fullPath = ' + fullPath);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.PathsWithQuotesBackslash.path1).toEqual("\\'Program Files'\\App\\");
-        expect(result.PathsWithQuotesBackslash.path2).toEqual('\\"user name"\\Desktop\\');
-        expect(result.PathsWithQuotesBackslash.path3).toEqual('\\Projects\\\`2024\`\\"Quarter 2"\\'); // NOTE: Has backticks!
-        expect(result.PathsWithQuotesBackslash.path1).not.toEqual('*');
-    });
-    test('11. Throw error if using section repeating markers higher than supported.', () => {
-        // Arrange.
-        const fixture1 = `^ Section1
-            ^^ Section2
-            ^^^ Section3
-            ^^^^ Section4
-            ^^^^^ Section5
-            ^^^^^^ Section6 // Section 6.
-            strVar = "These section headers are valid!"
-        `;
-        const fixture2 = `^ Section1
-            ^^ Section2
-            ^^^ Section3
-            ^^^^ Section4
-            ^^^^^ Section5
-            ^^^^^^ Section6 // Section 6.
-            ^^^^^^^ Section7 // INVALID HEADER MARKER!
-            strVar = "^^^^^^^ (7) is invalid"
-        `;
-        // Act.
-        const result1 = src_1.default.parse(fixture1);
-        (0, env_1.isDebug)() && (0, system_1.printObject)(result1);
-        // Assert.
-        expect(!!result1).toEqual(true);
-        expect(result1.Section1.Section2.Section3.Section4.Section5.Section6
-            .strVar).toBe('These section headers are valid!');
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(fixture2);
-        }).toThrow();
-    });
-    test('12. Should throw error if parsing an incorrect hash comment.', () => {
-        // Arrange.
-        const invalidYini = `^ App
-            id = 32403  #This hash comment is invalid due to a missing space.
-            title = "My Program"
-        `;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(invalidYini);
-        }).toThrow();
-    });
-    test('13. Correctly parse a YINI with a hash comment.', () => {
-        // Arrange.
-        const validYini = `^ App
-            id = 32403  # The correct app id.
-            title = "My Program"
-        `;
-        // Act.
-        (0, env_1.isDebug)() && (0, system_1.printObject)(validYini);
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.App.id).toEqual(32403);
-        expect(result.App.title).toEqual('My Program');
-    });
-    test('14. Correctly parse a YINI enclosed in comments.', () => {
-        // Arrange.
-        const validYini = `
-// This whole line is a comment.
-            ^SectionName# This part is a comment.
-            // This whole line is a comment.
-        `;
-        // Act.
-        (0, env_1.isDebug)() && (0, system_1.printObject)(validYini);
-        const result = src_1.default.parse(validYini);
-        (0, env_1.isDebug)() && (0, system_1.printObject)(result);
-        // Assert.
-        expect(result).toHaveProperty('SectionName');
-        //@todo Fix issue that the below value will correctly be {} and not undefined
-        //expect(result.SectionName).toEqual({})
-    });
-    test('15. Should throw error due to illegal section name.', () => {
-        // Arrange.
-        const invalidYini = `// Should detect illegal section name 2SubSub1!!
-        ^ App
-            ^^ SubSect
-                ^^^ 2SubSub1 // NOT OK, illegal name!
-                valueSS1 = "Something."
-                valueSS2 = OFF
-        `;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(invalidYini);
-            (0, system_1.debugPrint)(invalidYini);
-        }).toThrow();
-    });
-    test('16. Should throw error due to illegal section name.', () => {
-        // Arrange.
-        const invalidYini = `// Should detect illegal section name 2SubSub1!!
-        ^ App
-            ^^ \` lsdfkj lj\`
-                ^^^ 2SubSub1 // NOT OK, illegal name!
-                valueSS1 = "Something."
-                valueSS2 = OFF
-        `;
-        // Act & Assert.
-        expect(() => {
-            src_1.default.parse(invalidYini);
-            (0, system_1.debugPrint)(invalidYini);
-        }).toThrow();
-    });
-});

package/dist/tests/smoke/B-parse-inline-smoke.test.js

@@ -1,270 +0,0 @@
-"use strict";
-/**
- * Around 10 Parse-Inline (incl. literals) Smoke Tests
- *
- * To "quickly" test the main features and syntax of YINI.
- * @note These samples/fixtures are different than the tests for parseFile(..).
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const src_1 = __importDefault(require("../../src"));
-const system_1 = require("../../src/utils/system");
-const fixture10Yini = `
-^ AppConfig
-name = "YINI Tester"
-version = 1.0
-
-    ^^ Settings
-    enable_feature = true
-    paths = ["/home/user", "/tmp"]
-    options: "opt1", "opt2", "opt3"
-
-        ^^^ Advanced
-        triple = """multi
-        line
-        string"""
-
-        classic = C"Hello\tWorld\n"
-        hyper = H"  foo   
-            bar baz   "
-
-^ Metadata
-author = 'Smoke Test'
-created = null
-/END
-`;
-/**
- * Parse-Inline Smoke Tests.
- */
-describe('Parse-Inline Smoke Tests:', () => {
-    beforeAll(() => { });
-    //@todo Need to fix so a single member is attached or returned with the implicit base object.
-    xtest('1.a. Shortest Valid Code (a single member).', () => {
-        // Arrange.
-        const validYini = 'number=42';
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.number).toEqual(42);
-    });
-    //@todo Fix so this get parse correctly, seems to be issue that {} is being transformed to undefined at some point!
-    xtest('1.b. Shortest Valid Code (a single section title).', () => {
-        // Arrange.
-        const validYini = '^Title';
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.Title).toBeDefined();
-    });
-    test('1.c. Shortest Valid Code (section with a single member).', () => {
-        // Arrange.
-        const validYini = `^title
-another=64`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.title.another).toEqual(64);
-    });
-    test('2. Short Valid Code (tabbed section with a negative number).', () => {
-        // Arrange.
-        const validYini = `
-    \t^ Section
-    \tnumber = -1`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.Section.number).toEqual(-1);
-    });
-    test('3. Minimal Valid Code (section with couple of members).', () => {
-        // Arrange.
-        const validYini = `^ Main
-name = 'YINI Smoke Test'
-version = 3`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.Main.name).toEqual('YINI Smoke Test');
-        expect(result.Main.version).toEqual(3);
-    });
-    //@todo Needs implementing of section with sections for this pass.
-    xtest('4. Nested Sections, Tabbed Nesting, Backticked Names.', () => {
-        // Arrange.
-        const validYini = `@yini
-^ user
-username = "tester"
-\`Is Admin\` = True
-
-    ^^ prefs
-    theme = 'dark'
-    notifications = false
-
-        ^^^ \`Complex Section\`
-        setting = 99`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.user.username).toEqual('tester');
-        expect(result.user.is_admin).toEqual(true);
-        expect(result.user.prefs.theme).toEqual('dark');
-        expect(result.user.prefs.notifications).toEqual(false);
-        expect(result.user.prefs.theme['Complex Section'].setting).toEqual(99);
-    });
-    test('5. All Key/Value (simple) Types.', () => {
-        // Arrange.
-        const validYini = `
-    ^ TypesDemo
-    string1 = "Hello"
-    string2 = 'World'
-    number1 = 123
-    number2 = -5.7    
-    hexval = 0xFFEE
-
-    binval = %10001
-    bool_true = yes
-    \`bool false\` = OFF
-    nullval = null
-    empty_val =          # ← Null (lenient mode)`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.TypesDemo.string1).toEqual('Hello');
-        expect(result.TypesDemo.string2).toEqual('World');
-        expect(result.TypesDemo.number1).toEqual(123);
-        expect(result.TypesDemo.number2).toEqual(-5.7);
-        expect(result.TypesDemo.hexval).toEqual(65518);
-        expect(result.TypesDemo.binval).toEqual(17);
-        expect(result.TypesDemo.bool_true).toEqual(true);
-        expect(result.TypesDemo['bool false']).toEqual(false);
-        expect(result.TypesDemo.nullval).toEqual(null);
-        expect(result.TypesDemo.empty_val).toEqual(null);
-        //@todo Add the rest of the members too
-    });
-    xtest('6. List Types.', () => {
-        // Arrange.
-        const validYini = `
-@YINI
-^ Lists
-simple = [1, 2, 3]
-mixed = ["A", 10, true, null]
-nested = [[1, 2], [3, 4]]
-trailing = [5, 6, 7, ]        // Trailing comma allowed in lenient mode
-
-colonlist:
-  "a",
-  "b",
-  "c",`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        //expect(result.TypesDemo.string2).toEqual('World')
-        //@todo Add the rest of the members too
-    });
-    xtest('7. Object Types.', () => {
-        // Arrange.
-        const validYini = `
-^ Objects
-person = { name = "Alice", age = 30, active = true }
-nested = { inner = { foo = "bar" }, number = 2 }
-empty = { }`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        //expect(result.TypesDemo.string2).toEqual('World')
-        //@todo Add the rest of the members too
-    });
-    test('8. Comments, Block Comments, and Disabled Lines.', () => {
-        // Arrange.
-        const validYini = `
-    @yini    
-    // Top comment
-    ^ CommentsDemo
-    val1 = 123  # Inline comment
-    val2 = 456  // Another comment
-    ; Full-line comment
-
-    /*
-    Block comment
-    over multiple lines
-    */
-
-    --val3 = "This is disabled and ignored"
-    val4 = 'Some text.'
-`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.CommentsDemo.val1).toEqual(123);
-        expect(result.CommentsDemo.val2).toEqual(456);
-        expect(result.CommentsDemo.val3).toEqual(undefined);
-        expect(result.CommentsDemo.val4).toEqual('Some text.');
-    });
-    test('9. Short-Hand and Alternative Section Notations', () => {
-        // Arrange.
-        const validYini = `
-~ user
-username = 'tester two'
-isSysOp = YES
-
-    ~~ prefs
-    theme = "light"
-    notifications = OFF
-
-^1 user2
-^2 prefs
-^3 deepSection
-^4 deeperSection
-key = "Level 4 section"
-^5 yetDeeperSection
-key = "Level 5 section"
-item = 77
-
-~1 user3
-username = 'tester three'
-isSysOp = NO
-
-    ~2 prefs
-    theme = "special-dark"
-    notifications = ON
-
-`;
-        // Act.
-        const result = src_1.default.parse(validYini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(result.user.username).toEqual('tester two');
-        expect(result.user.isSysOp).toEqual(true);
-        expect(result.user.prefs.theme).toEqual('light');
-        expect(result.user.prefs.notifications).toEqual(false);
-        const deeperSection = Object.assign({}, result.user2.prefs.deepSection.deeperSection);
-        expect(deeperSection.key).toEqual('Level 4 section');
-        expect(deeperSection.yetDeeperSection.key).toEqual('Level 5 section');
-        expect(deeperSection.yetDeeperSection.item).toEqual(77);
-        expect(result.user3.username).toEqual('tester three');
-        expect(result.user3.isSysOp).toEqual(false);
-        //@todo (EDIT: This is fixed now??) Fix issue so this missing subsection gets included, not sure yet what exactly causes the issue...
-        expect(result.user3.prefs.theme).toEqual('special-dark');
-        expect(result.user3.prefs.notifications).toEqual(true);
-    });
-    //@todo Enable when can parse lists...
-    xtest('10. Parse inline AppConfig (Mixed).', () => {
-        // Arrange.
-        // Act.
-        const result = src_1.default.parse(fixture10Yini);
-        (0, system_1.debugPrint)(result);
-        // Assert.
-        expect(!!result).toEqual(true);
-        //@todo Add proper tests
-    });
-});