Skip to content
Merged
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
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ dependencies {
debugImplementation 'com.redmadrobot.debug:plugin-konfeature:${debug_panel_version}'
//Так же необходимо подключить саму библиотеку konfeature
debugImplementation "com.redmadrobot.konfeature:konfeature:${konfeature_version}"

//Плагин для отображения информации о приложении
debugImplementation 'com.redmadrobot.debug:plugin-about-app:${debug_panel_version}'
}

```
Expand Down Expand Up @@ -328,6 +331,31 @@ KonfeaturePlugin(
- настроить работу с remote config через реализацию интерфейса `FeatureSource` - `addSource(featureSource)`
- настроить логирование - `setLogger(logger)`

### AboutApp Plugin

Используется для отображения информации о приложении: версии, номера билда и других произвольных данных.

Для подключения плагина необходимо передать список `AboutAppInfo`. Требуется хотя бы один элемент:

```kotlin
AboutAppPlugin(
aboutAppInfo = listOf(
AboutAppInfo(
title = "Версия",
value = BuildConfig.VERSION_NAME
),
AboutAppInfo(
title = "Номер билда",
value = BuildConfig.VERSION_CODE.toString()
)
)
)
```

Каждый `AboutAppInfo` содержит:
- `title` — название поля (например, «Версия»)
- `value` — значение поля (например, «1.0.0»)

# Безопасность!
Для того чтобы тестовые данные не попали в релизные сборки рекомендуется не задавать их явно в Application классе, а использовать реализации DebugDataProvider, которые можно разнести по разным buildType. Для release версии следует сделать пустую реализацию.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,16 @@
package com.redmadrobot.debug.core.inapp.compose

import androidx.compose.foundation.ExperimentalFoundationApi
import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Spacer
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.statusBarsPadding
import androidx.compose.foundation.layout.width
import androidx.compose.foundation.pager.HorizontalPager
import androidx.compose.foundation.pager.PagerState
import androidx.compose.foundation.pager.rememberPagerState
import androidx.compose.foundation.shape.CircleShape
import androidx.compose.foundation.shape.RoundedCornerShape
import androidx.compose.material.Divider
import androidx.compose.material.MaterialTheme
import androidx.compose.material.ModalBottomSheetLayout
import androidx.compose.material.ModalBottomSheetValue
Expand All @@ -28,7 +27,6 @@ import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.unit.dp
import com.redmadrobot.debug.core.extension.getAllPlugins
Expand All @@ -38,7 +36,7 @@ import kotlinx.coroutines.launch
@Composable
public fun DebugBottomSheet(onClose: () -> Unit) {
val state = rememberModalBottomSheetState(
initialValue = ModalBottomSheetValue.HalfExpanded,
initialValue = ModalBottomSheetValue.Expanded,
confirmValueChange = { sheetState ->
if (sheetState == ModalBottomSheetValue.Hidden) onClose()
true
Expand All @@ -47,9 +45,11 @@ public fun DebugBottomSheet(onClose: () -> Unit) {
)

ModalBottomSheetLayout(
modifier = Modifier.statusBarsPadding(),
sheetContent = { BottomSheetContent() },
sheetState = state,
scrimColor = Color.Transparent,
sheetShape = RoundedCornerShape(size = 16.dp),
content = {},
)
}
Expand All @@ -59,43 +59,42 @@ private fun BottomSheetContent() {
val plugins = remember { getAllPlugins() }
val pluginsName = remember { plugins.map { it.getName() } }
val pagerState = rememberPagerState(initialPage = 0, pageCount = { plugins.size })
Column(modifier = Modifier.fillMaxSize()) {
Spacer(modifier = Modifier.height(8.dp))

Box(
Column(modifier = Modifier.fillMaxSize()) {
Divider(
modifier = Modifier
.height(4.dp)
.width(50.dp)
.clip(CircleShape)
.background(Color.Gray)
.align(Alignment.CenterHorizontally)
.width(width = 50.dp)
.padding(vertical = 8.dp)
.align(alignment = Alignment.CenterHorizontally),
color = Color.Gray,
thickness = 4.dp
)

Spacer(modifier = Modifier.height(8.dp))

PluginsTabLayout(pluginsName, pagerState = pagerState)

PluginsPager(plugins, pagerState = pagerState)
PluginsTabLayout(pluginsName = pluginsName, pagerState = pagerState)
PluginsPager(plugins = plugins, pagerState = pagerState)
}
}

@Composable
private fun PluginsTabLayout(pluginsName: List<String>, pagerState: PagerState) {
val scope = rememberCoroutineScope()

ScrollableTabRow(
selectedTabIndex = pagerState.currentPage,
backgroundColor = MaterialTheme.colors.background,
edgePadding = 16.dp,
indicator = { tabPositions ->
TabRowDefaults.Indicator(
modifier = Modifier.tabIndicatorOffset(tabPositions[pagerState.currentPage]),
modifier = Modifier.tabIndicatorOffset(
currentTabPosition = tabPositions[pagerState.currentPage]
),
height = 2.dp,
color = MaterialTheme.colors.secondary
)
}
) {
pluginsName.forEachIndexed { index, _ ->
Tab(
text = { Text(pluginsName[index]) },
text = { Text(text = pluginsName[index]) },
selected = pagerState.currentPage == index,
onClick = {
scope.launch { pagerState.animateScrollToPage(index) }
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package com.redmadrobot.debug.plugin.aboutapp

data class AboutAppInfo(
val title: String,
val value: String
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package com.redmadrobot.debug.plugin.aboutapp

class AboutAppPlugin(
private val appInfoList: List<AboutAppInfo> = emptyList()
)
1 change: 1 addition & 0 deletions plugins/plugin-about-app/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/build
11 changes: 11 additions & 0 deletions plugins/plugin-about-app/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
plugins {
id("convention.debug.panel.plugin")
alias(stack.plugins.ksp)
alias(stack.plugins.kotlin.compose)
}

description = "Plugin for showing about app information"

android {
namespace = "com.redmadrobot.debug.plugin.aboutapp"
}
21 changes: 21 additions & 0 deletions plugins/plugin-about-app/proguard-rules.pro
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.kts.kts.kts.kts.kts.kts.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
# public *;
#}

# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable

# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
package com.redmadrobot.debug.plugin.aboutapp

import androidx.compose.runtime.Composable
import com.redmadrobot.debug.core.internal.CommonContainer
import com.redmadrobot.debug.core.internal.EditablePlugin
import com.redmadrobot.debug.core.internal.PluginDependencyContainer
import com.redmadrobot.debug.core.plugin.Plugin
import com.redmadrobot.debug.plugin.aboutapp.model.AboutAppInfo
import com.redmadrobot.debug.plugin.aboutapp.ui.AboutAppScreen

public class AboutAppPlugin(
private val appInfoList: List<AboutAppInfo>
) : Plugin(), EditablePlugin {
init {
appInfoList.firstOrNull()
?: error("AboutAppPlugin can't be initialized. At least one information block must be set.")
}

internal companion object {
internal const val NAME = "ABOUT APP"
}

override fun getPluginContainer(commonContainer: CommonContainer): PluginDependencyContainer {
return AboutAppPluginContainer(appInfoList = appInfoList)
}

override fun getName(): String = NAME

@Composable
override fun content() {
AboutAppScreen()
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package com.redmadrobot.debug.plugin.aboutapp

import com.redmadrobot.debug.core.internal.PluginDependencyContainer
import com.redmadrobot.debug.plugin.aboutapp.model.AboutAppInfo
import com.redmadrobot.debug.plugin.aboutapp.ui.AboutAppViewModel

internal class AboutAppPluginContainer(
private val appInfoList: List<AboutAppInfo>
) : PluginDependencyContainer {
fun createAboutAppViewModel(): AboutAppViewModel {
return AboutAppViewModel(appInfoList = appInfoList)
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package com.redmadrobot.debug.plugin.aboutapp.model

import java.util.UUID

public data class AboutAppInfo(
val title: String,
val value: String,
) {
val id: String = UUID.randomUUID().toString()
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
package com.redmadrobot.debug.plugin.aboutapp.ui

import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.defaultMinSize
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.foundation.lazy.items
import androidx.compose.material.Card
import androidx.compose.material.MaterialTheme
import androidx.compose.material.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.collectAsState
import androidx.compose.runtime.getValue
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.text.style.TextOverflow
import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.unit.dp
import com.redmadrobot.debug.core.extension.getPlugin
import com.redmadrobot.debug.core.extension.provideViewModel
import com.redmadrobot.debug.plugin.aboutapp.AboutAppPlugin
import com.redmadrobot.debug.plugin.aboutapp.AboutAppPluginContainer
import com.redmadrobot.debug.plugin.aboutapp.model.AboutAppInfo

@Composable
internal fun AboutAppScreen(
viewModel: AboutAppViewModel = provideViewModel {
getPlugin<AboutAppPlugin>()
.getContainer<AboutAppPluginContainer>()
.createAboutAppViewModel()
}
) {
val state by viewModel.state.collectAsState()

AboutAppLayout(state = state)
}

@Composable
private fun AboutAppLayout(state: AboutAppViewState) {
LazyColumn(
modifier = Modifier.fillMaxSize(),
verticalArrangement = Arrangement.spacedBy(space = 8.dp),
contentPadding = PaddingValues(all = 16.dp),
) {
items(items = state.appInfoList, key = { it.id }) { item ->
AboutAppItem(item = item)
}
}
}

@Composable
private fun AboutAppItem(item: AboutAppInfo, modifier: Modifier = Modifier) {
Card(
modifier = modifier
.fillMaxWidth()
.defaultMinSize(minHeight = 56.dp),
elevation = 4.dp
) {
Column(
modifier = Modifier
.fillMaxWidth()
.padding(all = 16.dp),
verticalArrangement = Arrangement.spacedBy(space = 4.dp),
) {
Text(
text = item.title,
style = MaterialTheme.typography.caption,
fontWeight = FontWeight.SemiBold,
color = MaterialTheme.colors.primary,
)
Text(
text = item.value,
style = MaterialTheme.typography.body1,
color = MaterialTheme.colors.onSurface,
maxLines = 2,
overflow = TextOverflow.Ellipsis,
)
}
}
}

@Preview(showBackground = true)
@Composable
private fun Preview() {
val state = remember {
AboutAppViewState(
appInfoList = listOf(
AboutAppInfo(title = "Версия", value = "3,14"),
AboutAppInfo(
title = "Номер билда",
value = "fgkdfjgkdfgjdfkgjdfkjgkdfjgkdfjgkdfjgkdjgskdjgkdgfjdsfgjdsfgdsfgjdsfgdskjfgdsjkfgdjfgdsfg"
),
AboutAppInfo(title = "Версия", value = "3,14"),
AboutAppInfo(title = "Версия", value = "3,14"),
AboutAppInfo(title = "Версия", value = "3,14"),
AboutAppInfo(title = "Версия", value = "3,14"),
AboutAppInfo(title = "Версия", value = "3,14"),
AboutAppInfo(title = "Версия", value = "3,14"),
AboutAppInfo(title = "Версия", value = "3,14"),
)
)
}

MaterialTheme {
AboutAppLayout(state = state)
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package com.redmadrobot.debug.plugin.aboutapp.ui

import com.redmadrobot.debug.core.internal.PluginViewModel
import com.redmadrobot.debug.plugin.aboutapp.model.AboutAppInfo
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.flow.asStateFlow

internal class AboutAppViewModel(appInfoList: List<AboutAppInfo>) : PluginViewModel() {
private val _state = MutableStateFlow(value = AboutAppViewState(appInfoList = appInfoList))
val state: StateFlow<AboutAppViewState> = _state.asStateFlow()
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package com.redmadrobot.debug.plugin.aboutapp.ui

import androidx.compose.runtime.Immutable
import com.redmadrobot.debug.plugin.aboutapp.model.AboutAppInfo

@Immutable
internal data class AboutAppViewState(
val appInfoList: List<AboutAppInfo>
)
Loading
Loading