brighterscript 1.0.0-alpha.15 → 1.0.0-alpha.18

package/dist/files/BrsFile.spec.js

@@ -2,12 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const chai_1 = require("chai");
 const sinonImport = require("sinon");
-const path = require("path");
 const vscode_languageserver_1 = require("vscode-languageserver");
 const Program_1 = require("../Program");
 const BooleanType_1 = require("../types/BooleanType");
 const DynamicType_1 = require("../types/DynamicType");
-const FunctionType_1 = require("../types/FunctionType");
+const TypedFunctionType_1 = require("../types/TypedFunctionType");
 const IntegerType_1 = require("../types/IntegerType");
 const StringType_1 = require("../types/StringType");
 const BrsFile_1 = require("./BrsFile");
@@ -20,19 +19,24 @@ const PluginInterface_1 = require("../PluginInterface");
 const testHelpers_spec_1 = require("../testHelpers.spec");
 const Parser_1 = require("../parser/Parser");
 const Logger_1 = require("../Logger");
-const VoidType_1 = require("../types/VoidType");
+const Statement_1 = require("../parser/Statement");
+const creators_1 = require("../astUtils/creators");
+const fsExtra = require("fs-extra");
+const ArrayType_1 = require("../types/ArrayType");
 const FloatType_1 = require("../types/FloatType");
 const ObjectType_1 = require("../types/ObjectType");
-const ArrayType_1 = require("../types/ArrayType");
+const VoidType_1 = require("../types/VoidType");
 let sinon = sinonImport.createSandbox();
 describe('BrsFile', () => {
-    let rootDir = (0, util_1.standardizePath) `${process.cwd()}/.tmp/rootDir`;
+    let tempDir = (0, util_1.standardizePath) `${process.cwd()}/.tmp`;
+    let rootDir = (0, util_1.standardizePath) `${tempDir}/rootDir`;
     let program;
     let srcPath = (0, util_1.standardizePath) `${rootDir}/source/main.brs`;
     let destPath = 'source/main.brs';
     let file;
     let testTranspile = (0, testHelpers_spec_1.getTestTranspile)(() => [program, rootDir]);
     beforeEach(() => {
+        fsExtra.emptyDirSync(tempDir);
         program = new Program_1.Program({ rootDir: rootDir, sourceMap: true });
         file = new BrsFile_1.BrsFile(srcPath, destPath, program);
     });
@@ -64,6 +68,14 @@ describe('BrsFile', () => {
         //BrighterScript
         (0, chai_1.expect)(new BrsFile_1.BrsFile(`${rootDir}/source/main.bs`, 'source/main.bs', program).needsTranspiled).to.be.true;
     });
+    it('computes new import statements after clearing parser references', () => {
+        const file = program.setFile('source/main.bs', ``);
+        (0, chai_1.expect)(file.ownScriptImports).to.be.empty;
+        file.parser.ast.statements.push(new Statement_1.ImportStatement((0, creators_1.createToken)(TokenKind_1.TokenKind.Import), (0, creators_1.createToken)(TokenKind_1.TokenKind.StringLiteral, 'pkg:/source/lib.brs')));
+        (0, chai_1.expect)(file.ownScriptImports).to.be.empty;
+        file.parser.invalidateReferences();
+        (0, chai_1.expect)(file.ownScriptImports.map(x => x.text)).to.eql(['pkg:/source/lib.brs']);
+    });
     it('allows adding diagnostics', () => {
         const expected = [{
                 message: 'message',
@@ -1373,7 +1385,7 @@ describe('BrsFile', () => {
                 end sub
             `);
             (0, testHelpers_spec_1.expectSymbolTableEquals)(file.parser.references.functionExpressions[0].symbolTable, [
-                ['sayHi', new FunctionType_1.FunctionType(new VoidType_1.VoidType(), true), util_1.default.createRange(2, 20, 2, 25)]
+                ['sayHi', new TypedFunctionType_1.TypedFunctionType(new VoidType_1.VoidType(), true), util_1.default.createRange(2, 20, 2, 25)]
             ]);
             (0, testHelpers_spec_1.expectSymbolTableEquals)(file.parser.references.functionExpressions[1].symbolTable, [
                 ['age', new IntegerType_1.IntegerType(), util_1.default.createRange(3, 24, 3, 27)]
@@ -1735,6 +1747,106 @@ describe('BrsFile', () => {
         //this test will throw an exception if something went wrong
     });
     describe('transpile', () => {
+        it('transpiles if statement keywords as provided', () => {
+            const code = `
+                If True Then
+                    Print True
+                Else If True Then
+                    print True
+                Else If False Then
+                    Print False
+                Else
+                    Print False
+                End If
+            `;
+            testTranspile(code);
+            testTranspile(code.toLowerCase());
+            testTranspile(code.toUpperCase());
+        });
+        it('does not transpile `then` tokens', () => {
+            const code = `
+                if true
+                    print true
+                else if true
+                    print false
+                end if
+            `;
+            testTranspile(code);
+        });
+        it('honors spacing between multi-word tokens', () => {
+            testTranspile(`
+                if true
+                    print true
+                elseif true
+                    print false
+                endif
+            `);
+        });
+        it('handles when only some of the statements have `then`', () => {
+            testTranspile(`
+                if true
+                else if true then
+                else if true
+                else if true then
+                    if true then
+                        return true
+                    end if
+                end if
+            `);
+        });
+        it('retains casing of parameter types', () => {
+            function test(type) {
+                testTranspile(`
+                    sub one(a as ${type}, b as ${type.toUpperCase()}, c as ${type.toLowerCase()})
+                    end sub
+                `);
+            }
+            test('Boolean');
+            test('Double');
+            test('Dynamic');
+            test('Float');
+            test('Integer');
+            test('LongInteger');
+            test('Object');
+            test('String');
+        });
+        it('retains casing of return types', () => {
+            function test(type) {
+                testTranspile(`
+                    sub one() as ${type}
+                    end sub
+
+                    sub two() as ${type.toLowerCase()}
+                    end sub
+
+                    sub three() as ${type.toUpperCase()}
+                    end sub
+                `);
+            }
+            test('Boolean');
+            test('Double');
+            test('Dynamic');
+            test('Float');
+            test('Integer');
+            test('LongInteger');
+            test('Object');
+            test('String');
+            test('Void');
+        });
+        it('retains casing of literal types', () => {
+            function test(type) {
+                testTranspile(`
+                    sub main()
+                        thing = ${type}
+                        thing = ${type.toLowerCase()}
+                        thing = ${type.toUpperCase()}
+                    end sub
+                `);
+            }
+            test('Invalid');
+            test('True');
+            test('False');
+        });
         describe('throwStatement', () => {
             it('transpiles properly', () => {
                 testTranspile(`
@@ -1983,29 +2095,6 @@ describe('BrsFile', () => {
                 end sub
         `, null, 'trim');
         });
-        it('adds `then` when missing', () => {
-            testTranspile(`
-                sub a()
-                    if true
-                        print "true"
-                    else if true
-                        print "true"
-                    else
-                        print "true"
-                    end if
-                end sub
-            `, `
-                sub a()
-                    if true then
-                        print "true"
-                    else if true then
-                        print "true"
-                    else
-                        print "true"
-                    end if
-                end sub
-            `, 'trim');
-        });
         it('does not add leading or trailing newlines', () => {
             testTranspile(`function abc()\nend function`, undefined, 'none');
         });
@@ -2455,11 +2544,16 @@ describe('BrsFile', () => {
                     end class
                     class Duck extends Bird
                     end class
-                end namespace`, (0, testHelpers_spec_1.trim) `
+                end namespace
+            `, (0, testHelpers_spec_1.trim) `
                 namespace AnimalKingdom
                     class Bird
+                        sub new()
+                        end sub
                     end class
                     class Duck extends AnimalKingdom.Bird
+                        sub new()
+                        end sub
                     end class
                 end namespace
             `);
@@ -2499,6 +2593,8 @@ describe('BrsFile', () => {
                     function getDuck()
                     end function
                     class Duck
+                        sub new()
+                        end sub
                         @anMember
                         @anMember("field")
                         private thing as dynamic
@@ -2558,6 +2654,8 @@ describe('BrsFile', () => {
                 end namespace
             `, (0, testHelpers_spec_1.trim) `
                 class Person
+                    sub new()
+                    end sub
                     public name as string
                     public age as integer
                     public sub getAge() as integer
@@ -2565,6 +2663,8 @@ describe('BrsFile', () => {
                 end class
                 namespace NameA.NameB
                     class Person
+                        sub new()
+                        end sub
                         public name as string
                         public age as integer
                         public sub getAge() as integer
@@ -2573,6 +2673,17 @@ describe('BrsFile', () => {
                 end namespace
             `);
         });
+        it('creates constructor properly', () => {
+            testTypedef(`
+                class Parent
+                end class
+            `, (0, testHelpers_spec_1.trim) `
+                class Parent
+                    sub new()
+                    end sub
+                end class
+            `);
+        });
         it('sets properties to dynamic when initialized to invalid', () => {
             testTypedef(`
                 class Human
@@ -2581,6 +2692,8 @@ describe('BrsFile', () => {
                 end class
             `, (0, testHelpers_spec_1.trim) `
                 class Human
+                    sub new()
+                    end sub
                     public firstName as dynamic
                     public lastName as string
                 end class
@@ -2627,6 +2740,8 @@ describe('BrsFile', () => {
                 end class
             `, (0, testHelpers_spec_1.trim) `
                 class Human
+                    sub new()
+                    end sub
                     public firstName as string
                     protected middleName as string
                     private lastName as string
@@ -2653,10 +2768,14 @@ describe('BrsFile', () => {
                 end class
             `, (0, testHelpers_spec_1.trim) `
                 class Animal
+                    sub new()
+                    end sub
                     public sub speak()
                     end sub
                 end class
                 class Dog extends Animal
+                    sub new()
+                    end sub
                     public override sub speak()
                     end sub
                 end class
@@ -2728,47 +2847,35 @@ describe('BrsFile', () => {
         });
     });
     describe('Plugins', () => {
-        function testPluginTranspile() {
-            testTranspile(`
-                sub main()
-                    sayHello(sub()
-                        print "sub hello"
-                    end sub)
-                    print "something"
-                end sub
-
-                sub sayHello(fn)
-                    fn()
-                    print "hello"
-                end sub
-            `, `
-                sub main()
-                    sayHello(sub()
-                        \n                    end sub)
-                    \n                end sub
-
-                sub sayHello(fn)
-                    fn()
-                    \n                end sub
+        let pluginFileName;
+        let idx = 1;
+        beforeEach(() => {
+            pluginFileName = `plugin-${idx++}.js`;
+            fsExtra.outputFileSync((0, util_1.standardizePath) `${tempDir}/plugins/${pluginFileName}`, `
+                function plugin() {
+                    return {
+                        name: 'lower-file-name',
+                        afterFileParse: (evt) => {
+                            evt.file._customProp = true;
+                        }
+                    };
+                }
+                exports.default = plugin;
             `);
-        }
-        it('can use a plugin object which transforms the AST', () => {
-            program.plugins = new PluginInterface_1.default(util_1.default.loadPlugins('', [
-                require.resolve('../examples/plugins/removePrint')
-            ]), new Logger_1.Logger());
-            testPluginTranspile();
         });
-        it('can load an absolute plugin which transforms the AST', () => {
-            program.plugins = new PluginInterface_1.default(util_1.default.loadPlugins('', [
-                path.resolve(process.cwd(), './dist/examples/plugins/removePrint.js')
+        it('can load an absolute plugin which receives callbacks', () => {
+            program.plugins = new PluginInterface_1.default(util_1.default.loadPlugins(tempDir, [
+                (0, util_1.standardizePath) `${tempDir}/plugins/${pluginFileName}`
             ]), new Logger_1.Logger());
-            testPluginTranspile();
+            const file = program.setFile('source/MAIN.brs', '');
+            (0, chai_1.expect)(file._customProp).to.exist;
         });
-        it('can load a relative plugin which transforms the AST', () => {
-            program.plugins = new PluginInterface_1.default(util_1.default.loadPlugins(process.cwd(), [
-                './dist/examples/plugins/removePrint.js'
+        it('can load a relative plugin which receives callbacks', () => {
+            program.plugins = new PluginInterface_1.default(util_1.default.loadPlugins(tempDir, [
+                `./plugins/${pluginFileName}`
             ]), new Logger_1.Logger());
-            testPluginTranspile();
+            const file = program.setFile('source/MAIN.brs', '');
+            (0, chai_1.expect)(file._customProp).to.exist;
         });
     });
     describe('getSymbolTypeFromToken', () => {
@@ -2826,7 +2933,7 @@ describe('BrsFile', () => {
             (0, chai_1.expect)(symbol.expandedTokenText).to.equal('klass');
             const classStmt = file.parser.references.classStatements[0];
             (0, chai_1.expect)(classStmt.name.text).to.equal('MyKlass');
-            (0, chai_1.expect)(symbol.type.isAssignableTo(classStmt.getCustomType())).be.true;
+            (0, chai_1.expect)(symbol.type.isAssignableTo(classStmt.getThisBscType())).be.true;
             (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
         });
         it('gets types of properties of a klass', () => {
@@ -2973,5 +3080,18 @@ describe('BrsFile', () => {
             (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
         });
     });
+    it('defaults to `dynamic` type for a complex expression', () => {
+        const file = program.setFile('source/main.brs', `
+            sub main()
+                name = "cat"
+                thing = m["key"](true)
+            end sub
+        `);
+        program.validate();
+        //sanity check
+        (0, chai_1.expect)(file.parser.references.assignmentStatements[0].containingFunction.symbolTable.getSymbolType('name')).be.instanceof(StringType_1.StringType);
+        //this complex expression should resolve to dynamic type when not known
+        (0, chai_1.expect)(file.parser.references.assignmentStatements[0].containingFunction.symbolTable.getSymbolType('thing')).be.instanceof(DynamicType_1.DynamicType);
+    });
 });
 //# sourceMappingURL=BrsFile.spec.js.map