Merge pull request #186 from ethereum/translate-version

 Add helper to translate old style versions to semver

Author: axic

README.md

@@ -89,6 +89,10 @@ The `compile()` method always returns an object, which can contain `errors`, `so
 
 Starting from version 0.4.11 there is a new entry point named `compileStandardWrapper()` which supports Solidity's [standard JSON input and output](https://solidity.readthedocs.io/en/develop/using-the-compiler.html#compiler-input-and-output-json-description). It also maps old compiler output to it.
 
+#### From version 0.4.20
+
+Starting from version 0.4.20 a Semver compatible version number can be retrieved on every compiler release, including old ones, using the `semver()` method.
+
 ### Using with Electron
 
 **Note:**

test/index.js

@@ -1,3 +1,4 @@
+require('./translate.js');
 require('./package.js');
 require('./abi.js');
 require('./cli.js');

test/package.js

@@ -6,6 +6,10 @@ tape('Version and license', function (t) {
     st.equal(typeof solc.version(), 'string');
     st.end();
   });
+  t.test('check semver', function (st) {
+    st.equal(typeof solc.semver(), 'string');
+    st.end();
+  });
   t.test('check license', function (st) {
     st.ok(typeof solc.license() === 'undefined' || typeof solc.license() === 'string');
     st.end();

test/translate.js

@@ -0,0 +1,37 @@
+const tape = require('tape');
+const translate = require('../translate.js');
+const versionToSemver = translate.versionToSemver;
+
+tape('Version string to Semver translator', function (t) {
+  t.test('Only numbers', function (st) {
+    st.equal(versionToSemver('0.1.0'), '0.1.0');
+    st.end();
+  });
+  t.test('New style release (semver)', function (st) {
+    st.equal(versionToSemver('0.4.5+commit.b318366e.Emscripten.clang'), '0.4.5+commit.b318366e.Emscripten.clang');
+    st.end();
+  });
+  t.test('New style nightly (semver)', function (st) {
+    st.equal(versionToSemver('0.4.20-nightly.2018.2.13+commit.27ef9794.Emscripten.clang'), '0.4.20-nightly.2018.2.13+commit.27ef9794.Emscripten.clang');
+    st.end();
+  });
+  t.test('Old style 0.1.1', function (st) {
+    st.equal(versionToSemver('0.1.1-6ff4cd6b/RelWithDebInfo-Emscripten/clang/int'), '0.1.1+commit.6ff4cd6b');
+    st.end();
+  });
+  t.test('Old style 0.2.0', function (st) {
+    st.equal(
+      versionToSemver('0.2.0-e7098958/.-Emscripten/clang/int linked to libethereum-1.1.1-bbb80ab0/.-Emscripten/clang/int'),
+      '0.2.0+commit.e7098958'
+    );
+    st.end();
+  });
+  t.test('Old style 0.3.5', function (st) {
+    st.equal(versionToSemver('0.3.5-371690f0/Release-Emscripten/clang/Interpreter'), '0.3.5+commit.371690f0');
+    st.end();
+  });
+  t.test('Old style 0.3.6', function (st) {
+    st.equal(versionToSemver('0.3.6-3fc68da5/Release-Emscripten/clang'), '0.3.6+commit.3fc68da5');
+    st.end();
+  });
+});

translate.js

@@ -1,3 +1,19 @@
+/// Translate old style version numbers to semver.
+/// Old style: 0.3.6-3fc68da5/Release-Emscripten/clang
+///            0.3.5-371690f0/Release-Emscripten/clang/Interpreter
+///            0.2.0-e7098958/.-Emscripten/clang/int linked to libethereum-1.1.1-bbb80ab0/.-Emscripten/clang/int
+///            0.1.1-6ff4cd6b/RelWithDebInfo-Emscripten/clang/int
+/// New style: 0.4.5+commit.b318366e.Emscripten.clang
+function versionToSemver (version) {
+  // FIXME: parse more detail, but this is a good start
+  var parsed = version.match(/^([0-9]+\.[0-9]+\.[0-9]+)-([0-9a-f]{8})\/.*$/);
+  if (parsed) {
+    return parsed[1] + '+commit.' + parsed[2];
+  }
+  // assume it is already semver compatible
+  return version;
+}
+
 function translateErrors (ret, errors) {
   for (var error in errors) {
     var type = 'error';
@@ -118,5 +134,6 @@ function translateJsonCompilerOutput (output) {
 }
 
 module.exports = {
+  versionToSemver: versionToSemver,
   translateJsonCompilerOutput: translateJsonCompilerOutput
 };

wrapper.js

@@ -157,6 +157,10 @@ function setupMethods (soljson) {
 
   var version = soljson.cwrap('version', 'string', []);
 
+  var versionToSemver = function () {
+    return translate.versionToSemver(version());
+  };
+
   var license = function () {
     // return undefined
   };
@@ -167,6 +171,7 @@ function setupMethods (soljson) {
 
   return {
     version: version,
+    semver: versionToSemver,
     license: license,
     compile: compile,
     compileStandard: compileStandard,