add optional gomodules support (#54)

* add support for go modules

* add tests for gomodules

* bump version

Author: marceloneil

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.4.10
+
+- Support gomodules using the optional '-m' flag.
+
 # 1.4.9
 
 - Add nullSerializable decorator that always emits a field, even with a null value, instead of sometimes omitting it

lib/go_emit.js

@@ -1,6 +1,6 @@
 {
   "name": "avdl-compiler",
-  "version": "1.4.9",
+  "version": "1.4.10",
   "description": "AVDL to Go compiler written in IcedCoffeeScript (for node)",
   "main": "lib/main.js",
   "scripts": {
@@ -37,4 +37,4 @@
     "lodash": "4.17.15",
     "minimist": "^1.2.0"
   }
-}
+}

lib/main.js

@@ -14,7 +14,7 @@ is_one_way = (d) -> (d.notify? or d.oneway)
 #====================================================================
 
 exports.GoEmitter = class GoEmitter extends BaseEmitter
-  constructor : () ->
+  constructor : (@gomod_path, @gomod_dir) ->
     super
     @_tab_char = '\t'
     @_pkg = null
@@ -588,9 +588,13 @@ exports.GoEmitter = class GoEmitter extends BaseEmitter
       @output '"github.com/keybase/go-framed-msgpack-rpc/rpc"'
       @output 'context "golang.org/x/net/context"' if Object.keys(messages).length > 0
 
-    prefix = process.env.GOPATH + '/src/'
-    relative_file = path_lib.resolve(outfile).replace(prefix, "")
-    relative_dir = path_lib.dirname(relative_file)
+    if @gomod_path and @gomod_dir
+      relative_file = path_lib.resolve(outfile).replace(@gomod_dir, "")
+      relative_dir = @gomod_path + path_lib.dirname(relative_file)
+    else
+      prefix = process.env.GOPATH + '/src/'
+      relative_file = path_lib.resolve(outfile).replace(prefix, "")
+      relative_dir = path_lib.dirname(relative_file)
 
     for {import_as, path} in imports when path.indexOf('/') >= 0
       if path.match /(\.\/|\.\.\/)/

package-lock.json

@@ -1,10 +1,14 @@
 {GoEmitter} = require("./go_emit");
 pkg         = require '../package.json'
+path_lib    = require 'path'
 
-describe "GoEmitter", () ->
+describe.each([
+  ["Go Modules disabled", "", ""],
+  ["Go Modules enabled", "github.com/keybase/node-avdl-compiler", path_lib.resolve()]
+]) 'GoEmitter - %s', (_, gomod_path, gomod_dir) ->
   emitter = null
   beforeEach () ->
-    emitter = new GoEmitter
+    emitter = new GoEmitter gomod_path, gomod_dir
 
   describe "emit_preface", () ->
     it "Should emit a preface", () ->

package.json

@@ -7,26 +7,28 @@ avdl2json = require 'avdl2json'
 fs = require 'fs'
 pathmod = require 'path'
 {mergeWith} = require 'lodash'
+{exec} = require 'child_process'
 
 #================================================
 
 usage = () ->
   console.error """AVDL Compiler
 
-#{'  '}single file: avdlc -l <lang> [-t] -i <infile> -o <outfile>
-#{'  '}batch:       avdlc -l <lang> [-t] -b -o <outdir> <infiles...>
+#{'  '}single file: avdlc -l <lang> [-t] [-m] -i <infile> -o <outfile>
+#{'  '}batch:       avdlc -l <lang> [-t] [-m] -b -o <outdir> <infiles...>
 
 avdlc can run in either batch or single-file mode. Specify which language
 to output code in. Currently, only "go" is fully supported. TypeScript and Python are partially supported.
 
 Use -t to only print types and ignore function definitions.
+Use -m to set gomodules support
 """
 
 #================================================
 
-emit = ( { infiles, outfile, json, lang, types_only }, cb) ->
+emit = ( { infiles, outfile, json, lang, types_only, gomod_path, gomod_dir }, cb) ->
   emitter = switch lang
-    when "go" then new GoEmitter()
+    when "go" then new GoEmitter(gomod_path, gomod_dir)
     when "typescript" then new TypescriptEmitter()
     when "python" then new PythonEmitter()
     else throw new Error "Unrecognized language: #{@lang}"
@@ -66,12 +68,14 @@ exports.Main = class Main
       err = new Error "usage: shown!"
     else if (@batch = argv.b)
       @types_only = argv.t
+      @gomod_enabled = argv.m
       @outdir = argv.o
       @infiles = argv._
       unless @outdir? and @infiles.length
         err = new Error "need an [-o <outdir>] and input files in batch mode"
     else
       @types_only = argv.t
+      @gomod_enabled = argv.m
       @outfile = argv.o
       @infile = argv.i
       unless @outfile? and @infile?
@@ -104,14 +108,24 @@ exports.Main = class Main
 
   #---------------
 
+  get_gomod : (opts, cb) ->
+    esc = make_esc cb, "get_gomod"
+    cwd = if @outdir? then @outdir else pathmod.dirname(@outfile)
+    await exec 'go list -m -json', {cwd}, esc defer stdout
+    @gomod_path = JSON.parse(stdout).Path
+    @gomod_dir = JSON.parse(stdout).Dir
+    cb null
+
+  #---------------
+
   do_file : ({infile, outfile}, cb) ->
     esc = make_esc cb, "do_file"
     if @clean
       await fs.unlink outfile, defer err
       console.log "Deleting #{outfile}" unless err?
     else
       await avdl2json.parse { infile, version : 2 }, esc defer ast
-      await emit { infiles: [infile], outfile, json : ast.to_json(), @types_only, @lang }, esc defer code
+      await emit { infiles: [infile], outfile, json : ast.to_json(), @types_only, @lang, @gomod_path, @gomod_dir }, esc defer code
       await output { code, outfile }, esc defer()
       console.log "Compiling #{infile} -> #{outfile}"
     cb null
@@ -127,7 +141,7 @@ exports.Main = class Main
     for infile in @infiles
       await avdl2json.parse { infile, version: 2 }, esc defer ast
       merge_asts json, ast.to_json()
-    await emit { @infiles, json, outfile, types_only: true, @lang }, esc defer code
+    await emit { @infiles, json, outfile, types_only: true, @lang, @gomod_path, @gomod_dir }, esc defer code
     await output { code, outfile }, esc defer()
     console.log "Compiling #{@infiles} -> #{outfile}"
 
@@ -161,6 +175,8 @@ exports.Main = class Main
   main : ({argv}, cb) ->
     esc = make_esc cb, "main"
     await @parse_argv {argv}, esc defer()
+    if @gomod_enabled
+      await @get_gomod {}, esc defer()
     if @batch
       await @do_batch_mode {}, esc defer()
     else

src/go_emit.iced

@@ -1,4 +1,4 @@
-// Auto-generated to Go types and interfaces using avdl-compiler v1.4.9 (https://github.com/keybase/node-avdl-compiler)
+// Auto-generated to Go types and interfaces using avdl-compiler v1.4.10 (https://github.com/keybase/node-avdl-compiler)
 //   Input file: avdl/sample.avdl
 
 package sample1

src/go_emit.test.iced

@@ -1,6 +1,6 @@
 """sample.1
 
-Auto-generated to Python types by avdl-compiler v1.4.9 (https://github.com/keybase/node-avdl-compiler)
+Auto-generated to Python types by avdl-compiler v1.4.10 (https://github.com/keybase/node-avdl-compiler)
 Input files:
  - avdl/sample.avdl
 """