Merge pull request #154 from MasseGuillaume/scalafix-0.6

Scalafix 0.6

Author: julienrf

.travis.yml

@@ -76,7 +76,9 @@ matrix:
 # |  oraclejdk8 | 2.13.0-M5 | js           | 0.6.23               |               |
 # |  oraclejdk8 | 2.12.6    | jvm          |                      |   true        |
 
-before_script: ./checkCLA.sh
+before_script:
+  - admin/checkCLA.sh
+
 script:
   - java -version
   - sbt ci

README.md

@@ -8,10 +8,10 @@ This library provides some of the new APIs from Scala 2.13 to Scala 2.11 and 2.1
 To use this library, add the following to your build.sbt:
 
 ```
-libraryDependencies += "org.scala-lang.modules" %% "scala-collection-compat" % "0.2.0"
+libraryDependencies += "org.scala-lang.modules" %% "scala-collection-compat" % "0.2.1"
 ```
 
-Version 0.2.0 is compatible with Scala 2.13.0-M5. For Scala 2.13.0-M4 you should use version 0.1.1.
+Version 0.2.1 is compatible with Scala 2.13.0-M5. For Scala 2.13.0-M4 you should use version 0.1.1.
 
 Note that there are multiple ways to cross-build projects, see https://github.com/scala/collection-strawman/wiki/FAQ#how-do-i-cross-build-my-project-against-scala-212-and-scala-213.
 
@@ -34,17 +34,48 @@ With this compatibility library you can also use the 2.13 syntax which uses a co
 The 2.13 version consists only of an empty `scala.collection.compat` package object that allows you to write `import scala.collection.compat._` in 2.13.
 The 2.11/2.12 version has the compatibility extensions in this package.
 
-
 The library also adds backported versions of new collection types, currently `scala.collection.compat.immutable.ArraySeq`. In 2.11/2.12, this type is a new collection implementation. In 2.13, it is an alias for `scala.collection.immutable.ArraySeq`.
 
 ## Migration Tool
 
-A tool is being developed to automatically migrate code that uses the standard
-collection to use the strawman.
+We created two migration rules: 
+
+* `Collection213Upgrade` For upgrading applications (like web server, etc) from 2.11/2.12 to 2.13
+* `Collection213CrossCompat` For library that wants to cross compile to 2.11, 2.12 and 2.13
+
+```scala
+// project/plugins.sbt
+
+addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.7.0-RC1")
+```
+
+```scala
+// build.sbt or project/Build.scala
 
-To use it, add the [scalafix](https://scalacenter.github.io/scalafix/) sbt plugin
-to your build, as explained in
-[its documentation](https://scalacenter.github.io/scalafix/#Installation).
+// If you are using project/Build.scala add the following imports:
+import scalafix.sbt.ScalafixPlugin.autoImport.{scalafixDependencies, scalafixSemanticdb}
+
+val collectionCompatVersion = "0.2.1"
+val collectionCompat = "org.scala-lang.modules" %% "scala-collection-compat" % collectionCompatVersion
+
+libraryDependencies += collectionCompat // required for Collection213CrossCompat
+addCompilerPlugin(scalafixSemanticdb)
+scalacOptions ++= List(
+  "-Yrangepos",
+  "-Ywarn-unused-import",
+  "-P:semanticdb:synthetics:on"
+)
+
+scalafixDependencies in ThisBuild += "org.scala-lang.modules" %% "scala-collection-migrations" % Dependencies.collectionCompatVersion
+```
+
+Then run:
+
+```bash
+> ;scalafix Collection213Upgrade ;test:scalafix Collection213Upgrade # For Applications
+# or
+> ;scalafix Collection213CrossCompat ;test:scalafix Collection213CrossCompat # For Libraries
+```
 
 The migration tool is not exhaustive and we will continue to improve
 it over time. If you encounter a use case that’s not supported, please

checkCLA.sh renamed to admin/checkCLA.sh

@@ -1,6 +1,6 @@
 import ScalaModulePlugin._
 import sbtcrossproject.{crossProject, CrossType}
-import _root_.scalafix.Versions.{version => scalafixVersion, scala212 => scalafixScala212}
+import _root_.scalafix.sbt.BuildInfo.{scalafixVersion, scala212 => scalafixScala212}
 
 lazy val root = project
   .in(file("."))
@@ -157,10 +157,16 @@ lazy val sharedScalafixSettings = Seq(
 )
 
 // common part between input/output
-lazy val `scalafix-data` = MultiScalaProject("scalafix-data",
-                                             "scalafix/data",
-                                             _.settings(sharedScalafixSettings)
-                                               .settings(dontPublish))
+lazy val `scalafix-data` = MultiScalaProject(
+  "scalafix-data",
+  "scalafix/data",
+  _.settings(sharedScalafixSettings)
+    .settings(dontPublish)
+    .settings(
+      addCompilerPlugin(scalafixSemanticdb),
+      scalacOptions += "-P:semanticdb:synthetics:on"
+    )
+)
 
 val `scalafix-data211` = `scalafix-data`(scala211, _.dependsOn(compat211JVM))
 val `scalafix-data212` = `scalafix-data`(scalafixScala212, _.dependsOn(compat212JVM))
@@ -173,7 +179,11 @@ lazy val `scalafix-input` = project
   .settings(dontPublish)
   .settings(
     scalaVersion := scalafixScala212,
-    scalafixSourceroot := sourceDirectory.in(Compile).value
+    addCompilerPlugin(scalafixSemanticdb),
+    scalacOptions ++= Seq(
+      "-Yrangepos",
+      "-P:semanticdb:synthetics:on"
+    )
   )
   .dependsOn(`scalafix-data212`)
 
@@ -183,15 +193,20 @@ val `scalafix-output` = MultiScalaProject("scalafix-output",
                                             .settings(dontPublish)
                                             .disablePlugins(ScalafixPlugin))
 
-lazy val output212    = Def.setting((baseDirectory in ThisBuild).value / "scalafix/output212/src/main")
-lazy val addOutput212 = unmanagedSourceDirectories in Compile += output212.value / "scala"
+lazy val outputCross =
+  Def.setting((baseDirectory in ThisBuild).value / "scalafix/output/src/main/scala")
+
+lazy val output212 =
+  Def.setting((baseDirectory in ThisBuild).value / "scalafix/output212/src/main/scala")
+lazy val addOutput212 = unmanagedSourceDirectories in Compile += output212.value
 
 lazy val output212Plus =
-  Def.setting((baseDirectory in ThisBuild).value / "scalafix/output212+/src/main")
-lazy val addOutput212Plus = unmanagedSourceDirectories in Compile += output212Plus.value / "scala"
+  Def.setting((baseDirectory in ThisBuild).value / "scalafix/output212+/src/main/scala")
+lazy val addOutput212Plus = unmanagedSourceDirectories in Compile += output212Plus.value
 
-lazy val output213    = Def.setting((baseDirectory in ThisBuild).value / "scalafix/output213/src/main")
-lazy val addOutput213 = unmanagedSourceDirectories in Compile += output213.value / "scala"
+lazy val output213 =
+  Def.setting((baseDirectory in ThisBuild).value / "scalafix/output213/src/main/scala")
+lazy val addOutput213 = unmanagedSourceDirectories in Compile += output213.value
 
 lazy val `scalafix-output211` = `scalafix-output`(
   scala211,
@@ -226,28 +241,15 @@ lazy val `scalafix-tests` = project
   .settings(
     scalaVersion := scalafixScala212,
     libraryDependencies += "ch.epfl.scala" % "scalafix-testkit" % scalafixVersion % Test cross CrossVersion.full,
-    buildInfoPackage := "build",
-    buildInfoKeys := Seq[BuildInfoKey](
-      "inputSourceroot"         -> sourceDirectory.in(`scalafix-input`, Compile).value,
-      "outputSourceroot"        -> (baseDirectory in ThisBuild).value / "scalafix/output/src/main",
-      "output212Sourceroot"     -> output212.value,
-      "output212PlusSourceroot" -> output212Plus.value,
-      "output213Sourceroot"     -> output213.value,
-      "output213FailureSourceroot" -> sourceDirectory
-        .in(`scalafix-output213-failure`, Compile)
-        .value,
-      "inputClassdirectory" -> classDirectory.in(`scalafix-input`, Compile).value
-    ),
-    test in Test := (test in Test)
-      .dependsOn(
-        compile in (`scalafix-output211`, Compile),
-        compile in (`scalafix-output212`, Compile),
-        compile in (`scalafix-output213`, Compile)
-      )
-      .value
+    scalafixTestkitOutputSourceDirectories := Seq(outputCross.value,
+                                                  output212.value,
+                                                  output212Plus.value,
+                                                  output213.value),
+    scalafixTestkitInputSourceDirectories := sourceDirectories.in(`scalafix-input`, Compile).value,
+    scalafixTestkitInputClasspath := fullClasspath.in(`scalafix-input`, Compile).value
   )
   .dependsOn(`scalafix-input`, `scalafix-rules`)
-  .enablePlugins(BuildInfoPlugin)
+  .enablePlugins(BuildInfoPlugin, ScalafixTestkitPlugin)
 
 lazy val dontPublish = Seq(
   publishArtifact := false,

build.sbt

@@ -8,9 +8,9 @@ else
 val scalaJSVersion = Option(System.getenv("SCALAJS_VERSION")).filter(_.nonEmpty).getOrElse("0.6.25")
 
 addSbtPlugin("org.scala-js"           % "sbt-scalajs"              % scalaJSVersion)
-addSbtPlugin("org.portable-scala"     % "sbt-scalajs-crossproject" % "0.5.0")
+addSbtPlugin("org.portable-scala"     % "sbt-scalajs-crossproject" % "0.6.0")
 addSbtPlugin("org.scala-lang.modules" % "sbt-scala-module"         % "1.0.14")
-addSbtPlugin("ch.epfl.scala"          % "sbt-scalafix"             % "0.5.10")
+addSbtPlugin("ch.epfl.scala"          % "sbt-scalafix"             % "0.7.0-RC1")
 addSbtPlugin("com.eed3si9n"           % "sbt-buildinfo"            % "0.7.0")
 addSbtPlugin("com.typesafe.sbt"       % "sbt-pgp"                  % "0.8.3")
 

project/plugins.sbt

@@ -1,5 +1,5 @@
 /*
-rule = "scala:fix.CrossCompat"
+rule = "Collection213CrossCompat"
  */
 package fix
 
@@ -103,4 +103,9 @@ class BreakoutSrc(ts: Traversable[Int], vec: Vector[Int], list: List[Int], seq:
   List(1 -> "1").map(x => x)(breakOut): immutable.IntMap[String]
   List(1L -> "1").map(x => x)(breakOut): immutable.LongMap[String]
   List(1L -> "1").map(x => x)(breakOut): mutable.LongMap[String]
+  List(1).map(x => x)(breakOut): collection.BitSet
+
+
+  List(1).map(x => x)(collection.breakOut): Vector[Int]
+  List(1).map(x => x)(collection.breakOut): immutable.SortedSet[Int]
 }

scalafix/input/src/main/scala/fix/BreakoutSrc.scala

@@ -1,5 +1,5 @@
 /*
-rule = "scala:fix.CrossCompat"
+rule = "Collection213CrossCompat"
  */
 package fix
 

scalafix/input/src/main/scala/fix/BreakoutSrc212Plus.scala

@@ -1,5 +1,5 @@
 /*
-rule = "scala:fix.CrossCompat"
+rule = "Collection213CrossCompat"
  */
 package fix
 

scalafix/input/src/main/scala/fix/CanBuildFromNegSrc213Failure.scala

@@ -1,10 +1,11 @@
 /*
-rule = "scala:fix.CrossCompat"
+rule = "Collection213CrossCompat"
  */
 package fix
 
 import scala.language.higherKinds
 
+import scala.collection.immutable
 import collection.generic.CanBuildFrom
 
 object CanBuildFromSrc {
@@ -37,6 +38,9 @@ object CanBuildFromSrc {
   def f2[T, That](implicit cbf: CanBuildFrom[Nothing, T, That]): Foo[T, That] =
     new Foo
 
+  def f3[T, That](implicit cbf: CanBuildFrom[Nothing, T, That with immutable.Traversable[_]]): Foo[T, That] =
+    new Foo
+
   class Foo[T, That](implicit cbf: CanBuildFrom[Nothing, T, That]) {
     val b = cbf()
   }

scalafix/input/src/main/scala/fix/CanBuildFromSrc.scala

@@ -1,42 +1,42 @@
 /*
-rule = "scala:fix.CrossCompat"
+rule = "Collection213CrossCompat"
  */
 package fix
 
-import scala.collection.immutable
-import scala.collection.mutable
+import scala.{collection => c}
+import scala.collection.{immutable => i, mutable => m}
 
 object CompanionSrc {
 
-  (null: collection.IndexedSeq[Int]).companion
-  (null: collection.Iterable[Int]).companion
-  (null: collection.Seq[Int]).companion
-  (null: collection.Traversable[Int]).companion
+  (null: c.IndexedSeq[Int]).companion
+  (null: c.Iterable[Int]).companion
+  (null: c.Seq[Int]).companion
+  (null: c.Traversable[Int]).companion
 
-  (null: immutable.HashSet[Int]).companion
-  (null: immutable.IndexedSeq[Int]).companion
-  (null: immutable.Iterable[Int]).companion
-  (null: immutable.LinearSeq[Int]).companion
-  (null: immutable.List[Int]).companion
-  (null: immutable.ListSet[Int]).companion
-  (null: immutable.Queue[Int]).companion
-  (null: immutable.Seq[Int]).companion
-  (null: immutable.Set[Int]).companion
-  (null: immutable.Stream[Int]).companion
-  (null: immutable.Traversable[Int]).companion
-  (null: immutable.Vector[Int]).companion
+  (null: i.HashSet[Int]).companion
+  (null: i.IndexedSeq[Int]).companion
+  (null: i.Iterable[Int]).companion
+  (null: i.LinearSeq[Int]).companion
+  (null: i.List[Int]).companion
+  (null: i.ListSet[Int]).companion
+  (null: i.Queue[Int]).companion
+  (null: i.Seq[Int]).companion
+  (null: i.Set[Int]).companion
+  (null: i.Stream[Int]).companion
+  (null: i.Traversable[Int]).companion
+  (null: i.Vector[Int]).companion
 
-  (null: mutable.ArrayBuffer[Int]).companion
-  (null: mutable.ArraySeq[Int]).companion
-  (null: mutable.ArrayStack[Int]).companion
-  (null: mutable.Buffer[Int]).companion
-  (null: mutable.HashSet[Int]).companion
-  (null: mutable.IndexedSeq[Int]).companion
-  (null: mutable.Iterable[Int]).companion
-  (null: mutable.LinearSeq[Int]).companion
-  (null: mutable.LinkedHashSet[Int]).companion
-  (null: mutable.Queue[Int]).companion
-  (null: mutable.Seq[Int]).companion
-  (null: mutable.Set[Int]).companion
-  (null: mutable.Traversable[Int]).companion
+  (null: m.ArrayBuffer[Int]).companion
+  (null: m.ArraySeq[Int]).companion
+  (null: m.ArrayStack[Int]).companion
+  (null: m.Buffer[Int]).companion
+  (null: m.HashSet[Int]).companion
+  (null: m.IndexedSeq[Int]).companion
+  (null: m.Iterable[Int]).companion
+  (null: m.LinearSeq[Int]).companion
+  (null: m.LinkedHashSet[Int]).companion
+  (null: m.Queue[Int]).companion
+  (null: m.Seq[Int]).companion
+  (null: m.Set[Int]).companion
+  (null: m.Traversable[Int]).companion
 }