Merge pull request #4 from afterpay/maintenance/update-from-upstream-3.3.0

maintenance: update from upstream 3.3.0

Author: ScottAntonacAP

README.md

@@ -38,7 +38,7 @@ Add `afterpay-android-button` to your `build.gradle` dependencies.
 
 ```gradle
 dependencies {
-    implementation 'com.afterpay:afterpay-android-button:3.2.0'
+    implementation 'com.afterpay:afterpay-android-button:3.3.0'
 }
 ```
 
@@ -325,6 +325,14 @@ The Afterpay badge can be added to your layout and scaled to suit the needs of y
 ![Black on White badge][badge-black-on-white]
 ![White on Black badge][badge-white-on-black]
 
+### Lockup
+
+The Afterpay lockup can be added to your layout and scaled to suit the needs of your app. Per branding guidelines it requires a minimum width of `64dp`.
+
+![Black Lockup][lockup-black]
+![White Lockup][lockup-white]
+![Mint Lockup][lockup-mint]
+
 **Attributes**
 ```xml
 app:afterpayColorScheme="blackOnMint|mintOnBlack|blackOnWhite|whiteOnBlack"
@@ -391,6 +399,20 @@ Setting `introText` is optional, will default to `OR` and must be of type `After
 Can be any of `OR`, `OR_TITLE`, `MAKE`, `MAKE_TITLE`, `PAY`, `PAY_TITLE`, `IN`, `IN_TITLE`, `PAY_IN`, `PAY_IN_TITLE` or `EMPTY` (no intro text).
 Intro text will be rendered lowercase unless using an option suffixed with `_TITLE` in which case title case will be rendered.
 
+##### Logo Type
+Setting `logoType` is optional, will default to `BADGE` and must be of type `AfterpayLogoType`.
+
+Can be either of `BADGE` or `LOCKUP`.
+When setting color scheme on logo type of `LOCKUP`, only the foreground color will be applied. (See example)
+
+```kotlin
+val afterpayBreakdown = view.findViewById<AfterpayPriceBreakdown>(R.id.afterpayPriceBreakdown)
+afterpayBreakdown.logoType = AfterpayLogoType.LOCKUP
+afterpayBreakdown.colorScheme = AfterpayColorScheme.MINT_ON_BLACK
+```
+
+Given the above, the price breakdown will contain the lockup logo and will be of color mint.
+
 ##### Optional Words
 Setting `showInterestFreeText` and / or `showWithText` is optional and is of type `Boolean`.
 
@@ -407,12 +429,14 @@ Given the above, the price breakdown text will be rendered `Make 4 interest-free
 
 ##### More Info Options
 Setting `moreInfoOptions` is optional and of type `AfterpayMoreInfoOptions`. This class has two constructors.
-The first takes a single parameter:
+The first constructor takes two parameters:
 - `modalId`: a `string` that is the filename of a modal hosted on Afterpay static.
+- `modalLinkStyle`: an optional value of type `ModalLinkStyle`. See [Modal Link Style Options](#modal-link-style-options) for more details.
 
-The second takes two parameters:
+The second constructor takes three parameters:
 - `modalTheme`: an enum of type `AfterpayModalTheme` with the following options: `MINT` (default) and `WHITE`.
 - `isCbtEnabled`: a `boolean` to indicate if the modal should show the Cross Border Trade details in the modal
+- `modalLinkStyle`: an optional value of type `ModalLinkStyle`. See [Modal Link Style Options](#modal-link-style-options) for more details.
 
 **Note**
 Not all combinations of Locales and CBT are available.
@@ -426,6 +450,37 @@ afterpayBreakdown.moreInfoOptions = AfterpayMoreInfoOptions(
 
 Given the above, when clicking the more info "link", the modal that opens will be white in the current locale as set in configuration.
 
+###### Modal Link Style Options
+A value that can be set on `moreInfoOptions` when initialised. Setting this is optional and is of type `ModalLinkStyle`.
+
+Available values are `CircledInfoIcon`, `MoreInfoText`, `LearnMoreText`, `CircledQuestionIcon`, `CircledLogo`, `Custom`, `None`.
+`CircledInfoIcon` is the default & `None` will remove the link altogether.
+
+When using `Custom` the `setContent` (takes a single parameter of type `SpannableStringBuilder`) method should be called first (see second example below).
+
+```kotlin
+val afterpayBreakdown = view.findViewById<AfterpayPriceBreakdown>(R.id.afterpayPriceBreakdown)
+afterpayBreakdown.moreInfoOptions = AfterpayMoreInfoOptions(
+    modalLinkStyle  = AfterpayModalLinkStyle.CircledInfoIcon
+)
+```
+
+Given the above, the price breakdown modal link will be a circle containing a question mark.
+
+```kotlin
+val afterpayBreakdown = view.findViewById<AfterpayPriceBreakdown>(R.id.afterpayPriceBreakdown)
+val content = SpannableStringBuilder().apply {
+    append("Click ")
+    append("Here ", StyleSpan(Typeface.BOLD), Spannable.SPAN_EXCLUSIVE_EXCLUSIVE)
+}
+AfterpayModalLinkStyle.Custom.setContent(content)
+afterpayBreakdown.moreInfoOptions = AfterpayMoreInfoOptions(
+    modalLinkStyle  = AfterpayModalLinkStyle.Custom
+)
+```
+
+Given the above, the price breakdown modal link will display "Click Here".
+
 ## Security
 
 To limit the possibility of a man-in-the-middle attack during the checkout process, certificate pinning can be configured for the Afterpay portal. Please refer to the Android [Network Security Configuration][network-config] documentation for more information.
@@ -466,6 +521,9 @@ This project is licensed under the terms of the Apache 2.0 license. See the [LIC
 [badge-mint-on-black]: images/badge_mint_on_black.png
 [badge-black-on-white]: images/badge_black_on_white.png
 [badge-white-on-black]: images/badge_white_on_black.png
+[lockup-black]: images/lockup_black.png
+[lockup-white]: images/lockup_white.png
+[lockup-mint]: images/lockup_mint.png
 [breakdown-available]: images/price_breakdown_available.png
 [breakdown-no-configuration]: images/price_breakdown_no_configuration.png
 [breakdown-unavailable-min-max]: images/price_breakdown_unavailable_min_max.png

afterpay/src/main/kotlin/com/afterpay/android/internal/AfterpayInfoSpan.kt

@@ -1,10 +1,17 @@
 package com.afterpay.android.internal
 
 import android.content.Intent
+import android.text.TextPaint
 import android.text.style.URLSpan
 import android.view.View
 
 internal class AfterpayInfoSpan(url: String) : URLSpan(url) {
+    private var underlined: Boolean = true
+
+    constructor(url: String, underlined: Boolean) : this(url) {
+        this.underlined = underlined
+    }
+
     override fun onClick(widget: View) {
         val context = widget.context
         val intent = Intent(context, AfterpayInfoActivity::class.java).putInfoUrlExtra(url)
@@ -14,4 +21,9 @@ internal class AfterpayInfoSpan(url: String) : URLSpan(url) {
             super.onClick(widget)
         }
     }
+
+    override fun updateDrawState(ds: TextPaint) {
+        super.updateDrawState(ds)
+        ds.isUnderlineText = this.underlined
+    }
 }

afterpay/src/main/kotlin/com/afterpay/android/internal/Brand.kt

@@ -19,6 +19,7 @@ internal enum class Brand(
     @StringRes val title: Int,
     @StringRes val description: Int,
     @DrawableRes val badgeForeground: Int,
+    @DrawableRes val lockup: Int,
     @DrawableRes val payNowButtonForeground: Int,
     @DrawableRes val buyNowButtonForeground: Int,
     @DrawableRes val checkoutButtonForeground: Int,
@@ -29,6 +30,7 @@ internal enum class Brand(
         title = R.string.afterpay_service_name,
         description = R.string.afterpay_service_name_description,
         badgeForeground = R.drawable.afterpay_badge_fg,
+        lockup = R.drawable.afterpay_lockup,
         payNowButtonForeground = R.drawable.afterpay_button_pay_now_fg,
         buyNowButtonForeground = R.drawable.afterpay_button_buy_now_fg,
         checkoutButtonForeground = R.drawable.afterpay_button_checkout_fg,
@@ -39,6 +41,7 @@ internal enum class Brand(
         title = R.string.clearpay_service_name,
         description = R.string.clearpay_service_name_description,
         badgeForeground = R.drawable.clearpay_badge_fg,
+        lockup = R.drawable.clearpay_lockup,
         payNowButtonForeground = R.drawable.clearpay_button_pay_now_fg,
         buyNowButtonForeground = R.drawable.clearpay_button_buy_now_fg,
         checkoutButtonForeground = R.drawable.clearpay_button_checkout_fg,

afterpay/src/main/kotlin/com/afterpay/android/view/AfterpayLockup.kt

@@ -0,0 +1,55 @@
+package com.afterpay.android.view
+
+import android.content.Context
+import android.util.AttributeSet
+import android.widget.ImageView.ScaleType.FIT_CENTER
+import androidx.appcompat.widget.AppCompatImageView
+import androidx.core.content.res.use
+import com.afterpay.android.Afterpay
+import com.afterpay.android.R
+import com.afterpay.android.internal.coloredDrawable
+import com.afterpay.android.internal.dp
+
+private const val MIN_WIDTH: Int = 64
+
+class AfterpayLockup @JvmOverloads constructor(
+    context: Context,
+    attrs: AttributeSet? = null
+) : AppCompatImageView(context, attrs) {
+
+    var colorScheme: AfterpayColorScheme = AfterpayColorScheme.DEFAULT
+        set(value) {
+            field = value
+            update()
+        }
+
+    init {
+        contentDescription = resources.getString(Afterpay.brand.title)
+        importantForAccessibility = IMPORTANT_FOR_ACCESSIBILITY_YES
+        isFocusable = true
+        scaleType = FIT_CENTER
+        adjustViewBounds = true
+        minimumWidth = MIN_WIDTH.dp
+
+        context.theme.obtainStyledAttributes(attrs, R.styleable.Afterpay, 0, 0).use { attributes ->
+            colorScheme = AfterpayColorScheme.values()[
+                attributes.getInteger(
+                    R.styleable.Afterpay_afterpayColorScheme,
+                    AfterpayColorScheme.DEFAULT.ordinal
+                )
+            ]
+        }
+    }
+
+    private fun update() {
+        setImageDrawable(
+            context.coloredDrawable(
+                drawableResId = Afterpay.brand.lockup,
+                colorResId = colorScheme.foregroundColorResId
+            )
+        )
+
+        invalidate()
+        requestLayout()
+    }
+}

afterpay/src/main/kotlin/com/afterpay/android/view/AfterpayLogoType.kt

@@ -0,0 +1,12 @@
+package com.afterpay.android.view
+
+enum class AfterpayLogoType(val fontHeightMultiplier: Double) {
+    BADGE(2.5),
+    LOCKUP(1.0);
+
+    internal companion object {
+
+        @JvmField
+        val DEFAULT = AfterpayLogoType.BADGE
+    }
+}

afterpay/src/main/kotlin/com/afterpay/android/view/AfterpayModalLinkStyle.kt

@@ -0,0 +1,48 @@
+package com.afterpay.android.view
+
+import com.afterpay.android.R
+
+sealed class AfterpayModalLinkStyle(val config: ModalLinkConfig) {
+    constructor(string: String, config: ModalLinkConfig) : this(config)
+
+    object CircledInfoIcon : AfterpayModalLinkStyle(ModalLinkConfig(text = R.string.afterpay_price_breakdown_link_circled_info_icon, underlined = false))
+    object MoreInfoText : AfterpayModalLinkStyle(ModalLinkConfig(text = R.string.afterpay_price_breakdown_link_more_info_text))
+    object LearnMoreText : AfterpayModalLinkStyle(ModalLinkConfig(text = R.string.afterpay_price_breakdown_link_learn_more_text))
+    object CircledQuestionIcon : AfterpayModalLinkStyle(
+        ModalLinkConfig(
+            image = R.drawable.icon_circled_question,
+            imageRenderingMode = AfterpayImageRenderingMode.TEMPLATE
+        )
+    )
+    object CircledLogo : AfterpayModalLinkStyle(
+        ModalLinkConfig(
+            image = R.drawable.afterpay_logo_small,
+            imageRenderingMode = AfterpayImageRenderingMode.ORIGINAL
+        )
+    )
+    object Custom : AfterpayModalLinkStyle(ModalLinkConfig()) {
+        public fun setContent(content: CharSequence) {
+            config.customContent = content
+        }
+    }
+    object None : AfterpayModalLinkStyle(ModalLinkConfig())
+
+    internal companion object {
+
+        @JvmField
+        val DEFAULT = CircledInfoIcon
+    }
+}
+
+internal enum class AfterpayImageRenderingMode {
+    ORIGINAL,
+    TEMPLATE
+}
+
+internal data class ModalLinkConfig(
+    val text: Int? = null,
+    val image: Int? = null,
+    val imageRenderingMode: AfterpayImageRenderingMode? = null,
+    var customContent: CharSequence? = null,
+    val underlined: Boolean = true
+)

afterpay/src/main/kotlin/com/afterpay/android/view/AfterpayModalTheme.kt

@@ -3,4 +3,10 @@ package com.afterpay.android.view
 enum class AfterpayModalTheme(val slug: String) {
     MINT(""),
     WHITE("-theme-white");
+
+    internal companion object {
+
+        @JvmField
+        val DEFAULT = AfterpayModalTheme.MINT
+    }
 }

afterpay/src/main/kotlin/com/afterpay/android/view/AfterpayMoreInfoOptions.kt

@@ -3,17 +3,22 @@ package com.afterpay.android.view
 import com.afterpay.android.Afterpay
 
 class AfterpayMoreInfoOptions {
-    private var modalId: String? = null
-    private var modalTheme: AfterpayModalTheme = AfterpayModalTheme.MINT
-    private var isCbtEnabled: Boolean = false
+    internal var modalId: String? = null
+    internal var modalLinkStyle: AfterpayModalLinkStyle = AfterpayModalLinkStyle.DEFAULT
+    internal var modalTheme: AfterpayModalTheme = AfterpayModalTheme.DEFAULT
+    internal var isCbtEnabled: Boolean = false
 
     /**
      * Set up options for the more info link in AfterpayPriceBreakdown
      *
      * @param modalId the filename of a modal hosted on Afterpay static
      */
-    constructor(modalId: String) {
+    constructor(
+        modalId: String,
+        modalLinkStyle: AfterpayModalLinkStyle = AfterpayModalLinkStyle.DEFAULT
+    ) {
         this.modalId = modalId
+        this.modalLinkStyle = modalLinkStyle
     }
 
     /**
@@ -27,10 +32,12 @@ class AfterpayMoreInfoOptions {
      */
     constructor(
         modalTheme: AfterpayModalTheme = AfterpayModalTheme.MINT,
-        isCbtEnabled: Boolean = false
+        isCbtEnabled: Boolean = false,
+        modalLinkStyle: AfterpayModalLinkStyle = AfterpayModalLinkStyle.DEFAULT
     ) {
         this.modalTheme = modalTheme
         this.isCbtEnabled = isCbtEnabled
+        this.modalLinkStyle = modalLinkStyle
     }
 
     internal fun modalFile(): String {