#44 - add Vtype-def-position feature (#115)

* add Vtype-def-position option, guarded by a test suite * add filterConfigurations to dependencyUpdates, as suggested in this thread: ben-manes/gradle-versions-plugin#816 upgrade a gradle plugin
tek · Oct 12, 2023 · 7fe1ec1 · 7fe1ec1
1 parent 140e6e9
commit 7fe1ec1
Show file tree

Hide file tree

Showing 8 changed files with 148 additions and 32 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,5 +1,8 @@
 import org.gradle.util.internal.VersionNumber
 
+import com.github.benmanes.gradle.versions.updates.DependencyUpdatesTask
+import org.gradle.api.specs.Spec
+
 val vs = versions()
 
 buildscript {
@@ -13,6 +16,12 @@ buildscript {
     }
 }
 
+tasks.named<DependencyUpdatesTask>("dependencyUpdates").configure {
+    filterConfigurations = Spec<Configuration> {
+        !it.name.startsWith("incrementalScalaAnalysis")
+    }
+}
+
 plugins {
     `java-test-fixtures`
 
@@ -24,7 +33,7 @@ plugins {
     `maven-publish`
     id("io.github.gradle-nexus.publish-plugin") version "1.3.0"
 
-    id("com.github.ben-manes.versions") version "0.44.0"
+    id("com.github.ben-manes.versions") version "0.49.0"
 }
 
 val sonatypeApiUser = providers.gradleProperty("sonatypeApiUser")

diff --git a/core/src/main/scala-2.13.7+/latest/splain/SplainFormattingExtension.scala b/core/src/main/scala-2.13.7+/latest/splain/SplainFormattingExtension.scala
@@ -493,44 +493,62 @@ trait SplainFormattingExtension extends typechecker.splain.SplainFormatting with
     }
   }
 
+  case class DefPosition(
+      element: Formatted,
+      msg: String
+  ) extends Based {
+
+    def index(): Unit = {
+
+      if (pluginSettings.showTypeDefPosition)
+        Based += FormattedIndex(element) -> this
+    }
+
+    override protected def formattedHeader_Body(break: Boolean): (String, Seq[TypeRepr]) = {
+
+      s"(defined at)" -> Seq(BrokenType(List(msg)))
+    }
+  }
+
   def formatTypeRaw(tpe: Type, top: Boolean): Formatted = {
     formatWithInfix(tpe, extractArgs(tpe), top)(formatType)
   }
 
   override def formatTypeImpl(tpe: Type, top: Boolean): Formatted = {
 
-    if (pluginSettings.TypeDiffsDetail.disambiguation) {
+    tpe.typeArgs match {
+      case List(t1, t2) =>
+        val result =
+          if (pluginSettings.TypeDiffsDetail.disambiguation) {
+
+            withDisambiguation(Nil, t1, t2) {
+              formatTypeImplNoDisambiguation(tpe, top)
+            }
+          } else {
 
-      tpe.typeArgs match {
-        case List(t1, t2) =>
-          val result = withDisambiguation(Nil, t1, t2) {
             formatTypeImplNoDisambiguation(tpe, top)
           }
 
-          result match {
-            case Infix(ii, left, right, _) =>
-              val noApparentDiff = (left == right) && (t1 != t2)
-
-              if (noApparentDiff || pluginSettings.TypeDiffsDetail.builtInMsgAlways) {
+        result match {
+          case Infix(ii, left, right, _) =>
+            val noApparentDiff = (left == right) && (t1 != t2)
 
-                BuiltInDiffMsg(
-                  result,
-                  TypeDiffView(t1, t2).builtInDiffMsg,
-                  Some(ii)
-                ).index()
-              }
-            case _ =>
-          }
+            if (noApparentDiff || pluginSettings.TypeDiffsDetail.builtInMsgAlways) {
 
-          result
-        case _ =>
-          formatTypeImplNoDisambiguation(tpe, top)
-      }
-
-    } else {
+              BuiltInDiffMsg(
+                result,
+                TypeDiffView(t1, t2).builtInDiffMsg,
+                Some(ii)
+              ).index()
+            }
+          case _ =>
+        }
 
-      formatTypeImplNoDisambiguation(tpe, top)
+        result
+      case _ =>
+        formatTypeImplNoDisambiguation(tpe, top)
     }
+
   }
 
   protected def formatTypeImplNoDisambiguation(tpe: Type, top: Boolean): Formatted = {
@@ -548,6 +566,13 @@ trait SplainFormattingExtension extends typechecker.splain.SplainFormatting with
 
     val result = results.last
 
+    TypeView(tpe).defPositionOpt.foreach { v =>
+      DefPosition(
+        result,
+        v.shortText
+      ).index()
+    }
+
     result
   }
 

diff --git a/core/src/main/scala-2.13.7+/latest/splain/TyperCompatViews.scala b/core/src/main/scala-2.13.7+/latest/splain/TyperCompatViews.scala
@@ -1,5 +1,7 @@
 package splain
 
+import scala.reflect.internal.util.{NoSourceFile, Position}
+
 trait TyperCompatViews {
   self: SplainAnalyzer =>
 
@@ -66,26 +68,48 @@ trait TyperCompatViews {
       }
     }
 
+    object _DefPosition {
+
+      lazy val value: Position = definingSymbol.pos
+
+      lazy val noSource: Boolean = value.source == NoSourceFile
+
+      lazy val shortText: String = {
+
+        val prefix = value.source.file.path + ":"
+
+        val result = s"$prefix${value.line}:${value.column}"
+        result
+      }
+
+      lazy val formattedText: String = {
+
+        Position.formatMessage(value, "", shortenFile = false)
+      }
+    }
+
+    def defPositionOpt: Option[_DefPosition.type] = Option(_DefPosition).filterNot(_.noSource)
+
     def typeToString: String = {
 
-      val detailLvl = pluginSettings.typeDetail
+      val typeDetail = pluginSettings.typeDetail
 
       def short = self.safeToString
+
       def long = scala.util.Try(self.toLongString).getOrElse(short)
 
       def maybeContext = scala.util.Try(existentialContext(self)).toOption
 
       def maybeAlias = scala.util.Try(explainAlias(self)).toOption
 
-      detailLvl match {
+      typeDetail match {
         case i if i <= 1 => short
         case 2 => long
         case 3 =>
           (Seq(long) ++ maybeContext).mkString("")
 
         case i if i >= 4 =>
           (Seq(long) ++ maybeContext ++ maybeAlias).mkString("")
-
       }
     }
   }

diff --git a/core/src/main/scala/splain/PluginSettings.scala b/core/src/main/scala/splain/PluginSettings.scala
@@ -40,6 +40,8 @@ case class PluginSettings(pluginOpts: mutable.Map[String, String]) {
 
   def showTypeReduction: Boolean = boolean(PluginSettings.Key.typeReduction)
 
+  def showTypeDefPosition: Boolean = boolean(PluginSettings.Key.typeDefPosition)
+
   def typeDiffsDetail: Int = int(PluginSettings.Key.typeDiffsDetail)
 
   object TypeDiffsDetail {
@@ -66,6 +68,8 @@ object PluginSettings {
 
     val typeReduction = "Vtype-reduction"
 
+    val typeDefPosition = "Vtype-def-position"
+
     val typeDetail = "Vtype-detail"
 
     val typeDiffsDetail = "Vtype-diffs-detail"
@@ -79,6 +83,7 @@ object PluginSettings {
     Key.implicitDiverging -> "false",
     Key.implicitDivergingMaxDepth -> "100",
     Key.typeReduction -> "false",
+    Key.typeDefPosition -> "false",
     Key.typeDetail -> "1",
     Key.typeDiffsDetail -> "1",
     Key.debug -> "false"

diff --git a/core/src/test/resources/splain/plugin/VTypeDefPositionSpec/__direct/check b/core/src/test/resources/splain/plugin/VTypeDefPositionSpec/__direct/check
@@ -0,0 +1,20 @@
+newSource1.scala:12: error: implicit error;
+!I e: Diff.e1.VV =:= String
+  Cannot prove that Diff.e1.VV =:= String.
+
+  implicitly[e1.VV =:= String]
+            ^
+newSource1.scala:13: error: type mismatch;
+  String|Diff.e1.VV
+  val x: e1.VV = ??? : String
+                     ^
+newSource1.scala:12: error: implicit error;
+!I e: Diff.e1.VV (defined at) { newSource1.scala:9:10 } =:= String
+  Cannot prove that Diff.e1.VV =:= String.
+
+  implicitly[e1.VV =:= String]
+            ^
+newSource1.scala:13: error: type mismatch;
+  String|Diff.e1.VV (defined at) { newSource1.scala:9:10 }
+  val x: e1.VV = ??? : String
+                     ^
diff --git a/core/src/test/scala/splain/plugin/VTypeDefPositionSpec.scala b/core/src/test/scala/splain/plugin/VTypeDefPositionSpec.scala
@@ -0,0 +1,31 @@
+package splain.plugin
+
+import splain.SpecBase
+
+class VTypeDefPositionSpec extends SpecBase.Direct {
+
+  final val diff =
+    """
+object Diff {
+  class Example {
+
+    type VV
+  }
+
+  val e1 = new Example {
+
+    type VV <: Int
+  }
+
+  implicitly[e1.VV =:= String]
+  val x: e1.VV = ??? : String
+}
+  """
+
+  describe("#44") {
+
+    check(diff, numberOfErrors = 2)
+
+    check(diff, profile = "-P:splain:Vtype-def-position", numberOfErrors = 2)
+  }
+}
diff --git a/core/src/testFixtures/scala/splain/TestHelpers.scala b/core/src/testFixtures/scala/splain/TestHelpers.scala
@@ -3,7 +3,7 @@ package splain
 import org.scalatest.exceptions.TestFailedException
 import org.scalatest.{Assertion, Suite}
 import org.slf4j.LoggerFactory
-import splain.test.TryCompile
+import splain.test.{Issue, TryCompile}
 
 import java.nio.file.{FileSystems, Files, Path, Paths}
 import java.util.concurrent.atomic.AtomicInteger
@@ -197,7 +197,7 @@ trait TestHelpers extends Suite {
   case class DirectRunner() {
 
     case class ParseGroundTruths(
-        startsWith: String = "newSource1.scala:",
+        startsWith: String = Issue.defaultSrcName,
         fName: Option[String] = None
     ) {
 
@@ -208,9 +208,11 @@ trait TestHelpers extends Suite {
       }
 
       lazy val cases: Seq[String] = {
+        val regex = s"(^|\n)$startsWith"
+
         val result = raw
           .split(
-            startsWith
+            regex
           )
           .toSeq
           .filter(_.nonEmpty)

diff --git a/dev/gradle-versions.sh b/dev/gradle-versions.sh
@@ -7,4 +7,4 @@ FWDIR="$(
 
 ${FWDIR}/gradlew wrapper --gradle-version=8.4
 
-${FWDIR}/gradlew dependencyUpdates
+${FWDIR}/gradlew dependencyUpdates "$@"