Merge pull request #401 from skydoves/feature/coil3

Implement coil3 module and support KMP

app/build.gradle.kts

@@ -46,7 +46,7 @@ dependencies {
   implementation(project(":landscapist-palette"))
 
   implementation(project(":glide"))
-  implementation(project(":coil"))
+  implementation(project(":coil3"))
   implementation(project(":fresco"))
   implementation(project(":fresco-websupport"))
 

app/src/main/kotlin/com/github/skydoves/landscapistdemo/App.kt

@@ -17,14 +17,18 @@
 
 package com.github.skydoves.landscapistdemo
 
+import android.content.Context
 import androidx.multidex.MultiDexApplication
+import coil3.ImageLoader
+import coil3.SingletonImageLoader
+import coil3.fetch.NetworkFetcher
 import com.facebook.drawee.backends.pipeline.Fresco
 import com.facebook.imagepipeline.backends.okhttp3.OkHttpImagePipelineConfigFactory
 import dagger.hilt.android.HiltAndroidApp
 import okhttp3.OkHttpClient
 
 @HiltAndroidApp
-class App : MultiDexApplication() {
+class App : MultiDexApplication(), SingletonImageLoader.Factory {
 
   override fun onCreate() {
     super.onCreate()
@@ -40,4 +44,12 @@ class App : MultiDexApplication() {
 
     Fresco.initialize(this, pipelineConfig)
   }
+
+  override fun newImageLoader(context: Context): ImageLoader {
+    return ImageLoader.Builder(context)
+      .components {
+        add(NetworkFetcher.Factory())
+      }
+      .build()
+  }
 }

app/src/main/kotlin/com/github/skydoves/landscapistdemo/ui/MainPosters.kt

@@ -47,6 +47,7 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.draw.clip
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.layout.ContentScale
+import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.text.style.TextAlign
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
@@ -59,6 +60,7 @@ import com.github.skydoves.landscapistdemo.theme.background
 import com.skydoves.landscapist.ImageOptions
 import com.skydoves.landscapist.animation.circular.CircularRevealPlugin
 import com.skydoves.landscapist.animation.crossfade.CrossfadePlugin
+import com.skydoves.landscapist.coil3.CoilImage
 import com.skydoves.landscapist.components.rememberImageComponent
 import com.skydoves.landscapist.fresco.FrescoImage
 import com.skydoves.landscapist.glide.GlideImage
@@ -132,7 +134,7 @@ private fun SelectedPoster(
 ) {
   var palette by rememberPaletteState(null)
 
-  GlideImage(
+  CoilImage(
     imageModel = { poster.image },
     modifier = Modifier.aspectRatio(0.8f),
     component = rememberImageComponent {
@@ -149,7 +151,7 @@ private fun SelectedPoster(
       +CircularRevealPlugin()
       +PalettePlugin { palette = it }
     },
-    previewPlaceholder = R.drawable.poster,
+    previewPlaceholder = painterResource(id = R.drawable.poster),
   )
 
   ColorPalettes(palette)

benchmark-landscapist-app/build.gradle.kts

@@ -51,6 +51,7 @@ dependencies {
 
   implementation(project(":glide"))
   implementation(project(":coil"))
+  implementation(project(":coil3"))
   implementation(project(":fresco"))
   implementation(project(":fresco-websupport"))
 

benchmark-landscapist-app/src/main/kotlin/com/skydoves/benchmark/landscapist/app/App.kt

@@ -18,11 +18,15 @@
 package com.skydoves.benchmark.landscapist.app
 
 import android.app.Application
+import android.content.Context
+import coil3.ImageLoader
+import coil3.SingletonImageLoader
+import coil3.fetch.NetworkFetcher
 import com.facebook.drawee.backends.pipeline.Fresco
 import com.facebook.imagepipeline.backends.okhttp3.OkHttpImagePipelineConfigFactory
 import okhttp3.OkHttpClient
 
-class App : Application() {
+class App : Application(), SingletonImageLoader.Factory {
 
   override fun onCreate() {
     super.onCreate()
@@ -38,4 +42,12 @@ class App : Application() {
 
     Fresco.initialize(this, pipelineConfig)
   }
+
+  override fun newImageLoader(context: Context): ImageLoader {
+    return ImageLoader.Builder(context)
+      .components {
+        add(NetworkFetcher.Factory())
+      }
+      .build()
+  }
 }

benchmark-landscapist-app/src/main/kotlin/com/skydoves/benchmark/landscapist/app/CoilImage3Profiles.kt

@@ -0,0 +1,39 @@
+/*
+ * Designed and developed by 2020-2023 skydoves (Jaewoong Eum)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.skydoves.benchmark.landscapist.app
+
+import androidx.compose.foundation.layout.size
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.painterResource
+import androidx.compose.ui.unit.dp
+import com.skydoves.landscapist.ImageOptions
+import com.skydoves.landscapist.coil3.CoilImage
+import com.skydoves.landscapist.components.LocalImageComponent
+
+@Composable
+fun Coil3ImageProfiles() {
+  CoilImage(
+    modifier = Modifier.size(120.dp),
+    imageModel = {
+      "https://user-images.githubusercontent.com/" +
+        "24237865/75087936-5c1d9f80-553e-11ea-81d3-a912634dd8f7.jpg"
+    },
+    previewPlaceholder = painterResource(id = R.drawable.poster),
+    component = LocalImageComponent.current,
+    imageOptions = ImageOptions(tag = "CoilImage"),
+  )
+}

benchmark-landscapist-app/src/main/kotlin/com/skydoves/benchmark/landscapist/app/CoilImageProfiles.kt

@@ -33,6 +33,6 @@ fun CoilImageProfiles() {
     },
     previewPlaceholder = R.drawable.poster,
     component = LocalImageComponent.current,
-    imageOptions = ImageOptions(testTag = "CoilImage"),
+    imageOptions = ImageOptions(tag = "CoilImage"),
   )
 }

benchmark-landscapist-app/src/main/kotlin/com/skydoves/benchmark/landscapist/app/FrescoImageProfiles.kt

@@ -31,6 +31,6 @@ fun FrescoImageProfiles() {
       "24237865/75087936-5c1d9f80-553e-11ea-81d3-a912634dd8f7.jpg",
     previewPlaceholder = R.drawable.poster,
     component = LocalImageComponent.current,
-    imageOptions = ImageOptions(testTag = "FrescoImage"),
+    imageOptions = ImageOptions(tag = "FrescoImage"),
   )
 }

benchmark-landscapist-app/src/main/kotlin/com/skydoves/benchmark/landscapist/app/GlideImageProfiles.kt

@@ -33,6 +33,6 @@ fun GlideImageProfiles() {
     },
     previewPlaceholder = R.drawable.poster,
     component = LocalImageComponent.current,
-    imageOptions = ImageOptions(testTag = "GlideImage"),
+    imageOptions = ImageOptions(tag = "GlideImage"),
   )
 }

benchmark-landscapist-app/src/main/kotlin/com/skydoves/benchmark/landscapist/app/MainActivity.kt

@@ -58,6 +58,7 @@ class MainActivity : ComponentActivity() {
           },
         ) {
           CoilImageProfiles()
+          Coil3ImageProfiles()
           GlideImageProfiles()
           FrescoImageProfiles()
           FrescoWebSupportProfiles()

coil/src/main/kotlin/com/skydoves/landscapist/coil/CoilImage.kt

@@ -268,7 +268,7 @@ public fun CoilImage(
           imageOptions.LandscapistImage(
             modifier = Modifier
               .constraint(this)
-              .testTag(imageOptions.testTag),
+              .testTag(imageOptions.tag),
             painter = painter,
           )
         }

coil3/.gitignore

@@ -0,0 +1 @@
+/build

coil3/api/android/coil3.api

@@ -0,0 +1,75 @@
+public final class com/skydoves/landscapist/coil3/CoilImageKt {
+	public static final fun CoilImage (Lkotlin/jvm/functions/Function0;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function2;Lcom/skydoves/landscapist/components/ImageComponent;Lcom/skydoves/landscapist/ImageOptions;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/graphics/painter/Painter;Lkotlin/jvm/functions/Function4;Lkotlin/jvm/functions/Function5;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
+	public static final fun CoilImage (Lkotlin/jvm/functions/Function0;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function2;Lcom/skydoves/landscapist/components/ImageComponent;Lkotlin/jvm/functions/Function0;Lcom/skydoves/landscapist/ImageOptions;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/graphics/painter/Painter;Lkotlin/jvm/functions/Function4;Lkotlin/jvm/functions/Function5;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;III)V
+}
+
+public abstract class com/skydoves/landscapist/coil3/CoilImageState : com/skydoves/landscapist/ImageState {
+	public static final field $stable I
+}
+
+public final class com/skydoves/landscapist/coil3/CoilImageState$Failure : com/skydoves/landscapist/coil3/CoilImageState {
+	public static final field $stable I
+	public fun <init> (Lcoil3/Image;Ljava/lang/Throwable;)V
+	public final fun component1 ()Lcoil3/Image;
+	public final fun component2 ()Ljava/lang/Throwable;
+	public final fun copy (Lcoil3/Image;Ljava/lang/Throwable;)Lcom/skydoves/landscapist/coil3/CoilImageState$Failure;
+	public static synthetic fun copy$default (Lcom/skydoves/landscapist/coil3/CoilImageState$Failure;Lcoil3/Image;Ljava/lang/Throwable;ILjava/lang/Object;)Lcom/skydoves/landscapist/coil3/CoilImageState$Failure;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getErrorImage ()Lcoil3/Image;
+	public final fun getReason ()Ljava/lang/Throwable;
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class com/skydoves/landscapist/coil3/CoilImageState$Loading : com/skydoves/landscapist/coil3/CoilImageState {
+	public static final field $stable I
+	public static final field INSTANCE Lcom/skydoves/landscapist/coil3/CoilImageState$Loading;
+	public fun equals (Ljava/lang/Object;)Z
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class com/skydoves/landscapist/coil3/CoilImageState$None : com/skydoves/landscapist/coil3/CoilImageState {
+	public static final field $stable I
+	public static final field INSTANCE Lcom/skydoves/landscapist/coil3/CoilImageState$None;
+	public fun equals (Ljava/lang/Object;)Z
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class com/skydoves/landscapist/coil3/CoilImageState$Success : com/skydoves/landscapist/coil3/CoilImageState {
+	public static final field $stable I
+	public fun <init> (Lcoil3/Image;Lcom/skydoves/landscapist/DataSource;)V
+	public final fun component1 ()Lcoil3/Image;
+	public final fun component2 ()Lcom/skydoves/landscapist/DataSource;
+	public final fun copy (Lcoil3/Image;Lcom/skydoves/landscapist/DataSource;)Lcom/skydoves/landscapist/coil3/CoilImageState$Success;
+	public static synthetic fun copy$default (Lcom/skydoves/landscapist/coil3/CoilImageState$Success;Lcoil3/Image;Lcom/skydoves/landscapist/DataSource;ILjava/lang/Object;)Lcom/skydoves/landscapist/coil3/CoilImageState$Success;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getDataSource ()Lcom/skydoves/landscapist/DataSource;
+	public final fun getImage ()Lcoil3/Image;
+	public final fun getImageBitmap (Landroidx/compose/runtime/Composer;I)Landroidx/compose/ui/graphics/ImageBitmap;
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class com/skydoves/landscapist/coil3/CoilImageStateKt {
+	public static final fun toCoilImageState (Lcom/skydoves/landscapist/ImageLoadState;)Lcom/skydoves/landscapist/coil3/CoilImageState;
+}
+
+public final class com/skydoves/landscapist/coil3/ComposableSingletons$CoilImageKt {
+	public static final field INSTANCE Lcom/skydoves/landscapist/coil3/ComposableSingletons$CoilImageKt;
+	public static field lambda-1 Lkotlin/jvm/functions/Function3;
+	public static field lambda-2 Lkotlin/jvm/functions/Function3;
+	public fun <init> ()V
+	public final fun getLambda-1$coil3_release ()Lkotlin/jvm/functions/Function3;
+	public final fun getLambda-2$coil3_release ()Lkotlin/jvm/functions/Function3;
+}
+
+public final class com/skydoves/landscapist/coil3/LocalCoilProviderKt {
+	public static final fun getLocalCoilImageLoader ()Landroidx/compose/runtime/ProvidableCompositionLocal;
+}
+
+public final class com/skydoves/landscapist/coil3/RememberCoilImageStateKt {
+	public static final fun rememberCoilImageState (Lcom/skydoves/landscapist/coil3/CoilImageState;Ljava/lang/Object;Landroidx/compose/runtime/Composer;II)Landroidx/compose/runtime/MutableState;
+}
+

coil3/api/desktop/coil3.api

@@ -0,0 +1,75 @@
+public final class com/skydoves/landscapist/coil3/CoilImageKt {
+	public static final fun CoilImage (Lkotlin/jvm/functions/Function0;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function2;Lcom/skydoves/landscapist/components/ImageComponent;Lcom/skydoves/landscapist/ImageOptions;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/graphics/painter/Painter;Lkotlin/jvm/functions/Function4;Lkotlin/jvm/functions/Function5;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;II)V
+	public static final fun CoilImage (Lkotlin/jvm/functions/Function0;Landroidx/compose/ui/Modifier;Lkotlin/jvm/functions/Function2;Lcom/skydoves/landscapist/components/ImageComponent;Lkotlin/jvm/functions/Function0;Lcom/skydoves/landscapist/ImageOptions;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/graphics/painter/Painter;Lkotlin/jvm/functions/Function4;Lkotlin/jvm/functions/Function5;Lkotlin/jvm/functions/Function4;Landroidx/compose/runtime/Composer;III)V
+}
+
+public abstract class com/skydoves/landscapist/coil3/CoilImageState : com/skydoves/landscapist/ImageState {
+	public static final field $stable I
+}
+
+public final class com/skydoves/landscapist/coil3/CoilImageState$Failure : com/skydoves/landscapist/coil3/CoilImageState {
+	public static final field $stable I
+	public fun <init> (Lcoil3/Image;Ljava/lang/Throwable;)V
+	public final fun component1 ()Lcoil3/Image;
+	public final fun component2 ()Ljava/lang/Throwable;
+	public final fun copy (Lcoil3/Image;Ljava/lang/Throwable;)Lcom/skydoves/landscapist/coil3/CoilImageState$Failure;
+	public static synthetic fun copy$default (Lcom/skydoves/landscapist/coil3/CoilImageState$Failure;Lcoil3/Image;Ljava/lang/Throwable;ILjava/lang/Object;)Lcom/skydoves/landscapist/coil3/CoilImageState$Failure;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getErrorImage ()Lcoil3/Image;
+	public final fun getReason ()Ljava/lang/Throwable;
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class com/skydoves/landscapist/coil3/CoilImageState$Loading : com/skydoves/landscapist/coil3/CoilImageState {
+	public static final field $stable I
+	public static final field INSTANCE Lcom/skydoves/landscapist/coil3/CoilImageState$Loading;
+	public fun equals (Ljava/lang/Object;)Z
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class com/skydoves/landscapist/coil3/CoilImageState$None : com/skydoves/landscapist/coil3/CoilImageState {
+	public static final field $stable I
+	public static final field INSTANCE Lcom/skydoves/landscapist/coil3/CoilImageState$None;
+	public fun equals (Ljava/lang/Object;)Z
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class com/skydoves/landscapist/coil3/CoilImageState$Success : com/skydoves/landscapist/coil3/CoilImageState {
+	public static final field $stable I
+	public fun <init> (Lcoil3/Image;Lcom/skydoves/landscapist/DataSource;)V
+	public final fun component1 ()Lcoil3/Image;
+	public final fun component2 ()Lcom/skydoves/landscapist/DataSource;
+	public final fun copy (Lcoil3/Image;Lcom/skydoves/landscapist/DataSource;)Lcom/skydoves/landscapist/coil3/CoilImageState$Success;
+	public static synthetic fun copy$default (Lcom/skydoves/landscapist/coil3/CoilImageState$Success;Lcoil3/Image;Lcom/skydoves/landscapist/DataSource;ILjava/lang/Object;)Lcom/skydoves/landscapist/coil3/CoilImageState$Success;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getDataSource ()Lcom/skydoves/landscapist/DataSource;
+	public final fun getImage ()Lcoil3/Image;
+	public final fun getImageBitmap (Landroidx/compose/runtime/Composer;I)Landroidx/compose/ui/graphics/ImageBitmap;
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class com/skydoves/landscapist/coil3/CoilImageStateKt {
+	public static final fun toCoilImageState (Lcom/skydoves/landscapist/ImageLoadState;)Lcom/skydoves/landscapist/coil3/CoilImageState;
+}
+
+public final class com/skydoves/landscapist/coil3/ComposableSingletons$CoilImageKt {
+	public static final field INSTANCE Lcom/skydoves/landscapist/coil3/ComposableSingletons$CoilImageKt;
+	public static field lambda-1 Lkotlin/jvm/functions/Function3;
+	public static field lambda-2 Lkotlin/jvm/functions/Function3;
+	public fun <init> ()V
+	public final fun getLambda-1$coil3 ()Lkotlin/jvm/functions/Function3;
+	public final fun getLambda-2$coil3 ()Lkotlin/jvm/functions/Function3;
+}
+
+public final class com/skydoves/landscapist/coil3/LocalCoilProviderKt {
+	public static final fun getLocalCoilImageLoader ()Landroidx/compose/runtime/ProvidableCompositionLocal;
+}
+
+public final class com/skydoves/landscapist/coil3/RememberCoilImageStateKt {
+	public static final fun rememberCoilImageState (Lcom/skydoves/landscapist/coil3/CoilImageState;Ljava/lang/Object;Landroidx/compose/runtime/Composer;II)Landroidx/compose/runtime/MutableState;
+}
+