Merge pull request #241 from fmasa/trapping-note

fmasa · web-flow · commit 38b36679bbdd · 2024-01-14T22:47:14.000+01:00
Custom note for Trappins from Compendium
diff --git a/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/CharacterTrappingDetailScreen.kt b/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/CharacterTrappingDetailScreen.kt
@@ -1,6 +1,8 @@
 package cz.frantisekmasa.wfrp_master.common.character.trappings
 
+import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.ColumnScope
+import androidx.compose.foundation.layout.fillMaxWidth
 import androidx.compose.foundation.layout.padding
 import androidx.compose.material.Scaffold
 import androidx.compose.material.Text
@@ -37,6 +39,7 @@ import cz.frantisekmasa.wfrp_master.common.core.ui.navigation.LocalNavigationTra
 import cz.frantisekmasa.wfrp_master.common.core.ui.primitives.Spacing
 import cz.frantisekmasa.wfrp_master.common.core.ui.primitives.rememberScreenModel
 import cz.frantisekmasa.wfrp_master.common.core.ui.scaffolding.IconAction
+import cz.frantisekmasa.wfrp_master.common.core.ui.text.MarkdownTextValue
 import dev.icerock.moko.resources.compose.stringResource
 
 class CharacterTrappingDetailScreen(
@@ -139,6 +142,18 @@ private fun TrappingDetail(
                     }
                 )
             }
+
+            if (trapping.note.isNotBlank()) {
+                Box(
+                    Modifier
+                        .fillMaxWidth()
+                        .padding(horizontal = Spacing.bodyPadding)
+                        .padding(top = Spacing.bodyPadding),
+                    contentAlignment = Alignment.Center,
+                ) {
+                    MarkdownTextValue(stringResource(Str.trappings_note), trapping.note)
+                }
+            }
         }
 
         when (val type = trapping.trappingType) {
diff --git a/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/EditPlayerDataDialog.kt b/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/EditPlayerDataDialog.kt
@@ -4,22 +4,26 @@ import androidx.compose.runtime.Composable
 import cz.frantisekmasa.wfrp_master.common.core.domain.trappings.InventoryItem
 
 @Composable
-fun EditQualitiesDetailDialog(
+fun EditPlayerDataDialog(
     trapping: InventoryItem,
     onSaveRequest: suspend (InventoryItem) -> Unit,
     onDismissRequest: () -> Unit,
 ) {
     TrappingFromCompendiumForm(
         itemName = trapping.name,
-        itemQualities = trapping.itemQualities,
-        itemFlaws = trapping.itemFlaws,
-        quantity = trapping.quantity,
-        onSaveRequest = { qualities, flaws, quantity ->
+        data = TrappingFromCompendiumPlayerData(
+            itemQualities = trapping.itemQualities,
+            itemFlaws = trapping.itemFlaws,
+            quantity = trapping.quantity,
+            note = trapping.note,
+        ),
+        onSaveRequest = {
             onSaveRequest(
                 trapping.update(
-                    itemQualities = qualities,
-                    itemFlaws = flaws,
-                    quantity = quantity,
+                    itemQualities = it.itemQualities,
+                    itemFlaws = it.itemFlaws,
+                    quantity = it.quantity,
+                    note = it.note,
                 )
             )
             onDismissRequest()
diff --git a/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/EditTrappingDialog.kt b/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/EditTrappingDialog.kt
@@ -14,7 +14,7 @@ fun EditTrappingDialog(
         onDismissRequest = onDismissRequest,
     ) {
         if (existingItem.compendiumId != null) {
-            EditQualitiesDetailDialog(
+            EditPlayerDataDialog(
                 trapping = existingItem,
                 onSaveRequest = onSaveRequest,
                 onDismissRequest = onDismissRequest,
diff --git a/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/TrappingFromCompendiumForm.kt b/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/TrappingFromCompendiumForm.kt
@@ -20,6 +20,7 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.text.input.KeyboardType
 import cz.frantisekmasa.wfrp_master.common.Str
 import cz.frantisekmasa.wfrp_master.common.core.domain.localizedName
+import cz.frantisekmasa.wfrp_master.common.core.domain.trappings.InventoryItem
 import cz.frantisekmasa.wfrp_master.common.core.domain.trappings.ItemFlaw
 import cz.frantisekmasa.wfrp_master.common.core.domain.trappings.ItemQuality
 import cz.frantisekmasa.wfrp_master.common.core.ui.buttons.CloseButton
@@ -33,20 +34,18 @@ import cz.frantisekmasa.wfrp_master.common.core.ui.scaffolding.SaveAction
 import cz.frantisekmasa.wfrp_master.common.core.utils.launchLogged
 import dev.icerock.moko.resources.compose.stringResource
 import kotlinx.coroutines.Dispatchers
-import kotlin.math.max
 
 @Composable
 fun TrappingFromCompendiumForm(
     itemName: String,
-    itemQualities: Set<ItemQuality>,
-    itemFlaws: Set<ItemFlaw>,
-    quantity: Int,
-    onSaveRequest: suspend (Set<ItemQuality>, Set<ItemFlaw>, quantity: Int) -> Unit,
+    data: TrappingFromCompendiumPlayerData,
+    onSaveRequest: suspend (TrappingFromCompendiumPlayerData) -> Unit,
     onDismissRequest: () -> Unit,
 ) {
-    val quantityField = inputValue(quantity.toString(), Rules.PositiveInteger())
-    val qualityValues = rememberSaveable { mutableStateOf(itemQualities) }
-    val flawValues = rememberSaveable { mutableStateOf(itemFlaws) }
+    val quantityField = inputValue(data.quantity.toString(), Rules.PositiveInteger())
+    val noteField = inputValue(data.note)
+    val qualityValues = rememberSaveable { mutableStateOf(data.itemQualities) }
+    val flawValues = rememberSaveable { mutableStateOf(data.itemFlaws) }
     var validate by remember { mutableStateOf(false) }
 
     Scaffold(
@@ -68,9 +67,12 @@ fun TrappingFromCompendiumForm(
                             saving = true
                             coroutineScope.launchLogged(Dispatchers.IO) {
                                 onSaveRequest(
-                                    qualityValues.value,
-                                    flawValues.value,
-                                    max(quantityField.toInt(), 1),
+                                    TrappingFromCompendiumPlayerData(
+                                        itemQualities = qualityValues.value,
+                                        itemFlaws = flawValues.value,
+                                        quantity = quantityField.toInt().coerceAtLeast(1),
+                                        note = noteField.value,
+                                    )
                                 )
                                 onDismissRequest()
                             }
@@ -87,6 +89,16 @@ fun TrappingFromCompendiumForm(
                 .padding(Spacing.bodyPadding),
             verticalArrangement = Arrangement.spacedBy(Spacing.small),
         ) {
+
+            TextInput(
+                label = stringResource(Str.trappings_label_note),
+                value = noteField,
+                validate = validate,
+                multiLine = true,
+                helperText = stringResource(Str.common_ui_markdown_supported_note),
+                maxLength = InventoryItem.NOTE_MAX_LENGTH,
+            )
+
             InputLabel(stringResource(Str.trappings_label_item_qualities))
 
             CheckboxList(
@@ -112,3 +124,10 @@ fun TrappingFromCompendiumForm(
         }
     }
 }
+
+data class TrappingFromCompendiumPlayerData(
+    val itemQualities: Set<ItemQuality>,
+    val itemFlaws: Set<ItemFlaw>,
+    val quantity: Int,
+    val note: String,
+)
diff --git a/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/add/AddTrappingScreen.kt b/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/character/trappings/add/AddTrappingScreen.kt
@@ -10,6 +10,7 @@ import cz.frantisekmasa.wfrp_master.common.character.items.rememberAddItemUiStat
 import cz.frantisekmasa.wfrp_master.common.character.trappings.CharacterTrappingDetailScreen
 import cz.frantisekmasa.wfrp_master.common.character.trappings.NonCompendiumTrappingForm
 import cz.frantisekmasa.wfrp_master.common.character.trappings.TrappingFromCompendiumForm
+import cz.frantisekmasa.wfrp_master.common.character.trappings.TrappingFromCompendiumPlayerData
 import cz.frantisekmasa.wfrp_master.common.character.trappings.trappingIcon
 import cz.frantisekmasa.wfrp_master.common.core.domain.identifiers.CharacterId
 import cz.frantisekmasa.wfrp_master.common.core.domain.trappings.InventoryItem
@@ -58,15 +59,19 @@ class AddTrappingScreen(
             specification = { compendiumTrapping ->
                 TrappingFromCompendiumForm(
                     itemName = compendiumTrapping.name,
-                    itemQualities = emptySet(),
-                    itemFlaws = emptySet(),
-                    quantity = 1,
-                    onSaveRequest = { itemQualities, itemFlaws, quantity ->
+                    data = TrappingFromCompendiumPlayerData(
+                        itemQualities = emptySet(),
+                        itemFlaws = emptySet(),
+                        quantity = 1,
+                        note = "",
+                    ),
+                    onSaveRequest = {
                         val item = InventoryItem.fromCompendium(
                             compendiumTrapping,
-                            itemQualities,
-                            itemFlaws,
-                            quantity,
+                            it.itemQualities,
+                            it.itemFlaws,
+                            it.quantity,
+                            it.note,
                         )
 
                         addItemUiState.saveItem(
diff --git a/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/core/domain/trappings/InventoryItem.kt b/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/core/domain/trappings/InventoryItem.kt
@@ -5,6 +5,7 @@ import androidx.compose.runtime.Stable
 import com.benasher44.uuid.Uuid
 import com.benasher44.uuid.uuid4
 import cz.frantisekmasa.wfrp_master.common.compendium.domain.Trapping
+import cz.frantisekmasa.wfrp_master.common.core.common.requireMaxLength
 import cz.frantisekmasa.wfrp_master.common.core.domain.character.CharacterItem
 import cz.frantisekmasa.wfrp_master.common.core.utils.duplicateName
 import dev.icerock.moko.parcelize.Parcelize
@@ -21,6 +22,10 @@ data class InventoryItem(
     @Contextual override val id: InventoryItemId,
     val name: String,
     val description: String,
+    /**
+     * Used as custom player note for trappings where description is taken from compendium.
+     */
+    val note: String = "",
     val quantity: Int,
     val encumbrance: Encumbrance = Encumbrance.Zero,
     @Contextual val containerId: InventoryItemId? = null,
@@ -32,6 +37,7 @@ data class InventoryItem(
 
     init {
         require(quantity > 0) { "Quantity must be greater than 0" }
+        note.requireMaxLength(NOTE_MAX_LENGTH, "note")
     }
 
     @Stable
@@ -69,13 +75,15 @@ data class InventoryItem(
         itemQualities: Set<ItemQuality>,
         itemFlaws: Set<ItemFlaw>,
         quantity: Int,
+        note: String,
     ): InventoryItem = copy(
         encumbrance = encumbrance -
             encumbranceModifier(this.itemQualities, this.itemFlaws) +
             encumbranceModifier(this.itemQualities, this.itemFlaws),
         itemQualities = itemQualities,
         itemFlaws = itemFlaws,
         quantity = quantity,
+        note = note,
     )
 
     override fun unlinkFromCompendium() = copy(compendiumId = null)
@@ -102,12 +110,14 @@ data class InventoryItem(
     companion object {
         const val NAME_MAX_LENGTH = Trapping.NAME_MAX_LENGTH
         const val DESCRIPTION_MAX_LENGTH = Trapping.DESCRIPTION_MAX_LENGTH
+        const val NOTE_MAX_LENGTH = 500
 
         fun fromCompendium(
             compendiumItem: Trapping,
             itemQualities: Set<ItemQuality>,
             itemFlaws: Set<ItemFlaw>,
             quantity: Int,
+            note: String,
         ): InventoryItem {
             return InventoryItem(
                 id = uuid4(),
@@ -117,6 +127,7 @@ data class InventoryItem(
                 itemFlaws = itemFlaws,
                 trappingType = TrappingType.fromCompendium(compendiumItem.trappingType),
                 description = compendiumItem.description,
+                note = note,
                 quantity = quantity,
                 containerId = null,
                 compendiumId = compendiumItem.id,
diff --git a/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/core/ui/text/MarkdownTextValue.kt b/common/src/commonMain/kotlin/cz/frantisekmasa/wfrp_master/common/core/ui/text/MarkdownTextValue.kt
@@ -0,0 +1,24 @@
+package cz.frantisekmasa.wfrp_master.common.core.ui.text
+
+import androidx.compose.foundation.layout.Column
+import androidx.compose.material.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.text.font.FontWeight
+import com.halilibo.richtext.markdown.Markdown
+import com.halilibo.richtext.ui.RichText
+
+@Composable
+fun MarkdownTextValue(label: String, value: String) {
+    if (value.isBlank()) return
+
+    Column {
+        Text(
+            "$label:",
+            fontWeight = FontWeight.Bold,
+        )
+
+        RichText {
+            Markdown(value)
+        }
+    }
+}
diff --git a/common/src/commonMain/resources/MR/base/strings.xml b/common/src/commonMain/resources/MR/base/strings.xml
@@ -628,6 +628,8 @@
     <string name="trappings_label_item_qualities">Item Qualities</string>
     <string name="trappings_label_item_flaws">Item Flaws</string>
     <string name="trappings_label_name">Name</string>
+    <string name="trappings_label_note">Note (optional)</string>
+    <string name="trappings_note">Note</string>
     <string name="trappings_label_pack_size">Pack size</string>
     <string name="trappings_label_price">Price</string>
     <string name="trappings_label_qualities">Qualities</string>
diff --git a/common/src/commonMain/resources/MR/es/strings.xml b/common/src/commonMain/resources/MR/es/strings.xml
@@ -386,6 +386,8 @@
     <string name="journal_messages_no_entries">Ninguna entrada</string>
     <string name="character_tab_conditions">Condiciones</string>
     <string name="compendium_messages_export_failed">La exportación del JSON ha fallado.</string>
+    <string name="trappings_label_note">Nota (opcional)</string>
+    <string name="trappings_note">Nota</string>
     <string name="trappings_label_item_flaws">Defectos de objeto</string>
     <string name="combat_hit_locations_left_arm">Brazo Izquierdo</string>
     <string name="races_ogre">Ogro</string>
diff --git a/common/src/commonMain/resources/MR/fr/strings.xml b/common/src/commonMain/resources/MR/fr/strings.xml
@@ -622,6 +622,8 @@
     <string name="trappings_flaws_unreliable">Peu fiable</string>
     <string name="trappings_flaws_ugly">Laid</string>
     <string name="trappings_qualities_practical">Pratique</string>
+    <string name="trappings_label_note">Note (optionnel)</string>
+    <string name="trappings_note">Note</string>
     <string name="trappings_label_qualities">Qualités</string>
     <string name="trappings_label_quantity">Quantité</string>
     <string name="trappings_flaws_shoddy">Bâclé</string>
diff --git a/common/src/commonMain/resources/MR/it/strings.xml b/common/src/commonMain/resources/MR/it/strings.xml
@@ -508,6 +508,8 @@
     <string name="trappings_label_encumbrance_total">Ingombro (totale)</string>
     <string name="trappings_label_flaws">Difetti</string>
     <string name="trappings_label_name">Nome</string>
+    <string name="trappings_label_note">Nota (opzionale)</string>
+    <string name="trappings_note">Nota</string>
     <string name="trappings_label_qualities">Qualità</string>
     <string name="trappings_label_quantity">Quantità</string>
     <string name="trappings_label_type">Tipo di Avere</string>
diff --git a/firebase/firestore.rules b/firebase/firestore.rules
@@ -306,7 +306,7 @@ service cloud.firestore {
                     allow delete: if canEditCharacter();
 
                     function isValidInventoryItem(item) {
-                        return ["id", "name", "description", "quantity", "encumbrance", "trappingType", "containerId", "compendiumId", "itemQualities", "itemFlaws"].hasAll(item.keys())
+                        return ["id", "name", "description", "note", "quantity", "encumbrance", "trappingType", "containerId", "compendiumId", "itemQualities", "itemFlaws"].hasAll(item.keys())
                             && item.id is string && item.id == itemId && isValidUuid(item.id)
                             && item.name is string && isNotBlank(item.name) && item.name.size() <= 50
                             && item.description is string && item.description.size() <= 2500
@@ -316,6 +316,7 @@ service cloud.firestore {
                             && (! ("containerId" in item)
                                 || item.containerId == null || containerExists(item.containerId)
                             )
+                            && (! ("note" in item) || (item.note is string && item.note.size() <= 500))
                             && (!("compendiumId" in item) || (item.compendiumId == null || (item.compendiumId is string && exists(/databases/$(database)/documents/parties/$(partyId)/trappings/$(item.compendiumId)))));
                     }
 
