Create ForageVaultWrapper

README.md

@@ -3,7 +3,6 @@
 ## Table of contents
 
 <!--ts-->
-
 - [Overview](#overview)
 - [Installation](#installation)
 - [UI Components](#ui-components)

forage-android/src/main/java/com/joinforage/forage/android/Utils.kt

@@ -1,5 +1,6 @@
 package com.joinforage.forage.android
 
+import android.content.res.TypedArray
 import com.joinforage.forage.android.network.model.ForageApiResponse
 import com.joinforage.forage.android.network.model.ForageError
 import com.joinforage.forage.android.network.model.SQSError
@@ -30,3 +31,8 @@ internal fun sqsMessageToError(sqsError: SQSError): ForageApiResponse.Failure {
 internal fun HttpUrl.Builder.addTrailingSlash(): HttpUrl.Builder {
     return this.addPathSegment("")
 }
+
+internal fun TypedArray.getBoxCornerRadius(styleIndex: Int, defaultBoxCornerRadius: Float): Float {
+    val styledBoxCornerRadius = getDimension(styleIndex, 0f)
+    return if (styledBoxCornerRadius == 0f) defaultBoxCornerRadius else styledBoxCornerRadius
+}

forage-android/src/main/java/com/joinforage/forage/android/ui/BTVaultWrapper.kt

@@ -8,6 +8,7 @@ import android.util.AttributeSet
 import android.view.Gravity
 import android.view.View
 import android.view.ViewGroup
+import android.widget.EditText
 import android.widget.LinearLayout
 import com.basistheory.android.view.TextElement
 import com.basistheory.android.view.mask.ElementMask
@@ -106,6 +107,10 @@ internal class BTVaultWrapper @JvmOverloads constructor(
         return _internalTextElement
     }
 
+    override fun getForageTextElement(): EditText {
+        throw RuntimeException("Unimplemented for this vault!")
+    }
+
     override fun getUnderlying(): View {
         return _internalTextElement
     }

forage-android/src/main/java/com/joinforage/forage/android/ui/ForagePINEditText.kt

@@ -31,6 +31,7 @@ class ForagePINEditText @JvmOverloads constructor(
     private val _linearLayout: LinearLayout
     private val btVaultWrapper: BTVaultWrapper
     private val vgsVaultWrapper: VGSVaultWrapper
+    private val forageVaultWrapper: ForageVaultWrapper
 
     /**
      * The `vault` property acts as an abstraction for the actual code
@@ -69,16 +70,18 @@ class ForagePINEditText @JvmOverloads constructor(
 
                     // at this point in time, we do not know the environment and
                     // we are operating and thus do not know whether to add
-                    // BTVaultWrapper or VGSVaultWrapper to the UI.
-                    // But that's OK. We can hedge and instantiate both of them
+                    // BTVaultWrapper, VGSVaultWrapper, or ForageVaultWrapper to the UI.
+                    // But that's OK. We can hedge and instantiate all of them.
                     // Then, within setForageConfig, once we know the environment
                     // and are thus able to initial LaunchDarkly and find out
-                    // whether to use BT or VGS. So, below we are hedging
+                    // whether to use BT or VGS. So, below we are hedging.
                     btVaultWrapper = BTVaultWrapper(context, attrs, defStyleAttr)
                     vgsVaultWrapper = VGSVaultWrapper(context, attrs, defStyleAttr)
-                    // ensure both wrappers init with the
+                    forageVaultWrapper = ForageVaultWrapper(context, attrs, defStyleAttr)
+                    // ensure all wrappers init with the
                     // same typeface (or the attributes)
                     btVaultWrapper.typeface = vgsVaultWrapper.typeface
+                    forageVaultWrapper.typeface = vgsVaultWrapper.typeface
 
                     val elementWidth: Int = getDimensionPixelSize(R.styleable.ForagePINEditText_elementWidth, ViewGroup.LayoutParams.MATCH_PARENT)
                     val elementHeight: Int = getDimensionPixelSize(R.styleable.ForagePINEditText_elementHeight, ViewGroup.LayoutParams.WRAP_CONTENT)

forage-android/src/main/java/com/joinforage/forage/android/ui/ForageVaultWrapper.kt

@@ -0,0 +1,137 @@
+package com.joinforage.forage.android.ui
+
+import android.content.Context
+import android.graphics.Color
+import android.graphics.Typeface
+import android.graphics.drawable.GradientDrawable
+import android.text.InputFilter
+import android.text.InputType
+import android.util.AttributeSet
+import android.util.TypedValue
+import android.view.Gravity
+import android.widget.EditText
+import android.widget.LinearLayout
+import com.basistheory.android.view.TextElement
+import com.joinforage.forage.android.R
+import com.joinforage.forage.android.core.element.state.PinElementStateManager
+import com.verygoodsecurity.vgscollect.widget.VGSEditText
+
+internal class ForageVaultWrapper @JvmOverloads constructor(
+    context: Context,
+    attrs: AttributeSet? = null,
+    defStyleAttr: Int = 0
+) : VaultWrapper(context, attrs, defStyleAttr) {
+    private val _editText: EditText
+    override val manager: PinElementStateManager = PinElementStateManager.forEmptyInput()
+
+    init {
+        context.obtainStyledAttributes(attrs, R.styleable.ForagePINEditText, defStyleAttr, 0)
+            .apply {
+                try {
+                    val parsedStyles = parseStyles(context, attrs)
+
+                    _editText = EditText(context, null, parsedStyles.textInputLayoutStyleAttribute).apply {
+                        layoutParams =
+                            LinearLayout.LayoutParams(
+                                parsedStyles.inputWidth,
+                                parsedStyles.inputHeight
+                            )
+
+                        setTextIsSelectable(true)
+                        isSingleLine = true
+
+                        val maxLength = 4
+                        filters = arrayOf(InputFilter.LengthFilter(maxLength))
+
+                        if (parsedStyles.textColor != Color.BLACK) {
+                            setTextColor(parsedStyles.textColor)
+                        }
+
+                        if (parsedStyles.textSize != -1f) {
+                            setTextSize(TypedValue.COMPLEX_UNIT_PX, parsedStyles.textSize)
+                        }
+
+                        inputType =
+                            InputType.TYPE_CLASS_NUMBER or InputType.TYPE_NUMBER_VARIATION_PASSWORD
+
+                        gravity = Gravity.CENTER
+                        hint = parsedStyles.hint
+                        setHintTextColor(parsedStyles.hintTextColor)
+
+                        val customBackground = GradientDrawable().apply {
+                            setPaddingRelative(20, 20, 20, 20)
+                            shape = GradientDrawable.RECTANGLE
+                            cornerRadii = floatArrayOf(
+                                parsedStyles.boxCornerRadiusTopStart,
+                                parsedStyles.boxCornerRadiusTopStart,
+                                parsedStyles.boxCornerRadiusTopEnd,
+                                parsedStyles.boxCornerRadiusTopEnd,
+                                parsedStyles.boxCornerRadiusBottomStart,
+                                parsedStyles.boxCornerRadiusBottomStart,
+                                parsedStyles.boxCornerRadiusBottomEnd,
+                                parsedStyles.boxCornerRadiusBottomEnd
+                            )
+                            setStroke(5, parsedStyles.boxStrokeColor)
+                            setColor(parsedStyles.boxBackgroundColor)
+                        }
+                        background = customBackground
+                    }
+
+                    _editText.setOnFocusChangeListener { _, hasFocus ->
+                        manager.changeFocus(hasFocus)
+                    }
+                    val pinTextWatcher = PinTextWatcher(_editText)
+                    pinTextWatcher.onInputChangeEvent { isComplete, isEmpty ->
+                        manager.handleChangeEvent(isComplete, isEmpty)
+                    }
+                    _editText.addTextChangedListener(pinTextWatcher)
+                } finally {
+                    recycle()
+                }
+            }
+    }
+
+    override fun clearText() {
+        _editText.setText("")
+    }
+
+    override fun getForageTextElement(): EditText {
+        return _editText
+    }
+
+    override fun getTextElement(): TextElement {
+        throw RuntimeException("Unimplemented for this vault!")
+    }
+
+    override fun getVGSEditText(): VGSEditText {
+        throw RuntimeException("Unimplemented for this vault!")
+    }
+
+    override fun getUnderlying(): EditText {
+        return _editText
+    }
+
+    override var typeface: Typeface?
+        get() = _editText.typeface
+        set(value) {
+            if (value != null) {
+                _editText.typeface = value
+            }
+        }
+
+    override fun setTextColor(textColor: Int) {
+        _editText.setTextColor(textColor)
+    }
+
+    override fun setTextSize(textSize: Float) {
+        _editText.textSize = textSize
+    }
+
+    override fun setHint(hint: String) {
+        _editText.hint = hint
+    }
+
+    override fun setHintTextColor(hintTextColor: Int) {
+        _editText.setHintTextColor(hintTextColor)
+    }
+}

forage-android/src/main/java/com/joinforage/forage/android/ui/PinTextWatcher.kt

@@ -0,0 +1,29 @@
+package com.joinforage.forage.android.ui
+
+import android.text.Editable
+import android.text.TextWatcher
+import android.widget.EditText
+
+internal class PinTextWatcher(
+    private val editText: EditText
+) : TextWatcher {
+    private var onInputChangeEvent: ((Boolean, Boolean) -> Unit)? = null
+
+    fun onInputChangeEvent(callback: (Boolean, Boolean) -> Unit) {
+        onInputChangeEvent = callback
+    }
+
+    override fun beforeTextChanged(p0: CharSequence?, p1: Int, p2: Int, p3: Int) {
+        // a no-op for now
+    }
+
+    override fun onTextChanged(p0: CharSequence?, p1: Int, p2: Int, p3: Int) {
+        // a no-op for now
+    }
+
+    override fun afterTextChanged(editable: Editable) {
+        val isValidAndComplete = editText.length() == 4
+        val isEmpty = editText.length() == 0
+        onInputChangeEvent?.invoke(isValidAndComplete, isEmpty)
+    }
+}

forage-android/src/main/java/com/joinforage/forage/android/ui/VGSVaultWrapper.kt

@@ -8,6 +8,7 @@ import android.util.AttributeSet
 import android.util.TypedValue
 import android.view.Gravity
 import android.view.ViewGroup
+import android.widget.EditText
 import android.widget.LinearLayout
 import com.basistheory.android.view.TextElement
 import com.joinforage.forage.android.core.element.state.PinElementStateManager
@@ -96,7 +97,7 @@ internal class VGSVaultWrapper @JvmOverloads constructor(
                     // up into separate focus and blur listeners. This requires
                     // that we pass a single listener to VGS on init that uses
                     // mutable references to listeners so that setting the focus
-                    // would not remove the blur listener and vice versea
+                    // would not remove the blur listener and vice versa
                     _internalEditText.setOnFocusChangeListener { _, hasFocus ->
                         manager.changeFocus(hasFocus)
                     }
@@ -127,6 +128,10 @@ internal class VGSVaultWrapper @JvmOverloads constructor(
         throw RuntimeException("Unimplemented for this vault!")
     }
 
+    override fun getForageTextElement(): EditText {
+        throw RuntimeException("Unimplemented for this vault!")
+    }
+
     override fun getUnderlying(): VGSEditText {
         return _internalEditText
     }

forage-android/src/main/java/com/joinforage/forage/android/ui/VaultWrapper.kt

@@ -1,19 +1,41 @@
 package com.joinforage.forage.android.ui
 
 import android.content.Context
+import android.content.res.ColorStateList
 import android.content.res.TypedArray
+import android.graphics.Color
 import android.graphics.Typeface
 import android.util.AttributeSet
 import android.util.TypedValue
 import android.view.View
+import android.view.ViewGroup
+import android.widget.EditText
 import android.widget.FrameLayout
 import com.basistheory.android.view.TextElement
+import com.joinforage.forage.android.R
 import com.joinforage.forage.android.core.element.SimpleElementListener
 import com.joinforage.forage.android.core.element.StatefulElementListener
 import com.joinforage.forage.android.core.element.state.PinElementState
 import com.joinforage.forage.android.core.element.state.PinElementStateManager
+import com.joinforage.forage.android.getBoxCornerRadius
 import com.verygoodsecurity.vgscollect.widget.VGSEditText
 
+internal data class ParsedStyles(
+    val textInputLayoutStyleAttribute: Int,
+    val boxStrokeColor: Int,
+    val boxBackgroundColor: Int,
+    val boxCornerRadiusTopStart: Float,
+    val boxCornerRadiusTopEnd: Float,
+    val boxCornerRadiusBottomStart: Float,
+    val boxCornerRadiusBottomEnd: Float,
+    val hint: String?,
+    val hintTextColor: ColorStateList?,
+    val inputWidth: Int,
+    val inputHeight: Int,
+    val textSize: Float,
+    val textColor: Int
+)
+
 internal abstract class VaultWrapper @JvmOverloads constructor(
     context: Context,
     attrs: AttributeSet? = null,
@@ -38,37 +60,40 @@
     abstract fun getUnderlying(): View
     abstract fun getVGSEditText(): VGSEditText
     abstract fun getTextElement(): TextElement
+    abstract fun getForageTextElement(): EditText
+
+    fun parseStyles(context: Context, attrs: AttributeSet?): ParsedStyles {
+        val defaultRadius = resources.getDimension(R.dimen.default_horizontal_field)
+        val typedArray: TypedArray = context.obtainStyledAttributes(attrs, R.styleable.ForagePINEditText)
+        val boxCornerRadius = typedArray.getDimension(R.styleable.ForagePINEditText_boxCornerRadius, defaultRadius)
+
+        try {
+            return ParsedStyles(
+                textInputLayoutStyleAttribute = typedArray.getResourceId(R.styleable.ForagePINEditText_pinInputLayoutStyle, 0),
+                boxStrokeColor = typedArray.getColor(R.styleable.ForagePINEditText_pinBoxStrokeColor, getThemeAccentColor(context)),
+                boxBackgroundColor = typedArray.getColor(R.styleable.ForagePINEditText_boxBackgroundColor, Color.TRANSPARENT),
+                boxCornerRadiusTopStart = typedArray.getBoxCornerRadius(R.styleable.ForagePINEditText_boxCornerRadiusTopStart, boxCornerRadius),
+                boxCornerRadiusTopEnd = typedArray.getBoxCornerRadius(R.styleable.ForagePINEditText_boxCornerRadiusTopEnd, boxCornerRadius),
+                boxCornerRadiusBottomStart = typedArray.getBoxCornerRadius(R.styleable.ForagePINEditText_boxCornerRadiusBottomStart, boxCornerRadius),
+                boxCornerRadiusBottomEnd = typedArray.getBoxCornerRadius(R.styleable.ForagePINEditText_boxCornerRadiusBottomEnd, boxCornerRadius),
+                hint = typedArray.getString(R.styleable.ForagePINEditText_hint),
+                hintTextColor = typedArray.getColorStateList(R.styleable.ForagePINEditText_hintTextColor),
+                inputWidth = typedArray.getDimensionPixelSize(R.styleable.ForagePINEditText_inputWidth, ViewGroup.LayoutParams.MATCH_PARENT),
+                inputHeight = typedArray.getDimensionPixelSize(R.styleable.ForagePINEditText_inputHeight, ViewGroup.LayoutParams.WRAP_CONTENT),
+                textSize = typedArray.getDimension(R.styleable.ForagePINEditText_textSize, -1f),
+                textColor = typedArray.getColor(R.styleable.ForagePINEditText_textColor, Color.BLACK)
+            )
+        } finally {
+            typedArray.recycle()
+        }
+    }
 
     fun getThemeAccentColor(context: Context): Int {
         val outValue = TypedValue()
         context.theme.resolveAttribute(android.R.attr.colorAccent, outValue, true)
         return outValue.data
     }
 
-    fun TypedArray.getBoxCornerRadiusBottomStart(boxCornerRadius: Float): Float {
-        val boxCornerRadiusBottomStart =
-            getDimension(com.joinforage.forage.android.R.styleable.ForagePINEditText_boxCornerRadiusBottomStart, 0f)
-        return if (boxCornerRadiusBottomStart == 0f) boxCornerRadius else boxCornerRadiusBottomStart
-    }
-
-    fun TypedArray.getBoxCornerRadiusTopEnd(boxCornerRadius: Float): Float {
-        val boxCornerRadiusTopEnd =
-            getDimension(com.joinforage.forage.android.R.styleable.ForagePINEditText_boxCornerRadiusTopEnd, 0f)
-        return if (boxCornerRadiusTopEnd == 0f) boxCornerRadius else boxCornerRadiusTopEnd
-    }
-
-    fun TypedArray.getBoxCornerRadiusBottomEnd(boxCornerRadius: Float): Float {
-        val boxCornerRadiusBottomEnd =
-            getDimension(com.joinforage.forage.android.R.styleable.ForagePINEditText_boxCornerRadiusBottomEnd, 0f)
-        return if (boxCornerRadiusBottomEnd == 0f) boxCornerRadius else boxCornerRadiusBottomEnd
-    }
-
-    fun TypedArray.getBoxCornerRadiusTopStart(boxCornerRadius: Float): Float {
-        val boxCornerRadiusTopStart =
-            getDimension(com.joinforage.forage.android.R.styleable.ForagePINEditText_boxCornerRadiusTopStart, 0f)
-        return if (boxCornerRadiusTopStart == 0f) boxCornerRadius else boxCornerRadiusTopStart
-    }
-
     fun setOnFocusEventListener(l: SimpleElementListener) {
         manager.setOnFocusEventListener(l)
     }