Merge pull request #44 from bblfsh/feature/node.filter

Make Node.filter() work.

Author: juanjux

src/main/scala/org/bblfsh/client/BblfshClient.scala

@@ -16,10 +16,9 @@ class BblfshClient(host: String, port: Int, maxMsgSize: Int) {
     .maxInboundMessageSize(maxMsgSize)
     .build()
   private val stub = ProtocolServiceGrpc.blockingStub(channel)
-  private val libuast = new Libuast
 
   def parse(name: String, content: String, lang: String = "", 
-            encoding: Encoding = Encoding.UTF8) = {
+            encoding: Encoding = Encoding.UTF8): ParseResponse = {
     // assume content is already encoded in one of:
     // https://github.com/bblfsh/sdk/blob/master/protocol/protocol.go#L68
     val req = ParseRequest(filename = name,
@@ -30,13 +29,17 @@ class BblfshClient(host: String, port: Int, maxMsgSize: Int) {
     parsed
   }
 
-  def filter(node: Node, query: String): List[Node] = Libuast.synchronized {
-    libuast.filter(node, query)
+  /**
+   * Proxy for Bblfsh.filter / Node.filter, provided for backward compatibility.
+   */
+  def filter(node: Node, query: String): List[Node] = {
+    BblfshClient.filter(node, query)
   }
 }
 
 object BblfshClient {
   val DEFAULT_MAX_MSG_SIZE = 100 * 1024 * 1024
+  private val libuast = new Libuast
 
   def apply(host: String, port: Int, 
             maxMsgSize: Int = DEFAULT_MAX_MSG_SIZE): BblfshClient =
@@ -53,5 +56,15 @@ object BblfshClient {
       .replace("+", "p")
       .replace("#", "sharp")
   }
+
+  def filter(node: Node, query: String): List[Node] = Libuast.synchronized {
+    libuast.filter(node, query)
+  }
+
+  implicit class NodeMethods(val node: Node) {
+    def filter(query: String): List[Node] = {
+      BblfshClient.filter(node, query)
+    }
+  }
 }
 

src/main/scala/org/bblfsh/client/cli/ScalaClientCLI.scala

@@ -22,7 +22,7 @@ object ScalaClientCLI extends App {
 
   if (resp.errors.isEmpty) {
     if (query != null && query != "") {
-      println(client.filter(resp.uast.get, query))
+      println(BblfshClient.filter(resp.uast.get, query))
     } else {
       println(resp.uast.get)
     }

src/test/scala/org/bblf/client/BblfshClientTest.scala

@@ -1,7 +1,9 @@
 package org.bblfsh.client
 
-import gopkg.in.bblfsh.sdk.v1.protocol.generated.ParseResponse
+import org.bblfsh.client.BblfshClient._
 
+import gopkg.in.bblfsh.sdk.v1.protocol.generated.ParseResponse
+import gopkg.in.bblfsh.sdk.v1.uast.generated.Node
 import org.scalatest.FunSuite
 import org.scalatest.BeforeAndAfter
 
@@ -14,9 +16,14 @@ class BblfshClientTest extends FunSuite with BeforeAndAfter {
   val fileName = "src/test/resources/SampleJavaFile.java"
   val fileContent = Source.fromFile(fileName) .getLines.mkString
   var resp: ParseResponse = _
+  var rootNode: Node = _
 
   before {
     resp = client.parse(fileName, fileContent)
+    
+    if (resp.uast.isDefined) {
+      rootNode = resp.uast.get
+    }
   }
 
   test("Parse UAST for existing .java file") {
@@ -25,33 +32,39 @@ class BblfshClientTest extends FunSuite with BeforeAndAfter {
   }
 
   test("Get the internalType") {
-    assert(resp.uast.get.internalType == "CompilationUnit")
+    assert(rootNode.internalType == "CompilationUnit")
   }
 
   test("Get the children") {
-    val children = resp.uast.get.children
+    val children = rootNode.children
     assert(children.length == 2)
   }
 
   test("Get the token") {
-    assert(resp.uast.get.children.head.token == "package")
+    assert(rootNode.children.head.token == "package")
   }
 
   test("Get the properties") {
-    val properties = resp.uast.get.children.head.properties
+    val properties = rootNode.children.head.properties
     assert(properties.size == 1)
     assert(properties("internalRole") == "package")
   }
 
-  test("Simple XPath query") {
-    var filtered = client.filter(resp.uast.get, "//QualifiedName[@roleExpression]")
+  test("Simple XPath query called on client object andinstance") {
+    var filtered = client.filter(rootNode, "//QualifiedName[@roleExpression]")
+    var filtered2 = BblfshClient.filter(rootNode, "//QualifiedName[@roleExpression]")
     assert(filtered.length == 3)
+    assert(filtered == filtered2)
+  }
+
+  test("Simple XPath query calling filter on the Node") {
+    rootNode.filter("//QualifiedName[@roleExpression]")
   }
 
   test("XPath query with threads") {
     val th = new Thread(new Runnable {
       def run() {
-        var filtered = client.filter(resp.uast.get, "//QualifiedName[@roleExpression]")
+        var filtered = rootNode.filter("//QualifiedName[@roleExpression]")
         assert(filtered.length == 3)
       }
     })
@@ -63,56 +76,56 @@ class BblfshClientTest extends FunSuite with BeforeAndAfter {
   }
 
   test("XPath filter properties") {
-    val filtered = client.filter(resp.uast.get, "//*[@internalRole='types']");
+    val filtered = rootNode.filter("//*[@internalRole='types']");
     assert(filtered.length == 1)
-    val filteredNeg = client.filter(resp.uast.get, "//*[@internalRole='foo']");
+    val filteredNeg = rootNode.filter("//*[@internalRole='foo']");
     assert(filteredNeg.length == 0)
   }
 
   test("Xpath filter StartOffset") {
-    val filtered = client.filter(resp.uast.get, "//*[@startOffset='24']");
+    val filtered = rootNode.filter("//*[@startOffset='24']");
     assert(filtered.length == 1)
-    val filteredNeg = client.filter(resp.uast.get, "//*[@startOffset='44']");
+    val filteredNeg = rootNode.filter("//*[@startOffset='44']");
     assert(filteredNeg.length == 0)
   }
 
   test("Xpath filter StartLine") {
-    val filtered = client.filter(resp.uast.get, "//*[@startLine='1']");
+    val filtered = rootNode.filter("//*[@startLine='1']");
     assert(filtered.length == 17)
-    val filteredNeg = client.filter(resp.uast.get, "//*[@startLine='100']");
+    val filteredNeg = rootNode.filter("//*[@startLine='100']");
     assert(filteredNeg.length == 0)
   }
 
   test("Xpath filter StartCol") {
-    val filtered = client.filter(resp.uast.get, "//*[@startCol='25']");
+    val filtered = rootNode.filter("//*[@startCol='25']");
     assert(filtered.length == 1)
-    val filteredNeg = client.filter(resp.uast.get, "//*[@startCol='999']");
+    val filteredNeg = rootNode.filter("//*[@startCol='999']");
     assert(filteredNeg.length == 0)
   }
 
   test("Xpath filter EndOffset") {
-    val filtered = client.filter(resp.uast.get, "//*[@endOffset='44']");
+    val filtered = rootNode.filter("//*[@endOffset='44']");
     assert(filtered.length == 1)
-    val filteredNeg = client.filter(resp.uast.get, "//*[@endOffset='999']");
+    val filteredNeg = rootNode.filter("//*[@endOffset='999']");
     assert(filteredNeg.length == 0)
   }
 
   test("Xpath filter EndLine") {
-    val filtered = client.filter(resp.uast.get, "//*[@endLine='1']");
+    val filtered = rootNode.filter("//*[@endLine='1']");
     assert(filtered.length == 16)
-    val filteredNeg = client.filter(resp.uast.get, "//*[@endLine='100']");
+    val filteredNeg = rootNode.filter("//*[@endLine='100']");
     assert(filteredNeg.length == 0)
   }
 
   test("Xpath filter EndCol") {
-    val filtered = client.filter(resp.uast.get, "//*[@endCol='45']");
+    val filtered = rootNode.filter("//*[@endCol='45']");
     assert(filtered.length == 1)
-    val filteredNeg = client.filter(resp.uast.get, "//*[@endCol='999']");
+    val filteredNeg = rootNode.filter("//*[@endCol='999']");
     assert(filteredNeg.length == 0)
   }
 
   test("Get the start position") {
-    val childWithPos = resp.uast.get.children(1)
+    val childWithPos = rootNode.children(1)
     val startPos = childWithPos.startPosition
     assert(!startPos.isEmpty)
     assert(startPos.get.offset == 24)
@@ -121,7 +134,7 @@ class BblfshClientTest extends FunSuite with BeforeAndAfter {
   }
 
   test("Get the end position") {
-    val childWithPos = resp.uast.get.children(1).children.head
+    val childWithPos = rootNode.children(1).children.head
     val endPos = childWithPos.endPosition
     assert(!endPos.isEmpty)
     assert(endPos.get.offset == 44)