Skip to content

Commit f1389e5

Browse files
toluo-stripetoluo-stripe
committed
Introduce CardEditUIHandler for the CardEditUI
1 parent 2ba755e commit f1389e5

File tree

6 files changed

+355
-53
lines changed

6 files changed

+355
-53
lines changed

‎paymentsheet/src/main/java/com/stripe/android/paymentsheet/ui/CardDetailsEntry.kt

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
package com.stripe.android.paymentsheet.ui
2+
3+
import com.stripe.android.paymentsheet.CardUpdateParams
4+
5+
/**
6+
* Represents the editable details of a card payment method.
7+
*
8+
* @property cardBrandChoice The currently selected card brand choice.
9+
*/
10+
internal data class CardDetailsEntry(
11+
val cardBrandChoice: CardBrandChoice,
12+
) {
13+
/**
14+
* Determines if the card details have changed compared to the provided values.
15+
*
16+
* @param originalCardBrandChoice The card brand choice to compare against.
17+
* @return True if any of the card details have changed, false otherwise.
18+
*/
19+
fun hasChanged(
20+
originalCardBrandChoice: CardBrandChoice,
21+
): Boolean {
22+
return originalCardBrandChoice != this.cardBrandChoice
23+
}
24+
}
25+
26+
/**
27+
* Converts the CardDetailsEntry to CardUpdateParams.
28+
*
29+
* @return CardUpdateParams containing the updated card brand.
30+
*/
31+
internal fun CardDetailsEntry.toUpdateParams(): CardUpdateParams {
32+
return CardUpdateParams(cardBrand = cardBrandChoice.brand)
33+
}

‎paymentsheet/src/main/java/com/stripe/android/paymentsheet/ui/CardEditUIHandler.kt

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
package com.stripe.android.paymentsheet.ui
2+
3+
import androidx.compose.runtime.Immutable
4+
import com.stripe.android.CardBrandFilter
5+
import com.stripe.android.model.CardBrand
6+
import com.stripe.android.model.PaymentMethod
7+
import com.stripe.android.paymentsheet.CardUpdateParams
8+
import kotlinx.coroutines.flow.StateFlow
9+
10+
internal typealias CardDetailsCallback = (CardUpdateParams?) -> Unit
11+
12+
internal typealias BrandChoiceCallback = (CardBrand) -> Unit
13+
14+
/**
15+
* Interface for handling UI interactions when editing card details.
16+
*/
17+
internal interface CardEditUIHandler {
18+
/**
19+
* The card being edited.
20+
*/
21+
val card: PaymentMethod.Card
22+
23+
/**
24+
* Filter for determining which card brands are available.
25+
*/
26+
val cardBrandFilter: CardBrandFilter
27+
28+
/**
29+
* Icon resource ID for the payment method.
30+
*/
31+
val paymentMethodIcon: Int
32+
33+
/**
34+
* Whether to show the card brand dropdown.
35+
*/
36+
val showCardBrandDropdown: Boolean
37+
38+
/**
39+
* Current state of the card edit UI.
40+
*/
41+
val state: StateFlow<State>
42+
43+
/**
44+
* Callback for when the card brand choice changes.
45+
*/
46+
val onBrandChoiceChanged: BrandChoiceCallback
47+
48+
/**
49+
* Callback for when card details change. It provides the values needed to
50+
* update the card, if any.
51+
*/
52+
val onCardDetailsChanged: CardDetailsCallback
53+
54+
/**
55+
* Handle a change in the selected card brand. This will be called from the UI when
56+
* the users selects a card brand.
57+
*
58+
* @param cardBrandChoice The newly selected card brand choice
59+
*/
60+
fun onBrandChoiceChanged(cardBrandChoice: CardBrandChoice)
61+
62+
/**
63+
* Represents the current state of the card edit UI.
64+
*
65+
* @property card The current card details
66+
* @property selectedCardBrand The currently selected card brand
67+
*/
68+
@Immutable
69+
data class State(
70+
val card: PaymentMethod.Card,
71+
val selectedCardBrand: CardBrandChoice
72+
)
73+
74+
/**
75+
* Factory for creating CardEditUIHandler instances.
76+
*/
77+
fun interface Factory {
78+
/**
79+
* Create a new CardEditUIHandler instance.
80+
*
81+
* @param card The card to edit
82+
* @param cardBrandFilter Filter for available card brands
83+
* @param showCardBrandDropdown Whether to show the card brand dropdown
84+
* @param paymentMethodIcon Icon resource for the payment method
85+
* @param onCardDetailsChanged Callback for card value changes
86+
*/
87+
fun create(
88+
card: PaymentMethod.Card,
89+
cardBrandFilter: CardBrandFilter,
90+
showCardBrandDropdown: Boolean,
91+
paymentMethodIcon: Int,
92+
onCardDetailsChanged: CardDetailsCallback
93+
): CardEditUIHandler
94+
}
95+
}

‎paymentsheet/src/main/java/com/stripe/android/paymentsheet/ui/CommonTextField.kt

-52
This file was deleted.

‎paymentsheet/src/main/java/com/stripe/android/paymentsheet/ui/DefaultCardEditUIHandler.kt

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
package com.stripe.android.paymentsheet.ui
2+
3+
import com.stripe.android.CardBrandFilter
4+
import com.stripe.android.model.PaymentMethod
5+
import kotlinx.coroutines.CoroutineScope
6+
import kotlinx.coroutines.flow.MutableStateFlow
7+
import kotlinx.coroutines.flow.SharingStarted
8+
import kotlinx.coroutines.flow.StateFlow
9+
import kotlinx.coroutines.flow.collectLatest
10+
import kotlinx.coroutines.flow.mapLatest
11+
import kotlinx.coroutines.flow.stateIn
12+
import kotlinx.coroutines.flow.update
13+
import kotlinx.coroutines.launch
14+
15+
internal class DefaultCardEditUIHandler(
16+
override val card: PaymentMethod.Card,
17+
override val cardBrandFilter: CardBrandFilter,
18+
override val paymentMethodIcon: Int,
19+
override val showCardBrandDropdown: Boolean,
20+
private val scope: CoroutineScope,
21+
override val onBrandChoiceChanged: BrandChoiceCallback,
22+
override val onCardDetailsChanged: CardDetailsCallback
23+
) : CardEditUIHandler {
24+
private val cardDetailsEntry = MutableStateFlow(
25+
value = buildDefaultCardEntry()
26+
)
27+
28+
override val state: StateFlow<CardEditUIHandler.State> = cardDetailsEntry.mapLatest { inputState ->
29+
uiState(inputState.cardBrandChoice)
30+
}.stateIn(
31+
scope = scope,
32+
started = SharingStarted.Eagerly,
33+
initialValue = uiState()
34+
)
35+
36+
init {
37+
scope.launch {
38+
cardDetailsEntry.collectLatest { state ->
39+
val newParams = state.takeIf {
40+
it.hasChanged(
41+
originalCardBrandChoice = defaultCardBrandChoice(),
42+
)
43+
}?.toUpdateParams()
44+
onCardDetailsChanged(newParams)
45+
}
46+
}
47+
}
48+
49+
override fun onBrandChoiceChanged(cardBrandChoice: CardBrandChoice) {
50+
if (cardBrandChoice != state.value.selectedCardBrand) {
51+
onBrandChoiceChanged(cardBrandChoice.brand)
52+
}
53+
cardDetailsEntry.update {
54+
it.copy(
55+
cardBrandChoice = cardBrandChoice
56+
)
57+
}
58+
}
59+
60+
private fun buildDefaultCardEntry(): CardDetailsEntry {
61+
return CardDetailsEntry(
62+
cardBrandChoice = defaultCardBrandChoice()
63+
)
64+
}
65+
66+
private fun defaultCardBrandChoice() = card.getPreferredChoice(cardBrandFilter)
67+
68+
private fun uiState(cardBrandChoice: CardBrandChoice = defaultCardBrandChoice()): CardEditUIHandler.State {
69+
return CardEditUIHandler.State(
70+
card = card,
71+
selectedCardBrand = cardBrandChoice
72+
)
73+
}
74+
75+
class Factory(
76+
private val scope: CoroutineScope,
77+
private val onBrandChoiceChanged: BrandChoiceCallback,
78+
) : CardEditUIHandler.Factory {
79+
override fun create(
80+
card: PaymentMethod.Card,
81+
cardBrandFilter: CardBrandFilter,
82+
showCardBrandDropdown: Boolean,
83+
paymentMethodIcon: Int,
84+
onCardDetailsChanged: CardDetailsCallback
85+
): CardEditUIHandler {
86+
return DefaultCardEditUIHandler(
87+
card = card,
88+
cardBrandFilter = cardBrandFilter,
89+
paymentMethodIcon = paymentMethodIcon,
90+
showCardBrandDropdown = showCardBrandDropdown,
91+
scope = scope,
92+
onBrandChoiceChanged = onBrandChoiceChanged,
93+
onCardDetailsChanged = onCardDetailsChanged
94+
)
95+
}
96+
}
97+
}

‎paymentsheet/src/test/java/com/stripe/android/model/PaymentMethodFixtures.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import java.util.UUID
1515
import java.util.concurrent.ThreadLocalRandom
1616

1717
internal object PaymentMethodFixtures {
18-
private val CARD = PaymentMethod.Card(
18+
val CARD = PaymentMethod.Card(
1919
brand = CardBrand.Visa,
2020
checks = PaymentMethod.Card.Checks(
2121
addressLine1Check = "unchecked",

0 commit comments

Comments
 (0)