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.

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

SpeziOnboarding #129

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package edu.stanford.bdh.engagehf.onboarding
import edu.stanford.bdh.engagehf.navigation.AppNavigationEvent
import edu.stanford.spezi.core.navigation.Navigator
import edu.stanford.spezi.core.utils.MessageNotifier
import edu.stanford.spezi.module.onboarding.consent.ConsentManager
import javax.inject.Inject

class EngageConsentManager @Inject internal constructor(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import dagger.Binds
import dagger.Module
import dagger.hilt.InstallIn
import dagger.hilt.components.SingletonComponent
import edu.stanford.spezi.module.onboarding.consent.ConsentManager
import edu.stanford.spezi.module.onboarding.invitation.InvitationCodeRepository
import edu.stanford.spezi.module.onboarding.onboarding.OnboardingRepository
import edu.stanford.spezi.module.onboarding.sequential.SequentialOnboardingRepository
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.items
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.collectAsState
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.font.FontWeight
Expand All @@ -14,6 +15,15 @@ import edu.stanford.spezi.core.design.theme.Spacings
import edu.stanford.spezi.core.design.theme.SpeziTheme
import edu.stanford.spezi.core.design.theme.TextStyles

@Composable
fun MarkdownComposable(data: suspend () -> ByteArray) {
// TODO: Figure out why hiltViewModel is not working and how one would do that anyways
val viewModel = remember { MarkdownViewModel(data, MarkdownParser()) }
val uiState = viewModel.uiState.collectAsState()

MarkdownComponent(uiState.value.elements ?: emptyList())
}

@Composable
fun MarkdownComponent(markdownElements: List<MarkdownElement>) {
LazyColumn(modifier = Modifier.padding(Spacings.medium)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ private const val HEADING_LEVEL_2 = 2
private const val HEADING_LEVEL_3 = 3

class MarkdownParser @Inject constructor() {

fun parse(text: String): List<MarkdownElement> = buildList {
text.lines().forEach { line ->
when {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package edu.stanford.spezi.core.design.component.markdown

Check warning on line 1 in core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt

View workflow job for this annotation

GitHub Actions / detekt

[detekt] core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt#L1 <detekt.FinalNewline>

File must end with a newline (\n)
Raw output
/github/workspace/core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt:1:1: warning: File must end with a newline (\n) (detekt.FinalNewline)

data class MarkdownUiState(
val elements: List<MarkdownElement>? = null

Check warning on line 4 in core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt

View workflow job for this annotation

GitHub Actions / detekt

[detekt] core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt#L4 <detekt.TrailingCommaOnDeclarationSite>

Missing trailing comma before ")"
Raw output
/github/workspace/core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt:4:48: warning: Missing trailing comma before ")" (detekt.TrailingCommaOnDeclarationSite)
)

Check warning on line 5 in core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt

View workflow job for this annotation

GitHub Actions / detekt

[detekt] core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt#L5 <detekt.NewLineAtEndOfFile>

The file /github/workspace/core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt is not ending with a new line.
Raw output
/github/workspace/core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt:5:2: warning: The file /github/workspace/core/design/src/main/kotlin/edu/stanford/spezi/core/design/component/markdown/MarkdownUiState.kt is not ending with a new line. (detekt.NewLineAtEndOfFile)
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package edu.stanford.spezi.core.design.component.markdown

import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import dagger.assisted.Assisted
import dagger.assisted.AssistedInject
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.update
import kotlinx.coroutines.launch
import java.nio.charset.StandardCharsets

internal class MarkdownViewModel @AssistedInject internal constructor(
@Assisted private val data: suspend () -> ByteArray,
private val markdownParser: MarkdownParser,
) : ViewModel() {
private val _uiState = MutableStateFlow(MarkdownUiState())
val uiState: StateFlow<MarkdownUiState> = _uiState

init {
viewModelScope.launch {
val markdownText = data().toString(StandardCharsets.UTF_8)
val markdownElements = markdownParser.parse(markdownText)
_uiState.update {
it.copy(elements = markdownElements)
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package edu.stanford.spezi.modules.contact.model
package edu.stanford.spezi.core.utils.foundation

data class PersonNameComponents(
val namePrefix: String? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import android.location.Address
import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.AccountBox
import edu.stanford.spezi.core.design.component.StringResource
import edu.stanford.spezi.core.utils.foundation.PersonNameComponents
import edu.stanford.spezi.modules.contact.model.Contact
import edu.stanford.spezi.modules.contact.model.ContactOption
import edu.stanford.spezi.modules.contact.model.PersonNameComponents
import edu.stanford.spezi.modules.contact.model.call
import edu.stanford.spezi.modules.contact.model.email
import edu.stanford.spezi.modules.contact.model.text
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import androidx.compose.ui.test.onChildAt
import androidx.test.platform.app.InstrumentationRegistry
import edu.stanford.spezi.core.design.component.StringResource
import edu.stanford.spezi.core.testing.onNodeWithIdentifier
import edu.stanford.spezi.core.utils.foundation.PersonNameComponents
import edu.stanford.spezi.modules.contact.ContactComposableTestIdentifier
import edu.stanford.spezi.modules.contact.model.ContactOption
import edu.stanford.spezi.modules.contact.model.PersonNameComponents
import edu.stanford.spezi.modules.contact.model.formatted

class ContactComposableSimulator(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ import edu.stanford.spezi.core.design.theme.SpeziTheme
import edu.stanford.spezi.core.design.theme.TextStyles
import edu.stanford.spezi.core.design.theme.ThemePreviews
import edu.stanford.spezi.core.utils.extensions.testIdentifier
import edu.stanford.spezi.core.utils.foundation.PersonNameComponents
import edu.stanford.spezi.modules.contact.component.AddressCard
import edu.stanford.spezi.modules.contact.component.ContactOptionCard
import edu.stanford.spezi.modules.contact.model.Contact
import edu.stanford.spezi.modules.contact.model.ContactOption
import edu.stanford.spezi.modules.contact.model.PersonNameComponents
import edu.stanford.spezi.modules.contact.model.call
import edu.stanford.spezi.modules.contact.model.email
import edu.stanford.spezi.modules.contact.model.text
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package edu.stanford.spezi.modules.contact.model
import android.location.Address
import androidx.compose.ui.graphics.vector.ImageVector
import edu.stanford.spezi.core.design.component.StringResource
import edu.stanford.spezi.core.utils.foundation.PersonNameComponents
import java.util.UUID

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import dagger.hilt.testing.TestInstallIn
import edu.stanford.spezi.module.account.di.AccountModule
import edu.stanford.spezi.module.account.manager.InvitationAuthManager
import edu.stanford.spezi.module.account.manager.UserSessionManager
import edu.stanford.spezi.module.onboarding.consent.ConsentManager
import edu.stanford.spezi.module.onboarding.fakes.FakeOnboardingRepository
import edu.stanford.spezi.module.onboarding.invitation.InvitationCodeRepository
import edu.stanford.spezi.module.onboarding.onboarding.OnboardingRepository
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package edu.stanford.spezi.module.onboarding
import edu.stanford.spezi.core.navigation.NavigationEvent

sealed class OnboardingNavigationEvent : NavigationEvent {

data object InvitationCodeScreen : OnboardingNavigationEvent()
data class OnboardingScreen(val clearBackStack: Boolean) : OnboardingNavigationEvent()
data object SequentialOnboardingScreen : OnboardingNavigationEvent()
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package edu.stanford.spezi.module.onboarding.consent

import edu.stanford.spezi.module.onboarding.views.Standard

interface ConsentConstraint : Standard {
suspend fun store(consent: ConsentDocumentExport)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package edu.stanford.spezi.module.onboarding.consent

import android.graphics.pdf.PdfDocument
import edu.stanford.spezi.module.onboarding.views.Standard
import javax.inject.Inject

class ConsentDataSource {
@Inject lateinit var standard: Standard

init {
if (standard !is ConsentConstraint) {
TODO("on iOS: fatalError")
}
}

suspend fun store(document: suspend () -> PdfDocument, identifier: String) {
(standard as? ConsentConstraint)?.let { consentConstraint ->
val export = ConsentDocumentExport(identifier, document)
consentConstraint.store(export)
} ?: TODO("on iOS: fatalError")
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
package edu.stanford.spezi.module.onboarding.consent

import android.annotation.SuppressLint
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Row
import androidx.compose.foundation.layout.Spacer
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.width
import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Info
import androidx.compose.material3.FilledTonalButton
import androidx.compose.material3.Icon
import androidx.compose.material3.OutlinedTextField
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.MutableState
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.ExperimentalComposeUiApi
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Path
import androidx.compose.ui.platform.LocalSoftwareKeyboardController
import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.tooling.preview.PreviewParameter
import androidx.compose.ui.tooling.preview.PreviewParameterProvider
import edu.stanford.spezi.core.design.component.StringResource
import edu.stanford.spezi.core.design.theme.Spacings
import edu.stanford.spezi.core.utils.foundation.PersonNameComponents
import edu.stanford.spezi.module.onboarding.views.ViewState
import java.nio.charset.StandardCharsets

data class ConsentDocument(
private val markdown: suspend () -> ByteArray,
private val viewState: MutableState<ConsentViewState>,
private val givenNameTitle: StringResource = LocalizationDefaults.givenNameTitle,
private val givenNamePlaceholder: StringResource = LocalizationDefaults.givenNamePlaceholder,
private val familyNameTitle: StringResource = LocalizationDefaults.familyNameTitle,
private val familyNamePlaceholder: StringResource = LocalizationDefaults.familyNamePlaceholder,
private val exportConfiguration: ConsentDocumentExportConfiguration = ConsentDocumentExportConfiguration(),
) {
object LocalizationDefaults {
val givenNameTitle = StringResource("Given Name")
val givenNamePlaceholder = StringResource("Given Name Placeholder")
val familyNameTitle = StringResource("Family Name")
val familyNamePlaceholder = StringResource("Family Name Placeholder")
}

@OptIn(ExperimentalComposeUiApi::class)
@Composable
internal fun Composable(
modifier: Modifier = Modifier,
uiState: ConsentUiState,
onAction: (ConsentAction) -> Unit

Check warning on line 54 in modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocument.kt

View workflow job for this annotation

GitHub Actions / detekt

[detekt] modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocument.kt#L54 <detekt.TrailingCommaOnDeclarationSite>

Missing trailing comma before ")"
Raw output
/github/workspace/modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocument.kt:54:42: warning: Missing trailing comma before ")" (detekt.TrailingCommaOnDeclarationSite)
) {
val givenName = uiState.name.givenName ?: ""
val familyName = uiState.name.familyName ?: ""

val keyboardController = LocalSoftwareKeyboardController.current
Column(modifier = modifier) {
OutlinedTextField(
value = givenName,
onValueChange = {
onAction(ConsentAction.TextFieldUpdate(it, TextFieldType.FIRST_NAME))
},
modifier = Modifier.fillMaxWidth(),
label = { Text(givenNameTitle.text()) },
singleLine = true,
placeholder = { Text(givenNamePlaceholder.text()) },
trailingIcon = { Icon(Icons.Filled.Info, contentDescription = "Information Icon") }
)
Spacer(modifier = Modifier.height(Spacings.small))
OutlinedTextField(
value = familyName,
onValueChange = {
onAction(ConsentAction.TextFieldUpdate(it, TextFieldType.LAST_NAME))
},
modifier = Modifier.fillMaxWidth(),
label = { Text(familyNameTitle.text()) },
placeholder = { Text(familyNamePlaceholder.text()) },
singleLine = true,
trailingIcon = {
Icon(
Icons.Filled.Info,
contentDescription = "Information Icon"
)
}
)


Check warning on line 90 in modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocument.kt

View workflow job for this annotation

GitHub Actions / detekt

[detekt] modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocument.kt#L90 <detekt.NoConsecutiveBlankLines>

Needless blank line(s)
Raw output
/github/workspace/modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocument.kt:90:1: warning: Needless blank line(s) (detekt.NoConsecutiveBlankLines)
if (givenName.isNotBlank() && familyName.isNotBlank()) {
Spacer(modifier = Modifier.height(Spacings.medium))
Text("Signature:")
SignatureCanvas(
paths = uiState.paths.toMutableList(),
firstName = givenName,
lastName = familyName,
onPathAdd = { path ->
onAction(ConsentAction.AddPath(path))
keyboardController?.hide()
}
)
Spacer(modifier = Modifier.height(Spacings.medium))
Row(modifier = Modifier.fillMaxWidth()) {
FilledTonalButton(
onClick = {
if (uiState.paths.isNotEmpty()) {
onAction(ConsentAction.Undo)
}
},
enabled = uiState.paths.isNotEmpty(),
modifier = Modifier.weight(1f),
) {
Text("Undo")
}
Spacer(modifier = Modifier.width(Spacings.medium))
}
}
}
}
}

@SuppressLint("UnrememberedMutableState")
@Preview
@Composable
private fun ConsentDocumentComposablePreview(
@PreviewParameter(ConsentDocumentComposablePreviewProvider::class) data: ConsentDocumentComposablePreviewData,
) {
ConsentDocument(
markdown = { "".toByteArray(StandardCharsets.UTF_8) },
viewState = remember { mutableStateOf(ConsentViewState.Base(ViewState.Idle)) },
).Composable(

Check warning on line 132 in modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocument.kt

View workflow job for this annotation

GitHub Actions / detekt

[detekt] modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocument.kt#L132 <detekt.Indentation>

Unexpected indentation (8) (should be 4)
Raw output
/github/workspace/modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocument.kt:132:1: warning: Unexpected indentation (8) (should be 4) (detekt.Indentation)
uiState = ConsentUiState(
name = data.name,
paths = data.paths
)
) {}
}

private data class ConsentDocumentComposablePreviewData(
val paths: MutableList<Path>,
val name: PersonNameComponents,
)

private class ConsentDocumentComposablePreviewProvider : PreviewParameterProvider<ConsentDocumentComposablePreviewData> {
override val values: Sequence<ConsentDocumentComposablePreviewData> = sequenceOf(
ConsentDocumentComposablePreviewData(
paths = mutableListOf(Path()),
name = PersonNameComponents(givenName = "", familyName = "")
),
@Suppress("MagicNumber")
ConsentDocumentComposablePreviewData(
paths = mutableListOf(Path().apply { lineTo(100f, 100f) }.apply { lineTo(250f, 200f) }),
name = PersonNameComponents(givenName = "Jane", familyName = "Doe")

)
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package edu.stanford.spezi.module.onboarding.consent

import android.graphics.pdf.PdfDocument

class ConsentDocumentExport(
private val documentIdentifier: String = Defaults.DOCUMENT_IDENTIFIER,
private val document: suspend () -> PdfDocument

Check warning on line 7 in modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocumentExport.kt

View workflow job for this annotation

GitHub Actions / detekt

[detekt] modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocumentExport.kt#L7 <detekt.TrailingCommaOnDeclarationSite>

Missing trailing comma before ")"
Raw output
/github/workspace/modules/onboarding/src/main/kotlin/edu/stanford/spezi/module/onboarding/consent/ConsentDocumentExport.kt:7:52: warning: Missing trailing comma before ")" (detekt.TrailingCommaOnDeclarationSite)
) {
private object Defaults {
const val DOCUMENT_IDENTIFIER = "ConsentDocument"
}

suspend fun createDocument() = document()
}

This file was deleted.

Loading
Loading