Compare commits
4 Commits
v0.4.0
...
1530c83fbc
| Author | SHA1 | Date | |
|---|---|---|---|
| 1530c83fbc | |||
| c65913c62a | |||
| 17e9451494 | |||
| b0117acac1 |
@@ -23,6 +23,7 @@ import androidx.compose.ui.Modifier
|
|||||||
import com.runicgateway.app.core.auth.sso.SsoAuthManager
|
import com.runicgateway.app.core.auth.sso.SsoAuthManager
|
||||||
import com.runicgateway.app.core.push.PushNotifier
|
import com.runicgateway.app.core.push.PushNotifier
|
||||||
import androidx.hilt.navigation.compose.hiltViewModel
|
import androidx.hilt.navigation.compose.hiltViewModel
|
||||||
|
import androidx.lifecycle.compose.LifecycleResumeEffect
|
||||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||||
import com.runicgateway.app.ui.AppViewModel
|
import com.runicgateway.app.ui.AppViewModel
|
||||||
import com.runicgateway.app.ui.AppViewModel.AppState
|
import com.runicgateway.app.ui.AppViewModel.AppState
|
||||||
@@ -30,8 +31,8 @@ import com.runicgateway.app.ui.LocalAssetResolver
|
|||||||
import com.runicgateway.app.ui.RunicApp
|
import com.runicgateway.app.ui.RunicApp
|
||||||
import com.runicgateway.app.ui.components.LoadingView
|
import com.runicgateway.app.ui.components.LoadingView
|
||||||
import com.runicgateway.app.ui.connect.ConnectScreen
|
import com.runicgateway.app.ui.connect.ConnectScreen
|
||||||
|
import com.runicgateway.app.data.appearance.SiteAppearance
|
||||||
import com.runicgateway.app.ui.theme.RunicGatewayTheme
|
import com.runicgateway.app.ui.theme.RunicGatewayTheme
|
||||||
import com.runicgateway.app.ui.theme.parseBrandColor
|
|
||||||
import dagger.hilt.android.AndroidEntryPoint
|
import dagger.hilt.android.AndroidEntryPoint
|
||||||
import kotlinx.coroutines.launch
|
import kotlinx.coroutines.launch
|
||||||
import javax.inject.Inject
|
import javax.inject.Inject
|
||||||
@@ -39,8 +40,8 @@ import javax.inject.Inject
|
|||||||
/**
|
/**
|
||||||
* Single-activity host (PLAN.md §2). Gates on [AppViewModel]: the first-run
|
* Single-activity host (PLAN.md §2). Gates on [AppViewModel]: the first-run
|
||||||
* connect screen until a shard site is configured (§3), then the main app.
|
* connect screen until a shard site is configured (§3), then the main app.
|
||||||
* The Material theme is seeded from the per-shard brand accent, and asset-path
|
* The Material theme is resolved from the shard's published appearance (M12),
|
||||||
* resolution is provided to the whole tree.
|
* and asset-path resolution is provided to the whole tree.
|
||||||
*/
|
*/
|
||||||
@AndroidEntryPoint
|
@AndroidEntryPoint
|
||||||
class MainActivity : ComponentActivity() {
|
class MainActivity : ComponentActivity() {
|
||||||
@@ -69,9 +70,21 @@ class MainActivity : ComponentActivity() {
|
|||||||
val appViewModel: AppViewModel = hiltViewModel()
|
val appViewModel: AppViewModel = hiltViewModel()
|
||||||
val state by appViewModel.state.collectAsStateWithLifecycle()
|
val state by appViewModel.state.collectAsStateWithLifecycle()
|
||||||
|
|
||||||
val accent = (state as? AppState.Ready)?.brand?.let { parseBrandColor(it.accent) }
|
// The whole theme, not just the accent (THEMING_AND_NAV.md §5.1): the
|
||||||
|
// resolved token map is applied field by field over the shipped palette,
|
||||||
|
// so NONE — before the site is connected, or when settings can't be
|
||||||
|
// read — is the app exactly as it shipped.
|
||||||
|
val appearance = (state as? AppState.Ready)?.appearance ?: SiteAppearance.NONE
|
||||||
|
|
||||||
RunicGatewayTheme(accent = accent) {
|
// The admin's theme and nav can change while the app is backgrounded
|
||||||
|
// (THEMING_AND_NAV.md §5.5). Re-read them on resume, beside the session
|
||||||
|
// re-validation RunicApp already does. Best-effort and silent.
|
||||||
|
LifecycleResumeEffect(Unit) {
|
||||||
|
appViewModel.refreshAppearance()
|
||||||
|
onPauseOrDispose { }
|
||||||
|
}
|
||||||
|
|
||||||
|
RunicGatewayTheme(appearance = appearance) {
|
||||||
CompositionLocalProvider(LocalAssetResolver provides appViewModel::resolveAsset) {
|
CompositionLocalProvider(LocalAssetResolver provides appViewModel::resolveAsset) {
|
||||||
Surface(
|
Surface(
|
||||||
modifier = Modifier.fillMaxSize(),
|
modifier = Modifier.fillMaxSize(),
|
||||||
@@ -83,7 +96,7 @@ class MainActivity : ComponentActivity() {
|
|||||||
ConnectScreen(onConnected = appViewModel::onConnected)
|
ConnectScreen(onConnected = appViewModel::onConnected)
|
||||||
is AppState.Ready ->
|
is AppState.Ready ->
|
||||||
RunicApp(
|
RunicApp(
|
||||||
brand = s.brand,
|
brand = s.appearance.brand,
|
||||||
onChangeServer = appViewModel::changeServer,
|
onChangeServer = appViewModel::changeServer,
|
||||||
deepLinkStream = pendingStream,
|
deepLinkStream = pendingStream,
|
||||||
onDeepLinkConsumed = { pendingStream = null },
|
onDeepLinkConsumed = { pendingStream = null },
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ package com.runicgateway.app.data.api.dto
|
|||||||
|
|
||||||
import kotlinx.serialization.SerialName
|
import kotlinx.serialization.SerialName
|
||||||
import kotlinx.serialization.Serializable
|
import kotlinx.serialization.Serializable
|
||||||
|
import kotlinx.serialization.json.JsonElement
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* DTOs for the public site/identity endpoints. Shapes mirror the backend
|
* DTOs for the public site/identity endpoints. Shapes mirror the backend
|
||||||
@@ -80,4 +81,28 @@ data class SettingsDto(
|
|||||||
val brand: BrandDto = BrandDto(),
|
val brand: BrandDto = BrandDto(),
|
||||||
/** Push relay config (M7); default (null ntfyUrl) on a backend that predates it. */
|
/** Push relay config (M7); default (null ntfyUrl) on a backend that predates it. */
|
||||||
val push: PushConfigDto = PushConfigDto(),
|
val push: PushConfigDto = PushConfigDto(),
|
||||||
|
/**
|
||||||
|
* The admin's **resolved** theme tokens — the CSS custom properties the site
|
||||||
|
* paints, already layered `:root ← preset ← custom` by the server
|
||||||
|
* (THEMING_AND_NAV.md §3). Absent when no `theme_visual` row exists, which
|
||||||
|
* means "the shipped defaults" and is the untouched-instance path.
|
||||||
|
*
|
||||||
|
* Held as a raw [JsonElement] rather than a `Map<String, String>` on
|
||||||
|
* purpose: a single unexpected value must not fail the decode of the whole
|
||||||
|
* settings payload and take `brand` and `push` down with it. It is coerced
|
||||||
|
* field-by-field by `SiteAppearance.from`.
|
||||||
|
*
|
||||||
|
* The raw `theme_visual` / `brand_assets` rows ride along in this same
|
||||||
|
* response and are deliberately **not** modeled — they are inputs, and
|
||||||
|
* re-deriving a palette from them would be a second `resolveThemeTokens` in
|
||||||
|
* Kotlin, guaranteed to drift (§3).
|
||||||
|
*/
|
||||||
|
val theme: JsonElement? = null,
|
||||||
|
/**
|
||||||
|
* The public nav overrides, as the raw JSON **string** stored in
|
||||||
|
* `settings.value` (TEXT) — so it is parsed a second time, exactly as the web
|
||||||
|
* client's `parseJsonSetting` does. Absent when the admin never edited the
|
||||||
|
* nav.
|
||||||
|
*/
|
||||||
|
@SerialName("nav_public") val navPublic: String? = null,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -0,0 +1,37 @@
|
|||||||
|
/*
|
||||||
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
*/
|
||||||
|
package com.runicgateway.app.data.appearance
|
||||||
|
|
||||||
|
import kotlinx.serialization.SerializationException
|
||||||
|
import kotlinx.serialization.json.Json
|
||||||
|
import kotlinx.serialization.json.JsonObject
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parse a JSON-valued settings row, client side — the second stage of decoding
|
||||||
|
* `nav_public` (THEMING_AND_NAV.md §3).
|
||||||
|
*
|
||||||
|
* The Kotlin counterpart to the web client's `lib/settingsJson.js`, and
|
||||||
|
* deliberately the same three lines of judgement: `settings.value` is TEXT, so
|
||||||
|
* the row arrives as a **string inside** the already-decoded settings object,
|
||||||
|
* and a malformed or wrong-shaped one must read as **absent** — the surface
|
||||||
|
* falls back to the coded default — never as an error and never as a
|
||||||
|
* half-applied object.
|
||||||
|
*/
|
||||||
|
private val settingsJson = Json { ignoreUnknownKeys = true }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param raw the raw stored value, as it arrived in the settings payload
|
||||||
|
* @return the parsed object, or null when absent/malformed
|
||||||
|
*/
|
||||||
|
fun parseJsonSetting(raw: String?): JsonObject? {
|
||||||
|
if (raw.isNullOrEmpty()) return null
|
||||||
|
val parsed = try {
|
||||||
|
settingsJson.parseToJsonElement(raw)
|
||||||
|
} catch (_: SerializationException) {
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
// Only plain objects. A stored `null`, `4`, `"x"` or array is as unusable to
|
||||||
|
// every consumer of these keys as a syntax error is.
|
||||||
|
return parsed as? JsonObject
|
||||||
|
}
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
/*
|
||||||
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
*/
|
||||||
|
package com.runicgateway.app.data.appearance
|
||||||
|
|
||||||
|
import com.runicgateway.app.data.api.dto.BrandDto
|
||||||
|
import com.runicgateway.app.data.api.dto.SettingsDto
|
||||||
|
import kotlinx.serialization.json.JsonObject
|
||||||
|
import kotlinx.serialization.json.JsonPrimitive
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Everything the app renders itself with that the shard's admin controls
|
||||||
|
* (THEMING_AND_NAV.md, M12): the brand block, the resolved theme tokens, and the
|
||||||
|
* public navigation overrides. One value, held once in [com.runicgateway.app.ui.AppViewModel],
|
||||||
|
* so the theme and the drawer can never disagree about which shard they are showing.
|
||||||
|
*
|
||||||
|
* **[NONE] is the shipped app.** An instance with no settings rows, a backend
|
||||||
|
* that predates the feature, and a settings call that failed outright are all the
|
||||||
|
* same state here, and all three must render exactly as the app did before this
|
||||||
|
* milestone existed (§2). That is why nothing on this class is nullable except
|
||||||
|
* [brand], which was already nullable and whose absence already meant "use the
|
||||||
|
* bundled strings".
|
||||||
|
*/
|
||||||
|
data class SiteAppearance(
|
||||||
|
/** The per-shard branding block; null when settings couldn't be loaded. */
|
||||||
|
val brand: BrandDto? = null,
|
||||||
|
/**
|
||||||
|
* The resolved CSS custom properties, keyed by token (`"--accent"` → `"#7f99bd"`).
|
||||||
|
* Empty means "the shipped defaults" — the server never emits an empty map,
|
||||||
|
* but absent and empty are the same thing to the app and it must not depend
|
||||||
|
* on that.
|
||||||
|
*/
|
||||||
|
val theme: Map<String, String> = emptyMap(),
|
||||||
|
/**
|
||||||
|
* The parsed `nav_public` row, or null when the admin never edited the nav.
|
||||||
|
* Kept as the raw object here; reading `items` / `sections` / `links` out of
|
||||||
|
* it is the job of the phases that render them.
|
||||||
|
*/
|
||||||
|
val navPublic: JsonObject? = null,
|
||||||
|
) {
|
||||||
|
companion object {
|
||||||
|
/** The shipped app: no brand, no overrides. Also what a failed load means. */
|
||||||
|
val NONE = SiteAppearance()
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build the appearance from a `GET /public/settings` body. Forgiving
|
||||||
|
* field by field (§2): a bad `--accent` must not discard a good `--bg`
|
||||||
|
* beside it, and a malformed `nav_public` must not cost the theme.
|
||||||
|
*/
|
||||||
|
fun from(settings: SettingsDto?): SiteAppearance {
|
||||||
|
if (settings == null) return NONE
|
||||||
|
return SiteAppearance(
|
||||||
|
brand = settings.brand,
|
||||||
|
theme = themeTokens(settings.theme as? JsonObject),
|
||||||
|
navPublic = parseJsonSetting(settings.navPublic),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every themable token is a string server-side (validated on write, and
|
||||||
|
// resolveThemeTokens only ever copies a validated value). Anything else
|
||||||
|
// is dropped rather than coerced, so an unexpected value costs exactly
|
||||||
|
// its own token and the rest of the palette still applies.
|
||||||
|
private fun themeTokens(raw: JsonObject?): Map<String, String> {
|
||||||
|
if (raw.isNullOrEmpty()) return emptyMap()
|
||||||
|
return buildMap {
|
||||||
|
for ((token, value) in raw) {
|
||||||
|
val text = (value as? JsonPrimitive)?.takeIf { it.isString }?.content
|
||||||
|
if (!text.isNullOrBlank()) put(token, text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -8,7 +8,7 @@ import androidx.lifecycle.viewModelScope
|
|||||||
import com.runicgateway.app.core.net.BaseUrlHolder
|
import com.runicgateway.app.core.net.BaseUrlHolder
|
||||||
import com.runicgateway.app.core.push.PushManager
|
import com.runicgateway.app.core.push.PushManager
|
||||||
import com.runicgateway.app.core.result.ApiResult
|
import com.runicgateway.app.core.result.ApiResult
|
||||||
import com.runicgateway.app.data.api.dto.BrandDto
|
import com.runicgateway.app.data.appearance.SiteAppearance
|
||||||
import com.runicgateway.app.data.repository.ConnectionRepository
|
import com.runicgateway.app.data.repository.ConnectionRepository
|
||||||
import com.runicgateway.app.data.repository.SettingsRepository
|
import com.runicgateway.app.data.repository.SettingsRepository
|
||||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||||
@@ -20,8 +20,8 @@ import javax.inject.Inject
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Top-level app gate (PLAN.md §3): decides whether the first-run connect screen
|
* Top-level app gate (PLAN.md §3): decides whether the first-run connect screen
|
||||||
* or the main UI shows, and holds the per-shard branding the theme is seeded
|
* or the main UI shows, and holds the per-shard [SiteAppearance] the theme and
|
||||||
* from. Activity-scoped so the whole app observes one state.
|
* the drawer are built from. Activity-scoped so the whole app observes one state.
|
||||||
*/
|
*/
|
||||||
@HiltViewModel
|
@HiltViewModel
|
||||||
class AppViewModel @Inject constructor(
|
class AppViewModel @Inject constructor(
|
||||||
@@ -38,8 +38,11 @@ class AppViewModel @Inject constructor(
|
|||||||
/** No shard site configured yet — show the connect screen. */
|
/** No shard site configured yet — show the connect screen. */
|
||||||
data object NeedsConnection : AppState
|
data object NeedsConnection : AppState
|
||||||
|
|
||||||
/** A site is configured; [brand] is null if branding couldn't be loaded (still usable). */
|
/**
|
||||||
data class Ready(val brand: BrandDto?) : AppState
|
* A site is configured. [appearance] is [SiteAppearance.NONE] when settings
|
||||||
|
* couldn't be loaded — the shipped app, still fully usable (§2).
|
||||||
|
*/
|
||||||
|
data class Ready(val appearance: SiteAppearance) : AppState
|
||||||
}
|
}
|
||||||
|
|
||||||
private val _state = MutableStateFlow<AppState>(AppState.Loading)
|
private val _state = MutableStateFlow<AppState>(AppState.Loading)
|
||||||
@@ -48,7 +51,7 @@ class AppViewModel @Inject constructor(
|
|||||||
init {
|
init {
|
||||||
viewModelScope.launch {
|
viewModelScope.launch {
|
||||||
_state.value = if (connectionRepository.restore()) {
|
_state.value = if (connectionRepository.restore()) {
|
||||||
AppState.Ready(loadBrand())
|
AppState.Ready(loadAppearance())
|
||||||
} else {
|
} else {
|
||||||
AppState.NeedsConnection
|
AppState.NeedsConnection
|
||||||
}
|
}
|
||||||
@@ -57,7 +60,30 @@ class AppViewModel @Inject constructor(
|
|||||||
|
|
||||||
/** Called by the connect screen once a site has been validated + saved. */
|
/** Called by the connect screen once a site has been validated + saved. */
|
||||||
fun onConnected() {
|
fun onConnected() {
|
||||||
viewModelScope.launch { _state.value = AppState.Ready(loadBrand()) }
|
viewModelScope.launch { _state.value = AppState.Ready(loadAppearance()) }
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Re-read the appearance while the app is already running — on resume, beside
|
||||||
|
* the session's own re-validation (§5.5). An admin who re-skins the site from
|
||||||
|
* a laptop and picks the phone up should see it.
|
||||||
|
*
|
||||||
|
* Best-effort, and silent either way: a failed refresh **keeps the last good
|
||||||
|
* appearance** rather than dropping back to the shipped one, so a moment of
|
||||||
|
* no connectivity does not repaint a themed shard. There is no loading state
|
||||||
|
* and no error surface. Ignored unless a site is configured.
|
||||||
|
*/
|
||||||
|
fun refreshAppearance() {
|
||||||
|
if (_state.value !is AppState.Ready) return
|
||||||
|
viewModelScope.launch {
|
||||||
|
val settings = (settingsRepository.getSettings() as? ApiResult.Ok)?.data ?: return@launch
|
||||||
|
pushManager.setNtfyUrl(settings.push.ntfyUrl)
|
||||||
|
// changeServer() may have raced us back to the connect screen while the
|
||||||
|
// call was in flight; don't resurrect Ready on top of it.
|
||||||
|
if (_state.value is AppState.Ready) {
|
||||||
|
_state.value = AppState.Ready(SiteAppearance.from(settings))
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Settings → Server switch: hard reset back to the connect screen (§3). */
|
/** Settings → Server switch: hard reset back to the connect screen (§3). */
|
||||||
@@ -69,14 +95,14 @@ class AppViewModel @Inject constructor(
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load public settings for branding and feed the shard's push relay URL into the
|
* Load public settings for the appearance and feed the shard's push relay URL into
|
||||||
* [PushManager] (§11) — its arrival is what lets push re-register after a restart
|
* the [PushManager] (§11) — its arrival is what lets push re-register after a restart
|
||||||
* or sign-in. Returns the brand block (null if settings couldn't be loaded).
|
* or sign-in. Returns [SiteAppearance.NONE] if settings couldn't be loaded.
|
||||||
*/
|
*/
|
||||||
private suspend fun loadBrand(): BrandDto? {
|
private suspend fun loadAppearance(): SiteAppearance {
|
||||||
val settings = (settingsRepository.getSettings() as? ApiResult.Ok)?.data
|
val settings = (settingsRepository.getSettings() as? ApiResult.Ok)?.data
|
||||||
pushManager.setNtfyUrl(settings?.push?.ntfyUrl)
|
pushManager.setNtfyUrl(settings?.push?.ntfyUrl)
|
||||||
return settings?.brand
|
return SiteAppearance.from(settings)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -23,15 +23,9 @@ import androidx.compose.ui.draw.clip
|
|||||||
import androidx.compose.ui.graphics.Brush
|
import androidx.compose.ui.graphics.Brush
|
||||||
import androidx.compose.ui.graphics.Color
|
import androidx.compose.ui.graphics.Color
|
||||||
import androidx.compose.ui.unit.dp
|
import androidx.compose.ui.unit.dp
|
||||||
import com.runicgateway.app.ui.theme.ShardCardBottom
|
import com.runicgateway.app.ui.theme.LocalShardPalette
|
||||||
import com.runicgateway.app.ui.theme.ShardCardTop
|
|
||||||
import com.runicgateway.app.ui.theme.ShardDanger
|
import com.runicgateway.app.ui.theme.ShardDanger
|
||||||
import com.runicgateway.app.ui.theme.ShardDangerBg
|
import com.runicgateway.app.ui.theme.ShardDangerBg
|
||||||
import com.runicgateway.app.ui.theme.ShardElevated
|
|
||||||
import com.runicgateway.app.ui.theme.ShardFaint
|
|
||||||
import com.runicgateway.app.ui.theme.ShardOutline
|
|
||||||
import com.runicgateway.app.ui.theme.ShardPillBg
|
|
||||||
import com.runicgateway.app.ui.theme.ShardPillFg
|
|
||||||
import com.runicgateway.app.ui.theme.ShardSuccess
|
import com.runicgateway.app.ui.theme.ShardSuccess
|
||||||
import com.runicgateway.app.ui.theme.ShardSuccessBg
|
import com.runicgateway.app.ui.theme.ShardSuccessBg
|
||||||
import com.runicgateway.app.ui.theme.ShardSuccessDot
|
import com.runicgateway.app.ui.theme.ShardSuccessDot
|
||||||
@@ -43,6 +37,13 @@ import com.runicgateway.app.ui.theme.ShardWarningBg
|
|||||||
* (docs/android/PLAN.md §M5): the recurring pill, section-label, feature-card,
|
* (docs/android/PLAN.md §M5): the recurring pill, section-label, feature-card,
|
||||||
* and stat-bar motifs the mockup repeats across screens. Pure presentation —
|
* and stat-bar motifs the mockup repeats across screens. Pure presentation —
|
||||||
* no state, no data dependencies — so any screen can adopt them.
|
* no state, no data dependencies — so any screen can adopt them.
|
||||||
|
*
|
||||||
|
* This is the app's **only** file that reaches past `MaterialTheme.colorScheme`
|
||||||
|
* for a themable color, so it is the one place M12 had to migrate: the surface,
|
||||||
|
* line and accent tokens now come from [LocalShardPalette] and follow the
|
||||||
|
* shard's theme (THEMING_AND_NAV.md §5.1). The success/warning/danger constants
|
||||||
|
* stay imported directly — those are semantic and never themed, mirroring the
|
||||||
|
* server's `FIXED_TOKENS`.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** Semantic tone for a [StatusPill] / [OnlineDot]. */
|
/** Semantic tone for a [StatusPill] / [OnlineDot]. */
|
||||||
@@ -50,11 +51,13 @@ enum class PillTone { Success, Warning, Danger, Neutral, Info }
|
|||||||
|
|
||||||
private data class PillColors(val fg: Color, val bg: Color)
|
private data class PillColors(val fg: Color, val bg: Color)
|
||||||
|
|
||||||
|
@Composable
|
||||||
private fun toneColors(tone: PillTone): PillColors = when (tone) {
|
private fun toneColors(tone: PillTone): PillColors = when (tone) {
|
||||||
PillTone.Success -> PillColors(ShardSuccess, ShardSuccessBg)
|
PillTone.Success -> PillColors(ShardSuccess, ShardSuccessBg)
|
||||||
PillTone.Warning -> PillColors(ShardWarning, ShardWarningBg)
|
PillTone.Warning -> PillColors(ShardWarning, ShardWarningBg)
|
||||||
PillTone.Danger -> PillColors(ShardDanger, ShardDangerBg)
|
PillTone.Danger -> PillColors(ShardDanger, ShardDangerBg)
|
||||||
PillTone.Neutral, PillTone.Info -> PillColors(ShardPillFg, ShardPillBg)
|
PillTone.Neutral, PillTone.Info ->
|
||||||
|
LocalShardPalette.current.let { PillColors(it.pillFg, it.pillBg) }
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -81,7 +84,7 @@ fun OnlineDot(tone: PillTone, modifier: Modifier = Modifier) {
|
|||||||
PillTone.Success -> ShardSuccessDot
|
PillTone.Success -> ShardSuccessDot
|
||||||
PillTone.Warning -> ShardWarning
|
PillTone.Warning -> ShardWarning
|
||||||
PillTone.Danger -> ShardDanger
|
PillTone.Danger -> ShardDanger
|
||||||
PillTone.Neutral, PillTone.Info -> ShardFaint
|
PillTone.Neutral, PillTone.Info -> LocalShardPalette.current.faint
|
||||||
}
|
}
|
||||||
Box(modifier.size(8.dp).clip(CircleShape).background(color))
|
Box(modifier.size(8.dp).clip(CircleShape).background(color))
|
||||||
}
|
}
|
||||||
@@ -95,7 +98,7 @@ fun SectionLabel(text: String, modifier: Modifier = Modifier) {
|
|||||||
Text(
|
Text(
|
||||||
text = text.uppercase(),
|
text = text.uppercase(),
|
||||||
style = MaterialTheme.typography.labelSmall,
|
style = MaterialTheme.typography.labelSmall,
|
||||||
color = ShardFaint,
|
color = LocalShardPalette.current.faint,
|
||||||
modifier = modifier,
|
modifier = modifier,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
@@ -111,12 +114,13 @@ fun FeatureCard(
|
|||||||
contentPadding: Int = 18,
|
contentPadding: Int = 18,
|
||||||
content: @Composable ColumnScope.() -> Unit,
|
content: @Composable ColumnScope.() -> Unit,
|
||||||
) {
|
) {
|
||||||
|
val palette = LocalShardPalette.current
|
||||||
Box(
|
Box(
|
||||||
modifier = modifier
|
modifier = modifier
|
||||||
.fillMaxWidth()
|
.fillMaxWidth()
|
||||||
.clip(RoundedCornerShape(12.dp))
|
.clip(RoundedCornerShape(12.dp))
|
||||||
.background(Brush.verticalGradient(listOf(ShardCardTop, ShardCardBottom)))
|
.background(Brush.verticalGradient(listOf(palette.cardTop, palette.cardBottom)))
|
||||||
.border(1.dp, ShardOutline, RoundedCornerShape(12.dp)),
|
.border(1.dp, palette.outline, RoundedCornerShape(12.dp)),
|
||||||
) {
|
) {
|
||||||
Column(Modifier.padding(contentPadding.dp), content = content)
|
Column(Modifier.padding(contentPadding.dp), content = content)
|
||||||
}
|
}
|
||||||
@@ -129,13 +133,14 @@ fun FeatureCard(
|
|||||||
@Composable
|
@Composable
|
||||||
fun StatBar(fraction: Float, modifier: Modifier = Modifier) {
|
fun StatBar(fraction: Float, modifier: Modifier = Modifier) {
|
||||||
val pct = fraction.coerceIn(0f, 1f)
|
val pct = fraction.coerceIn(0f, 1f)
|
||||||
|
val palette = LocalShardPalette.current
|
||||||
Box(
|
Box(
|
||||||
modifier = modifier
|
modifier = modifier
|
||||||
.fillMaxWidth()
|
.fillMaxWidth()
|
||||||
.height(6.dp)
|
.height(6.dp)
|
||||||
.clip(RoundedCornerShape(3.dp))
|
.clip(RoundedCornerShape(3.dp))
|
||||||
.background(ShardElevated)
|
.background(palette.elevated)
|
||||||
.border(1.dp, ShardOutline, RoundedCornerShape(3.dp)),
|
.border(1.dp, palette.outline, RoundedCornerShape(3.dp)),
|
||||||
) {
|
) {
|
||||||
Box(
|
Box(
|
||||||
Modifier
|
Modifier
|
||||||
|
|||||||
@@ -10,6 +10,11 @@ import androidx.compose.ui.graphics.Color
|
|||||||
* without the leading `#`) into a Compose [Color]. Returns null for anything
|
* without the leading `#`) into a Compose [Color]. Returns null for anything
|
||||||
* unparseable so the theme falls back to its default scheme (PLAN.md §3, §5).
|
* unparseable so the theme falls back to its default scheme (PLAN.md §3, §5).
|
||||||
* Pure logic — covered by JVM unit tests.
|
* Pure logic — covered by JVM unit tests.
|
||||||
|
*
|
||||||
|
* Also the parser for every color token in the shard's resolved theme map
|
||||||
|
* ([ShardPalette.resolve], M12): the server validates those as `#RGB` or
|
||||||
|
* `#RRGGBB` on write, and a null here is what makes a token that slipped
|
||||||
|
* through anyway cost only itself.
|
||||||
*/
|
*/
|
||||||
fun parseBrandColor(hex: String?): Color? {
|
fun parseBrandColor(hex: String?): Color? {
|
||||||
if (hex.isNullOrBlank()) return null
|
if (hex.isNullOrBlank()) return null
|
||||||
|
|||||||
126
app/src/main/java/com/runicgateway/app/ui/theme/ShardPalette.kt
Normal file
126
app/src/main/java/com/runicgateway/app/ui/theme/ShardPalette.kt
Normal file
@@ -0,0 +1,126 @@
|
|||||||
|
/*
|
||||||
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
*/
|
||||||
|
package com.runicgateway.app.ui.theme
|
||||||
|
|
||||||
|
import androidx.compose.runtime.Immutable
|
||||||
|
import androidx.compose.runtime.staticCompositionLocalOf
|
||||||
|
import androidx.compose.ui.graphics.Color
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The shard's resolved color palette — the fifteen themable tokens of
|
||||||
|
* `GET /public/settings`' `theme` map, parsed into Compose colors
|
||||||
|
* (THEMING_AND_NAV.md §5.1).
|
||||||
|
*
|
||||||
|
* **The default value of every field is the shipped constant from
|
||||||
|
* [ui/theme/Color.kt], and that is not an approximation.** The app's M5 palette
|
||||||
|
* *is* the website's `runic-gateway` preset, value for value, because both were
|
||||||
|
* drawn from the same `theme.css`. So [Shipped] renders exactly as the app did
|
||||||
|
* before this milestone, and an instance with no `theme_visual` row resolves
|
||||||
|
* back to it token by token (§2, AC-1).
|
||||||
|
*
|
||||||
|
* The palette has two consumers and one resolution: ten of the fifteen tokens
|
||||||
|
* have a Material role and are fed into the [androidx.compose.material3.ColorScheme]
|
||||||
|
* by [shardColorScheme]; the other five have none, and reach the screens that
|
||||||
|
* need them through [LocalShardPalette].
|
||||||
|
*/
|
||||||
|
@Immutable
|
||||||
|
data class ShardPalette(
|
||||||
|
/** `--bg-deep` — the page behind everything. */
|
||||||
|
val page: Color = ShardPage,
|
||||||
|
/** `--bg` — the screen background. */
|
||||||
|
val surface: Color = ShardSurface,
|
||||||
|
/** `--panel-flat` — top bar, inputs, drawer, list tracks. */
|
||||||
|
val elevated: Color = ShardElevated,
|
||||||
|
/** `--panel-a` — feature-card gradient, top. No Material role. */
|
||||||
|
val cardTop: Color = ShardCardTop,
|
||||||
|
/** `--panel-b` — feature-card gradient, bottom. No Material role. */
|
||||||
|
val cardBottom: Color = ShardCardBottom,
|
||||||
|
/** `--line` — borders and input outlines. */
|
||||||
|
val outline: Color = ShardOutline,
|
||||||
|
/** `--line-soft` — hairline row dividers. */
|
||||||
|
val divider: Color = ShardDivider,
|
||||||
|
/** `--ink` — the brightest headings. No Material role. */
|
||||||
|
val heading: Color = ShardHeading,
|
||||||
|
/** `--head` — heading on a surface. No Material role. */
|
||||||
|
val headingDim: Color = ShardHeadingDim,
|
||||||
|
/** `--text` — body copy. */
|
||||||
|
val body: Color = ShardBody,
|
||||||
|
/** `--muted` — secondary text. */
|
||||||
|
val muted: Color = ShardMuted,
|
||||||
|
/** `--dim` — meta and faint labels. No Material role. */
|
||||||
|
val faint: Color = ShardFaint,
|
||||||
|
/** `--accent` — links and secondary highlights. */
|
||||||
|
val accent: Color = ShardAccent,
|
||||||
|
/** `--accent-bright` — the filled CTA surface. */
|
||||||
|
val cta: Color = ShardCta,
|
||||||
|
/** `--blue` — the neutral/info pill background. */
|
||||||
|
val pillBg: Color = ShardPillBg,
|
||||||
|
) {
|
||||||
|
/**
|
||||||
|
* Text drawn on the [cta] fill. **Derived, never themed** — it tracks
|
||||||
|
* `--bg-deep`, exactly as the server refuses to freeze `--panel-grad` as a
|
||||||
|
* literal (§5.1). A value expressed in terms of another token must follow
|
||||||
|
* it, or a future light preset inherits a dark one and looks broken.
|
||||||
|
*/
|
||||||
|
val onCta: Color get() = page
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The neutral/info pill's foreground. Also derived: `ShardPillFg` and
|
||||||
|
* `ShardCta` are the same `--accent-bright` value, so the pill's text
|
||||||
|
* follows the CTA fill rather than being a sixteenth token the contract
|
||||||
|
* does not have.
|
||||||
|
*/
|
||||||
|
val pillFg: Color get() = cta
|
||||||
|
|
||||||
|
companion object {
|
||||||
|
/** The shipped app: the M5 palette, i.e. the `runic-gateway` preset. */
|
||||||
|
val Shipped = ShardPalette()
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolve a `theme` token map into a palette, **field by field** (§2).
|
||||||
|
* A token that is missing, blank or unparseable falls back to its
|
||||||
|
* shipped value on its own; a bad `--accent` must never discard a good
|
||||||
|
* `--bg` beside it (AC-2).
|
||||||
|
*
|
||||||
|
* [brandAccent] is the pre-feature branding path and must keep working:
|
||||||
|
* an instance with a `BRAND_ACCENT_COLOR` but no `theme_visual` row
|
||||||
|
* still tints its links and highlights. It seeds `--accent` only — the
|
||||||
|
* server resolves `brand.accent` as `theme['--accent'] || env`, so the
|
||||||
|
* token always wins where both exist.
|
||||||
|
*/
|
||||||
|
fun resolve(theme: Map<String, String>, brandAccent: Color? = null): ShardPalette {
|
||||||
|
if (theme.isEmpty() && brandAccent == null) return Shipped
|
||||||
|
fun token(name: String, shipped: Color): Color =
|
||||||
|
parseBrandColor(theme[name]) ?: shipped
|
||||||
|
return ShardPalette(
|
||||||
|
page = token("--bg-deep", ShardPage),
|
||||||
|
surface = token("--bg", ShardSurface),
|
||||||
|
elevated = token("--panel-flat", ShardElevated),
|
||||||
|
cardTop = token("--panel-a", ShardCardTop),
|
||||||
|
cardBottom = token("--panel-b", ShardCardBottom),
|
||||||
|
outline = token("--line", ShardOutline),
|
||||||
|
divider = token("--line-soft", ShardDivider),
|
||||||
|
heading = token("--ink", ShardHeading),
|
||||||
|
headingDim = token("--head", ShardHeadingDim),
|
||||||
|
body = token("--text", ShardBody),
|
||||||
|
muted = token("--muted", ShardMuted),
|
||||||
|
faint = token("--dim", ShardFaint),
|
||||||
|
accent = token("--accent", brandAccent ?: ShardAccent),
|
||||||
|
cta = token("--accent-bright", ShardCta),
|
||||||
|
pillBg = token("--blue", ShardPillBg),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The live palette, for the five tokens with no Material role and for the
|
||||||
|
* components that draw the card gradient. Everything that *can* go through
|
||||||
|
* `MaterialTheme.colorScheme` still should — this is the escape hatch, not the
|
||||||
|
* front door.
|
||||||
|
*
|
||||||
|
* Defaulted to [ShardPalette.Shipped] so previews and any composable outside
|
||||||
|
* [RunicGatewayTheme] still draw the shipped palette rather than crashing.
|
||||||
|
*/
|
||||||
|
val LocalShardPalette = staticCompositionLocalOf { ShardPalette.Shipped }
|
||||||
@@ -4,42 +4,49 @@
|
|||||||
package com.runicgateway.app.ui.theme
|
package com.runicgateway.app.ui.theme
|
||||||
|
|
||||||
import androidx.compose.foundation.shape.RoundedCornerShape
|
import androidx.compose.foundation.shape.RoundedCornerShape
|
||||||
|
import androidx.compose.material3.ColorScheme
|
||||||
import androidx.compose.material3.MaterialTheme
|
import androidx.compose.material3.MaterialTheme
|
||||||
import androidx.compose.material3.Shapes
|
import androidx.compose.material3.Shapes
|
||||||
import androidx.compose.material3.darkColorScheme
|
import androidx.compose.material3.darkColorScheme
|
||||||
import androidx.compose.runtime.Composable
|
import androidx.compose.runtime.Composable
|
||||||
import androidx.compose.ui.graphics.Color
|
import androidx.compose.runtime.CompositionLocalProvider
|
||||||
|
import androidx.compose.runtime.remember
|
||||||
import androidx.compose.ui.unit.dp
|
import androidx.compose.ui.unit.dp
|
||||||
|
import com.runicgateway.app.data.appearance.SiteAppearance
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The shard-website color scheme (M5 design pass). The app is **dark-only** — the
|
* Maps a resolved [ShardPalette] onto the Material roles (THEMING_AND_NAV.md
|
||||||
* design is a single deep blue-black theme, so there is no light variant and the
|
* §5.1). The app is **dark-only** — the design is a single deep blue-black
|
||||||
* system light/dark setting is intentionally ignored. Material roles are mapped
|
* theme, so there is no light variant and the system light/dark setting is
|
||||||
* onto the palette in [ui/theme/Color.kt] so the ~20 token-based screens take on
|
* intentionally ignored; every v1 preset on the website is dark too.
|
||||||
* the theme without per-screen color work.
|
*
|
||||||
|
* Ten of the palette's fifteen tokens land here, which is why the ~20
|
||||||
|
* token-based screens take on a shard's theme with no per-screen color work.
|
||||||
|
* Pure, so the no-op proof (AC-1) can assert on it directly.
|
||||||
*/
|
*/
|
||||||
private val ShardColorScheme = darkColorScheme(
|
internal fun shardColorScheme(palette: ShardPalette): ColorScheme = darkColorScheme(
|
||||||
primary = ShardCta, // filled CTA buttons
|
primary = palette.cta, // filled CTA buttons
|
||||||
onPrimary = ShardOnCta,
|
onPrimary = palette.onCta,
|
||||||
secondary = ShardAccent, // links / secondary highlights
|
secondary = palette.accent, // links / secondary highlights
|
||||||
onSecondary = ShardOnCta,
|
onSecondary = palette.onCta,
|
||||||
tertiary = ShardAccent,
|
tertiary = palette.accent,
|
||||||
onTertiary = ShardOnCta,
|
onTertiary = palette.onCta,
|
||||||
background = ShardPage,
|
background = palette.page,
|
||||||
onBackground = ShardBody,
|
onBackground = palette.body,
|
||||||
surface = ShardSurface,
|
surface = palette.surface,
|
||||||
onSurface = ShardBody,
|
onSurface = palette.body,
|
||||||
surfaceVariant = ShardElevated,
|
surfaceVariant = palette.elevated,
|
||||||
onSurfaceVariant = ShardMuted,
|
onSurfaceVariant = palette.muted,
|
||||||
surfaceContainer = ShardElevated,
|
surfaceContainer = palette.elevated,
|
||||||
surfaceContainerHigh = ShardElevated,
|
surfaceContainerHigh = palette.elevated,
|
||||||
surfaceContainerLow = ShardSurface,
|
surfaceContainerLow = palette.surface,
|
||||||
outline = ShardOutline,
|
outline = palette.outline,
|
||||||
outlineVariant = ShardDivider,
|
outlineVariant = palette.divider,
|
||||||
secondaryContainer = ShardPillBg, // neutral chips / selected drawer item
|
secondaryContainer = palette.pillBg, // neutral chips / selected drawer item
|
||||||
onSecondaryContainer = ShardPillFg,
|
onSecondaryContainer = palette.pillFg,
|
||||||
|
// Semantic, never themed — mirrors the server's FIXED_TOKENS (§4).
|
||||||
error = ShardDanger,
|
error = ShardDanger,
|
||||||
onError = ShardOnCta,
|
onError = palette.onCta,
|
||||||
errorContainer = ShardDangerBg,
|
errorContainer = ShardDangerBg,
|
||||||
onErrorContainer = ShardDanger,
|
onErrorContainer = ShardDanger,
|
||||||
)
|
)
|
||||||
@@ -54,27 +61,35 @@ private val ShardShapes = Shapes(
|
|||||||
)
|
)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* App theme. The color scheme is the fixed shard-website dark palette; when a shard
|
* App theme, themed by the shard (M12). [appearance] carries the resolved token
|
||||||
* publishes a brand accent (PLAN.md §3), it seeds the [MaterialTheme]'s primary and
|
* map the admin's Appearance page publishes; it is applied field by field over
|
||||||
* secondary roles so buttons and highlights carry that shard's color while the rest
|
* the shipped palette, so [SiteAppearance.NONE] — no settings rows, a backend
|
||||||
* of the deep blue-black system stays intact. With no accent, the slate default is
|
* that predates the feature, or a settings call that failed — renders exactly
|
||||||
* used.
|
* as the app did before this milestone (§2).
|
||||||
|
*
|
||||||
|
* The palette reaches screens two ways: through [MaterialTheme]'s color scheme
|
||||||
|
* for the ten tokens with a Material role, and through [LocalShardPalette] for
|
||||||
|
* the five without one.
|
||||||
*/
|
*/
|
||||||
@Composable
|
@Composable
|
||||||
fun RunicGatewayTheme(
|
fun RunicGatewayTheme(
|
||||||
accent: Color? = null,
|
appearance: SiteAppearance = SiteAppearance.NONE,
|
||||||
content: @Composable () -> Unit,
|
content: @Composable () -> Unit,
|
||||||
) {
|
) {
|
||||||
val colorScheme = if (accent != null) {
|
val palette = remember(appearance) {
|
||||||
ShardColorScheme.copy(primary = accent, secondary = accent, tertiary = accent)
|
ShardPalette.resolve(
|
||||||
} else {
|
theme = appearance.theme,
|
||||||
ShardColorScheme
|
brandAccent = parseBrandColor(appearance.brand?.accent),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
val colorScheme = remember(palette) { shardColorScheme(palette) }
|
||||||
|
|
||||||
MaterialTheme(
|
CompositionLocalProvider(LocalShardPalette provides palette) {
|
||||||
colorScheme = colorScheme,
|
MaterialTheme(
|
||||||
typography = Typography,
|
colorScheme = colorScheme,
|
||||||
shapes = ShardShapes,
|
typography = Typography,
|
||||||
content = content,
|
shapes = ShardShapes,
|
||||||
)
|
content = content,
|
||||||
|
)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,6 +4,8 @@
|
|||||||
package com.runicgateway.app.data.api.dto
|
package com.runicgateway.app.data.api.dto
|
||||||
|
|
||||||
import kotlinx.serialization.json.Json
|
import kotlinx.serialization.json.Json
|
||||||
|
import kotlinx.serialization.json.JsonObject
|
||||||
|
import kotlinx.serialization.json.jsonPrimitive
|
||||||
import org.junit.Assert.assertEquals
|
import org.junit.Assert.assertEquals
|
||||||
import org.junit.Assert.assertFalse
|
import org.junit.Assert.assertFalse
|
||||||
import org.junit.Assert.assertTrue
|
import org.junit.Assert.assertTrue
|
||||||
@@ -69,5 +71,32 @@ class PublicDtoTest {
|
|||||||
assertFalse(dto.registration.password)
|
assertFalse(dto.registration.password)
|
||||||
assertEquals("", dto.brand.name)
|
assertEquals("", dto.brand.name)
|
||||||
assertEquals(null, dto.push.ntfyUrl)
|
assertEquals(null, dto.push.ntfyUrl)
|
||||||
|
// …and one that predates admin theming: both M12 fields are simply absent
|
||||||
|
// (THEMING_AND_NAV.md §2 — absence means the shipped defaults).
|
||||||
|
assertEquals(null, dto.theme)
|
||||||
|
assertEquals(null, dto.navPublic)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun settingsDecodesTheThemeAndNavRows() {
|
||||||
|
val dto = json.decodeFromString<SettingsDto>(
|
||||||
|
"""{
|
||||||
|
"theme":{"--accent":"#c8a45c","--radius-card":"3px"},
|
||||||
|
"nav_public":"{\"/wiki\":{\"label\":\"Codex\"}}",
|
||||||
|
"theme_visual":"{\"preset\":\"fantasy\"}"
|
||||||
|
}""",
|
||||||
|
)
|
||||||
|
assertEquals("#c8a45c", (dto.theme as JsonObject)["--accent"]?.jsonPrimitive?.content)
|
||||||
|
// nav_public stays a raw string here: settings.value is TEXT, so it is
|
||||||
|
// parsed a second time by SiteAppearance.
|
||||||
|
assertEquals("""{"/wiki":{"label":"Codex"}}""", dto.navPublic)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun anUnexpectedThemeKindStillDecodesTheRest() {
|
||||||
|
// `theme` is a raw JsonElement precisely so a value we did not expect
|
||||||
|
// cannot fail the decode and take brand/push with it.
|
||||||
|
val dto = json.decodeFromString<SettingsDto>(
|
||||||
|
"""{"theme":"nonsense","brand":{"name":"UOMysticmoon"}}""",
|
||||||
|
)
|
||||||
|
assertEquals("UOMysticmoon", dto.brand.name)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,57 @@
|
|||||||
|
/*
|
||||||
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
*/
|
||||||
|
package com.runicgateway.app.data.appearance
|
||||||
|
|
||||||
|
import kotlinx.serialization.json.JsonPrimitive
|
||||||
|
import org.junit.Assert.assertEquals
|
||||||
|
import org.junit.Assert.assertNull
|
||||||
|
import org.junit.Test
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The second-stage parse of a JSON-valued settings row (THEMING_AND_NAV.md §3).
|
||||||
|
* The rule under test is the one the web client's `parseJsonSetting` states:
|
||||||
|
* anything that is not a plain object reads as **absent**, never as an error.
|
||||||
|
*/
|
||||||
|
class SettingsJsonTest {
|
||||||
|
|
||||||
|
@Test fun parsesAPlainObject() {
|
||||||
|
val parsed = parseJsonSetting("""{"/wiki":{"label":"Codex","order":0}}""")
|
||||||
|
assertEquals(1, parsed!!.size)
|
||||||
|
assertEquals(setOf("/wiki"), parsed.keys)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun parsesTheWrappedPublicShape() {
|
||||||
|
val parsed = parseJsonSetting(
|
||||||
|
"""{"items":{"/":{"hidden":true}},"sections":[{"id":"s1","label":"Play"}],"links":[]}""",
|
||||||
|
)
|
||||||
|
assertEquals(setOf("items", "sections", "links"), parsed!!.keys)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun absentValuesReadAsNull() {
|
||||||
|
assertNull(parseJsonSetting(null))
|
||||||
|
assertNull(parseJsonSetting(""))
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun malformedJsonReadsAsNull() {
|
||||||
|
assertNull(parseJsonSetting("{"))
|
||||||
|
assertNull(parseJsonSetting("""{"a":}"""))
|
||||||
|
assertNull(parseJsonSetting("not json at all"))
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun nonObjectJsonReadsAsNull() {
|
||||||
|
// A stored `null`, number, string or array is as unusable to every
|
||||||
|
// consumer of these keys as a syntax error is.
|
||||||
|
assertNull(parseJsonSetting("null"))
|
||||||
|
assertNull(parseJsonSetting("4"))
|
||||||
|
assertNull(parseJsonSetting("\"x\""))
|
||||||
|
assertNull(parseJsonSetting("[]"))
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun unusualKeysAndValuesSurviveVerbatim() {
|
||||||
|
// The parse stage validates the *kind*, not the shape — a nonsense entry
|
||||||
|
// is dropped later, by the phase that reads it.
|
||||||
|
val parsed = parseJsonSetting("""{"/site/news":{"order":"first"},"nonsense":7}""")
|
||||||
|
assertEquals(JsonPrimitive(7), parsed!!["nonsense"])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
/*
|
||||||
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
*/
|
||||||
|
package com.runicgateway.app.data.appearance
|
||||||
|
|
||||||
|
import com.runicgateway.app.data.api.dto.SettingsDto
|
||||||
|
import kotlinx.serialization.json.Json
|
||||||
|
import org.junit.Assert.assertEquals
|
||||||
|
import org.junit.Assert.assertNull
|
||||||
|
import org.junit.Assert.assertSame
|
||||||
|
import org.junit.Assert.assertTrue
|
||||||
|
import org.junit.Test
|
||||||
|
|
||||||
|
/**
|
||||||
|
* [SiteAppearance.from] — the coercion between the settings payload and what the
|
||||||
|
* theme and the drawer read (THEMING_AND_NAV.md §2, §3).
|
||||||
|
*
|
||||||
|
* The claims that matter here are the two the milestone rests on: an untouched
|
||||||
|
* instance resolves to *nothing* (so the shipped app renders), and a bad token
|
||||||
|
* costs exactly its own token.
|
||||||
|
*/
|
||||||
|
class SiteAppearanceTest {
|
||||||
|
|
||||||
|
private val json = Json {
|
||||||
|
ignoreUnknownKeys = true
|
||||||
|
explicitNulls = false
|
||||||
|
coerceInputValues = true
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun appearanceOf(body: String) =
|
||||||
|
SiteAppearance.from(json.decodeFromString<SettingsDto>(body))
|
||||||
|
|
||||||
|
@Test fun untouchedInstanceResolvesToNoOverrides() {
|
||||||
|
// No theme_visual row, no nav_public row: the shipped app, exactly (§2).
|
||||||
|
val appearance = appearanceOf("""{"brand":{"name":"UOMysticmoon"}}""")
|
||||||
|
assertTrue(appearance.theme.isEmpty())
|
||||||
|
assertNull(appearance.navPublic)
|
||||||
|
assertEquals("UOMysticmoon", appearance.brand?.name)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun failedSettingsCallIsTheSameAsNoOverrides() {
|
||||||
|
assertSame(SiteAppearance.NONE, SiteAppearance.from(null))
|
||||||
|
assertNull(SiteAppearance.NONE.brand)
|
||||||
|
assertTrue(SiteAppearance.NONE.theme.isEmpty())
|
||||||
|
assertNull(SiteAppearance.NONE.navPublic)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun resolvedThemeTokensAreReadAsAMap() {
|
||||||
|
val appearance = appearanceOf(
|
||||||
|
"""{"theme":{"--accent":"#c8a45c","--bg":"#1a1410","--radius-card":"10px",
|
||||||
|
"--shadow-card":"none","--sans":"Inter, sans-serif"}}""",
|
||||||
|
)
|
||||||
|
assertEquals("#c8a45c", appearance.theme["--accent"])
|
||||||
|
assertEquals("#1a1410", appearance.theme["--bg"])
|
||||||
|
assertEquals("10px", appearance.theme["--radius-card"])
|
||||||
|
assertEquals("none", appearance.theme["--shadow-card"])
|
||||||
|
assertEquals("Inter, sans-serif", appearance.theme["--sans"])
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun anEmptyThemeMapIsTheSameAsAbsent() {
|
||||||
|
// The server returns null rather than {} — the app must not depend on that.
|
||||||
|
assertTrue(appearanceOf("""{"theme":{}}""").theme.isEmpty())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun aBadTokenCostsOnlyItself() {
|
||||||
|
// AC-2 in miniature at the decode boundary: a non-string or blank value is
|
||||||
|
// dropped field-by-field, and its neighbours still apply.
|
||||||
|
val appearance = appearanceOf(
|
||||||
|
"""{"theme":{"--accent":"#c8a45c","--bg":7,"--line":null,"--ink":" "}}""",
|
||||||
|
)
|
||||||
|
assertEquals(mapOf("--accent" to "#c8a45c"), appearance.theme)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun aThemeOfTheWrongKindDoesNotCostTheBrand() {
|
||||||
|
// The whole reason `theme` is modeled as a raw JsonElement: one unexpected
|
||||||
|
// value must not fail the decode and take brand and push down with it.
|
||||||
|
val appearance = appearanceOf(
|
||||||
|
"""{"theme":"not an object","brand":{"name":"UOMysticmoon","accent":"#7f99bd"},
|
||||||
|
"push":{"ntfyUrl":"https://ntfy.example.com"}}""",
|
||||||
|
)
|
||||||
|
assertTrue(appearance.theme.isEmpty())
|
||||||
|
assertEquals("#7f99bd", appearance.brand?.accent)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun navPublicIsParsedASecondTime() {
|
||||||
|
// It arrives as a JSON string inside a JSON object, because settings.value
|
||||||
|
// is TEXT.
|
||||||
|
val appearance = appearanceOf("""{"nav_public":"{\"/wiki\":{\"label\":\"Codex\"}}"}""")
|
||||||
|
assertEquals(setOf("/wiki"), appearance.navPublic?.keys)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test fun aMalformedNavPublicDoesNotCostTheTheme() {
|
||||||
|
val appearance = appearanceOf("""{"nav_public":"{oops","theme":{"--accent":"#c8a45c"}}""")
|
||||||
|
assertNull(appearance.navPublic)
|
||||||
|
assertEquals("#c8a45c", appearance.theme["--accent"])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,118 @@
|
|||||||
|
/*
|
||||||
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
*/
|
||||||
|
package com.runicgateway.app.ui.theme
|
||||||
|
|
||||||
|
import androidx.compose.material3.ColorScheme
|
||||||
|
import androidx.compose.material3.darkColorScheme
|
||||||
|
import androidx.compose.ui.graphics.Color
|
||||||
|
import org.junit.Assert.assertEquals
|
||||||
|
import org.junit.Assert.assertNotEquals
|
||||||
|
import org.junit.Assert.assertTrue
|
||||||
|
import org.junit.Test
|
||||||
|
|
||||||
|
/**
|
||||||
|
* **AC-1, the no-op proof** (THEMING_AND_NAV.md §7). An instance with no
|
||||||
|
* `theme_visual` row must resolve to a color scheme equal to the one the app
|
||||||
|
* shipped before M12 — not "close enough", identical, because the app's M5
|
||||||
|
* palette *is* the website's `runic-gateway` preset.
|
||||||
|
*
|
||||||
|
* Two things this test has to work around:
|
||||||
|
*
|
||||||
|
* - **`ColorScheme` does not implement `equals`** (checked against material3
|
||||||
|
* 1.3.0), so "the full scheme, not a spot check" is a field-by-field compare.
|
||||||
|
* It is done by reflection over every color-valued getter rather than by a
|
||||||
|
* hand-written list, so a role that is added to Material — or one the mapping
|
||||||
|
* forgets — cannot silently escape the assertion.
|
||||||
|
* - The expected value is a **verbatim copy of the pre-M12 `ShardColorScheme`**,
|
||||||
|
* kept here rather than referenced, so the proof is against what the app used
|
||||||
|
* to do and not against whatever [shardColorScheme] does today.
|
||||||
|
*/
|
||||||
|
class ShardColorSchemeTest {
|
||||||
|
|
||||||
|
/** The scheme exactly as `ui/theme/Theme.kt` declared it before M12. */
|
||||||
|
private val preM12Scheme = darkColorScheme(
|
||||||
|
primary = ShardCta,
|
||||||
|
onPrimary = ShardOnCta,
|
||||||
|
secondary = ShardAccent,
|
||||||
|
onSecondary = ShardOnCta,
|
||||||
|
tertiary = ShardAccent,
|
||||||
|
onTertiary = ShardOnCta,
|
||||||
|
background = ShardPage,
|
||||||
|
onBackground = ShardBody,
|
||||||
|
surface = ShardSurface,
|
||||||
|
onSurface = ShardBody,
|
||||||
|
surfaceVariant = ShardElevated,
|
||||||
|
onSurfaceVariant = ShardMuted,
|
||||||
|
surfaceContainer = ShardElevated,
|
||||||
|
surfaceContainerHigh = ShardElevated,
|
||||||
|
surfaceContainerLow = ShardSurface,
|
||||||
|
outline = ShardOutline,
|
||||||
|
outlineVariant = ShardDivider,
|
||||||
|
secondaryContainer = ShardPillBg,
|
||||||
|
onSecondaryContainer = ShardPillFg,
|
||||||
|
error = ShardDanger,
|
||||||
|
onError = ShardOnCta,
|
||||||
|
errorContainer = ShardDangerBg,
|
||||||
|
onErrorContainer = ShardDanger,
|
||||||
|
)
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun `the shipped palette reproduces the pre-M12 color scheme exactly`() {
|
||||||
|
assertEquals(roles(preM12Scheme), roles(shardColorScheme(ShardPalette.Shipped)))
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The same claim from the other end: an absent theme map is the shipped app. */
|
||||||
|
@Test
|
||||||
|
fun `an absent theme map reproduces the pre-M12 color scheme`() {
|
||||||
|
val resolved = shardColorScheme(ShardPalette.resolve(emptyMap()))
|
||||||
|
assertEquals(roles(preM12Scheme), roles(resolved))
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Sanity: the comparison is capable of failing, and covers the whole scheme. */
|
||||||
|
@Test
|
||||||
|
fun `the role comparison sees every color role`() {
|
||||||
|
val roles = roles(preM12Scheme)
|
||||||
|
// material3 1.3.0 declares 36 color roles; fewer than that means the
|
||||||
|
// reflection has stopped seeing them and the comparison above went hollow.
|
||||||
|
assertTrue("expected the full Material role set, got ${roles.keys}", roles.size >= 36)
|
||||||
|
assertEquals(ShardCta, roles["primary"])
|
||||||
|
assertNotEquals(
|
||||||
|
roles,
|
||||||
|
roles(shardColorScheme(ShardPalette.Shipped.copy(cta = Color(0xFFC9973F)))),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A themed shard moves the roles its tokens own, and only those. */
|
||||||
|
@Test
|
||||||
|
fun `a theme token reaches its Material role`() {
|
||||||
|
val themed = shardColorScheme(
|
||||||
|
ShardPalette.resolve(mapOf("--accent" to "#c9973f", "--bg-deep" to "#120c07")),
|
||||||
|
)
|
||||||
|
val roles = roles(themed)
|
||||||
|
assertEquals(Color(0xFFC9973F), roles["secondary"])
|
||||||
|
assertEquals(Color(0xFFC9973F), roles["tertiary"])
|
||||||
|
assertEquals(Color(0xFF120C07), roles["background"])
|
||||||
|
assertEquals(Color(0xFF120C07), roles["onPrimary"]) // derived: onCta tracks --bg-deep
|
||||||
|
assertEquals(ShardCta, roles["primary"]) // untouched by these two tokens
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Every color role of a scheme, by name. `Color` is a value class, so the
|
||||||
|
* roles are the `long`-returning getters and their names carry Kotlin's
|
||||||
|
* mangling suffix (`getPrimary-0d7_KjU`), which is stripped here.
|
||||||
|
*/
|
||||||
|
private fun roles(scheme: ColorScheme): Map<String, Color> =
|
||||||
|
ColorScheme::class.java.declaredMethods
|
||||||
|
.filter {
|
||||||
|
it.name.startsWith("get") &&
|
||||||
|
it.returnType == java.lang.Long.TYPE &&
|
||||||
|
it.parameterCount == 0
|
||||||
|
}
|
||||||
|
.associate { method ->
|
||||||
|
val name = method.name.removePrefix("get").substringBefore('-')
|
||||||
|
.replaceFirstChar { it.lowercase() }
|
||||||
|
// The getter hands back Color's packed ULong bits, not an ARGB int.
|
||||||
|
name to Color((method.invoke(scheme) as Long).toULong())
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,135 @@
|
|||||||
|
/*
|
||||||
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
||||||
|
*/
|
||||||
|
package com.runicgateway.app.ui.theme
|
||||||
|
|
||||||
|
import androidx.compose.ui.graphics.Color
|
||||||
|
import org.junit.Assert.assertEquals
|
||||||
|
import org.junit.Assert.assertSame
|
||||||
|
import org.junit.Test
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The token → palette resolution (THEMING_AND_NAV.md §5.1) and its
|
||||||
|
* forgiving-on-read rule (§2, AC-2).
|
||||||
|
*/
|
||||||
|
class ShardPaletteTest {
|
||||||
|
|
||||||
|
/** AC-1, the palette half: no theme row resolves to the shipped M5 palette. */
|
||||||
|
@Test
|
||||||
|
fun `no tokens resolve to the shipped palette`() {
|
||||||
|
assertSame(ShardPalette.Shipped, ShardPalette.resolve(emptyMap()))
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Every one of the fifteen has a home, and lands in the right one. */
|
||||||
|
@Test
|
||||||
|
fun `all fifteen tokens map to their palette field`() {
|
||||||
|
val p = ShardPalette.resolve(
|
||||||
|
mapOf(
|
||||||
|
"--bg" to "#010101",
|
||||||
|
"--bg-deep" to "#020202",
|
||||||
|
"--panel-a" to "#030303",
|
||||||
|
"--panel-b" to "#040404",
|
||||||
|
"--panel-flat" to "#050505",
|
||||||
|
"--line" to "#060606",
|
||||||
|
"--line-soft" to "#070707",
|
||||||
|
"--accent" to "#080808",
|
||||||
|
"--accent-bright" to "#090909",
|
||||||
|
"--ink" to "#0a0a0a",
|
||||||
|
"--head" to "#0b0b0b",
|
||||||
|
"--text" to "#0c0c0c",
|
||||||
|
"--muted" to "#0d0d0d",
|
||||||
|
"--dim" to "#0e0e0e",
|
||||||
|
"--blue" to "#0f0f0f",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
assertEquals(Color(0xFF010101), p.surface)
|
||||||
|
assertEquals(Color(0xFF020202), p.page)
|
||||||
|
assertEquals(Color(0xFF030303), p.cardTop)
|
||||||
|
assertEquals(Color(0xFF040404), p.cardBottom)
|
||||||
|
assertEquals(Color(0xFF050505), p.elevated)
|
||||||
|
assertEquals(Color(0xFF060606), p.outline)
|
||||||
|
assertEquals(Color(0xFF070707), p.divider)
|
||||||
|
assertEquals(Color(0xFF080808), p.accent)
|
||||||
|
assertEquals(Color(0xFF090909), p.cta)
|
||||||
|
assertEquals(Color(0xFF0A0A0A), p.heading)
|
||||||
|
assertEquals(Color(0xFF0B0B0B), p.headingDim)
|
||||||
|
assertEquals(Color(0xFF0C0C0C), p.body)
|
||||||
|
assertEquals(Color(0xFF0D0D0D), p.muted)
|
||||||
|
assertEquals(Color(0xFF0E0E0E), p.faint)
|
||||||
|
assertEquals(Color(0xFF0F0F0F), p.pillBg)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* AC-2. One valid token applies; four malformed ones each fall back on their
|
||||||
|
* own, and none of them costs the good one beside it.
|
||||||
|
*/
|
||||||
|
@Test
|
||||||
|
fun `a malformed token costs only itself`() {
|
||||||
|
val p = ShardPalette.resolve(
|
||||||
|
mapOf(
|
||||||
|
"--accent" to "#c9973f", // the one valid token
|
||||||
|
"--bg" to "not a color",
|
||||||
|
"--ink" to "",
|
||||||
|
"--line" to "#12",
|
||||||
|
"--text" to "rgb(1, 2, 3)",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
assertEquals(Color(0xFFC9973F), p.accent)
|
||||||
|
assertEquals(ShardPalette.Shipped.surface, p.surface)
|
||||||
|
assertEquals(ShardPalette.Shipped.heading, p.heading)
|
||||||
|
assertEquals(ShardPalette.Shipped.outline, p.outline)
|
||||||
|
assertEquals(ShardPalette.Shipped.body, p.body)
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A token the app does not know is not an error — it is simply not read. */
|
||||||
|
@Test
|
||||||
|
fun `unknown tokens are ignored`() {
|
||||||
|
val p = ShardPalette.resolve(mapOf("--mode-live" to "#ff0000", "--radius-card" to "2px"))
|
||||||
|
assertEquals(ShardPalette.Shipped, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The pre-feature branding path: a `BRAND_ACCENT_COLOR` with no theme row
|
||||||
|
* still tints links and highlights, and nothing else moves.
|
||||||
|
*/
|
||||||
|
@Test
|
||||||
|
fun `brand accent seeds only the accent token`() {
|
||||||
|
val p = ShardPalette.resolve(emptyMap(), brandAccent = Color(0xFFC9973F))
|
||||||
|
assertEquals(Color(0xFFC9973F), p.accent)
|
||||||
|
assertEquals(ShardPalette.Shipped.copy(accent = Color(0xFFC9973F)), p)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The server resolves `brand.accent` as `theme['--accent'] || env`, so the two
|
||||||
|
* can only disagree if a client is holding a stale brand — the token wins.
|
||||||
|
*/
|
||||||
|
@Test
|
||||||
|
fun `the accent token beats the brand accent`() {
|
||||||
|
val p = ShardPalette.resolve(mapOf("--accent" to "#4f8ef7"), brandAccent = Color(0xFFC9973F))
|
||||||
|
assertEquals(Color(0xFF4F8EF7), p.accent)
|
||||||
|
}
|
||||||
|
|
||||||
|
/** An unparseable brand accent is the same as none. */
|
||||||
|
@Test
|
||||||
|
fun `a malformed brand accent falls back to the shipped accent`() {
|
||||||
|
assertEquals(ShardPalette.Shipped, ShardPalette.resolve(emptyMap(), parseBrandColor("nope")))
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The derived pair (§5.1): expressed in terms of another token, so they must
|
||||||
|
* follow it rather than being frozen at the shipped literal.
|
||||||
|
*/
|
||||||
|
@Test
|
||||||
|
fun `derived colors track the tokens they are expressed in`() {
|
||||||
|
val p = ShardPalette.resolve(mapOf("--bg-deep" to "#120c07", "--accent-bright" to "#e8c374"))
|
||||||
|
assertEquals(Color(0xFF120C07), p.onCta)
|
||||||
|
assertEquals(Color(0xFFE8C374), p.pillFg)
|
||||||
|
}
|
||||||
|
|
||||||
|
/** And on the shipped palette they are exactly today's two constants. */
|
||||||
|
@Test
|
||||||
|
fun `derived colors are the shipped constants by default`() {
|
||||||
|
assertEquals(ShardOnCta, ShardPalette.Shipped.onCta)
|
||||||
|
assertEquals(ShardPillFg, ShardPalette.Shipped.pillFg)
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user