Merge pull request benjamin-luescher#9 from benjamin-luescher/feature/is_visible_refactoring

Ignore hidden fields for validation

Author: benjamin-luescher

README.md

@@ -23,7 +23,7 @@ dependencyResolutionManagement {
 
 2. Add the dependency in your build.gradle file.
 ```kotlin
-implementation 'com.github.benjamin-luescher:compose-form:0.2.4'
+implementation 'com.github.benjamin-luescher:compose-form:0.2.5'
 ```
 
 ## Easy example

app/src/main/java/com/edorex/mobile/composeForm/MainForm.kt

@@ -1,6 +1,5 @@
 package com.edorex.mobile.composeForm
 
-import android.util.Log
 import androidx.compose.runtime.mutableStateOf
 import ch.benlu.composeform.*
 import ch.benlu.composeform.validators.*
@@ -45,6 +44,7 @@ class MainForm(resourcesProvider: ResourcesProvider): Form() {
     @FormField
     val passwordConfirm = FieldState(
         state = mutableStateOf<String?>(null),
+        isVisible = { password.state.value != null && password.state.value!!.isNotEmpty()  },
         validators = mutableListOf(
             IsEqualValidator({ password.state.value })
         )
@@ -83,15 +83,14 @@ class MainForm(resourcesProvider: ResourcesProvider): Form() {
             null,
             Country(code = "CH", name = "Switzerland"),
             Country(code = "DE", name = "Germany")
-        ),
-        optionItemFormatter = {
-            if (it != null) {
-                "${it.name} (${it.code})"
-            } else {
-                "All"
-            }
+        )
+    ) {
+        if (it != null) {
+            "${it.name} (${it.code})"
+        } else {
+            "All"
         }
-    )
+    }
 
     @FormField
     val startDate = FieldState(

composeform/build.gradle

@@ -69,7 +69,7 @@ publishing {
         release(MavenPublication) {
             groupId = 'com.github.benjamin-luescher'
             artifactId = 'compose-form'
-            version = '0.2.4'
+            version = '0.2.5'
 
             afterEvaluate {
                 from components.release

composeform/src/main/java/ch/benlu/composeform/Field.kt

@@ -8,13 +8,12 @@ import androidx.compose.ui.text.input.KeyboardType
 import androidx.compose.ui.text.input.VisualTransformation
 import java.util.*
 
-abstract class Field<T> constructor(
+abstract class Field<T> (
     open val fieldState: FieldState<T?>,
     open val label: String,
     open val form: Form,
     open val keyboardType: KeyboardType = KeyboardType.Text,
     open val visualTransformation: VisualTransformation = VisualTransformation.None,
-    open val isVisible: Boolean = true,
     open val isEnabled: Boolean = true,
     open val modifier: Modifier? = Modifier,
     open val imeAction: ImeAction? = ImeAction.Next,

composeform/src/main/java/ch/benlu/composeform/FieldState.kt

@@ -8,12 +8,13 @@ class FieldState<T>(
     val validators: MutableList<Validator<T>> = mutableListOf(),
     val errorText: MutableList<String> = mutableListOf(),
     val isValid: MutableState<Boolean?> = mutableStateOf(false),
+    val isVisible: () -> Boolean = { true },
     val hasChanges: MutableState<Boolean?> = mutableStateOf(false),
     var options: MutableList<T> = mutableListOf(),
     val optionItemFormatter: ((T?) -> String)? = null,
 ) {
     fun hasError(): Boolean {
-        return isValid.value == false && hasChanges.value == true
+        return isVisible() && isValid.value == false && hasChanges.value == true
     }
 
     fun selectedOption(): T? {

composeform/src/main/java/ch/benlu/composeform/Form.kt

@@ -8,6 +8,9 @@ abstract class Form {
 
     abstract fun self(): Form
 
+    /**
+     * Returns a list of all fields in the form.
+     */
     private fun getFormFields(): List<Pair<String, FormField?>> {
         return this::class.java.declaredFields.map {
             Pair(it.name, it.getAnnotation(FormField::class.java))
@@ -21,9 +24,10 @@ abstract class Form {
             f.isAccessible = true
 
             try {
-                val fieldState = (f.get(this) as FieldState<Any>)
-                val value = fieldState.state?.value
-                Log.d("Form", "$name:${value}")
+                val fieldState = (f.get(this) as FieldState<*>)
+                val value = fieldState.state.value
+                val isVisible = fieldState.isVisible()
+                Log.d("Form", "$name:${value} (isVisible: $isVisible)")
             } catch (e: Exception) {
                 Log.e("Form", e.toString())
             }
@@ -32,8 +36,10 @@ abstract class Form {
 
     /**
      * Triggers validation for all fields in the form.
+     * @param markAsChanged If true, all fields will be marked as changed.
+     * @param ignoreInvisible If true, invisible fields will be ignored during validation.
      */
-    fun validate(ignoreUntouched: Boolean = false) {
+    fun validate(markAsChanged: Boolean = false, ignoreInvisible: Boolean = true) {
         var isValid = true
         val formFields = getFormFields()
 
@@ -42,8 +48,15 @@ abstract class Form {
             val f = this::class.java.getDeclaredField(name)
             f.isAccessible = true
 
+
             try {
                 val fieldState = (f.get(this) as FieldState<Any>)
+
+                // if we should ignore invisible fields, skip validation
+                if (ignoreInvisible && !fieldState.isVisible()) {
+                    return@forEach
+                }
+
                 val value = fieldState.state?.value
                 val validators = fieldState.validators
 
@@ -58,14 +71,14 @@ abstract class Form {
                         isValid = false
                         isFieldValid = false
                         // add error text to fieldState
-                        fieldState.errorText.add(it.errorText!!)
+                        fieldState.errorText.add(it.errorText)
                     }
                 }
                 Log.d("Form", "Field Validation ($name): $isFieldValid")
                 fieldState.isValid.value = isFieldValid
 
                 // if we should ignore untouched fields, every field should be marked as changed
-                if (ignoreUntouched) {
+                if (markAsChanged) {
                     fieldState.hasChanges.value = true
                 }
 

composeform/src/main/java/ch/benlu/composeform/fields/CheckboxField.kt

@@ -13,7 +13,6 @@ class CheckboxField(
     form: Form,
     modifier: Modifier? = Modifier,
     fieldState: FieldState<Boolean?>,
-    isVisible: Boolean = true,
     isEnabled: Boolean = true,
     imeAction: ImeAction = ImeAction.Next,
     formatter: ((raw: Boolean?) -> String)? = null,
@@ -22,7 +21,6 @@ class CheckboxField(
     label = label,
     form = form,
     fieldState = fieldState,
-    isVisible = isVisible,
     isEnabled = isEnabled,
     modifier = modifier,
     imeAction = imeAction,
@@ -36,7 +34,7 @@ class CheckboxField(
     @Composable
     override fun Field() {
         this.updateComposableValue()
-        if (!isVisible) {
+        if (!fieldState.isVisible()) {
             return
         }
         CheckboxComponent(

composeform/src/main/java/ch/benlu/composeform/fields/DateField.kt

@@ -21,7 +21,6 @@ class DateField(
     form: Form,
     modifier: Modifier? = Modifier,
     fieldState: FieldState<Date?>,
-    isVisible: Boolean = true,
     isEnabled: Boolean = true,
     imeAction: ImeAction = ImeAction.Next,
     formatter: ((raw: Date?) -> String)? = null,
@@ -31,7 +30,6 @@ class DateField(
     label = label,
     form = form,
     fieldState = fieldState,
-    isVisible = isVisible,
     isEnabled = isEnabled,
     modifier = modifier,
     imeAction = imeAction,
@@ -45,7 +43,7 @@ class DateField(
     @Composable
     override fun Field() {
         this.updateComposableValue()
-        if (!isVisible) {
+        if (!fieldState.isVisible()) {
             return
         }
 

composeform/src/main/java/ch/benlu/composeform/fields/PasswordField.kt

@@ -25,15 +25,13 @@ class PasswordField(
     form: Form,
     modifier: Modifier? = Modifier,
     fieldState: FieldState<String?>,
-    isVisible: Boolean = true,
     isEnabled: Boolean = true,
     imeAction: ImeAction = ImeAction.Next,
     changed: ((v: String?) -> Unit)? = null
 ) : Field<String>(
     label = label,
     form = form,
     fieldState = fieldState,
-    isVisible = isVisible,
     isEnabled = isEnabled,
     modifier = modifier,
     imeAction = imeAction,
@@ -48,7 +46,7 @@ class PasswordField(
     @Composable
     override fun Field() {
         this.updateComposableValue()
-        if (!isVisible) {
+        if (!fieldState.isVisible()) {
             return
         }
 

composeform/src/main/java/ch/benlu/composeform/fields/PickerField.kt

@@ -25,7 +25,6 @@ class PickerField<T: PickerValue>(
     form: Form,
     modifier: Modifier? = Modifier,
     fieldState: FieldState<T?>,
-    isVisible: Boolean = true,
     isEnabled: Boolean = true,
     imeAction: ImeAction = ImeAction.Next,
     formatter: ((raw: T?) -> String)? = null,
@@ -35,7 +34,6 @@ class PickerField<T: PickerValue>(
     label = label,
     form = form,
     fieldState = fieldState,
-    isVisible = isVisible,
     isEnabled = isEnabled,
     modifier = modifier,
     imeAction = imeAction,
@@ -46,7 +44,7 @@ class PickerField<T: PickerValue>(
     @Composable
     override fun Field() {
         this.updateComposableValue()
-        if (!isVisible) {
+        if (!fieldState.isVisible()) {
             return
         }