Develop

package.json

@@ -1,6 +1,6 @@
 {
   "name": "Builder",
-  "version": "3.3.0",
+  "version": "4.0.0",
   "description": "Builder Language Implementation",
   "main": "src/index.js",
   "bin": {

spec/Builder.spec.js

@@ -1,11 +1,15 @@
-// Copyright (c) 2016-2017 Electric Imp
+// Copyright (c) 2016-2020 Electric Imp
 // This file is licensed under the MIT License
 // http://opensource.org/licenses/MIT
 
 'use strict';
 
 const Builder = require('../src');
 const Machine = require('../src/Machine');
+const path = require('path');
+
+const contextPath = path.resolve(__dirname, './..').replace(/\\/g, '/');
+const filePath = path.join(contextPath, 'main').replace(/\\/g, '/');
 
 describe('Builder', () => {
 
@@ -21,7 +25,7 @@ describe('Builder', () => {
     expect(builder.machine instanceof Machine).toBeTruthy();
     builder.machine.generateLineControlStatements = true;
     expect(builder.machine.execute('@{__FILE__}:@{__LINE__}'))
-      .toBe('#line 1 "main"\nmain:1');
+      .toBe('#line 1 "' + filePath + '"\nmain:1');
   });
 
   it('should execute "escape" filter', () => {

spec/Include/IncludePath.spec.js

@@ -0,0 +1,71 @@
+// MIT License
+//
+// Copyright 2020 Electric Imp
+//
+// SPDX-License-Identifier: MIT
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+// EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+// OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+// OTHER DEALINGS IN THE SOFTWARE.
+
+'use strict';
+
+const Builder = require('../../src');
+const backslashToSlash = require('../backslashToSlash');
+const Log = require('log');
+const path = require('path');
+const fs = require('fs');
+
+const LOCAL_REPO_NOT_DEFINED_MESSAGE = "SPEC_GIT_LOCAL_REPO_PATH is not defined. Test will be skipped";
+
+describe('__PATH__ variable - ', () => {
+
+  let builder;
+  const contextPath = path.resolve(__dirname + "/../fixtures/lib/").replace(/\\/g, '/');
+
+  beforeEach(() => {
+    builder = new Builder();
+    builder.machine.path = contextPath;
+    builder.machine.readers.github.username = process.env.SPEC_GITHUB_USERNAME;
+    builder.machine.readers.github.token = process.env.SPEC_GITHUB_PASSWORD || process.env.SPEC_GITHUB_TOKEN;
+    builder.logger = new Log(process.env.SPEC_LOGLEVEL || 'error');
+  });
+
+  it('__PATH__ should be a local path', () => {
+    let output = builder.machine.execute(`@include "${backslashToSlash(__dirname)}/../fixtures/lib/path.builder"`);
+    expect(output).toContain(contextPath + "#path.builder@1");
+  });
+
+  it('__PATH__ should be a git-local path', () => {
+    if (process.env.SPEC_GIT_LOCAL_REPO_PATH != undefined) {
+      let output = builder.machine.execute(`@include "git-local:${process.env.SPEC_GIT_LOCAL_REPO_PATH}/spec/fixtures/lib/path.builder@develop"`);
+      expect(output).toContain("git-local:" + backslashToSlash(process.env.SPEC_GIT_LOCAL_REPO_PATH) + "/spec/fixtures/lib#path.builder@1");
+    } else {
+      console.log(LOCAL_REPO_NOT_DEFINED_MESSAGE);
+    }
+  });
+
+  it('__PATH__ should be a remote repository path', () => {
+    let output = builder.machine.execute(`@include "github:electricimp/Builder/spec/fixtures/lib/path.builder@develop"`);
+    expect(output).toContain('github:electricimp/Builder/spec/fixtures/lib#path.builder@1\n');
+  });
+
+  it('__PATH__ should be a web link', () => {
+    let output = builder.machine.execute(`@include "https://raw.githubusercontent.com/electricimp/Builder/develop/spec/fixtures/lib/path.builder"`);
+    expect(output).toContain('https://raw.githubusercontent.com/electricimp/Builder/develop/spec/fixtures/lib#path.builder@1\n');
+  });
+});

spec/Include/IncludeRelativeLocal.spec.js

@@ -0,0 +1,146 @@
+// MIT License
+//
+// Copyright 2020 Electric Imp
+//
+// SPDX-License-Identifier: MIT
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+// EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+// OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+// OTHER DEALINGS IN THE SOFTWARE.
+
+'use strict';
+
+const Builder = require('../../src');
+const backslashToSlash = require('../backslashToSlash');
+const Log = require('log');
+const path = require('path');
+const fs = require('fs');
+
+describe('Builder is called for file in included directory - ', () => {
+
+  let builder;
+  const contextPath = path.resolve(__dirname + "/../fixtures/include/sample-1/").replace(/\\/g, '/');
+
+  beforeEach(() => {
+    builder = new Builder();
+    builder.machine.path = contextPath;
+    builder.machine.readers.file.runDir = contextPath;
+    builder.machine.readers.file.inputFileDir = path.join(contextPath + '/dirZ');
+    builder.logger = new Log(process.env.SPEC_LOGLEVEL || 'error');
+  });
+
+  it('should search Y file in directory where X file located', () => {
+    let output = builder.machine.execute(`@include "dirZ/file_case1.nut"`);
+    expect(output).toContain('// y.nut (case 1)\n');
+  });
+
+  it('should search Y file in directory where processing file located', () => {
+    let output = builder.machine.execute(`@include "dirZ/file_case2.nut"`);
+    expect(output).toContain('// y.nut (case 2)\n');
+  });
+
+  it('should search Y file in directory where builder called', () => {
+    let output = builder.machine.execute(`@include "dirZ/file_case3.nut"`);
+    expect(output).toContain('// y.nut (case 3)\n');
+  });
+
+  it('file not found', () => {
+    const filePath = path.join(contextPath, 'dirX/x_case4.nut').replace(/\\/g, '/');
+    const fileNotFoundMessage = `Local file "dirD/y4.nut" not found (${filePath}:1)`;
+    try {
+      builder.machine.execute(`@include "dirZ/file_case4.nut"`);
+      fail();
+    } catch (e) {
+      expect(backslashToSlash(e.message)).toEqual(fileNotFoundMessage);
+    }
+  });
+});
+
+describe('Builder is called for file in current directory - ', () => {
+
+  let builder;
+  const contextPath = path.resolve(__dirname + "/../fixtures/include/sample-1/dirZ").replace(/\\/g, '/');
+
+  beforeEach(() => {
+    builder = new Builder();
+    builder.machine.path = contextPath;
+    builder.machine.readers.file.runDir = contextPath;
+    builder.machine.readers.file.inputFileDir = path.join(contextPath);
+    builder.logger = new Log(process.env.SPEC_LOGLEVEL || 'error');
+  });
+
+  it('should search Y file in directory where X file located', () => {
+    let output = builder.machine.execute(`@include "file_case1.nut"`);
+    expect(output).toContain('// y.nut (case 1)\n');
+  });
+
+  it('should search Y file in directory where processing file located', () => {
+    let output = builder.machine.execute(`@include "file_case2.nut"`);
+    expect(output).toContain('// y.nut (case 2)\n');
+  });
+
+  it('should search Y file in directory where builder called', () => {
+    const filePath = path.join(contextPath, '/../dirX/x_case3.nut').replace(/\\/g, '/');
+    const fileNotFoundMessage = `Local file "dirD/y3.nut" not found (${filePath}:1)`;
+    try {
+      builder.machine.execute(`@include "file_case3.nut"`);
+      fail();
+    } catch (e) {
+      expect(backslashToSlash(e.message)).toEqual(fileNotFoundMessage);
+    }
+  });
+});
+
+describe('Builder is called for file in deep included directory - ', () => {
+
+  let builder;
+  const contextPath = path.resolve(__dirname + "/../fixtures/include/").replace(/\\/g, '/');
+
+  beforeEach(() => {
+    builder = new Builder();
+    builder.machine.path = contextPath;
+    builder.machine.readers.file.runDir = contextPath;
+    builder.machine.readers.file.inputFileDir = path.join(contextPath + '/sample-1/dirZ');
+    builder.logger = new Log(process.env.SPEC_LOGLEVEL || 'error');
+  });
+
+  it('should search Y file in directory where X file located', () => {
+    let output = builder.machine.execute(`@include "sample-1/dirZ/file_case1.nut"`);
+    expect(output).toContain('// y.nut (case 1)\n');
+  });
+
+  it('should search Y file in directory where processing file located', () => {
+    let output = builder.machine.execute(`@include "sample-1/dirZ/file_case2.nut"`);
+    expect(output).toContain('// y.nut (case 2)\n');
+  });
+
+  it('file not found', () => {
+    const filePath = path.join(contextPath, 'sample-1/dirX/x_case3.nut').replace(/\\/g, '/');
+    const fileNotFoundMessage = `Local file "dirD/y3.nut" not found (${filePath}:1)`;
+    try {
+      builder.machine.execute(`@include "sample-1/dirZ/file_case3.nut"`);
+      fail();
+    } catch (e) {
+      expect(backslashToSlash(e.message)).toEqual(fileNotFoundMessage);
+    }
+  });
+
+  it('should search Y file in directory where builder called', () => {
+    let output = builder.machine.execute(`@include "sample-1/dirZ/file_case4.nut"`);
+    expect(output).toContain('// y.nut (case 4)\n');
+  });
+});