Pull out SDK into its own module

gradle/libs.versions.toml

@@ -18,6 +18,7 @@ androidx-annotations = { module = "androidx.annotation:annotation", version = "1
 androidx-appcompat = { module = "androidx.appcompat:appcompat", version = "1.7.0" }
 androidx-activity = { module = "androidx.activity:activity", version = "1.9.0" }
 androidx-compose-ui-android = { module = "androidx.compose.ui:ui-android", version = "1.6.7" }
+androidx-compose-runtime = { module = "androidx.compose.runtime:runtime", version = "1.6.7" }
 androidx-recyclerview = { module = "androidx.recyclerview:recyclerview", version = "1.3.2" }
 
 bytebuddy-agent = { module = "net.bytebuddy:byte-buddy-agent", version.ref = "bytebuddy" }

paparazzi-gradle-plugin/build.gradle

@@ -61,7 +61,8 @@ buildConfig {
 }
 
 tasks.withType(Test).configureEach {
-  dependsOn(':paparazzi:publishMavenPublicationToProjectLocalMavenRepository')
+  dependsOn(':paparazzi-junit4:publishMavenPublicationToProjectLocalMavenRepository')
+  dependsOn(':paparazzi-sdk:publishMavenPublicationToProjectLocalMavenRepository')
 }
 
 // When cleaning this project, we also want to clean the test projects.

paparazzi-gradle-plugin/src/main/java/app/cash/paparazzi/gradle/PaparazziPlugin.kt

@@ -329,7 +329,7 @@ public class PaparazziPlugin : Plugin<Project> {
 
   private fun Project.addTestDependency() {
     val dependency = if (isInternal()) {
-      dependencies.project(mapOf("path" to ":paparazzi"))
+      dependencies.project(mapOf("path" to ":paparazzi-junit4"))
     } else {
       dependencies.create("app.cash.paparazzi:paparazzi:$VERSION")
     }

paparazzi-junit4/api/paparazzi-junit4.api

@@ -0,0 +1,45 @@
+public final class app/cash/paparazzi/InstantAnimationsRule : org/junit/rules/TestRule {
+	public static final field $stable I
+	public fun <init> ()V
+	public fun apply (Lorg/junit/runners/model/Statement;Lorg/junit/runner/Description;)Lorg/junit/runners/model/Statement;
+}
+
+public final class app/cash/paparazzi/Paparazzi : org/junit/rules/TestRule {
+	public static final field $stable I
+	public fun <init> ()V
+	public fun <init> (Lapp/cash/paparazzi/Environment;)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;Z)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZD)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;Z)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;ZZ)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;ZZZ)V
+	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;ZZZZ)V
+	public synthetic fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;ZZZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun apply (Lorg/junit/runners/model/Statement;Lorg/junit/runner/Description;)Lorg/junit/runners/model/Statement;
+	public final fun close ()V
+	public final fun getContext ()Landroid/content/Context;
+	public final fun getLayoutInflater ()Landroid/view/LayoutInflater;
+	public final fun getResources ()Landroid/content/res/Resources;
+	public final fun gif (Landroid/view/View;)V
+	public final fun gif (Landroid/view/View;Ljava/lang/String;)V
+	public final fun gif (Landroid/view/View;Ljava/lang/String;J)V
+	public final fun gif (Landroid/view/View;Ljava/lang/String;JJ)V
+	public final fun gif (Landroid/view/View;Ljava/lang/String;JJI)V
+	public static synthetic fun gif$default (Lapp/cash/paparazzi/Paparazzi;Landroid/view/View;Ljava/lang/String;JJIILjava/lang/Object;)V
+	public final fun inflate (I)Landroid/view/View;
+	public final fun prepare (Lorg/junit/runner/Description;)V
+	public final fun snapshot (Landroid/view/View;)V
+	public final fun snapshot (Landroid/view/View;Ljava/lang/String;)V
+	public final fun snapshot (Landroid/view/View;Ljava/lang/String;J)V
+	public final fun snapshot (Ljava/lang/String;Lkotlin/jvm/functions/Function2;)V
+	public static synthetic fun snapshot$default (Lapp/cash/paparazzi/Paparazzi;Landroid/view/View;Ljava/lang/String;JILjava/lang/Object;)V
+	public static synthetic fun snapshot$default (Lapp/cash/paparazzi/Paparazzi;Ljava/lang/String;Lkotlin/jvm/functions/Function2;ILjava/lang/Object;)V
+	public final fun unsafeUpdateConfig (Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;)V
+	public static synthetic fun unsafeUpdateConfig$default (Lapp/cash/paparazzi/Paparazzi;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ILjava/lang/Object;)V
+}
+

paparazzi-junit4/build.gradle

@@ -0,0 +1,129 @@
+import com.android.build.gradle.internal.publishing.AndroidArtifacts
+
+apply plugin: 'org.jetbrains.kotlin.jvm'
+apply plugin: 'org.jetbrains.kotlin.plugin.compose'
+apply plugin: 'org.jetbrains.dokka'
+apply plugin: 'com.vanniktech.maven.publish'
+apply plugin: 'aar2jar'
+
+configurations {
+  layoutlibRuntime {
+    canBeConsumed = false
+    attributes.attribute(AndroidArtifacts.ARTIFACT_TYPE, ArtifactTypeDefinition.DIRECTORY_TYPE)
+  }
+  layoutlibResources {
+    canBeConsumed = false
+    attributes.attribute(AndroidArtifacts.ARTIFACT_TYPE, ArtifactTypeDefinition.DIRECTORY_TYPE)
+  }
+}
+
+aar2jar.configureForConfiguration("compileOnly")
+aar2jar.configureForConfiguration("testImplementation")
+
+dependencies {
+  registerTransform(org.gradle.api.internal.artifacts.transform.UnzipTransform) {
+    from.attribute(AndroidArtifacts.ARTIFACT_TYPE, ArtifactTypeDefinition.JAR_TYPE)
+    to.attribute(AndroidArtifacts.ARTIFACT_TYPE, ArtifactTypeDefinition.DIRECTORY_TYPE)
+  }
+}
+
+dependencies {
+  testImplementationAarAsJar libs.androidx.compose.ui.android
+  compileOnlyAarAsJar libs.androidx.compose.ui.android
+  compileOnlyAarAsJar libs.androidx.compose.runtime
+  api projects.paparazziSdk
+  api libs.junit
+  api platform(libs.kotlin.bom)
+
+  def osName = System.getProperty("os.name").toLowerCase(Locale.US)
+  def osLabel
+  if (osName.startsWith("mac")) {
+    def osArch = System.getProperty("os.arch").toLowerCase(Locale.US)
+    if (osArch.startsWith("x86")) {
+      osLabel = 'mac'
+    } else {
+      osLabel = 'mac-arm'
+    }
+  } else if (osName.startsWith("windows")) {
+    osLabel = 'win'
+  } else {
+    osLabel = 'linux'
+  }
+  layoutlibRuntime variantOf(libs.tools.layoutlib.runtime) { classifier(osLabel) }
+  layoutlibResources libs.tools.layoutlib.resources
+
+  testImplementation libs.truth
+}
+
+tasks.named("dokkaGfm").configure {
+  outputDirectory = rootProject.file("docs/1.x")
+
+  dokkaSourceSets.named("main") {
+    configureEach {
+      reportUndocumented = false
+      skipDeprecated = true
+      jdkVersion = 8
+      perPackageOption {
+        prefix = "app.cash.paparazzi.internal"
+        suppress = true
+      }
+    }
+  }
+}
+
+def generateTestConfig = tasks.register("generateTestConfig") {
+  def resources = layout.buildDirectory.file('intermediates/paparazzi/resources.json')
+  outputs.file(resources)
+
+  doLast {
+    File configFile = resources.get().asFile
+    configFile.write("""{
+      "mainPackage": "app.cash.paparazzi",
+      "mergeResourcesOutputDir": ".",
+      "targetSdkVersion": "34",
+      "mergeAssetsOutputDir": ".",
+      "resourcePackageNames": ["app.cash.paparazzi"],
+      "projectResourceDirs": [],
+      "moduleResourceDirs": [],
+      "aarExplodedDirs": [],
+      "projectAssetDirs": [],
+      "aarAssetDirs": []
+    }""")
+  }
+}
+
+tasks.withType(Test).configureEach {
+  dependsOn(generateTestConfig)
+  systemProperty(
+    "paparazzi.test.resources",
+    generateTestConfig.map { it.outputs.files.singleFile }.get().path
+  )
+  systemProperty(
+    "paparazzi.project.dir",
+    project.layout.projectDirectory.toString()
+  )
+  systemProperty(
+    "paparazzi.build.dir",
+    project.layout.buildDirectory.get().toString()
+  )
+  systemProperty(
+    "paparazzi.report.dir",
+    project.extensions.getByType(ReportingExtension).baseDirectory.dir("paparazzi").get().toString()
+  )
+  systemProperty(
+    "paparazzi.snapshot.dir",
+    project.layout.projectDirectory.dir("src/test/snapshots").toString()
+  )
+  systemProperty(
+    "paparazzi.artifacts.cache.dir",
+    project.gradle.gradleUserHomeDir.path
+  )
+  systemProperty(
+    "paparazzi.layoutlib.runtime.root",
+    configurations.layoutlibRuntime.singleFile.absolutePath
+  )
+  systemProperty(
+    "paparazzi.layoutlib.resources.root",
+    configurations.layoutlibResources.singleFile.absolutePath
+  )
+}

paparazzi/src/test/java/app/cash/paparazzi/RenderExtensionTest.kt → paparazzi-junit4/src/test/java/app/cash/paparazzi/RenderExtensionTest.kt

@@ -1,3 +1,5 @@
+@file:Suppress("invisible_reference", "invisible_member")
+
 package app.cash.paparazzi
 
 import android.content.Context

paparazzi/src/test/java/app/cash/paparazzi/accessibility/AccessibilityRenderExtensionTest.kt → paparazzi-junit4/src/test/java/app/cash/paparazzi/accessibility/AccessibilityRenderExtensionTest.kt

@@ -1,3 +1,5 @@
+@file:Suppress("invisible_reference", "invisible_member")
+
 package app.cash.paparazzi.accessibility
 
 import android.content.Context

paparazzi/api/paparazzi.api → paparazzi-sdk/api/paparazzi-sdk.api

@@ -100,51 +100,6 @@ public final class app/cash/paparazzi/HtmlReportWriter : app/cash/paparazzi/Snap
 	public fun newFrameHandler (Lapp/cash/paparazzi/Snapshot;II)Lapp/cash/paparazzi/SnapshotHandler$FrameHandler;
 }
 
-public final class app/cash/paparazzi/InstantAnimationsRule : org/junit/rules/TestRule {
-	public static final field $stable I
-	public fun <init> ()V
-	public fun apply (Lorg/junit/runners/model/Statement;Lorg/junit/runner/Description;)Lorg/junit/runners/model/Statement;
-}
-
-public final class app/cash/paparazzi/Paparazzi : org/junit/rules/TestRule {
-	public static final field $stable I
-	public fun <init> ()V
-	public fun <init> (Lapp/cash/paparazzi/Environment;)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;Z)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZD)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;Z)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;ZZ)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;ZZZ)V
-	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;ZZZZ)V
-	public synthetic fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ZDLapp/cash/paparazzi/SnapshotHandler;Ljava/util/Set;ZZZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
-	public fun apply (Lorg/junit/runners/model/Statement;Lorg/junit/runner/Description;)Lorg/junit/runners/model/Statement;
-	public final fun close ()V
-	public final fun getContext ()Landroid/content/Context;
-	public final fun getLayoutInflater ()Landroid/view/LayoutInflater;
-	public final fun getResources ()Landroid/content/res/Resources;
-	public final fun gif (Landroid/view/View;)V
-	public final fun gif (Landroid/view/View;Ljava/lang/String;)V
-	public final fun gif (Landroid/view/View;Ljava/lang/String;J)V
-	public final fun gif (Landroid/view/View;Ljava/lang/String;JJ)V
-	public final fun gif (Landroid/view/View;Ljava/lang/String;JJI)V
-	public static synthetic fun gif$default (Lapp/cash/paparazzi/Paparazzi;Landroid/view/View;Ljava/lang/String;JJIILjava/lang/Object;)V
-	public final fun inflate (I)Landroid/view/View;
-	public final fun prepare (Lorg/junit/runner/Description;)V
-	public final fun snapshot (Landroid/view/View;)V
-	public final fun snapshot (Landroid/view/View;Ljava/lang/String;)V
-	public final fun snapshot (Landroid/view/View;Ljava/lang/String;J)V
-	public final fun snapshot (Ljava/lang/String;Lkotlin/jvm/functions/Function2;)V
-	public static synthetic fun snapshot$default (Lapp/cash/paparazzi/Paparazzi;Landroid/view/View;Ljava/lang/String;JILjava/lang/Object;)V
-	public static synthetic fun snapshot$default (Lapp/cash/paparazzi/Paparazzi;Ljava/lang/String;Lkotlin/jvm/functions/Function2;ILjava/lang/Object;)V
-	public final fun unsafeUpdateConfig (Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;)V
-	public static synthetic fun unsafeUpdateConfig$default (Lapp/cash/paparazzi/Paparazzi;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;ILjava/lang/Object;)V
-}
-
 public final class app/cash/paparazzi/PaparazziSdk {
 	public static final field $stable I
 	public fun <init> (Lapp/cash/paparazzi/Environment;Lapp/cash/paparazzi/DeviceConfig;Ljava/lang/String;Lcom/android/ide/common/rendering/api/SessionParams$RenderingMode;Lkotlin/jvm/functions/Function1;)V

paparazzi/build.gradle → paparazzi-sdk/build.gradle

@@ -42,7 +42,6 @@ dependencies {
   api libs.tools.ninepatch
   api libs.tools.sdkCommon
   api libs.kxml2
-  api libs.junit
   api libs.androidx.annotations
   api libs.guava
   api libs.kotlinx.coroutines.android

paparazzi-sdk/gradle.properties

@@ -0,0 +1,4 @@
+POM_ARTIFACT_ID=paparazzi-sdk
+POM_NAME=Paparazzi SDK
+POM_DESCRIPTION=An SDK to render your application screens without a physical device or emulator
+POM_PACKAGING=jar

paparazzi/src/main/java/app/cash/paparazzi/internal/PaparazziLogger.kt → paparazzi-sdk/src/main/java/app/cash/paparazzi/internal/PaparazziLogger.kt

@@ -15,7 +15,7 @@
  */
 package app.cash.paparazzi.internal
 
-import app.cash.paparazzi.Paparazzi
+import app.cash.paparazzi.PaparazziSdk
 import com.android.ide.common.rendering.api.ILayoutLog
 import com.android.utils.ILogger
 import java.io.PrintStream
@@ -28,7 +28,7 @@ import java.util.logging.Logger.getLogger
  * This logger delegates to java.util.Logging.
  */
 internal class PaparazziLogger : ILayoutLog, ILogger {
-  private val logger: Logger = getLogger(Paparazzi::class.java.name)
+  private val logger: Logger = getLogger(PaparazziSdk::class.java.name)
   private val errors = mutableListOf<Throwable>()
 
   override fun error(

paparazzi/src/main/java/app/cash/paparazzi/internal/Renderer.kt → paparazzi-sdk/src/main/java/app/cash/paparazzi/internal/Renderer.kt

@@ -19,7 +19,7 @@ package app.cash.paparazzi.internal
 import app.cash.paparazzi.DeviceConfig
 import app.cash.paparazzi.Environment
 import app.cash.paparazzi.Flags
-import app.cash.paparazzi.Paparazzi
+import app.cash.paparazzi.PaparazziSdk
 import app.cash.paparazzi.getFieldReflectively
 import app.cash.paparazzi.internal.resources.AarSourceResourceRepository
 import app.cash.paparazzi.internal.resources.AppResourceRepository
@@ -119,7 +119,7 @@ internal class Renderer(
   }
 
   private fun configureBuildProperties() {
-    val classLoader = Paparazzi::class.java.classLoader
+    val classLoader = PaparazziSdk::class.java.classLoader
     val buildClass = try {
       classLoader.loadClass("android.os.Build")
     } catch (e: ClassNotFoundException) {

settings.gradle

@@ -1,6 +1,7 @@
 rootProject.name = 'paparazzi-root'
 
-include ':paparazzi'
+include ':paparazzi-sdk'
+include ':paparazzi-junit4'
 include ':paparazzi-annotations'
 include ':paparazzi-preview-processor'
 include ':paparazzi-gradle-plugin'