Merge pull request #129 from superwall/ir/feature/config-dsl

Add idiomatic DSL for prettier configuration

Author: ianrumac

CHANGELOG.md

@@ -2,16 +2,37 @@
 
 The changelog for `Superwall`. Also see the [releases](https://github.com/superwall/Superwall-Android/releases) on GitHub.
 
-## 1.1.9
+## 1.2.0
 
-### Deprecations
+### Enhancements
+- Adds DSL methods for configuring the SDK. You can now use a configuration block:
+  ```kotlin
+  fun Application.configureSuperwall(
+        apiKey: String,
+        configure: SuperwallBuilder.() -> Unit,
+  )
+  ```
+
+This allows you to configure the SDK in a more idiomatic way:
+  ```kotlin
+     configureSuperwall(CONSTANT_API_KEY){
+        options {
+          logging {
+            level = LogLevel.debug
+          }
+          paywalls {
+            shouldPreload = false
+          }
+        }
+    }
+  ```
 
+### Deprecations
 
 This release includes multiple deprecations that will be removed in upcoming versions.
 Most are internal and will not affect the public API, those that will are marked as such and a simple migration
 path is provided. The notable ones in the public API are as follows:
 
-- Deprecated configuration method `Superwall.configure(applicationContext: Context, ...)` in favor of `Superwall.configure(applicationContext: Application, ...)` to enforce type safety. The rest of the method signature remains the same.
 - Deprecated `DebugViewControllerActivity` in favor of `DebugViewActivity`
 - Deprecated `PaywallViewController` in favor of `PaywallView`
   - Deprecated belonging methods:
@@ -38,6 +59,12 @@ path is provided. The notable ones in the public API are as follows:
 - Deprecated `LogScope.debugViewController` in favor of `LogScope.debugView`
 - Deprecated `PaywallPresentationRequestStatus.NoPaywallViewController` in favor of `NoPaywallView`
 
+## 1.1.9
+
+### Deprecations
+
+- Deprecated configuration method `Superwall.configure(applicationContext: Context, ...)` in favor of `Superwall.configure(applicationContext: Application, ...)` to enforce type safety. The rest of the method signature remains the same.
+
 ### Fixes
 
 - SW-2878: and it's related leaks. The `PaywallViewController` was not being properly detached when activity was stopped, causing memory leaks.

superwall/src/main/java/com/superwall/sdk/utilities/SuperwallDSL.kt

@@ -0,0 +1,71 @@
+package com.superwall.sdk.utilities
+
+import android.app.Application
+import com.superwall.sdk.Superwall
+import com.superwall.sdk.config.options.PaywallOptions
+import com.superwall.sdk.config.options.SuperwallOptions
+import com.superwall.sdk.delegate.subscription_controller.PurchaseController
+import com.superwall.sdk.misc.ActivityProvider
+
+class SuperwallBuilder {
+    var purchaseController: PurchaseController? = null
+    var options: SuperwallOptions? = null
+        private set
+    var activityProvider: ActivityProvider? = null
+    var completion: (() -> Unit)? = null
+
+    @SuperwallDSL
+    fun options(action: SuperwallOptions.() -> Unit) {
+        options = SuperwallOptions().apply(action)
+    }
+}
+
+/**
+ * Configures a shared instance of [Superwall] for use throughout your app.
+ *
+ * Call this as soon as your app finishes launching in `onCreate` in your `MainApplication`
+ * class.
+ * Check out [Configuring the SDK](https://docs.superwall.com/docs/configuring-the-sdk) for
+ * information about how to configure the SDK.
+ *
+ * @param apiKey Your Public API Key that you can get from the Superwall dashboard
+ * settings. If you don't have an account, you can
+ * [sign up for free](https://superwall.com/sign-up).
+ * @param configure A lambda that allows you to configure the SDK. Inside the configuration block,
+ * you can setup your [PurchaseController], [ActivityProvider], a completion
+ * closure and [SuperwallOptions] via [SuperwallBuilder.options] closure.
+ * @return The configured [Superwall] instance.
+ */
+
+@SuperwallDSL
+fun Application.configureSuperwall(
+    apiKey: String,
+    configure: SuperwallBuilder.() -> Unit,
+): Superwall {
+    val builder = SuperwallBuilder().apply(configure)
+    Superwall.configure(
+        this,
+        apiKey,
+        builder.purchaseController,
+        builder.options,
+        builder.activityProvider,
+        builder.completion,
+    )
+    return Superwall.instance
+}
+
+/**
+ * Enables you to define [PaywallOptions] via closure.
+ * */
+@SuperwallDSL
+fun SuperwallOptions.paywalls(action: PaywallOptions.() -> Unit) {
+    paywalls = this.paywalls.apply(action)
+}
+
+/**
+ * Enables you to define [SuperwallOptions.Logging] via closure.
+ * */
+@SuperwallDSL
+fun SuperwallOptions.logging(action: SuperwallOptions.Logging.() -> Unit) {
+    logging = this.logging.apply(action)
+}

superwall/src/main/java/com/superwall/sdk/utilities/SuperwallDSLUtils.kt

@@ -0,0 +1,4 @@
+package com.superwall.sdk.utilities
+
+@DslMarker
+annotation class SuperwallDSL