Added in "ExtraMetadata" for CodeReferences and changed CollectedStat…

…Type -> DataType.
square · Sep 4, 2024 · a1da1e1 · a1da1e1
1 parent ce6ebca
commit a1da1e1
Show file tree

Hide file tree

Showing 16 changed files with 194 additions and 136 deletions.
diff --git a/invert-gradle-plugin/src/main/kotlin/com/squareup/invert/ReportOutputConfig.kt b/invert-gradle-plugin/src/main/kotlin/com/squareup/invert/ReportOutputConfig.kt
@@ -0,0 +1,7 @@
+package com.squareup.invert
+
+import java.io.File
+
+data class ReportOutputConfig(
+  val invertReportDirectory: File
+)
diff --git a/invert-gradle-plugin/src/main/kotlin/com/squareup/invert/StatCollector.kt b/invert-gradle-plugin/src/main/kotlin/com/squareup/invert/StatCollector.kt
@@ -1,6 +1,7 @@
 package com.squareup.invert
 
 import org.gradle.api.Named
+import java.io.File
 
 
 /**
@@ -21,6 +22,7 @@ interface StatCollector : Named {
    * Compute [CollectedStat]s with the context of all collected information.
    */
   fun aggregate(
+    reportOutputConfig: ReportOutputConfig,
     invertAllCollectedDataRepo: InvertAllCollectedDataRepo,
-  ): CollectedStatsAggregate = CollectedStatsAggregate(mapOf(), listOf())
-}
+  ): CollectedStatsAggregate? = CollectedStatsAggregate(mapOf(), listOf())
+}
diff --git a/invert-gradle-plugin/src/main/kotlin/com/squareup/invert/internal/CollectedStatAggregator.kt b/invert-gradle-plugin/src/main/kotlin/com/squareup/invert/internal/CollectedStatAggregator.kt
@@ -2,13 +2,15 @@ package com.squareup.invert.internal
 
 import com.squareup.invert.CollectedStatsAggregate
 import com.squareup.invert.InvertAllCollectedDataRepo
+import com.squareup.invert.ReportOutputConfig
 import com.squareup.invert.StatCollector
 import com.squareup.invert.internal.models.CollectedStatsForProject
 import com.squareup.invert.internal.models.InvertCombinedCollectedData
 import com.squareup.invert.models.Stat
 import com.squareup.invert.models.StatKey
 import com.squareup.invert.models.StatMetadata
 import com.squareup.invert.models.js.MetadataJsReportModel
+import java.io.File
 
 object CollectedStatAggregator {
 
@@ -17,19 +19,21 @@ object CollectedStatAggregator {
    */
   fun aggregate(
     allCollectedData: InvertCombinedCollectedData,
+    reportOutputConfig: ReportOutputConfig,
     reportMetadata: MetadataJsReportModel,
     statCollectors: List<StatCollector>?
   ): InvertCombinedCollectedData {
     val statMap: MutableMap<String, CollectedStatsForProject> =
       allCollectedData.collectedStats.associateBy { it.path }.toMutableMap()
     statCollectors?.forEach { statCollector: StatCollector ->
-      val result: CollectedStatsAggregate = statCollector.aggregate(
-        InvertAllCollectedDataRepo(
+      val result: CollectedStatsAggregate? = statCollector.aggregate(
+        reportOutputConfig = reportOutputConfig,
+        invertAllCollectedDataRepo = InvertAllCollectedDataRepo(
           projectMetadata = reportMetadata,
           allCollectedData = allCollectedData
-        )
+        ),
       )
-      result.projectStats.entries.forEach { (gradlePath, stats) ->
+      result?.projectStats?.entries?.forEach { (gradlePath, stats) ->
         val curr: CollectedStatsForProject = statMap[gradlePath] ?: CollectedStatsForProject(
           path = gradlePath,
           statInfos = emptyMap(),

diff --git a/...adle-plugin/src/main/kotlin/com/squareup/invert/internal/report/js/InvertJsReportUtils.kt b/...adle-plugin/src/main/kotlin/com/squareup/invert/internal/report/js/InvertJsReportUtils.kt
@@ -5,8 +5,8 @@ import com.squareup.invert.internal.models.CollectedDependenciesForProject
 import com.squareup.invert.internal.models.CollectedOwnershipForProject
 import com.squareup.invert.internal.models.CollectedPluginsForProject
 import com.squareup.invert.internal.models.CollectedStatsForProject
-import com.squareup.invert.models.CollectedStatType
 import com.squareup.invert.models.ConfigurationName
+import com.squareup.invert.models.DataType
 import com.squareup.invert.models.DependencyId
 import com.squareup.invert.models.GradlePath
 import com.squareup.invert.models.GradlePluginId
@@ -44,10 +44,10 @@ object InvertJsReportUtils {
   fun computeGlobalStats(allProjectsStatsData: StatsJsReportModel): Map<StatMetadata, Int> {
     val globalStats: Map<StatMetadata, Int> = allProjectsStatsData.statInfos.values
       .filter { statInfo ->
-        when (statInfo.statType) {
-          CollectedStatType.BOOLEAN,
-          CollectedStatType.NUMERIC,
-          CollectedStatType.CODE_REFERENCES -> true
+        when (statInfo.dataType) {
+          DataType.BOOLEAN,
+          DataType.NUMERIC,
+          DataType.CODE_REFERENCES -> true
 
           else -> {
             false

diff --git a/invert-gradle-plugin/src/main/kotlin/com/squareup/invert/internal/tasks/InvertTask.kt b/invert-gradle-plugin/src/main/kotlin/com/squareup/invert/internal/tasks/InvertTask.kt
@@ -1,6 +1,7 @@
 package com.squareup.invert.internal.tasks
 
 import com.squareup.invert.InvertExtension
+import com.squareup.invert.ReportOutputConfig
 import com.squareup.invert.StatCollector
 import com.squareup.invert.internal.CollectedStatAggregator
 import com.squareup.invert.internal.InvertFileUtils
@@ -63,6 +64,7 @@ abstract class InvertTask : DefaultTask() {
     val datePatternFormat = "MMMM dd, yyyy[ 'at' HH:mm:ss]"
     val mavenRepoUrls = this.mavenRepoUrls.get()
     runBlocking {
+      val invertReportDir = rootBuildReportsDir.get().asFile
 
       val reportMetadata = ProjectMetadataCollector.gatherProjectMetadata(
         timeZoneId = timeZoneId,
@@ -78,12 +80,15 @@ abstract class InvertTask : DefaultTask() {
       val allCollectedData = CollectedStatAggregator.aggregate(
         allCollectedData = allCollectedDataOrig,
         reportMetadata = reportMetadata,
-        statCollectors = statCollectors
+        statCollectors = statCollectors,
+        reportOutputConfig = ReportOutputConfig(
+          invertReportDirectory = invertReportDir,
+        )
       )
 
       InvertReportWriter(
         invertLogger = invertLogger(),
-        rootBuildReportsDir = rootBuildReportsDir.get().asFile
+        rootBuildReportsDir = invertReportDir,
       ).writeProjectData(
         reportMetadata = reportMetadata,
         collectedOwners = allCollectedData.collectedOwners,

diff --git a/invert-models/build.gradle.kts b/invert-models/build.gradle.kts
@@ -1,24 +1,24 @@
 plugins {
-    kotlin("multiplatform")
-    kotlin("plugin.serialization")
-    alias(libs.plugins.dokka)
-    alias(libs.plugins.vanniktech.maven.publish)
+  kotlin("multiplatform")
+  kotlin("plugin.serialization")
+  alias(libs.plugins.dokka)
+  alias(libs.plugins.vanniktech.maven.publish)
 }
 
 kotlin {
-    js {
-        browser()
-    }
-    jvm {
-        withSourcesJar()
-    }
+  js {
+    browser()
+  }
+  jvm {
+    withSourcesJar()
+  }
 
-    sourceSets {
-        val commonMain by getting {
-            dependencies {
-                api(libs.kotlinx.serialization.core)
-                api(libs.kotlinx.serialization.json)
-            }
-        }
+  sourceSets {
+    val commonMain by getting {
+      dependencies {
+        api(libs.kotlinx.serialization.core)
+        api(libs.kotlinx.serialization.json)
+      }
     }
+  }
 }
diff --git a/invert-models/src/commonMain/kotlin/com/squareup/invert/models/CollectedStatType.kt b/invert-models/src/commonMain/kotlin/com/squareup/invert/models/CollectedStatType.kt
diff --git a/invert-models/src/commonMain/kotlin/com/squareup/invert/models/DataType.kt b/invert-models/src/commonMain/kotlin/com/squareup/invert/models/DataType.kt
@@ -0,0 +1,25 @@
+package com.squareup.invert.models
+
+import kotlinx.serialization.Transient
+import kotlin.reflect.KClass
+
+enum class DataType(
+  @Transient val basicType: Basic?,
+  @Transient val backingType: KClass<*>
+) {
+  BOOLEAN(Basic.BOOLEAN, Boolean::class),
+  NUMERIC(Basic.NUMERIC, Long::class),
+  STRING(Basic.STRING, String::class),
+  CODE_REFERENCES(null, Stat.CodeReferencesStat.CodeReference::class), // EXPLORE (CUSTOM)
+  DI_PROVIDES_AND_INJECTS(null, Stat.DiProvidesAndInjectsStat::class); // EXPLORE (CUSTOM)
+
+  companion object {
+    fun fromString(type: String?): DataType? {
+      return DataType.entries.firstOrNull { it.name == type }
+    }
+  }
+
+  enum class Basic {
+    BOOLEAN, NUMERIC, STRING
+  }
+}
diff --git a/invert-models/src/commonMain/kotlin/com/squareup/invert/models/InvertSerialization.kt b/invert-models/src/commonMain/kotlin/com/squareup/invert/models/InvertSerialization.kt
@@ -13,6 +13,7 @@ object InvertSerialization {
     allowStructuredMapKeys = true
     ignoreUnknownKeys = true
     serializersModule = SerializersModule {
+      // Stat
       polymorphic(
         baseClass = Stat::class,
         actualClass = Stat.BooleanStat::class,

diff --git a/invert-models/src/commonMain/kotlin/com/squareup/invert/models/Stat.kt b/invert-models/src/commonMain/kotlin/com/squareup/invert/models/Stat.kt
@@ -10,80 +10,80 @@ import kotlinx.serialization.Serializable
  */
 sealed interface Stat {
 
-    @Serializable
-    @SerialName("numeric_stat")
-    data class NumericStat(
-        val value: Int,
-        val details: String? = null,
-    ) : Stat
-
-    @Serializable
-    @SerialName("string_stat")
-    data class StringStat(
-        val value: String,
-        val details: String? = null,
-    ) : Stat
+  @Serializable
+  @SerialName("numeric_stat")
+  data class NumericStat(
+    val value: Int,
+    val details: String? = null,
+  ) : Stat
 
-    @Serializable
-    @SerialName("boolean_stat")
-    data class BooleanStat(
-        val value: Boolean,
-        val details: String? = null,
-    ) : Stat
+  @Serializable
+  @SerialName("string_stat")
+  data class StringStat(
+    val value: String,
+    val details: String? = null,
+  ) : Stat
 
-    @Serializable
-    @SerialName("code_reference")
-    data class CodeReferencesStat(
-        val value: List<CodeReference>,
-    ) : Stat {
+  @Serializable
+  @SerialName("boolean_stat")
+  data class BooleanStat(
+    val value: Boolean,
+    val details: String? = null,
+  ) : Stat
 
-        @Serializable
-        data class CodeReference(
-            val filePath: String,
-            val startLine: Int,
-            val endLine: Int,
-            val code: String? = null
-        )
-    }
+  @Serializable
+  @SerialName("code_reference")
+  data class CodeReferencesStat(
+    val value: List<CodeReference>,
+  ) : Stat {
 
+    @Serializable
+    data class CodeReference(
+      val filePath: String,
+      val startLine: Int,
+      val endLine: Int,
+      val code: String? = null,
+      val extras: Map<ExtraKey, String> = emptyMap(),
+    )
+  }
 
+  @Serializable
+  @SerialName("di_provides_and_injects")
+  data class DiProvidesAndInjectsStat(
+    val value: List<ProvidesAndInjects>,
+    val details: String? = null,
+  ) : Stat {
+    /**
+     * Represents the data in an Anvil ContributesBinding Annotation Usage
+     */
     @Serializable
-    @SerialName("di_provides_and_injects")
-    data class DiProvidesAndInjectsStat(
-        val value: List<ProvidesAndInjects>,
-        val details: String? = null,
-    ) : Stat {
-        /**
-         * Represents the data in an Anvil ContributesBinding Annotation Usage
-         */
-        @Serializable
-        data class DiContribution(
-            val annotation: String,
-            val scope: String,
-            val boundImplementation: String,
-            val boundType: String,
-            val replaces: List<String>,
-        )
+    data class DiContribution(
+      val annotation: String,
+      val scope: String,
+      val boundImplementation: String,
+      val boundType: String,
+      val replaces: List<String>,
+    )
 
-        /**
-         * Represents the data in an Anvil ContributesBinding Annotation Usage
-         */
-        @Serializable
-        data class DiInjection(
-            val type: String,
-            val qualifierAnnotations: List<String>,
-            val startLine: Int,
-            val endLine: Int,
-        )
+    /**
+     * Represents the data in an Anvil ContributesBinding Annotation Usage
+     */
+    @Serializable
+    data class DiInjection(
+      val type: String,
+      val qualifierAnnotations: List<String>,
+      val startLine: Int,
+      val endLine: Int,
+    )
 
-        @Serializable
-        data class ProvidesAndInjects(
-            val classFqName: String,
-            val contributions: List<DiContribution>,
-            val consumptions: List<DiInjection>,
-            val filePath: String,
-            val startLine: Int,
-            val endLine: Int,
-        )
-    }
+    @Serializable
+    data class ProvidesAndInjects(
+      val classFqName: String,
+      val contributions: List<DiContribution>,
+      val consumptions: List<DiInjection>,
+      val filePath: String,
+      val startLine: Int,
+      val endLine: Int,
+    )
+  }
 }
diff --git a/invert-models/src/commonMain/kotlin/com/squareup/invert/models/StatMetadata.kt b/invert-models/src/commonMain/kotlin/com/squareup/invert/models/StatMetadata.kt
@@ -2,13 +2,22 @@ package com.squareup.invert.models
 
 import kotlinx.serialization.Serializable
 
+
+@Serializable
+data class ExtraMetadata(
+    val key: ExtraKey,
+    val type: DataType,
+    val description: String,
+)
+
 /**
  * Information about a specific stat type.
  */
 @Serializable
 data class StatMetadata(
     val key: StatKey,
     val description: String,
-    val statType: CollectedStatType,
-    val category: String? = null,
+    val dataType: DataType,
+    val category: String = "Stats",
+    val extraMetadata: List<ExtraMetadata> = emptyList(),
 )
diff --git a/invert-models/src/commonMain/kotlin/com/squareup/invert/models/Typealiases.kt b/invert-models/src/commonMain/kotlin/com/squareup/invert/models/Typealiases.kt
@@ -8,3 +8,4 @@ typealias OwnerName = String
 typealias GitSha = String
 typealias GitBranch = String
 typealias StatKey = String
+typealias ExtraKey = String