path: root/test/scaladoc/run/implicits-base.scala

import scala.tools.nsc.doc.model._
import scala.tools.partest.ScaladocModelTest
import language._

object Test extends ScaladocModelTest {

  // test a file instead of a piece of code
  override def resourceFile = "implicits-base-res.scala"

  // start implicits
  def scaladocSettings = "-implicits -implicits-show-all"

  def testModel(root: Package) = {
    // get the quick access implicit defs in scope (_package(s), _class(es), _trait(s), object(s) _method(s), _value(s))
    import access._

    def isShadowed(mbr: MemberEntity): Boolean =
      mbr.byConversion.map(_.source.implicitsShadowing.get(mbr).map(_.isShadowed).getOrElse(false)).getOrElse(false)

    // SEE THE test/resources/implicits-base-res.scala FOR THE EXPLANATION OF WHAT'S CHECKED HERE:
    val base = root._package("scala")._package("test")._package("scaladoc")._package("implicits")._package("base")
    var conv: ImplicitConversion = null

//// class A ///////////////////////////////////////////////////////////////////////////////////////////////////////////

    val A = base._class("A")

    // def convToPimpedA(x: T)                // pimpA0: with no constraints, SHADOWED
    conv = A._conversion(A.qualifiedName + ".pimpA0")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(isShadowed(conv._member("convToPimpedA")))
    assert(conv._member("convToPimpedA").resultType.name == "T")

    // def convToNumericA: T               // pimpA1: with a constraint that there is x: Numeric[T] implicit in scope
    conv = A._conversion(A.qualifiedName + ".pimpA1")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 1)
    assert(conv._member("convToNumericA").resultType.name == "T")

    // def convToIntA: Int                 // pimpA2: with a constraint that T = Int
    conv = A._conversion(A.qualifiedName + ".pimpA2")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 1)
    assert(conv._member("convToIntA").resultType.name == "Int")

    // def convToGtColonDoubleA: Double    // pimpA3: with a constraint that T <: Double
    conv = A._conversion(A.qualifiedName + ".pimpA3")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 1)
    assert(conv._member("convToGtColonDoubleA").resultType.name == "Double")

    // def convToPimpedA: S                // pimpA4: with 3 constraints: T = Foo[Bar[S]], S: Foo and S: Bar
    conv = A._conversion(A.qualifiedName + ".pimpA4")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 3)
    assert(conv._member("convToPimpedA").resultType.name == "S")

    // def convToPimpedA: Bar[Foo[T]]      // pimpA5: no constraints
    conv = A._conversion(A.qualifiedName + ".pimpA5")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(isShadowed(conv._member("convToPimpedA")))
    assert(conv._member("convToPimpedA").resultType.name == "Bar[Foo[T]]")

    // def convToMyNumericA: T             // pimpA6: with a constraint that there is x: MyNumeric[T] implicit in scope
    conv = A._conversion(A.qualifiedName + ".pimpA6")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 1)
    assert(conv._member("convToMyNumericA").resultType.name == "T")

    // def convToManifestA: T              // pimpA7: with 2 constraints: T: Manifest and T <: Double
    // def convToTraversableOps: T         // pimpA7: with 2 constraints: T: Manifest and T <: Double
                                           // should not be abstract!
    conv = A._conversion(A.qualifiedName + ".pimpA7")
    assert(conv.members.length == 2)
    assert(conv.constraints.length == 2)
    assert(conv._member("convToManifestA").resultType.name == "T")
    assert(conv._member("convToTraversableOps").resultType.name == "T")
    assert(conv._member("convToTraversableOps").flags.toString.indexOf("abstract") == -1)

//// class B ///////////////////////////////////////////////////////////////////////////////////////////////////////////

    val B = base._class("B")

    // these conversions should not affect B
    assert(B._conversions(A.qualifiedName + ".pimpA2").isEmpty)
    assert(B._conversions(A.qualifiedName + ".pimpA4").isEmpty)

    // def convToPimpedA(x: Double)           // pimpA0: no constraints, SHADOWED
    conv = B._conversion(A.qualifiedName + ".pimpA0")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(isShadowed(conv._member("convToPimpedA")))
    assert(conv._member("convToPimpedA").resultType.name == "Double")

    // def convToNumericA: Double          // pimpA1: no constraintsd
    conv = B._conversion(A.qualifiedName + ".pimpA1")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(conv._member("convToNumericA").resultType.name == "Double")

    // def convToGtColonDoubleA: Double    // pimpA3: no constraints
    conv = B._conversion(A.qualifiedName + ".pimpA3")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(conv._member("convToGtColonDoubleA").resultType.name == "Double")

    // def convToPimpedA: Bar[Foo[Double]] // pimpA5: no constraints
    conv = B._conversion(A.qualifiedName + ".pimpA5")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(isShadowed(conv._member("convToPimpedA")))
    assert(conv._member("convToPimpedA").resultType.name == "Bar[Foo[Double]]")

    // def convToMyNumericA: Double        // pimpA6: (if showAll is set) with a constraint that there is x: MyNumeric[Double] implicit in scope
    conv = B._conversion(A.qualifiedName + ".pimpA6")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 1)
    assert(conv._member("convToMyNumericA").resultType.name == "Double")

    // def convToManifestA: Double         // pimpA7: no constraints
    // def convToTraversableOps: Double    // pimpA7: no constraints
    //                                     // should not be abstract!
    conv = B._conversion(A.qualifiedName + ".pimpA7")
    assert(conv.members.length == 2)
    assert(conv.constraints.length == 0)
    assert(conv._member("convToManifestA").resultType.name == "Double")
    assert(conv._member("convToTraversableOps").resultType.name == "Double")
    assert(conv._member("convToTraversableOps").flags.toString.indexOf("abstract") == -1)

//// class C ///////////////////////////////////////////////////////////////////////////////////////////////////////////

    val C = base._class("C")

    // these conversions should not affect C
    assert(C._conversions(A.qualifiedName + ".pimpA3").isEmpty)
    assert(C._conversions(A.qualifiedName + ".pimpA4").isEmpty)
    assert(C._conversions(A.qualifiedName + ".pimpA7").isEmpty)

    // def convToPimpedA(x: Int)           // pimpA0: no constraints, SHADOWED
    conv = C._conversion(A.qualifiedName + ".pimpA0")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(isShadowed(conv._member("convToPimpedA")))
    assert(conv._member("convToPimpedA").resultType.name == "Int")

    // def convToNumericA: Int             // pimpA1: no constraints
    conv = C._conversion(A.qualifiedName + ".pimpA1")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(conv._member("convToNumericA").resultType.name == "Int")

    // def convToIntA: Int                 // pimpA2: no constraints
    conv = C._conversion(A.qualifiedName + ".pimpA2")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(conv._member("convToIntA").resultType.name == "Int")

    // def convToPimpedA: Bar[Foo[Int]]    // pimpA5: no constraints
    conv = C._conversion(A.qualifiedName + ".pimpA5")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(isShadowed(conv._member("convToPimpedA")))
    assert(conv._member("convToPimpedA").resultType.name == "Bar[Foo[Int]]")

    // def convToMyNumericA: Int           // pimpA6: (if showAll is set) with a constraint that there is x: MyNumeric[Int] implicit in scope
    conv = C._conversion(A.qualifiedName + ".pimpA6")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 1)
    assert(conv._member("convToMyNumericA").resultType.name == "Int")

//// class D ///////////////////////////////////////////////////////////////////////////////////////////////////////////

    val D = base._class("D")

    // these conversions should not affect D
    assert(D._conversions(A.qualifiedName + ".pimpA2").isEmpty)
    assert(D._conversions(A.qualifiedName + ".pimpA3").isEmpty)
    assert(D._conversions(A.qualifiedName + ".pimpA4").isEmpty)
    assert(D._conversions(A.qualifiedName + ".pimpA7").isEmpty)

    // def convToPimpedA(x: String)        // pimpA0: no constraints, SHADOWED
    conv = D._conversion(A.qualifiedName + ".pimpA0")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(isShadowed(conv._member("convToPimpedA")))
    assert(conv._member("convToPimpedA").resultType.name == "String")

    // def convToNumericA: String          // pimpA1: (if showAll is set) with a constraint that there is x: Numeric[String] implicit in scope
    conv = D._conversion(A.qualifiedName + ".pimpA1")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 1)
    assert(conv._member("convToNumericA").resultType.name == "String")

    // def convToPimpedA: Bar[Foo[String]] // pimpA5: no constraints
    conv = D._conversion(A.qualifiedName + ".pimpA5")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 0)
    assert(isShadowed(conv._member("convToPimpedA")))
    assert(conv._member("convToPimpedA").resultType.name == "Bar[Foo[String]]")

    // def convToMyNumericA: String        // pimpA6: (if showAll is set) with a constraint that there is x: MyNumeric[String] implicit in scope
    conv = D._conversion(A.qualifiedName + ".pimpA6")
    assert(conv.members.length == 1)
    assert(conv.constraints.length == 1)
    assert(conv._member("convToMyNumericA").resultType.name == "String")
  }
}