Merge pull request #161 from allanrenucci/xml

Disable Xml Rewrite in pattern position

Author: olafurpg

build.sbt

@@ -221,7 +221,7 @@ lazy val testkit = project
 
 lazy val testsDeps = List(
   // integration property tests
-  "org.renucci"        %% "scala-xml-quote"    % "0.1.3",
+  "org.renucci"        %% "scala-xml-quote"    % "0.1.4",
   "org.typelevel"      %% "catalysts-platform" % "0.0.5",
   "com.typesafe.slick" %% "slick"              % "3.2.0-M2",
   "com.chuusai"        %% "shapeless"          % "2.3.2",

scalafix-core/src/main/scala/scalafix/rewrite/RemoveXmlLiterals.scala

@@ -3,7 +3,7 @@ package rewrite
 
 import scala.meta._
 
-/** Rewrite Xml Literal to Xml Interpolator
+/** Rewrite Xml Literal to Xml Interpolator.
   *
   * e.g.
   * {{{
@@ -13,20 +13,16 @@ import scala.meta._
   *   // after:
   *   xml"<div>${ "Hello" }</div>"
   * }}}
+  *
+  * This only rewrites xml literals in expression position:
+  * Xml patterns will not be supported by the xml interpolator,
+  * until we know how to rewrite `case <a>{ns @ _*}</a>`.
   */
 case object RemoveXmlLiterals extends Rewrite {
 
   override def rewrite(ctx: RewriteCtx): Patch = {
-    object Xml {
-      def unapply(tree: Tree): Option[Seq[Lit]] =
-        tree match {
-          case Pat.Xml(parts, _) => Some(parts)
-          case Term.Xml(parts, _) => Some(parts)
-          case _ => None
-        }
-    }
 
-    def isMultiLine(xml: Tree) =
+    def isMultiLine(xml: Term.Xml) =
       xml.pos.start.line != xml.pos.end.line
 
     /** Contains '"' or '\' */
@@ -36,7 +32,7 @@ case object RemoveXmlLiterals extends Rewrite {
     }
 
     /** Rewrite xml literal to interpolator */
-    def patchXml(xml: Tree, tripleQuoted: Boolean) = {
+    def patchXml(xml: Term.Xml, tripleQuoted: Boolean) = {
 
       // We don't want to patch inner xml literals multiple times
       def removeSplices(tokens: Tokens) = {
@@ -54,16 +50,20 @@ case object RemoveXmlLiterals extends Rewrite {
         }
       }
 
-      /** Substitute {{ by { */
+      /** Substitute {{ by { and }} by } */
       def patchEscapedBraces(tok: Token.Xml.Part) = {
         ctx.reporter.warn(
-          """Single opening braces don't need be escaped with {{ inside the xml interpolator,
-            |unlike xml literals. For example <x>{{</x> is identical to xml"<x>{</x>".
-            |This Rewrite will replace all occurrences of {{. Make sure this is intended.
+          """Single braces don't need be escaped with {{ and }} inside the xml interpolator, unlike xml literals.
+            |For example <x>{{</x> is identical to xml"<x>{</x>".
+            |This Rewrite will replace all occurrences of {{ and }} . Make sure this is intended.
           """.stripMargin,
           tok.pos
         )
-        ctx.replaceToken(tok, tok.value.replaceAllLiterally("{{", "{"))
+
+        val patched = tok.value
+          .replaceAllLiterally("{{", "{")
+          .replaceAllLiterally("}}", "}")
+        ctx.replaceToken(tok, patched)
       }
 
       removeSplices(xml.tokens).collect {
@@ -86,7 +86,7 @@ case object RemoveXmlLiterals extends Rewrite {
           var patch = Patch.empty
           if (part.contains('$'))
             patch += ctx.replaceToken(tok, part.replaceAllLiterally("$", "$$"))
-          if (part.contains("{{"))
+          if (part.contains("{{") || part.contains("}}"))
             patch += patchEscapedBraces(tok)
           patch
 
@@ -108,7 +108,7 @@ case object RemoveXmlLiterals extends Rewrite {
     }
 
     val patch = ctx.tree.collect {
-      case xml @ Xml(parts) =>
+      case xml @ Term.Xml(parts, _) =>
         val tripleQuoted = isMultiLine(xml) || parts.exists(
           containsEscapeSequence)
         patchXml(xml, tripleQuoted)

scalafix-tests/input/src/main/scala/test/RemoveXmlLiterals.scala

@@ -45,15 +45,21 @@ class RemoveXmlLiterals {
   }
 
   object I {
-    <div>{{</div>
+    val a = <div>{{</div>
+    val b = <div>}}</div>
+    // <div b="{{"/> >>> xml"""<div b="{{"/>"""
   }
 
   object J {
-    <div b="{{"/>
+    <a>{1}{2}</a>
   }
 
   object K {
-    <a>{1}{2}</a>
+    null match { case <a></a> => }
+  }
+
+  object L {
+    null match { case <a>{_*}</a> => }
   }
 
 }

scalafix-tests/output/src/main/scala/test/RemoveXmlLiterals.scala

@@ -43,15 +43,21 @@ class RemoveXmlLiterals {
   }
 
   object I {
-    xml"<div>{</div>"
+    val a = xml"<div>{</div>"
+    val b = xml"<div>}</div>"
+    // <div b="{{"/> >>> xml"""<div b="{{"/>"""
   }
 
   object J {
-    xml"""<div b="{"/>"""
+    xml"<a>${1}${2}</a>"
   }
 
   object K {
-    xml"<a>${1}${2}</a>"
+    null match { case <a></a> => }
+  }
+
+  object L {
+    null match { case <a>{_*}</a> => }
   }
 
 }