Merge pull request #51 from abeaumont/driver-refactor

Driver refactor

Author: abeaumont

ANNOTATION.md

@@ -5,5 +5,5 @@ ENV RUNTIME_NATIVE_VERSION $RUNTIME_NATIVE_VERSION
 
 RUN apk add --no-cache openjdk8-jre="$RUNTIME_NATIVE_VERSION"
 
-ADD build /opt/driver/bin
-CMD /opt/driver/bin/driver
+ADD build /opt/driver
+ENTRYPOINT ["/opt/driver/bin/driver"]

Dockerfile.tpl

@@ -12,7 +12,7 @@ test-native-internal:
 build-native-internal:
 	cd native; \
 	$(MVN_CMD) package
-	cp native/target/$(JAR) $(BUILD_PATH); \
-	cp native/src/main/sh/native.sh $(BUILD_PATH)/native; \
-	chmod +x $(BUILD_PATH)/native
+	cp native/target/$(JAR) $(BUILD_PATH)/bin; \
+	cp native/src/main/sh/native.sh $(BUILD_PATH)/bin/native; \
+	chmod +x $(BUILD_PATH)/bin/native
 

Makefile

@@ -1,20 +1,19 @@
 package main
 
 import (
-	"gopkg.in/bblfsh/sdk.v1/protocol/driver"
-
 	"github.com/bblfsh/java-driver/driver/normalizer"
-)
 
-var version string
-var build string
+	"gopkg.in/bblfsh/sdk.v1/sdk/driver"
+)
 
 func main() {
-	d := driver.Driver{
-		Version:       version,
-		Build:         build,
-		ParserBuilder: normalizer.ParserBuilder,
-		Annotate:      normalizer.AnnotationRules,
+	d, err := driver.NewDriver(normalizer.ToNode, normalizer.Transformers)
+	if err != nil {
+		panic(err)
+	}
+
+	s := driver.NewServer(d)
+	if err := s.Start(); err != nil {
+		panic(err)
 	}
-	d.Exec()
 }

driver/main.go

@@ -5,8 +5,20 @@ import (
 
 	"gopkg.in/bblfsh/sdk.v1/uast"
 	. "gopkg.in/bblfsh/sdk.v1/uast/ann"
+	"gopkg.in/bblfsh/sdk.v1/uast/transformer"
+	"gopkg.in/bblfsh/sdk.v1/uast/transformer/annotatter"
 )
 
+// Transformers is the of list `transformer.Transfomer` to apply to a UAST, to
+// learn more about the Transformers and the available ones take a look to:
+// https://godoc.org/gopkg.in/bblfsh/sdk.v1/uast/transformers
+var Transformers = []transformer.Tranformer{
+	annotatter.NewAnnotatter(AnnotationRules),
+}
+
+// AnnotationRules describes how a UAST should be annotated with `uast.Role`.
+//
+// https://godoc.org/gopkg.in/bblfsh/sdk.v1/uast/ann
 var AnnotationRules = On(jdt.CompilationUnit).Roles(uast.File).Descendants(
 	// Names
 	On(jdt.QualifiedName).Roles(uast.Expression, uast.Identifier, uast.Qualified),

driver/normalizer/annotation.go

@@ -8,8 +8,8 @@ import (
 	"path/filepath"
 	"testing"
 
-	"gopkg.in/bblfsh/sdk.v1/uast"
 	"github.com/stretchr/testify/require"
+	"gopkg.in/bblfsh/sdk.v1/uast"
 )
 
 var (
@@ -22,7 +22,7 @@ func TestAnnotate(t *testing.T) {
 	f, err := getFixture("java_example_1.json")
 	require.NoError(err)
 
-	n, err := ToNoder.ToNode(f)
+	n, err := ToNode.ToNode(f)
 	require.NoError(err)
 	require.NotNil(n)
 
@@ -51,7 +51,7 @@ func TestAnnotatePrettyAnnotationsOnly(t *testing.T) {
 	f, err := getFixture("java_example_1.json")
 	require.NoError(err)
 
-	n, err := ToNoder.ToNode(f)
+	n, err := ToNode.ToNode(f)
 	require.NoError(err)
 	require.NotNil(n)
 
@@ -70,7 +70,7 @@ func TestNodeTokens(t *testing.T) {
 	f, err := getFixture("java_example_1.json")
 	require.NoError(err)
 
-	n, err := ToNoder.ToNode(f)
+	n, err := ToNode.ToNode(f)
 	require.NoError(err)
 	require.NotNil(n)
 

driver/normalizer/annotation_test.go

@@ -0,0 +1,34 @@
+package normalizer
+
+import (
+	"gopkg.in/bblfsh/sdk.v1/uast"
+)
+
+// ToNode is an instance of `uast.ObjectToNode`, defining how to transform an
+// into a UAST (`uast.Node`).
+//
+// https://godoc.org/gopkg.in/bblfsh/sdk.v1/uast#ObjectToNode
+var ToNode = &uast.ObjectToNode{
+	InternalTypeKey: "internalClass",
+	LineKey:         "startLine",
+	ColumnKey:       "startColumn",
+	OffsetKey:       "startPosition",
+	EndLineKey:      "endLine",
+	EndColumnKey:    "endColumn",
+	EndOffsetKey:    "endPosition",
+
+	//TODO: Should this be part of the UAST rules?
+	TokenKeys: map[string]bool{
+		"identifier":        true, // SimpleName
+		"escapedValue":      true, // StringLiteral
+		"keyword":           true, // Modifier
+		"primitiveTypeCode": true, // ?
+	},
+	SyntheticTokens: map[string]string{
+		"PackageDeclaration": "package",
+		"IfStatement":        "if",
+		"NullLiteral":        "null",
+	},
+	//TODO: add names of children (e.g. elseStatement) as
+	//      children node properties.
+}

driver/normalizer/parser.go

@@ -1,20 +1,18 @@
 package normalizer
 
 import (
-	"fmt"
 	"testing"
 
 	"github.com/stretchr/testify/require"
 )
 
-func TestNativeToNoder(t *testing.T) {
+func TestNativeToNode(t *testing.T) {
 	require := require.New(t)
 
 	f, err := getFixture("java_example_1.json")
 	require.NoError(err)
 
-	n, err := ToNoder.ToNode(f)
+	n, err := ToNode.ToNode(f)
 	require.NoError(err)
 	require.NotNil(n)
-	fmt.Println("NODE", n)
 }