Merge pull request #121 from MasseGuillaume/simplify-cross-compile

Simplify cross-compilation for scalafix output

Author: julienrf

CONTRIBUTING.md

@@ -6,17 +6,17 @@
 
 - `compat` project: implementation of the compatibility library ;
 - `scalafix*`: implementation of the migration tool.
+- `binary-compat`: preserve binary compatibility when using the compat library on 2.12
 
 ## Migration tool
 
 Several levels of contribution are possible!
 
 ### Report a missing case
 
-Create an issue tagged with the
-[migration](https://github.com/scala/collection-strawman/labels/migration) label.
+Create an issue [scala-collection-compat/issues](https://github.com/scala/scala-collection-compat/issues).
 Embrace `diff`s to describe differences between the standard collections and
-the strawman:
+the new collection:
 
 ~~~ diff
 - xs.toIterator
@@ -33,18 +33,18 @@ Even better, instead of providing a diff, you can directly add it as a test case
    that uses the standard collections:
 
 ~~~ scala
-class toIteratorVsIterator(xs: Iterable[Int]) {
+class ToIteratorVsIteratorSrc(xs: Iterable[Int]) {
   xs.toIterator
 }
 ~~~
 
 3. Add a corresponding file in the `scalafix/output/src/main/scala/fix/` directory
-   with the same code but using the strawman:
+   with the same code but using the new collection:
 
 ~~~ scala
 import scala.collection.compat._
 
-class toIteratorVsIterator(xs: Iterable[Int]) {
+class ToIteratorVsIteratorSrc(xs: Iterable[Int]) {
   xs.iterator
 }
 ~~~
@@ -63,55 +63,35 @@ Then maybe someone will take over and implement your use case… or maybe you wi
 Even better, complete the migration tool implementation to support the missing case!
 
 After you have added the missing case (see previous section), run the following
-sbt task (with sbt started from the `scalafix/` directory) to run the
-migration tool on the input files and check whether the result matches the
+sbt task to run the migration tool on the input files and check whether the result matches the
 expected output files:
 
 ~~~
 > scalafix-tests/test
 ~~~
 
-Fix the implementation of the rule (in the
-`rules/src/main/scala/fix/NewCollections.scala` file) until the
+Fix the implementation of the rule (in the `rules/src/main/scala/fix/NewCollections.scala` file) until the
 tests are green. You can find more help about the scalafix API in its
 [documentation](https://scalacenter.github.io/scalafix/docs/rule-authors/setup).
 
 
 ### Scalafix Teskit Directory Layout
 
+
 ```
-.
-├── data                    |
-│   └── src                 |
-│       └── main            |
-│           └── scala       | Project to avoid duplicating code between input and output
-├── input                   |
-│   └── src                 |
-│       └── main            |
-│           ├── scala       | Input that cross-compile
-│           └── scala-2.12  | 2.12 specific input
-├── output                  |
-│   └── src                 |
-│       └── main            |
-│           └── scala       | Output that cross-compile
-├── output212               |
-│   └── src                 |
-│       └── main            |
-│           └── scala-2.12  | 2.12 specific output
-├── output213               |
-│   └── src                 |
-│       └── main            |
-│           └── scala       | 2.13 specific output (from a cross-compiled input)
-├── output213-failure       |
-│   └── src                 |
-│       └── main            |
-│           └── scala       | 2.13 specific output that cannot be migrated due to technical limitations
-├── rules                   |
-│   └── src                 |
-│       └── main            |
-│           └── scala       | Rule implementations
-└── tests                   |
-    └── src                 |
-        └── test            |
-            └── scala       | Scalafix testkit launcher (useful to run a single input file)
++------------------+-----+-----------------+
+|                  |Input|     Output      |
+|                  | 2.12| 2.11| 2.12| 2.13|
++------------------+-----+-----+-----+-----+
+|data              |  X  |  X  |  X  |  X  |
+|input             |  X  |     |     |     |
+|output            |     |  X  |  X  |  X  |
+|output212         |     |     |  X  |     |
+|output212+        |     |     |  X  |  X  |
+|output213         |     |     |     |  X  |
+|output213-failure |     |     |     |  X  |
++------------------+-----+-----+-----+-----+
+
+rules: Rule implementations
+tests: Scalafix testkit launcher (useful to run a single input file)
 ```

build.sbt

@@ -183,14 +183,29 @@ val `scalafix-output` = MultiScalaProject("scalafix-output", "scalafix/output",
 lazy val output212 = Def.setting((baseDirectory in ThisBuild).value / "scalafix/output212/src/main")
 lazy val addOutput212 = unmanagedSourceDirectories in Compile += output212.value / "scala"
 
+lazy val output212Plus = Def.setting((baseDirectory in ThisBuild).value / "scalafix/output212+/src/main")
+lazy val addOutput212Plus = unmanagedSourceDirectories in Compile += output212Plus.value / "scala"
+
 lazy val output213 = Def.setting((baseDirectory in ThisBuild).value / "scalafix/output213/src/main")
 lazy val addOutput213 = unmanagedSourceDirectories in Compile += output213.value / "scala"
 
-lazy val `scalafix-output211` = `scalafix-output`(scala211, _.dependsOn(`scalafix-data211`))
-lazy val `scalafix-output212` = `scalafix-output`(scala212, _.settings(addOutput212).dependsOn(`scalafix-data212`))
+lazy val `scalafix-output211` = `scalafix-output`(
+  scala211,
+  _.dependsOn(`scalafix-data211`)
+)
+
+
+lazy val `scalafix-output212` = `scalafix-output`(
+  scala212,
+  _.settings(addOutput212)
+   .settings(addOutput212Plus)
+   .dependsOn(`scalafix-data212`)
+)
+
 lazy val `scalafix-output213` = `scalafix-output`(
   scala213,
   _.settings(addOutput213)
+   .settings(addOutput212Plus)
    .settings(scala213Settings)
    .dependsOn(`scalafix-data213`)
 )
@@ -213,7 +228,9 @@ lazy val `scalafix-tests` = project
       "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,
+      "output212PlusSourceroot"    -> output212Plus.value,
       "output213FailureSourceroot" -> sourceDirectory.in(`scalafix-output213-failure`, Compile).value,
       "inputClassdirectory"        -> classDirectory.in(`scalafix-input`, Compile).value
     ),

project/MultiScalaProject.scala

@@ -40,6 +40,13 @@ trait MultiScala {
         (baseDirectory in ThisBuild).value / base / "src" / "main" / "scala",
       unmanagedSourceDirectories in Compile +=
         (baseDirectory in ThisBuild).value / base / "src" / "main" / ("scala-" + scalaBinaryVersion.value),
+      unmanagedSourceDirectories in Compile ++= {
+        val sourceDir = (baseDirectory in ThisBuild).value / base / "src" / "main"
+        CrossVersion.partialVersion(scalaVersion.value) match {
+          case Some((2, n)) if n >= 12 => List(sourceDir / "scala-2.12+")
+          case _                       => Nil
+        }
+      },
       unmanagedSourceDirectories in Test +=
         (baseDirectory in ThisBuild).value / base / "src" / "test" / "scala",
       unmanagedResourceDirectories in Compile +=

scalafix/input/src/main/scala-2.12/fix/BreakoutSrc212.scala renamed to scalafix/input/src/main/scala/fix/BreakoutSrc212Plus.scala

@@ -6,7 +6,7 @@ package fix
 import scala.collection.mutable
 import scala.collection.breakOut
 
-object BreakoutSrc212 {
+object BreakoutSrc212Plus {
   List(1 -> "1").map(x => x)(breakOut): mutable.SortedMap[Int, String]
   List(1 -> "1").map(x => x)(breakOut): mutable.TreeMap[Int, String]
 }

scalafix/input/src/main/scala/fix/CanBuildFromNegSrc.scala renamed to scalafix/input/src/main/scala/fix/CanBuildFromNegSrc213Failure.scala

@@ -7,7 +7,7 @@ import scala.language.higherKinds
 
 import collection.generic.CanBuildFrom
 
-class CanBuildFromNegSrc() {
+object CanBuildFromNegSrc213Failure {
 
   // negative test
   def g[C0, A, C1[_]](c0: C0)(implicit cbf3: CanBuildFrom[C0, A, C1[A]]): C1[A] = {

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

@@ -7,7 +7,7 @@ import scala.language.higherKinds
 
 import collection.generic.CanBuildFrom
 
-class CanBuildFromSrc() {
+object CanBuildFromSrc {
 
   def f[C0, A, C1[_]](c0: C0)(implicit
       cbf: CanBuildFrom[Nothing, Int, C1[Int]],

scalafix/input/src/main/scala/fix/CompanionSrc.scala renamed to scalafix/input/src/main/scala/fix/CompanionSrc212.scala

@@ -6,7 +6,7 @@ package fix
 import scala.collection.{immutable => i, mutable => m}
 import scala.{collection => c}
 
-object CompanionSrc {
+object CompanionSrc212 {
 
   (null: c.IndexedSeq[Int]).companion
   (null: c.Iterable[Int]).companion

scalafix/input/src/main/scala/fix/RetainSrc.scala renamed to scalafix/input/src/main/scala/fix/RetainSrc213.scala

@@ -5,7 +5,7 @@ package fix
 
 import scala.collection.mutable.{Map, Set}
 
-class MethodRenames(xs: Map[Int, Int], ys: Set[Int]) {
+class RetainSrc213(xs: Map[Int, Int], ys: Set[Int]) {
   xs.retain((_, _) => true)
   xs.retain{case (x, y) => true}
   ys.retain(_ => true)

scalafix/input/src/main/scala/fix/Roughly212Src.scala renamed to scalafix/input/src/main/scala/fix/RoughlySrc.scala

@@ -10,7 +10,7 @@ package fix
 import scala.{collection => c}
 import scala.collection.{immutable => i, mutable => m}
 
-object Roughly212Src {
+object RoughlySrc {
 
   def id[T](x: T): T = x
   def f[T](x: T): Boolean = true

scalafix/input/src/main/scala/fix/Roughly213Src.scala renamed to scalafix/input/src/main/scala/fix/RoughlySrc213.scala

@@ -7,7 +7,7 @@ Roughly = {
  */
 package fix
 
-class Roughly213Src() {
+object RoughlySrc213 {
   val s = Stream(1, 2, 3)
   s.append(List(4, 5, 6))
   1 #:: 2 #:: 3 #:: Stream.Empty

scalafix/input/src/main/scala-2.12/fix/SortedSrc212.scala renamed to scalafix/input/src/main/scala/fix/SortedSrc212Plus.scala

@@ -5,7 +5,7 @@ package fix
 
 import scala.collection.{mutable => m}
 
-object SortedSrc212 {
+object SortedSrc212Plus {
   m.SortedMap(1 -> 1).from(0)
   m.TreeMap(1 -> 1).from(0)
   m.SortedMap(1 -> 1).to(0)

scalafix/input/src/main/scala/fix/TupleNZippedSrc.scala renamed to scalafix/input/src/main/scala/fix/TupleNZippedSrc213.scala

@@ -4,7 +4,7 @@ rule = "scala:fix.NewCollections"
 package fix
 
 import scala.language.postfixOps
-object Collectionstrawman_v0_Tuple2Zipped {
+object Tuple2ZippedSrc213 {
   def zipped(xs: List[Int], ys: List[Int]): Unit = {
     (xs, ys).zipped
     (xs,ys).zipped
@@ -19,7 +19,7 @@ object Collectionstrawman_v0_Tuple2Zipped {
   def coll(x: Int): List[Int] = ???
 }
 
-object Collectionstrawman_v0_Tuple3Zipped {
+object Tuple3ZippedSrc213 {
   def zipped(xs: List[Int], ys: List[Int], zs: List[Int]): Unit = {
     (xs, ys, zs).zipped
     (xs,ys,zs).zipped

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

@@ -7,7 +7,7 @@ import scala.language.higherKinds
 
 import scala.collection.compat._
 
-class CanBuildFromSrc() {
+object CanBuildFromSrc {
 
   def f[C0, A, C1[_]](c0: C0)(implicit
       cbf: Factory[Int, C1[Int]],

scalafix/output/src/main/scala/fix/Roughly212Src.scala renamed to scalafix/output/src/main/scala/fix/RoughlySrc.scala

@@ -6,7 +6,7 @@ package fix
 import scala.{collection => c}
 import scala.collection.{immutable => i, mutable => m}
 
-object Roughly212Src {
+object RoughlySrc {
 
   def id[T](x: T): T = x
   def f[T](x: T): Boolean = true

scalafix/output212/src/main/scala-2.12/fix/BreakoutSrc212.scala renamed to scalafix/output212+/src/main/scala/fix/BreakoutSrc212Plus.scala

@@ -6,7 +6,7 @@ package fix
 import scala.collection.mutable
 import scala.collection.compat._
 
-object BreakoutSrc212 {
+object BreakoutSrc212Plus {
   scala.collection.mutable.SortedMap.from(List(1 -> "1").iterator.map(x => x)): mutable.SortedMap[Int, String]
   scala.collection.mutable.TreeMap.from(List(1 -> "1").iterator.map(x => x)): mutable.TreeMap[Int, String]
 }

scalafix/output212/src/main/scala-2.12/fix/SortedSrc212.scala renamed to scalafix/output212+/src/main/scala/fix/SortedSrc212Plus.scala

@@ -6,7 +6,7 @@ package fix
 import scala.collection.{mutable => m}
 import scala.collection.compat._
 
-object SortedSrc212 {
+object SortedSrc212Plus {
   m.SortedMap(1 -> 1).rangeFrom(0)
   m.TreeMap(1 -> 1).rangeFrom(0)
   m.SortedMap(1 -> 1).rangeTo(0)

scalafix/output212/src/main/scala/fix/CompanionSrc.scala renamed to scalafix/output212/src/main/scala/fix/CompanionSrc212.scala

@@ -7,7 +7,7 @@ import scala.collection.{immutable => i, mutable => m}
 import scala.{collection => c}
 import scala.collection.compat._
 
-object CompanionSrc {
+object CompanionSrc212 {
 
   (null: c.IndexedSeq[Int]).iterableFactory
   (null: c.Iterable[Int]).iterableFactory

scalafix/output213-failure/src/main/scala/fix/CanBuildFromNegSrc.scala renamed to scalafix/output213-failure/src/main/scala/fix/CanBuildFromNegSrc213Failure.scala

@@ -7,7 +7,7 @@ import scala.language.higherKinds
 
 import collection.generic.CanBuildFrom
 
-class CanBuildFromNegSrc() {
+object CanBuildFromNegSrc213Failure {
 
   // negative test
   def g[C0, A, C1[_]](c0: C0)(implicit cbf3: CanBuildFrom[C0, A, C1[A]]): C1[A] = {

scalafix/output213/src/main/scala/fix/RetainSrc.scala renamed to scalafix/output213/src/main/scala/fix/RetainSrc213.scala

@@ -5,7 +5,7 @@ package fix
 
 import scala.collection.mutable.{Map, Set}
 
-class MethodRenames(xs: Map[Int, Int], ys: Set[Int]) {
+class RetainSrc213(xs: Map[Int, Int], ys: Set[Int]) {
   xs.filterInPlace{case (_, _) => true}
   xs.filterInPlace{case (x, y) => true}
   ys.filterInPlace(_ => true)

scalafix/output213/src/main/scala/fix/Roughly213Src.scala renamed to scalafix/output213/src/main/scala/fix/RoughlySrc213.scala

@@ -3,7 +3,7 @@
 
 package fix
 
-class Roughly213Src() {
+object RoughlySrc213 {
   val s = LazyList(1, 2, 3)
   s.lazyAppendedAll(List(4, 5, 6))
   1 #:: 2 #:: 3 #:: LazyList.Empty

scalafix/output213/src/main/scala/fix/TupleNZippedSrc.scala renamed to scalafix/output213/src/main/scala/fix/TupleNZippedSrc213.scala

@@ -4,7 +4,7 @@
 package fix
 
 import scala.language.postfixOps
-object Collectionstrawman_v0_Tuple2Zipped {
+object Tuple2ZippedSrc213 {
   def zipped(xs: List[Int], ys: List[Int]): Unit = {
     xs.lazyZip(ys)
     xs.lazyZip(ys)
@@ -19,7 +19,7 @@ object Collectionstrawman_v0_Tuple2Zipped {
   def coll(x: Int): List[Int] = ???
 }
 
-object Collectionstrawman_v0_Tuple3Zipped {
+object Tuple3ZippedSrc213 {
   def zipped(xs: List[Int], ys: List[Int], zs: List[Int]): Unit = {
     xs.lazyZip(ys).lazyZip(zs)
     xs.lazyZip(ys).lazyZip(zs)

scalafix/tests/src/test/scala/fix/ScalafixTests.scala

@@ -12,6 +12,7 @@ class ScalafixTests
       AbsolutePath(BuildInfo.outputSourceroot),
       AbsolutePath(BuildInfo.output212Sourceroot),
       AbsolutePath(BuildInfo.output213Sourceroot),
+      AbsolutePath(BuildInfo.output212PlusSourceroot),
       AbsolutePath(BuildInfo.output213FailureSourceroot)
     )
   ) {