Skip to content

Rewrite collection.{Map, Set}.+ and collection.Set.- #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Rewrite collection.{Map, Set}.+ and collection.Set.- #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions scalafix/input/src/main/scala/fix/SetMapSrc.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,22 @@ rule = "scala:fix.Scalacollectioncompat_newcollections"
*/
package fix

class SetMapSrc(set: Set[Int], map: Map[Int, Int]) {
set + (2, 3)
map + (2 -> 3, 3 -> 4)
(set + (2, 3)).map(x => x)
set + (2, 3) - 4
map.mapValues(_ + 1)
}
import scala.collection
import scala.collection.immutable
import scala.collection.mutable.{Map, Set} // Challenge to make sure the scoping is correct

class SetMapSrc(iset: immutable.Set[Int],
cset: collection.Set[Int],
imap: immutable.Map[Int, Int],
cmap: collection.Map[Int, Int]) {
iset + (2, 3)
imap + (2 -> 3, 3 -> 4)
(iset + (2, 3)).toString
iset + (2, 3) - 4
imap.mapValues(_ + 1)
iset + 1
iset - 2
cset + 1
cset - 2
cmap + (2 -> 3) + ((4, 5))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add the following test case?

- imap + (2 -> 3) + ((4, 5))
+ imap + (2 -> 3) + ((4, 5))

}
24 changes: 18 additions & 6 deletions scalafix/output/src/main/scala/fix/SetMapSrc.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,22 @@

package fix

class SetMapSrc(set: Set[Int], map: Map[Int, Int]) {
set + 2 + 3
map + (2 -> 3) + (3 -> 4)
(set + 2 + 3).map(x => x)
set + 2 + 3 - 4
map.mapValues(_ + 1).toMap
import scala.collection
import scala.collection.immutable
import scala.collection.mutable.{Map, Set} // Challenge to make sure the scoping is correct

class SetMapSrc(iset: immutable.Set[Int],
cset: collection.Set[Int],
imap: immutable.Map[Int, Int],
cmap: collection.Map[Int, Int]) {
iset + 2 + 3
imap + (2 -> 3) + (3 -> 4)
(iset + 2 + 3).toString
iset + 2 + 3 - 4
imap.mapValues(_ + 1).toMap
iset + 1
iset - 2
cset ++ _root_.scala.collection.Set(1)
cset -- _root_.scala.collection.Set(2)
cmap ++ _root_.scala.collection.Map(2 -> 3) ++ _root_.scala.collection.Map((4, 5))
}
66 changes: 64 additions & 2 deletions scalafix/rules/src/main/scala/fix/Scalacollectioncompat_newcollections.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,24 @@ import scala.meta._
case class Scalacollectioncompat_newcollections(index: SemanticdbIndex)
extends SemanticRule(index, "Scalacollectioncompat_newcollections") {

// WARNING: TOTAL HACK
// this is only to unblock us until Term.tpe is available: https://github.com/scalameta/scalameta/issues/1212
// if we have a simple identifier, we can look at his definition at query it's type
// this should be improved in future version of scalameta
object TypeMatcher {
def apply(symbols: Symbol*)(implicit index: SemanticdbIndex): TypeMatcher =
new TypeMatcher(symbols: _*)(index)
}

final class TypeMatcher(symbols: Symbol*)(implicit index: SemanticdbIndex) {
def unapply(tree: Tree): Boolean = {
index.denotation(tree)
.exists(_.names.headOption.exists(n => symbols.exists(_ == n.symbol)))
}
}

val CollectionSet: TypeMatcher = TypeMatcher(Symbol("_root_.scala.collection.Set#"))

def replaceSymbols(ctx: RuleCtx): Patch = {
ctx.replaceSymbols(
"scala.collection.LinearSeq" -> "scala.collection.immutable.List",
Expand All @@ -30,6 +48,18 @@ case class Scalacollectioncompat_newcollections(index: SemanticdbIndex)
Symbol("_root_.scala.runtime.Tuple2Zipped.Ops.zipped."),
Symbol("_root_.scala.runtime.Tuple3Zipped.Ops.zipped.")
)
val setPlus =
SymbolMatcher.exact(
Symbol("_root_.scala.collection.SetLike#`+`(Ljava/lang/Object;)Lscala/collection/Set;.")
)
val setMinus =
SymbolMatcher.exact(
Symbol("_root_.scala.collection.SetLike#`-`(Ljava/lang/Object;)Lscala/collection/Set;.")
)
val mapPlus =
SymbolMatcher.exact(
Symbol("_root_.scala.collection.MapLike#`+`(Lscala/Tuple2;)Lscala/collection/Map;.")
)
val setPlus2 = SymbolMatcher.exact(
Symbol("_root_.scala.collection.SetLike#`+`(Ljava/lang/Object;Ljava/lang/Object;Lscala/collection/Seq;)Lscala/collection/Set;.")
)
Expand Down Expand Up @@ -82,6 +112,9 @@ case class Scalacollectioncompat_newcollections(index: SemanticdbIndex)
Symbol("_root_.scala.collection.mutable.ArrayBuilder.make(Lscala/reflect/ClassTag;)Lscala/collection/mutable/ArrayBuilder;.")
)

def startsWithParens(tree: Tree): Boolean =
tree.tokens.headOption.map(_.is[Token.LeftParen]).getOrElse(false)

def replaceMutableSet(ctx: RuleCtx) =
ctx.tree.collect {
case retainSet(n: Name) =>
Expand Down Expand Up @@ -192,7 +225,7 @@ case class Scalacollectioncompat_newcollections(index: SemanticdbIndex)
def replaceSetMapPlus2(ctx: RuleCtx): Patch = {
def rewritePlus(ap: Term.ApplyInfix, lhs: Term, op: Term.Name, rhs1: Term, rhs2: Term): Patch = {
val tokensToReplace =
if(ap.tokens.headOption.map(_.is[Token.LeftParen]).getOrElse(false)) {
if(startsWithParens(ap)) {
// don't drop surrounding parens
ap.tokens.slice(1, ap.tokens.size - 1)
} else ap.tokens
Expand All @@ -217,6 +250,34 @@ case class Scalacollectioncompat_newcollections(index: SemanticdbIndex)
}.asPatch
}

def replaceSetMapPlusMinus(ctx: RuleCtx): Patch = {
def rewriteOp(op: Tree, rhs: Tree, doubleOp: String, col0: String): Patch = {
val col = "_root_.scala.collection." + col0
val callSite =
if (startsWithParens(rhs)) {
ctx.addLeft(rhs, col)
}
else {
ctx.addLeft(rhs, col + "(") +
ctx.addRight(rhs, ")")
}

ctx.addRight(op, doubleOp) + callSite
}

ctx.tree.collect {
case Term.ApplyInfix(CollectionSet(), op @ setPlus(_), Nil, List(rhs)) =>
rewriteOp(op, rhs, "+", "Set")

case Term.ApplyInfix(CollectionSet(), op @ setMinus(_), Nil, List(rhs)) =>
rewriteOp(op, rhs, "-", "Set")

case Term.ApplyInfix(_, op @ mapPlus(_), Nil, List(rhs)) =>
rewriteOp(op, rhs, "+", "Map")
}.asPatch
}


def replaceMutSetMapPlus(ctx: RuleCtx): Patch = {
def rewriteMutPlus(lhs: Term, op: Term.Name): Patch = {
ctx.addRight(lhs, ".clone()") +
Expand Down Expand Up @@ -265,7 +326,7 @@ case class Scalacollectioncompat_newcollections(index: SemanticdbIndex)
ctx.addRight(ap, ".toMap")
}.asPatch
}

override def fix(ctx: RuleCtx): Patch = {
replaceToList(ctx) +
replaceSymbols(ctx) +
Expand All @@ -276,6 +337,7 @@ case class Scalacollectioncompat_newcollections(index: SemanticdbIndex)
replaceMutableSet(ctx) +
replaceSymbolicFold(ctx) +
replaceSetMapPlus2(ctx) +
replaceSetMapPlusMinus(ctx) +
replaceMutSetMapPlus(ctx) +
replaceMutMapUpdated(ctx) +
replaceIterableSameElements(ctx) +
Expand Down