Restrict Paparazzi's public API

cashapp · Jan 29, 2024 · 44a138a · 44a138a
1 parent 3e7258f
commit 44a138a
Show file tree

Hide file tree

Showing 56 changed files with 364 additions and 55 deletions.
diff --git a/build.gradle b/build.gradle
@@ -10,6 +10,7 @@ buildscript {
 
   dependencies {
     classpath libs.plugin.kotlin
+    classpath libs.plugin.kotlinApiDump
     classpath libs.plugin.android
     classpath libs.plugin.mavenPublish
     classpath libs.plugin.dokka
@@ -25,6 +26,12 @@ buildscript {
   }
 }
 
+apply plugin: 'binary-compatibility-validator'
+
+apiValidation {
+  ignoredProjects += ['libs', 'sample']
+}
+
 subprojects {
   version = property("VERSION_NAME") as String
 

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -74,6 +74,7 @@ plugin-android = { module = "com.android.tools.build:gradle", version.ref = "agp
 plugin-buildConfig = { module = "com.github.gmazzo.buildconfig:plugin", version = "5.3.5" }
 plugin-dokka = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version = "1.9.10" }
 plugin-kotlin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
+plugin-kotlinApiDump = { module = "org.jetbrains.kotlinx:binary-compatibility-validator", version = '0.13.2' }
 plugin-ksp = { module = "com.google.devtools.ksp:com.google.devtools.ksp.gradle.plugin", version.ref = "ksp" }
 plugin-mavenPublish = { module = "com.vanniktech:gradle-maven-publish-plugin", version = "0.27.0" }
 plugin-spotless = { module = "com.diffplug.spotless:spotless-plugin-gradle", version = "6.25.0" }

diff --git a/paparazzi-annotations/api/paparazzi-annotations.api b/paparazzi-annotations/api/paparazzi-annotations.api
@@ -0,0 +1,3 @@
+public abstract interface annotation class app/cash/paparazzi/annotations/Paparazzi : java/lang/annotation/Annotation {
+}
+
diff --git a/paparazzi-gradle-plugin/api/paparazzi-gradle-plugin.api b/paparazzi-gradle-plugin/api/paparazzi-gradle-plugin.api
@@ -0,0 +1,27 @@
+public final class app/cash/paparazzi/gradle/PaparazziPlugin : org/gradle/api/Plugin {
+	public fun <init> ()V
+	public synthetic fun apply (Ljava/lang/Object;)V
+	public fun apply (Lorg/gradle/api/Project;)V
+}
+
+public class app/cash/paparazzi/gradle/PaparazziPlugin$PaparazziTask : org/gradle/api/DefaultTask {
+	public fun <init> ()V
+	public fun setTestNameIncludePatterns (Ljava/util/List;)Lapp/cash/paparazzi/gradle/PaparazziPlugin$PaparazziTask;
+}
+
+public abstract class app/cash/paparazzi/gradle/PrepareResourcesTask : org/gradle/api/DefaultTask {
+	public fun <init> ()V
+	public abstract fun getAarAssetDirs ()Lorg/gradle/api/file/ConfigurableFileCollection;
+	public abstract fun getAarExplodedDirs ()Lorg/gradle/api/file/ConfigurableFileCollection;
+	public abstract fun getArtifactFiles ()Lorg/gradle/api/file/ConfigurableFileCollection;
+	public abstract fun getCompileSdkVersion ()Lorg/gradle/api/provider/Property;
+	public abstract fun getModuleResourceDirs ()Lorg/gradle/api/provider/ListProperty;
+	public abstract fun getNonTransitiveRClassEnabled ()Lorg/gradle/api/provider/Property;
+	public abstract fun getPackageName ()Lorg/gradle/api/provider/Property;
+	public abstract fun getPaparazziResources ()Lorg/gradle/api/file/RegularFileProperty;
+	public abstract fun getProjectAssetDirs ()Lorg/gradle/api/provider/ListProperty;
+	public abstract fun getProjectResourceDirs ()Lorg/gradle/api/provider/ListProperty;
+	public abstract fun getTargetSdkVersion ()Lorg/gradle/api/provider/Property;
+	public final fun writeResourcesFile ()V
+}
+
diff --git a/paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/PrepareResourcesTask.kt b/paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/PrepareResourcesTask.kt
@@ -108,7 +108,7 @@ abstract class PrepareResourcesTask : DefaultTask() {
   }
 
   @JsonClass(generateAdapter = true)
-  data class Config(
+  internal data class Config(
     val mainPackage: String,
     val targetSdkVersion: String,
     val platformDir: String,

diff --git a/paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/utils/FileUtils.kt b/paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/utils/FileUtils.kt
@@ -19,8 +19,8 @@ import org.gradle.api.file.Directory
 import org.gradle.api.file.FileCollection
 import java.io.File
 
-fun FileCollection.relativize(directory: Directory) = files.map(directory::relativize)
+internal fun FileCollection.relativize(directory: Directory) = files.map(directory::relativize)
 
-fun Directory.relativize(child: File): String {
+internal fun Directory.relativize(child: File): String {
   return asFile.toPath().relativize(child.toPath()).toFile().invariantSeparatorsPath
 }
diff --git a/paparazzi-preview-processor/api/paparazzi-preview-processor.api b/paparazzi-preview-processor/api/paparazzi-preview-processor.api
@@ -0,0 +1,11 @@
+public final class app/cash/paparazzi/preview/processor/PreviewProcessor : com/google/devtools/ksp/processing/SymbolProcessor {
+	public fun <init> (Lcom/google/devtools/ksp/processing/SymbolProcessorEnvironment;)V
+	public fun process (Lcom/google/devtools/ksp/processing/Resolver;)Ljava/util/List;
+}
+
+public final class app/cash/paparazzi/preview/processor/PreviewProcessorProvider : com/google/devtools/ksp/processing/SymbolProcessorProvider {
+	public fun <init> ()V
+	public fun create (Lcom/google/devtools/ksp/processing/SymbolProcessorEnvironment;)Lapp/cash/paparazzi/preview/processor/PreviewProcessor;
+	public synthetic fun create (Lcom/google/devtools/ksp/processing/SymbolProcessorEnvironment;)Lcom/google/devtools/ksp/processing/SymbolProcessor;
+}
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		public abstract interface annotation class app/cash/paparazzi/annotations/Paparazzi : java/lang/annotation/Annotation {
		}