Merge pull request #60 from Mogztter/issue-58-opal-init

Author: ggrossetie

.github/workflows/build.yml

@@ -0,0 +1,33 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+      - '0.3.x'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node-version:
+          - 12.17
+          - 14.x
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Node ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install dependencies
+      run: |
+        npm ci
+    - name: Lint and test
+      run: |
+        npm run lint
+        npm t

.travis.yml

@@ -22,7 +22,7 @@
   },
   "main": "src/index.js",
   "scripts": {
-    "test": "mocha spec/*.spec.js",
+    "test": "mocha spec/*.spec.js && mocha spec/load/load-compat.spec.js && mocha spec/load/load-error.spec.js",
     "lint": "standard src/index.js spec npm",
     "prepublishOnly": "node npm/prepublish.js",
     "postpublish": "node npm/postpublish.js"

package.json

@@ -0,0 +1,16 @@
+const chai = require('chai')
+const expect = chai.expect
+
+describe('When an compatible version of Opal is loaded', function () {
+  it('should return the already loaded instance', function () {
+    // fake an already loaded Opal runtime using version 0.10
+    globalThis.Opal = {}
+    globalThis.Opal.$$ = {
+      'RUBY_ENGINE_VERSION': '0.11'
+    }
+    globalThis.Opal.__INSTANCE__ = 'a1b2c3'
+    const Opal = require('../../src/index').Opal
+    expect(Opal.$$['RUBY_ENGINE_VERSION']).to.equal('0.11')
+    expect(Opal.__INSTANCE__).to.equal('a1b2c3')
+  })
+})

spec/load/load-compat.spec.js

@@ -0,0 +1,14 @@
+const chai = require('chai')
+const expect = chai.expect
+
+describe('When an incompatible version of Opal is loaded', function () {
+  it('should throw an error', function () {
+    // fake an already loaded Opal runtime using version 0.10
+    globalThis.Opal = {}
+    globalThis.Opal.$$ = {
+      'RUBY_ENGINE_VERSION': '0.10'
+    }
+    expect(() => require('../../src/index').Opal)
+      .to.throw('Opal is already loaded and version 0.10 is not compatible with 0.11. Please upgrade Asciidoctor.js to the latest version.')
+  })
+})

spec/load/load-error.spec.js

@@ -1,5 +1,5 @@
-const chai = require('chai');
-const expect = chai.expect;
+const chai = require('chai')
+const expect = chai.expect
 
 const fundamentalObjects = [
   Function,
@@ -10,53 +10,62 @@ const fundamentalObjects = [
   String,
   RegExp,
   Array
-];
+]
 
 // Save the current value of toString() for each object, before the import of Opal
 const fundamentalToStringValues = []
 for (let index in fundamentalObjects) {
-  const fundamentalObject = fundamentalObjects[index];
-  fundamentalToStringValues.push(fundamentalObject.toString());
+  const fundamentalObject = fundamentalObjects[index]
+  fundamentalToStringValues.push(fundamentalObject.toString())
 }
 
-const Opal = require('../src/index').Opal;
+const Opal = require('../src/index').Opal
 
 describe('Opal Node Runtime', function () {
 
-  describe('When loaded', function() {
-    it('should export Opal object', function() {
-      expect(Opal).not.be.null;
-    });
+  describe('When loaded', function () {
+    it('should export Opal object', function () {
+      expect(Opal).not.be.null
+    })
 
-    it('should preserve Function methods', function() {
+    it('should preserve Function methods', function () {
 
       for (let index in fundamentalObjects) {
-        const fundamentalObject = fundamentalObjects[index];
-        expect(fundamentalObject.call, `${fundamentalObject.name}.call should be a Function`).to.be.an.instanceof(Function);
-        expect(fundamentalObject.apply, `${fundamentalObject.name}.apply should be a Function`).to.be.an.instanceof(Function);
-        expect(fundamentalObject.bind, `${fundamentalObject.name}.bind should be a Function`).to.be.an.instanceof(Function);
-        expect(fundamentalObject.toString(), `${fundamentalObject.name}.toString should be native function`).to.be.equal(fundamentalToStringValues[index]);
-        expect(fundamentalObject.toString()).to.equal(`function ${fundamentalObject.name}() { [native code] }`);
+        const fundamentalObject = fundamentalObjects[index]
+        expect(fundamentalObject.call, `${fundamentalObject.name}.call should be a Function`).to.be.an.instanceof(Function)
+        expect(fundamentalObject.apply, `${fundamentalObject.name}.apply should be a Function`).to.be.an.instanceof(Function)
+        expect(fundamentalObject.bind, `${fundamentalObject.name}.bind should be a Function`).to.be.an.instanceof(Function)
+        expect(fundamentalObject.toString(), `${fundamentalObject.name}.toString should be native function`).to.be.equal(fundamentalToStringValues[index])
+        expect(fundamentalObject.toString()).to.equal(`function ${fundamentalObject.name}() { [native code] }`)
       }
-    });
-  });
-
-  describe('When pathname module is loaded', function() {
-    it('should register Pathname methods', function() {
-      Opal.load('pathname');
-      var Pathname = Opal.const_get_relative([], 'Pathname');
-      var path1 = Pathname.$new('/foo/bar');
-      var path2 = Pathname.$new('qux');
-      expect(path1['$+'](path2)['$to_path']()).to.equal('/foo/bar/qux');
-    });
-  });
-
-  describe('When nodejs module is loaded', function() {
-    it('should register Node.js specific implementations', function() {
-      Opal.load('nodejs');
-      var Dir = Opal.const_get_relative([], 'Dir');
-      var currentDir = Dir['$pwd']();
-      expect(currentDir).to.equal(process.cwd());
-    });
-  });
-});
+    })
+  })
+
+  describe('When pathname module is loaded', function () {
+    it('should register Pathname methods', function () {
+      Opal.load('pathname')
+      var Pathname = Opal.const_get_relative([], 'Pathname')
+      var path1 = Pathname.$new('/foo/bar')
+      var path2 = Pathname.$new('qux')
+      expect(path1['$+'](path2)['$to_path']()).to.equal('/foo/bar/qux')
+    })
+  })
+
+  describe('When nodejs module is loaded', function () {
+    it('should register Node.js specific implementations', function () {
+      Opal.load('nodejs')
+      var Dir = Opal.const_get_relative([], 'Dir')
+      var currentDir = Dir['$pwd']()
+      expect(currentDir).to.equal(process.cwd())
+    })
+  })
+
+  describe('When nodejs module is loaded', function () {
+    it('should register Node.js specific implementations', function () {
+      Opal.load('nodejs')
+      var Dir = Opal.const_get_relative([], 'Dir')
+      var currentDir = Dir['$pwd']()
+      expect(currentDir).to.equal(process.cwd())
+    })
+  })
+})

spec/main.spec.js

@@ -1,7 +1,29 @@
-/* global Opal */
-require('./opal.js')
-require('./nodejs.js')
-require('./pathname.js')
-require('./stringio.js')
+/* global globalThis, self */
+var globalObject
+if (typeof globalThis !== 'undefined') {
+  globalObject = globalThis
+} else if (typeof self !== 'undefined') {
+  globalObject = self
+} else if (typeof window !== 'undefined') {
+  globalObject = window
+} else if (typeof global !== 'undefined') {
+  globalObject = global
+} else {
+  throw new Error('Unable to locate global object. Unsupported runtime.')
+}
+if (globalObject && globalObject.Opal) {
+  // Opal is already loaded!
+  var rubyEngineVersion = globalObject.Opal.$$['RUBY_ENGINE_VERSION']
+  if (!rubyEngineVersion.startsWith('0.11')) {
+    // incompatible version!
+    throw new Error('Opal is already loaded and version ' + rubyEngineVersion + ' is not compatible with 0.11. Please upgrade Asciidoctor.js to the latest version.')
+  }
+} else {
+  // load Opal
+  require('./opal.js')
+  require('./nodejs.js')
+  require('./pathname.js')
+  require('./stringio.js')
+}
 
-module.exports.Opal = Opal
+module.exports.Opal = globalObject.Opal

src/index.js

@@ -31,9 +31,9 @@
   if (!('log' in console)) { console.log = function () {}; }
   if (!('warn' in console)) { console.warn = console.log; }
 
-  if (typeof(this.Opal) !== 'undefined') {
+  if (typeof(global_object.Opal) !== 'undefined') {
     console.warn('Opal already loaded. Loading twice can cause troubles, please fix your setup.');
-    return this.Opal;
+    return global_object.Opal;
   }
 
   var nil;