Merge pull request #814 from olafurpg/inspect

Inline scalameta-structure into repo

Author: olafurpg

scalafix-core/src/main/scala/scalafix/internal/util/Inspect.scala

@@ -0,0 +1,85 @@
+package scalafix.internal.util
+
+import scala.meta.Tree
+import scala.meta._
+import org.typelevel.paiges._
+
+object Inspect {
+
+  def prettyList(tree: List[Tree], showFieldNames: Boolean): Doc = {
+    wrapList(tree.map(t => prettyTree(t, showFieldNames)))
+  }
+
+  def prettyOption(tree: Option[Tree], showFieldNames: Boolean): Doc = {
+    wrapOption(tree.map(t => prettyTree(t, showFieldNames)))
+  }
+
+  def prettyTree(tree: Tree, showFieldNames: Boolean): Doc = {
+    tree match {
+      case _ if tree.tokens.isEmpty =>
+        Doc.empty
+      case v: Term.Name =>
+        Doc.text(v.structure)
+      case t: Type.Name =>
+        Doc.text(t.structure)
+      case _ =>
+        val args = tree.productFields.zip(tree.productIterator.toList).map {
+          case (fieldName, value) =>
+            val rhs = value match {
+              case v: Term.Name => Doc.text(v.structure)
+              case t: Tree => prettyTree(t, showFieldNames)
+              case o: Option[_] =>
+                o match {
+                  case Some(t: Tree) =>
+                    wrap(
+                      Doc.text("Some") + Doc.char('('),
+                      List(prettyTree(t, showFieldNames)),
+                      Doc.char(')')
+                    )
+                  case None =>
+                    Doc.text("None")
+                  case _ =>
+                    throw new Exception("cannot handle: " + o)
+                }
+              case vs: List[_] =>
+                vs match {
+                  case Nil => Doc.text("Nil")
+                  case (_: Tree) :: _ =>
+                    prettyList(vs.asInstanceOf[List[Tree]], showFieldNames)
+                  case (_: List[_]) :: _ =>
+                    val vsT = vs.asInstanceOf[List[List[Tree]]]
+                    wrapList(vsT.map(v => prettyList(v, showFieldNames)))
+                  case _ =>
+                    throw new IllegalArgumentException("cannot handle: " + vs)
+                }
+              case _ => Doc.text(value.toString)
+            }
+
+            if (showFieldNames) Doc.text(fieldName) + Doc.text(" = ") + rhs
+            else rhs
+        }
+
+        wrap(Doc.text(tree.productPrefix) + Doc.char('('), args, Doc.char(')'))
+    }
+  }
+
+  private def wrapList(args: List[Doc]): Doc = {
+    if (args.nonEmpty) {
+      wrap(Doc.text("List") + Doc.char('('), args, Doc.char(')'))
+    } else {
+      Doc.text("Nil")
+    }
+  }
+
+  private def wrapOption(opt: Option[Doc]): Doc = {
+    opt match {
+      case Some(doc) => Doc.text("Some") + Doc.char('(') + doc + Doc.char(')')
+      case None => Doc.text("None")
+    }
+  }
+
+  private def wrap(prefix: Doc, args: List[Doc], suffix: Doc): Doc = {
+    val body = Doc.intercalate(Doc.char(',') + Doc.line, args)
+    body.tightBracketBy(prefix, suffix)
+  }
+}

scalafix-core/src/main/scala/scalafix/util/Api.scala

@@ -1,5 +1,8 @@
 package scalafix.util
 
+import scala.meta.Tree
+import scalafix.internal.util.Inspect
+
 trait Api {
 
   type RuleName = scalafix.rule.RuleName
@@ -22,4 +25,25 @@ trait Api {
   type CustomMessage[T] = scalafix.config.CustomMessage[T]
   val CustomMessage = scalafix.config.CustomMessage
 
+  implicit class XtensionScalafixTreeInspect(tree: Tree) {
+    def inspect: String =
+      Inspect.prettyTree(tree, showFieldNames = false).render(1)
+    def inspectLabeled: String =
+      Inspect.prettyTree(tree, showFieldNames = true).render(1)
+  }
+
+  implicit class XtensionScalafixOptionTreeInspect(tree: Option[Tree]) {
+    def inspect: String =
+      Inspect.prettyOption(tree, showFieldNames = false).render(1)
+    def inspectLabeled: String =
+      Inspect.prettyOption(tree, showFieldNames = true).render(1)
+  }
+
+  implicit class XtensionScalafixListTreeInspect(tree: List[Tree]) {
+    def inspect: String =
+      Inspect.prettyList(tree, showFieldNames = false).render(1)
+    def inspectLabeled: String =
+      Inspect.prettyList(tree, showFieldNames = true).render(1)
+  }
+
 }

scalafix-tests/unit/src/test/scala/scalafix/tests/util/InspectSuite.scala

@@ -0,0 +1,59 @@
+package scalafix.tests.util
+
+import scala.meta._
+import org.scalatest.FunSuite
+import scalafix.testkit.DiffAssertions
+import scalafix.v1._
+
+class InspectSuite extends FunSuite with DiffAssertions {
+  test("pretty(t)") {
+    val obtained = q"a.b.c.d".inspect
+    val expected =
+      """|Term.Select(
+         |  Term.Select(
+         |    Term.Select(
+         |      Term.Name("a"),
+         |      Term.Name("b")
+         |    ),
+         |    Term.Name("c")
+         |  ),
+         |  Term.Name("d")
+         |)""".stripMargin
+    assert(obtained == expected)
+  }
+
+  test("pretty(t, showFieldNames = true)") {
+    val obtained = q"a.b.c.d".inspectLabeled
+    val expected =
+      """|Term.Select(
+         |  qual = Term.Select(
+         |    qual = Term.Select(
+         |      qual = Term.Name("a"),
+         |      name = Term.Name("b")
+         |    ),
+         |    name = Term.Name("c")
+         |  ),
+         |  name = Term.Name("d")
+         |)""".stripMargin
+    assert(obtained == expected)
+  }
+
+  test("option") {
+    assertNoDiff(
+      q"def foo: A = ???".decltpe.inspect,
+      """|
+         |Some(Type.Name("A"))
+         |""".stripMargin
+    )
+  }
+
+  test("list") {
+    assertNoDiff(
+      q"foo(a)".args.inspect,
+      """|List(
+         |  Term.Name("a")
+         |)
+         |""".stripMargin
+    )
+  }
+}