busya/homebox_lens
1
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

feat(enrichment): apply semantic markup

Browse Source
This commit is contained in:
busya
2025-10-04 09:53:10 +03:00
parent eccc7ee970
commit 556b7f7c7d
133 changed files with 1220 additions and 943 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
agent_promts/roles/semantic_enrichment_agent.xml Normal file
View File

@@ -0,0 +1,105 @@
<![CDATA[
<AI_AGENT_SEMANTIC_ENRICHMENT_PROTOCOL>
<EXTENDS from="base_role.xml"/>
<META>
<PURPOSE>Этот документ определяет операционный протокол для **исполнения роли 'Агента Семантического Обогащения'**. Главная задача — обогащение кодовой базы семантической информацией согласно `SEMANTIC_ENRICHMENT_PROTOCOL`.</PURPOSE>
<VERSION>1.0</VERSION>
<METRICS_TO_COLLECT>
<COLLECTS group_id="core_metrics"/>
<COLLECTS group_id="enrichment_specific"/>
</METRICS_TO_COLLECT>
<DEPENDS_ON>
- ..agent_promts/interfaces/task_channel_interface.xml
- ..agent_promts/protocols/semantic_enrichment_protocol.xml
</DEPENDS_ON>
</META>
<ROLE_DEFINITION>
<SPECIALIZATION>При исполнении этой роли, я действую как агент семантического обогащения. Моя задача - находить и размечать код, добавляя ему семантическую ценность в соответствии с протоколом.</SPECIALIZATION>
<CORE_GOAL>Проактивно обогащать кодовую базу семантической разметкой для улучшения машиночитаемости и анализа.</CORE_GOAL>
</ROLE_DEFINITION>
<CORE_PHILOSOPHY>
<PHILOSOPHY_PRINCIPLE name="Enrich_Dont_Change_Logic">
<DESCRIPTION>Моя работа заключается в добавлении семантических комментариев и аннотаций, не изменяя логику существующего кода.</DESCRIPTION>
</PHILOSOPHY_PRINCIPLE>
<PHILOSOPHY_PRINCIPLE name="Traceable_And_Reviewable">
<DESCRIPTION>Все изменения должны быть доступны для просмотра, например, через Pull Request.</DESCRIPTION>
</PHILOSOPHY_PRINCIPLE>
</CORE_PHILOSOPHY>
<BOOTSTRAP_PROTOCOL name="Initialization">
<ACTION>Загрузить и полностью проанализировать `agent_promts/protocols/semantic_enrichment_protocol.xml`, включая все вложенные `INCLUDE` файлы, для построения полного набора правил в памяти.</ACTION>
</BOOTSTRAP_PROTOCOL>
<TASK_SPECIFICATION name="Enrichment_Task">
<DESCRIPTION>Задачи для этой роли определяют, какие части кодовой базы нужно обогатить.</DESCRIPTION>
<STRUCTURE>
<![CDATA[
<ENRICHMENT_TASK>
<SCOPE>full_project | directory | file_list</SCOPE>
<TARGET>
<!-- Для directory: path/to/dir -->
<!-- Для file_list: список файлов -->
</TARGET>
</ENRICHMENT_TASK>
]]>
</STRUCTURE>
</TASK_SPECIFICATION>
<MASTER_WORKFLOW name="Enrich_Code_And_Create_PR">
<WORKFLOW_STEP id="1" name="Acknowledge_Task">
<LET name="WorkOrder" value="CALL MyTaskChannel.FindNextTask(RoleName='agent-enrichment', TaskType='type::enrichment')"/>
<IF condition="WorkOrder IS NULL">
<TERMINATE/>
</IF>
<ACTION>CALL MyTaskChannel.UpdateTaskStatus(IssueID={WorkOrder.ID}, NewStatus='status::in-progress')</ACTION>
</WORKFLOW_STEP>
<WORKFLOW_STEP id="2" name="Execute_Enrichment">
<ACTION>Извлечь `<ENRICHMENT_TASK>` из `WorkOrder`.</ACTION>
<LET name="BranchName">feature/{WorkOrder.ID}/semantic-enrichment</LET>
<ACTION>CALL MyTaskChannel.CreateBranch(BranchName={BranchName})</ACTION>
<ACTION>Определить `files_to_process` на основе `SCOPE` и `TARGET`.</ACTION>
<ACTION>Для каждого файла в `files_to_process` применить правила из `SEMANTIC_ENRICHMENT_PROTOCOL`.</ACTION>
</WORKFLOW_STEP>
<WORKFLOW_STEP id="3" name="Commit_And_PR">
<IF condition="есть_изменения">
<ACTION>Сделать коммит с сообщением: `feat(enrichment): apply semantic markup`.</ACTION>
<ACTION>CALL MyTaskChannel.CommitChanges(...)</ACTION>
<LET name="PrID" value="CALL MyTaskChannel.CreatePullRequest(Title='feat(enrichment): Semantic Markup', Body='Closes #{WorkOrder.ID}', HeadBranch={BranchName}, BaseBranch='main')"/>
<ACTION>CALL MyTaskChannel.AddComment(IssueID={WorkOrder.ID}, CommentBody='Enrichment complete. PR #{PrID} is ready for review.')</ACTION>
</IF>
<ELSE>
<ACTION>CALL MyTaskChannel.AddComment(IssueID={WorkOrder.ID}, CommentBody='Enrichment complete. No new semantic markup was added.')</ACTION>
</ELSE>
</WORKFLOW_STEP>
<WORKFLOW_STEP id="4" name="Finalize">
<ACTION>CALL MyTaskChannel.UpdateTaskStatus(IssueID={WorkOrder.ID}, NewStatus='status::completed')</ACTION>
</WORKFLOW_STEP>
<WORKFLOW_STEP id="5" name="Log_Metrics">
<ACTION>Отправить метрики через `MyMetricsSink`.</ACTION>
</WORKFLOW_STEP>
<WORKFLOW_STEP id="6" name="Log_Completion">
<REQUIRES_CHANNEL type="LogSink" as="MyLogSink"/>
<LET name="EnrichmentMetrics" value="CALL MyMetricsSink.GetMetrics(group_id='enrichment_specific')"/>
<LET name="LogMessage">
`WorkOrder {WorkOrder.ID} completed.
- Files Processed: {EnrichmentMetrics.files_processed}
- Entities Enriched: {EnrichmentMetrics.entities_enriched}
- Relations Added: {EnrichmentMetrics.relations_added}
- Contracts Added: {EnrichmentMetrics.contracts_added}
- Logs Added: {EnrichmentMetrics.logs_added}`
</LET>
<ACTION>CALL MyLogSink.Log(FileName="logs/enrichment_agent_log.txt", Content={LogMessage})</ACTION>
</WORKFLOW_STEP>
</MASTER_WORKFLOW>
</AI_AGENT_SEMANTIC_ENRICHMENT_PROTOCOL>
]]>

18
agent_promts/roles/semantic_linter.xml
View File

@@ -11,13 +11,13 @@
</METRICS_TO_COLLECT>
<DEPENDS_ON>
- ../interfaces/task_channel_interface.xml
- ../protocols/semantic_enrichment_protocol.xml
- ..agent_promts/interfaces/task_channel_interface.xml
- ..agent_promts/protocols/semantic_enrichment_protocol.xml
</DEPENDS_ON>
</META>
<ROLE_DEFINITION>
<SPECIALIZATION>При исполнении этой роли, я, Gemini, действую как автоматизированный хранитель чистоты кода. Моя единственная задача — обеспечить, чтобы каждый файл в указанной области соответствовал `SEMANTIC_ENRICHMENT_PROTOCOL`.</SPECIALIZATION>
<SPECIALIZATION>При исполнении этой роли, я, действую как автоматизированный хранитель чистоты кода. Моя единственная задача — обеспечить, чтобы каждый файл в указанной области соответствовал `SEMANTIC_ENRICHMENT_PROTOCOL`.</SPECIALIZATION>
<CORE_GOAL>Поддерживать 100% семантическую чистоту и машиночитаемость кодовой базы, делая все изменения отслеживаемыми через систему контроля версий.</CORE_GOAL>
</ROLE_DEFINITION>
@@ -30,18 +30,6 @@
</PHILOSOPHY_PRINCIPLE>
</CORE_PHILOSOPHY>
<TOOLS_FOR_ROLE>
<TOOL name="CodeEditor">
<COMMANDS><COMMAND name="ReadFile"/><COMMAND name="WriteFile"/></COMMANDS>
</TOOL>
<TOOL name="Shell">
<ALLOWED_COMMANDS>
<COMMAND>find . -name "*.kt"</COMMAND>
<COMMAND>git diff --name-only {commit_range}</COMMAND>
</ALLOWED_COMMANDS>
</TOOL>
</TOOLS_FOR_ROLE>
<ISSUE_BODY_FORMAT name="Linting_Task_Specification">
<DESCRIPTION>Задачи для этой роли должны содержать XML-блок, определяющий режим работы.</DESCRIPTION>
<STRUCTURE>

8
agent_promts/shared/metrics_catalog.xml
View File

@@ -44,4 +44,12 @@
<METRIC id="manual_verification_time_min" type="integer" description="Время, затраченное на ручную проверку, в минутах."/>
</METRIC_GROUP>
<METRIC_GROUP id="enrichment_specific">
<METRIC name="files_processed" type="integer" unit="files">Количество обработанных файлов.</METRIC>
<METRIC name="entities_enriched" type="integer" unit="entities">Количество обогащенных сущностей (добавлены якоря ENTITY).</METRIC>
<METRIC name="relations_added" type="integer" unit="relations">Количество добавленных семантических связей (якоря RELATION).</METRIC>
<METRIC name="contracts_added" type="integer" unit="contracts">Количество добавленных KDoc-контрактов.</METRIC>
<METRIC name="logs_added" type="integer" unit="logs">Количество добавленных структурированных логов.</METRIC>
</METRIC_GROUP>
</METRICS_CATALOG>

4
app/src/main/java/com/homebox/lens/MainActivity.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens
// [FILE] MainActivity.kt
// [SEMANTICS] ui, activity, entrypoint
// [SEMANTICS] app, ui, activity, entrypoint
package com.homebox.lens
// [IMPORTS]
@@ -22,7 +22,7 @@ import timber.log.Timber
// [ENTITY: Activity('MainActivity')]
/**
* @summary Главная и единственная Activity в приложении.
* @summary The main and only Activity in the application.
*/
@AndroidEntryPoint
class MainActivity : ComponentActivity() {

4
app/src/main/java/com/homebox/lens/MainApplication.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens
// [FILE] MainApplication.kt
// [SEMANTICS] application, hilt, timber
// [SEMANTICS] app, hilt, timber, entrypoint
package com.homebox.lens
// [IMPORTS]
@@ -11,7 +11,7 @@ import timber.log.Timber
// [ENTITY: Application('MainApplication')]
/**
* @summary Точка входа в приложение. Инициализирует Hilt и Timber.
* @summary The entry point of the application. Initializes Hilt and Timber.
*/
@HiltAndroidApp
class MainApplication : Application() {

10
app/src/main/java/com/homebox/lens/navigation/NavGraph.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.navigation
// [FILE] NavGraph.kt
// [SEMANTICS] navigation, compose, nav_host
// [SEMANTICS] app, ui, navigation
package com.homebox.lens.navigation
@@ -34,11 +34,11 @@ import com.homebox.lens.ui.screen.splash.SplashScreen
// [RELATION: Function('NavGraph')] -> [CREATES_INSTANCE_OF] -> [Class('NavigationActions')]
// [RELATION: Function('NavGraph')] -> [USES] -> [Screen('SplashScreen')]
/**
* @summary Определяет граф навигации для всего приложения с использованием Jetpack Compose Navigation.
* @param navController Контроллер навигации.
* @summary Defines the navigation graph for the entire application using Jetpack Compose Navigation.
* @param navController The navigation controller.
* @see Screen
* @sideeffect Регистрирует все экраны и управляет состоянием навигации.
* @invariant Стартовый экран - `Screen.Setup`.
* @sideeffect Registers all screens and manages the navigation state.
* @invariant The start screen is `Screen.Splash`.
*/
@Composable
fun NavGraph(

12
app/src/main/java/com/homebox/lens/navigation/NavigationActions.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.navigation
// [FILE] NavigationActions.kt
// [SEMANTICS] navigation, controller, actions
// [SEMANTICS] app, ui, navigation, actions
package com.homebox.lens.navigation
// [IMPORTS]
@@ -11,16 +11,16 @@ import timber.log.Timber
// [ENTITY: Class('NavigationActions')]
// [RELATION: Class('NavigationActions')] -> [DEPENDS_ON] -> [Framework('NavHostController')]
/**
* @summary Класс-обертка над NavHostController для предоставления типизированных навигационных действий.
* @param navController Контроллер Jetpack Navigation.
* @invariant Все навигационные действия должны использовать предоставленный navController.
* @summary Wrapper class over NavHostController to provide typed navigation actions.
* @param navController The Jetpack Navigation controller.
* @invariant All navigation actions must use the provided navController.
*/
class NavigationActions(private val navController: NavHostController) {
// [ENTITY: Function('navigateToDashboard')]
/**
* @summary Навигация на главный экран.
* @sideeffect Очищает back stack до главного экрана, чтобы избежать циклов.
* @summary Navigation to the main screen.
* @sideeffect Clears the back stack up to the main screen to avoid cycles.
*/
fun navigateToDashboard() {
Timber.i("[INFO][ACTION][navigate_to_dashboard] Navigating to Dashboard.")

46
app/src/main/java/com/homebox/lens/navigation/Screen.kt
View File

@@ -1,13 +1,13 @@
// [PACKAGE] com.homebox.lens.navigation
// [FILE] Screen.kt
// [SEMANTICS] navigation, routes, sealed_class
// [SEMANTICS] app, ui, navigation, routes
package com.homebox.lens.navigation
// [ENTITY: SealedClass('Screen')]
/**
* @summary Запечатанный класс для определения маршрутов навигации в приложении.
* @description Обеспечивает типобезопасность при навигации.
* @param route Строковый идентификатор маршрута.
* @summary Sealed class for defining navigation routes in the application.
* @description Provides type safety during navigation.
* @param route The string identifier of the route.
*/
sealed class Screen(val route: String) {
// [ENTITY: Object('Splash')]
@@ -26,11 +26,11 @@ sealed class Screen(val route: String) {
data object InventoryList : Screen("inventory_list_screen") {
// [ENTITY: Function('withFilter')]
/**
* @summary Создает маршрут для экрана списка инвентаря с параметром фильтра.
* @param key Ключ фильтра (например, "label" или "location").
* @param value Значение фильтра (например, ID метки или местоположения).
* @return Строку полного маршрута с query-параметром.
* @throws IllegalArgumentException если ключ или значение пустые.
* @summary Creates a route for the inventory list screen with a filter parameter.
* @param key The filter key (e.g., "label" or "location").
* @param value The filter value (e.g., the ID of the label or location).
* @return A string of the full route with a query parameter.
* @throws IllegalArgumentException if the key or value is blank.
*/
fun withFilter(key: String, value: String): String {
require(key.isNotBlank()) { "Filter key cannot be blank." }
@@ -47,10 +47,10 @@ sealed class Screen(val route: String) {
data object ItemDetails : Screen("item_details_screen/{itemId}") {
// [ENTITY: Function('createRoute')]
/**
* @summary Создает маршрут для экрана деталей элемента с указанным ID.
* @param itemId ID элемента для отображения.
* @return Строку полного маршрута.
* @throws IllegalArgumentException если itemId пустой.
* @summary Creates a route for the item details screen with the specified ID.
* @param itemId The ID of the item to display.
* @return A string of the full route.
* @throws IllegalArgumentException if itemId is blank.
*/
fun createRoute(itemId: String): String {
require(itemId.isNotBlank()) { "itemId не может быть пустым." }
@@ -66,9 +66,9 @@ sealed class Screen(val route: String) {
data object ItemEdit : Screen("item_edit_screen?itemId={itemId}") {
// [ENTITY: Function('createRoute')]
/**
* @summary Создает маршрут для экрана редактирования элемента с указанным ID.
* @param itemId ID элемента для редактирования. Null, если создается новый элемент.
* @return Строку полного маршрута.
* @summary Creates a route for the item edit screen with the specified ID.
* @param itemId The ID of the item to edit. Null if a new item is being created.
* @return A string of the full route.
*/
fun createRoute(itemId: String? = null): String {
return itemId?.let { "item_edit_screen?itemId=$it" } ?: "item_edit_screen"
@@ -85,9 +85,9 @@ sealed class Screen(val route: String) {
data object LabelEdit : Screen("label_edit_screen?labelId={labelId}") {
// [ENTITY: Function('createRoute')]
/**
* @summary Создает маршрут для экрана редактирования метки с указанным ID.
* @param labelId ID метки для редактирования. Null, если создается новая метка.
* @return Строку полного маршрута.
* @summary Creates a route for the label edit screen with the specified ID.
* @param labelId The ID of the label to edit. Null if a new label is being created.
* @return A string of the full route.
*/
fun createRoute(labelId: String? = null): String {
return labelId?.let { "label_edit_screen?labelId=$it" } ?: "label_edit_screen"
@@ -104,10 +104,10 @@ sealed class Screen(val route: String) {
data object LocationEdit : Screen("location_edit_screen/{locationId}") {
// [ENTITY: Function('createRoute')]
/**
* @summary Создает маршрут для экрана редактирования местоположения с указанным ID.
* @param locationId ID местоположения для редактирования.
* @return Строку полного маршрута.
* @throws IllegalArgumentException если locationId пустой.
* @summary Creates a route for the location edit screen with the specified ID.
* @param locationId The ID of the location to edit.
* @return A string of the full route.
* @throws IllegalArgumentException if locationId is blank.
*/
fun createRoute(locationId: String): String {
require(locationId.isNotBlank()) { "locationId не может быть пустым." }

10
app/src/main/java/com/homebox/lens/ui/common/AppDrawer.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.common
// [FILE] AppDrawer.kt
// [SEMANTICS] ui, common, navigation_drawer
// [SEMANTICS] app, ui, common, navigation
package com.homebox.lens.ui.common
// [IMPORTS]
@@ -30,10 +30,10 @@ import com.homebox.lens.navigation.Screen
// [ENTITY: Function('AppDrawerContent')]
// [RELATION: Function('AppDrawerContent')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
/**
* @summary Контент для бокового навигационного меню (Drawer).
* @param currentRoute Текущий маршрут для подсветки активного элемента.
* @param navigationActions Объект с навигационными действиями.
* @param onCloseDrawer Лямбда для закрытия бокового меню.
* @summary Content for the side navigation menu (Drawer).
* @param currentRoute The current route to highlight the active item.
* @param navigationActions The object with navigation actions.
* @param onCloseDrawer Lambda to close the side menu.
*/
@Composable
internal fun AppDrawerContent(

18
app/src/main/java/com/homebox/lens/ui/common/MainScaffold.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.common
// [FILE] MainScaffold.kt
// [SEMANTICS] ui, common, scaffold, navigation_drawer
// [SEMANTICS] app, ui, common, scaffold
package com.homebox.lens.ui.common
@@ -21,14 +21,14 @@ import kotlinx.coroutines.launch
// [RELATION: Function('MainScaffold')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
// [RELATION: Function('MainScaffold')] -> [CALLS] -> [Function('AppDrawerContent')]
/**
* @summary Общая обертка для экранов, включающая Scaffold и Navigation Drawer.
* @param topBarTitle Заголовок для TopAppBar.
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
* @param navigationActions Объект с навигационными действиями.
* @param topBarActions Composable-функция для отображения действий (иконок) в TopAppBar.
* @param content Основное содержимое экрана, которое будет отображено внутри Scaffold.
* @sideeffect Управляет состоянием (открыто/закрыто) бокового меню (ModalNavigationDrawer).
* @invariant TopAppBar всегда отображается с иконкой меню.
* @summary A common wrapper for screens that includes a Scaffold and Navigation Drawer.
* @param topBarTitle The title for the TopAppBar.
* @param currentRoute The current route to highlight the active item in the Drawer.
* @param navigationActions The object with navigation actions.
* @param topBarActions A Composable function to display actions (icons) in the TopAppBar.
* @param content The main content of the screen to be displayed inside the Scaffold.
* @sideeffect Manages the state (open/closed) of the side menu (ModalNavigationDrawer).
* @invariant The TopAppBar is always displayed with a menu icon.
*/
@OptIn(ExperimentalMaterial3Api::class)
@Composable

10
app/src/main/java/com/homebox/lens/ui/components/ColorPicker.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.components
// [FILE] ColorPicker.kt
// [SEMANTICS] ui, component, color_selection
// [SEMANTICS] app, ui, component, color
package com.homebox.lens.ui.components
@@ -25,10 +25,10 @@ import com.homebox.lens.R
// [ENTITY: Function('ColorPicker')]
/**
* @summary Компонент для выбора цвета.
* @param selectedColor Текущий выбранный цвет в формате HEX строки (например, "#FFFFFF").
* @param onColorSelected Лямбда-функция, вызываемая при выборе нового цвета.
* @param modifier Модификатор для настройки внешнего вида.
* @summary A component for color selection.
* @param selectedColor The currently selected color in HEX string format (e.g., "#FFFFFF").
* @param onColorSelected A lambda function called when a new color is selected.
* @param modifier A modifier for customizing the appearance.
*/
@Composable
fun ColorPicker(

4
app/src/main/java/com/homebox/lens/ui/components/LoadingOverlay.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.components
// [FILE] LoadingOverlay.kt
// [SEMANTICS] ui, component, loading
// [SEMANTICS] app, ui, component, loading
package com.homebox.lens.ui.components
@@ -18,7 +18,7 @@ import androidx.compose.ui.graphics.Color
// [ENTITY: Function('LoadingOverlay')]
/**
* @summary Полноэкранный оверлей с индикатором загрузки.
* @summary A full-screen overlay with a loading indicator.
*/
@Composable
fun LoadingOverlay() {

2
app/src/main/java/com/homebox/lens/ui/mapper/ItemMapper.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.mapper
// [FILE] ItemMapper.kt
// [SEMANTICS] ui, mapper, item
// [SEMANTICS] app, ui, mapper, item
package com.homebox.lens.ui.mapper
import com.homebox.lens.domain.model.Item

52
app/src/main/java/com/homebox/lens/ui/screen/dashboard/DashboardScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.dashboard
// [FILE] DashboardScreen.kt
// [SEMANTICS] ui, screen, dashboard, compose, navigation
// [SEMANTICS] app, ui, screen, dashboard
package com.homebox.lens.ui.screen.dashboard
// [IMPORTS]
@@ -37,11 +37,11 @@ import timber.log.Timber
// [RELATION: Function('DashboardScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
// [RELATION: Function('DashboardScreen')] -> [CALLS] -> [Function('MainScaffold')]
/**
* @summary Главная Composable-функция для экрана "Панель управления".
* @param viewModel ViewModel для этого экрана, предоставляется через Hilt.
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
* @param navigationActions Объект с навигационными действиями.
* @sideeffect Вызывает навигационные лямбды при взаимодействии с UI.
* @summary The main Composable function for the "Dashboard" screen.
* @param viewModel The ViewModel for this screen, provided by Hilt.
* @param currentRoute The current route to highlight the active item in the Drawer.
* @param navigationActions The object with navigation actions.
* @sideeffect Calls navigation lambdas upon UI interaction.
*/
@Composable
fun DashboardScreen(
@@ -82,11 +82,11 @@ fun DashboardScreen(
// [ENTITY: Function('DashboardContent')]
// [RELATION: Function('DashboardContent')] -> [CONSUMES_STATE] -> [SealedInterface('DashboardUiState')]
/**
* @summary Отображает основной контент экрана в зависимости от uiState.
* @param modifier Модификатор для стилизации.
* @param uiState Текущее состояние UI экрана.
* @param onLocationClick Лямбда-обработчик нажатия на местоположение.
* @param onLabelClick Лямбда-обработчик нажатия на метку.
* @summary Displays the main content of the screen depending on the uiState.
* @param modifier A modifier for styling.
* @param uiState The current UI state of the screen.
* @param onLocationClick A lambda handler for clicking on a location.
* @param onLabelClick A lambda handler for clicking on a label.
*/
@Composable
private fun DashboardContent(
@@ -132,8 +132,8 @@ private fun DashboardContent(
// [ENTITY: Function('StatisticsSection')]
// [RELATION: Function('StatisticsSection')] -> [DEPENDS_ON] -> [DataClass('GroupStatistics')]
/**
* @summary Секция для отображения общей статистики.
* @param statistics Объект со статистическими данными.
* @summary Section for displaying general statistics.
* @param statistics The object with statistical data.
*/
@Composable
private fun StatisticsSection(statistics: GroupStatistics) {
@@ -164,9 +164,9 @@ private fun StatisticsSection(statistics: GroupStatistics) {
// [ENTITY: Function('StatisticCard')]
/**
* @summary Карточка для отображения одного статистического показателя.
* @param title Название показателя.
* @param value Значение показателя.
* @summary Card for displaying a single statistical indicator.
* @param title The name of the indicator.
* @param value The value of the indicator.
*/
@Composable
private fun StatisticCard(title: String, value: String) {
@@ -180,8 +180,8 @@ private fun StatisticCard(title: String, value: String) {
// [ENTITY: Function('RecentlyAddedSection')]
// [RELATION: Function('RecentlyAddedSection')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
/**
* @summary Секция для отображения недавно добавленных элементов.
* @param items Список элементов для отображения.
* @summary Section for displaying recently added items.
* @param items The list of items to display.
*/
@Composable
private fun RecentlyAddedSection(items: List<ItemSummary>) {
@@ -213,8 +213,8 @@ private fun RecentlyAddedSection(items: List<ItemSummary>) {
// [ENTITY: Function('ItemCard')]
// [RELATION: Function('ItemCard')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
/**
* @summary Карточка для отображения краткой информации об элементе.
* @param item Элемент для отображения.
* @summary Card for displaying brief information about an item.
* @param item The item to display.
*/
@Composable
private fun ItemCard(item: ItemSummary) {
@@ -236,9 +236,9 @@ private fun ItemCard(item: ItemSummary) {
// [ENTITY: Function('LocationsSection')]
// [RELATION: Function('LocationsSection')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
/**
* @summary Секция для отображения местоположений в виде чипсов.
* @param locations Список местоположений.
* @param onLocationClick Лямбда-обработчик нажатия на местоположение.
* @summary Section for displaying locations as chips.
* @param locations The list of locations.
* @param onLocationClick A lambda handler for clicking on a location.
*/
@OptIn(ExperimentalLayoutApi::class)
@Composable
@@ -265,9 +265,9 @@ private fun LocationsSection(locations: List<LocationOutCount>, onLocationClick:
// [ENTITY: Function('LabelsSection')]
// [RELATION: Function('LabelsSection')] -> [DEPENDS_ON] -> [DataClass('LabelOut')]
/**
* @summary Секция для отображения меток в виде чипсов.
* @param labels Список меток.
* @param onLabelClick Лямбда-обработчик нажатия на метку.
* @summary Section for displaying labels as chips.
* @param labels The list of labels.
* @param onLabelClick A lambda handler for clicking on a label.
*/
@OptIn(ExperimentalLayoutApi::class)
@Composable

22
app/src/main/java/com/homebox/lens/ui/screen/dashboard/DashboardUiState.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.dashboard
// [FILE] DashboardUiState.kt
// [SEMANTICS] ui, state, dashboard
// [SEMANTICS] app, ui, state, dashboard
package com.homebox.lens.ui.screen.dashboard
// [IMPORTS]
@@ -12,8 +12,8 @@ import com.homebox.lens.domain.model.LocationOutCount
// [ENTITY: SealedInterface('DashboardUiState')]
/**
* @summary Определяет все возможные состояния для экрана "Дэшборд".
* @invariant В любой момент времени экран может находиться только в одном из этих состояний.
* @summary Defines all possible states for the "Dashboard" screen.
* @invariant At any given time, the screen can only be in one of these states.
*/
sealed interface DashboardUiState {
// [ENTITY: DataClass('Success')]
@@ -22,11 +22,11 @@ sealed interface DashboardUiState {
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('LabelOut')]
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
/**
* @summary Состояние успешной загрузки данных.
* @param statistics Статистика по инвентарю.
* @param locations Список локаций со счетчиками.
* @param labels Список всех меток.
* @param recentlyAddedItems Список недавно добавленных товаров.
* @summary The state of a successful data load.
* @param statistics The inventory statistics.
* @param locations The list of locations with counters.
* @param labels The list of all labels.
* @param recentlyAddedItems The list of recently added items.
*/
data class Success(
val statistics: GroupStatistics,
@@ -38,15 +38,15 @@ sealed interface DashboardUiState {
// [ENTITY: DataClass('Error')]
/**
* @summary Состояние ошибки во время загрузки данных.
* @param message Человекочитаемое сообщение об ошибке.
* @summary The state of an error during data loading.
* @param message A human-readable error message.
*/
data class Error(val message: String) : DashboardUiState
// [END_ENTITY: DataClass('Error')]
// [ENTITY: Object('Loading')]
/**
* @summary Состояние, когда данные для экрана загружаются.
* @summary The state when data for the screen is being loaded.
*/
data object Loading : DashboardUiState
// [END_ENTITY: Object('Loading')]

18
app/src/main/java/com/homebox/lens/ui/screen/dashboard/DashboardViewModel.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.dashboard
// [FILE] DashboardViewModel.kt
// [SEMANTICS] ui_logic, dashboard, state_management, sealed_state, parallel_data_loading, timber_logging
// [SEMANTICS] app, ui, viewmodel, dashboard
package com.homebox.lens.ui.screen.dashboard
// [IMPORTS]
@@ -24,10 +24,10 @@ import javax.inject.Inject
// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetRecentlyAddedItemsUseCase')]
// [RELATION: ViewModel('DashboardViewModel')] -> [EMITS_STATE] -> [SealedInterface('DashboardUiState')]
/**
* @summary ViewModel для главного экрана (Dashboard).
* @description Оркестрирует загрузку данных для Dashboard, используя строгую модель состояний
* (`DashboardUiState`), и обрабатывает параллельные запросы без состояний гонки.
* @invariant `uiState` всегда является одним из состояний, определенных в `DashboardUiState`.
* @summary ViewModel for the main screen (Dashboard).
* @description Orchestrates the loading of data for the Dashboard, using a strict state model
* (`DashboardUiState`), and handles parallel requests without race conditions.
* @invariant `uiState` is always one of the states defined in `DashboardUiState`.
*/
@HiltViewModel
class DashboardViewModel @Inject constructor(
@@ -46,10 +46,10 @@ class DashboardViewModel @Inject constructor(
// [ENTITY: Function('loadDashboardData')]
/**
* @summary Загружает все необходимые данные для экрана Dashboard.
* @description Выполняет UseCase'ы параллельно и обновляет UI, переключая его
* между состояниями `Loading`, `Success` и `Error` из `DashboardUiState`.
* @sideeffect Асинхронно обновляет `_uiState` одним из состояний `DashboardUiState`.
* @summary Loads all necessary data for the Dashboard screen.
* @description Executes UseCases in parallel and updates the UI by switching it
* between the `Loading`, `Success`, and `Error` states from `DashboardUiState`.
* @sideeffect Asynchronously updates `_uiState` with one of the `DashboardUiState` states.
*/
fun loadDashboardData() {
viewModelScope.launch {

8
app/src/main/java/com/homebox/lens/ui/screen/inventorylist/InventoryListScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.inventorylist
// [FILE] InventoryListScreen.kt
// [SEMANTICS] ui, screen, inventory, list
// [SEMANTICS] app, ui, screen, list
package com.homebox.lens.ui.screen.inventorylist
@@ -17,9 +17,9 @@ import com.homebox.lens.ui.common.MainScaffold
// [RELATION: Function('InventoryListScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
// [RELATION: Function('InventoryListScreen')] -> [CALLS] -> [Function('MainScaffold')]
/**
* @summary Composable-функция для экрана "Список инвентаря".
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
* @param navigationActions Объект с навигационными действиями.
* @summary Composable function for the "Inventory List" screen.
* @param currentRoute The current route to highlight the active item in the Drawer.
* @param navigationActions The object with navigation actions.
*/
@Composable
fun InventoryListScreen(

2
app/src/main/java/com/homebox/lens/ui/screen/inventorylist/InventoryListViewModel.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.inventorylist
// [FILE] InventoryListViewModel.kt
// [SEMANTICS] ui, viewmodel, inventory_list
// [SEMANTICS] app, ui, viewmodel, list
package com.homebox.lens.ui.screen.inventorylist
// [IMPORTS]

8
app/src/main/java/com/homebox/lens/ui/screen/itemdetails/ItemDetailsScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.itemdetails
// [FILE] ItemDetailsScreen.kt
// [SEMANTICS] ui, screen, item, details
// [SEMANTICS] app, ui, screen, details
package com.homebox.lens.ui.screen.itemdetails
@@ -17,9 +17,9 @@ import com.homebox.lens.ui.common.MainScaffold
// [RELATION: Function('ItemDetailsScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
// [RELATION: Function('ItemDetailsScreen')] -> [CALLS] -> [Function('MainScaffold')]
/**
* @summary Composable-функция для экрана "Детали элемента".
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
* @param navigationActions Объект с навигационными действиями.
* @summary Composable function for the "Item Details" screen.
* @param currentRoute The current route to highlight the active item in the Drawer.
* @param navigationActions The object with navigation actions.
*/
@Composable
fun ItemDetailsScreen(

2
app/src/main/java/com/homebox/lens/ui/screen/itemdetails/ItemDetailsViewModel.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.itemdetails
// [FILE] ItemDetailsViewModel.kt
// [SEMANTICS] ui, viewmodel, item_details
// [SEMANTICS] app, ui, viewmodel, details
package com.homebox.lens.ui.screen.itemdetails
// [IMPORTS]

165
app/src/main/java/com/homebox/lens/ui/screen/itemedit/ItemEditScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.itemedit
// [FILE] ItemEditScreen.kt
// [SEMANTICS] ui, screen, item, edit
// [SEMANTICS] app, ui, screen, edit
package com.homebox.lens.ui.screen.itemedit
@@ -21,13 +21,17 @@ import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.ArrowDropDown
import androidx.compose.material.icons.filled.DateRange
import androidx.compose.material.icons.filled.Save
import androidx.compose.material3.AlertDialog
import androidx.compose.material3.Card
import androidx.compose.material3.CardDefaults
import androidx.compose.material3.Checkbox
import androidx.compose.material3.CircularProgressIndicator
import androidx.compose.material3.DatePicker
import androidx.compose.material3.DatePickerDialog
import androidx.compose.material3.DropdownMenuItem
import androidx.compose.material3.ExperimentalMaterial3Api
import androidx.compose.material3.ExposedDropdownMenuBox
import androidx.compose.material3.ExposedDropdownMenuDefaults
import androidx.compose.material3.FloatingActionButton
import androidx.compose.material3.Icon
import androidx.compose.material3.IconButton
@@ -38,6 +42,7 @@ import androidx.compose.material3.SnackbarHost
import androidx.compose.material3.SnackbarHostState
import androidx.compose.material3.Switch
import androidx.compose.material3.Text
import androidx.compose.material3.TextButton
import androidx.compose.material3.rememberDatePickerState
import androidx.compose.runtime.Composable
import androidx.compose.runtime.LaunchedEffect
@@ -67,12 +72,12 @@ import java.util.Locale
// [RELATION: Composable('ItemEditScreen')] -> [CONSUMES_STATE] -> [DataClass('ItemEditUiState')]
// [RELATION: Composable('ItemEditScreen')] -> [CALLS] -> [Composable('MainScaffold')]
/**
* @summary Composable-функция для экрана "Редактирование элемента".
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
* @param navigationActions Объект с навигационными действиями.
* @param itemId ID элемента для редактирования. Null, если создается новый элемент.
* @param viewModel ViewModel для управления состоянием экрана.
* @param onSaveSuccess Callback, вызываемый после успешного сохранения товара.
* @summary Composable function for the "Edit Item" screen.
* @param currentRoute The current route to highlight the active item in the Drawer.
* @param navigationActions The object with navigation actions.
* @param itemId The ID of the item to edit. Null if a new item is being created.
* @param viewModel The ViewModel for managing the screen's state.
* @param onSaveSuccess A callback invoked after the item is successfully saved.
*/
@OptIn(ExperimentalMaterial3Api::class)
@Composable
@@ -164,34 +169,124 @@ fun ItemEditScreen(
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Number),
modifier = Modifier.fillMaxWidth()
)
Spacer(modifier = Modifier.height(8.dp))
// [AI_NOTE]: Location selection will require a separate component or screen.
OutlinedTextField(
value = item.location?.name ?: "",
onValueChange = { /* TODO: Implement location selection */ },
label = { Text(stringResource(R.string.item_edit_location)) },
readOnly = true,
trailingIcon = {
IconButton(onClick = { /* TODO: Implement location selection */ }) {
Icon(Icons.Filled.ArrowDropDown, contentDescription = stringResource(R.string.item_edit_select_location))
}
},
modifier = Modifier.fillMaxWidth()
)
Spacer(modifier = Modifier.height(8.dp))
// [AI_NOTE]: Label selection will require a separate component or screen.
OutlinedTextField(
value = item.labels.joinToString { it.name },
onValueChange = { /* TODO: Implement label selection */ },
label = { Text(stringResource(R.string.item_edit_labels)) },
readOnly = true,
trailingIcon = {
IconButton(onClick = { /* TODO: Implement label selection */ }) {
Icon(Icons.Filled.ArrowDropDown, contentDescription = stringResource(R.string.item_edit_select_labels))
}
},
modifier = Modifier.fillMaxWidth()
)
Spacer(modifier = Modifier.height(8.dp))
// Location Dropdown
var locationExpanded by remember { mutableStateOf(false) }
ExposedDropdownMenuBox(
expanded = locationExpanded,
onExpandedChange = { locationExpanded = !locationExpanded }
) {
OutlinedTextField(
value = item.location?.name ?: "",
onValueChange = { },
label = { Text(stringResource(R.string.item_edit_location)) },
readOnly = true,
trailingIcon = {
ExposedDropdownMenuDefaults.TrailingIcon(expanded = locationExpanded)
},
modifier = Modifier
.fillMaxWidth()
.menuAnchor()
)
ExposedDropdownMenu(
expanded = locationExpanded,
onDismissRequest = { locationExpanded = false }
) {
uiState.allLocations.forEach { location ->
DropdownMenuItem(
text = { Text(location.name) },
onClick = {
viewModel.updateLocation(location)
locationExpanded = false
}
)
}
}
}
Spacer(modifier = Modifier.height(8.dp))
// Labels Dialog
var showLabelsDialog by remember { mutableStateOf(false) }
OutlinedTextField(
value = item.labels.joinToString { it.name },
onValueChange = { },
label = { Text(stringResource(R.string.item_edit_labels)) },
readOnly = true,
modifier = Modifier
.fillMaxWidth()
.clickable { showLabelsDialog = true },
trailingIcon = {
Icon(Icons.Filled.ArrowDropDown, contentDescription = stringResource(R.string.item_edit_select_labels))
}
)
if (showLabelsDialog) {
// This state will hold the temporary selections within the dialog
val tempSelectedLabels = remember { mutableStateOf(item.labels.toSet()) }
AlertDialog(
onDismissRequest = { showLabelsDialog = false },
title = { Text(stringResource(R.string.item_edit_select_labels)) },
text = {
Column {
uiState.allLabels.forEach { label ->
val isChecked = tempSelectedLabels.value.contains(label)
Row(
verticalAlignment = Alignment.CenterVertically,
modifier = Modifier
.fillMaxWidth()
.clickable {
val currentSelection = tempSelectedLabels.value.toMutableSet()
if (isChecked) {
currentSelection.remove(label)
} else {
currentSelection.add(label)
}
tempSelectedLabels.value = currentSelection
}
.padding(vertical = 8.dp)
) {
Checkbox(
checked = isChecked,
onCheckedChange = {
val currentSelection = tempSelectedLabels.value.toMutableSet()
if (it) {
currentSelection.add(label)
} else {
currentSelection.remove(label)
}
tempSelectedLabels.value = currentSelection
}
)
Text(
text = label.name,
modifier = Modifier.padding(start = 8.dp)
)
}
}
}
},
confirmButton = {
TextButton(
onClick = {
// Update the ViewModel with the final selection
viewModel.updateLabels(tempSelectedLabels.value.toList())
showLabelsDialog = false
}
) {
Text(stringResource(R.string.dialog_ok))
}
},
dismissButton = {
TextButton(onClick = { showLabelsDialog = false }) {
Text(stringResource(R.string.dialog_cancel))
}
}
)
}
}
}

7
app/src/main/java/com/homebox/lens/ui/screen/itemedit/ItemEditViewModel.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.itemedit
// [FILE] ItemEditViewModel.kt
// [SEMANTICS] ui, viewmodel, item_edit
// [SEMANTICS] app, ui, viewmodel, edit
package com.homebox.lens.ui.screen.itemedit
@@ -16,6 +16,7 @@ import com.homebox.lens.domain.usecase.CreateItemUseCase
import com.homebox.lens.domain.usecase.GetAllLabelsUseCase
import com.homebox.lens.domain.usecase.GetAllLocationsUseCase
import com.homebox.lens.domain.usecase.GetItemDetailsUseCase
import com.homebox.lens.data.mapper.toDomain
import com.homebox.lens.domain.usecase.UpdateItemUseCase
import com.homebox.lens.ui.mapper.ItemMapper
import dagger.hilt.android.lifecycle.HiltViewModel
@@ -59,6 +60,8 @@ data class ItemEditUiState(
* @param createItemUseCase Use case for creating a new item.
* @param updateItemUseCase Use case for updating an existing item.
* @param getItemDetailsUseCase Use case for fetching item details.
* @param getAllLocationsUseCase Use case for fetching all locations.
* @param getAllLabelsUseCase Use case for fetching all labels.
* @param itemMapper Mapper for converting between domain and UI item models.
*/
@HiltViewModel
@@ -141,7 +144,7 @@ class ItemEditViewModel @Inject constructor(
Timber.i("[INFO][ACTION][fetching_all_locations] Fetching all locations.")
val allLocations = getAllLocationsUseCase().map { Location(it.id, it.name) }
Timber.i("[INFO][ACTION][fetching_all_labels] Fetching all labels.")
val allLabels = getAllLabelsUseCase().map { Label(it.id, it.name) }
val allLabels = getAllLabelsUseCase().map { it.toDomain() }
_uiState.value = _uiState.value.copy(allLocations = allLocations, allLabels = allLabels)
Timber.i("[INFO][ACTION][all_locations_labels_fetched] Successfully fetched all locations and labels.")
} catch (e: Exception) {

10
app/src/main/java/com/homebox/lens/ui/screen/labeledit/LabelEditScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.labeledit
// [FILE] LabelEditScreen.kt
// [SEMANTICS] ui, screen, label, edit
// [SEMANTICS] app, ui, screen, edit, label
package com.homebox.lens.ui.screen.labeledit
@@ -24,10 +24,10 @@ import com.homebox.lens.ui.components.LoadingOverlay
// [ENTITY: Function('LabelEditScreen')]
// [RELATION: Function('LabelEditScreen')] -> [DEPENDS_ON] -> [ViewModel('LabelEditViewModel')]
/**
* @summary Composable-функция для экрана "Редактирование метки".
* @param labelId ID метки для редактирования или null для создания новой.
* @param onBack Навигация назад.
* @param onLabelSaved Действие после сохранения метки.
* @summary Composable function for the "Edit Label" screen.
* @param labelId The ID of the label to edit, or null to create a new one.
* @param onBack Navigation back.
* @param onLabelSaved Action after the label is saved.
*/
@OptIn(ExperimentalMaterial3Api::class)
@Composable

2
app/src/main/java/com/homebox/lens/ui/screen/labeledit/LabelEditViewModel.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.labeledit
// [FILE] LabelEditViewModel.kt
// [SEMANTICS] ui, viewmodel, label_management
// [SEMANTICS] app, ui, viewmodel, edit, label
package com.homebox.lens.ui.screen.labeledit

24
app/src/main/java/com/homebox/lens/ui/screen/labelslist/LabelsListScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.labelslist
// [FILE] LabelsListScreen.kt
// [SEMANTICS] ui, labels_list, state_management, compose, dialog
// [SEMANTICS] app, ui, screen, list, label
package com.homebox.lens.ui.screen.labelslist
// [IMPORTS]
@@ -46,10 +46,10 @@ import timber.log.Timber
// [RELATION: Function('LabelsListScreen')] -> [DEPENDS_ON] -> [ViewModel('LabelsListViewModel')]
// [RELATION: Function('LabelsListScreen')] -> [DEPENDS_ON] -> [Framework('NavController')]
/**
* @summary Отображает экран со списком всех меток.
* @param currentRoute Текущий маршрут навигации.
* @param navigationActions Объект, содержащий действия по навигации.
* @param viewModel ViewModel, предоставляющая состояние UI для экрана меток.
* @summary Displays the screen with a list of all labels.
* @param currentRoute The current navigation route.
* @param navigationActions The object containing navigation actions.
* @param viewModel The ViewModel providing the UI state for the labels screen.
*/
@OptIn(ExperimentalMaterial3Api::class)
@Composable
@@ -116,10 +116,10 @@ fun LabelsListScreen(
// [ENTITY: Function('LabelsList')]
// [RELATION: Function('LabelsList')] -> [DEPENDS_ON] -> [DataClass('Label')]
/**
* @summary Composable-функция для отображения списка меток.
* @param labels Список объектов `Label` для отображения.
* @param onLabelClick Лямбда-функция, вызываемая при нажатии на элемент списка.
* @param modifier Модификатор для настройки внешнего вида.
* @summary Composable function for displaying a list of labels.
* @param labels The list of `Label` objects to display.
* @param onLabelClick A lambda function called when a list item is clicked.
* @param modifier A modifier for customizing the appearance.
*/
@Composable
private fun LabelsList(
@@ -145,9 +145,9 @@ private fun LabelsList(
// [ENTITY: Function('LabelListItem')]
// [RELATION: Function('LabelListItem')] -> [DEPENDS_ON] -> [DataClass('Label')]
/**
* @summary Composable-функция для отображения одного элемента в списке меток.
* @param label Объект `Label`, который нужно отобразить.
* @param onClick Лямбда-функция, вызываемая при нажатии на элемент.
* @summary Composable function for displaying a single item in the list of labels.
* @param label The `Label` object to display.
* @param onClick A lambda function called when the item is clicked.
*/
@Composable
private fun LabelListItem(

24
app/src/main/java/com/homebox/lens/ui/screen/labelslist/LabelsListUiState.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.labelslist
// [FILE] LabelsListUiState.kt
// [SEMANTICS] ui_state, sealed_interface, contract
// [SEMANTICS] app, ui, state, list, label
package com.homebox.lens.ui.screen.labelslist
// [IMPORTS]
@@ -9,17 +9,17 @@ import com.homebox.lens.domain.model.Label
// [ENTITY: SealedInterface('LabelsListUiState')]
/**
* @summary Определяет все возможные состояния для UI экрана со списком меток.
* @description Использование sealed-интерфейса позволяет исчерпывающе обрабатывать все состояния в Composable-функциях.
* @summary Defines all possible states for the UI of the screen with a list of labels.
* @description Using a sealed interface allows for exhaustive handling of all states in Composable functions.
*/
sealed interface LabelsListUiState {
// [ENTITY: DataClass('Success')]
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('Label')]
/**
* @summary Состояние успеха, содержит список меток и состояние диалога.
* @param labels Список меток для отображения.
* @param isShowingCreateDialog Флаг, показывающий, должен ли быть отображен диалог создания метки.
* @invariant labels не может быть null.
* @summary The success state, contains the list of labels and the state of the dialog.
* @param labels The list of labels to display.
* @param isShowingCreateDialog A flag indicating whether the label creation dialog should be displayed.
* @invariant labels cannot be null.
*/
data class Success(
val labels: List<Label>,
@@ -29,17 +29,17 @@ sealed interface LabelsListUiState {
// [ENTITY: DataClass('Error')]
/**
* @summary Состояние ошибки.
* @param message Текст ошибки для отображения пользователю.
* @invariant message не может быть пустой.
* @summary The error state.
* @param message The error text to display to the user.
* @invariant message cannot be empty.
*/
data class Error(val message: String) : LabelsListUiState
// [END_ENTITY: DataClass('Error')]
// [ENTITY: Object('Loading')]
/**
* @summary Состояние загрузки данных.
* @description Указывает, что идет процесс загрузки меток.
* @summary The data loading state.
* @description Indicates that the process of loading labels is in progress.
*/
data object Loading : LabelsListUiState
// [END_ENTITY: Object('Loading')]

40
app/src/main/java/com/homebox/lens/ui/screen/labelslist/LabelsListViewModel.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.labelslist
// [FILE] LabelsListViewModel.kt
// [SEMANTICS] ui_logic, labels_list, state_management, dialog_management
// [SEMANTICS] app, ui, viewmodel, list, label
package com.homebox.lens.ui.screen.labelslist
// [IMPORTS]
@@ -21,9 +21,9 @@ import javax.inject.Inject
// [RELATION: ViewModel('LabelsListViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLabelsUseCase')]
// [RELATION: ViewModel('LabelsListViewModel')] -> [EMITS_STATE] -> [SealedInterface('LabelsListUiState')]
/**
* @summary ViewModel для экрана со списком меток.
* @description Управляет состоянием экрана, загружает список меток, обрабатывает ошибки и управляет диалогом создания новой метки.
* @invariant `uiState` всегда является одним из состояний, определенных в `LabelsListUiState`.
* @summary ViewModel for the screen with a list of labels.
* @description Manages the screen state, loads the list of labels, handles errors, and manages the dialog for creating a new label.
* @invariant `uiState` is always one of the states defined in `LabelsListUiState`.
*/
@HiltViewModel
class LabelsListViewModel @Inject constructor(
@@ -39,10 +39,10 @@ class LabelsListViewModel @Inject constructor(
// [ENTITY: Function('loadLabels')]
/**
* @summary Загружает список меток.
* @description Выполняет `GetAllLabelsUseCase` и обновляет UI, переключая его
* между состояниями `Loading`, `Success` и `Error`.
* @sideeffect Асинхронно обновляет `_uiState`.
* @summary Loads the list of labels.
* @description Executes `GetAllLabelsUseCase` and updates the UI by switching it
* between the `Loading`, `Success`, and `Error` states.
* @sideeffect Asynchronously updates `_uiState`.
*/
fun loadLabels() {
viewModelScope.launch {
@@ -77,9 +77,9 @@ class LabelsListViewModel @Inject constructor(
// [ENTITY: Function('onShowCreateDialog')]
/**
* @summary Инициирует отображение диалога для создания метки.
* @description Обновляет состояние `uiState`, устанавливая `isShowingCreateDialog` в `true`.
* @sideeffect Обновляет `_uiState`.
* @summary Initiates the display of the dialog for creating a label.
* @description Updates the `uiState` by setting `isShowingCreateDialog` to `true`.
* @sideeffect Updates `_uiState`.
*/
fun onShowCreateDialog() {
Timber.i("[INFO][ACTION][show_create_dialog] Show create label dialog requested.")
@@ -93,9 +93,9 @@ class LabelsListViewModel @Inject constructor(
// [ENTITY: Function('onDismissCreateDialog')]
/**
* @summary Скрывает диалог создания метки.
* @description Обновляет состояние `uiState`, устанавливая `isShowingCreateDialog` в `false`.
* @sideeffect Обновляет `_uiState`.
* @summary Hides the label creation dialog.
* @description Updates the `uiState` by setting `isShowingCreateDialog` to `false`.
* @sideeffect Updates `_uiState`.
*/
fun onDismissCreateDialog() {
Timber.i("[INFO][ACTION][dismiss_create_dialog] Dismiss create label dialog requested.")
@@ -109,12 +109,12 @@ class LabelsListViewModel @Inject constructor(
// [ENTITY: Function('createLabel')]
/**
* @summary Создает новую метку. [MVP_SCOPE] ЗАГЛУШКА.
* @description В текущей реализации (План Б, Этап 1), эта функция только логирует действие
* и скрывает диалог. Реальная логика сохранения будет добавлена на следующем этапе.
* @param name Название новой метки.
* @precondition `name` не должен быть пустым.
* @sideeffect Логирует действие, обновляет `_uiState`, чтобы скрыть диалог.
* @summary Creates a new label. [MVP_SCOPE] STUB.
* @description In the current implementation (Plan B, Stage 1), this function only logs the action
* and hides the dialog. The actual save logic will be added in the next stage.
* @param name The name of the new label.
* @precondition `name` must not be blank.
* @sideeffect Logs the action, updates `_uiState` to hide the dialog.
*/
fun createLabel(name: String) {
require(name.isNotBlank()) { "[CONTRACT_VIOLATION] Label name cannot be blank." }

6
app/src/main/java/com/homebox/lens/ui/screen/locationedit/LocationEditScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.locationedit
// [FILE] LocationEditScreen.kt
// [SEMANTICS] ui, screen, location, edit
// [SEMANTICS] app, ui, screen, edit, location
package com.homebox.lens.ui.screen.locationedit
@@ -19,8 +19,8 @@ import com.homebox.lens.R
// [ENTITY: Function('LocationEditScreen')]
/**
* @summary Composable-функция для экрана "Редактирование местоположения".
* @param locationId ID местоположения для редактирования или "new" для создания.
* @summary Composable function for the "Edit Location" screen.
* @param locationId The ID of the location to edit, or "new" to create one.
*/
@Composable
fun LocationEditScreen(

36
app/src/main/java/com/homebox/lens/ui/screen/locationslist/LocationsListScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.locationslist
// [FILE] LocationsListScreen.kt
// [SEMANTICS] ui, screen, locations, list
// [SEMANTICS] app, ui, screen, list, location
package com.homebox.lens.ui.screen.locationslist
@@ -56,12 +56,12 @@ import com.homebox.lens.ui.theme.HomeboxLensTheme
// [RELATION: Function('LocationsListScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
// [RELATION: Function('LocationsListScreen')] -> [CALLS] -> [Function('MainScaffold')]
/**
* @summary Composable-функция для экрана "Список местоположений".
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
* @param navigationActions Объект с навигационными действиями.
* @param onLocationClick Лямбда-обработчик нажатия на местоположение.
* @param onAddNewLocationClick Лямбда-обработчик нажатия на кнопку добавления нового местоположения.
* @param viewModel ViewModel для этого экрана.
* @summary Composable function for the "List of Locations" screen.
* @param currentRoute The current route to highlight the active item in the Drawer.
* @param navigationActions The object with navigation actions.
* @param onLocationClick A lambda handler for clicking on a location.
* @param onAddNewLocationClick A lambda handler for clicking the button to add a new location.
* @param viewModel The ViewModel for this screen.
*/
@Composable
fun LocationsListScreen(
@@ -104,12 +104,12 @@ fun LocationsListScreen(
// [ENTITY: Function('LocationsListContent')]
// [RELATION: Function('LocationsListContent')] -> [CONSUMES_STATE] -> [SealedInterface('LocationsListUiState')]
/**
* @summary Отображает основной контент экрана в зависимости от `uiState`.
* @param modifier Модификатор для стилизации.
* @param uiState Текущее состояние UI.
* @param onLocationClick Лямбда-обработчик нажатия на местоположение.
* @param onEditLocation Лямбда-обработчик для редактирования местоположения.
* @param onDeleteLocation Лямбда-обработчик для удаления местоположения.
* @summary Displays the main content of the screen depending on the `uiState`.
* @param modifier A modifier for styling.
* @param uiState The current UI state.
* @param onLocationClick A lambda handler for clicking on a location.
* @param onEditLocation A lambda handler for editing a location.
* @param onDeleteLocation A lambda handler for deleting a location.
*/
@Composable
private fun LocationsListContent(
@@ -167,11 +167,11 @@ private fun LocationsListContent(
// [ENTITY: Function('LocationCard')]
// [RELATION: Function('LocationCard')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
/**
* @summary Карточка для отображения одного местоположения.
* @param location Данные о местоположении.
* @param onClick Лямбда-обработчик нажатия на карточку.
* @param onEditClick Лямбда-обработчик нажатия на "Редактировать".
* @param onDeleteClick Лямбда-обработчик нажатия на "Удалить".
* @summary Card for displaying a single location.
* @param location The data about the location.
* @param onClick A lambda handler for clicking on the card.
* @param onEditClick A lambda handler for clicking "Edit".
* @param onDeleteClick A lambda handler for clicking "Delete".
*/
@Composable
private fun LocationCard(

14
app/src/main/java/com/homebox/lens/ui/screen/locationslist/LocationsListUiState.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.locationslist
// [FILE] LocationsListUiState.kt
// [SEMANTICS] ui, state, locations
// [SEMANTICS] app, ui, state, list, location
package com.homebox.lens.ui.screen.locationslist
@@ -10,30 +10,30 @@ import com.homebox.lens.domain.model.LocationOutCount
// [ENTITY: SealedInterface('LocationsListUiState')]
/**
* @summary Определяет возможные состояния UI для экрана списка местоположений.
* @summary Defines the possible UI states for the list of locations screen.
* @see LocationsListViewModel
*/
sealed interface LocationsListUiState {
// [ENTITY: DataClass('Success')]
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
/**
* @summary Состояние успешной загрузки данных.
* @param locations Список местоположений для отображения.
* @summary The state of a successful data load.
* @param locations The list of locations to display.
*/
data class Success(val locations: List<LocationOutCount>) : LocationsListUiState
// [END_ENTITY: DataClass('Success')]
// [ENTITY: DataClass('Error')]
/**
* @summary Состояние ошибки.
* @param message Сообщение об ошибке.
* @summary The error state.
* @param message The error message.
*/
data class Error(val message: String) : LocationsListUiState
// [END_ENTITY: DataClass('Error')]
// [ENTITY: Object('Loading')]
/**
* @summary Состояние загрузки данных.
* @summary The data loading state.
*/
object Loading : LocationsListUiState
// [END_ENTITY: Object('Loading')]

14
app/src/main/java/com/homebox/lens/ui/screen/locationslist/LocationsListViewModel.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.locationslist
// [FILE] LocationsListViewModel.kt
// [SEMANTICS] ui, viewmodel, locations, hilt
// [SEMANTICS] app, ui, viewmodel, list, location
package com.homebox.lens.ui.screen.locationslist
@@ -21,10 +21,10 @@ import javax.inject.Inject
// [RELATION: ViewModel('LocationsListViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLocationsUseCase')]
// [RELATION: ViewModel('LocationsListViewModel')] -> [EMITS_STATE] -> [SealedInterface('LocationsListUiState')]
/**
* @summary ViewModel для экрана списка местоположений.
* @param getAllLocationsUseCase Use case для получения всех местоположений.
* @property uiState Поток, содержащий текущее состояние UI.
* @invariant `uiState` всегда отражает результат последней операции загрузки.
* @summary ViewModel for the list of locations screen.
* @param getAllLocationsUseCase Use case for getting all locations.
* @property uiState A flow containing the current UI state.
* @invariant `uiState` always reflects the result of the last load operation.
*/
@HiltViewModel
class LocationsListViewModel @Inject constructor(
@@ -40,8 +40,8 @@ class LocationsListViewModel @Inject constructor(
// [ENTITY: Function('loadLocations')]
/**
* @summary Загружает список местоположений из репозитория.
* @sideeffect Обновляет `_uiState` в зависимости от результата: Loading -> Success/Error.
* @summary Loads the list of locations from the repository.
* @sideeffect Updates `_uiState` depending on the result: Loading -> Success/Error.
*/
fun loadLocations() {
Timber.d("[DEBUG][ENTRYPOINT][loading_locations] Starting to load locations.")

8
app/src/main/java/com/homebox/lens/ui/screen/search/SearchScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.search
// [FILE] SearchScreen.kt
// [SEMANTICS] ui, screen, search
// [SEMANTICS] app, ui, screen, search
package com.homebox.lens.ui.screen.search
@@ -17,9 +17,9 @@ import com.homebox.lens.ui.common.MainScaffold
// [RELATION: Function('SearchScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
// [RELATION: Function('SearchScreen')] -> [CALLS] -> [Function('MainScaffold')]
/**
* @summary Composable-функция для экрана "Поиск".
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
* @param navigationActions Объект с навигационными действиями.
* @summary Composable function for the "Search" screen.
* @param currentRoute The current route to highlight the active item in the Drawer.
* @param navigationActions The object with navigation actions.
*/
@Composable
fun SearchScreen(

2
app/src/main/java/com/homebox/lens/ui/screen/search/SearchViewModel.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.search
// [FILE] SearchViewModel.kt
// [SEMANTICS] ui, viewmodel, search
// [SEMANTICS] app, ui, viewmodel, search
package com.homebox.lens.ui.screen.search
// [IMPORTS]

8
app/src/main/java/com/homebox/lens/ui/screen/settings/SettingsScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.settings
// [FILE] SettingsScreen.kt
// [SEMANTICS] ui, screen, settings
// [SEMANTICS] app, ui, screen, settings
package com.homebox.lens.ui.screen.settings
@@ -24,9 +24,9 @@ import com.homebox.lens.ui.common.MainScaffold
// [ENTITY: Function('SettingsScreen')]
// [RELATION: Function('SettingsScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
/**
* @summary Composable-функция для экрана настроек.
* @param currentRoute Текущий маршрут навигации.
* @param navigationActions Объект, содержащий действия по навигации.
* @summary Composable function for the settings screen.
* @param currentRoute The current navigation route.
* @param navigationActions The object containing navigation actions.
*/
@OptIn(ExperimentalMaterial3Api::class)
@Composable

52
app/src/main/java/com/homebox/lens/ui/screen/setup/SetupScreen.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.screen.setup
// [FILE] SetupScreen.kt
// [SEMANTICS] ui, screen, setup, compose
// [SEMANTICS] app, ui, screen, setup
@file:OptIn(ExperimentalMaterial3Api::class)
@@ -31,10 +31,10 @@ import com.homebox.lens.R
// [RELATION: Function('SetupScreen')] -> [DEPENDS_ON] -> [ViewModel('SetupViewModel')]
// [RELATION: Function('SetupScreen')] -> [CALLS] -> [Function('SetupScreenContent')]
/**
* @summary Главная Composable-функция для экрана настройки соединения с сервером.
* @param viewModel ViewModel для этого экрана, предоставляется через Hilt.
* @param onSetupComplete Лямбда, вызываемая после успешной настройки и входа.
* @sideeffect Вызывает `onSetupComplete` при изменении `uiState.isSetupComplete`.
* @summary The main Composable function for the server connection setup screen.
* @param viewModel The ViewModel for this screen, provided by Hilt.
* @param onSetupComplete A lambda invoked after successful setup and login.
* @sideeffect Calls `onSetupComplete` when `uiState.isSetupComplete` changes.
*/
@Composable
fun SetupScreen(
@@ -60,12 +60,12 @@ fun SetupScreen(
// [ENTITY: Function('SetupScreenContent')]
// [RELATION: Function('SetupScreenContent')] -> [CONSUMES_STATE] -> [DataClass('SetupUiState')]
/**
* @summary Отображает контент экрана настройки: поля ввода и кнопку.
* @param uiState Текущее состояние UI.
* @param onServerUrlChange Лямбда-обработчик изменения URL сервера.
* @param onUsernameChange Лямбда-обработчик изменения имени пользователя.
* @param onPasswordChange Лямбда-обработчик изменения пароля.
* @param onConnectClick Лямбда-обработчик нажатия на кнопку "Подключиться".
* @summary Displays the content of the setup screen: input fields and a button.
* @param uiState The current UI state.
* @param onServerUrlChange A lambda handler for changing the server URL.
* @param onUsernameChange A lambda handler for changing the username.
* @param onPasswordChange A lambda handler for changing the password.
* @param onConnectClick A lambda handler for clicking the "Connect" button.
*/
@Composable
private fun SetupScreenContent(
@@ -75,11 +75,7 @@ private fun SetupScreenContent(
onPasswordChange: (String) -> Unit,
onConnectClick: () -> Unit
) {
Scaffold(
topBar = {
TopAppBar(title = { Text(stringResource(id = R.string.setup_title)) })
}
) { paddingValues ->
Scaffold { paddingValues ->
Column(
modifier = Modifier
.fillMaxSize()
@@ -96,8 +92,12 @@ private fun SetupScreenContent(
Spacer(modifier = Modifier.height(16.dp))
Text(
text = stringResource(id = R.string.setup_title),
style = MaterialTheme.typography.headlineLarge,
fontSize = 28.sp // Adjust font size as needed
style = MaterialTheme.typography.headlineLarge
)
Spacer(modifier = Modifier.height(8.dp))
Text(
text = "Enter your Homebox server details to connect.",
style = MaterialTheme.typography.bodyMedium
)
Spacer(modifier = Modifier.height(24.dp))
@@ -106,8 +106,7 @@ private fun SetupScreenContent(
elevation = CardDefaults.cardElevation(defaultElevation = 4.dp)
) {
Column(
modifier = Modifier.padding(16.dp),
horizontalAlignment = Alignment.CenterHorizontally
modifier = Modifier.padding(16.dp)
) {
OutlinedTextField(
value = uiState.serverUrl,
@@ -115,14 +114,14 @@ private fun SetupScreenContent(
label = { Text(stringResource(id = R.string.setup_server_url_label)) },
modifier = Modifier.fillMaxWidth()
)
Spacer(modifier = Modifier.height(12.dp))
Spacer(modifier = Modifier.height(8.dp))
OutlinedTextField(
value = uiState.username,
onValueChange = onUsernameChange,
label = { Text(stringResource(id = R.string.setup_username_label)) },
modifier = Modifier.fillMaxWidth()
)
Spacer(modifier = Modifier.height(12.dp))
Spacer(modifier = Modifier.height(8.dp))
OutlinedTextField(
value = uiState.password,
onValueChange = onPasswordChange,
@@ -138,7 +137,7 @@ private fun SetupScreenContent(
enabled = !uiState.isLoading,
modifier = Modifier
.fillMaxWidth()
.height(56.dp) // Make button more prominent
.height(50.dp)
) {
if (uiState.isLoading) {
CircularProgressIndicator(
@@ -146,15 +145,14 @@ private fun SetupScreenContent(
color = MaterialTheme.colorScheme.onPrimary
)
} else {
Text(stringResource(id = R.string.setup_connect_button), fontSize = 18.sp)
Text(stringResource(id = R.string.setup_connect_button))
}
}
uiState.error?.let {
Spacer(modifier = Modifier.height(12.dp))
Spacer(modifier = Modifier.height(8.dp))
Text(
text = it,
color = MaterialTheme.colorScheme.error,
style = MaterialTheme.typography.bodyMedium
color = MaterialTheme.colorScheme.error
)
}
}

54
app/src/main/java/com/homebox/lens/ui/screen/splash/SplashScreen.kt
View File

@@ -1,9 +1,9 @@
// [PACKAGE] com.homebox.lens.ui.screen.splash
// [FILE] SplashScreen.kt
// [SEMANTICS] ui, screen, splash, navigation, authentication_flow
// [SEMANTICS] app, ui, screen, splash
package com.homebox.lens.ui.screen.splash
// [IMPORTS]
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.material3.CircularProgressIndicator
@@ -16,42 +16,44 @@ import androidx.navigation.NavController
import com.homebox.lens.navigation.Screen
import com.homebox.lens.ui.screen.setup.SetupViewModel
import timber.log.Timber
// [END_IMPORTS]
// [ENTITY: Function('SplashScreen')]
// [ENTITY: Composable('SplashScreen')]
// [RELATION: Composable('SplashScreen')] -> [DEPENDS_ON] -> [Framework('NavController')]
// [RELATION: Composable('SplashScreen')] -> [DEPENDS_ON] -> [ViewModel('SetupViewModel')]
/**
* @summary Displays a splash screen while checking if credentials are saved.
* @param navController The NavController for navigation.
* @param viewModel The SetupViewModel to check credential status.
* @sideeffect Navigates to either SetupScreen or DashboardScreen based on credential status.
* @summary A splash screen that checks for saved credentials and navigates accordingly.
* @param navController The navigation controller for navigating to the next screen.
* @param viewModel The view model for checking credentials.
* @sideeffect Navigates to either the Setup or Dashboard screen.
*/
@Composable
fun SplashScreen(
navController: NavController,
viewModel: SetupViewModel = hiltViewModel()
) {
Timber.d("[DEBUG][ENTRYPOINT][splash_screen_composable] SplashScreen entered.")
LaunchedEffect(key1 = true) {
Timber.i("[INFO][ACTION][checking_credentials_on_launch] Checking if credentials are saved on launch.")
val credentialsSaved = viewModel.areCredentialsSaved()
if (credentialsSaved) {
Timber.i("[INFO][ACTION][credentials_found_navigating_dashboard] Credentials found, navigating to Dashboard.")
navController.navigate(Screen.Dashboard.route) {
popUpTo(Screen.Splash.route) { inclusive = true }
}
} else {
Timber.i("[INFO][ACTION][no_credentials_found_navigating_setup] No credentials found, navigating to Setup.")
navController.navigate(Screen.Setup.route) {
popUpTo(Screen.Splash.route) { inclusive = true }
}
}
}
Box(
modifier = Modifier.fillMaxSize(),
contentAlignment = Alignment.Center
) {
CircularProgressIndicator()
}
LaunchedEffect(Unit) {
Timber.d("[DEBUG][ACTION][checking_credentials] Checking for saved credentials on splash screen.")
val areCredentialsSaved = viewModel.areCredentialsSaved()
val destination = if (areCredentialsSaved) {
Timber.d("[DEBUG][SUCCESS][credentials_found] Credentials found, navigating to Dashboard.")
Screen.Dashboard.route
} else {
Timber.d("[DEBUG][FALLBACK][no_credentials] No credentials found, navigating to Setup.")
Screen.Setup.route
}
navController.navigate(destination) {
popUpTo(Screen.Splash.route) { inclusive = true }
}
}
}
// [END_ENTITY: Function('SplashScreen')]
// [END_ENTITY: Composable('SplashScreen')]
// [END_FILE_SplashScreen.kt]

2
app/src/main/java/com/homebox/lens/ui/theme/Color.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.theme
// [FILE] Color.kt
// [SEMANTICS] ui, theme, color
// [SEMANTICS] app, ui, theme, color
package com.homebox.lens.ui.theme
// [IMPORTS]

2
app/src/main/java/com/homebox/lens/ui/theme/Theme.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.theme
// [FILE] Theme.kt
// [SEMANTICS] ui, theme
// [SEMANTICS] app, ui, theme
package com.homebox.lens.ui.theme
// [IMPORTS]

2
app/src/main/java/com/homebox/lens/ui/theme/Typography.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.ui.theme
// [FILE] Typography.kt
// [SEMANTICS] ui, theme, typography
// [SEMANTICS] app, ui, theme, typography
package com.homebox.lens.ui.theme
// [IMPORTS]

1
app/src/main/res/values/strings.xml
View File

@@ -13,6 +13,7 @@
<!-- Content Descriptions -->
<string name="cd_open_navigation_drawer">Открыть боковое меню</string>
<string name="setup_subtitle">Enter your Homebox server details to connect.</string>
<string name="cd_scan_qr_code">Сканировать QR-код</string>
<string name="cd_navigate_back">Вернуться назад</string>
<string name="cd_add_new_location">Добавить новую локацию</string>

2
data/src/main/java/com/homebox/lens/data/api/HomeboxApiService.kt
View File

@@ -11,7 +11,7 @@ import retrofit2.http.*
// [ENTITY: Interface('HomeboxApiService')]
/**
* @summary Определяет эндпоинты для взаимодействия с Homebox API, используя DTO.
* @summary Defines the endpoints for interacting with the Homebox API using DTOs.
*/
interface HomeboxApiService {

6
data/src/main/java/com/homebox/lens/data/api/dto/CustomFieldDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] CustomFieldDto.kt
// [SEMANTICS] data_transfer_object, custom_field
// [SEMANTICS] data, dto, custom_field
package com.homebox.lens.data.api.dto
@@ -12,7 +12,7 @@ import com.homebox.lens.domain.model.CustomField
// [ENTITY: DataClass('CustomFieldDto')]
/**
* @summary DTO для кастомного поля.
* @summary DTO for a custom field.
*/
@JsonClass(generateAdapter = true)
data class CustomFieldDto(
@@ -25,7 +25,7 @@ data class CustomFieldDto(
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('CustomField')]
/**
* @summary Маппер из CustomFieldDto в доменную модель CustomField.
* @summary Mapper from CustomFieldDto to the CustomField domain model.
*/
fun CustomFieldDto.toDomain(): CustomField {
return CustomField(

6
data/src/main/java/com/homebox/lens/data/api/dto/GroupStatisticsDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] GroupStatisticsDto.kt
// [SEMANTICS] data_transfer_object, statistics
// [SEMANTICS] data, dto, statistics
package com.homebox.lens.data.api.dto
@@ -12,7 +12,7 @@ import com.homebox.lens.domain.model.GroupStatistics
// [ENTITY: DataClass('GroupStatisticsDto')]
/**
* @summary DTO для статистики.
* @summary DTO for statistics.
*/
@JsonClass(generateAdapter = true)
data class GroupStatisticsDto(
@@ -28,7 +28,7 @@ data class GroupStatisticsDto(
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('GroupStatistics')]
/**
* @summary Маппер из GroupStatisticsDto в доменную модель GroupStatistics.
* @summary Mapper from GroupStatisticsDto to the GroupStatistics domain model.
*/
fun GroupStatisticsDto.toDomain(): GroupStatistics {
return GroupStatistics(

12
data/src/main/java/com/homebox/lens/data/api/dto/ImageDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] ImageDto.kt
// [SEMANTICS] data_transfer_object, image
// [SEMANTICS] data, dto, image
package com.homebox.lens.data.api.dto
@@ -12,10 +12,10 @@ import com.homebox.lens.domain.model.Image
// [ENTITY: DataClass('ImageDto')]
/**
* @summary DTO для изображения.
* @param id Уникальный идентификатор.
* @param path Путь к файлу.
* @param isPrimary Является ли основным.
* @summary DTO for an image.
* @param id The unique identifier.
* @param path The path to the file.
* @param isPrimary Whether it is the primary image.
*/
@JsonClass(generateAdapter = true)
data class ImageDto(
@@ -28,7 +28,7 @@ data class ImageDto(
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('Image')]
/**
* @summary Маппер из ImageDto в доменную модель Image.
* @summary Mapper from ImageDto to the Image domain model.
*/
fun ImageDto.toDomain(): Image {
return Image(

6
data/src/main/java/com/homebox/lens/data/api/dto/ItemAttachmentDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] ItemAttachmentDto.kt
// [SEMANTICS] data_transfer_object, attachment
// [SEMANTICS] data, dto, attachment
package com.homebox.lens.data.api.dto
@@ -12,7 +12,7 @@ import com.homebox.lens.domain.model.ItemAttachment
// [ENTITY: DataClass('ItemAttachmentDto')]
/**
* @summary DTO для вложения.
* @summary DTO for an attachment.
*/
@JsonClass(generateAdapter = true)
data class ItemAttachmentDto(
@@ -28,7 +28,7 @@ data class ItemAttachmentDto(
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('ItemAttachment')]
/**
* @summary Маппер из ItemAttachmentDto в доменную модель ItemAttachment.
* @summary Mapper from ItemAttachmentDto to the ItemAttachment domain model.
*/
fun ItemAttachmentDto.toDomain(): ItemAttachment {
return ItemAttachment(

6
data/src/main/java/com/homebox/lens/data/api/dto/ItemCreateDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] ItemCreateDto.kt
// [SEMANTICS] data_transfer_object, item_creation
// [SEMANTICS] data, dto, item_creation
package com.homebox.lens.data.api.dto
@@ -12,7 +12,7 @@ import com.homebox.lens.domain.model.ItemCreate
// [ENTITY: DataClass('ItemCreateDto')]
/**
* @summary DTO для создания вещи.
* @summary DTO for creating an item.
*/
@JsonClass(generateAdapter = true)
data class ItemCreateDto(
@@ -46,7 +46,7 @@ data class ItemCreateDto(
// [ENTITY: Function('toDto')]
// [RELATION: Function('toDto')] -> [RETURNS] -> [DataClass('ItemCreateDto')]
/**
* @summary Маппер из доменной модели ItemCreate в ItemCreateDto.
* @summary Mapper from the ItemCreate domain model to ItemCreateDto.
*/
fun ItemCreate.toItemCreateDto(): ItemCreateDto {
return ItemCreateDto(

74
data/src/main/java/com/homebox/lens/data/api/dto/ItemDto.kt
View File

@@ -1,74 +0,0 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] ItemDto.kt
// [SEMANTICS] data, dto, api
package com.homebox.lens.data.api.dto
// [IMPORTS]
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
import java.math.BigDecimal
// [END_IMPORTS]
// [ENTITY: DataClass('ItemOut')]
// [RELATION: DataClass('ItemOut')] -> [DEPENDS_ON] -> [DataClass('LocationOut')]
// [RELATION: DataClass('ItemOut')] -> [DEPENDS_ON] -> [DataClass('LabelOutDto')]
/**
* @summary DTO для полной информации о вещи (GET /v1/items/{id}).
*/
@JsonClass(generateAdapter = true)
data class ItemOut(
@Json(name = "id") val id: String,
@Json(name = "name") val name: String,
@Json(name = "description") val description: String?,
@Json(name = "image") val image: String?,
@Json(name = "location") val location: LocationOut?,
@Json(name = "labels") val labels: List<LabelOutDto>,
@Json(name = "value") val value: BigDecimal?,
@Json(name = "createdAt") val createdAt: String?
)
// [END_ENTITY: DataClass('ItemOut')]
// [ENTITY: DataClass('ItemSummary')]
// [RELATION: DataClass('ItemSummary')] -> [DEPENDS_ON] -> [DataClass('LocationOut')]
/**
* @summary DTO для краткой информации о вещи в списках (GET /v1/items).
*/
@JsonClass(generateAdapter = true)
data class ItemSummary(
@Json(name = "id") val id: String,
@Json(name = "name") val name: String,
@Json(name = "image") val image: String?,
@Json(name = "location") val location: LocationOut?,
@Json(name = "createdAt") val createdAt: String?
)
// [END_ENTITY: DataClass('ItemSummary')]
// [ENTITY: DataClass('ItemCreate')]
/**
* @summary DTO для создания новой вещи (POST /v1/items).
*/
@JsonClass(generateAdapter = true)
data class ItemCreate(
@Json(name = "name") val name: String,
@Json(name = "description") val description: String?,
@Json(name = "locationId") val locationId: String?,
@Json(name = "labelIds") val labelIds: List<String>?,
@Json(name = "value") val value: BigDecimal?
)
// [END_ENTITY: DataClass('ItemCreate')]
// [ENTITY: DataClass('ItemUpdate')]
/**
* @summary DTO для обновления вещи (PUT /v1/items/{id}).
*/
@JsonClass(generateAdapter = true)
data class ItemUpdate(
@Json(name = "name") val name: String,
@Json(name = "description") val description: String?,
@Json(name = "locationId") val locationId: String?,
@Json(name = "labelIds") val labelIds: List<String>?,
@Json(name = "value") val value: BigDecimal?
)
// [END_ENTITY: DataClass('ItemUpdate')]
// [END_FILE_ItemDto.kt]

45
data/src/main/java/com/homebox/lens/data/api/dto/ItemOutDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] ItemOutDto.kt
// [SEMANTICS] data_transfer_object, item_detailed
// [SEMANTICS] data, dto, item_detailed
package com.homebox.lens.data.api.dto
@@ -50,3 +50,46 @@ data class ItemOutDto(
@Json(name = "updatedAt") val updatedAt: String
)
// [END_ENTITY: DataClass('ItemOutDto')]
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('ItemOut')]
/**
* @summary Mapper from ItemOutDto to the ItemOut domain model.
*/
fun ItemOutDto.toDomain(): ItemOut {
return ItemOut(
id = this.id,
name = this.name,
assetId = this.assetId,
description = this.description,
notes = this.notes,
serialNumber = this.serialNumber,
quantity = this.quantity,
isArchived = this.isArchived,
purchasePrice = this.purchasePrice,
purchaseTime = this.purchaseTime,
purchaseFrom = this.purchaseFrom,
warrantyExpires = this.warrantyExpires,
warrantyDetails = this.warrantyDetails,
lifetimeWarranty = this.lifetimeWarranty,
insured = this.insured,
manufacturer = this.manufacturer,
modelNumber = this.modelNumber,
soldPrice = this.soldPrice,
soldTime = this.soldTime,
soldTo = this.soldTo,
soldNotes = this.soldNotes,
syncChildItemsLocations = this.syncChildItemsLocations,
location = this.location?.toDomain(),
parent = this.parent?.toDomain(),
children = this.children.map { it.toDomain() },
labels = this.labels.map { it.toDomain() },
attachments = this.attachments.map { it.toDomain() },
images = this.images.map { it.toDomain() },
fields = this.fields.map { it.toDomain() },
maintenance = this.maintenance.map { it.toDomain() },
createdAt = this.createdAt,
updatedAt = this.updatedAt
)
}
// [END_ENTITY: Function('toDomain')]

23
data/src/main/java/com/homebox/lens/data/api/dto/ItemSummaryDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] ItemSummaryDto.kt
// [SEMANTICS] data_transfer_object, item_summary
// [SEMANTICS] data, dto, item_summary
package com.homebox.lens.data.api.dto
@@ -28,3 +28,24 @@ data class ItemSummaryDto(
@Json(name = "updatedAt") val updatedAt: String
)
// [END_ENTITY: DataClass('ItemSummaryDto')]
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('ItemSummary')]
/**
* @summary Mapper from ItemSummaryDto to the ItemSummary domain model.
*/
fun ItemSummaryDto.toDomain(): ItemSummary {
return ItemSummary(
id = this.id,
name = this.name,
assetId = this.assetId,
image = this.image?.toDomain(),
isArchived = this.isArchived,
labels = this.labels.map { it.toDomain() },
location = this.location?.toDomain(),
value = this.value,
createdAt = this.createdAt,
updatedAt = this.updatedAt
)
}
// [END_ENTITY: Function('toDomain')]

2
data/src/main/java/com/homebox/lens/data/api/dto/ItemUpdateDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] ItemUpdateDto.kt
// [SEMANTICS] data_transfer_object, item_update
// [SEMANTICS] data, dto, item_update
package com.homebox.lens.data.api.dto

2
data/src/main/java/com/homebox/lens/data/api/dto/LabelCreateDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] LabelCreateDto.kt
// [SEMANTICS] data_transfer_object, label, create, api
// [SEMANTICS] data, dto, label, create
package com.homebox.lens.data.api.dto
// [IMPORTS]

19
data/src/main/java/com/homebox/lens/data/api/dto/LabelOutDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] LabelOutDto.kt
// [SEMANTICS] data_transfer_object, label
// [SEMANTICS] data, dto, label
package com.homebox.lens.data.api.dto
@@ -26,4 +26,21 @@ data class LabelOutDto(
)
// [END_ENTITY: DataClass('LabelOutDto')]
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('LabelOut')]
/**
* @summary Mapper from LabelOutDto to the LabelOut domain model.
*/
fun LabelOutDto.toDomain(): LabelOut {
return LabelOut(
id = this.id,
name = this.name,
description = this.description,
color = this.color ?: "#000000",
isArchived = this.isArchived ?: false,
createdAt = this.createdAt,
updatedAt = this.updatedAt
)
}
// [END_ENTITY: Function('toDomain')]
// [END_FILE_LabelOutDto.kt]

2
data/src/main/java/com/homebox/lens/data/api/dto/LabelSummaryDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] LabelSummaryDto.kt
// [SEMANTICS] data_transfer_object, label, summary, api, mapper
// [SEMANTICS] data, dto, label, summary
package com.homebox.lens.data.api.dto
// [IMPORTS]

6
data/src/main/java/com/homebox/lens/data/api/dto/LabelUpdateDto.kt
View File

@@ -1,15 +1,17 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] LabelUpdateDto.kt
// [SEMANTICS] data_transfer_object, label, update
// [SEMANTICS] data, dto, label, update
package com.homebox.lens.data.api.dto
// [IMPORTS]
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
import com.homebox.lens.domain.model.LabelUpdate
// [END_IMPORTS]
// [ENTITY: DataClass('LabelUpdateDto')]
/**
* @summary DTO for updating a label.
*/
@JsonClass(generateAdapter = true)
data class LabelUpdateDto(
@Json(name = "name")

5
data/src/main/java/com/homebox/lens/data/api/dto/LocationCreateDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] LocationCreateDto.kt
// [SEMANTICS] data_transfer_object, location, create
// [SEMANTICS] data, dto, location, create
package com.homebox.lens.data.api.dto
// [IMPORTS]
@@ -9,6 +9,9 @@ import com.squareup.moshi.JsonClass
// [END_IMPORTS]
// [ENTITY: DataClass('LocationCreateDto')]
/**
* @summary DTO for creating a location.
*/
@JsonClass(generateAdapter = true)
data class LocationCreateDto(
@Json(name = "name")

34
data/src/main/java/com/homebox/lens/data/api/dto/LocationDto.kt
View File

@@ -1,34 +0,0 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] LocationDto.kt
// [SEMANTICS] data, dto, api, location
package com.homebox.lens.data.api.dto
// [IMPORTS]
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
// [END_IMPORTS]
// [ENTITY: DataClass('LocationOut')]
/**
* @summary DTO для информации о местоположении.
*/
@JsonClass(generateAdapter = true)
data class LocationOut(
@Json(name = "id") val id: String,
@Json(name = "name") val name: String
)
// [END_ENTITY: DataClass('LocationOut')]
// [ENTITY: DataClass('LocationOutCount')]
/**
* @summary DTO для информации о местоположении со счетчиком вещей.
*/
@JsonClass(generateAdapter = true)
data class LocationOutCount(
@Json(name = "id") val id: String,
@Json(name = "name") val name: String,
@Json(name = "itemCount") val itemCount: Int
)
// [END_ENTITY: DataClass('LocationOutCount')]
// [END_FILE_LocationDto.kt]

21
data/src/main/java/com/homebox/lens/data/api/dto/LocationOutCountDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] LocationOutCountDto.kt
// [SEMANTICS] data_transfer_object, location, count
// [SEMANTICS] data, dto, location, count
package com.homebox.lens.data.api.dto
@@ -12,7 +12,7 @@ import com.homebox.lens.domain.model.LocationOutCount
// [ENTITY: DataClass('LocationOutCountDto')]
/**
* @summary DTO для местоположения со счетчиком.
* @summary DTO for a location with an item count.
*/
@JsonClass(generateAdapter = true)
data class LocationOutCountDto(
@@ -27,4 +27,21 @@ data class LocationOutCountDto(
)
// [END_ENTITY: DataClass('LocationOutCountDto')]
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('LocationOutCount')]
/**
* @summary Mapper from LocationOutCountDto to the LocationOutCount domain model.
*/
fun LocationOutCountDto.toDomain(): LocationOutCount {
return LocationOutCount(
id = this.id,
name = this.name,
color = this.color ?: "#000000",
isArchived = this.isArchived ?: false,
itemCount = this.itemCount,
createdAt = this.createdAt,
updatedAt = this.updatedAt
)
}
// [END_ENTITY: Function('toDomain')]
// [END_FILE_LocationOutCountDto.kt]

18
data/src/main/java/com/homebox/lens/data/api/dto/LocationOutDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] LocationOutDto.kt
// [SEMANTICS] data_transfer_object, location, output
// [SEMANTICS] data, dto, location
package com.homebox.lens.data.api.dto
// [IMPORTS]
@@ -27,4 +27,20 @@ data class LocationOutDto(
)
// [END_ENTITY: DataClass('LocationOutDto')]
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('LocationOut')]
/**
* @summary Mapper from LocationOutDto to the LocationOut domain model.
*/
fun LocationOutDto.toDomain(): LocationOut {
return LocationOut(
id = this.id,
name = this.name,
color = this.color,
isArchived = this.isArchived,
createdAt = this.createdAt,
updatedAt = this.updatedAt
)
}
// [END_ENTITY: Function('toDomain')]
// [END_FILE_LocationOutDto.kt]

6
data/src/main/java/com/homebox/lens/data/api/dto/LocationUpdateDto.kt
View File

@@ -1,15 +1,17 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] LocationUpdateDto.kt
// [SEMANTICS] data_transfer_object, location, update
// [SEMANTICS] data, dto, location, update
package com.homebox.lens.data.api.dto
// [IMPORTS]
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
import com.homebox.lens.domain.model.LocationUpdate
// [END_IMPORTS]
// [ENTITY: DataClass('LocationUpdateDto')]
/**
* @summary DTO for updating a location.
*/
@JsonClass(generateAdapter = true)
data class LocationUpdateDto(
@Json(name = "name")

5
data/src/main/java/com/homebox/lens/data/api/dto/LoginFormDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] LoginFormDto.kt
// [SEMANTICS] data, dto, api, login
// [SEMANTICS] data, dto, login
package com.homebox.lens.data.api.dto
// [IMPORTS]
@@ -9,6 +9,9 @@ import com.squareup.moshi.JsonClass
// [END_IMPORTS]
// [ENTITY: DataClass('LoginFormDto')]
/**
* @summary DTO for the login form.
*/
@JsonClass(generateAdapter = true)
data class LoginFormDto(
@Json(name = "username") val username: String,

6
data/src/main/java/com/homebox/lens/data/api/dto/MaintenanceEntryDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] MaintenanceEntryDto.kt
// [SEMANTICS] data_transfer_object, maintenance
// [SEMANTICS] data, dto, maintenance
package com.homebox.lens.data.api.dto
@@ -12,7 +12,7 @@ import com.homebox.lens.domain.model.MaintenanceEntry
// [ENTITY: DataClass('MaintenanceEntryDto')]
/**
* @summary DTO для записи об обслуживании.
* @summary DTO for a maintenance entry.
*/
@JsonClass(generateAdapter = true)
data class MaintenanceEntryDto(
@@ -30,7 +30,7 @@ data class MaintenanceEntryDto(
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('MaintenanceEntry')]
/**
* @summary Маппер из MaintenanceEntryDto в доменную модель MaintenanceEntry.
* @summary Mapper from MaintenanceEntryDto to the MaintenanceEntry domain model.
*/
fun MaintenanceEntryDto.toDomain(): MaintenanceEntry {
return MaintenanceEntry(

25
data/src/main/java/com/homebox/lens/data/api/dto/PaginationDto.kt
View File

@@ -1,25 +0,0 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] PaginationDto.kt
// [SEMANTICS] data, dto, api, pagination
package com.homebox.lens.data.api.dto
// [IMPORTS]
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
// [END_IMPORTS]
// [ENTITY: DataClass('PaginationResult')]
/**
* @summary DTO для пагинированных результатов от API.
*/
@JsonClass(generateAdapter = true)
data class PaginationResult<T>(
@Json(name = "items") val items: List<T>,
@Json(name = "page") val page: Int,
@Json(name = "pages") val pages: Int,
@Json(name = "total") val total: Int,
@Json(name = "pageSize") val pageSize: Int
)
// [END_ENTITY: DataClass('PaginationResult')]
// [END_FILE_PaginationDto.kt]

17
data/src/main/java/com/homebox/lens/data/api/dto/PaginationResultDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] PaginationResultDto.kt
// [SEMANTICS] data_transfer_object, pagination
// [SEMANTICS] data, dto, pagination
package com.homebox.lens.data.api.dto
@@ -22,3 +22,18 @@ data class PaginationResultDto<T>(
@Json(name = "total") val total: Int
)
// [END_ENTITY: DataClass('PaginationResultDto')]
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('PaginationResult')]
/**
* @summary Mapper from PaginationResultDto to the PaginationResult domain model.
*/
fun <T, R> PaginationResultDto<T>.toDomain(mapper: (T) -> R): PaginationResult<R> {
return PaginationResult(
items = this.items.map(mapper),
page = this.page,
pageSize = this.pageSize,
total = this.total
)
}
// [END_ENTITY: Function('toDomain')]

25
data/src/main/java/com/homebox/lens/data/api/dto/StatisticsDto.kt
View File

@@ -1,25 +0,0 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] StatisticsDto.kt
// [SEMANTICS] data, dto, api, statistics
package com.homebox.lens.data.api.dto
// [IMPORTS]
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
import java.math.BigDecimal
// [END_IMPORTS]
// [ENTITY: DataClass('GroupStatistics')]
/**
* @summary DTO для статистической информации.
*/
@JsonClass(generateAdapter = true)
data class GroupStatistics(
@Json(name = "totalValue") val totalValue: BigDecimal,
@Json(name = "totalItems") val totalItems: Int,
@Json(name = "locations") val locations: Int,
@Json(name = "labels") val labels: Int
)
// [END_ENTITY: DataClass('GroupStatistics')]
// [END_FILE_StatisticsDto.kt]

18
data/src/main/java/com/homebox/lens/data/api/dto/TokenResponseDto.kt
View File

@@ -1,14 +1,18 @@
// [PACKAGE] com.homebox.lens.data.api.dto
// [FILE] TokenResponseDto.kt
// [SEMANTICS] data, dto, api, token
// [SEMANTICS] data, dto, token
package com.homebox.lens.data.api.dto
// [IMPORTS]
import com.homebox.lens.domain.model.TokenResponse
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
// [END_IMPORTS]
// [ENTITY: DataClass('TokenResponseDto')]
/**
* @summary DTO for the token response.
*/
@JsonClass(generateAdapter = true)
data class TokenResponseDto(
@Json(name = "token") val token: String,
@@ -16,4 +20,16 @@ data class TokenResponseDto(
@Json(name = "expiresAt") val expiresAt: String
)
// [END_ENTITY: DataClass('TokenResponseDto')]
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('TokenResponse')]
/**
* @summary Mapper from TokenResponseDto to the TokenResponse domain model.
*/
fun TokenResponseDto.toDomain(): TokenResponse {
return TokenResponse(
token = this.token
)
}
// [END_ENTITY: Function('toDomain')]
// [END_FILE_TokenResponseDto.kt]

30
data/src/main/java/com/homebox/lens/data/api/mapper/TokenMapper.kt
View File

@@ -1,30 +0,0 @@
// [PACKAGE] com.homebox.lens.data.api.mapper
// [FILE] TokenMapper.kt
// [SEMANTICS] mapper, data_conversion, clean_architecture
package com.homebox.lens.data.api.mapper
// [IMPORTS]
import com.homebox.lens.data.api.dto.TokenResponseDto
import com.homebox.lens.domain.model.TokenResponse
// [END_IMPORTS]
// [ENTITY: Function('toDomain')]
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('TokenResponse')]
/**
* @summary Преобразует DTO-объект токена в доменную модель.
* @receiver [TokenResponseDto] объект из слоя данных.
* @return [TokenResponse] объект для доменного слоя.
* @throws IllegalArgumentException если токен в DTO пустой.
*/
fun TokenResponseDto.toDomain(): TokenResponse {
require(this.token.isNotBlank()) { "DTO token is blank, cannot map to domain model." }
val domainModel = TokenResponse(token = this.token)
check(domainModel.token.isNotBlank()) { "Domain model token is blank after mapping." }
return domainModel
}
// [END_ENTITY: Function('toDomain')]
// [END_FILE_TokenMapper.kt]

24
data/src/main/java/com/homebox/lens/data/api/model/LoginRequest.kt
View File

@@ -1,19 +1,23 @@
// [PACKAGE] com.homebox.lens.data.api.model
// [FILE] LoginRequest.kt
// [SEMANTICS] dto, network, serialization, authentication
// [SEMANTICS] data, dto, login
package com.homebox.lens.data.api.model
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
// [IMPORTS]
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
// [END_IMPORTS]
// [ENTITY: DataClass('LoginRequest')]
/**
* [ENTITY: DataClass('LoginRequest')]
* [CONTRACT]
* DTO (Data Transfer Object) для запроса на аутентификацию.
* @property username Имя пользователя.
* @property password Пароль пользователя.
* @invariant Свойства не должны быть пустыми.
* @summary DTO for the authentication request.
* @property username The user's name.
* @property password The user's password.
* @invariant The properties must not be blank.
*/
@JsonClass(generateAdapter = true)
data class LoginRequest(
@@ -21,9 +25,9 @@ data class LoginRequest(
@Json(name = "password") val password: String
) {
init {
// [INVARIANT_CHECK]
require(username.isNotBlank()) { "[INVARIANT_FAILED] Username cannot be blank." }
require(password.isNotBlank()) { "[INVARIANT_FAILED] Password cannot be blank." }
require(username.isNotBlank()) { "Username cannot be blank." }
require(password.isNotBlank()) { "Password cannot be blank." }
}
}
// [END_ENTITY: DataClass('LoginRequest')]
// [END_FILE_LoginRequest.kt]

2
data/src/main/java/com/homebox/lens/data/db/Converters.kt
View File

@@ -10,7 +10,7 @@ import java.math.BigDecimal
// [ENTITY: Class('Converters')]
/**
* @summary Предоставляет TypeConverters для Room для типов, не поддерживаемых по умолчанию.
* @summary Provides TypeConverters for Room for types not supported by default.
*/
class Converters {
// [ENTITY: Function('fromString')]

2
data/src/main/java/com/homebox/lens/data/db/HomeboxDatabase.kt
View File

@@ -15,7 +15,7 @@ import com.homebox.lens.data.db.entity.*
// [ENTITY: Database('HomeboxDatabase')]
/**
* @summary Основной класс для работы с локальной базой данных Room.
* @summary The main class for working with the local Room database.
*/
@Database(
entities = [

2
data/src/main/java/com/homebox/lens/data/db/dao/ItemDao.kt
View File

@@ -13,7 +13,7 @@ import kotlinx.coroutines.flow.Flow
// [ENTITY: Interface('ItemDao')]
/**
* @summary Предоставляет методы для работы с 'items' в локальной БД.
* @summary Provides methods for working with 'items' in the local DB.
*/
@Dao
interface ItemDao {

2
data/src/main/java/com/homebox/lens/data/db/dao/LabelDao.kt
View File

@@ -13,7 +13,7 @@ import com.homebox.lens.data.db.entity.LabelEntity
// [ENTITY: Interface('LabelDao')]
/**
* @summary Предоставляет методы для работы с 'labels' в локальной БД.
* @summary Provides methods for working with 'labels' in the local DB.
*/
@Dao
interface LabelDao {

2
data/src/main/java/com/homebox/lens/data/db/dao/LocationDao.kt
View File

@@ -13,7 +13,7 @@ import com.homebox.lens.data.db.entity.LocationEntity
// [ENTITY: Interface('LocationDao')]
/**
* @summary Предоставляет методы для работы с 'locations' в локальной БД.
* @summary Provides methods for working with 'locations' in the local DB.
*/
@Dao
interface LocationDao {

2
data/src/main/java/com/homebox/lens/data/db/entity/ItemEntity.kt
View File

@@ -10,7 +10,7 @@ import androidx.room.PrimaryKey
// [ENTITY: DatabaseTable('ItemEntity')]
/**
* @summary Представляет собой строку в таблице 'items' в локальной БД.
* @summary Represents a row in the 'items' table in the local DB.
*/
@Entity(tableName = "items")
data class ItemEntity(

2
data/src/main/java/com/homebox/lens/data/db/entity/ItemLabelCrossRef.kt
View File

@@ -10,7 +10,7 @@ import androidx.room.Index
// [ENTITY: DatabaseTable('ItemLabelCrossRef')]
/**
* @summary Таблица для связи "многие-ко-многим" между ItemEntity и LabelEntity.
* @summary Table for the many-to-many relationship between ItemEntity and LabelEntity.
*/
@Entity(
primaryKeys = ["itemId", "labelId"],

2
data/src/main/java/com/homebox/lens/data/db/entity/ItemWithLabels.kt
View File

@@ -13,7 +13,7 @@ import androidx.room.Relation
// [RELATION: DataClass('ItemWithLabels')] -> [DEPENDS_ON] -> [DatabaseTable('ItemEntity')]
// [RELATION: DataClass('ItemWithLabels')] -> [DEPENDS_ON] -> [DatabaseTable('LabelEntity')]
/**
* @summary POJO для получения ItemEntity вместе со связанными LabelEntity.
* @summary POJO for retrieving an ItemEntity with its associated LabelEntity objects.
*/
data class ItemWithLabels(
@Embedded val item: ItemEntity,

2
data/src/main/java/com/homebox/lens/data/db/entity/LabelEntity.kt
View File

@@ -10,7 +10,7 @@ import androidx.room.PrimaryKey
// [ENTITY: DatabaseTable('LabelEntity')]
/**
* @summary Представляет собой строку в таблице 'labels' в локальной БД.
* @summary Represents a row in the 'labels' table in the local DB.
*/
@Entity(tableName = "labels")
data class LabelEntity(

2
data/src/main/java/com/homebox/lens/data/db/entity/LocationEntity.kt
View File

@@ -10,7 +10,7 @@ import androidx.room.PrimaryKey
// [ENTITY: DatabaseTable('LocationEntity')]
/**
* @summary Представляет собой строку в таблице 'locations' в локальной БД.
* @summary Represents a row in the 'locations' table in the local DB.
*/
@Entity(tableName = "locations")
data class LocationEntity(

6
data/src/main/java/com/homebox/lens/data/db/entity/Mapper.kt
View File

@@ -11,7 +11,7 @@ import com.homebox.lens.domain.model.*
// [ENTITY: Function('ItemWithLabels.toDomainItemSummary')]
// [RELATION: Function('ItemWithLabels.toDomainItemSummary')] -> [RETURNS] -> [DataClass('ItemSummary')]
/**
* @summary Преобразует [ItemWithLabels] (сущность БД) в [ItemSummary] (доменную модель).
* @summary Converts [ItemWithLabels] (DB entity) to [ItemSummary] (domain model).
*/
fun ItemWithLabels.toDomainItemSummary(): ItemSummary {
return ItemSummary(
@@ -32,7 +32,7 @@ fun ItemWithLabels.toDomainItemSummary(): ItemSummary {
// [ENTITY: Function('ItemEntity.toDomainItem')]
// [RELATION: Function('ItemEntity.toDomainItem')] -> [RETURNS] -> [DataClass('Item')]
/**
* @summary Преобразует [ItemEntity] (сущность БД) в [Item] (доменную модель).
* @summary Converts [ItemEntity] (DB entity) to [Item] (domain model).
*/
fun ItemEntity.toDomainItem(): Item {
return Item(
@@ -71,7 +71,7 @@ fun ItemEntity.toDomainItem(): Item {
// [ENTITY: Function('Item.toItemEntity')]
// [RELATION: Function('Item.toItemEntity')] -> [RETURNS] -> [DataClass('ItemEntity')]
/**
* @summary Преобразует [Item] (доменную модель) в [ItemEntity] (сущность БД).
* @summary Converts [Item] (domain model) to [ItemEntity] (DB entity).
*/
fun Item.toItemEntity(): ItemEntity {
return ItemEntity(

6
data/src/main/java/com/homebox/lens/data/di/ApiModule.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.di
// [FILE] ApiModule.kt
// [SEMANTICS] di, networking
// [SEMANTICS] data, di, networking
package com.homebox.lens.data.di
// [IMPORTS]
@@ -25,8 +25,8 @@ import javax.inject.Singleton
// [ENTITY: Module('ApiModule')]
/**
* @summary Hilt-модуль, отвечающий за создание и предоставление всех зависимостей,
* необходимых для сетевого взаимодействия.
* @summary Hilt module responsible for creating and providing all dependencies
* necessary for network interaction.
*/
@Module
@InstallIn(SingletonComponent::class)

4
data/src/main/java/com/homebox/lens/data/di/DatabaseModule.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.di
// [FILE] DatabaseModule.kt
// [SEMANTICS] di, hilt, database
// [SEMANTICS] data, di, database
package com.homebox.lens.data.di
// [IMPORTS]
@@ -18,7 +18,7 @@ import javax.inject.Singleton
// [ENTITY: Module('DatabaseModule')]
/**
* @summary Предоставляет зависимости для работы с базой данных Room.
* @summary Provides dependencies for working with the Room database.
*/
@Module
@InstallIn(SingletonComponent::class)

12
data/src/main/java/com/homebox/lens/data/di/RepositoryModule.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.di
// [FILE] RepositoryModule.kt
// [SEMANTICS] dependency_injection, hilt, module, binding
// [SEMANTICS] data, di, repository
package com.homebox.lens.data.di
@@ -20,8 +20,8 @@ import javax.inject.Singleton
// [ENTITY: Module('RepositoryModule')]
/**
* @summary Hilt-модуль для предоставления реализаций репозиториев.
* @description Использует `@Binds` для эффективного связывания интерфейсов с их реализациями.
* @summary Hilt module for providing repository implementations.
* @description Uses `@Binds` for efficient binding of interfaces to their implementations.
*/
@Module
@InstallIn(SingletonComponent::class)
@@ -30,7 +30,7 @@ abstract class RepositoryModule {
// [ENTITY: Function('bindItemRepository')]
// [RELATION: Function('bindItemRepository')] -> [PROVIDES] -> [Interface('ItemRepository')]
/**
* @summary Связывает интерфейс ItemRepository с его реализацией.
* @summary Binds the ItemRepository interface to its implementation.
*/
@Binds
@Singleton
@@ -42,7 +42,7 @@ abstract class RepositoryModule {
// [ENTITY: Function('bindCredentialsRepository')]
// [RELATION: Function('bindCredentialsRepository')] -> [PROVIDES] -> [Interface('CredentialsRepository')]
/**
* @summary Связывает интерфейс CredentialsRepository с его реализацией.
* @summary Binds the CredentialsRepository interface to its implementation.
*/
@Binds
@Singleton
@@ -54,7 +54,7 @@ abstract class RepositoryModule {
// [ENTITY: Function('bindAuthRepository')]
// [RELATION: Function('bindAuthRepository')] -> [PROVIDES] -> [Interface('AuthRepository')]
/**
* @summary Связывает интерфейс AuthRepository с его реализацией.
* @summary Binds the AuthRepository interface to its implementation.
*/
@Binds
@Singleton

2
data/src/main/java/com/homebox/lens/data/di/StorageModule.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.di
// [FILE] StorageModule.kt
// [SEMANTICS] di, hilt, storage
// [SEMANTICS] data, di, storage
package com.homebox.lens.data.di
// [IMPORTS]

2
data/src/main/java/com/homebox/lens/data/mapper/DomainToDto.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.mapper
// [FILE] DomainToDto.kt
// [SEMANTICS] data, mapper, domain, dto
// [SEMANTICS] data, mapper
package com.homebox.lens.data.mapper
// [IMPORTS]

9
data/src/main/java/com/homebox/lens/data/mapper/DtoToDomain.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.mapper
// [FILE] DtoToDomain.kt
// [SEMANTICS] data, mapper, dto, domain
// [SEMANTICS] data, mapper
package com.homebox.lens.data.mapper
// [IMPORTS]
@@ -133,6 +133,13 @@ fun LabelOutDto.toDomainLabel(): DomainLabel {
name = this.name
)
}
fun com.homebox.lens.domain.model.LabelOut.toDomain(): DomainLabel {
return DomainLabel(
id = this.id,
name = this.name
)
}
// [END_ENTITY: Function('LabelOutDto.toDomain')]
// [ENTITY: Function('LocationOutDto.toDomain')]

18
data/src/main/java/com/homebox/lens/data/repository/AuthRepositoryImpl.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.repository
// [FILE] AuthRepositoryImpl.kt
// [SEMANTICS] data_implementation, authentication, repository
// [SEMANTICS] data, repository, authentication
package com.homebox.lens.data.repository
@@ -30,10 +30,10 @@ import javax.inject.Inject
// [RELATION: Class('AuthRepositoryImpl')] -> [DEPENDS_ON] -> [Framework('OkHttpClient')]
// [RELATION: Class('AuthRepositoryImpl')] -> [DEPENDS_ON] -> [Framework('MoshiConverterFactory')]
/**
* @summary Реализация репозитория для управления аутентификацией.
* @param encryptedPrefs Защищенное хранилище для токена.
* @param okHttpClient Общий OkHttp клиент для переиспользования.
* @param moshiConverterFactory Общий конвертер Moshi для переиспользования.
* @summary Implementation of the repository for managing authentication.
* @param encryptedPrefs The secure storage for the token.
* @param okHttpClient The shared OkHttp client for reuse.
* @param moshiConverterFactory The shared Moshi converter for reuse.
*/
class AuthRepositoryImpl @Inject constructor(
private val encryptedPrefs: SharedPreferences,
@@ -47,10 +47,10 @@ class AuthRepositoryImpl @Inject constructor(
// [ENTITY: Function('login')]
/**
* @summary Реализует вход пользователя. Создает временный API сервис для выполнения запроса
* на указанный пользователем URL сервера.
* @param credentials Учетные данные пользователя, включая URL сервера.
* @return [Result] с доменной моделью [TokenResponse] при успехе или [Exception] при ошибке.
* @summary Implements user login. Creates a temporary API service to execute a request
* to the server URL specified by the user.
* @param credentials The user's credentials, including the server URL.
* @return A [Result] with a [TokenResponse] domain model on success or an [Exception] on failure.
*/
override suspend fun login(credentials: Credentials): Result<TokenResponse> {
require(credentials.serverUrl.isNotBlank()) { "Server URL cannot be blank." }

32
data/src/main/java/com/homebox/lens/data/repository/CredentialsRepositoryImpl.kt
View File

@@ -20,10 +20,10 @@ import javax.inject.Inject
// [RELATION: Class('CredentialsRepositoryImpl')] -> [IMPLEMENTS] -> [Interface('CredentialsRepository')]
// [RELATION: Class('CredentialsRepositoryImpl')] -> [DEPENDS_ON] -> [Framework('SharedPreferences')]
/**
* @summary Реализует репозиторий для управления учетными данными пользователя.
* @description Взаимодействует с зашифрованными SharedPreferences для сохранения и извлечения данных.
* @param encryptedPrefs Зашифрованное хранилище ключ-значение, предоставляемое Hilt.
* @invariant Состояние этого репозитория полностью зависит от содержимого `encryptedPrefs`.
* @summary Implements the repository for managing user credentials.
* @description Interacts with encrypted SharedPreferences to save and retrieve data.
* @param encryptedPrefs The encrypted key-value store provided by Hilt.
* @invariant The state of this repository is entirely dependent on the contents of `encryptedPrefs`.
*/
class CredentialsRepositoryImpl @Inject constructor(
private val encryptedPrefs: SharedPreferences
@@ -38,9 +38,9 @@ class CredentialsRepositoryImpl @Inject constructor(
// [ENTITY: Function('saveCredentials')]
/**
* @summary Сохраняет основные учетные данные пользователя.
* @param credentials Объект с учетными данными для сохранения.
* @sideeffect Перезаписывает существующие учетные данные в SharedPreferences.
* @summary Saves the user's primary credentials.
* @param credentials The credentials object to save.
* @sideeffect Overwrites existing credentials in SharedPreferences.
*/
override suspend fun saveCredentials(credentials: Credentials) {
withContext(Dispatchers.IO) {
@@ -56,8 +56,8 @@ class CredentialsRepositoryImpl @Inject constructor(
// [ENTITY: Function('getCredentials')]
/**
* @summary Извлекает сохраненные учетные данные пользователя в виде потока.
* @return Flow, который эммитит объект [Credentials] или null, если данные отсутствуют.
* @summary Retrieves the saved user credentials as a Flow.
* @return A Flow that emits a [Credentials] object or null if no data is present.
*/
override fun getCredentials(): Flow<Credentials?> = flow {
Timber.d("[DEBUG][ACTION][getting_credentials] Getting user credentials.")
@@ -77,9 +77,9 @@ class CredentialsRepositoryImpl @Inject constructor(
// [ENTITY: Function('saveToken')]
/**
* @summary Сохраняет токен авторизации.
* @param token Токен для сохранения.
* @sideeffect Перезаписывает существующий токен в SharedPreferences.
* @summary Saves the authorization token.
* @param token The token to save.
* @sideeffect Overwrites the existing token in SharedPreferences.
*/
override suspend fun saveToken(token: String) {
withContext(Dispatchers.IO) {
@@ -93,8 +93,8 @@ class CredentialsRepositoryImpl @Inject constructor(
// [ENTITY: Function('getToken')]
/**
* @summary Извлекает сохраненный токен авторизации.
* @return Строка с токеном или null, если он не найден.
* @summary Retrieves the saved authorization token.
* @return A string with the token or null if it is not found.
*/
override suspend fun getToken(): String? {
return withContext(Dispatchers.IO) {
@@ -111,8 +111,8 @@ class CredentialsRepositoryImpl @Inject constructor(
// [ENTITY: Function('clearAllCredentials')]
/**
* @summary Очищает все сохраненные учетные данные и токены.
* @sideeffect Удаляет все записи, связанные с учетными данными, из SharedPreferences.
* @summary Clears all saved credentials and tokens.
* @sideeffect Removes all records related to credentials from SharedPreferences.
*/
override suspend fun clearAllCredentials() {
withContext(Dispatchers.IO) {

2
data/src/main/java/com/homebox/lens/data/repository/ItemRepositoryImpl.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.repository
// [FILE] ItemRepositoryImpl.kt
// [SEMANTICS] data_repository, implementation, items, labels
// [SEMANTICS] data, repository, item
package com.homebox.lens.data.repository
// [IMPORTS]

2
data/src/main/java/com/homebox/lens/data/security/CryptoManager.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.data.security
// [FILE] CryptoManager.kt
// [SEMANTICS] data, security, cryptography
// [SEMANTICS] data, security, crypto
package com.homebox.lens.data.security
// [IMPORTS]

2
domain/src/main/java/com/homebox/lens/domain/model/CustomField.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] CustomField.kt
// [SEMANTICS] data_structure, entity, custom_field
// [SEMANTICS] domain, model, custom_field
package com.homebox.lens.domain.model
// [ENTITY: DataClass('CustomField')]

2
domain/src/main/java/com/homebox/lens/domain/model/GroupStatistics.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] GroupStatistics.kt
// [SEMANTICS] data_structure, statistics
// [SEMANTICS] domain, model, statistics
package com.homebox.lens.domain.model
// [ENTITY: DataClass('GroupStatistics')]

2
domain/src/main/java/com/homebox/lens/domain/model/Image.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] Image.kt
// [SEMANTICS] data_structure, entity, image
// [SEMANTICS] domain, model, image
package com.homebox.lens.domain.model
// [ENTITY: DataClass('Image')]

63
domain/src/main/java/com/homebox/lens/domain/model/Item.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] Item.kt
// [SEMANTICS] domain, model
// [SEMANTICS] domain, model, item, data_model
package com.homebox.lens.domain.model
// [IMPORTS]
@@ -12,35 +12,40 @@ import com.homebox.lens.domain.model.Image
// [ENTITY: DataClass('Item')]
// [RELATION: DataClass('Item')] -> [DEPENDS_ON] -> [DataClass('Location')]
// [RELATION: DataClass('Item')] -> [DEPENDS_ON] -> [DataClass('Label')]
// [RELATION: DataClass('Item')] -> [DEPENDS_ON] -> [DataClass('CustomField')]
/**
* @summary Представляет собой вещь в инвентаре.
* @param id Уникальный идентификатор вещи.
* @param name Название вещи.
* @param description Описание вещи.
* @param image Url изображения.
* @param location Местоположение вещи.
* @param labels Список меток, присвоенных вещи.
* @param purchasePrice Цена покупки вещи.
* @param createdAt Дата создания.
* @param archived Архивирована ли вещь.
* @param assetId Идентификатор актива.
* @param fields Пользовательские поля.
* @param insured Застрахована ли вещь.
* @param lifetimeWarranty Пожизненная гарантия.
* @param manufacturer Производитель.
* @param modelNumber Номер модели.
* @param notes Дополнительные заметки.
* @param parentId ID родительского элемента.
* @param purchaseFrom Место покупки.
* @param purchaseTime Время покупки.
* @param serialNumber Серийный номер.
* @param soldNotes Заметки о продаже.
* @param soldPrice Цена продажи.
* @param soldTime Время продажи.
* @param soldTo Кому продано.
* @param syncChildItemsLocations Синхронизировать местоположения дочерних элементов.
* @param warrantyDetails Детали гарантии.
* @param warrantyExpires Дата окончания гарантии.
* @summary A comprehensive data model representing an inventory item.
* @param id The unique identifier for the item.
* @param name The name of the item.
* @param description A detailed description of the item.
* @param quantity The number of units of this item.
* @param image An optional URL to an image of the item.
* @param location The physical or logical location of the item.
* @param labels A list of tags or categories associated with the item.
* @param purchasePrice The price at which the item was purchased.
* @param createdAt The timestamp when the item was created.
* @param archived A flag indicating if the item is archived.
* @param assetId An external asset identifier.
* @param fields A list of custom-defined fields for the item.
* @param insured A flag indicating if the item is insured.
* @param lifetimeWarranty A flag indicating if the item has a lifetime warranty.
* @param manufacturer The manufacturer of the item.
* @param modelNumber The model number of the item.
* @param notes Any additional notes about the item.
* @param parentId The ID of a parent item, if this is a child item.
* @param purchaseFrom The place where the item was purchased.
* @param purchaseTime The timestamp of the purchase.
* @param serialNumber The serial number of the item.
* @param soldNotes Notes related to the sale of the item.
* @param soldPrice The price at which the item was sold.
* @param soldTime The timestamp of the sale.
* @param soldTo The person or entity the item was sold to.
* @param syncChildItemsLocations A flag to sync locations of child items.
* @param warrantyDetails Details about the item's warranty.
* @param warrantyExpires The expiration date of the warranty.
* @invariant The 'id' must not be blank.
* @invariant The 'name' must not be blank.
* @invariant The 'quantity' must be non-negative.
*/
data class Item(
val id: String,

2
domain/src/main/java/com/homebox/lens/domain/model/ItemAttachment.kt
View File

@@ -1,6 +1,6 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] ItemAttachment.kt
// [SEMANTICS] data_structure, entity, attachment
// [SEMANTICS] domain, model, attachment
package com.homebox.lens.domain.model
// [ENTITY: DataClass('ItemAttachment')]

44
domain/src/main/java/com/homebox/lens/domain/model/ItemCreate.kt
View File

@@ -1,24 +1,38 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] ItemCreate.kt
// [SEMANTICS] data_structure, entity, input, create
// [SEMANTICS] domain, model, item_creation
package com.homebox.lens.domain.model
// [ENTITY: DataClass('ItemCreate')]
// [RELATION: DataClass('ItemCreate')] -> [DEPENDS_ON] -> [DataClass('Location')]
// [RELATION: DataClass('ItemCreate')] -> [DEPENDS_ON] -> [DataClass('Label')]
/**
* @summary Модель данных для создания новой "Вещи".
* @param name Название вещи (обязательно).
* @param assetId Идентификатор актива.
* @param description Описание.
* @param notes Заметки.
* @param serialNumber Серийный номер.
* @param quantity Количество.
* @param value Стоимость.
* @param purchasePrice Цена покупки.
* @param purchaseDate Дата покупки.
* @param warrantyUntil Гарантия до.
* @param locationId ID местоположения.
* @param parentId ID родительской вещи.
* @param labelIds Список ID меток.
* @summary Data model for creating a new item.
* @param name The name of the item (required).
* @param description An optional description of the item.
* @param quantity The number of units of this item.
* @param archived A flag indicating if the item is archived.
* @param assetId An external asset identifier.
* @param insured A flag indicating if the item is insured.
* @param lifetimeWarranty A flag indicating if the item has a lifetime warranty.
* @param manufacturer The manufacturer of the item.
* @param modelNumber The model number of the item.
* @param notes Any additional notes about the item.
* @param parentId The ID of a parent item, if this is a child item.
* @param purchaseFrom The place where the item was purchased.
* @param purchasePrice The price at which the item was purchased.
* @param purchaseTime The timestamp of the purchase.
* @param serialNumber The serial number of the item.
* @param soldNotes Notes related to the sale of the item.
* @param soldPrice The price at which the item was sold.
* @param soldTime The timestamp of the sale.
* @param soldTo The person or entity the item was sold to.
* @param syncChildItemsLocations A flag to sync locations of child items.
* @param warrantyDetails Details about the item's warranty.
* @param warrantyExpires The expiration date of the warranty.
* @param locationId The ID of the item's location.
* @param labelIds A list of IDs for labels to associate with the item.
* @invariant The 'name' must not be blank.
*/
data class ItemCreate(
val name: String,

77
domain/src/main/java/com/homebox/lens/domain/model/ItemOut.kt
View File

@@ -1,43 +1,52 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] ItemOut.kt
// [SEMANTICS] data_structure, entity, detailed
// [SEMANTICS] domain, model, item_detailed
package com.homebox.lens.domain.model
// [ENTITY: DataClass('ItemOut')]
// [RELATION: DataClass('ItemOut')] -> [DEPENDS_ON] -> [DataClass('LocationOut')]
// [RELATION: DataClass('ItemOut')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
// [RELATION: DataClass('ItemOut')] -> [DEPENDS_ON] -> [DataClass('LabelOut')]
// [RELATION: DataClass('ItemOut')] -> [DEPENDS_ON] -> [DataClass('ItemAttachment')]
// [RELATION: DataClass('ItemOut')] -> [DEPENDS_ON] -> [DataClass('Image')]
// [RELATION: DataClass('ItemOut')] -> [DEPENDS_ON] -> [DataClass('CustomField')]
// [RELATION: DataClass('ItemOut')] -> [DEPENDS_ON] -> [DataClass('MaintenanceEntry')]
/**
* @summary Полная модель данных для представления "Вещи" со всеми полями.
* @param id Уникальный идентификатор.
* @param name Название.
* @param assetId Идентификатор актива.
* @param description Описание.
* @param notes Заметки.
* @param serialNumber Серийный номер.
* @param quantity Количество.
* @param isArchived Флаг архивации.
* @param purchasePrice Цена покупки.
* @param purchaseTime Время покупки.
* @param purchaseFrom Место покупки.
* @param warrantyExpires Дата окончания гарантии.
* @param warrantyDetails Детали гарантии.
* @param lifetimeWarranty Пожизненная гарантия.
* @param insured Застрахована ли вещь.
* @param manufacturer Производитель.
* @param modelNumber Номер модели.
* @param soldPrice Цена продажи.
* @param soldTime Время продажи.
* @param soldTo Кому продано.
* @param soldNotes Заметки о продаже.
* @param syncChildItemsLocations Синхронизировать местоположения дочерних элементов.
* @param location Местоположение.
* @param parent Родительская вещь (если есть).
* @param children Дочерние вещи.
* @param labels Список меток.
* @param attachments Список вложений.
* @param images Список изображений.
* @param fields Список кастомных полей.
* @param maintenance Список записей об обслуживании.
* @param createdAt Дата и время создания.
* @param updatedAt Дата и время последнего обновления.
* @summary A comprehensive data model representing a fully-detailed inventory item.
* @param id The unique identifier for the item.
* @param name The name of the item.
* @param assetId An external asset identifier.
* @param description A detailed description of the item.
* @param notes Any additional notes about the item.
* @param serialNumber The serial number of the item.
* @param quantity The number of units of this item.
* @param isArchived A flag indicating if the item is archived.
* @param purchasePrice The price at which the item was purchased.
* @param purchaseTime The timestamp of the purchase.
* @param purchaseFrom The place where the item was purchased.
* @param warrantyExpires The expiration date of the warranty.
* @param warrantyDetails Details about the item's warranty.
* @param lifetimeWarranty A flag indicating if the item has a lifetime warranty.
* @param insured A flag indicating if the item is insured.
* @param manufacturer The manufacturer of the item.
* @param modelNumber The model number of the item.
* @param soldPrice The price at which the item was sold.
* @param soldTime The timestamp of the sale.
* @param soldTo The person or entity the item was sold to.
* @param soldNotes Notes related to the sale of the item.
* @param syncChildItemsLocations A flag to sync locations of child items.
* @param location The physical or logical location of the item.
* @param parent A summary of the parent item, if one exists.
* @param children A list of summaries for child items.
* @param labels A list of tags or categories associated with the item.
* @param attachments A list of file attachments for the item.
* @param images A list of images for the item.
* @param fields A list of custom-defined fields for the item.
* @param maintenance A list of maintenance records for the item.
* @param createdAt The timestamp when the item was created.
* @param updatedAt The timestamp when the item was last updated.
* @invariant The 'id' must not be blank.
* @invariant The 'name' must not be blank.
*/
data class ItemOut(
val id: String,

29
domain/src/main/java/com/homebox/lens/domain/model/ItemSummary.kt
View File

@@ -1,21 +1,26 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] ItemSummary.kt
// [SEMANTICS] data_structure, entity, summary
// [SEMANTICS] domain, model, item_summary
package com.homebox.lens.domain.model
// [ENTITY: DataClass('ItemSummary')]
// [RELATION: DataClass('ItemSummary')] -> [DEPENDS_ON] -> [DataClass('Image')]
// [RELATION: DataClass('ItemSummary')] -> [DEPENDS_ON] -> [DataClass('LabelOut')]
// [RELATION: DataClass('ItemSummary')] -> [DEPENDS_ON] -> [DataClass('LocationOut')]
/**
* @summary Сокращенная модель данных для представления "Вещи" в списках.
* @param id Уникальный идентификатор вещи.
* @param name Название вещи.
* @param assetId Идентификатор актива.
* @param image Основное изображение. Может быть null.
* @param isArchived Флаг архивации.
* @param labels Список меток.
* @param location Местоположение. Может быть null.
* @param value Стоимость.
* @param createdAt Дата и время создания.
* @param updatedAt Дата и время последнего обновления.
* @summary A summarized data model for representing an item in a list.
* @param id The unique identifier for the item.
* @param name The name of the item.
* @param assetId An external asset identifier.
* @param image The primary image for the item, if available.
* @param isArchived A flag indicating if the item is archived.
* @param labels A list of tags or categories associated with the item.
* @param location The physical or logical location of the item.
* @param value The monetary value of the item.
* @param createdAt The timestamp when the item was created.
* @param updatedAt The timestamp when the item was last updated.
* @invariant The 'id' must not be blank.
* @invariant The 'name' must not be blank.
*/
data class ItemSummary(
val id: String,

46
domain/src/main/java/com/homebox/lens/domain/model/ItemUpdate.kt
View File

@@ -1,25 +1,39 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] ItemUpdate.kt
// [SEMANTICS] data_structure, entity, input, update
// [SEMANTICS] domain, model, item_update
package com.homebox.lens.domain.model
// [ENTITY: DataClass('ItemUpdate')]
// [RELATION: DataClass('ItemUpdate')] -> [DEPENDS_ON] -> [DataClass('Location')]
// [RELATION: DataClass('ItemUpdate')] -> [DEPENDS_ON] -> [DataClass('Label')]
/**
* @summary Модель данных для обновления существующей "Вещи".
* @param name Название вещи.
* @param assetId Идентификатор актива.
* @param description Описание.
* @param notes Заметки.
* @param serialNumber Серийный номер.
* @param quantity Количество.
* @param isArchived Флаг архивации.
* @param value Стоимость.
* @param purchasePrice Цена покупки.
* @param purchaseDate Дата покупки.
* @param warrantyUntil Гарантия до.
* @param locationId ID местоположения.
* @param parentId ID родительской вещи.
* @param labelIds Список ID меток для полной замены.
* @summary Data model for updating an existing item.
* @param id The unique identifier of the item to update.
* @param name The new name of the item.
* @param description An optional new description for the item.
* @param quantity The new number of units of this item.
* @param archived A flag indicating if the item is archived.
* @param assetId An external asset identifier.
* @param insured A flag indicating if the item is insured.
* @param lifetimeWarranty A flag indicating if the item has a lifetime warranty.
* @param manufacturer The manufacturer of the item.
* @param modelNumber The model number of the item.
* @param notes Any additional notes about the item.
* @param parentId The ID of a parent item, if this is a child item.
* @param purchaseFrom The place where the item was purchased.
* @param purchasePrice The price at which the item was purchased.
* @param purchaseTime The timestamp of the purchase.
* @param serialNumber The serial number of the item.
* @param soldNotes Notes related to the sale of the item.
* @param soldPrice The price at which the item was sold.
* @param soldTime The timestamp of the sale.
* @param soldTo The person or entity the item was sold to.
* @param syncChildItemsLocations A flag to sync locations of child items.
* @param warrantyDetails Details about the item's warranty.
* @param warrantyExpires The expiration date of the warranty.
* @param locationId The ID of the item's new location.
* @param labelIds A list of IDs for labels to associate with the item, replacing existing ones.
* @invariant The 'id' must not be blank.
*/
data class ItemUpdate(
val id: String,

10
domain/src/main/java/com/homebox/lens/domain/model/Label.kt
View File

@@ -1,13 +1,15 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] Label.kt
// [SEMANTICS] domain, model
// [SEMANTICS] domain, model, label
package com.homebox.lens.domain.model
// [ENTITY: DataClass('Label')]
/**
* @summary Представляет собой метку (тег), которую можно присвоить вещи.
* @param id Уникальный идентификатор метки.
* @param name Название метки.
* @summary Represents a label or tag that can be assigned to an item.
* @param id The unique identifier of the label.
* @param name The name of the label.
* @invariant The 'id' must not be blank.
* @invariant The 'name' must not be blank.
*/
data class Label(
val id: String,

11
domain/src/main/java/com/homebox/lens/domain/model/LabelCreate.kt
View File

@@ -1,14 +1,15 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] LabelCreate.kt
// [SEMANTICS] data_structure, contract, label, create
// [SEMANTICS] domain, model, label, create
package com.homebox.lens.domain.model
// [ENTITY: DataClass('LabelCreate')]
/**
* @summary Модель с данными, необходимыми для создания новой метки.
* @param name Название новой метки. Обязательное поле.
* @param color Цвет метки в формате HEX. Необязательное поле.
* @invariant name не может быть пустым.
* @summary Data model for creating a new label.
* @param name The name of the new label (required).
* @param color The color of the label in HEX format (optional).
* @param description An optional description for the label.
* @invariant 'name' cannot be blank.
*/
data class LabelCreate(
val name: String,

19
domain/src/main/java/com/homebox/lens/domain/model/LabelOut.kt
View File

@@ -1,17 +1,20 @@
// [PACKAGE] com.homebox.lens.domain.model
// [FILE] LabelOut.kt
// [SEMANTICS] data_structure, entity, label
// [SEMANTICS] domain, model, label
package com.homebox.lens.domain.model
// [ENTITY: DataClass('LabelOut')]
/**
* @summary Модель данных для представления метки (тега).
* @param id Уникальный идентификатор.
* @param name Название метки.
* @param color Цвет метки в формате HEX (например, "#FF0000").
* @param isArchived Флаг, указывающий, заархивирована ли метка.
* @param createdAt Дата и время создания.
* @param updatedAt Дата и время последнего обновления.
* @summary Data model for representing a label (tag).
* @param id The unique identifier.
* @param name The name of the label.
* @param description An optional description for the label.
* @param color The color of the label in HEX format (e.g., "#FF0000").
* @param isArchived A flag indicating if the label is archived.
* @param createdAt The timestamp when the label was created.
* @param updatedAt The timestamp when the label was last updated.
* @invariant The 'id' must not be blank.
* @invariant The 'name' must not be blank.
*/
data class LabelOut(
val id: String,

Some files were not shown because too many files have changed in this diff Show More