Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Publishes change event from CardVerificationCodeElement on brand changes #30

Merged
merged 3 commits into from
Jan 5, 2023
Merged

feat: Publishes change event from CardVerificationCodeElement on brand changes #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f8931e
Adds failing tests
dhudec Jan 5, 2023
cceae59
Emit cvc change events when card brand changes impact validation
dhudec Jan 5, 2023
d44019d
Fixing typo in test name
dhudec Jan 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions lib/src/main/java/com/basistheory/android/view/CardVerificationCodeElement.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ class CardVerificationCodeElement @JvmOverloads constructor(
set(value) {
if (value != null && cardNumberElement !== value) {
field = value
super.mask =
cardNumberElement?.cardMetadata?.cvcMask?.let { ElementMask(it) } ?: defaultMask
field?.addChangeEventListener { updateMask() }
onCardNumberChanged(true)
field?.addChangeEventListener { onCardNumberChanged() }
} else {
field = value
}
Expand All @@ -27,7 +26,7 @@ class CardVerificationCodeElement @JvmOverloads constructor(
init {
super.keyboardType = KeyboardType.NUMBER
super.mask = defaultMask
super.validator = RegexValidator("""^\d{3,4}$""")
super.validator = validatorForLength(defaultMask.length)
}

companion object {
Expand All @@ -36,10 +35,27 @@ class CardVerificationCodeElement @JvmOverloads constructor(
val defaultMask = ElementMask(
listOf(digit, digit, digit)
)

fun validatorForLength(length: Int) =
RegexValidator("""^\d{$length}$""")
}

private fun updateMask() {
super.mask =
cardNumberElement?.cardMetadata?.cvcMask?.let { ElementMask(it) } ?: defaultMask
private fun onCardNumberChanged(isInitialConfiguration: Boolean = false) {
val oldMaskLength = super.mask?.length

val updatedMask = cardNumberElement
?.cardMetadata
?.cvcMask
?.let { ElementMask(it) }
?: defaultMask

super.mask = updatedMask
super.validator = validatorForLength(updatedMask.length)

val updatedMaskLength = super.mask?.length

// publish a change event if the mask length changed
if (!isInitialConfiguration && oldMaskLength != updatedMaskLength)
super.publishChangeEvent()
}
}
3 changes: 3 additions & 0 deletions lib/src/main/java/com/basistheory/android/view/TextElement.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,9 @@ open class TextElement @JvmOverloads constructor(
isInternalChange = false
}

protected fun publishChangeEvent()
= publishChangeEvent(editText.editableText)

private fun publishChangeEvent(editable: Editable?) {
val event = createElementChangeEvent(
getText(),
Expand Down
3 changes: 3 additions & 0 deletions lib/src/main/java/com/basistheory/android/view/mask/ElementMask.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ class ElementMask {
)
}

val length: Int
get() = characterMasks.size

internal fun evaluate(text: String?, action: InputAction): String? {
if (text.isNullOrEmpty())
return ""
Expand Down
80 changes: 76 additions & 4 deletions lib/src/test/java/com/basistheory/android/view/CardVerificationCodeElementTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ import org.junit.runner.RunWith
import org.robolectric.Robolectric
import org.robolectric.RobolectricTestRunner
import strikt.api.expectThat
import strikt.assertions.isEqualTo
import strikt.assertions.isFalse
import strikt.assertions.isTrue
import strikt.assertions.single
import strikt.assertions.*
import kotlin.text.get

@RunWith(RobolectricTestRunner::class)
class CardVerificationCodeElementTests {
Expand Down Expand Up @@ -96,4 +94,78 @@ class CardVerificationCodeElementTests {

verify(exactly = 1) { cardNumberElement.addChangeEventListener(any()) }
}

@Test
fun `emits a change event when mask increases from 3 to 4 chars`() {
val changeEvents = mutableListOf<ChangeEvent>()
cvcElement.addChangeEventListener { changeEvents.add(it) }

cardNumberElement.setText("4242424242424242")
cvcElement.cardNumberElement = cardNumberElement
cvcElement.setText("123")

expectThat(changeEvents).single().and {
get { isValid }.isTrue()
get { isEmpty }.isFalse()
get { isComplete }.isTrue()
}

// change the card brand from visa to american-express
cardNumberElement.setText("378282246310005")

expectThat(cvcElement.getText()).isEqualTo("123") // value does not change
expectThat(changeEvents).hasSize(2).last().and {
get { isValid }.isFalse()
get { isEmpty }.isFalse()
get { isComplete }.isFalse()
}
}

@Test
fun `emits a change event when mask decreases from 4 to 3 chars`() {
val changeEvents = mutableListOf<ChangeEvent>()
cvcElement.addChangeEventListener { changeEvents.add(it) }

cardNumberElement.setText("378282246310005")
cvcElement.cardNumberElement = cardNumberElement
cvcElement.setText("1234")

expectThat(changeEvents).single().and {
get { isValid }.isTrue()
get { isEmpty }.isFalse()
get { isComplete }.isTrue()
}

// change the card brand from visa to american-express
cardNumberElement.setText("4242424242424242")

expectThat(cvcElement.getText()).isEqualTo("1234") // value does not change
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so it is their problem to make sure it is not tokenized like this since the element still have 4 digits right?

expectThat(changeEvents).hasSize(2).last().and {
get { isValid }.isFalse()
get { isEmpty }.isFalse()
get { isComplete }.isFalse()
}
}

@Test
fun `does NOT emit a change event when card brand changes without impacting cvc mask`() {
val changeEvents = mutableListOf<ChangeEvent>()
cvcElement.addChangeEventListener { changeEvents.add(it) }

cardNumberElement.setText("4242424242424242")
cvcElement.cardNumberElement = cardNumberElement
cvcElement.setText("1234")

expectThat(changeEvents).single().and {
get { isValid }.isTrue()
get { isEmpty }.isFalse()
get { isComplete }.isTrue()
}

// change the card brand from visa to mastercard
cardNumberElement.setText("5555555555554444")

expectThat(cvcElement.getText()).isEqualTo("123") // value does not change
expectThat(changeEvents).single() // no new change events were published
}
}