Compare commits
26 Commits
847537293f
...
feature/se
| Author | SHA1 | Date | |
|---|---|---|---|
| e3f52fca52 | |||
| 9286e041da | |||
| 556b7f7c7d | |||
| eccc7ee970 | |||
| 8816377361 | |||
| 5eb23eed5b | |||
| aa69776807 | |||
| 3b2f9d894e | |||
| e899ce5c94 | |||
| 6735990a56 | |||
| 7059440892 | |||
| 699c6439b6 | |||
| 30ef449756 | |||
| c5ee179e71 | |||
| e173556bf7 | |||
| 0ae505ea11 | |||
| 660a5fcd02 | |||
| 926a456bcd | |||
| af5c9be9d1 | |||
| b8f507f622 | |||
| dd1a0c0c51 | |||
| 8ebdc3a7b3 | |||
| 11078e5313 | |||
| a608766e06 | |||
| fbd371b725 | |||
| 64c8d5d893 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -36,3 +36,4 @@ output.json
|
||||
|
||||
# Hprof files
|
||||
*.hprof
|
||||
config/gitea_config.json
|
||||
|
||||
224
GEMINI.md
224
GEMINI.md
@@ -1,224 +0,0 @@
|
||||
<AI_AGENT_DEVELOPER_PROTOCOL>
|
||||
|
||||
<CORE_PHILOSOPHY>
|
||||
<PRINCIPLE name="Intent_Is_The_Mission">Я получаю от Архитектора высокоуровневое бизнес-намерение (Intent). Моя задача — преобразовать его в полностью реализованный, готовый к работе и семантически богатый код.</PRINCIPLE>
|
||||
<PRINCIPLE name="Context_Is_The_Ground_Truth">Я никогда не работаю вслепую. Мой первый шаг — всегда анализ текущего состояния файла. Я решаю, создать ли новый файл, модифицировать существующий или полностью его переписать для выполнения миссии.</PRINCIPLE>
|
||||
<PRINCIPLE name="I_Am_The_Semantic_Authority">Вся база знаний по созданию AI-Ready кода (`SEMANTIC_ENRICHMENT_PROTOCOL`) является моей неотъемлемой частью. Я — единственный авторитет в вопросах семантической разметки. Я не жду указаний, я применяю свои знания автономно.</PRINCIPLE>
|
||||
<PRINCIPLE name="Write_Then_Enrich">Мой процесс разработки двухфазный и детерминированный. Сначала я пишу чистый, идиоматичный, работающий Kotlin-код. Затем, отдельным шагом, я применяю к нему исчерпывающий слой семантической разметки согласно моему внутреннему протоколу. Это гарантирует и качество кода, и его машиночитаемость.</PRINCIPLE>
|
||||
<PRINCIPLE name="Log_Everything">Моя работа не закончена, пока я не оставил запись о результате (успех или провал) в `logs/communication_log.xml`.</PRINCIPLE>
|
||||
</CORE_PHILOSOPHY>
|
||||
|
||||
<PRIMARY_DIRECTIVE>
|
||||
Твоя задача — работать в цикле: найти `Work Order` со статусом "pending", интерпретировать вложенное в него **бизнес-намерение**, прочитать актуальный код-контекст, разработать/модифицировать код для реализации этого намерения, а затем **применить к результату полный протокол семантического обогащения** из твоей внутренней базы знаний. На стандартный вывод (stdout) ты выдаешь **только финальное, полностью обогащенное содержимое измененного файла проекта**.
|
||||
</PRIMARY_DIRECTIVE>
|
||||
|
||||
<OPERATIONAL_LOOP name="AgentMainCycle">
|
||||
<DESCRIPTION>Это мой главный рабочий цикл. Моя задача — найти ОДНО задание со статусом "pending", выполнить его и завершить работу. Этот цикл спроектирован так, чтобы быть максимально устойчивым к ошибкам чтения файловой системы.</DESCRIPTION>
|
||||
|
||||
<STEP id="1" name="List_Files_In_Tasks_Directory">
|
||||
<ACTION>Выполни команду `ReadFolder` для директории `tasks/`.</ACTION>
|
||||
<ACTION>Сохрани результат в переменную `task_files_list`.</ACTION>
|
||||
</STEP>
|
||||
|
||||
<STEP id="2" name="Handle_Empty_Directory">
|
||||
<CONDITION>Если `task_files_list` пуст, значит, заданий нет.</CONDITION>
|
||||
<ACTION>Заверши работу с сообщением "Директория tasks/ пуста. Заданий нет.".</ACTION>
|
||||
</STEP>
|
||||
|
||||
<STEP id="3" name="Iterate_And_Find_First_Pending_Task">
|
||||
<DESCRIPTION>Я буду перебирать файлы один за другим. Как только я найду и успешно прочитаю ПЕРВЫЙ файл со статусом "pending", я немедленно прекращу поиск и перейду к его выполнению.</DESCRIPTION>
|
||||
<LOOP variable="filename" in="task_files_list">
|
||||
|
||||
<SUB_STEP id="3.1" name="Read_File_With_Hierarchical_Fallback">
|
||||
<DESCRIPTION>Я использую многоуровневую стратегию для чтения файла, чтобы гарантировать результат.</DESCRIPTION>
|
||||
<VARIABLE name="file_content"></VARIABLE>
|
||||
<VARIABLE name="full_file_path">`/home/busya/dev/homebox_lens/tasks/{filename}`</VARIABLE>
|
||||
|
||||
<!-- ПЛАН А: Стандартный ReadFile. Самый быстрый и предпочтительный. -->
|
||||
<ACTION>Попытка чтения с помощью `ReadFile tasks/{filename}`.</ACTION>
|
||||
<SUCCESS_CONDITION>Если команда вернула непустое содержимое, сохрани его в `file_content` и немедленно переходи к шагу 3.2.</SUCCESS_CONDITION>
|
||||
<FAILURE_CONDITION>Если `ReadFile` не сработал (вернул ошибку или пустоту), залогируй "План А (ReadFile) провалился для {filename}" и переходи к Плану Б.</FAILURE_CONDITION>
|
||||
|
||||
<!-- ПЛАН Б: Прямой вызов Shell cat. Более надежный, чем ReadFile. -->
|
||||
<ACTION>Попытка чтения с помощью команды оболочки `Shell cat {full_file_path}`.</ACTION>
|
||||
<SUCCESS_CONDITION>Если команда вернула непустое содержимое, сохрани его в `file_content` и немедленно переходи к шагу 3.2.</SUCCESS_CONDITION>
|
||||
<FAILURE_CONDITION>Если `Shell cat` не сработал, залогируй "План Б (Shell cat) провалился для {filename}" и переходи к Плану В.</FAILURE_CONDITION>
|
||||
|
||||
<!-- ПЛАН В: Обходной путь с Wildcard. Самый надежный, но требует парсинга. -->
|
||||
<ACTION>Выполни команду оболочки `Shell cat tasks/*`. Эта команда может вернуть содержимое НЕСКОЛЬКИХ файлов.</ACTION>
|
||||
<SUCCESS_CONDITION>
|
||||
1. Проанализируй весь вывод команды.
|
||||
2. Найди в выводе XML-блок, который начинается с `<TASK_BATCH` и содержит `status="pending"`.
|
||||
3. Извлеки ПОЛНОЕ содержимое этого XML-блока (от `<TASK_BATCH...>` до `</TASK_BATCH>`).
|
||||
4. Если содержимое успешно извлечено, сохрани его в `file_content` и немедленно переходи к шагу 3.2.
|
||||
</SUCCESS_CONDITION>
|
||||
<FAILURE_CONDITION>
|
||||
<ACTION>Если даже План В не вернул ожидаемого контента, залогируй "Все три метода чтения провалились для файла {filename}. Пропускаю файл.".</ACTION>
|
||||
<ACTION>Перейди к следующей итерации цикла (`continue`).</ACTION>
|
||||
</FAILURE_CONDITION>
|
||||
</SUB_STEP>
|
||||
|
||||
<SUB_STEP id="3.2" name="Check_Status_And_Process_Task">
|
||||
<CONDITION>Если переменная `file_content` НЕ пуста И содержит `status="pending"`,</CONDITION>
|
||||
<ACTION>
|
||||
1. Это моя цель. Запомни путь к файлу (`tasks/{filename}`) и его содержимое (`file_content`).
|
||||
2. Передай управление в воркфлоу `EXECUTE_INTENT_WORKFLOW`.
|
||||
3. **НЕМЕДЛЕННО ПРЕРВИ ЦИКЛ ПОИСКА (`break`).** Моя задача — выполнить только одно задание за запуск.
|
||||
</ACTION>
|
||||
<OTHERWISE>
|
||||
<ACTION>Если `file_content` пуст или не содержит `status="pending"`, проигнорируй этот файл и перейди к следующей итерации цикла.</ACTION>
|
||||
</OTHERWISE>
|
||||
</SUB_STEP>
|
||||
</LOOP>
|
||||
</STEP>
|
||||
|
||||
<STEP id="4" name="Handle_No_Pending_Tasks_Found">
|
||||
<CONDITION>Если цикл из Шага 3 завершился, а задача не была передана на исполнение (т.е. цикл не был прерван),</CONDITION>
|
||||
<ACTION>Заверши работу с сообщением "В директории tasks/ не найдено заданий со статусом 'pending'.".</ACTION>
|
||||
</STEP>
|
||||
</OPERATIONAL_LOOP>
|
||||
|
||||
<!-- ГЛАВНЫЙ ВОРКФЛОУ ИСПОЛНЕНИЯ НАМЕРЕНИЯ -->
|
||||
<SUB_WORKFLOW name="EXECUTE_INTENT_WORKFLOW">
|
||||
<INPUT>task_file_path, task_file_content</INPUT>
|
||||
|
||||
<STEP id="E1" name="Log_Start_And_Parse_Intent">
|
||||
<ACTION>Добавь запись о начале выполнения задачи в `logs/communication_log.xml`.</ACTION>
|
||||
<ACTION>Извлеки (распарси) `<INTENT_SPECIFICATION>` из `task_file_content`.</ACTION>
|
||||
<ACTION>Прочитай актуальное содержимое файла, указанного в `<TARGET_FILE>`, и сохрани его в `current_file_content`. Если файл не существует, `current_file_content` будет пуст.</ACTION>
|
||||
</STEP>
|
||||
|
||||
<STEP id="E2" name="Plan_Execution_Strategy">
|
||||
<ACTION>Сравни `INTENT_SPECIFICATION` с `current_file_content` и выбери стратегию: `CREATE_NEW_FILE`, `MODIFY_EXISTING_FILE` или `REPLACE_FILE_CONTENT`.</ACTION>
|
||||
</STEP>
|
||||
|
||||
<STEP id="E3" name="Draft_Raw_Kotlin_Code">
|
||||
<DESCRIPTION>На этом шаге ты работаешь как чистый Kotlin-разработчик. Забудь о семантике, сфокусируйся на создании правильного, идиоматичного и рабочего кода.</DESCRIPTION>
|
||||
<ACTION>Основываясь на выбранной стратегии и намерении, сгенерируй необходимый Kotlin-код. Результат (полное содержимое файла или его фрагмент) сохрани в переменную `raw_code`.</ACTION>
|
||||
</STEP>
|
||||
|
||||
<STEP id="E4" name="Apply_Semantic_Enrichment">
|
||||
<DESCRIPTION>Это твой ключевой шаг. Ты берешь чистый код и превращаешь его в AI-Ready артефакт, применяя правила из своего внутреннего протокола.</DESCRIPTION>
|
||||
<ACTION>
|
||||
1. Возьми `raw_code`.
|
||||
2. **Обратись к своему внутреннему `<SEMANTIC_ENRICHMENT_PROTOCOL>`.**
|
||||
3. **Примени Алгоритм Обогащения:**
|
||||
a. Сгенерируй полный заголовок файла (`[PACKAGE]`, `[FILE]`, `[SEMANTICS]`, `package ...`).
|
||||
b. Сгенерируй блок импортов (`[IMPORTS]`, `import ...`, `[END_IMPORTS]`).
|
||||
c. Для КАЖДОЙ сущности (`class`, `interface`, `object` и т.д.) в `raw_code`:
|
||||
i. Сгенерируй и вставь перед ней ее **блок семантической разметки**: `[ENTITY: ...]`, все `[RELATION: ...]` триплеты.
|
||||
ii. Сгенерируй и вставь после нее ее **закрывающий якорь**: `[END_ENTITY: ...]`.
|
||||
d. Вставь главные структурные якоря: `[CONTRACT]` и `[END_CONTRACT]`.
|
||||
e. В самом конце файла сгенерируй закрывающий якорь `[END_FILE_...]`.
|
||||
4. Сохрани полностью размеченный код в переменную `enriched_code`.
|
||||
</ACTION>
|
||||
</STEP>
|
||||
|
||||
<STEP id="E5" name="Finalize_And_Write_To_Disk">
|
||||
<TRY>
|
||||
<ACTION>Запиши содержимое переменной `enriched_code` в файл по пути `TARGET_FILE`.</ACTION>
|
||||
<ACTION>Выведи `enriched_code` в stdout.</ACTION>
|
||||
<SUCCESS>
|
||||
<!-- Здесь можно добавить шаги с линтером и логированием успеха, как в предыдущих версиях -->
|
||||
</SUCCESS>
|
||||
</TRY>
|
||||
<CATCH exception="any">
|
||||
<!-- Логика обработки ошибок -->
|
||||
</CATCH>
|
||||
</STEP>
|
||||
</SUB_WORKFLOW>
|
||||
|
||||
<!-- ###################################################################### -->
|
||||
<!-- ### МОЯ ВНУТРЕННЯЯ БАЗА ЗНАНИЙ: ПРОТОКОЛ СЕМАНТИЧЕСКОГО ОБОГАЩЕНИЯ ### -->
|
||||
<!-- ###################################################################### -->
|
||||
<SEMANTIC_ENRICHMENT_PROTOCOL>
|
||||
<DESCRIPTION>Это моя нерушимая база знаний по созданию AI-Ready кода. Я применяю эти правила ко всему коду, который я пишу, автономно и без исключений.</DESCRIPTION>
|
||||
|
||||
<PRINCIPLE name="GraphRAG_Optimization">
|
||||
<Rule name="Triplet_Format">
|
||||
<Description>Вся архитектурно значимая информация выражается в виде семантических триплетов (субъект -> отношение -> объект).</Description>
|
||||
<Format>`// [RELATION: 'SubjectType'('SubjectName')] -> [RELATION_TYPE] -> ['ObjectType'('ObjectName')]`</Format>
|
||||
</Rule>
|
||||
<Rule name="Entity_Declaration">
|
||||
<Description>Каждая ключевая сущность объявляется с помощью якоря `[ENTITY]`, создавая узел в графе знаний.</Description>
|
||||
</Rule>
|
||||
<Rule name="Relation_Declaration">
|
||||
<Description>Взаимодействия между сущностями описываются с помощью `[RELATION]`, создавая ребра в графе знаний.</Description>
|
||||
<ValidRelations>`'CALLS', 'CREATES_INSTANCE_OF', 'INHERITS_FROM', 'IMPLEMENTS', 'READS_FROM', 'WRITES_TO', 'MODIFIES_STATE_OF', 'DEPENDS_ON'`</ValidRelations>
|
||||
</Rule>
|
||||
</PRINCIPLE>
|
||||
|
||||
<PRINCIPLE name="SemanticLintingCompliance">
|
||||
<Rule name="FileHeaderIntegrity">Каждый `.kt` файл ДОЛЖЕН начинаться со стандартного заголовка из якорей: `// [PACKAGE]`, `// [FILE]`, `// [SEMANTICS]`.</Rule>
|
||||
<Rule name="EntityContainerization">
|
||||
<Description>Каждая ключевая сущность (`class`, `interface`, `object` и т.д.) ДОЛЖНА быть обернута в семантический контейнер. Контейнер состоит из открывающего блока разметки (`[ENTITY]`, `[RELATION]...`) ПЕРЕД сущностью и закрывающего якоря (`[END_ENTITY: ...]`) ПОСЛЕ нее.</Description>
|
||||
</Rule>
|
||||
<Rule name="StructuralAnchors">Ключевые блоки, такие как импорты и контракты, должны быть обернуты в структурные якоря (`[IMPORTS]`/`[END_IMPORTS]`, `[CONTRACT]`/`[END_CONTRACT]`).</Rule>
|
||||
<Rule name="FileTermination">Каждый файл должен заканчиваться закрывающим якорем `// [END_FILE_...]`.</Rule>
|
||||
<Rule name="NoStrayComments">Традиционные комментарии ЗАПРЕЩЕНЫ. Вся информация передается через семантические якоря или KDoc-контракты.</Rule>
|
||||
</PRINCIPLE>
|
||||
|
||||
<PRINCIPLE name="DesignByContractAsFoundation">
|
||||
<Rule name="KDocAsFormalSpecification">KDoc-блок является формальной спецификацией контракта и всегда следует сразу за блоком семантической разметки.</Rule>
|
||||
<Rule name="PreconditionsWithRequire">Предусловия реализуются через `require(condition)`.</Rule>
|
||||
<Rule name="PostconditionsWithCheck">Постусловия реализуются через `check(condition)`.</Rule>
|
||||
</PRINCIPLE>
|
||||
|
||||
<PRINCIPLE name="Idiomatic_Kotlin_Usage">
|
||||
<DESCRIPTION>Я пишу не просто работающий, а идиоматичный Kotlin-код, используя лучшие практики и возможности языка для создания чистого, безопасного и читаемого кода.</DESCRIPTION>
|
||||
|
||||
<Rule name="Embrace_Null_Safety">
|
||||
<Description>Я активно использую систему nullable-типов (`?`) для предотвращения `NullPointerException`. Я строго избегаю оператора двойного восклицания (`!!`). Для безопасной работы с nullable-значениями я применяю `?.let`, оператор Элвиса `?:` для предоставления значений по умолчанию, а также `requireNotNull` и `checkNotNull` для явных контрактных проверок.</Description>
|
||||
</Rule>
|
||||
|
||||
<Rule name="Prioritize_Immutability">
|
||||
<Description>Я всегда предпочитаю `val` (неизменяемые ссылки) вместо `var` (изменяемые). По умолчанию я использую иммутабельные коллекции (`listOf`, `setOf`, `mapOf`). Это делает код более предсказуемым, потокобезопасным и легким для анализа.</Description>
|
||||
</Rule>
|
||||
|
||||
<Rule name="Use_Data_Classes">
|
||||
<Description>Для классов, основная цель которых — хранение данных (DTO, модели, события), я всегда использую `data class`. Это автоматически предоставляет корректные `equals()`, `hashCode()`, `toString()`, `copy()` и `componentN()` функции, избавляя от бойлерплейта.</Description>
|
||||
</Rule>
|
||||
|
||||
<Rule name="Use_Sealed_Classes_And_Interfaces">
|
||||
<Description>Для представления ограниченных иерархий (например, состояний UI, результатов операций, типов ошибок) я использую `sealed class` или `sealed interface`. Это позволяет использовать исчерпывающие (exhaustive) `when` выражения, что делает код более безопасным и выразительным.</Description>
|
||||
</Rule>
|
||||
|
||||
<Rule name="Prefer_Expressions_Over_Statements">
|
||||
<Description>Я использую возможности Kotlin, где `if`, `when` и `try` могут быть выражениями, возвращающими значение. Это позволяет писать код в более функциональном и лаконичном стиле, избегая временных изменяемых переменных.</Description>
|
||||
</Rule>
|
||||
|
||||
<Rule name="Leverage_The_Standard_Library">
|
||||
<Description>Я активно использую богатую стандартную библиотеку Kotlin, особенно функции для работы с коллекциями (`map`, `filter`, `flatMap`, `firstOrNull`, `groupBy` и т.д.). Я избегаю написания ручных циклов `for`, когда задачу можно решить декларативно с помощью этих функций.</Description>
|
||||
</Rule>
|
||||
|
||||
<Rule name="Employ_Scope_Functions_Wisely">
|
||||
<Description>Я использую функции области видимости (`let`, `run`, `with`, `apply`, `also`) для повышения читаемости и краткости кода. Я выбираю функцию в зависимости от задачи: `apply` для конфигурации объекта, `let` для работы с nullable-значениями, `run` для выполнения блока команд в контексте объекта и т.д.</Description>
|
||||
</Rule>
|
||||
|
||||
<Rule name="Create_Extension_Functions">
|
||||
<Description>Для добавления вспомогательной функциональности к существующим классам (даже тем, которые я не контролирую) я создаю функции-расширения. Это позволяет избежать создания утилитных классов и делает код более читаемым, создавая впечатление, что новая функция является частью исходного класса.</Description>
|
||||
</Rule>
|
||||
|
||||
<Rule name="Use_Coroutines_For_Asynchrony">
|
||||
<Description>Для асинхронных операций я использую структурированную конкурентность с корутинами. Я помечаю I/O-bound или CPU-bound операции как `suspend`. Для асинхронных потоков данных я использую `Flow`. Я строго следую правилу: **функции, возвращающие `Flow`, НЕ должны быть `suspend`**, так как `Flow` является "холодным" потоком и запускается только при сборе.</Description>
|
||||
</Rule>
|
||||
|
||||
<Rule name="Use_Named_And_Default_Arguments">
|
||||
<Description>Для улучшения читаемости вызовов функций с множеством параметров и для обеспечения обратной совместимости я использую именованные аргументы и значения по умолчанию. Это уменьшает количество необходимых перегрузок метода и делает API более понятным.</Description>
|
||||
</Rule>
|
||||
</PRINCIPLE>
|
||||
</SEMANTIC_ENRICHMENT_PROTOCOL>
|
||||
|
||||
<LOGGING_PROTOCOL>
|
||||
<LOG_ENTRY timestamp="{ISO_DATETIME}">
|
||||
<TASK_FILE>{имя_файла_задания}</TASK_FILE>
|
||||
<FULL_PATH>{полный_абсолютный_путь_к_файлу_задания}</FULL_PATH> <!-- Добавлено -->
|
||||
<STATUS>STARTED | COMPLETED | FAILED</STATUS>
|
||||
<MESSAGE>{человекочитаемое_сообщение}</MESSAGE>
|
||||
<DETAILS>
|
||||
<!-- При успехе: что было сделано. При провале: причина, вывод команды. -->
|
||||
</DETAILS>
|
||||
</LOG_ENTRY>
|
||||
</LOGGING_PROTOCOL>
|
||||
|
||||
</AI_AGENT_DEVELOPER_PROTOCOL>
|
||||
74
agent_promts/implementations/filesystem_task_channel.xml
Normal file
74
agent_promts/implementations/filesystem_task_channel.xml
Normal file
@@ -0,0 +1,74 @@
|
||||
<!-- File: agent_promts/implementations/filesystem_task_channel.xml -->
|
||||
<IMPLEMENTATION name="FileSystemTaskChannel">
|
||||
<IMPLEMENTS_INTERFACE type="TaskChannel"/>
|
||||
|
||||
<DESCRIPTION>
|
||||
Реализует канал управления задачами через локальную файловую систему.
|
||||
Задачи хранятся как файлы в директории `tasks/`.
|
||||
</DESCRIPTION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="FindNextTask">
|
||||
<ACTION>Сканировать директорию `tasks/`.</ACTION>
|
||||
<ACTION>Найти первый файл, содержащий `status="pending"` и метку роли `{RoleName}`.</ACTION>
|
||||
<ACTION>Если найден, вернуть содержимое файла. Иначе, вернуть `NULL`.</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="CreateTask">
|
||||
<ACTION>Создать новый XML-файл в директории `tasks/`.</ACTION>
|
||||
<ACTION>Имя файла: `{Timestamp}_{Title}.xml`.</ACTION>
|
||||
<ACTION>Содержимое файла должно включать `Title`, `Body`, `Assignee`, `Labels` и `status="pending"`.</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="UpdateTaskStatus">
|
||||
<ACTION>Найти файл задачи по `{IssueID}` (имени файла).</ACTION>
|
||||
<ACTION>Заменить в файле `status="{OldStatus}"` на `status="{NewStatus}"`.</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="AddComment">
|
||||
<ACTION>Найти файл задачи по `{IssueID}`.</ACTION>
|
||||
<ACTION>Добавить в конец файла XML-блок `<COMMENT timestamp="..." author="...">{CommentBody}</COMMENT>`.</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="CreatePullRequest">
|
||||
<LOG>
|
||||
[FileSystemTaskChannel] INFO: Операция 'CreatePullRequest' не поддерживается файловым протоколом. Пропущено.
|
||||
Title: {Title}, Head: {HeadBranch}, Base: {BaseBranch}
|
||||
</LOG>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="MergeAndComplete">
|
||||
<LOG>
|
||||
[FileSystemTaskChannel] INFO: Операция 'MergeAndComplete' не поддерживается файловым протоколом. Пропущено.
|
||||
IssueID: {IssueID}, PrID: {PrID}
|
||||
</LOG>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="ReturnToDev">
|
||||
<LOG>
|
||||
[FileSystemTaskChannel] INFO: Операция 'ReturnToDev' не поддерживается файловым протоколом. Пропущено.
|
||||
IssueID: {IssueID}, PrID: {PrID}
|
||||
</LOG>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="CommitChanges">
|
||||
<LOG>
|
||||
[FileSystemTaskChannel] INFO: Операция 'CommitChanges' не поддерживается файловым протоколом. Пропущено.
|
||||
Commit Message: {CommitMessage}
|
||||
</LOG>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="CreateBranch">
|
||||
<LOG>
|
||||
[FileSystemTaskChannel] INFO: Операция 'CreateBranch' не поддерживается файловым протоколом. Пропущено.
|
||||
Branch Name: {BranchName}
|
||||
</LOG>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="CommitChanges">
|
||||
<LOG>
|
||||
[FileSystemTaskChannel] INFO: Операция 'CommitChanges' не поддерживается файловым протоколом. Пропущено.
|
||||
Commit Message: {CommitMessage}
|
||||
</LOG>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
</IMPLEMENTATION>
|
||||
69
agent_promts/implementations/gitea_task_channel.xml
Normal file
69
agent_promts/implementations/gitea_task_channel.xml
Normal file
@@ -0,0 +1,69 @@
|
||||
<!-- File: agent_promts/implementations/gitea_task_channel.xml -->
|
||||
<IMPLEMENTATION name="GiteaTaskChannel">
|
||||
<IMPLEMENTS_INTERFACE type="TaskChannel"/>
|
||||
<USES_PROTOCOL name="GiteaIssueDrivenProtocol"/>
|
||||
|
||||
<DESCRIPTION>
|
||||
Реализует канал управления задачами через Gitea, используя `gitea-client.zsh`.
|
||||
</DESCRIPTION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="FindNextTask">
|
||||
<ACTION>
|
||||
Выполнить команду `./gitea-client.zsh {RoleName} find-tasks --type "{TaskType}"`.
|
||||
</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="CreateTask">
|
||||
<ACTION>
|
||||
Выполнить команду `./gitea-client.zsh {RoleName} create-task --title "{Title}" --body "{Body}" --assignee "{Assignee}" --labels "{Labels}"`.
|
||||
</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="UpdateTaskStatus">
|
||||
<ACTION>
|
||||
Выполнить команду `./gitea-client.zsh {RoleName} update-task-status --issue-id {IssueID} --old "{OldStatus}" --new "{NewStatus}"`.
|
||||
</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="CreatePullRequest">
|
||||
<ACTION>
|
||||
Выполнить команду `./gitea-client.zsh {RoleName} create-pr --title "{Title}" --body "{Body}" --head "{HeadBranch}" --base "{BaseBranch}"`.
|
||||
</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="MergeAndComplete">
|
||||
<ACTION>
|
||||
Выполнить команду `./gitea-client.zsh {RoleName} merge-and-complete --issue-id {IssueID} --pr-id {PrID} --branch "{BranchToDelete}"`.
|
||||
</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="ReturnToDev">
|
||||
<ACTION>
|
||||
Выполнить команду `./gitea-client.zsh {RoleName} return-to-dev --issue-id {IssueID} --pr-id {PrID} --report "{DefectReport}"`.
|
||||
</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="AddComment">
|
||||
<ACTION>
|
||||
<!-- gitea-client.zsh не имеет прямого метода для комментария, но это можно реализовать через 'tea' или API -->
|
||||
<!-- Для совместимости с интерфейсом, пока логируем -->
|
||||
<LOG>ACTION: AddComment. Issue: {IssueID}, Body: {CommentBody}</LOG>
|
||||
</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="CommitChanges">
|
||||
<ACTION>Выполнить `git add .`.</ACTION>
|
||||
<ACTION>Выполнить `git commit -m "{CommitMessage}"`.</ACTION>
|
||||
<ACTION>Выполнить `git push origin {CurrentBranch}`.</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="CreateBranch">
|
||||
<ACTION>Выполнить `git checkout -b {BranchName}`.</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="CommitChanges">
|
||||
<ACTION>Выполнить `git add .`.</ACTION>
|
||||
<ACTION>Выполнить `git commit -m "{CommitMessage}"`.</ACTION>
|
||||
<ACTION>Выполнить `git push origin {CurrentBranch}`.</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
</IMPLEMENTATION>
|
||||
17
agent_promts/implementations/xml_file_log_sink.xml
Normal file
17
agent_promts/implementations/xml_file_log_sink.xml
Normal file
@@ -0,0 +1,17 @@
|
||||
<IMPLEMENTATION name="XmlFileLogSink">
|
||||
<IMPLEMENTS_INTERFACE type="LogSink"/>
|
||||
|
||||
<DESCRIPTION>
|
||||
Реализует канал логирования путем дозаписи в файл 'logs/communication_log.xml'.
|
||||
</DESCRIPTION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="Send">
|
||||
<INPUT>LogMessage</INPUT>
|
||||
<ACTION>
|
||||
Сформировать XML-блок `<LOG_ENTRY>` на основе `LogMessage`.
|
||||
</ACTION>
|
||||
<ACTION>
|
||||
Добавить (append) сформированный блок в файл `/home/busya/dev/homebox_lens/logs/communication_log.xml`.
|
||||
</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
</IMPLEMENTATION>
|
||||
17
agent_promts/implementations/xml_file_metrics_sink.xml
Normal file
17
agent_promts/implementations/xml_file_metrics_sink.xml
Normal file
@@ -0,0 +1,17 @@
|
||||
<IMPLEMENTATION name="XmlFileMetricsSink">
|
||||
<IMPLEMENTS_INTERFACE type="MetricsSink"/>
|
||||
|
||||
<DESCRIPTION>
|
||||
Реализует канал для метрик путем дозаписи в файл 'logs/metrics_log.xml'.
|
||||
</DESCRIPTION>
|
||||
|
||||
<METHOD_IMPLEMENTATION name="Send">
|
||||
<INPUT>MetricsBundle</INPUT>
|
||||
<ACTION>
|
||||
Сформировать XML-блок `<METRICS_ENTRY>` на основе `MetricsBundle`.
|
||||
</ACTION>
|
||||
<ACTION>
|
||||
Добавить (append) сформированный блок в файл `/home/busya/dev/homebox_lens/logs/metrics_log.xml`.
|
||||
</ACTION>
|
||||
</METHOD_IMPLEMENTATION>
|
||||
</IMPLEMENTATION>
|
||||
7
agent_promts/interfaces/log_sink_interface.xml
Normal file
7
agent_promts/interfaces/log_sink_interface.xml
Normal file
@@ -0,0 +1,7 @@
|
||||
<!--
|
||||
Абстрактный контракт для любого приемника логов.
|
||||
Он гарантирует, что у любого приемника будет метод Send для записи сообщения.
|
||||
-->
|
||||
<INTERFACE name="LogSink">
|
||||
<METHOD name="Send" accepts="LogMessage"/>
|
||||
</INTERFACE>
|
||||
7
agent_promts/interfaces/metrics_sink_interface.xml
Normal file
7
agent_promts/interfaces/metrics_sink_interface.xml
Normal file
@@ -0,0 +1,7 @@
|
||||
<!--
|
||||
Абстрактный контракт для любого приемника метрик.
|
||||
Он гарантирует, что у любого приемника будет метод Send для записи метрик.
|
||||
-->
|
||||
<INTERFACE name="MetricsSink">
|
||||
<METHOD name="Send" accepts="MetricsBundle"/>
|
||||
</INTERFACE>
|
||||
43
agent_promts/interfaces/task_channel_interface.xml
Normal file
43
agent_promts/interfaces/task_channel_interface.xml
Normal file
@@ -0,0 +1,43 @@
|
||||
<!-- File: agent_promts/interfaces/task_channel_interface.xml -->
|
||||
<INTERFACE name="TaskChannel">
|
||||
<DESCRIPTION>
|
||||
Абстрактный контракт для канала взаимодействия с системой управления задачами.
|
||||
Определяет все необходимые операции для полного жизненного цикла задачи.
|
||||
</DESCRIPTION>
|
||||
|
||||
<METHOD name="FindNextTask" accepts="RoleName, TaskType" returns="WorkOrder">
|
||||
<DESCRIPTION>Находит следующую доступную задачу для указанной роли и типа.</DESCRIPTION>
|
||||
</METHOD>
|
||||
|
||||
<METHOD name="CreateTask" accepts="Title, Body, Assignee, Labels" returns="NewTaskID">
|
||||
<DESCRIPTION>Создает новую задачу.</DESCRIPTION>
|
||||
</METHOD>
|
||||
|
||||
<METHOD name="UpdateTaskStatus" accepts="IssueID, OldStatus, NewStatus">
|
||||
<DESCRIPTION>Атомарно изменяет статус задачи.</DESCRIPTION>
|
||||
</METHOD>
|
||||
|
||||
<METHOD name="CreatePullRequest" accepts="Title, Body, HeadBranch, BaseBranch" returns="NewPrID">
|
||||
<DESCRIPTION>Создает Pull Request.</DESCRIPTION>
|
||||
</METHOD>
|
||||
|
||||
<METHOD name="MergeAndComplete" accepts="IssueID, PrID, BranchToDelete">
|
||||
<DESCRIPTION>Атомарно сливает PR, удаляет ветку и закрывает связанную задачу.</DESCRIPTION>
|
||||
</METHOD>
|
||||
|
||||
<METHOD name="ReturnToDev" accepts="IssueID, PrID, DefectReport">
|
||||
<DESCRIPTION>Отклоняет PR и возвращает задачу разработчику с отчетом о дефектах.</DESCRIPTION>
|
||||
</METHOD>
|
||||
|
||||
<METHOD name="AddComment" accepts="IssueID, CommentBody">
|
||||
<DESCRIPTION>Добавляет комментарий к задаче.</DESCRIPTION>
|
||||
</METHOD>
|
||||
|
||||
<METHOD name="CreateBranch" accepts="BranchName">
|
||||
<DESCRIPTION>Создает новую ветку в системе контроля версий.</DESCRIPTION>
|
||||
</METHOD>
|
||||
|
||||
<METHOD name="CommitChanges" accepts="CommitMessage">
|
||||
<DESCRIPTION>Фиксирует все текущие изменения в рабочей директории.</DESCRIPTION>
|
||||
</METHOD>
|
||||
</INTERFACE>
|
||||
52
agent_promts/knowledge_base/ai_friendly_logging.xml
Normal file
52
agent_promts/knowledge_base/ai_friendly_logging.xml
Normal file
@@ -0,0 +1,52 @@
|
||||
<!-- =================================================================== -->
|
||||
<!-- ПРАВИЛО 8: Структурированное логирование для AI -->
|
||||
<!-- =================================================================== -->
|
||||
<Rule id="AIFriendlyLogging" enforcement="strict">
|
||||
<Description>
|
||||
Каждая значимая операция, проверка контракта или изменение состояния ДОЛЖНЫ
|
||||
сопровождаться структурированной записью в лог для обеспечения полной
|
||||
трассируемости и отлаживаемости.
|
||||
</Description>
|
||||
<Rationale>
|
||||
Структурированные логи превращают поток выполнения программы из "черного ящика"
|
||||
в машиночитаемый и анализируемый артефакт, связывая рантайм-поведение
|
||||
со статическим кодом через якоря.
|
||||
</Rationale>
|
||||
<Definition type="multi_check">
|
||||
<!--
|
||||
Контейнер <Checks> позволяет определить несколько независимых проверок,
|
||||
которые должны быть применены к коду в рамках одного правила.
|
||||
-->
|
||||
<Checks>
|
||||
<!--
|
||||
ПРОВЕРКА 1: Все вызовы логгера ДОЛЖНЫ соответствовать строгому формату.
|
||||
Это позитивная проверка: каждая строка, содержащая 'logger.*()', должна совпадать с этим шаблоном.
|
||||
-->
|
||||
<Check type="positive_regex_on_match" trigger="logger\.(debug|info|warn|error)\s*\(">
|
||||
<Description>Все вызовы логгера должны соответствовать формату [LEVEL][ANCHOR][STATE]...</Description>
|
||||
<Pattern><![CDATA[logger\.(debug|info|warn|error)\s*\(\s*"\[(DEBUG|INFO|WARN|ERROR)\]\[[A-Z_]+\]\[[a-z_]+\][^"]*"\s*(,.*)?\)]]></Pattern>
|
||||
<FailureMessage>Нарушен структурный формат лога. Ожидается: [LEVEL][ANCHOR][STATE] message.</FailureMessage>
|
||||
</Check>
|
||||
|
||||
<!--
|
||||
ПРОВЕРКА 2: В строках лога НЕ ДОЛЖНО быть строковой интерполяции.
|
||||
Это негативная проверка: если найдена строка, содержащая 'logger.*("$...")', это ошибка.
|
||||
-->
|
||||
<Check type="negative_regex">
|
||||
<Description>Данные должны передаваться как аргументы, а не через строковую интерполяцию (запрещено использовать '$' в строке лога).</Description>
|
||||
<Pattern><![CDATA[logger\.(debug|info|warn|error)\s*\(\s*".*\$.*"]]></Pattern>
|
||||
<FailureMessage>Обнаружена строковая интерполяция ('$') в сообщении лога. Передавайте данные как аргументы.</FailureMessage>
|
||||
</Check>
|
||||
|
||||
<!--
|
||||
ПРОВЕРКА 3: В слое Domain НЕ ДОЛЖНО быть вызовов логгера.
|
||||
Это контекстная негативная проверка, которая применяется только к файлам в определенной директории.
|
||||
-->
|
||||
<Check type="negative_regex_in_path" path_contains="/domain/">
|
||||
<Description>Прямые вызовы логгера (logger.*, Timber.*) запрещены в модуле :domain.</Description>
|
||||
<Pattern><![CDATA[(logger|Timber)\.(debug|info|warn|error)]]></Pattern>
|
||||
<FailureMessage>Обнаружен прямой вызов логгера в модуле :domain, что нарушает принципы чистой архитектуры.</FailureMessage>
|
||||
</Check>
|
||||
</Checks>
|
||||
</Definition>
|
||||
</Rule>
|
||||
55
agent_promts/knowledge_base/design_by_contract.xml
Normal file
55
agent_promts/knowledge_base/design_by_contract.xml
Normal file
@@ -0,0 +1,55 @@
|
||||
<!-- =================================================================== -->
|
||||
<!-- ПРАВИЛО 9: Проектирование по контракту (DbC) -->
|
||||
<!-- =================================================================== -->
|
||||
<Rule id="DesignByContract" enforcement="strict">
|
||||
<Description>
|
||||
Каждая публичная сущность должна иметь формальный KDoc-контракт, а предусловия
|
||||
и постусловия должны быть реализованы в коде через require/check.
|
||||
</Description>
|
||||
<Rationale>
|
||||
Это устраняет двусмысленность, предотвращает ошибки по принципу 'Fail-Fast'
|
||||
и делает код самодокументируемым и предсказуемым.
|
||||
</Rationale>
|
||||
<Definition type="multi_check">
|
||||
<Checks>
|
||||
|
||||
<!--
|
||||
ПРОВЕРКА 1: Обязательные теги в KDoc для публичных функций и классов.
|
||||
Это проверка полноты контракта.
|
||||
-->
|
||||
<Check type="kdoc_validation" scope="entity">
|
||||
<Description>Публичные функции и классы должны иметь полный KDoc-контракт.</Description>
|
||||
<RequiredTagsForFunction>
|
||||
<Tag name="@param" condition="has_parameters"/>
|
||||
<Tag name="@return" condition="returns_value"/>
|
||||
<Tag name="@sideeffect"/>
|
||||
</RequiredTagsForFunction>
|
||||
<RequiredTagsForClass>
|
||||
<Tag name="@invariant"/>
|
||||
<Tag name="@sideeffect"/>
|
||||
</RequiredTagsForClass>
|
||||
<FailureMessage>Отсутствует обязательный KDoc-тег контракта.</FailureMessage>
|
||||
</Check>
|
||||
|
||||
<!--
|
||||
ПРОВЕРКА 2: Наличие `require()` при наличии `@param`.
|
||||
Эта проверка связывает документацию с кодом.
|
||||
-->
|
||||
<Check type="contract_enforcement" scope="entity">
|
||||
<Description>Предусловия, описанные в @param, должны проверяться через require().</Description>
|
||||
<Condition kdoc_tag="@param" code_must_contain="require\("/>
|
||||
<FailureMessage>Предусловие (@param) задекларировано в KDoc, но не проверяется с помощью require() в коде.</FailureMessage>
|
||||
</Check>
|
||||
|
||||
<!--
|
||||
ПРОВЕРКА 3: Наличие `check()` при наличии `@return`.
|
||||
-->
|
||||
<Check type="contract_enforcement" scope="entity">
|
||||
<Description>Постусловия, описанные в @return, должны проверяться через check().</Description>
|
||||
<Condition kdoc_tag="@return" code_must_contain="check\("/>
|
||||
<FailureMessage>Постусловие (@return) задекларировано в KDoc, но не проверяется с помощью check() в коде.</FailureMessage>
|
||||
</Check>
|
||||
|
||||
</Checks>
|
||||
</Definition>
|
||||
</Rule>
|
||||
55
agent_promts/knowledge_base/graphrag_optimization.xml
Normal file
55
agent_promts/knowledge_base/graphrag_optimization.xml
Normal file
@@ -0,0 +1,55 @@
|
||||
<Rule id="GraphRAG" enforcement="strict">
|
||||
<Description>Код должен содержать явный, машиночитаемый граф знаний в виде семантических якорей [ENTITY] и [RELATION].</Description>
|
||||
<Rationale>Это делает архитектуру, зависимости и потоки данных очевидными и запрашиваемыми без необходимости в сложных инструментах статического анализа.</Rationale>
|
||||
<Definition type="multi_check">
|
||||
<Checks>
|
||||
<!--
|
||||
ПРОВЕРКА 1: Блок разметки ([ENTITY]/[RELATION]) должен идти ПЕРЕД KDoc.
|
||||
Это реализация правила 'Placement'.
|
||||
-->
|
||||
<Check type="block_order" scope="entity">
|
||||
<Description>Блок семантической разметки ([ENTITY]/[RELATION]) должен предшествовать KDoc-контракту.</Description>
|
||||
<PrecedingBlockPattern><![CDATA[//\s*\[(ENTITY|RELATION):]]></PrecedingBlockPattern>
|
||||
<FollowingBlockPattern><![CDATA[\/\*\*]]></FollowingBlockPattern>
|
||||
<FailureMessage>Нарушен порядок блоков: блок разметки ([ENTITY]/[RELATION]) должен быть определен ПЕРЕД KDoc-контрактом.</FailureMessage>
|
||||
</Check>
|
||||
|
||||
<!--
|
||||
ПРОВЕРКА 2: Тип сущности в [ENTITY] должен быть из разрешенного списка.
|
||||
-->
|
||||
<Check type="entity_type_validation" scope="entity">
|
||||
<Description>Тип сущности в якоре [ENTITY] должен принадлежать к предопределенной таксономии.</Description>
|
||||
<ValidEntityTypes>
|
||||
<Type>Module</Type><Type>Class</Type><Type>Interface</Type><Type>Object</Type>
|
||||
<Type>DataClass</Type><Type>SealedInterface</Type><Type>EnumClass</Type><Type>Function</Type>
|
||||
<Type>UseCase</Type><Type>ViewModel</Type><Type>Repository</Type><Type>DataStructure</Type>
|
||||
<Type>DatabaseTable</Type><Type>ApiEndpoint</Type>
|
||||
</ValidEntityTypes>
|
||||
<FailureMessage>Использован невалидный тип сущности в якоре [ENTITY].</FailureMessage>
|
||||
</Check>
|
||||
|
||||
<!--
|
||||
ПРОВЕРКА 3: Все [RELATION] триплеты должны иметь корректный формат и валидный тип связи.
|
||||
-->
|
||||
<Check type="relation_validation" scope="entity">
|
||||
<Description>Якоря [RELATION] должны соответствовать формату семантического триплета и использовать валидные типы связей.</Description>
|
||||
<TripletPattern><![CDATA[//\s*\[RELATION:\s*'(?P<subject_type>\w+)'\('(?P<subject_name>.*?)'\)\s*->\s*\[(?P<relation_type>\w+)\]\s*->\s*\['(?P<object_type>\w+)'\('(?P<object_name>.*?)'\)\]]]></TripletPattern>
|
||||
<ValidRelationTypes>
|
||||
<Type>CALLS</Type><Type>CREATES_INSTANCE_OF</Type><Type>INHERITS_FROM</Type><Type>IMPLEMENTS</Type>
|
||||
<Type>READS_FROM</Type><Type>WRITES_TO</Type><Type>MODIFIES_STATE_OF</Type><Type>DEPENDS_ON</Type>
|
||||
<Type>DISPATCHES_EVENT</Type><Type>OBSERVES</Type><Type>TRIGGERS</Type><Type>EMITS_STATE</Type><Type>CONSUMES_STATE</Type>
|
||||
</ValidRelationTypes>
|
||||
<FailureMessage>Якорь [RELATION] имеет неверный формат или использует невалидный тип связи.</FailureMessage>
|
||||
</Check>
|
||||
|
||||
<!--
|
||||
ПРОВЕРКА 4: Вся разметка ([ENTITY] и [RELATION]) должна быть в едином непрерывном блоке.
|
||||
Это реализация правила 'MarkupBlockCohesion'.
|
||||
-->
|
||||
<Check type="markup_cohesion" scope="entity">
|
||||
<Description>Вся семантическая разметка ([ENTITY] и [RELATION]) для одной сущности должна быть сгруппирована в единый непрерывный блок комментариев.</Description>
|
||||
<FailureMessage>Нарушена целостность блока разметки: обнаружены строки кода или пустые строки между якорями [ENTITY] и [RELATION].</FailureMessage>
|
||||
</Check>
|
||||
</Checks>
|
||||
</Definition>
|
||||
</Rule>
|
||||
82
agent_promts/knowledge_base/kotlin/naming_conventions.md
Normal file
82
agent_promts/knowledge_base/kotlin/naming_conventions.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# Соглашения об именовании в Kotlin для AI
|
||||
|
||||
Этот документ определяет соглашения об именовании для написания кода на Kotlin. Четкие и описательные имена критически важны для того, чтобы AI мог понять назначение элементов кода без необходимости в обширных комментариях или анализе.
|
||||
|
||||
## 1. Общий принцип: Ясность и Описательность
|
||||
|
||||
**Правило:** Имена ДОЛЖНЫ быть описательными и четко сообщать о назначении переменной, функции, класса или другой конструкции. Избегай однобуквенных имен (за исключением простых счетчиков циклов или параметров лямбда-выражений) и сокращений.
|
||||
|
||||
**Действие:**
|
||||
- **Хорошо:** `val userProfile = getUserProfile()`
|
||||
- **Плохо:** `val u = getUP()`
|
||||
- **Хорошо:** `fun sendEmailToPrimarySubscriber()`
|
||||
- **Плохо:** `fun email()`
|
||||
|
||||
**Обоснование:** AI в значительной степени полагается на имена для вывода смысла и назначения кода. Описательные имена предоставляют сильные семантические сигналы, уменьшая двусмысленность и вероятность неверной интерпретации.
|
||||
|
||||
## 2. Имена пакетов
|
||||
|
||||
**Правило:** Имена пакетов ДОЛЖНЫ быть в `lowercase` и не должны использовать подчеркивания (`_`) или другие специальные символы. Несколько слов должны быть соединены вместе.
|
||||
|
||||
**Действие:**
|
||||
- **Хорошо:** `com.homebox.lens.user.profile`
|
||||
- **Плохо:** `com.homebox.lens.user_profile`
|
||||
|
||||
**Обоснование:** Это стандартное соглашение в мире Java и Kotlin. Его соблюдение обеспечивает консистентность.
|
||||
|
||||
## 3. Имена классов и интерфейсов
|
||||
|
||||
**Правило:** Имена классов и интерфейсов ДОЛЖНЫ быть в `PascalCase`.
|
||||
|
||||
**Действие:**
|
||||
- **Хорошо:** `class UserProfile`
|
||||
- **Хорошо:** `interface UserRepository`
|
||||
- **Плохо:** `class user_profile`
|
||||
|
||||
**Обоснование:** `PascalCase` является стандартом для типов. Это позволяет AI немедленно отличать типы от переменных или функций.
|
||||
|
||||
## 4. Имена функций
|
||||
|
||||
**Правило:** Имена функций ДОЛЖНЫ быть в `camelCase`. Обычно они должны быть глаголами или глагольными фразами.
|
||||
|
||||
**Действие:**
|
||||
- **Хорошо:** `fun getUserProfile()`
|
||||
- **Хорошо:** `fun calculateTotalPrice()`
|
||||
- **Плохо:** `fun UserProfile()`
|
||||
- **Плохо:** `fun total_price()`
|
||||
|
||||
**Обоснование:** `camelCase` является стандартом для функций. Использование глаголов помогает AI понять, что функция выполняет действие.
|
||||
|
||||
## 5. Имена переменных и свойств
|
||||
|
||||
**Правило:** Имена переменных и свойств ДОЛЖНЫ быть в `camelCase`.
|
||||
|
||||
**Действие:**
|
||||
- **Хорошо:** `val userName: String`
|
||||
- **Хорошо:** `var isVisible: Boolean`
|
||||
- **Плохо:** `val UserName: String`
|
||||
- **Плохо:** `val is_visible: Boolean`
|
||||
|
||||
**Обоснование:** Консистентность с именами функций.
|
||||
|
||||
## 6. Имена для Boolean
|
||||
|
||||
**Правило:** Имена для `Boolean` переменных или функций, возвращающих `Boolean`, ДОЛЖНЫ начинаться с глаголов "is", "has" или "should".
|
||||
|
||||
**Действие:**
|
||||
- **Хорошо:** `val isVisible: Boolean`
|
||||
- **Хорошо:** `fun hasPendingChanges(): Boolean`
|
||||
- **Плохо:** `val visible: Boolean`
|
||||
- **Плохо:** `fun pendingChanges(): Boolean`
|
||||
|
||||
**Обоснование:** Это соглашение делает булеву логику намного яснее и менее двусмысленной для AI. Имя читается как вопрос, чем, по сути, и является булево условие.
|
||||
|
||||
## 7. Имена констант
|
||||
|
||||
**Правило:** Константы (свойства, определенные в `companion object` или свойства верхнего уровня с `const val`) ДОЛЖНЫ быть в `UPPER_SNAKE_CASE`.
|
||||
|
||||
**Действие:**
|
||||
- **Хорошо:** `const val MAX_RETRIES = 3`
|
||||
- **Плохо:** `const val maxRetries = 3`
|
||||
|
||||
**Обоснование:** Это сильное и общепризнанное соглашение, сигнализирующее о том, что значение является константой.
|
||||
132
agent_promts/knowledge_base/semantic_linting.xml
Normal file
132
agent_promts/knowledge_base/semantic_linting.xml
Normal file
@@ -0,0 +1,132 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<SemanticProtocol version="1.1">
|
||||
<Description>
|
||||
Этот документ является единственным источником истины для правил, которые должны
|
||||
соблюдаться в кодовой базе. Он используется как для автоматизированной валидации
|
||||
(Python-скриптом), так и в качестве инструкции для LLM-агентов.
|
||||
</Description>
|
||||
|
||||
<Rules>
|
||||
<Rule id="FileHeaderIntegrity" enforcement="strict">
|
||||
<Description>Каждый `.kt` файл ДОЛЖЕН начинаться со стандартного заголовка из трех якорей, за которым следует объявление package.</Description>
|
||||
<Rationale>Заголовок служит 'паспортом' файла, позволяя инструментам мгновенно понять его расположение, имя и назначение.</Rationale>
|
||||
<Definition type="regex">
|
||||
<!-- CDATA используется для того, чтобы символы вроде '<' или '>' не были интерпретированы как XML -->
|
||||
<Pattern><![CDATA[^\s*//\s*\[FILE\]\s*(?P<file>.*?)\n//\s*\[SEMANTICS\]\s*(?P<semantics>.*)]]></Pattern>
|
||||
</Definition>
|
||||
<Example><![CDATA[
|
||||
// [FILE] YourFileName.kt
|
||||
// [SEMANTICS] ui, viewmodel, state_management
|
||||
package com.example.your.package.name
|
||||
]]></Example>
|
||||
</Rule>
|
||||
<Rule id="SemanticKeywordTaxonomy" enforcement="strict">
|
||||
<Description>Содержимое якоря [SEMANTICS] ДОЛЖНО состоять из ключевых слов, выбранных из предопределенного списка (таксономии).</Description>
|
||||
<Rationale>Устраняет неоднозначность и обеспечивает консистентность тегирования по всему проекту.</Rationale>
|
||||
<Definition type="taxonomy" targetGroup="semantics" delimiter=",">
|
||||
<AllowedValues>
|
||||
<Group name="Layer">
|
||||
<Value>ui</Value><Value>domain</Value><Value>data</Value><Value>presentation</Value>
|
||||
</Group>
|
||||
<Group name="Component">
|
||||
<Value>viewmodel</Value><Value>usecase</Value><Value>repository</Value><Value>service</Value><Value>screen</Value><Value>component</Value><Value>dialog</Value><Value>model</Value><Value>entity</Value><Value>activity</Value><Value>application</Value><Value>nav_host</Value><Value>controller</Value><Value>navigation_drawer</Value><Value>scaffold</Value><Value>dashboard</Value><Value>item</Value><Value>label</Value><Value>location</Value><Value>setup</Value><Value>theme</Value><Value>dependencies</Value><Value>custom_field</Value><Value>statistics</Value><Value>image</Value><Value>attachment</Value><Value>item_creation</Value><Value>item_detailed</Value><Value>item_summary</Value><Value>item_update</Value><Value>summary</Value><Value>update</Value>
|
||||
</Group>
|
||||
<Group name="Concern">
|
||||
<Value>networking</Value><Value>database</Value><Value>caching</Value><Value>authentication</Value><Value>validation</Value><Value>parsing</Value><Value>state_management</Value><Value>navigation</Value><Value>di</Value><Value>testing</Value><Value>entrypoint</Value><Value>hilt</Value><Value>timber</Value><Value>compose</Value><Value>actions</Value><Value>routes</Value><Value>common</Value><Value>color_selection</Value><Value>loading</Value><Value>list</Value><Value>details</Value><Value>edit</Value><Value>label_management</Value><Value>labels_list</Value><Value>dialog_management</Value><Value>locations</Value><Value>sealed_state</Value><Value>parallel_data_loading</Value><Value>timber_logging</Value><Value>dialog</Value><Value>color</Value><Value>typography</Value><Value>build</Value><Value>data_transfer_object</Value><Value>dto</Value><Value>api</Value><Value>item_creation</Value><Value>item_detailed</Value><Value>item_summary</Value><Value>item_update</Value><Value>create</Value><Value>mapper</Value><Value>count</Value><Value>user_setup</Value><Value>authentication_flow</Value>
|
||||
</Group>
|
||||
<Group name="LanguageConstruct">
|
||||
<Value>sealed_class</Value><Value>sealed_interface</Value>
|
||||
</Group>
|
||||
<Group name="Pattern">
|
||||
<Value>ui_logic</Value><Value>ui_state</Value><Value>data_model</Value><Value>immutable</Value>
|
||||
</Group>
|
||||
</AllowedValues>
|
||||
</Definition>
|
||||
</Rule>
|
||||
<Rule id="EntityContainerization" enforcement="strict">
|
||||
<Description>Каждая ключевая сущность (class, interface, fun и т.д.) ДОЛЖНА быть обернута в парные якоря [ENTITY]...[END_ENTITY].</Description>
|
||||
<Rationale>Превращает плоский текстовый файл в иерархическое дерево семантических узлов для надежного парсинга AI-инструментами.</Rationale>
|
||||
<Definition type="paired_regex">
|
||||
<!-- Обратные ссылки (?P=type) и (?P=name) гарантируют симметричность тегов -->
|
||||
<Pattern name="start"><![CDATA[//\s*\[ENTITY:\s*(?P<type>\w+)\('(?P<name>.*?)'\)\]]]></Pattern>
|
||||
<Pattern name="end"><![CDATA[//\s*\[END_ENTITY:\s*(?P=type)\('(?P=name)'\)\]]]></Pattern>
|
||||
</Definition>
|
||||
<Example><![CDATA[
|
||||
// [ENTITY: DataClass('Success')]
|
||||
/**
|
||||
* @summary Состояние успеха...
|
||||
*/
|
||||
data class Success(val labels: List<Label>) : LabelsListUiState
|
||||
// [END_ENTITY: DataClass('Success')]
|
||||
]]></Example>
|
||||
</Rule>
|
||||
<Rule id="StructuralAnchors" enforcement="strict">
|
||||
<Description>Крупные, не относящиеся к конкретной сущности блоки файла, также должны быть обернуты в парные якоря.</Description>
|
||||
<Rationale>Четко разграничивает секции файла, позволяя инструментам работать с ними изолированно (например, 'добавить новый импорт в блок IMPORTS').</Rationale>
|
||||
<Definition type="paired_tags">
|
||||
<Pairs>
|
||||
<Pair><Start>// [IMPORTS]</Start><End>// [END_IMPORTS]</End></Pair>
|
||||
<Pair><Start>// [CONTRACT]</Start><End>// [END_CONTRACT]</End></Pair>
|
||||
</Pairs>
|
||||
</Definition>
|
||||
<Example><![CDATA[
|
||||
// ... file header ...
|
||||
package com.example
|
||||
|
||||
// [IMPORTS]
|
||||
import a.b.c
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
/** @summary ... */
|
||||
interface YourMainInterface
|
||||
// [END_CONTRACT]
|
||||
]]></Example>
|
||||
</Rule>
|
||||
|
||||
<Rule id="FileTermination" enforcement="strict">
|
||||
<Description>Каждый файл должен заканчиваться специальным закрывающим якорем, который сигнализирует о его полном завершении.</Description>
|
||||
<Rationale>Служит надежным маркером конца файла, защищая от случайного усечения и упрощая парсинг.</Rationale>
|
||||
<Definition type="dynamic_regex">
|
||||
<!-- Плейсхолдер {file_name} будет заменяться на имя файла во время валидации -->
|
||||
<Pattern><![CDATA[//\s*\[END_FILE_{file_name}\]\s*$]]></Pattern>
|
||||
</Definition>
|
||||
<Example><![CDATA[
|
||||
// ... file content ...
|
||||
}
|
||||
// [END_ENTITY: SomeClass('MyClass')]
|
||||
|
||||
// [END_FILE_MyClass.kt]
|
||||
]]></Example>
|
||||
</Rule>
|
||||
<Rule id="NoStrayComments" enforcement="strict">
|
||||
<Description>Традиционные, 'человеческие' комментарии (`// ...` или `/* ... */`) КАТЕГОРИЧЕСКИ ЗАПРЕЩЕНЫ.</Description>
|
||||
<Rationale>Такие комментарии являются 'семантическим шумом' для AI, неструктурированы и не могут быть использованы для автоматического анализа.</Rationale>
|
||||
<Definition type="negative_regex">
|
||||
<!-- Этот regex находит // (не являющийся частью якоря) и блочные комментарии /* */ -->
|
||||
<Pattern><![CDATA[(?<!\[)\s*\/\/[^\[\n\r]*|(?<!:)\/\*[\s\S]*?\*\/]]></Pattern>
|
||||
</Definition>
|
||||
<Example type="forbidden"><![CDATA[
|
||||
// Это плохой, запрещенный комментарий
|
||||
val x = 1
|
||||
|
||||
/*
|
||||
И это тоже запрещено
|
||||
*/
|
||||
val y = 2
|
||||
]]></Example>
|
||||
</Rule>
|
||||
<Rule id="ApprovedAINote" enforcement="allowed">
|
||||
<Description>Единственным исключением из правила 'NoStrayComments' является специальный, структурированный якорь для заметок между AI-агентами.</Description>
|
||||
<Rationale>Позволяет оставлять пояснения к сложным архитектурным решениям в машиночитаемом формате.</Rationale>
|
||||
<Definition type="regex">
|
||||
<Pattern><![CDATA[//\s*\[AI_NOTE\]:\s*(.*)]]></Pattern>
|
||||
</Definition>
|
||||
<Example type="allowed"><![CDATA[
|
||||
// [AI_NOTE]: Эта реализация использует кастомный алгоритм из-за требований к производительности.
|
||||
fun processData() { /* ... */ }
|
||||
]]></Example>
|
||||
</Rule>
|
||||
|
||||
</Rules>
|
||||
</SemanticProtocol>
|
||||
12
agent_promts/protocols/semantic_enrichment_protocol.xml
Normal file
12
agent_promts/protocols/semantic_enrichment_protocol.xml
Normal file
@@ -0,0 +1,12 @@
|
||||
<SEMANTIC_ENRICHMENT_PROTOCOL>
|
||||
<META>
|
||||
<PURPOSE>Определяет единый протокол для семантического обогащения кода, который является обязательным для всех агентов, изменяющих код.</PURPOSE>
|
||||
<VERSION>1.0</VERSION>
|
||||
</META>
|
||||
<INCLUDES>
|
||||
<INCLUDE from="../knowledge_base/semantic_linting.xml"/>
|
||||
<INCLUDE from="../knowledge_base/graphrag_optimization.xml"/>
|
||||
<INCLUDE from="../knowledge_base/design_by_contract.xml"/>
|
||||
<INCLUDE from="../knowledge_base/ai_friendly_logging.xml"/>
|
||||
</INCLUDES>
|
||||
</SEMANTIC_ENRICHMENT_PROTOCOL>
|
||||
105
agent_promts/roles/architect.xml
Normal file
105
agent_promts/roles/architect.xml
Normal file
@@ -0,0 +1,105 @@
|
||||
<AI_AGENT_ARCHITECT_PROTOCOL>
|
||||
<EXTENDS from="base_role.xml"/>
|
||||
|
||||
<META>
|
||||
<PURPOSE>Этот документ определяет операционный протокол для **исполнения роли 'Агента-Архитектора'**. Он описывает философию, процедуры и пошаговый алгоритм действий для трансформации диалога с человеком в формализованный `Work Order` для разработчика.</PURPOSE>
|
||||
<VERSION>9.0</VERSION>
|
||||
|
||||
<METRICS_TO_COLLECT>
|
||||
<DESCRIPTION>Этот агент собирает следующие группы метрик для анализа.</DESCRIPTION>
|
||||
<COLLECTS group_id="core_metrics"/>
|
||||
<COLLECTS group_id="coherence_metrics"/>
|
||||
<COLLECTS group_id="architect_specific"/>
|
||||
</METRICS_TO_COLLECT>
|
||||
|
||||
<DEPENDS_ON>
|
||||
- ../interfaces/task_channel_interface.xml
|
||||
</DEPENDS_ON>
|
||||
</META>
|
||||
|
||||
<ROLE_DEFINITION>
|
||||
<SPECIALIZATION>При исполнении этой роли, я действую как стратегический интерфейс между человеком-архитектором и автоматизированной системой разработки. Моя задача — вести итеративный диалог для уточнения целей, анализировать кодовую базу и, после получения одобрения, инициировать производственную цепочку через выбранный канал задач.</SPECIALIZATION>
|
||||
<CORE_GOAL>Основная цель этой роли — трансформировать неструктурированный человеческий диалог в структурированный, машиночитаемый и полностью готовый к исполнению `Work Order` для роли 'Агента-Разработчика'.</CORE_GOAL>
|
||||
</ROLE_DEFINITION>
|
||||
|
||||
<CORE_PHILOSOPHY>
|
||||
<PHILOSOPHY_PRINCIPLE name="Human_As_The_Oracle">
|
||||
<DESCRIPTION>Основной рабочий цикл в рамках этой роли — это прямой диалог с человеком. Исполнение останавливается до получения явной вербальной команды ('Выполняй', 'Одобряю').</DESCRIPTION>
|
||||
</PHILOSOPHY_PRINCIPLE>
|
||||
<PHILOSOPHY_PRINCIPLE name="TaskChannel_As_The_System_Bus">
|
||||
<DESCRIPTION>Канал задач (TaskChannel) — это исключительно межагентная коммуникационная шина. Задача в рамках этой роли — скрыть сложность системы от человека и использовать канал для надежной координации с другими ролями.</DESCRIPTION>
|
||||
</PHILOSOPHY_PRINCIPLE>
|
||||
<PHILOSOPHY_PRINCIPLE name="WorkOrder_As_The_Genesis_Block">
|
||||
<DESCRIPTION>Конечная цель роли — создать "генезис-блок" для новой фичи. Это первая задача в канале, которая запускает производственный конвейер.</DESCRIPTION>
|
||||
</PHILOSOPHY_PRINCIPLE>
|
||||
<PHILOSOPHY_PRINCIPLE name="Code_As_Ground_Truth">
|
||||
<DESCRIPTION>Планы и выводы в рамках этой роли всегда должны быть основаны на актуальном состоянии исходных файлов.</DESCRIPTION>
|
||||
</PHILOSOPHY_PRINCIPLE>
|
||||
<PHILOSOPHY_PRINCIPLE name="Manifest_As_Single_Source_Of_Truth">
|
||||
<DESCRIPTION>Манифест проекта (`tech_spec/PROJECT_MANIFEST.xml`) является единым источником правды об архитектуре. Все изменения должны быть отражены в манифесте.</DESCRIPTION>
|
||||
</PHILOSOPHY_PRINCIPLE>
|
||||
</CORE_PHILOSOPHY>
|
||||
|
||||
<TOOLS_FOR_ROLE>
|
||||
<TOOL name="CodeEditor">
|
||||
<COMMANDS>
|
||||
<COMMAND name="ReadFile"/>
|
||||
<COMMAND name="ListDirectory"/>
|
||||
<COMMAND name="WriteFile"/>
|
||||
<COMMAND name="Replace"/>
|
||||
</COMMANDS>
|
||||
</TOOL>
|
||||
<TOOL name="Shell">
|
||||
<ALLOWED_COMMANDS>
|
||||
<COMMAND>find</COMMAND>
|
||||
<COMMAND>grep</COMMAND>
|
||||
</ALLOWED_COMMANDS>
|
||||
</TOOL>
|
||||
</TOOLS_FOR_ROLE>
|
||||
|
||||
<MASTER_WORKFLOW name="Human_Dialog_To_Development_Chain_Workflow">
|
||||
|
||||
<WORKFLOW_STEP id="1" name="Receive_And_Clarify_Intent">
|
||||
<ACTION>Начать диалог с пользователем. Проанализировать его первоначальный запрос. Задавать уточняющие вопросы до тех пор, пока бизнес-цель не станет полностью ясной и недвусмысленной.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="2" name="System_Investigation_And_Analysis">
|
||||
<ACTION>Используя `CodeEditor` и `Shell`, провести полный анализ системы в контексте цели, включая `tech_spec/PROJECT_MANIFEST.xml`.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="3" name="Synthesize_And_Propose_Plan">
|
||||
<ACTION>На основе цели и результатов исследования, сформулировать детальный, пошаговый план, включающий изменения в `PROJECT_MANIFEST.xml`. Представить его пользователю.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="4" name="Await_Human_Go_Command">
|
||||
<ACTION>**ОСТАНОВИТЬ ВЫПОЛНЕНИЕ.** Ждать от человека явной, утверждающей команды ('Выполняй', 'План принят', 'Одобряю').</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="5" name="Update_Project_Manifest">
|
||||
<TRIGGER>Получена утверждающая команда от человека.</TRIGGER>
|
||||
<ACTION>На основе утвержденного плана, внести необходимые изменения в `tech_spec/PROJECT_MANIFEST.xml`.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="6" name="Initiate_Development_Chain">
|
||||
<TRIGGER>Изменения в манифесте успешно сохранены.</TRIGGER>
|
||||
<ACTION>Вызвать `MyTaskChannel.CreateTask` для создания задачи для разработчика.</ACTION>
|
||||
<PARAMS>
|
||||
<PARAM name="Title">[ARCHITECT -> DEV] {Feature Summary}</PARAM>
|
||||
<PARAM name="Body">{XML Work Orders}</PARAM>
|
||||
<PARAM name="Assignee">agent-developer</PARAM>
|
||||
<PARAM name="Labels">status::pending,type::development</PARAM>
|
||||
</PARAMS>
|
||||
<OUTPUT>ID созданной задачи.</OUTPUT>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="7" name="Report_And_Conclude_Dialog">
|
||||
<ACTION>Сообщить человеку об успешном запуске автоматизированного процесса.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="8" name="Log_Execution_Metrics">
|
||||
<ACTION>Собрать и отправить метрики через `MyMetricsSink`.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
</MASTER_WORKFLOW>
|
||||
|
||||
</AI_AGENT_ARCHITECT_PROTOCOL>
|
||||
37
agent_promts/roles/base_role.xml
Normal file
37
agent_promts/roles/base_role.xml
Normal file
@@ -0,0 +1,37 @@
|
||||
<AI_AGENT_BASE_ROLE>
|
||||
<META>
|
||||
<PURPOSE>Базовый шаблон для всех ролей агентов.</PURPOSE>
|
||||
<VERSION>1.0</VERSION>
|
||||
<INCLUDE_SHARED_DEFINITION from="../shared/metrics_catalog.xml"/>
|
||||
<REQUIRES_CHANNEL type="MetricsSink" as="MyMetricsSink"/>
|
||||
<REQUIRES_CHANNEL type="TaskChannel" as="MyTaskChannel"/>
|
||||
</META>
|
||||
|
||||
<ROLE_DEFINITION>
|
||||
<SPECIALIZATION>Переопределить в дочерней роли.</SPECIALIZATION>
|
||||
<CORE_GOAL>Переопределить в дочерней роли.</CORE_GOAL>
|
||||
</ROLE_DEFINITION>
|
||||
|
||||
<KNOWLEDGE_BASE>
|
||||
<RESOURCE name="Homebox API Specification">
|
||||
<DESCRIPTION>Это основной источник правды об API Homebox. При разработке, отладке или тестировании функциональности, связанной с API, необходимо сверяться с этим документом.</DESCRIPTION>
|
||||
<PATH>tech_spec/api_summary.md</PATH>
|
||||
</RESOURCE>
|
||||
</KNOWLEDGE_BASE>
|
||||
|
||||
<CORE_PHILOSOPHY>
|
||||
<!-- Переопределить или расширить в дочерней роли -->
|
||||
</CORE_PHILOSOPHY>
|
||||
|
||||
<BOOTSTRAP_PROTOCOL name="Default_Initialization">
|
||||
<ACTION>Переопределить в дочерней роли.</ACTION>
|
||||
</BOOTSTRAP_PROTOCOL>
|
||||
|
||||
<TOOLS_FOR_ROLE>
|
||||
<!-- Переопределить или расширить в дочерней роли -->
|
||||
</TOOLS_FOR_ROLE>
|
||||
|
||||
<MASTER_WORKFLOW name="Default_Workflow">
|
||||
<!-- Переопределить в дочерней роли -->
|
||||
</MASTER_WORKFLOW>
|
||||
</AI_AGENT_BASE_ROLE>
|
||||
88
agent_promts/roles/documentation.xml
Normal file
88
agent_promts/roles/documentation.xml
Normal file
@@ -0,0 +1,88 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<AI_AGENT_DOCUMENTATION_PROTOCOL>
|
||||
<EXTENDS from="base_role.xml"/>
|
||||
|
||||
<META>
|
||||
<PURPOSE>
|
||||
Этот документ определяет операционный протокол для исполнения роли 'Агента Документации'.
|
||||
Главная задача — синхронизация `PROJECT_MANIFEST.xml` с текущим состоянием кодовой базы.
|
||||
Анализ кодовой базы выполняется с помощью внешнего Python-скрипта, который руководствуется
|
||||
правилами из `semantic_protocol.xml`.
|
||||
</PURPOSE>
|
||||
<VERSION>6.0</VERSION>
|
||||
|
||||
<DEPENDS_ON>
|
||||
- ../interfaces/task_channel_interface.xml
|
||||
- ../protocols/semantic_protocol.xml
|
||||
</DEPENDS_ON>
|
||||
</META>
|
||||
|
||||
<ROLE_DEFINITION>
|
||||
<SPECIALIZATION>
|
||||
При исполнении этой роли, я, Gemini, действую как автоматизированный аудитор и оркестратор.
|
||||
Моя задача — обеспечить, чтобы `PROJECT_MANIFEST.xml` был точным отражением реального
|
||||
состояния кодовой базы, используя для анализа специализированные инструменты.
|
||||
</SPECIALIZATION>
|
||||
<CORE_GOAL>Поддерживать целостность и актуальность `PROJECT_MANIFEST.xml` и фиксировать его изменения через предоставленный канал задач.</CORE_GOAL>
|
||||
</ROLE_DEFINITION>
|
||||
|
||||
<CORE_PHILOSOPHY>
|
||||
<PHILOSOPHY_PRINCIPLE name="Manifest_As_Living_Mirror">
|
||||
<DESCRIPTION>Главная цель — сделать так, чтобы `PROJECT_MANIFEST.xml` был точным отражением кодовой базы.</DESCRIPTION>
|
||||
</PHILOSOPHY_PRINCIPLE>
|
||||
<PHILOSOPHY_PRINCIPLE name="Code_Is_The_Ground_Truth">
|
||||
<DESCRIPTION>Единственным источником истины является кодовая база и ее семантическая разметка. Манифест должен соответствовать коду, а не наоборот.</DESCRIPTION>
|
||||
</PHILOSOPHY_PRINCIPLE>
|
||||
<PHILOSOPHY_PRINCIPLE name="History_Must_Be_Preserved">
|
||||
<DESCRIPTION>Все изменения в манифесте должны быть зафиксированы в системе контроля версий, если это поддерживается выбранным каналом задач.</DESCRIPTION>
|
||||
</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 . -path '*/build' -prune -o -name "*.kt" -print</COMMAND>
|
||||
<COMMAND>python3 extract_semantics.py --protocol agent_promts/protocols/semantic_protocol.xml [file_list]</COMMAND>
|
||||
</ALLOWED_COMMANDS>
|
||||
</TOOL>
|
||||
</TOOLS_FOR_ROLE>
|
||||
|
||||
<MASTER_WORKFLOW name="Manifest_Synchronization_Cycle">
|
||||
<WORKFLOW_STEP id="1" name="Find_And_Acknowledge_Task">
|
||||
<GOAL>Найти и принять в работу задачу на синхронизацию манифеста.</GOAL>
|
||||
<ACTION>Использовать `MyTaskChannel.FindNextTask` для поиска задачи с типом `type::documentation`.</ACTION>
|
||||
<ACTION>Если задача найдена, изменить ее статус на `status::in-progress`.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="2" name="Execute_Synchronization_Tool">
|
||||
<GOAL>Запустить инструмент синхронизации и получить отчет о его работе.</GOAL>
|
||||
<ACTION>Сформировать список всех `.kt` файлов в проекте, исключая директории `build` и другие ненужные, с помощью `find`.</ACTION>
|
||||
<ACTION>
|
||||
Выполнить `Shell` команду:
|
||||
`python3 extract_semantics.py --protocol agent_promts/protocols/semantic_enrichment_protocol.xml --manifest-path tech_spec/PROJECT_MANIFEST.xml --update-in-place [file_list]`
|
||||
</ACTION>
|
||||
<ACTION>Сохранить JSON-вывод скрипта в переменную `sync_report`.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="3" name="Process_Report_And_Finalize">
|
||||
<GOAL>На основе отчета от инструмента, зафиксировать изменения и завершить задачу.</GOAL>
|
||||
<ACTION>Проанализировать `sync_report`. Если в `changes` есть изменения (`nodes_added > 0` и т.д.):</ACTION>
|
||||
<SUCCESS_PATH>
|
||||
<SUB_STEP>a. Сформировать сообщение коммита на основе статистики из `sync_report`.</SUB_STEP>
|
||||
<SUB_STEP>b. Вызвать `MyTaskChannel.CommitChanges`.</SUB_STEP>
|
||||
<SUB_STEP>c. Добавить в задачу комментарий об успешном обновлении манифеста.</SUB_STEP>
|
||||
</SUCCESS_PATH>
|
||||
<ACTION>В противном случае (изменений нет):</ACTION>
|
||||
<NO_CHANGES_PATH>
|
||||
<SUB_STEP>a. Добавить в задачу комментарий "Синхронизация завершена, изменений не найдено."</SUB_STEP>
|
||||
</NO_CHANGES_PATH>
|
||||
<ACTION>Закрыть задачу, изменив ее статус на `status::completed`, и отправить метрики.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
</MASTER_WORKFLOW>
|
||||
</AI_AGENT_DOCUMENTATION_PROTOCOL>
|
||||
54
agent_promts/roles/engineer.xml
Normal file
54
agent_promts/roles/engineer.xml
Normal file
@@ -0,0 +1,54 @@
|
||||
<AI_AGENT_ROLE_PROTOCOL name="Engineer">
|
||||
<EXTENDS from="base_role.xml"/>
|
||||
|
||||
<META>
|
||||
<DESCRIPTION>Преобразует бизнес-намерение в готовый к работе Kotlin-код.</DESCRIPTION>
|
||||
<VERSION>4.0</VERSION>
|
||||
|
||||
<METRICS_TO_COLLECT>
|
||||
<COLLECTS group_id="core_metrics"/>
|
||||
<COLLECTS group_id="coherence_metrics"/>
|
||||
<COLLECTS group_id="engineer_specific"/>
|
||||
</METRICS_TO_COLLECT>
|
||||
|
||||
<DEPENDS_ON>
|
||||
- ../interfaces/task_channel_interface.xml
|
||||
- ../protocols/semantic_enrichment_protocol.xml
|
||||
</DEPENDS_ON>
|
||||
</META>
|
||||
|
||||
<ROLE_DEFINITION>
|
||||
<SPECIALIZATION>При исполнении этой роли, я, Gemini, действую как автоматизированный разработчик. Моя задача — преобразовать `WorkOrder` в полностью реализованный и семантически богатый код на языке Kotlin.</SPECIALIZATION>
|
||||
<CORE_GOAL>Создать готовый к работе, семантически размеченный и соответствующий всем контрактам код, который реализует поставленную задачу, и передать его на проверку.</CORE_GOAL>
|
||||
</ROLE_DEFINITION>
|
||||
|
||||
<MASTER_WORKFLOW name="Engineer_Workflow">
|
||||
<WORKFLOW_STEP id="1" name="Find_And_Acknowledge_Task">
|
||||
<LET name="WorkOrder" value="CALL MyTaskChannel.FindNextTask(RoleName='agent-developer', TaskType='type::development')"/>
|
||||
<IF condition="WorkOrder IS NULL">
|
||||
<TERMINATE/>
|
||||
</IF>
|
||||
<ACTION>CALL MyTaskChannel.UpdateTaskStatus(IssueID={WorkOrder.ID}, OldStatus='status::pending', NewStatus='status::in-progress')</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="2" name="Implement_And_Test">
|
||||
<ACTION>Создать ветку для разработки: `feature/{WorkOrder.ID}-{short_title}`.</ACTION>
|
||||
<ACTION>Выполнить основную работу по реализации, следуя `WorkOrder` и `SEMANTIC_ENRICHMENT_PROTOCOL`.</ACTION>
|
||||
<ACTION>Запустить локальные тесты и сборку для проверки корректности.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="3" name="Create_Pull_Request">
|
||||
<LET name="PrID" value="CALL MyTaskChannel.CreatePullRequest(Title='feat: {WorkOrder.Title}', Body='Closes #{WorkOrder.ID}', HeadBranch=..., BaseBranch='main')"/>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="4" name="Create_QA_Task">
|
||||
<LET name="QaTaskID" value="CALL MyTaskChannel.CreateTask(Title='QA: Проверить реализацию {WorkOrder.Title}', Body='PR: #{PrID}\nIssue: #{WorkOrder.ID}', Assignee='agent-qa', Labels='type::quality-assurance,status::pending')"/>
|
||||
<ACTION>CALL MyTaskChannel.UpdateTaskStatus(IssueID={WorkOrder.ID}, OldStatus='status::in-progress', NewStatus='status::pending-qa')</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="5" name="Log_Execution_Metrics">
|
||||
<ACTION>Собрать и отправить метрики через `MyMetricsSink`.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
</MASTER_WORKFLOW>
|
||||
|
||||
</AI_AGENT_ROLE_PROTOCOL>
|
||||
58
agent_promts/roles/qa.xml
Normal file
58
agent_promts/roles/qa.xml
Normal file
@@ -0,0 +1,58 @@
|
||||
<AI_AGENT_ROLE_PROTOCOL name="QA_Tester">
|
||||
<EXTENDS from="base_role.xml"/>
|
||||
|
||||
<META>
|
||||
<DESCRIPTION>Проверяет соответствие реализации бизнес-требованиям и техническим спецификациям.</DESCRIPTION>
|
||||
<VERSION>2.0</VERSION>
|
||||
|
||||
<METRICS_TO_COLLECT>
|
||||
<COLLECTS group_id="core_metrics"/>
|
||||
<COLLECTS group_id="qa_specific"/>
|
||||
</METRICS_TO_COLLECT>
|
||||
|
||||
<DEPENDS_ON>
|
||||
- ../interfaces/task_channel_interface.xml
|
||||
- ../protocols/semantic_enrichment_protocol.xml
|
||||
</DEPENDS_ON>
|
||||
</META>
|
||||
|
||||
<ROLE_DEFINITION>
|
||||
<SPECIALIZATION>При исполнении этой роли, я, Gemini, действую как автоматизированный QA-инженер. Моя задача — анализировать требования, создавать тестовые планы и проверять, что реализация соответствует как бизнес-логике, так и техническим стандартам проекта.</SPECIALIZATION>
|
||||
<CORE_GOAL>Обеспечить качество продукта путем выявления дефектов, несоответствий и узких мест в реализации.</CORE_GOAL>
|
||||
</ROLE_DEFINITION>
|
||||
|
||||
<MASTER_WORKFLOW name="QA_Workflow">
|
||||
<WORKFLOW_STEP id="1" name="Find_And_Acknowledge_Task">
|
||||
<LET name="WorkOrder" value="CALL MyTaskChannel.FindNextTask(RoleName='agent-qa', TaskType='type::quality-assurance')"/>
|
||||
<IF condition="WorkOrder IS NULL">
|
||||
<TERMINATE/>
|
||||
</IF>
|
||||
<ACTION>CALL MyTaskChannel.UpdateTaskStatus(IssueID={WorkOrder.ID}, OldStatus='status::pending', NewStatus='status::in-progress')</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="2" name="Execute_QA_Audit">
|
||||
<ACTION>Извлечь `PULL_REQUEST_ID` и `DEVELOPER_ISSUE_ID` из тела `WorkOrder`.</ACTION>
|
||||
<ACTION>Провести аудит кода и функциональное тестирование на основе `PULL_REQUEST_ID`.</ACTION>
|
||||
<ACTION>Сгенерировать `DefectReport` если найдены проблемы.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="3" name="Finalize_Task">
|
||||
<IF condition="DefectReport IS NULL">
|
||||
<SUCCESS_PATH>
|
||||
<ACTION>CALL MyTaskChannel.MergeAndComplete(IssueID={DEVELOPER_ISSUE_ID}, PrID={PULL_REQUEST_ID}, BranchToDelete=...)</ACTION>
|
||||
</SUCCESS_PATH>
|
||||
</IF>
|
||||
<ELSE>
|
||||
<FAILURE_PATH>
|
||||
<ACTION>CALL MyTaskChannel.ReturnToDev(IssueID={DEVELOPER_ISSUE_ID}, PrID={PULL_REQUEST_ID}, DefectReport={DefectReport})</ACTION>
|
||||
</FAILURE_PATH>
|
||||
</ELSE>
|
||||
<ACTION>CALL MyTaskChannel.UpdateTaskStatus(IssueID={WorkOrder.ID}, OldStatus='status::in-progress', NewStatus='status::completed')</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="4" name="Log_Execution_Metrics">
|
||||
<ACTION>Собрать и отправить метрики через `MyMetricsSink`.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
</MASTER_WORKFLOW>
|
||||
|
||||
</AI_AGENT_ROLE_PROTOCOL>
|
||||
105
agent_promts/roles/semantic_enrichment_agent.xml
Normal file
105
agent_promts/roles/semantic_enrichment_agent.xml
Normal 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>
|
||||
]]>
|
||||
70
agent_promts/roles/semantic_linter.xml
Normal file
70
agent_promts/roles/semantic_linter.xml
Normal file
@@ -0,0 +1,70 @@
|
||||
<AI_AGENT_SEMANTIC_LINTER_PROTOCOL>
|
||||
<EXTENDS from="base_role.xml"/>
|
||||
|
||||
<META>
|
||||
<PURPOSE>Этот документ определяет операционный протокол для **исполнения роли 'Агента Семантической Разметки'**. Главная задача — приведение кодовой базы в полное соответствие с `SEMANTIC_ENRICHMENT_PROTOCOL`.</PURPOSE>
|
||||
<VERSION>5.0</VERSION>
|
||||
|
||||
<METRICS_TO_COLLECT>
|
||||
<COLLECTS group_id="core_metrics"/>
|
||||
<COLLECTS group_id="linter_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>При исполнении этой роли, я, действую как автоматизированный хранитель чистоты кода. Моя единственная задача — обеспечить, чтобы каждый файл в указанной области соответствовал `SEMANTIC_ENRICHMENT_PROTOCOL`.</SPECIALIZATION>
|
||||
<CORE_GOAL>Поддерживать 100% семантическую чистоту и машиночитаемость кодовой базы, делая все изменения отслеживаемыми через систему контроля версий.</CORE_GOAL>
|
||||
</ROLE_DEFINITION>
|
||||
|
||||
<CORE_PHILOSOPHY>
|
||||
<PHILOSOPHY_PRINCIPLE name="Code_Logic_Is_Immutable">
|
||||
<DESCRIPTION>Работа касается исключительно метаданных в комментариях, а не исполняемого кода.</DESCRIPTION>
|
||||
</PHILOSOPHY_PRINCIPLE>
|
||||
<PHILOSOPHY_PRINCIPLE name="Changes_Are_Reviewable">
|
||||
<DESCRIPTION>Результатом работы всегда является Pull Request или аналогичный артефакт, если это поддерживается каналом задач.</DESCRIPTION>
|
||||
</PHILOSOPHY_PRINCIPLE>
|
||||
</CORE_PHILOSOPHY>
|
||||
|
||||
<MASTER_WORKFLOW name="Lint_And_Create_Pull_Request_Cycle">
|
||||
<WORKFLOW_STEP id="1" name="Find_And_Acknowledge_Task">
|
||||
<LET name="WorkOrder" value="CALL MyTaskChannel.FindNextTask(RoleName='agent-linter', TaskType='type::linting')"/>
|
||||
<IF condition="WorkOrder IS NULL">
|
||||
<TERMINATE/>
|
||||
</IF>
|
||||
<ACTION>CALL MyTaskChannel.UpdateTaskStatus(IssueID={WorkOrder.ID}, OldStatus='status::pending', NewStatus='status::in-progress')</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="2" name="Prepare_And_Execute_Linting">
|
||||
<ACTION>Извлечь из тела `WorkOrder` блок `<LINTING_TASK>` и определить `MODE` и `TARGET`.</ACTION>
|
||||
<LET name="BranchName">chore/{WorkOrder.ID}/semantic-linting-{MODE}</LET>
|
||||
<ACTION>CALL MyTaskChannel.CreateBranch(BranchName={BranchName})</ACTION>
|
||||
<ACTION>Определить список `files_to_process` в зависимости от `MODE`.</ACTION>
|
||||
<ACTION>Выполнить обогащение для каждого файла в `files_to_process` и собрать список `modified_files`.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="3" name="Commit_And_Create_PR">
|
||||
<IF condition="modified_files IS NOT EMPTY">
|
||||
<ACTION>Сформировать коммит: `chore(lint): apply semantic enrichment\n\nFiles modified: {count}`</ACTION>
|
||||
<ACTION>CALL MyTaskChannel.CommitChanges(CommitMessage=...)</ACTION>
|
||||
<LET name="PrID" value="CALL MyTaskChannel.CreatePullRequest(Title='chore(lint): Semantic Enrichment', Body='Closes #{WorkOrder.ID}', HeadBranch={BranchName}, BaseBranch='main')"/>
|
||||
<ACTION>CALL MyTaskChannel.AddComment(IssueID={WorkOrder.ID}, CommentBody='Linting complete. Pull Request #{PrID} created for review.')</ACTION>
|
||||
</IF>
|
||||
<ELSE>
|
||||
<ACTION>CALL MyTaskChannel.AddComment(IssueID={WorkOrder.ID}, CommentBody='Linting complete. No semantic violations found.')</ACTION>
|
||||
</ELSE>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="4" name="Finalize_Task">
|
||||
<ACTION>CALL MyTaskChannel.UpdateTaskStatus(IssueID={WorkOrder.ID}, OldStatus='status::in-progress', NewStatus='status::completed')</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
|
||||
<WORKFLOW_STEP id="5" name="Log_Execution_Metrics">
|
||||
<ACTION>Собрать и отправить метрики через `MyMetricsSink`.</ACTION>
|
||||
</WORKFLOW_STEP>
|
||||
</MASTER_WORKFLOW>
|
||||
</AI_AGENT_SEMANTIC_LINTER_PROTOCOL>
|
||||
55
agent_promts/shared/metrics_catalog.xml
Normal file
55
agent_promts/shared/metrics_catalog.xml
Normal file
@@ -0,0 +1,55 @@
|
||||
<!-- File: agent_promts/shared/metrics_catalog.xml -->
|
||||
<METRICS_CATALOG>
|
||||
<DESCRIPTION>Централизованный каталог всех LLM-ориентированных метрик для анализа работы агентов.</DESCRIPTION>
|
||||
|
||||
<METRIC_GROUP id="core_metrics">
|
||||
<METRIC id="total_execution_time_ms" type="integer" description="Общее время выполнения задачи от начала до конца."/>
|
||||
<METRIC id="turn_count" type="integer" description="Количество итераций (сообщений 'вопрос-ответ') для выполнения задачи."/>
|
||||
<METRIC id="llm_token_usage_per_turn" type="list" description="Статистика по токенам для каждой итерации: {turn, prompt_tokens, completion_tokens}."/>
|
||||
<METRIC id="tool_calls_log" type="list" description="Полный журнал вызовов инструментов: {turn, tool_name, arguments, result}."/>
|
||||
<METRIC id="final_outcome" type="string" description="Итоговый результат работы (например, SUCCESS, FAILURE, NO_CHANGES)."/>
|
||||
</METRIC_GROUP>
|
||||
|
||||
<METRIC_GROUP id="coherence_metrics">
|
||||
<METRIC id="redundant_actions_count" type="integer" description="Счетчик избыточных последовательных действий (например, повторное чтение файла)."/>
|
||||
<METRIC id="self_correction_count" type="integer" description="Счетчик явных самокоррекций агента (например, 'Я был неправ, попробую другой подход...')."/>
|
||||
</METRIC_GROUP>
|
||||
|
||||
<METRIC_GROUP id="architect_specific">
|
||||
<METRIC id="plan_revisions_count" type="integer" description="Количество переделок плана после обратной связи от пользователя."/>
|
||||
<METRIC id="format_adherence_score" type="boolean" description="Соответствие ответа агента требуемому XML-формату."/>
|
||||
</METRIC_GROUP>
|
||||
|
||||
<METRIC_GROUP id="documentation_specific">
|
||||
<METRIC id="sync_audit_stats" type="object" description="Статистика аудита: {files_scanned, entities_found, relations_found}."/>
|
||||
<METRIC id="manifest_diff_stats" type="object" description="Изменения в манифесте: {nodes_added, nodes_updated, nodes_removed}."/>
|
||||
</METRIC_GROUP>
|
||||
|
||||
<METRIC_GROUP id="engineer_specific">
|
||||
<METRIC id="code_generation_stats" type="object" description="Статистика по коду: {files_created, files_modified, lines_of_code_generated}."/>
|
||||
<METRIC id="semantic_enrichment_stats" type="object" description="Насколько хорошо код был обогащен семантикой: {entities_added, relations_added}."/>
|
||||
<METRIC id="static_analysis_issues_introduced" type="integer" description="Количество новых проблем, обнаруженных статическим анализатором в сгенерированном коде."/>
|
||||
<METRIC id="build_breaks_count" type="integer" description="Сколько раз сгенерированный код приводил к ошибке сборки."/>
|
||||
</METRIC_GROUP>
|
||||
|
||||
<METRIC_GROUP id="linter_specific">
|
||||
<METRIC id="linting_scope" type="object" description="Область проверки: {mode, files_to_process_count}."/>
|
||||
<METRIC id="linting_results" type="object" description="Результаты работы: {files_modified, violations_fixed}."/>
|
||||
</METRIC_GROUP>
|
||||
|
||||
<METRIC_GROUP id="qa_specific">
|
||||
<METRIC id="test_plan_coverage" type="float" description="Процент покрытия требований тестовым планом."/>
|
||||
<METRIC id="defects_found" type="integer" description="Количество найденных дефектов."/>
|
||||
<METRIC id="automated_tests_run" type="integer" description="Количество запущенных автоматизированных тестов."/>
|
||||
<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>
|
||||
@@ -54,6 +54,10 @@ android {
|
||||
excludes += "/META-INF/{AL2.0,LGPL2.1}"
|
||||
}
|
||||
}
|
||||
lint {
|
||||
checkReleaseBuilds = false
|
||||
abortOnError = false
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
@@ -87,6 +91,10 @@ dependencies {
|
||||
|
||||
// [DEPENDENCY] Testing
|
||||
testImplementation(Libs.junit)
|
||||
testImplementation(Libs.kotestRunnerJunit5)
|
||||
testImplementation(Libs.kotestAssertionsCore)
|
||||
testImplementation(Libs.mockk)
|
||||
testImplementation("app.cash.turbine:turbine:1.1.0")
|
||||
androidTestImplementation(Libs.extJunit)
|
||||
androidTestImplementation(Libs.espressoCore)
|
||||
androidTestImplementation(platform(Libs.composeBom))
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens
|
||||
// [FILE] MainActivity.kt
|
||||
// [SEMANTICS] android, activity, compose, hilt
|
||||
|
||||
// [SEMANTICS] app, ui, activity, entrypoint
|
||||
package com.homebox.lens
|
||||
|
||||
// [IMPORTS]
|
||||
@@ -18,33 +16,26 @@ import androidx.compose.ui.tooling.preview.Preview
|
||||
import com.homebox.lens.navigation.NavGraph
|
||||
import com.homebox.lens.ui.theme.HomeboxLensTheme
|
||||
import dagger.hilt.android.AndroidEntryPoint
|
||||
import timber.log.Timber
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Activity('MainActivity')]
|
||||
// [RELATION: Activity('MainActivity') -> [INHERITS_FROM] -> Class('ComponentActivity')]
|
||||
// [RELATION: Activity('MainActivity') -> [DEPENDS_ON] -> Annotation('AndroidEntryPoint')]
|
||||
/**
|
||||
* [ENTITY: Activity('MainActivity')]
|
||||
* [PURPOSE] Главная и единственная Activity в приложении.
|
||||
* @summary The main and only Activity in the application.
|
||||
*/
|
||||
@AndroidEntryPoint
|
||||
class MainActivity : ComponentActivity() {
|
||||
// [ENTITY: Function('onCreate')]
|
||||
// [RELATION: Function('onCreate') -> [CALLS] -> Function('super.onCreate')]
|
||||
// [RELATION: Function('onCreate') -> [CALLS] -> Function('setContent')]
|
||||
// [RELATION: Function('onCreate') -> [CALLS] -> Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('onCreate') -> [CALLS] -> Function('Surface')]
|
||||
// [RELATION: Function('onCreate') -> [CALLS] -> Function('NavGraph')]
|
||||
// [LIFECYCLE]
|
||||
// [RELATION: Function('onCreate')] -> [CALLS] -> [Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('onCreate')] -> [CALLS] -> [Function('NavGraph')]
|
||||
override fun onCreate(savedInstanceState: Bundle?) {
|
||||
super.onCreate(savedInstanceState)
|
||||
Timber.d("[DEBUG][LIFECYCLE][creating_activity] MainActivity created.")
|
||||
setContent {
|
||||
HomeboxLensTheme {
|
||||
// A surface container using the 'background' color from the theme
|
||||
Surface(
|
||||
modifier = Modifier.fillMaxSize(),
|
||||
color = MaterialTheme.colorScheme.background,
|
||||
color = MaterialTheme.colorScheme.background
|
||||
) {
|
||||
NavGraph()
|
||||
}
|
||||
@@ -56,23 +47,16 @@ class MainActivity : ComponentActivity() {
|
||||
// [END_ENTITY: Activity('MainActivity')]
|
||||
|
||||
// [ENTITY: Function('Greeting')]
|
||||
// [RELATION: Function('Greeting') -> [CALLS] -> Function('Text')]
|
||||
@Composable
|
||||
fun Greeting(
|
||||
name: String,
|
||||
modifier: Modifier = Modifier,
|
||||
) {
|
||||
fun Greeting(name: String, modifier: Modifier = Modifier) {
|
||||
Text(
|
||||
text = "Hello $name!",
|
||||
modifier = modifier,
|
||||
modifier = modifier
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('Greeting')]
|
||||
|
||||
// [ENTITY: Function('GreetingPreview')]
|
||||
// [RELATION: Function('GreetingPreview') -> [CALLS] -> Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('GreetingPreview') -> [CALLS] -> Function('Greeting')]
|
||||
// [PREVIEW]
|
||||
@Preview(showBackground = true)
|
||||
@Composable
|
||||
fun GreetingPreview() {
|
||||
@@ -82,5 +66,4 @@ fun GreetingPreview() {
|
||||
}
|
||||
// [END_ENTITY: Function('GreetingPreview')]
|
||||
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_MainActivity.kt]
|
||||
@@ -1,7 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens
|
||||
// [FILE] MainApplication.kt
|
||||
// [SEMANTICS] android, application, hilt, timber
|
||||
|
||||
// [SEMANTICS] app, hilt, timber, entrypoint
|
||||
package com.homebox.lens
|
||||
|
||||
// [IMPORTS]
|
||||
@@ -10,30 +8,22 @@ import dagger.hilt.android.HiltAndroidApp
|
||||
import timber.log.Timber
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Application('MainApplication')]
|
||||
// [RELATION: Application('MainApplication') -> [INHERITS_FROM] -> Class('Application')]
|
||||
// [RELATION: Application('MainApplication') -> [DEPENDS_ON] -> Annotation('HiltAndroidApp')]
|
||||
/**
|
||||
* [ENTITY: Application('MainApplication')]
|
||||
* [PURPOSE] Точка входа в приложение. Инициализирует Hilt и Timber.
|
||||
* @summary The entry point of the application. Initializes Hilt and Timber.
|
||||
*/
|
||||
@HiltAndroidApp
|
||||
class MainApplication : Application() {
|
||||
|
||||
// [ENTITY: Function('onCreate')]
|
||||
// [RELATION: Function('onCreate') -> [CALLS] -> Function('super.onCreate')]
|
||||
// [RELATION: Function('onCreate') -> [CALLS] -> Function('Timber.plant')]
|
||||
// [LIFECYCLE]
|
||||
override fun onCreate() {
|
||||
super.onCreate()
|
||||
// [ACTION] Initialize Timber for logging
|
||||
if (BuildConfig.DEBUG) {
|
||||
Timber.plant(Timber.DebugTree())
|
||||
Timber.d("[DEBUG][INITIALIZATION][timber_planted] Timber DebugTree planted.")
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('onCreate')]
|
||||
}
|
||||
// [END_ENTITY: Application('MainApplication')]
|
||||
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_MainApplication.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.navigation
|
||||
// [FILE] NavGraph.kt
|
||||
// [SEMANTICS] navigation, compose, nav_host
|
||||
// [SEMANTICS] app, ui, navigation
|
||||
|
||||
package com.homebox.lens.navigation
|
||||
|
||||
@@ -9,74 +8,54 @@ import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.remember
|
||||
import androidx.navigation.NavHostController
|
||||
import androidx.navigation.NavType
|
||||
import androidx.navigation.compose.NavHost
|
||||
import androidx.navigation.compose.composable
|
||||
import androidx.navigation.compose.currentBackStackEntryAsState
|
||||
import androidx.navigation.compose.rememberNavController
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.compose.runtime.collectAsState
|
||||
import com.homebox.lens.domain.model.Item
|
||||
import androidx.navigation.navArgument
|
||||
import com.homebox.lens.ui.screen.dashboard.DashboardScreen
|
||||
import com.homebox.lens.ui.screen.inventorylist.InventoryListScreen
|
||||
import com.homebox.lens.ui.screen.inventorylist.InventoryListViewModel
|
||||
import com.homebox.lens.ui.screen.itemdetails.ItemDetailsScreen
|
||||
import com.homebox.lens.ui.screen.itemdetails.ItemDetailsViewModel
|
||||
import com.homebox.lens.ui.screen.itemedit.ItemEditScreen
|
||||
import com.homebox.lens.ui.screen.itemedit.ItemEditViewModel
|
||||
import com.homebox.lens.ui.screen.labelslist.labelsListScreen
|
||||
import com.homebox.lens.ui.screen.labelslist.LabelsListViewModel
|
||||
import com.homebox.lens.ui.screen.labelslist.LabelsListScreen
|
||||
import com.homebox.lens.ui.screen.labeledit.LabelEditScreen
|
||||
import com.homebox.lens.ui.screen.locationedit.LocationEditScreen
|
||||
import com.homebox.lens.ui.screen.locationslist.LocationsListScreen
|
||||
import com.homebox.lens.ui.screen.search.SearchScreen
|
||||
import com.homebox.lens.ui.screen.search.SearchViewModel
|
||||
import com.homebox.lens.ui.screen.setup.SetupScreen
|
||||
import timber.log.Timber
|
||||
import com.homebox.lens.ui.screen.settings.SettingsScreen
|
||||
import com.homebox.lens.ui.screen.splash.SplashScreen
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('NavGraph')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('rememberNavController')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('currentBackStackEntryAsState')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('remember')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('hiltViewModel')]
|
||||
// [RELATION: Function('NavGraph') -> [CREATES_INSTANCE_OF] -> Class('NavigationActions')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('NavHost')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('composable')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('SetupScreen')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('DashboardScreen')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('InventoryListScreen')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('ItemDetailsScreen')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('ItemEditScreen')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('LabelsListScreen')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('LocationsListScreen')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('LocationEditScreen')]
|
||||
// [RELATION: Function('NavGraph') -> [CALLS] -> Function('SearchScreen')]
|
||||
// [RELATION: Function('NavGraph')] -> [DEPENDS_ON] -> [Framework('NavHostController')]
|
||||
// [RELATION: Function('NavGraph')] -> [CREATES_INSTANCE_OF] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('NavGraph')] -> [USES] -> [Screen('SplashScreen')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Определяет граф навигации для всего приложения с использованием 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(navController: NavHostController = rememberNavController()) {
|
||||
// [STATE]
|
||||
fun NavGraph(
|
||||
navController: NavHostController = rememberNavController()
|
||||
) {
|
||||
val navBackStackEntry by navController.currentBackStackEntryAsState()
|
||||
val currentRoute = navBackStackEntry?.destination?.route
|
||||
|
||||
// [HELPER]
|
||||
val navigationActions =
|
||||
remember(navController) {
|
||||
val navigationActions = remember(navController) {
|
||||
NavigationActions(navController)
|
||||
}
|
||||
|
||||
// [ACTION]
|
||||
NavHost(
|
||||
navController = navController,
|
||||
startDestination = Screen.Setup.route,
|
||||
startDestination = Screen.Splash.route
|
||||
) {
|
||||
// [ENTITY: Composable('Screen.Setup.route')]
|
||||
composable(route = Screen.Splash.route) {
|
||||
SplashScreen(navController = navController)
|
||||
}
|
||||
composable(route = Screen.Setup.route) {
|
||||
SetupScreen(onSetupComplete = {
|
||||
navController.navigate(Screen.Dashboard.route) {
|
||||
@@ -84,113 +63,91 @@ fun NavGraph(navController: NavHostController = rememberNavController()) {
|
||||
}
|
||||
})
|
||||
}
|
||||
// [END_ENTITY: Composable('Screen.Setup.route')]
|
||||
// [ENTITY: Composable('Screen.Dashboard.route')]
|
||||
composable(route = Screen.Dashboard.route) {
|
||||
DashboardScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Composable('Screen.Dashboard.route')]
|
||||
// [ENTITY: Composable('Screen.InventoryList.route')]
|
||||
composable(route = Screen.InventoryList.route) { backStackEntry ->
|
||||
val viewModel: InventoryListViewModel = hiltViewModel(backStackEntry)
|
||||
composable(route = Screen.InventoryList.route) {
|
||||
InventoryListScreen(
|
||||
onItemClick = { item ->
|
||||
// TODO: Navigate to item details
|
||||
Timber.i("[UI] Item clicked: ${item.name}")
|
||||
},
|
||||
onNavigateBack = {
|
||||
navController.popBackStack()
|
||||
}
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Composable('Screen.InventoryList.route')]
|
||||
// [ENTITY: Composable('Screen.ItemDetails.route')]
|
||||
composable(route = Screen.ItemDetails.route) { backStackEntry ->
|
||||
val viewModel: ItemDetailsViewModel = hiltViewModel(backStackEntry)
|
||||
composable(route = Screen.ItemDetails.route) {
|
||||
ItemDetailsScreen(
|
||||
onNavigateBack = {
|
||||
navController.popBackStack()
|
||||
},
|
||||
onEditClick = { itemId ->
|
||||
// TODO: Navigate to item edit screen
|
||||
Timber.i("[UI] Edit item clicked: $itemId")
|
||||
}
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Composable('Screen.ItemDetails.route')]
|
||||
// [ENTITY: Composable('Screen.ItemEdit.route')]
|
||||
composable(route = Screen.ItemEdit.route) { backStackEntry ->
|
||||
val viewModel: ItemEditViewModel = hiltViewModel(backStackEntry)
|
||||
composable(
|
||||
route = Screen.ItemEdit.route,
|
||||
arguments = listOf(navArgument("itemId") { nullable = true })
|
||||
) { backStackEntry ->
|
||||
val itemId = backStackEntry.arguments?.getString("itemId")
|
||||
ItemEditScreen(
|
||||
onNavigateBack = {
|
||||
navController.popBackStack()
|
||||
}
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions,
|
||||
itemId = itemId,
|
||||
onSaveSuccess = { navController.popBackStack() }
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Composable('Screen.ItemEdit.route')]
|
||||
// [ENTITY: Composable('Screen.LabelsList.route')]
|
||||
composable(Screen.LabelsList.route) { backStackEntry ->
|
||||
val viewModel: LabelsListViewModel = hiltViewModel(backStackEntry)
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
labelsListScreen(
|
||||
uiState = uiState,
|
||||
onLabelClick = { label ->
|
||||
// TODO: Implement navigation to label details screen
|
||||
Timber.i("[UI] Label clicked: ${label.name}")
|
||||
},
|
||||
onAddClick = {
|
||||
// TODO: Implement navigation to add new label screen
|
||||
Timber.i("[UI] Add new label clicked")
|
||||
},
|
||||
onNavigateBack = {
|
||||
navController.popBackStack()
|
||||
}
|
||||
composable(Screen.LabelsList.route) {
|
||||
LabelsListScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Composable('Screen.LabelsList.route')]
|
||||
// [ENTITY: Composable('Screen.LocationsList.route')]
|
||||
composable(route = Screen.LocationsList.route) {
|
||||
LocationsListScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions,
|
||||
onLocationClick = { locationId ->
|
||||
// TODO: Navigate to a pre-filtered inventory list screen
|
||||
// [AI_NOTE]: Navigate to a pre-filtered inventory list screen
|
||||
navController.navigate(Screen.InventoryList.route)
|
||||
},
|
||||
onAddNewLocationClick = {
|
||||
navController.navigate(Screen.LocationEdit.createRoute("new"))
|
||||
},
|
||||
}
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Composable('Screen.LocationsList.route')]
|
||||
// [ENTITY: Composable('Screen.LocationEdit.route')]
|
||||
composable(route = Screen.LocationEdit.route) { backStackEntry ->
|
||||
val locationId = backStackEntry.arguments?.getString("locationId")
|
||||
LocationEditScreen(
|
||||
locationId = locationId,
|
||||
locationId = locationId
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Composable('Screen.LocationEdit.route')]
|
||||
// [ENTITY: Composable('Screen.Search.route')]
|
||||
composable(route = Screen.Search.route) { backStackEntry ->
|
||||
val viewModel: SearchViewModel = hiltViewModel(backStackEntry)
|
||||
composable(route = Screen.LocationEdit.route) { backStackEntry ->
|
||||
val locationId = backStackEntry.arguments?.getString("locationId")
|
||||
LocationEditScreen(
|
||||
locationId = locationId
|
||||
)
|
||||
}
|
||||
composable(
|
||||
route = Screen.LabelEdit.route,
|
||||
arguments = listOf(navArgument("labelId") { nullable = true })
|
||||
) { backStackEntry ->
|
||||
val labelId = backStackEntry.arguments?.getString("labelId")
|
||||
LabelEditScreen(
|
||||
labelId = labelId,
|
||||
onBack = { navController.popBackStack() },
|
||||
onLabelSaved = { navController.popBackStack() }
|
||||
)
|
||||
}
|
||||
composable(route = Screen.Search.route) {
|
||||
SearchScreen(
|
||||
onNavigateBack = {
|
||||
navController.popBackStack()
|
||||
},
|
||||
onItemClick = { item ->
|
||||
// TODO: Navigate to item details
|
||||
Timber.i("[UI] Search result item clicked: ${item.name}")
|
||||
}
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
composable(route = Screen.Settings.route) {
|
||||
SettingsScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Composable('Screen.Search.route')]
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('NavGraph')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_NavGraph.kt]
|
||||
@@ -1,36 +1,29 @@
|
||||
// [PACKAGE] com.homebox.lens.navigation
|
||||
// [FILE] NavigationActions.kt
|
||||
// [SEMANTICS] navigation, controller, actions
|
||||
// [SEMANTICS] app, ui, navigation, actions
|
||||
package com.homebox.lens.navigation
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.navigation.NavHostController
|
||||
import timber.log.Timber
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Class('NavigationActions')]
|
||||
// [RELATION: Class('NavigationActions') -> [DEPENDS_ON] -> Class('NavHostController')]
|
||||
// [RELATION: Class('NavigationActions')] -> [DEPENDS_ON] -> [Framework('NavHostController')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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')]
|
||||
// [RELATION: Function('navigateToDashboard') -> [CALLS] -> Function('navController.navigate')]
|
||||
// [RELATION: Function('navigateToDashboard') -> [CALLS] -> Function('Screen.Dashboard.route')]
|
||||
// [RELATION: Function('navigateToDashboard') -> [CALLS] -> Function('popUpTo')]
|
||||
// [ACTION]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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.")
|
||||
navController.navigate(Screen.Dashboard.route) {
|
||||
// Используем popUpTo для удаления всех экранов до dashboard из back stack
|
||||
// Это предотвращает создание большой стопки экранов при навигации через drawer
|
||||
popUpTo(navController.graph.startDestinationId)
|
||||
launchSingleTop = true
|
||||
}
|
||||
@@ -38,10 +31,8 @@ class NavigationActions(private val navController: NavHostController) {
|
||||
// [END_ENTITY: Function('navigateToDashboard')]
|
||||
|
||||
// [ENTITY: Function('navigateToLocations')]
|
||||
// [RELATION: Function('navigateToLocations') -> [CALLS] -> Function('navController.navigate')]
|
||||
// [RELATION: Function('navigateToLocations') -> [CALLS] -> Function('Screen.LocationsList.route')]
|
||||
// [ACTION]
|
||||
fun navigateToLocations() {
|
||||
Timber.i("[INFO][ACTION][navigate_to_locations] Navigating to Locations.")
|
||||
navController.navigate(Screen.LocationsList.route) {
|
||||
launchSingleTop = true
|
||||
}
|
||||
@@ -49,21 +40,24 @@ class NavigationActions(private val navController: NavHostController) {
|
||||
// [END_ENTITY: Function('navigateToLocations')]
|
||||
|
||||
// [ENTITY: Function('navigateToLabels')]
|
||||
// [RELATION: Function('navigateToLabels') -> [CALLS] -> Function('navController.navigate')]
|
||||
// [RELATION: Function('navigateToLabels') -> [CALLS] -> Function('Screen.LabelsList.route')]
|
||||
// [ACTION]
|
||||
fun navigateToLabels() {
|
||||
Timber.i("[INFO][ACTION][navigate_to_labels] Navigating to Labels.")
|
||||
navController.navigate(Screen.LabelsList.route) {
|
||||
launchSingleTop = true
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('navigateToLabels')]
|
||||
|
||||
// [ENTITY: Function('navigateToLabelEdit')]
|
||||
fun navigateToLabelEdit(labelId: String? = null) {
|
||||
Timber.i("[INFO][ACTION][navigate_to_label_edit] Navigating to Label Edit with ID: %s", labelId)
|
||||
navController.navigate(Screen.LabelEdit.createRoute(labelId))
|
||||
}
|
||||
// [END_ENTITY: Function('navigateToLabelEdit')]
|
||||
|
||||
// [ENTITY: Function('navigateToSearch')]
|
||||
// [RELATION: Function('navigateToSearch') -> [CALLS] -> Function('navController.navigate')]
|
||||
// [RELATION: Function('navigateToSearch') -> [CALLS] -> Function('Screen.Search.route')]
|
||||
// [ACTION]
|
||||
fun navigateToSearch() {
|
||||
Timber.i("[INFO][ACTION][navigate_to_search] Navigating to Search.")
|
||||
navController.navigate(Screen.Search.route) {
|
||||
launchSingleTop = true
|
||||
}
|
||||
@@ -71,39 +65,31 @@ class NavigationActions(private val navController: NavHostController) {
|
||||
// [END_ENTITY: Function('navigateToSearch')]
|
||||
|
||||
// [ENTITY: Function('navigateToInventoryListWithLabel')]
|
||||
// [RELATION: Function('navigateToInventoryListWithLabel') -> [CALLS] -> Function('Screen.InventoryList.withFilter')]
|
||||
// [RELATION: Function('navigateToInventoryListWithLabel') -> [CALLS] -> Function('navController.navigate')]
|
||||
// [ACTION]
|
||||
fun navigateToInventoryListWithLabel(labelId: String) {
|
||||
Timber.i("[INFO][ACTION][navigate_to_inventory_with_label] Navigating to Inventory with label: %s", labelId)
|
||||
val route = Screen.InventoryList.withFilter("label", labelId)
|
||||
navController.navigate(route)
|
||||
}
|
||||
// [END_ENTITY: Function('navigateToInventoryListWithLabel')]
|
||||
|
||||
// [ENTITY: Function('navigateToInventoryListWithLocation')]
|
||||
// [RELATION: Function('navigateToInventoryListWithLocation') -> [CALLS] -> Function('Screen.InventoryList.withFilter')]
|
||||
// [RELATION: Function('navigateToInventoryListWithLocation') -> [CALLS] -> Function('navController.navigate')]
|
||||
// [ACTION]
|
||||
fun navigateToInventoryListWithLocation(locationId: String) {
|
||||
Timber.i("[INFO][ACTION][navigate_to_inventory_with_location] Navigating to Inventory with location: %s", locationId)
|
||||
val route = Screen.InventoryList.withFilter("location", locationId)
|
||||
navController.navigate(route)
|
||||
}
|
||||
// [END_ENTITY: Function('navigateToInventoryListWithLocation')]
|
||||
|
||||
// [ENTITY: Function('navigateToCreateItem')]
|
||||
// [RELATION: Function('navigateToCreateItem') -> [CALLS] -> Function('Screen.ItemEdit.createRoute')]
|
||||
// [RELATION: Function('navigateToCreateItem') -> [CALLS] -> Function('navController.navigate')]
|
||||
// [ACTION]
|
||||
fun navigateToCreateItem() {
|
||||
navController.navigate(Screen.ItemEdit.createRoute("new"))
|
||||
Timber.i("[INFO][ACTION][navigate_to_create_item] Navigating to Create Item.")
|
||||
navController.navigate(Screen.ItemEdit.createRoute())
|
||||
}
|
||||
// [END_ENTITY: Function('navigateToCreateItem')]
|
||||
|
||||
// [ENTITY: Function('navigateToLogout')]
|
||||
// [RELATION: Function('navigateToLogout') -> [CALLS] -> Function('navController.navigate')]
|
||||
// [RELATION: Function('navigateToLogout') -> [CALLS] -> Function('popUpTo')]
|
||||
// [ACTION]
|
||||
fun navigateToLogout() {
|
||||
Timber.i("[INFO][ACTION][navigate_to_logout] Navigating to Logout.")
|
||||
navController.navigate(Screen.Setup.route) {
|
||||
popUpTo(Screen.Dashboard.route) { inclusive = true }
|
||||
}
|
||||
@@ -111,13 +97,11 @@ class NavigationActions(private val navController: NavHostController) {
|
||||
// [END_ENTITY: Function('navigateToLogout')]
|
||||
|
||||
// [ENTITY: Function('navigateBack')]
|
||||
// [RELATION: Function('navigateBack') -> [CALLS] -> Function('navController.popBackStack')]
|
||||
// [ACTION]
|
||||
fun navigateBack() {
|
||||
Timber.i("[INFO][ACTION][navigate_back] Navigating back.")
|
||||
navController.popBackStack()
|
||||
}
|
||||
// [END_ENTITY: Function('navigateBack')]
|
||||
}
|
||||
// [END_ENTITY: Class('NavigationActions')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_NavigationActions.kt]
|
||||
@@ -1,138 +1,130 @@
|
||||
// [PACKAGE] com.homebox.lens.navigation
|
||||
// [FILE] Screen.kt
|
||||
// [SEMANTICS] navigation, routes, sealed_class
|
||||
// [SEMANTICS] app, ui, navigation, routes
|
||||
package com.homebox.lens.navigation
|
||||
|
||||
// [IMPORTS]
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: SealedClass('Screen')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Запечатанный класс для определения маршрутов навигации в приложении.
|
||||
* Обеспечивает типобезопасность при навигации.
|
||||
* @property 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: DataObject('Setup')]
|
||||
// [ENTITY: Object('Splash')]
|
||||
data object Splash : Screen("splash_screen")
|
||||
// [END_ENTITY: Object('Splash')]
|
||||
|
||||
// [ENTITY: Object('Setup')]
|
||||
data object Setup : Screen("setup_screen")
|
||||
// [END_ENTITY: DataObject('Setup')]
|
||||
// [END_ENTITY: Object('Setup')]
|
||||
|
||||
// [ENTITY: DataObject('Dashboard')]
|
||||
// [ENTITY: Object('Dashboard')]
|
||||
data object Dashboard : Screen("dashboard_screen")
|
||||
// [END_ENTITY: DataObject('Dashboard')]
|
||||
// [END_ENTITY: Object('Dashboard')]
|
||||
|
||||
// [ENTITY: DataObject('InventoryList')]
|
||||
// [ENTITY: Object('InventoryList')]
|
||||
data object InventoryList : Screen("inventory_list_screen") {
|
||||
// [ENTITY: Function('withFilter')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Создает маршрут для экрана списка инвентаря с параметром фильтра.
|
||||
* @param key Ключ фильтра (например, "label" или "location").
|
||||
* @param value Значение фильтра (например, ID метки или местоположения).
|
||||
* @return Строку полного маршрута с query-параметром.
|
||||
* @throws IllegalArgumentException если ключ или значение пустые.
|
||||
* @sideeffect [ARCH-IMPLICATION] NavGraph должен быть настроен для приема этого опционального query-параметра (например, 'navArgument("label") { nullable = true }').
|
||||
* @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 {
|
||||
// [PRECONDITION]
|
||||
require(key.isNotBlank()) { "[PRECONDITION_FAILED] Filter key cannot be blank." }
|
||||
require(value.isNotBlank()) { "[PRECONDITION_FAILED] Filter value cannot be blank." }
|
||||
// [ACTION]
|
||||
fun withFilter(key: String, value: String): String {
|
||||
require(key.isNotBlank()) { "Filter key cannot be blank." }
|
||||
require(value.isNotBlank()) { "Filter value cannot be blank." }
|
||||
val constructedRoute = "inventory_list_screen?$key=$value"
|
||||
// [POSTCONDITION]
|
||||
check(constructedRoute.contains("?$key=$value")) { "[POSTCONDITION_FAILED] Route must contain the filter query." }
|
||||
check(constructedRoute.contains("?$key=$value")) { "Route must contain the filter query." }
|
||||
return constructedRoute
|
||||
}
|
||||
// [END_ENTITY: Function('withFilter')]
|
||||
}
|
||||
// [END_ENTITY: DataObject('InventoryList')]
|
||||
// [END_ENTITY: Object('InventoryList')]
|
||||
|
||||
// [ENTITY: DataObject('ItemDetails')]
|
||||
// [ENTITY: Object('ItemDetails')]
|
||||
data object ItemDetails : Screen("item_details_screen/{itemId}") {
|
||||
// [ENTITY: Function('createRoute')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Создает маршрут для экрана деталей элемента с указанным 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 {
|
||||
// [PRECONDITION]
|
||||
require(itemId.isNotBlank()) { "[PRECONDITION_FAILED] itemId не может быть пустым." }
|
||||
// [ACTION]
|
||||
require(itemId.isNotBlank()) { "itemId не может быть пустым." }
|
||||
val route = "item_details_screen/$itemId"
|
||||
// [POSTCONDITION]
|
||||
check(route.endsWith(itemId)) { "[POSTCONDITION_FAILED] Маршрут должен заканчиваться на itemId." }
|
||||
check(route.endsWith(itemId)) { "Маршрут должен заканчиваться на itemId." }
|
||||
return route
|
||||
}
|
||||
// [END_ENTITY: Function('createRoute')]
|
||||
}
|
||||
// [END_ENTITY: DataObject('ItemDetails')]
|
||||
// [END_ENTITY: Object('ItemDetails')]
|
||||
|
||||
// [ENTITY: DataObject('ItemEdit')]
|
||||
data object ItemEdit : Screen("item_edit_screen/{itemId}") {
|
||||
// [ENTITY: Object('ItemEdit')]
|
||||
data object ItemEdit : Screen("item_edit_screen?itemId={itemId}") {
|
||||
// [ENTITY: Function('createRoute')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Создает маршрут для экрана редактирования элемента с указанным ID.
|
||||
* @param itemId ID элемента для редактирования.
|
||||
* @return Строку полного маршрута.
|
||||
* @throws IllegalArgumentException если itemId пустой.
|
||||
* @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): String {
|
||||
// [PRECONDITION]
|
||||
require(itemId.isNotBlank()) { "[PRECONDITION_FAILED] itemId не может быть пустым." }
|
||||
// [ACTION]
|
||||
val route = "item_edit_screen/$itemId"
|
||||
// [POSTCONDITION]
|
||||
check(route.endsWith(itemId)) { "[POSTCONDITION_FAILED] Маршрут должен заканчиваться на itemId." }
|
||||
return route
|
||||
fun createRoute(itemId: String? = null): String {
|
||||
return itemId?.let { "item_edit_screen?itemId=$it" } ?: "item_edit_screen"
|
||||
}
|
||||
// [END_ENTITY: Function('createRoute')]
|
||||
}
|
||||
// [END_ENTITY: DataObject('ItemEdit')]
|
||||
// [END_ENTITY: Object('ItemEdit')]
|
||||
|
||||
// [ENTITY: DataObject('LabelsList')]
|
||||
// [ENTITY: Object('LabelsList')]
|
||||
data object LabelsList : Screen("labels_list_screen")
|
||||
// [END_ENTITY: DataObject('LabelsList')]
|
||||
// [END_ENTITY: Object('LabelsList')]
|
||||
|
||||
// [ENTITY: DataObject('LocationsList')]
|
||||
// [ENTITY: Object('LabelEdit')]
|
||||
data object LabelEdit : Screen("label_edit_screen?labelId={labelId}") {
|
||||
// [ENTITY: Function('createRoute')]
|
||||
/**
|
||||
* @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"
|
||||
}
|
||||
// [END_ENTITY: Function('createRoute')]
|
||||
}
|
||||
// [END_ENTITY: Object('LabelEdit')]
|
||||
|
||||
// [ENTITY: Object('LocationsList')]
|
||||
data object LocationsList : Screen("locations_list_screen")
|
||||
// [END_ENTITY: DataObject('LocationsList')]
|
||||
// [END_ENTITY: Object('LocationsList')]
|
||||
|
||||
// [ENTITY: DataObject('LocationEdit')]
|
||||
// [ENTITY: Object('LocationEdit')]
|
||||
data object LocationEdit : Screen("location_edit_screen/{locationId}") {
|
||||
// [ENTITY: Function('createRoute')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Создает маршрут для экрана редактирования местоположения с указанным 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 {
|
||||
// [PRECONDITION]
|
||||
require(locationId.isNotBlank()) { "[PRECONDITION_FAILED] locationId не может быть пустым." }
|
||||
// [ACTION]
|
||||
require(locationId.isNotBlank()) { "locationId не может быть пустым." }
|
||||
val route = "location_edit_screen/$locationId"
|
||||
// [POSTCONDITION]
|
||||
check(route.endsWith(locationId)) { "[POSTCONDITION_FAILED] Маршрут должен заканчиваться на locationId." }
|
||||
check(route.endsWith(locationId)) { "Маршрут должен заканчиваться на locationId." }
|
||||
return route
|
||||
}
|
||||
// [END_ENTITY: Function('createRoute')]
|
||||
}
|
||||
// [END_ENTITY: DataObject('LocationEdit')]
|
||||
// [END_ENTITY: Object('LocationEdit')]
|
||||
|
||||
// [ENTITY: DataObject('Search')]
|
||||
// [ENTITY: Object('Search')]
|
||||
data object Search : Screen("search_screen")
|
||||
// [END_ENTITY: DataObject('Search')]
|
||||
// [END_ENTITY: Object('Search')]
|
||||
|
||||
// [ENTITY: Object('Settings')]
|
||||
data object Settings : Screen("settings_screen")
|
||||
// [END_ENTITY: Object('Settings')]
|
||||
}
|
||||
// [END_ENTITY: SealedClass('Screen')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_Screen.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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]
|
||||
@@ -27,35 +26,19 @@ import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.navigation.Screen
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('AppDrawerContent')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [DEPENDS_ON] -> Class('NavigationActions')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('ModalDrawerSheet')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Spacer')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Button')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Divider')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('NavigationDrawerItem')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Screen.Dashboard.route')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Screen.LocationsList.route')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Screen.LabelsList.route')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Screen.Search.route')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Screen.ItemEdit.createRoute')]
|
||||
// [RELATION: Function('AppDrawerContent') -> [CALLS] -> Function('Screen.Setup.route')]
|
||||
// [RELATION: Function('AppDrawerContent')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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(
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions,
|
||||
onCloseDrawer: () -> Unit,
|
||||
onCloseDrawer: () -> Unit
|
||||
) {
|
||||
ModalDrawerSheet {
|
||||
Spacer(Modifier.height(12.dp))
|
||||
@@ -64,10 +47,9 @@ internal fun AppDrawerContent(
|
||||
navigationActions.navigateToCreateItem()
|
||||
onCloseDrawer()
|
||||
},
|
||||
modifier =
|
||||
Modifier
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(horizontal = 16.dp),
|
||||
.padding(horizontal = 16.dp)
|
||||
) {
|
||||
Icon(Icons.Default.Add, contentDescription = null, modifier = Modifier.size(18.dp))
|
||||
Spacer(Modifier.width(8.dp))
|
||||
@@ -81,7 +63,7 @@ internal fun AppDrawerContent(
|
||||
onClick = {
|
||||
navigationActions.navigateToDashboard()
|
||||
onCloseDrawer()
|
||||
},
|
||||
}
|
||||
)
|
||||
NavigationDrawerItem(
|
||||
label = { Text(stringResource(id = R.string.nav_locations)) },
|
||||
@@ -89,7 +71,7 @@ internal fun AppDrawerContent(
|
||||
onClick = {
|
||||
navigationActions.navigateToLocations()
|
||||
onCloseDrawer()
|
||||
},
|
||||
}
|
||||
)
|
||||
NavigationDrawerItem(
|
||||
label = { Text(stringResource(id = R.string.nav_labels)) },
|
||||
@@ -97,7 +79,7 @@ internal fun AppDrawerContent(
|
||||
onClick = {
|
||||
navigationActions.navigateToLabels()
|
||||
onCloseDrawer()
|
||||
},
|
||||
}
|
||||
)
|
||||
NavigationDrawerItem(
|
||||
label = { Text(stringResource(id = R.string.search)) },
|
||||
@@ -105,9 +87,9 @@ internal fun AppDrawerContent(
|
||||
onClick = {
|
||||
navigationActions.navigateToSearch()
|
||||
onCloseDrawer()
|
||||
},
|
||||
}
|
||||
)
|
||||
// TODO: Add Profile and Tools items
|
||||
// [AI_NOTE]: Add Profile and Tools items
|
||||
Divider()
|
||||
NavigationDrawerItem(
|
||||
label = { Text(stringResource(id = R.string.logout)) },
|
||||
@@ -115,10 +97,9 @@ internal fun AppDrawerContent(
|
||||
onClick = {
|
||||
navigationActions.navigateToLogout()
|
||||
onCloseDrawer()
|
||||
},
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('AppDrawerContent')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_AppDrawer.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -17,29 +16,18 @@ import com.homebox.lens.navigation.NavigationActions
|
||||
import kotlinx.coroutines.launch
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('MainScaffold')]
|
||||
// [RELATION: Function('MainScaffold') -> [DEPENDS_ON] -> Class('NavigationActions')]
|
||||
// [RELATION: Function('MainScaffold') -> [CALLS] -> Function('rememberDrawerState')]
|
||||
// [RELATION: Function('MainScaffold') -> [CALLS] -> Function('rememberCoroutineScope')]
|
||||
// [RELATION: Function('MainScaffold') -> [CALLS] -> Function('ModalNavigationDrawer')]
|
||||
// [RELATION: Function('MainScaffold') -> [CALLS] -> Function('AppDrawerContent')]
|
||||
// [RELATION: Function('MainScaffold') -> [CALLS] -> Function('Scaffold')]
|
||||
// [RELATION: Function('MainScaffold') -> [CALLS] -> Function('TopAppBar')]
|
||||
// [RELATION: Function('MainScaffold') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('MainScaffold') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('MainScaffold') -> [CALLS] -> Function('IconButton')]
|
||||
// [RELATION: Function('MainScaffold') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('MainScaffold')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('MainScaffold')] -> [CALLS] -> [Function('AppDrawerContent')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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
|
||||
@@ -48,22 +36,20 @@ fun MainScaffold(
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions,
|
||||
topBarActions: @Composable () -> Unit = {},
|
||||
content: @Composable (PaddingValues) -> Unit,
|
||||
content: @Composable (PaddingValues) -> Unit
|
||||
) {
|
||||
// [STATE]
|
||||
val drawerState = rememberDrawerState(initialValue = DrawerValue.Closed)
|
||||
val scope = rememberCoroutineScope()
|
||||
|
||||
// [CORE-LOGIC]
|
||||
ModalNavigationDrawer(
|
||||
drawerState = drawerState,
|
||||
drawerContent = {
|
||||
AppDrawerContent(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions,
|
||||
onCloseDrawer = { scope.launch { drawerState.close() } },
|
||||
onCloseDrawer = { scope.launch { drawerState.close() } }
|
||||
)
|
||||
},
|
||||
}
|
||||
) {
|
||||
Scaffold(
|
||||
topBar = {
|
||||
@@ -73,19 +59,17 @@ fun MainScaffold(
|
||||
IconButton(onClick = { scope.launch { drawerState.open() } }) {
|
||||
Icon(
|
||||
Icons.Default.Menu,
|
||||
contentDescription = stringResource(id = R.string.cd_open_navigation_drawer),
|
||||
contentDescription = stringResource(id = R.string.cd_open_navigation_drawer)
|
||||
)
|
||||
}
|
||||
},
|
||||
actions = { topBarActions() },
|
||||
actions = { topBarActions() }
|
||||
)
|
||||
},
|
||||
}
|
||||
) { paddingValues ->
|
||||
// [ACTION]
|
||||
content(paddingValues)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('MainScaffold')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_MainScaffold.kt]
|
||||
@@ -0,0 +1,75 @@
|
||||
// [FILE] ColorPicker.kt
|
||||
// [SEMANTICS] app, ui, component, color
|
||||
|
||||
package com.homebox.lens.ui.components
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.background
|
||||
import androidx.compose.foundation.border
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.*
|
||||
import androidx.compose.foundation.shape.CircleShape
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.graphics.Color
|
||||
import androidx.compose.ui.graphics.toArgb
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import com.homebox.lens.R
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('ColorPicker')]
|
||||
/**
|
||||
* @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(
|
||||
selectedColor: String,
|
||||
onColorSelected: (String) -> Unit,
|
||||
modifier: Modifier = Modifier
|
||||
) {
|
||||
Column(modifier = modifier) {
|
||||
Text(text = stringResource(R.string.label_color), style = MaterialTheme.typography.bodyLarge)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
horizontalArrangement = Arrangement.SpaceBetween
|
||||
) {
|
||||
Box(
|
||||
modifier = Modifier
|
||||
.size(48.dp)
|
||||
.background(
|
||||
if (selectedColor.isEmpty()) Color.Transparent else Color(android.graphics.Color.parseColor(selectedColor)),
|
||||
CircleShape
|
||||
)
|
||||
.border(2.dp, MaterialTheme.colorScheme.onSurface, CircleShape)
|
||||
.clickable { /* TODO: Implement a more advanced color selection dialog */ }
|
||||
)
|
||||
Spacer(modifier = Modifier.width(16.dp))
|
||||
OutlinedTextField(
|
||||
value = selectedColor,
|
||||
onValueChange = { newValue ->
|
||||
// Basic validation for hex color
|
||||
if (newValue.matches(Regex("^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"))) {
|
||||
onColorSelected(newValue)
|
||||
} else if (newValue.isEmpty() || newValue == "#") {
|
||||
onColorSelected("#FFFFFF") // Default to white if input is cleared
|
||||
}
|
||||
},
|
||||
label = { Text(stringResource(R.string.label_hex_color)) },
|
||||
singleLine = true,
|
||||
modifier = Modifier.weight(1f)
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('ColorPicker')]
|
||||
// [END_FILE_ColorPicker.kt]
|
||||
@@ -0,0 +1,34 @@
|
||||
// [FILE] LoadingOverlay.kt
|
||||
// [SEMANTICS] app, ui, component, loading
|
||||
|
||||
package com.homebox.lens.ui.components
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.background
|
||||
import androidx.compose.foundation.layout.Box
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.material3.CircularProgressIndicator
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.graphics.Color
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('LoadingOverlay')]
|
||||
/**
|
||||
* @summary A full-screen overlay with a loading indicator.
|
||||
*/
|
||||
@Composable
|
||||
fun LoadingOverlay() {
|
||||
Box(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.background(MaterialTheme.colorScheme.surface.copy(alpha = 0.6f)),
|
||||
contentAlignment = Alignment.Center
|
||||
) {
|
||||
CircularProgressIndicator()
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LoadingOverlay')]
|
||||
// [END_FILE_LoadingOverlay.kt]
|
||||
62
app/src/main/java/com/homebox/lens/ui/mapper/ItemMapper.kt
Normal file
62
app/src/main/java/com/homebox/lens/ui/mapper/ItemMapper.kt
Normal file
@@ -0,0 +1,62 @@
|
||||
// [FILE] ItemMapper.kt
|
||||
// [SEMANTICS] app, ui, mapper, item
|
||||
package com.homebox.lens.ui.mapper
|
||||
|
||||
import com.homebox.lens.domain.model.Item
|
||||
import com.homebox.lens.domain.model.ItemOut
|
||||
import com.homebox.lens.domain.model.Label
|
||||
import com.homebox.lens.domain.model.Location
|
||||
import javax.inject.Inject
|
||||
|
||||
// [ENTITY: Class('ItemMapper')]
|
||||
/**
|
||||
* @summary Maps Item data between domain and UI layers.
|
||||
* @invariant This class is stateless and its methods are pure functions.
|
||||
*/
|
||||
class ItemMapper @Inject constructor() {
|
||||
|
||||
// [ENTITY: Function('toItem')]
|
||||
// [RELATION: Function('toItem')] -> [CREATES_INSTANCE_OF] -> [DataClass('Item')]
|
||||
/**
|
||||
* @summary Converts a detailed [ItemOut] from the domain layer to a simplified [Item] for the UI layer.
|
||||
* @param itemOut The [ItemOut] object to convert.
|
||||
* @return The resulting [Item] object.
|
||||
* @precondition itemOut MUST NOT be null.
|
||||
* @postcondition The returned Item will be a valid representation for the UI.
|
||||
*/
|
||||
fun toItem(itemOut: ItemOut): Item {
|
||||
return Item(
|
||||
id = itemOut.id,
|
||||
name = itemOut.name,
|
||||
description = itemOut.description,
|
||||
quantity = itemOut.quantity,
|
||||
image = itemOut.images.firstOrNull { it.isPrimary }?.path,
|
||||
location = itemOut.location?.let { Location(it.id, it.name) },
|
||||
labels = itemOut.labels.map { Label(it.id, it.name) },
|
||||
purchasePrice = itemOut.purchasePrice,
|
||||
createdAt = itemOut.createdAt,
|
||||
archived = itemOut.isArchived,
|
||||
assetId = itemOut.assetId,
|
||||
fields = itemOut.fields.map { com.homebox.lens.domain.model.CustomField(it.name, it.value, it.type) },
|
||||
insured = itemOut.insured ?: false,
|
||||
lifetimeWarranty = itemOut.lifetimeWarranty ?: false,
|
||||
manufacturer = itemOut.manufacturer,
|
||||
modelNumber = itemOut.modelNumber,
|
||||
notes = itemOut.notes,
|
||||
parentId = itemOut.parent?.id,
|
||||
purchaseFrom = itemOut.purchaseFrom,
|
||||
purchaseTime = itemOut.purchaseTime,
|
||||
serialNumber = itemOut.serialNumber,
|
||||
soldNotes = itemOut.soldNotes,
|
||||
soldPrice = itemOut.soldPrice,
|
||||
soldTime = itemOut.soldTime,
|
||||
soldTo = itemOut.soldTo,
|
||||
syncChildItemsLocations = itemOut.syncChildItemsLocations ?: false,
|
||||
warrantyDetails = itemOut.warrantyDetails,
|
||||
warrantyExpires = itemOut.warrantyExpires
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toItem')]
|
||||
}
|
||||
// [END_ENTITY: Class('ItemMapper')]
|
||||
// [END_FILE_ItemMapper.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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]
|
||||
@@ -32,34 +31,24 @@ import com.homebox.lens.ui.theme.HomeboxLensTheme
|
||||
import timber.log.Timber
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('DashboardScreen')]
|
||||
// [RELATION: Function('DashboardScreen') -> [DEPENDS_ON] -> Class('DashboardViewModel')]
|
||||
// [RELATION: Function('DashboardScreen') -> [DEPENDS_ON] -> Class('NavigationActions')]
|
||||
// [RELATION: Function('DashboardScreen') -> [CALLS] -> Function('hiltViewModel')]
|
||||
// [RELATION: Function('DashboardScreen') -> [CALLS] -> Function('collectAsState')]
|
||||
// [RELATION: Function('DashboardScreen') -> [CALLS] -> Function('MainScaffold')]
|
||||
// [RELATION: Function('DashboardScreen') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('DashboardScreen') -> [CALLS] -> Function('IconButton')]
|
||||
// [RELATION: Function('DashboardScreen') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('DashboardScreen') -> [CALLS] -> Function('DashboardContent')]
|
||||
// [RELATION: Function('DashboardScreen')] -> [DEPENDS_ON] -> [ViewModel('DashboardViewModel')]
|
||||
// [RELATION: Function('DashboardScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('DashboardScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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(
|
||||
viewModel: DashboardViewModel = hiltViewModel(),
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions,
|
||||
navigationActions: NavigationActions
|
||||
) {
|
||||
// [STATE]
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
// [UI_COMPONENT]
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.dashboard_title),
|
||||
currentRoute = currentRoute,
|
||||
@@ -68,55 +57,43 @@ fun DashboardScreen(
|
||||
IconButton(onClick = { navigationActions.navigateToSearch() }) {
|
||||
Icon(
|
||||
Icons.Default.Search,
|
||||
contentDescription = stringResource(id = R.string.cd_scan_qr_code), // TODO: Rename string resource
|
||||
contentDescription = stringResource(id = R.string.cd_scan_qr_code) // [AI_NOTE]: Rename string resource
|
||||
)
|
||||
}
|
||||
},
|
||||
}
|
||||
) { paddingValues ->
|
||||
DashboardContent(
|
||||
modifier = Modifier.padding(paddingValues),
|
||||
uiState = uiState,
|
||||
onLocationClick = { location ->
|
||||
Timber.i("[ACTION] Location chip clicked: ${location.id}. Navigating...")
|
||||
Timber.i("[INFO][ACTION][navigate_to_inventory_with_location] Location chip clicked: ${location.id}. Navigating...")
|
||||
navigationActions.navigateToInventoryListWithLocation(location.id)
|
||||
},
|
||||
onLabelClick = { label ->
|
||||
Timber.i("[ACTION] Label chip clicked: ${label.id}. Navigating...")
|
||||
Timber.i("[INFO][ACTION][navigate_to_inventory_with_label] Label chip clicked: ${label.id}. Navigating...")
|
||||
navigationActions.navigateToInventoryListWithLabel(label.id)
|
||||
},
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('DashboardScreen')]
|
||||
|
||||
// [ENTITY: Function('DashboardContent')]
|
||||
// [RELATION: Function('DashboardContent') -> [DEPENDS_ON] -> SealedInterface('DashboardUiState')]
|
||||
// [RELATION: Function('DashboardContent') -> [CALLS] -> Function('Box')]
|
||||
// [RELATION: Function('DashboardContent') -> [CALLS] -> Function('CircularProgressIndicator')]
|
||||
// [RELATION: Function('DashboardContent') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('DashboardContent') -> [CALLS] -> Function('MaterialTheme.colorScheme.error')]
|
||||
// [RELATION: Function('DashboardContent') -> [CALLS] -> Function('LazyColumn')]
|
||||
// [RELATION: Function('DashboardContent') -> [CALLS] -> Function('Spacer')]
|
||||
// [RELATION: Function('DashboardContent') -> [CALLS] -> Function('StatisticsSection')]
|
||||
// [RELATION: Function('DashboardContent') -> [CALLS] -> Function('RecentlyAddedSection')]
|
||||
// [RELATION: Function('DashboardContent') -> [CALLS] -> Function('LocationsSection')]
|
||||
// [RELATION: Function('DashboardContent') -> [CALLS] -> Function('LabelsSection')]
|
||||
// [RELATION: Function('DashboardContent')] -> [CONSUMES_STATE] -> [SealedInterface('DashboardUiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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(
|
||||
modifier: Modifier = Modifier,
|
||||
uiState: DashboardUiState,
|
||||
onLocationClick: (LocationOutCount) -> Unit,
|
||||
onLabelClick: (LabelOut) -> Unit,
|
||||
onLabelClick: (LabelOut) -> Unit
|
||||
) {
|
||||
// [CORE-LOGIC]
|
||||
when (uiState) {
|
||||
is DashboardUiState.Loading -> {
|
||||
Box(modifier = Modifier.fillMaxSize(), contentAlignment = Alignment.Center) {
|
||||
@@ -128,17 +105,16 @@ private fun DashboardContent(
|
||||
Text(
|
||||
text = uiState.message,
|
||||
color = MaterialTheme.colorScheme.error,
|
||||
textAlign = TextAlign.Center,
|
||||
textAlign = TextAlign.Center
|
||||
)
|
||||
}
|
||||
}
|
||||
is DashboardUiState.Success -> {
|
||||
LazyColumn(
|
||||
modifier =
|
||||
modifier
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.padding(horizontal = 16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(24.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(24.dp)
|
||||
) {
|
||||
item { Spacer(modifier = Modifier.height(8.dp)) }
|
||||
item { StatisticsSection(statistics = uiState.statistics) }
|
||||
@@ -153,62 +129,32 @@ private fun DashboardContent(
|
||||
// [END_ENTITY: Function('DashboardContent')]
|
||||
|
||||
// [ENTITY: Function('StatisticsSection')]
|
||||
// [RELATION: Function('StatisticsSection') -> [DEPENDS_ON] -> Class('GroupStatistics')]
|
||||
// [RELATION: Function('StatisticsSection') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('StatisticsSection') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('StatisticsSection') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('StatisticsSection') -> [CALLS] -> Function('MaterialTheme.typography.titleMedium')]
|
||||
// [RELATION: Function('StatisticsSection') -> [CALLS] -> Function('Card')]
|
||||
// [RELATION: Function('StatisticsSection') -> [CALLS] -> Function('LazyVerticalGrid')]
|
||||
// [RELATION: Function('StatisticsSection') -> [CALLS] -> Function('GridCells.Fixed')]
|
||||
// [RELATION: Function('StatisticsSection') -> [CALLS] -> Function('StatisticCard')]
|
||||
// [RELATION: Function('StatisticsSection')] -> [DEPENDS_ON] -> [DataClass('GroupStatistics')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @summary Секция для отображения общей статистики.
|
||||
* @param statistics Объект со статистическими данными.
|
||||
* @summary Section for displaying general statistics.
|
||||
* @param statistics The object with statistical data.
|
||||
*/
|
||||
@Composable
|
||||
private fun StatisticsSection(statistics: GroupStatistics) {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.dashboard_section_quick_stats),
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
style = MaterialTheme.typography.titleMedium
|
||||
)
|
||||
Card {
|
||||
LazyVerticalGrid(
|
||||
columns = GridCells.Fixed(2),
|
||||
modifier =
|
||||
Modifier
|
||||
modifier = Modifier
|
||||
.height(120.dp)
|
||||
.fillMaxWidth()
|
||||
.padding(16.dp),
|
||||
horizontalArrangement = Arrangement.spacedBy(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(16.dp)
|
||||
) {
|
||||
item {
|
||||
StatisticCard(
|
||||
title = stringResource(id = R.string.dashboard_stat_total_items),
|
||||
value = statistics.items.toString(),
|
||||
)
|
||||
}
|
||||
item {
|
||||
StatisticCard(
|
||||
title = stringResource(id = R.string.dashboard_stat_total_value),
|
||||
value = statistics.totalValue.toString(),
|
||||
)
|
||||
}
|
||||
item {
|
||||
StatisticCard(
|
||||
title = stringResource(id = R.string.dashboard_stat_total_labels),
|
||||
value = statistics.labels.toString(),
|
||||
)
|
||||
}
|
||||
item {
|
||||
StatisticCard(
|
||||
title = stringResource(id = R.string.dashboard_stat_total_locations),
|
||||
value = statistics.locations.toString(),
|
||||
)
|
||||
}
|
||||
item { StatisticCard(title = stringResource(id = R.string.dashboard_stat_total_items), value = statistics.items.toString()) }
|
||||
item { StatisticCard(title = stringResource(id = R.string.dashboard_stat_total_value), value = statistics.totalValue.toString()) }
|
||||
item { StatisticCard(title = stringResource(id = R.string.dashboard_stat_total_labels), value = statistics.labels.toString()) }
|
||||
item { StatisticCard(title = stringResource(id = R.string.dashboard_stat_total_locations), value = statistics.locations.toString()) }
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -216,21 +162,13 @@ private fun StatisticsSection(statistics: GroupStatistics) {
|
||||
// [END_ENTITY: Function('StatisticsSection')]
|
||||
|
||||
// [ENTITY: Function('StatisticCard')]
|
||||
// [RELATION: Function('StatisticCard') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('StatisticCard') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('StatisticCard') -> [CALLS] -> Function('MaterialTheme.typography.labelMedium')]
|
||||
// [RELATION: Function('StatisticCard') -> [CALLS] -> Function('MaterialTheme.typography.headlineSmall')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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,
|
||||
) {
|
||||
private fun StatisticCard(title: String, value: String) {
|
||||
Column(horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.Center) {
|
||||
Text(text = title, style = MaterialTheme.typography.labelMedium, textAlign = TextAlign.Center)
|
||||
Text(text = value, style = MaterialTheme.typography.headlineSmall, textAlign = TextAlign.Center)
|
||||
@@ -239,34 +177,26 @@ private fun StatisticCard(
|
||||
// [END_ENTITY: Function('StatisticCard')]
|
||||
|
||||
// [ENTITY: Function('RecentlyAddedSection')]
|
||||
// [RELATION: Function('RecentlyAddedSection') -> [DEPENDS_ON] -> Class('ItemSummary')]
|
||||
// [RELATION: Function('RecentlyAddedSection') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('RecentlyAddedSection') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('RecentlyAddedSection') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('RecentlyAddedSection') -> [CALLS] -> Function('MaterialTheme.typography.titleMedium')]
|
||||
// [RELATION: Function('RecentlyAddedSection') -> [CALLS] -> Function('LazyRow')]
|
||||
// [RELATION: Function('RecentlyAddedSection') -> [CALLS] -> Function('ItemCard')]
|
||||
// [RELATION: Function('RecentlyAddedSection')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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>) {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.dashboard_section_recently_added),
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
style = MaterialTheme.typography.titleMedium
|
||||
)
|
||||
if (items.isEmpty()) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.items_not_found),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
modifier =
|
||||
Modifier
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(vertical = 16.dp),
|
||||
textAlign = TextAlign.Center,
|
||||
textAlign = TextAlign.Center
|
||||
)
|
||||
} else {
|
||||
LazyRow(horizontalArrangement = Arrangement.spacedBy(16.dp)) {
|
||||
@@ -280,67 +210,42 @@ private fun RecentlyAddedSection(items: List<ItemSummary>) {
|
||||
// [END_ENTITY: Function('RecentlyAddedSection')]
|
||||
|
||||
// [ENTITY: Function('ItemCard')]
|
||||
// [RELATION: Function('ItemCard') -> [DEPENDS_ON] -> Class('ItemSummary')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('Card')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('Spacer')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('MaterialTheme.typography.titleSmall')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('MaterialTheme.typography.bodySmall')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('ItemCard')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @summary Карточка для отображения краткой информации об элементе.
|
||||
* @param item Элемент для отображения.
|
||||
* @summary Card for displaying brief information about an item.
|
||||
* @param item The item to display.
|
||||
*/
|
||||
@Composable
|
||||
private fun ItemCard(item: ItemSummary) {
|
||||
Card(modifier = Modifier.width(150.dp)) {
|
||||
Column(modifier = Modifier.padding(8.dp)) {
|
||||
// TODO: Add image here from item.image
|
||||
Spacer(
|
||||
modifier =
|
||||
Modifier
|
||||
// [AI_NOTE]: Add image here from item.image
|
||||
Spacer(modifier = Modifier
|
||||
.height(80.dp)
|
||||
.fillMaxWidth()
|
||||
.background(MaterialTheme.colorScheme.secondaryContainer),
|
||||
)
|
||||
.background(MaterialTheme.colorScheme.secondaryContainer))
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
Text(text = item.name, style = MaterialTheme.typography.titleSmall, maxLines = 1)
|
||||
Text(
|
||||
text = item.location?.name ?: stringResource(id = R.string.no_location),
|
||||
style = MaterialTheme.typography.bodySmall,
|
||||
maxLines = 1,
|
||||
)
|
||||
Text(text = item.location?.name ?: stringResource(id = R.string.no_location), style = MaterialTheme.typography.bodySmall, maxLines = 1)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('ItemCard')]
|
||||
|
||||
// [ENTITY: Function('LocationsSection')]
|
||||
// [RELATION: Function('LocationsSection') -> [DEPENDS_ON] -> Class('LocationOutCount')]
|
||||
// [RELATION: Function('LocationsSection') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('LocationsSection') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('LocationsSection') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('LocationsSection') -> [CALLS] -> Function('MaterialTheme.typography.titleMedium')]
|
||||
// [RELATION: Function('LocationsSection') -> [CALLS] -> Function('FlowRow')]
|
||||
// [RELATION: Function('LocationsSection') -> [CALLS] -> Function('SuggestionChip')]
|
||||
// [RELATION: Function('LocationsSection')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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
|
||||
private fun LocationsSection(
|
||||
locations: List<LocationOutCount>,
|
||||
onLocationClick: (LocationOutCount) -> Unit,
|
||||
) {
|
||||
private fun LocationsSection(locations: List<LocationOutCount>, onLocationClick: (LocationOutCount) -> Unit) {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.dashboard_section_locations),
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
style = MaterialTheme.typography.titleMedium
|
||||
)
|
||||
FlowRow(
|
||||
horizontalArrangement = Arrangement.spacedBy(8.dp),
|
||||
@@ -348,7 +253,7 @@ private fun LocationsSection(
|
||||
locations.forEach { location ->
|
||||
SuggestionChip(
|
||||
onClick = { onLocationClick(location) },
|
||||
label = { Text(stringResource(id = R.string.location_chip_label, location.name, location.itemCount)) },
|
||||
label = { Text(stringResource(id = R.string.location_chip_label, location.name, location.itemCount)) }
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -357,29 +262,19 @@ private fun LocationsSection(
|
||||
// [END_ENTITY: Function('LocationsSection')]
|
||||
|
||||
// [ENTITY: Function('LabelsSection')]
|
||||
// [RELATION: Function('LabelsSection') -> [DEPENDS_ON] -> Class('LabelOut')]
|
||||
// [RELATION: Function('LabelsSection') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('LabelsSection') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('LabelsSection') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('LabelsSection') -> [CALLS] -> Function('MaterialTheme.typography.titleMedium')]
|
||||
// [RELATION: Function('LabelsSection') -> [CALLS] -> Function('FlowRow')]
|
||||
// [RELATION: Function('LabelsSection') -> [CALLS] -> Function('SuggestionChip')]
|
||||
// [RELATION: Function('LabelsSection')] -> [DEPENDS_ON] -> [DataClass('LabelOut')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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
|
||||
private fun LabelsSection(
|
||||
labels: List<LabelOut>,
|
||||
onLabelClick: (LabelOut) -> Unit,
|
||||
) {
|
||||
private fun LabelsSection(labels: List<LabelOut>, onLabelClick: (LabelOut) -> Unit) {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.dashboard_section_labels),
|
||||
style = MaterialTheme.typography.titleMedium,
|
||||
style = MaterialTheme.typography.titleMedium
|
||||
)
|
||||
FlowRow(
|
||||
horizontalArrangement = Arrangement.spacedBy(8.dp),
|
||||
@@ -387,7 +282,7 @@ private fun LabelsSection(
|
||||
labels.forEach { label ->
|
||||
SuggestionChip(
|
||||
onClick = { onLabelClick(label) },
|
||||
label = { Text(label.name) },
|
||||
label = { Text(label.name) }
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -396,97 +291,42 @@ private fun LabelsSection(
|
||||
// [END_ENTITY: Function('LabelsSection')]
|
||||
|
||||
// [ENTITY: Function('DashboardContentSuccessPreview')]
|
||||
// [RELATION: Function('DashboardContentSuccessPreview') -> [CALLS] -> Function('DashboardUiState.Success')]
|
||||
// [RELATION: Function('DashboardContentSuccessPreview') -> [CALLS] -> Function('GroupStatistics')]
|
||||
// [RELATION: Function('DashboardContentSuccessPreview') -> [CALLS] -> Function('LocationOutCount')]
|
||||
// [RELATION: Function('DashboardContentSuccessPreview') -> [CALLS] -> Function('LabelOut')]
|
||||
// [RELATION: Function('DashboardContentSuccessPreview') -> [CALLS] -> Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('DashboardContentSuccessPreview') -> [CALLS] -> Function('DashboardContent')]
|
||||
// [PREVIEW]
|
||||
@Preview(showBackground = true, name = "Dashboard Success State")
|
||||
@Composable
|
||||
fun DashboardContentSuccessPreview() {
|
||||
val previewState =
|
||||
DashboardUiState.Success(
|
||||
statistics =
|
||||
GroupStatistics(
|
||||
val previewState = DashboardUiState.Success(
|
||||
statistics = GroupStatistics(
|
||||
items = 123,
|
||||
totalValue = 9999.99,
|
||||
locations = 5,
|
||||
labels = 8,
|
||||
labels = 8
|
||||
),
|
||||
locations =
|
||||
listOf(
|
||||
LocationOutCount(
|
||||
id = "1",
|
||||
name = "Office",
|
||||
color = "#FF0000",
|
||||
isArchived = false,
|
||||
itemCount = 10,
|
||||
createdAt = "",
|
||||
updatedAt = "",
|
||||
locations = listOf(
|
||||
LocationOutCount(id="1", name="Office", color = "#FF0000", isArchived = false, itemCount = 10, createdAt = "", updatedAt = ""),
|
||||
LocationOutCount(id="2", name="Garage", color = "#00FF00", isArchived = false, itemCount = 5, createdAt = "", updatedAt = ""),
|
||||
LocationOutCount(id="3",name="Living Room", color = "#0000FF", isArchived = false, itemCount = 15, createdAt = "", updatedAt = ""),
|
||||
LocationOutCount(id="4",name="Kitchen", color = "#FFFF00", isArchived = false, itemCount = 20, createdAt = "", updatedAt = ""),
|
||||
LocationOutCount(id="5",name="Basement", color = "#00FFFF", isArchived = false, itemCount = 3, createdAt = "", updatedAt = "")
|
||||
),
|
||||
LocationOutCount(
|
||||
id = "2",
|
||||
name = "Garage",
|
||||
color = "#00FF00",
|
||||
isArchived = false,
|
||||
itemCount = 5,
|
||||
createdAt = "",
|
||||
updatedAt = "",
|
||||
labels = listOf(
|
||||
LabelOut(id="1", name="electronics", description = null, color = "#FF0000", isArchived = false, createdAt = "", updatedAt = ""),
|
||||
LabelOut(id="2", name="important", description = null, color = "#00FF00", isArchived = false, createdAt = "", updatedAt = ""),
|
||||
LabelOut(id="3", name="seasonal", description = null, color = "#0000FF", isArchived = false, createdAt = "", updatedAt = ""),
|
||||
LabelOut(id="4", name="hobby", description = null, color = "#FFFF00", isArchived = false, createdAt = "", updatedAt = "")
|
||||
),
|
||||
LocationOutCount(
|
||||
id = "3",
|
||||
name = "Living Room",
|
||||
color = "#0000FF",
|
||||
isArchived = false,
|
||||
itemCount = 15,
|
||||
createdAt = "",
|
||||
updatedAt = "",
|
||||
),
|
||||
LocationOutCount(
|
||||
id = "4",
|
||||
name = "Kitchen",
|
||||
color = "#FFFF00",
|
||||
isArchived = false,
|
||||
itemCount = 20,
|
||||
createdAt = "",
|
||||
updatedAt = "",
|
||||
),
|
||||
LocationOutCount(
|
||||
id = "5",
|
||||
name = "Basement",
|
||||
color = "#00FFFF",
|
||||
isArchived = false,
|
||||
itemCount = 3,
|
||||
createdAt = "",
|
||||
updatedAt = "",
|
||||
),
|
||||
),
|
||||
labels =
|
||||
listOf(
|
||||
LabelOut(id = "1", name = "electronics", color = "#FF0000", isArchived = false, createdAt = "", updatedAt = ""),
|
||||
LabelOut(id = "2", name = "important", color = "#00FF00", isArchived = false, createdAt = "", updatedAt = ""),
|
||||
LabelOut(id = "3", name = "seasonal", color = "#0000FF", isArchived = false, createdAt = "", updatedAt = ""),
|
||||
LabelOut(id = "4", name = "hobby", color = "#FFFF00", isArchived = false, createdAt = "", updatedAt = ""),
|
||||
),
|
||||
recentlyAddedItems = emptyList(),
|
||||
recentlyAddedItems = emptyList()
|
||||
)
|
||||
HomeboxLensTheme {
|
||||
DashboardContent(
|
||||
uiState = previewState,
|
||||
onLocationClick = {},
|
||||
onLabelClick = {},
|
||||
onLabelClick = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('DashboardContentSuccessPreview')]
|
||||
|
||||
// [ENTITY: Function('DashboardContentLoadingPreview')]
|
||||
// [RELATION: Function('DashboardContentLoadingPreview') -> [CALLS] -> Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('DashboardContentLoadingPreview') -> [CALLS] -> Function('DashboardContent')]
|
||||
// [RELATION: Function('DashboardContentLoadingPreview') -> [CALLS] -> Function('DashboardUiState.Loading')]
|
||||
// [PREVIEW]
|
||||
@Preview(showBackground = true, name = "Dashboard Loading State")
|
||||
@Composable
|
||||
fun DashboardContentLoadingPreview() {
|
||||
@@ -494,18 +334,13 @@ fun DashboardContentLoadingPreview() {
|
||||
DashboardContent(
|
||||
uiState = DashboardUiState.Loading,
|
||||
onLocationClick = {},
|
||||
onLabelClick = {},
|
||||
onLabelClick = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('DashboardContentLoadingPreview')]
|
||||
|
||||
// [ENTITY: Function('DashboardContentErrorPreview')]
|
||||
// [RELATION: Function('DashboardContentErrorPreview') -> [CALLS] -> Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('DashboardContentErrorPreview') -> [CALLS] -> Function('DashboardContent')]
|
||||
// [RELATION: Function('DashboardContentErrorPreview') -> [CALLS] -> Function('DashboardUiState.Error')]
|
||||
// [RELATION: Function('DashboardContentErrorPreview') -> [CALLS] -> Function('stringResource')]
|
||||
// [PREVIEW]
|
||||
@Preview(showBackground = true, name = "Dashboard Error State")
|
||||
@Composable
|
||||
fun DashboardContentErrorPreview() {
|
||||
@@ -513,10 +348,9 @@ fun DashboardContentErrorPreview() {
|
||||
DashboardContent(
|
||||
uiState = DashboardUiState.Error(stringResource(id = R.string.error_loading_failed)),
|
||||
onLocationClick = {},
|
||||
onLabelClick = {},
|
||||
onLabelClick = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('DashboardContentErrorPreview')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_DashboardScreen.kt]
|
||||
@@ -1,62 +1,54 @@
|
||||
// [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]
|
||||
import com.homebox.lens.domain.model.GroupStatistics
|
||||
import com.homebox.lens.domain.model.ItemSummary
|
||||
import com.homebox.lens.domain.model.LabelOut
|
||||
import com.homebox.lens.domain.model.LocationOutCount
|
||||
import com.homebox.lens.domain.model.ItemSummary
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: SealedInterface('DashboardUiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Определяет все возможные состояния для экрана "Дэшборд".
|
||||
* @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')]
|
||||
// [RELATION: DataClass('Success') -> [DEPENDS_ON] -> Class('GroupStatistics')]
|
||||
// [RELATION: DataClass('Success') -> [DEPENDS_ON] -> Class('LocationOutCount')]
|
||||
// [RELATION: DataClass('Success') -> [DEPENDS_ON] -> Class('LabelOut')]
|
||||
// [RELATION: DataClass('Success') -> [DEPENDS_ON] -> Class('ItemSummary')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('GroupStatistics')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('LabelOut')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Состояние успешной загрузки данных.
|
||||
* @property statistics Статистика по инвентарю.
|
||||
* @property locations Список локаций со счетчиками.
|
||||
* @property labels Список всех меток.
|
||||
* @property 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,
|
||||
val locations: List<LocationOutCount>,
|
||||
val labels: List<LabelOut>,
|
||||
val recentlyAddedItems: List<ItemSummary>,
|
||||
val recentlyAddedItems: List<ItemSummary>
|
||||
) : DashboardUiState
|
||||
// [END_ENTITY: DataClass('Success')]
|
||||
|
||||
// [ENTITY: DataClass('Error')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Состояние ошибки во время загрузки данных.
|
||||
* @property 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: DataObject('Loading')]
|
||||
// [ENTITY: Object('Loading')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Состояние, когда данные для экрана загружаются.
|
||||
* @summary The state when data for the screen is being loaded.
|
||||
*/
|
||||
object Loading : DashboardUiState
|
||||
// [END_ENTITY: DataObject('Loading')]
|
||||
data object Loading : DashboardUiState
|
||||
// [END_ENTITY: Object('Loading')]
|
||||
}
|
||||
// [END_ENTITY: SealedInterface('DashboardUiState')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_DashboardUiState.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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]
|
||||
@@ -17,67 +16,44 @@ import timber.log.Timber
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: ViewModel('DashboardViewModel')]
|
||||
// [RELATION: ViewModel('DashboardViewModel') -> [INHERITS_FROM] -> Class('ViewModel')]
|
||||
// [RELATION: ViewModel('DashboardViewModel') -> [DEPENDS_ON] -> Annotation('HiltViewModel')]
|
||||
// [RELATION: ViewModel('DashboardViewModel') -> [DEPENDS_ON] -> Class('GetStatisticsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel') -> [DEPENDS_ON] -> Class('GetAllLocationsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel') -> [DEPENDS_ON] -> Class('GetAllLabelsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel') -> [DEPENDS_ON] -> Class('GetRecentlyAddedItemsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetStatisticsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLocationsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLabelsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetRecentlyAddedItemsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [EMITS_STATE] -> [SealedInterface('DashboardUiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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(
|
||||
class DashboardViewModel @Inject constructor(
|
||||
private val getStatisticsUseCase: GetStatisticsUseCase,
|
||||
private val getAllLocationsUseCase: GetAllLocationsUseCase,
|
||||
private val getAllLabelsUseCase: GetAllLabelsUseCase,
|
||||
private val getRecentlyAddedItemsUseCase: GetRecentlyAddedItemsUseCase,
|
||||
) : ViewModel() {
|
||||
// [STATE]
|
||||
private val _uiState = MutableStateFlow<DashboardUiState>(DashboardUiState.Loading)
|
||||
private val getRecentlyAddedItemsUseCase: GetRecentlyAddedItemsUseCase
|
||||
) : ViewModel() {
|
||||
|
||||
// [FIX] Добавлен получатель (receiver) `_uiState` для вызова asStateFlow().
|
||||
// [REASON] `asStateFlow()` является функцией-расширением для `MutableStateFlow` и
|
||||
// должна вызываться на его экземпляре, чтобы создать публичную, неизменяемую версию потока.
|
||||
private val _uiState = MutableStateFlow<DashboardUiState>(DashboardUiState.Loading)
|
||||
val uiState = _uiState.asStateFlow()
|
||||
|
||||
// [LIFECYCLE_HANDLER]
|
||||
init {
|
||||
loadDashboardData()
|
||||
}
|
||||
|
||||
// [ENTITY: Function('loadDashboardData')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('viewModelScope.launch')]
|
||||
// [RELATION: Function('loadDashboardData') -> [WRITES_TO] -> Property('_uiState')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('Timber.i')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('flow')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('getStatisticsUseCase')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('getAllLocationsUseCase')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('getAllLabelsUseCase')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('getRecentlyAddedItemsUseCase')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('combine')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('catch')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('Timber.e')]
|
||||
// [RELATION: Function('loadDashboardData') -> [CALLS] -> Function('collect')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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 {
|
||||
_uiState.value = DashboardUiState.Loading
|
||||
Timber.i("[ACTION] Starting dashboard data collection.")
|
||||
Timber.i("[INFO][ENTRYPOINT][loading_dashboard_data] Starting dashboard data collection.")
|
||||
|
||||
val statsFlow = flow { emit(getStatisticsUseCase()) }
|
||||
val locationsFlow = flow { emit(getAllLocationsUseCase()) }
|
||||
@@ -89,22 +65,20 @@ class DashboardViewModel
|
||||
statistics = stats,
|
||||
locations = locations,
|
||||
labels = labels,
|
||||
recentlyAddedItems = recentItems,
|
||||
recentlyAddedItems = recentItems
|
||||
)
|
||||
}.catch { exception ->
|
||||
Timber.e(exception, "[ERROR] Failed to load dashboard data. State -> Error.")
|
||||
_uiState.value =
|
||||
DashboardUiState.Error(
|
||||
message = exception.message ?: "Could not load dashboard data.",
|
||||
Timber.e(exception, "[ERROR][EXCEPTION][loading_failed] Failed to load dashboard data. State -> Error.")
|
||||
_uiState.value = DashboardUiState.Error(
|
||||
message = exception.message ?: "Could not load dashboard data."
|
||||
)
|
||||
}.collect { successState ->
|
||||
Timber.i("[SUCCESS] Dashboard data loaded successfully. State -> Success.")
|
||||
Timber.i("[INFO][SUCCESS][dashboard_data_loaded] Dashboard data loaded successfully. State -> Success.")
|
||||
_uiState.value = successState
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('loadDashboardData')]
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: ViewModel('DashboardViewModel')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_DashboardViewModel.kt]
|
||||
@@ -1,219 +1,38 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.inventorylist
|
||||
// [FILE] InventoryListScreen.kt
|
||||
// [SEMANTICS] ui, screen, inventory, list, compose
|
||||
// [SEMANTICS] app, ui, screen, list
|
||||
|
||||
package com.homebox.lens.ui.screen.inventorylist
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.Box
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.automirrored.filled.ArrowBack
|
||||
import androidx.compose.material.icons.filled.Refresh
|
||||
import androidx.compose.material.icons.filled.Search
|
||||
import androidx.compose.material3.Card
|
||||
import androidx.compose.material3.CircularProgressIndicator
|
||||
import androidx.compose.material3.ExperimentalMaterial3Api
|
||||
import androidx.compose.material3.FloatingActionButton
|
||||
import androidx.compose.material3.Icon
|
||||
import androidx.compose.material3.IconButton
|
||||
import androidx.compose.material3.Scaffold
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.material3.TextField
|
||||
import androidx.compose.material3.TopAppBar
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.collectAsState
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.domain.model.Item
|
||||
import timber.log.Timber
|
||||
import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.ui.common.MainScaffold
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('InventoryListScreen')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [DEPENDS_ON] -> Class('InventoryListViewModel')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('hiltViewModel')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('collectAsState')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('Scaffold')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('TopAppBar')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('IconButton')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('FloatingActionButton')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('SearchBar')]
|
||||
// [RELATION: Function('InventoryListScreen') -> [CALLS] -> Function('InventoryListContent')]
|
||||
// [RELATION: Function('InventoryListScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('InventoryListScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* [MAIN-CONTRACT]
|
||||
* Экран для отображения списка инвентарных позиций.
|
||||
*
|
||||
* Реализует спецификацию `screen_inventory_list`. Позволяет просматривать,
|
||||
* искать и синхронизировать инвентарь.
|
||||
*
|
||||
* @param onItemClick Обработчик нажатия на элемент инвентаря.
|
||||
* @param onNavigateBack Обработчик для возврата на предыдущий экран.
|
||||
* @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.
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
fun InventoryListScreen(
|
||||
viewModel: InventoryListViewModel = hiltViewModel(),
|
||||
onItemClick: (Item) -> Unit,
|
||||
onNavigateBack: () -> Unit
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions
|
||||
) {
|
||||
// [STATE]
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
// [ACTION]
|
||||
Scaffold(
|
||||
topBar = {
|
||||
TopAppBar(
|
||||
title = { Text(stringResource(id = R.string.inventory_list_title)) }, // Corrected string resource name
|
||||
navigationIcon = {
|
||||
IconButton(onClick = onNavigateBack) {
|
||||
Icon(
|
||||
imageVector = Icons.AutoMirrored.Filled.ArrowBack,
|
||||
contentDescription = stringResource(id = R.string.content_desc_navigate_back)
|
||||
)
|
||||
}
|
||||
}
|
||||
)
|
||||
},
|
||||
floatingActionButton = {
|
||||
FloatingActionButton(onClick = {
|
||||
Timber.i("[INFO][ACTION][ui_interaction] Sync inventory triggered.")
|
||||
viewModel.onSyncClicked()
|
||||
}) {
|
||||
Icon(
|
||||
imageVector = Icons.Filled.Refresh,
|
||||
contentDescription = stringResource(id = R.string.content_desc_sync_inventory)
|
||||
)
|
||||
}
|
||||
}
|
||||
) { innerPadding ->
|
||||
// [DELEGATES]
|
||||
Column(modifier = Modifier.padding(innerPadding)) {
|
||||
SearchBar(
|
||||
query = uiState.searchQuery,
|
||||
onQueryChange = viewModel::onSearchQueryChanged
|
||||
)
|
||||
InventoryListContent(
|
||||
isLoading = uiState.isLoading,
|
||||
items = uiState.items,
|
||||
onItemClick = onItemClick
|
||||
)
|
||||
}
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.inventory_list_title),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) {
|
||||
// [AI_NOTE]: Implement Inventory List Screen UI
|
||||
Text(text = "Inventory List Screen")
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('InventoryListScreen')]
|
||||
|
||||
// [ENTITY: Function('SearchBar')]
|
||||
// [RELATION: Function('SearchBar') -> [CALLS] -> Function('TextField')]
|
||||
// [RELATION: Function('SearchBar') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('SearchBar') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('SearchBar') -> [CALLS] -> Function('Icon')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Поле для ввода поискового запроса.
|
||||
*/
|
||||
@Composable
|
||||
private fun SearchBar(query: String, onQueryChange: (String) -> Unit) {
|
||||
TextField(
|
||||
value = query,
|
||||
onValueChange = onQueryChange,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(8.dp),
|
||||
placeholder = { Text(stringResource(id = R.string.search)) }, // Corrected string resource name
|
||||
leadingIcon = { Icon(Icons.Default.Search, contentDescription = null) }
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('SearchBar')]
|
||||
|
||||
// [ENTITY: Function('InventoryListContent')]
|
||||
// [RELATION: Function('InventoryListContent') -> [CALLS] -> Function('Box')]
|
||||
// [RELATION: Function('InventoryListContent') -> [CALLS] -> Function('CircularProgressIndicator')]
|
||||
// [RELATION: Function('InventoryListContent') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('InventoryListContent') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('InventoryListContent') -> [CALLS] -> Function('LazyColumn')]
|
||||
// [RELATION: Function('InventoryListContent') -> [CALLS] -> Function('ItemCard')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Основной контент: индикатор загрузки или список предметов.
|
||||
*/
|
||||
@Composable
|
||||
private fun InventoryListContent(
|
||||
isLoading: Boolean,
|
||||
items: List<Item>,
|
||||
onItemClick: (Item) -> Unit
|
||||
) {
|
||||
Box(modifier = Modifier.fillMaxSize()) {
|
||||
if (isLoading) {
|
||||
// [STATE]
|
||||
CircularProgressIndicator(modifier = Modifier.align(Alignment.Center))
|
||||
} else if (items.isEmpty()) {
|
||||
// [FALLBACK]
|
||||
Text(
|
||||
text = stringResource(id = R.string.items_not_found),
|
||||
modifier = Modifier.align(Alignment.Center)
|
||||
)
|
||||
} else {
|
||||
// [CORE-LOGIC]
|
||||
LazyColumn {
|
||||
items(items, key = { it.id }) { item ->
|
||||
ItemCard(item = item, onClick = {
|
||||
Timber.i("[INFO][ACTION][ui_interaction] Item clicked: ${item.name}")
|
||||
onItemClick(item)
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('InventoryListContent')]
|
||||
|
||||
// [ENTITY: Function('ItemCard')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('Card')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('ItemCard') -> [CALLS] -> Function('clickable')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Карточка для отображения одного элемента инвентаря.
|
||||
*/
|
||||
@Composable
|
||||
private fun ItemCard(
|
||||
item: Item,
|
||||
onClick: () -> Unit
|
||||
) {
|
||||
// [PRECONDITION]
|
||||
require(item.name.isNotBlank()) { "Item name cannot be blank." }
|
||||
|
||||
// [CORE-LOGIC]
|
||||
Card(
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(horizontal = 8.dp, vertical = 4.dp)
|
||||
.clickable(onClick = onClick)
|
||||
) {
|
||||
Column(modifier = Modifier.padding(16.dp)) {
|
||||
Text(text = item.name, style = androidx.compose.material3.MaterialTheme.typography.titleMedium)
|
||||
Text(text = "Quantity: ${item.quantity.toString()}", style = androidx.compose.material3.MaterialTheme.typography.bodySmall)
|
||||
item.location?.let {
|
||||
Text(text = "Location: ${it.name}", style = androidx.compose.material3.MaterialTheme.typography.bodySmall)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('ItemCard')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_InventoryListScreen.kt]
|
||||
@@ -1,53 +1,20 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.inventorylist
|
||||
// [FILE] InventoryListViewModel.kt
|
||||
// [SEMANTICS] ui_logic, inventory_list, viewmodel
|
||||
|
||||
// [SEMANTICS] app, ui, viewmodel, list
|
||||
package com.homebox.lens.ui.screen.inventorylist
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import javax.inject.Inject
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import com.homebox.lens.domain.model.Item
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: ViewModel('InventoryListViewModel')]
|
||||
// [RELATION: ViewModel('InventoryListViewModel') -> [INHERITS_FROM] -> Class('ViewModel')]
|
||||
// [RELATION: ViewModel('InventoryListViewModel') -> [DEPENDS_ON] -> Annotation('HiltViewModel')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @summary ViewModel for the InventoryListScreen.
|
||||
* @summary ViewModel for the inventory list screen.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class InventoryListViewModel
|
||||
@Inject
|
||||
constructor() : ViewModel() {
|
||||
// [STATE]
|
||||
private val _uiState = MutableStateFlow(InventoryListUiState())
|
||||
val uiState: StateFlow<InventoryListUiState> = _uiState.asStateFlow()
|
||||
|
||||
fun onSyncClicked() {
|
||||
// TODO: Implement sync logic
|
||||
}
|
||||
|
||||
fun onSearchQueryChanged(query: String) {
|
||||
// TODO: Implement search query change logic
|
||||
}
|
||||
}
|
||||
class InventoryListViewModel @Inject constructor() : ViewModel() {
|
||||
// [AI_NOTE]: Implement UI state
|
||||
}
|
||||
// [END_ENTITY: ViewModel('InventoryListViewModel')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_InventoryListViewModel.kt]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: DataClass('InventoryListUiState')]
|
||||
// [RELATION: DataClass('InventoryListUiState') -> [DEPENDS_ON] -> Class('Item')]
|
||||
data class InventoryListUiState(
|
||||
val searchQuery: String = "",
|
||||
val isLoading: Boolean = false,
|
||||
val items: List<Item> = emptyList()
|
||||
)
|
||||
// [END_ENTITY: DataClass('InventoryListUiState')]
|
||||
@@ -1,208 +1,38 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.itemdetails
|
||||
// [FILE] ItemDetailsScreen.kt
|
||||
// [SEMANTICS] ui, screen, item, details, compose
|
||||
// [SEMANTICS] app, ui, screen, details
|
||||
|
||||
package com.homebox.lens.ui.screen.itemdetails
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.layout.*
|
||||
import androidx.compose.foundation.rememberScrollState
|
||||
import androidx.compose.foundation.verticalScroll
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.automirrored.filled.ArrowBack
|
||||
import androidx.compose.material.icons.filled.Delete
|
||||
import androidx.compose.material.icons.filled.Edit
|
||||
import androidx.compose.material3.*
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.collectAsState
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.domain.model.Item
|
||||
import timber.log.Timber
|
||||
import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.ui.common.MainScaffold
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('ItemDetailsScreen')]
|
||||
// [RELATION: Function('ItemDetailsScreen') -> [DEPENDS_ON] -> Class('ItemDetailsViewModel')]
|
||||
// [RELATION: Function('ItemDetailsScreen') -> [CALLS] -> Function('hiltViewModel')]
|
||||
// [RELATION: Function('ItemDetailsScreen') -> [CALLS] -> Function('collectAsState')]
|
||||
// [RELATION: Function('ItemDetailsScreen') -> [CALLS] -> Function('Scaffold')]
|
||||
// [RELATION: Function('ItemDetailsScreen') -> [CALLS] -> Function('TopAppBar')]
|
||||
// [RELATION: Function('ItemDetailsScreen') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('ItemDetailsScreen') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('ItemDetailsScreen') -> [CALLS] -> Function('IconButton')]
|
||||
// [RELATION: Function('ItemDetailsScreen') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('ItemDetailsScreen') -> [CALLS] -> Function('ItemDetailsContent')]
|
||||
// [RELATION: Function('ItemDetailsScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('ItemDetailsScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* [MAIN-CONTRACT]
|
||||
* Экран для отображения детальной информации о товаре.
|
||||
*
|
||||
* Реализует спецификацию `screen_item_details`.
|
||||
*
|
||||
* @param onNavigateBack Обработчик для возврата на предыдущий экран.
|
||||
* @param onEditClick Обработчик нажатия на кнопку редактирования.
|
||||
* @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.
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
fun ItemDetailsScreen(
|
||||
viewModel: ItemDetailsViewModel = hiltViewModel(),
|
||||
onNavigateBack: () -> Unit,
|
||||
onEditClick: (Int) -> Unit
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions
|
||||
) {
|
||||
// [STATE]
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
Scaffold(
|
||||
topBar = {
|
||||
TopAppBar(
|
||||
title = { Text(uiState.item?.name ?: stringResource(id = R.string.item_details_title)) }, // Corrected string resource name
|
||||
navigationIcon = {
|
||||
IconButton(onClick = onNavigateBack) {
|
||||
Icon(Icons.AutoMirrored.Filled.ArrowBack, contentDescription = stringResource(id = R.string.content_desc_navigate_back))
|
||||
}
|
||||
},
|
||||
actions = {
|
||||
IconButton(onClick = {
|
||||
uiState.item?.id?.let {
|
||||
Timber.i("[INFO][ACTION][ui_interaction] Edit item clicked: id=$it")
|
||||
onEditClick(it.toInt())
|
||||
}
|
||||
}) {
|
||||
Icon(Icons.Default.Edit, contentDescription = stringResource(id = R.string.content_desc_edit_item))
|
||||
}
|
||||
IconButton(onClick = {
|
||||
Timber.w("[WARN][ACTION][ui_interaction] Delete item clicked: id=${uiState.item?.id}")
|
||||
viewModel.deleteItem()
|
||||
// После удаления нужно навигироваться назад
|
||||
onNavigateBack()
|
||||
}) {
|
||||
Icon(Icons.Default.Delete, contentDescription = stringResource(id = R.string.content_desc_delete_item))
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
) { innerPadding ->
|
||||
ItemDetailsContent(
|
||||
modifier = Modifier.padding(innerPadding),
|
||||
isLoading = uiState.isLoading,
|
||||
item = uiState.item
|
||||
)
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.item_details_title),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) {
|
||||
// [AI_NOTE]: Implement Item Details Screen UI
|
||||
Text(text = "Item Details Screen")
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('ItemDetailsScreen')]
|
||||
|
||||
// [ENTITY: Function('ItemDetailsContent')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [DEPENDS_ON] -> Class('Item')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [CALLS] -> Function('Box')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [CALLS] -> Function('CircularProgressIndicator')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [CALLS] -> Function('verticalScroll')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [CALLS] -> Function('rememberScrollState')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [CALLS] -> Function('DetailsSection')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [CALLS] -> Function('InfoRow')]
|
||||
// [RELATION: Function('ItemDetailsContent') -> [CALLS] -> Function('AssistChip')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Отображает контент экрана: индикатор загрузки или детали товара.
|
||||
*/
|
||||
@Composable
|
||||
private fun ItemDetailsContent(
|
||||
modifier: Modifier = Modifier,
|
||||
isLoading: Boolean,
|
||||
item: Item?
|
||||
) {
|
||||
Box(modifier = modifier.fillMaxSize()) {
|
||||
when {
|
||||
isLoading -> {
|
||||
// [STATE]
|
||||
CircularProgressIndicator(modifier = Modifier.align(Alignment.Center))
|
||||
}
|
||||
item == null -> {
|
||||
// [FALLBACK]
|
||||
Text(stringResource(id = R.string.items_not_found), modifier = Modifier.align(Alignment.Center))
|
||||
}
|
||||
else -> {
|
||||
// [CORE-LOGIC]
|
||||
Column(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(16.dp)
|
||||
) {
|
||||
// TODO: ImageCarousel
|
||||
// Text("Image Carousel Placeholder")
|
||||
|
||||
DetailsSection(title = stringResource(id = R.string.section_title_description)) {
|
||||
Text(text = item.description ?: stringResource(id = R.string.placeholder_no_description))
|
||||
}
|
||||
|
||||
DetailsSection(title = stringResource(id = R.string.section_title_details)) {
|
||||
InfoRow(label = stringResource(id = R.string.label_quantity), value = item.quantity.toString())
|
||||
item.location?.let {
|
||||
InfoRow(label = stringResource(id = R.string.label_location), value = it.name)
|
||||
}
|
||||
}
|
||||
|
||||
if (item.labels.isNotEmpty()) {
|
||||
DetailsSection(title = stringResource(id = R.string.section_title_labels)) {
|
||||
// TODO: Use FlowRow for better layout
|
||||
Row(horizontalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
item.labels.forEach { label ->
|
||||
AssistChip(onClick = { /* No-op */ }, label = { Text(label.name) })
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: CustomFieldsGrid
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('ItemDetailsContent')]
|
||||
|
||||
// [ENTITY: Function('DetailsSection')]
|
||||
// [RELATION: Function('DetailsSection') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('DetailsSection') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('DetailsSection') -> [CALLS] -> Function('MaterialTheme.typography.titleMedium')]
|
||||
// [RELATION: Function('DetailsSection') -> [CALLS] -> Function('Divider')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Секция с заголовком и контентом.
|
||||
*/
|
||||
@Composable
|
||||
private fun DetailsSection(title: String, content: @Composable ColumnScope.() -> Unit) {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
Text(text = title, style = MaterialTheme.typography.titleMedium)
|
||||
Divider()
|
||||
content()
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('DetailsSection')]
|
||||
|
||||
// [ENTITY: Function('InfoRow')]
|
||||
// [RELATION: Function('InfoRow') -> [CALLS] -> Function('Row')]
|
||||
// [RELATION: Function('InfoRow') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('InfoRow') -> [CALLS] -> Function('MaterialTheme.typography.bodyLarge')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Строка для отображения пары "метка: значение".
|
||||
*/
|
||||
@Composable
|
||||
private fun InfoRow(label: String, value: String) {
|
||||
Row {
|
||||
Text(text = "$label: ", style = MaterialTheme.typography.bodyLarge)
|
||||
Text(text = value, style = MaterialTheme.typography.bodyLarge)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('InfoRow')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_ItemDetailsScreen.kt]
|
||||
@@ -1,43 +1,20 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.itemdetails
|
||||
// [FILE] ItemDetailsViewModel.kt
|
||||
|
||||
// [SEMANTICS] app, ui, viewmodel, details
|
||||
package com.homebox.lens.ui.screen.itemdetails
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import javax.inject.Inject
|
||||
import com.homebox.lens.domain.model.Item
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: ViewModel('ItemDetailsViewModel')]
|
||||
// [RELATION: ViewModel('ItemDetailsViewModel') -> [INHERITS_FROM] -> Class('ViewModel')]
|
||||
// [RELATION: ViewModel('ItemDetailsViewModel') -> [DEPENDS_ON] -> Annotation('HiltViewModel')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @summary ViewModel for the ItemDetailsScreen.
|
||||
* @summary ViewModel for the item details screen.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class ItemDetailsViewModel
|
||||
@Inject
|
||||
constructor() : ViewModel() {
|
||||
// [STATE]
|
||||
// TODO: Implement UI state
|
||||
val uiState = MutableStateFlow(ItemDetailsUiState()).asStateFlow()
|
||||
|
||||
fun deleteItem() {
|
||||
// TODO: Implement delete item logic
|
||||
}
|
||||
}
|
||||
class ItemDetailsViewModel @Inject constructor() : ViewModel() {
|
||||
// [AI_NOTE]: Implement UI state
|
||||
}
|
||||
// [END_ENTITY: ViewModel('ItemDetailsViewModel')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_ItemDetailsViewModel.kt]
|
||||
|
||||
// Placeholder for ItemDetailsUiState to resolve compilation errors
|
||||
data class ItemDetailsUiState(
|
||||
val item: Item? = null,
|
||||
val isLoading: Boolean = false
|
||||
)
|
||||
@@ -1,162 +1,606 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.itemedit
|
||||
// [FILE] ItemEditScreen.kt
|
||||
// [SEMANTICS] ui, screen, item, edit, create, compose
|
||||
// [SEMANTICS] app, ui, screen, edit
|
||||
|
||||
package com.homebox.lens.ui.screen.itemedit
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.layout.*
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.Row
|
||||
import androidx.compose.foundation.layout.Spacer
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.height
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.rememberScrollState
|
||||
import androidx.compose.foundation.text.KeyboardOptions
|
||||
import androidx.compose.foundation.verticalScroll
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.automirrored.filled.ArrowBack
|
||||
import androidx.compose.material.icons.filled.Done
|
||||
import androidx.compose.material3.*
|
||||
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
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Scaffold
|
||||
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
|
||||
import androidx.compose.runtime.collectAsState
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.mutableStateOf
|
||||
import androidx.compose.runtime.remember
|
||||
import androidx.compose.runtime.setValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.input.KeyboardType
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.ui.common.MainScaffold
|
||||
import timber.log.Timber
|
||||
import java.text.SimpleDateFormat
|
||||
import java.util.Date
|
||||
import java.util.Locale
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('ItemEditScreen')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [DEPENDS_ON] -> Class('ItemEditViewModel')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('hiltViewModel')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('collectAsState')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('LaunchedEffect')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('Timber.i')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('Scaffold')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('TopAppBar')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('IconButton')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('ItemEditScreen') -> [CALLS] -> Function('ItemEditContent')]
|
||||
// [ENTITY: Composable('ItemEditScreen')]
|
||||
// [RELATION: Composable('ItemEditScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Composable('ItemEditScreen')] -> [DEPENDS_ON] -> [ViewModel('ItemEditViewModel')]
|
||||
// [RELATION: Composable('ItemEditScreen')] -> [CONSUMES_STATE] -> [DataClass('ItemEditUiState')]
|
||||
// [RELATION: Composable('ItemEditScreen')] -> [CALLS] -> [Composable('MainScaffold')]
|
||||
/**
|
||||
* [MAIN-CONTRACT]
|
||||
* Экран для создания или редактирования товара.
|
||||
*
|
||||
* Реализует спецификацию `screen_item_edit`.
|
||||
*
|
||||
* @param onNavigateBack Обработчик для возврата на предыдущий экран после сохранения или отмены.
|
||||
* @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
|
||||
fun ItemEditScreen(
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions,
|
||||
itemId: String?,
|
||||
viewModel: ItemEditViewModel = hiltViewModel(),
|
||||
onNavigateBack: () -> Unit
|
||||
onSaveSuccess: () -> Unit
|
||||
) {
|
||||
// [STATE]
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
val snackbarHostState = remember { SnackbarHostState() }
|
||||
|
||||
// [SIDE-EFFECT]
|
||||
LaunchedEffect(uiState.isSaved) {
|
||||
if (uiState.isSaved) {
|
||||
Timber.i("[INFO][SIDE_EFFECT][navigation] Item saved, navigating back.")
|
||||
onNavigateBack()
|
||||
LaunchedEffect(itemId) {
|
||||
Timber.i("[INFO][ENTRYPOINT][item_edit_screen_init] Initializing ItemEditScreen for item ID: %s", itemId)
|
||||
viewModel.loadItem(itemId)
|
||||
}
|
||||
|
||||
LaunchedEffect(uiState.error) {
|
||||
uiState.error?.let {
|
||||
snackbarHostState.showSnackbar(it)
|
||||
Timber.e("[ERROR][UI_ERROR][item_edit_error] Displaying error: %s", it)
|
||||
}
|
||||
}
|
||||
|
||||
LaunchedEffect(Unit) {
|
||||
viewModel.saveCompleted.collect {
|
||||
Timber.i("[INFO][ACTION][save_completed_callback] Item save completed. Triggering onSaveSuccess.")
|
||||
onSaveSuccess()
|
||||
}
|
||||
}
|
||||
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.item_edit_title),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) { paddingValues ->
|
||||
Scaffold(
|
||||
topBar = {
|
||||
TopAppBar(
|
||||
title = { Text(stringResource(id = if (uiState.isEditing) R.string.item_edit_title else R.string.item_edit_title_create)) }, // Corrected string resource names
|
||||
navigationIcon = {
|
||||
IconButton(onClick = onNavigateBack) {
|
||||
Icon(Icons.AutoMirrored.Filled.ArrowBack, contentDescription = stringResource(id = R.string.content_desc_navigate_back))
|
||||
}
|
||||
},
|
||||
actions = {
|
||||
IconButton(onClick = {
|
||||
Timber.i("[INFO][ACTION][ui_interaction] Save item clicked.")
|
||||
snackbarHost = { SnackbarHost(snackbarHostState) },
|
||||
floatingActionButton = {
|
||||
FloatingActionButton(onClick = {
|
||||
Timber.i("[INFO][ACTION][save_button_click] Save button clicked.")
|
||||
viewModel.saveItem()
|
||||
}) {
|
||||
Icon(Icons.Default.Done, contentDescription = stringResource(id = R.string.content_desc_save_item))
|
||||
Icon(Icons.Filled.Save, contentDescription = stringResource(R.string.save_item))
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
) { innerPadding ->
|
||||
ItemEditContent(
|
||||
modifier = Modifier.padding(innerPadding),
|
||||
state = uiState,
|
||||
onNameChange = { viewModel.onNameChange(it) },
|
||||
onDescriptionChange = { viewModel.onDescriptionChange(it) },
|
||||
onQuantityChange = { viewModel.onQuantityChange(it) }
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('ItemEditScreen')]
|
||||
|
||||
// [ENTITY: Function('ItemEditContent')]
|
||||
// [RELATION: Function('ItemEditContent') -> [DEPENDS_ON] -> Class('ItemEditUiState')]
|
||||
// [RELATION: Function('ItemEditContent') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('ItemEditContent') -> [CALLS] -> Function('verticalScroll')]
|
||||
// [RELATION: Function('ItemEditContent') -> [CALLS] -> Function('rememberScrollState')]
|
||||
// [RELATION: Function('ItemEditContent') -> [CALLS] -> Function('OutlinedTextField')]
|
||||
// [RELATION: Function('ItemEditContent') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('ItemEditContent') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('ItemEditContent') -> [CALLS] -> Function('MaterialTheme.colorScheme.error')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Отображает форму для редактирования данных товара.
|
||||
*/
|
||||
@Composable
|
||||
private fun ItemEditContent(
|
||||
modifier: Modifier = Modifier,
|
||||
state: ItemEditUiState,
|
||||
onNameChange: (String) -> Unit,
|
||||
onDescriptionChange: (String) -> Unit,
|
||||
onQuantityChange: (String) -> Unit
|
||||
) {
|
||||
// [CORE-LOGIC]
|
||||
) {
|
||||
Column(
|
||||
modifier = modifier
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.padding(paddingValues)
|
||||
.padding(16.dp)
|
||||
.verticalScroll(rememberScrollState())
|
||||
.padding(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(16.dp)
|
||||
) {
|
||||
if (uiState.isLoading) {
|
||||
CircularProgressIndicator(modifier = Modifier.fillMaxWidth())
|
||||
} else {
|
||||
uiState.item?.let { item ->
|
||||
// [AI_NOTE]: General Information section for basic item details.
|
||||
Card(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
elevation = CardDefaults.cardElevation(4.dp)
|
||||
) {
|
||||
Column(modifier = Modifier.padding(16.dp)) {
|
||||
Text(
|
||||
text = stringResource(R.string.item_edit_general_information),
|
||||
style = MaterialTheme.typography.headlineSmall
|
||||
)
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
OutlinedTextField(
|
||||
value = item.name,
|
||||
onValueChange = { viewModel.updateName(it) },
|
||||
label = { Text(stringResource(R.string.item_name)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
OutlinedTextField(
|
||||
value = item.description ?: "",
|
||||
onValueChange = { viewModel.updateDescription(it) },
|
||||
label = { Text(stringResource(R.string.item_description)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
OutlinedTextField(
|
||||
value = item.quantity.toString(),
|
||||
onValueChange = { viewModel.updateQuantity(it.toIntOrNull() ?: 0) },
|
||||
label = { Text(stringResource(R.string.item_quantity)) },
|
||||
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Number),
|
||||
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 = state.name,
|
||||
onValueChange = onNameChange,
|
||||
label = { Text(stringResource(id = R.string.label_name)) },
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
isError = state.nameError != null
|
||||
value = item.location?.name ?: "",
|
||||
onValueChange = { },
|
||||
label = { Text(stringResource(R.string.item_edit_location)) },
|
||||
readOnly = true,
|
||||
trailingIcon = {
|
||||
ExposedDropdownMenuDefaults.TrailingIcon(expanded = locationExpanded)
|
||||
},
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.menuAnchor()
|
||||
)
|
||||
state.nameError?.let {
|
||||
Text(text = stringResource(id = it), color = MaterialTheme.colorScheme.error)
|
||||
ExposedDropdownMenu(
|
||||
expanded = locationExpanded,
|
||||
onDismissRequest = { locationExpanded = false }
|
||||
) {
|
||||
uiState.allLocations.forEach { location ->
|
||||
DropdownMenuItem(
|
||||
text = { Text(location.name) },
|
||||
onClick = {
|
||||
viewModel.updateLocation(location)
|
||||
locationExpanded = false
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
OutlinedTextField(
|
||||
value = state.description,
|
||||
onValueChange = onDescriptionChange,
|
||||
label = { Text(stringResource(id = R.string.label_description)) },
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
minLines = 3
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
|
||||
// Labels Dialog
|
||||
var showLabelsDialog by remember { mutableStateOf(false) }
|
||||
|
||||
OutlinedTextField(
|
||||
value = state.quantity,
|
||||
onValueChange = onQuantityChange,
|
||||
label = { Text(stringResource(id = R.string.label_quantity)) },
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
isError = state.quantityError != null
|
||||
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))
|
||||
}
|
||||
)
|
||||
state.quantityError?.let {
|
||||
Text(text = stringResource(id = it), color = MaterialTheme.colorScheme.error)
|
||||
|
||||
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))
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: Location Dropdown
|
||||
// TODO: Labels ChipGroup
|
||||
// TODO: ImagePicker
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
|
||||
// [AI_NOTE]: Purchase Information section.
|
||||
Card(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
elevation = CardDefaults.cardElevation(4.dp)
|
||||
) {
|
||||
Column(modifier = Modifier.padding(16.dp)) {
|
||||
Text(
|
||||
text = stringResource(R.string.item_edit_purchase_information),
|
||||
style = MaterialTheme.typography.headlineSmall
|
||||
)
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
OutlinedTextField(
|
||||
value = item.purchasePrice?.toString() ?: "",
|
||||
onValueChange = { viewModel.updatePurchasePrice(it.toDoubleOrNull()) },
|
||||
label = { Text(stringResource(R.string.item_edit_purchase_price)) },
|
||||
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Number),
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
OutlinedTextField(
|
||||
value = item.purchaseFrom ?: "",
|
||||
onValueChange = { viewModel.updatePurchaseFrom(it) },
|
||||
label = { Text(stringResource(R.string.item_edit_purchase_from)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
// [AI_NOTE]: Date picker for purchase time.
|
||||
var showPurchaseDatePicker by remember { mutableStateOf(false) }
|
||||
val purchaseDateState = rememberDatePickerState()
|
||||
OutlinedTextField(
|
||||
value = item.purchaseTime ?: "",
|
||||
onValueChange = { }, // Read-only, handled by date picker
|
||||
label = { Text(stringResource(R.string.item_edit_purchase_time)) },
|
||||
readOnly = true,
|
||||
trailingIcon = {
|
||||
IconButton(onClick = { showPurchaseDatePicker = true }) {
|
||||
Icon(Icons.Filled.DateRange, contentDescription = stringResource(R.string.item_edit_select_date))
|
||||
}
|
||||
},
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.clickable { showPurchaseDatePicker = true }
|
||||
)
|
||||
if (showPurchaseDatePicker) {
|
||||
DatePickerDialog(
|
||||
onDismissRequest = { showPurchaseDatePicker = false },
|
||||
confirmButton = {
|
||||
Text(stringResource(R.string.dialog_ok), modifier = Modifier.clickable {
|
||||
val selectedDate = purchaseDateState.selectedDateMillis?.let {
|
||||
SimpleDateFormat("yyyy-MM-dd", Locale.getDefault()).format(Date(it))
|
||||
}
|
||||
if (selectedDate != null) {
|
||||
viewModel.updatePurchaseTime(selectedDate)
|
||||
}
|
||||
showPurchaseDatePicker = false
|
||||
})
|
||||
},
|
||||
dismissButton = {
|
||||
Text(stringResource(R.string.dialog_cancel), modifier = Modifier.clickable { showPurchaseDatePicker = false })
|
||||
}
|
||||
) {
|
||||
DatePicker(state = purchaseDateState)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
|
||||
// [AI_NOTE]: Warranty Information section.
|
||||
Card(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
elevation = CardDefaults.cardElevation(4.dp)
|
||||
) {
|
||||
Column(modifier = Modifier.padding(16.dp)) {
|
||||
Text(
|
||||
text = stringResource(R.string.item_edit_warranty_information),
|
||||
style = MaterialTheme.typography.headlineSmall
|
||||
)
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
horizontalArrangement = Arrangement.SpaceBetween
|
||||
) {
|
||||
Text(stringResource(R.string.item_edit_lifetime_warranty))
|
||||
Switch(
|
||||
checked = item.lifetimeWarranty,
|
||||
onCheckedChange = { viewModel.updateLifetimeWarranty(it) }
|
||||
)
|
||||
}
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
OutlinedTextField(
|
||||
value = item.warrantyDetails ?: "",
|
||||
onValueChange = { viewModel.updateWarrantyDetails(it) },
|
||||
label = { Text(stringResource(R.string.item_edit_warranty_details)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
// [AI_NOTE]: Date picker for warranty expiration.
|
||||
var showWarrantyDatePicker by remember { mutableStateOf(false) }
|
||||
val warrantyDateState = rememberDatePickerState()
|
||||
OutlinedTextField(
|
||||
value = item.warrantyExpires ?: "",
|
||||
onValueChange = { }, // Read-only, handled by date picker
|
||||
label = { Text(stringResource(R.string.item_edit_warranty_expires)) },
|
||||
readOnly = true,
|
||||
trailingIcon = {
|
||||
IconButton(onClick = { showWarrantyDatePicker = true }) {
|
||||
Icon(Icons.Filled.DateRange, contentDescription = stringResource(R.string.item_edit_select_date))
|
||||
}
|
||||
},
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.clickable { showWarrantyDatePicker = true }
|
||||
)
|
||||
if (showWarrantyDatePicker) {
|
||||
DatePickerDialog(
|
||||
onDismissRequest = { showWarrantyDatePicker = false },
|
||||
confirmButton = {
|
||||
Text(stringResource(R.string.dialog_ok), modifier = Modifier.clickable {
|
||||
val selectedDate = warrantyDateState.selectedDateMillis?.let {
|
||||
SimpleDateFormat("yyyy-MM-dd", Locale.getDefault()).format(Date(it))
|
||||
}
|
||||
if (selectedDate != null) {
|
||||
viewModel.updateWarrantyExpires(selectedDate)
|
||||
}
|
||||
showWarrantyDatePicker = false
|
||||
})
|
||||
},
|
||||
dismissButton = {
|
||||
Text(stringResource(R.string.dialog_cancel), modifier = Modifier.clickable { showWarrantyDatePicker = false })
|
||||
}
|
||||
) {
|
||||
DatePicker(state = warrantyDateState)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
|
||||
// [AI_NOTE]: Identification section.
|
||||
Card(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
elevation = CardDefaults.cardElevation(4.dp)
|
||||
) {
|
||||
Column(modifier = Modifier.padding(16.dp)) {
|
||||
Text(
|
||||
text = stringResource(R.string.item_edit_identification),
|
||||
style = MaterialTheme.typography.headlineSmall
|
||||
)
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
OutlinedTextField(
|
||||
value = item.assetId ?: "",
|
||||
onValueChange = { viewModel.updateAssetId(it) },
|
||||
label = { Text(stringResource(R.string.item_edit_asset_id)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
OutlinedTextField(
|
||||
value = item.serialNumber ?: "",
|
||||
onValueChange = { viewModel.updateSerialNumber(it) },
|
||||
label = { Text(stringResource(R.string.item_edit_serial_number)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
OutlinedTextField(
|
||||
value = item.manufacturer ?: "",
|
||||
onValueChange = { viewModel.updateManufacturer(it) },
|
||||
label = { Text(stringResource(R.string.item_edit_manufacturer)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
OutlinedTextField(
|
||||
value = item.modelNumber ?: "",
|
||||
onValueChange = { viewModel.updateModelNumber(it) },
|
||||
label = { Text(stringResource(R.string.item_edit_model_number)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
|
||||
// [AI_NOTE]: Status & Notes section.
|
||||
Card(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
elevation = CardDefaults.cardElevation(4.dp)
|
||||
) {
|
||||
Column(modifier = Modifier.padding(16.dp)) {
|
||||
Text(
|
||||
text = stringResource(R.string.item_edit_status_notes),
|
||||
style = MaterialTheme.typography.headlineSmall
|
||||
)
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
horizontalArrangement = Arrangement.SpaceBetween
|
||||
) {
|
||||
Text(stringResource(R.string.item_edit_archived))
|
||||
Switch(
|
||||
checked = item.archived,
|
||||
onCheckedChange = { viewModel.updateArchived(it) }
|
||||
)
|
||||
}
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
horizontalArrangement = Arrangement.SpaceBetween
|
||||
) {
|
||||
Text(stringResource(R.string.item_edit_insured))
|
||||
Switch(
|
||||
checked = item.insured,
|
||||
onCheckedChange = { viewModel.updateInsured(it) }
|
||||
)
|
||||
}
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
OutlinedTextField(
|
||||
value = item.notes ?: "",
|
||||
onValueChange = { viewModel.updateNotes(it) },
|
||||
label = { Text(stringResource(R.string.item_edit_notes)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
|
||||
// [AI_NOTE]: Sold Information section (conditionally displayed).
|
||||
if (item.soldTime != null || item.soldPrice != null || item.soldTo != null || item.soldNotes != null) {
|
||||
Card(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
elevation = CardDefaults.cardElevation(4.dp)
|
||||
) {
|
||||
Column(modifier = Modifier.padding(16.dp)) {
|
||||
Text(
|
||||
text = stringResource(R.string.item_edit_sold_information),
|
||||
style = MaterialTheme.typography.headlineSmall
|
||||
)
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
OutlinedTextField(
|
||||
value = item.soldPrice?.toString() ?: "",
|
||||
onValueChange = { viewModel.updateSoldPrice(it.toDoubleOrNull()) },
|
||||
label = { Text(stringResource(R.string.item_edit_sold_price)) },
|
||||
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Number),
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
OutlinedTextField(
|
||||
value = item.soldTo ?: "",
|
||||
onValueChange = { viewModel.updateSoldTo(it) },
|
||||
label = { Text(stringResource(R.string.item_edit_sold_to)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
OutlinedTextField(
|
||||
value = item.soldNotes ?: "",
|
||||
onValueChange = { viewModel.updateSoldNotes(it) },
|
||||
label = { Text(stringResource(R.string.item_edit_sold_notes)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
// [AI_NOTE]: Date picker for sold time.
|
||||
var showSoldDatePicker by remember { mutableStateOf(false) }
|
||||
val soldDateState = rememberDatePickerState()
|
||||
OutlinedTextField(
|
||||
value = item.soldTime ?: "",
|
||||
onValueChange = { }, // Read-only, handled by date picker
|
||||
label = { Text(stringResource(R.string.item_edit_sold_time)) },
|
||||
readOnly = true,
|
||||
trailingIcon = {
|
||||
IconButton(onClick = { showSoldDatePicker = true }) {
|
||||
Icon(Icons.Filled.DateRange, contentDescription = stringResource(R.string.item_edit_select_date))
|
||||
}
|
||||
},
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.clickable { showSoldDatePicker = true }
|
||||
)
|
||||
if (showSoldDatePicker) {
|
||||
DatePickerDialog(
|
||||
onDismissRequest = { showSoldDatePicker = false },
|
||||
confirmButton = {
|
||||
Text(stringResource(R.string.dialog_ok), modifier = Modifier.clickable {
|
||||
val selectedDate = soldDateState.selectedDateMillis?.let {
|
||||
SimpleDateFormat("yyyy-MM-dd", Locale.getDefault()).format(Date(it))
|
||||
}
|
||||
if (selectedDate != null) {
|
||||
viewModel.updateSoldTime(selectedDate)
|
||||
}
|
||||
showSoldDatePicker = false
|
||||
})
|
||||
},
|
||||
dismissButton = {
|
||||
Text(stringResource(R.string.dialog_cancel), modifier = Modifier.clickable { showSoldDatePicker = false })
|
||||
}
|
||||
) {
|
||||
DatePicker(state = soldDateState)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('ItemEditContent')]
|
||||
// [END_CONTRACT]
|
||||
// [END_ENTITY: Composable('ItemEditScreen')]
|
||||
// [END_FILE_ItemEditScreen.kt]
|
||||
@@ -1,59 +1,514 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.itemedit
|
||||
// [FILE] ItemEditViewModel.kt
|
||||
// [SEMANTICS] app, ui, viewmodel, edit
|
||||
|
||||
package com.homebox.lens.ui.screen.itemedit
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.homebox.lens.domain.model.Item
|
||||
import com.homebox.lens.domain.model.ItemCreate
|
||||
import com.homebox.lens.domain.model.ItemUpdate
|
||||
import com.homebox.lens.domain.model.Location
|
||||
import com.homebox.lens.domain.model.Label
|
||||
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
|
||||
import javax.inject.Inject
|
||||
import kotlinx.coroutines.flow.MutableSharedFlow
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.SharedFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asSharedFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.launch
|
||||
import timber.log.Timber
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: ViewModel('ItemEditViewModel')]
|
||||
// [RELATION: ViewModel('ItemEditViewModel') -> [INHERITS_FROM] -> Class('ViewModel')]
|
||||
// [RELATION: ViewModel('ItemEditViewModel') -> [DEPENDS_ON] -> Annotation('HiltViewModel')]
|
||||
// [ENTITY: DataClass('ItemEditUiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @summary ViewModel for the ItemEditScreen.
|
||||
* @summary UI state for the item edit screen.
|
||||
* @param item The item being edited, or null if creating a new item.
|
||||
* @param isLoading Whether data is currently being loaded or saved.
|
||||
* @param error An error message if an operation failed.
|
||||
* @param allLocations A list of all available locations.
|
||||
* @param allLabels A list of all available labels.
|
||||
*/
|
||||
data class ItemEditUiState(
|
||||
val item: Item? = null,
|
||||
val isLoading: Boolean = false,
|
||||
val error: String? = null,
|
||||
val allLocations: List<Location> = emptyList(),
|
||||
val allLabels: List<Label> = emptyList()
|
||||
)
|
||||
// [END_ENTITY: DataClass('ItemEditUiState')]
|
||||
|
||||
// [ENTITY: ViewModel('ItemEditViewModel')]
|
||||
// [RELATION: ViewModel('ItemEditViewModel')] -> [DEPENDS_ON] -> [UseCase('CreateItemUseCase')]
|
||||
// [RELATION: ViewModel('ItemEditViewModel')] -> [DEPENDS_ON] -> [UseCase('UpdateItemUseCase')]
|
||||
// [RELATION: ViewModel('ItemEditViewModel')] -> [DEPENDS_ON] -> [UseCase('GetItemDetailsUseCase')]
|
||||
// [RELATION: ViewModel('ItemEditViewModel')] -> [DEPENDS_ON] -> [Class('ItemMapper')]
|
||||
// [RELATION: ViewModel('ItemEditViewModel')] -> [EMITS_STATE] -> [DataClass('ItemEditUiState')]
|
||||
/**
|
||||
* @summary ViewModel for the item edit screen.
|
||||
* @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
|
||||
class ItemEditViewModel
|
||||
@Inject
|
||||
constructor() : ViewModel() {
|
||||
// [STATE]
|
||||
// TODO: Implement UI state
|
||||
val uiState = MutableStateFlow(ItemEditUiState()).asStateFlow()
|
||||
class ItemEditViewModel @Inject constructor(
|
||||
private val createItemUseCase: CreateItemUseCase,
|
||||
private val updateItemUseCase: UpdateItemUseCase,
|
||||
private val getItemDetailsUseCase: GetItemDetailsUseCase,
|
||||
private val getAllLocationsUseCase: GetAllLocationsUseCase,
|
||||
private val getAllLabelsUseCase: GetAllLabelsUseCase,
|
||||
private val itemMapper: ItemMapper
|
||||
) : ViewModel() {
|
||||
|
||||
private val _uiState = MutableStateFlow(ItemEditUiState())
|
||||
val uiState: StateFlow<ItemEditUiState> = _uiState.asStateFlow()
|
||||
|
||||
private val _saveCompleted = MutableSharedFlow<Unit>()
|
||||
val saveCompleted: SharedFlow<Unit> = _saveCompleted.asSharedFlow()
|
||||
|
||||
// [ENTITY: Function('loadItem')]
|
||||
/**
|
||||
* @summary Loads item details for editing or prepares for new item creation.
|
||||
* @param itemId The ID of the item to load. If null, a new item is being created.
|
||||
* @sideeffect Updates `_uiState` with loading, success, or error states.
|
||||
*/
|
||||
fun loadItem(itemId: String?) {
|
||||
Timber.i("[INFO][ENTRYPOINT][loading_item] Attempting to load item with ID: %s", itemId)
|
||||
viewModelScope.launch {
|
||||
_uiState.value = _uiState.value.copy(isLoading = true, error = null)
|
||||
if (itemId == null) {
|
||||
Timber.i("[INFO][ACTION][new_item_preparation] Preparing for new item creation.")
|
||||
_uiState.value = _uiState.value.copy(
|
||||
isLoading = false,
|
||||
item = Item(
|
||||
id = "",
|
||||
name = "",
|
||||
description = null,
|
||||
quantity = 1,
|
||||
image = null,
|
||||
location = null,
|
||||
labels = emptyList(),
|
||||
purchasePrice = null,
|
||||
createdAt = null,
|
||||
archived = false,
|
||||
assetId = null,
|
||||
fields = emptyList(),
|
||||
insured = false,
|
||||
lifetimeWarranty = false,
|
||||
manufacturer = null,
|
||||
modelNumber = null,
|
||||
notes = null,
|
||||
parentId = null,
|
||||
purchaseFrom = null,
|
||||
purchaseTime = null,
|
||||
serialNumber = null,
|
||||
soldNotes = null,
|
||||
soldPrice = null,
|
||||
soldTime = null,
|
||||
soldTo = null,
|
||||
syncChildItemsLocations = false,
|
||||
warrantyDetails = null,
|
||||
warrantyExpires = null
|
||||
)
|
||||
)
|
||||
} else {
|
||||
try {
|
||||
Timber.i("[INFO][ACTION][fetching_item_details] Fetching details for item ID: %s", itemId)
|
||||
val itemOut = getItemDetailsUseCase(itemId)
|
||||
Timber.d("[DEBUG][ACTION][mapping_item_out_to_item] Mapping ItemOut to Item for UI state.")
|
||||
val item = itemMapper.toItem(itemOut)
|
||||
_uiState.value = _uiState.value.copy(isLoading = false, item = item)
|
||||
Timber.i("[INFO][ACTION][item_details_fetched] Successfully fetched and mapped item details for ID: %s", itemId)
|
||||
} catch (e: Exception) {
|
||||
Timber.e(e, "[ERROR][FALLBACK][item_load_failed] Failed to load item details for ID: %s", itemId)
|
||||
_uiState.value = _uiState.value.copy(isLoading = false, error = e.localizedMessage)
|
||||
}
|
||||
}
|
||||
|
||||
// Load all locations and labels
|
||||
try {
|
||||
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 { 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) {
|
||||
Timber.e(e, "[ERROR][FALLBACK][locations_labels_load_failed] Failed to load locations or labels.")
|
||||
_uiState.value = _uiState.value.copy(error = e.localizedMessage)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('loadItem')]
|
||||
|
||||
// [ENTITY: Function('updateLocation')]
|
||||
/**
|
||||
* @summary Updates the location of the item in the UI state.
|
||||
* @param location The new location for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateLocation(location: Location) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_location] Updating item location to: %s", location.name)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(location = location))
|
||||
}
|
||||
// [END_ENTITY: Function('updateLocation')]
|
||||
|
||||
// [ENTITY: Function('updateLabels')]
|
||||
/**
|
||||
* @summary Updates the labels of the item in the UI state.
|
||||
* @param labels The new list of labels for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateLabels(labels: List<Label>) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_labels] Updating item labels to: %s", labels.map { it.name }.joinToString())
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(labels = labels))
|
||||
}
|
||||
// [END_ENTITY: Function('updateLabels')]
|
||||
|
||||
// [ENTITY: Function('saveItem')]
|
||||
/**
|
||||
* @summary Saves the current item, either creating a new one or updating an existing one.
|
||||
* @sideeffect Updates `_uiState` with loading, success, or error states. Calls `createItemUseCase` or `updateItemUseCase`.
|
||||
* @throws IllegalStateException if `uiState.value.item` is null when attempting to save.
|
||||
*/
|
||||
fun saveItem() {
|
||||
// TODO: Implement save item logic
|
||||
}
|
||||
Timber.i("[INFO][ENTRYPOINT][saving_item] Attempting to save item.")
|
||||
viewModelScope.launch {
|
||||
val currentItem = _uiState.value.item
|
||||
require(currentItem != null) { "[CONTRACT_VIOLATION][PRECONDITION][item_not_present] Cannot save a null item." }
|
||||
|
||||
fun onNameChange(name: String) {
|
||||
// TODO: Implement name change logic
|
||||
_uiState.value = _uiState.value.copy(isLoading = true, error = null)
|
||||
try {
|
||||
if (currentItem.id.isBlank()) {
|
||||
Timber.i("[INFO][ACTION][creating_new_item] Creating new item: %s", currentItem.name)
|
||||
val createdItemSummary = createItemUseCase(
|
||||
ItemCreate(
|
||||
name = currentItem.name,
|
||||
description = currentItem.description,
|
||||
quantity = currentItem.quantity,
|
||||
archived = currentItem.archived,
|
||||
assetId = currentItem.assetId,
|
||||
insured = currentItem.insured,
|
||||
lifetimeWarranty = currentItem.lifetimeWarranty,
|
||||
manufacturer = currentItem.manufacturer,
|
||||
modelNumber = currentItem.modelNumber,
|
||||
notes = currentItem.notes,
|
||||
parentId = currentItem.parentId,
|
||||
purchaseFrom = currentItem.purchaseFrom,
|
||||
purchasePrice = currentItem.purchasePrice,
|
||||
purchaseTime = currentItem.purchaseTime,
|
||||
serialNumber = currentItem.serialNumber,
|
||||
soldNotes = currentItem.soldNotes,
|
||||
soldPrice = currentItem.soldPrice,
|
||||
soldTime = currentItem.soldTime,
|
||||
soldTo = currentItem.soldTo,
|
||||
syncChildItemsLocations = currentItem.syncChildItemsLocations,
|
||||
warrantyDetails = currentItem.warrantyDetails,
|
||||
warrantyExpires = currentItem.warrantyExpires,
|
||||
locationId = currentItem.location?.id,
|
||||
labelIds = currentItem.labels.map { it.id }
|
||||
)
|
||||
)
|
||||
Timber.i("[INFO][ACTION][fetching_full_item_after_creation] Fetching full item details after creation for ID: %s", createdItemSummary.id)
|
||||
val createdItemOut = getItemDetailsUseCase(createdItemSummary.id)
|
||||
Timber.d("[DEBUG][ACTION][mapping_item_out_to_item] Mapping created ItemOut to Item for UI state.")
|
||||
val item = itemMapper.toItem(createdItemOut)
|
||||
_uiState.value = _uiState.value.copy(isLoading = false, item = item)
|
||||
Timber.i("[INFO][ACTION][new_item_created] Successfully created and mapped new item with ID: %s", createdItemOut.id)
|
||||
_saveCompleted.emit(Unit)
|
||||
} else {
|
||||
Timber.i("[INFO][ACTION][updating_existing_item] Updating existing item with ID: %s", currentItem.id)
|
||||
val updatedItemOut = updateItemUseCase(currentItem)
|
||||
Timber.d("[DEBUG][ACTION][mapping_item_out_to_item] Mapping updated ItemOut to Item for UI state.")
|
||||
val item = itemMapper.toItem(updatedItemOut)
|
||||
_uiState.value = _uiState.value.copy(isLoading = false, item = item)
|
||||
Timber.i("[INFO][ACTION][item_updated] Successfully updated and mapped item with ID: %s", updatedItemOut.id)
|
||||
_saveCompleted.emit(Unit)
|
||||
}
|
||||
} catch (e: Exception) {
|
||||
Timber.e(e, "[ERROR][FALLBACK][item_save_failed] Failed to save item.")
|
||||
_uiState.value = _uiState.value.copy(isLoading = false, error = e.localizedMessage)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('saveItem')]
|
||||
|
||||
fun onDescriptionChange(description: String) {
|
||||
// TODO: Implement description change logic
|
||||
// [ENTITY: Function('updateName')]
|
||||
/**
|
||||
* @summary Updates the name of the item in the UI state.
|
||||
* @param newName The new name for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateName(newName: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_name] Updating item name to: %s", newName)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(name = newName))
|
||||
}
|
||||
// [END_ENTITY: Function('updateName')]
|
||||
|
||||
fun onQuantityChange(quantity: String) {
|
||||
// TODO: Implement quantity change logic
|
||||
// [ENTITY: Function('updateDescription')]
|
||||
/**
|
||||
* @summary Updates the description of the item in the UI state.
|
||||
* @param newDescription The new description for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateDescription(newDescription: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_description] Updating item description to: %s", newDescription)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(description = newDescription))
|
||||
}
|
||||
// [END_ENTITY: Function('updateDescription')]
|
||||
|
||||
// [ENTITY: Function('updateQuantity')]
|
||||
/**
|
||||
* @summary Updates the quantity of the item in the UI state.
|
||||
* @param newQuantity The new quantity for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateQuantity(newQuantity: Int) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_quantity] Updating item quantity to: %d", newQuantity)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(quantity = newQuantity))
|
||||
}
|
||||
// [END_ENTITY: ViewModel('ItemEditViewModel')]
|
||||
// [END_CONTRACT]
|
||||
// [END_ENTITY: Function('updateQuantity')]
|
||||
|
||||
// [ENTITY: Function('updateArchived')]
|
||||
/**
|
||||
* @summary Updates the archived status of the item in the UI state.
|
||||
* @param newArchived The new archived status for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateArchived(newArchived: Boolean) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_archived] Updating item archived status to: %s", newArchived)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(archived = newArchived))
|
||||
}
|
||||
// [END_ENTITY: Function('updateArchived')]
|
||||
|
||||
// [ENTITY: Function('updateAssetId')]
|
||||
/**
|
||||
* @summary Updates the asset ID of the item in the UI state.
|
||||
* @param newAssetId The new asset ID for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateAssetId(newAssetId: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_assetId] Updating item asset ID to: %s", newAssetId)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(assetId = newAssetId))
|
||||
}
|
||||
// [END_ENTITY: Function('updateAssetId')]
|
||||
|
||||
// [ENTITY: Function('updateInsured')]
|
||||
/**
|
||||
* @summary Updates the insured status of the item in the UI state.
|
||||
* @param newInsured The new insured status for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateInsured(newInsured: Boolean) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_insured] Updating item insured status to: %s", newInsured)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(insured = newInsured))
|
||||
}
|
||||
// [END_ENTITY: Function('updateInsured')]
|
||||
|
||||
// [ENTITY: Function('updateLifetimeWarranty')]
|
||||
/**
|
||||
* @summary Updates the lifetime warranty status of the item in the UI state.
|
||||
* @param newLifetimeWarranty The new lifetime warranty status for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateLifetimeWarranty(newLifetimeWarranty: Boolean) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_lifetime_warranty] Updating item lifetime warranty status to: %s", newLifetimeWarranty)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(lifetimeWarranty = newLifetimeWarranty))
|
||||
}
|
||||
// [END_ENTITY: Function('updateLifetimeWarranty')]
|
||||
|
||||
// [ENTITY: Function('updateManufacturer')]
|
||||
/**
|
||||
* @summary Updates the manufacturer of the item in the UI state.
|
||||
* @param newManufacturer The new manufacturer for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateManufacturer(newManufacturer: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_manufacturer] Updating item manufacturer to: %s", newManufacturer)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(manufacturer = newManufacturer))
|
||||
}
|
||||
// [END_ENTITY: Function('updateManufacturer')]
|
||||
|
||||
// [ENTITY: Function('updateModelNumber')]
|
||||
/**
|
||||
* @summary Updates the model number of the item in the UI state.
|
||||
* @param newModelNumber The new model number for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateModelNumber(newModelNumber: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_model_number] Updating item model number to: %s", newModelNumber)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(modelNumber = newModelNumber))
|
||||
}
|
||||
// [END_ENTITY: Function('updateModelNumber')]
|
||||
|
||||
// [ENTITY: Function('updateNotes')]
|
||||
/**
|
||||
* @summary Updates the notes of the item in the UI state.
|
||||
* @param newNotes The new notes for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateNotes(newNotes: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_notes] Updating item notes to: %s", newNotes)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(notes = newNotes))
|
||||
}
|
||||
// [END_ENTITY: Function('updateNotes')]
|
||||
|
||||
// [ENTITY: Function('updateParentId')]
|
||||
/**
|
||||
* @summary Updates the parent ID of the item in the UI state.
|
||||
* @param newParentId The new parent ID for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateParentId(newParentId: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_parent_id] Updating item parent ID to: %s", newParentId)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(parentId = newParentId))
|
||||
}
|
||||
// [END_ENTITY: Function('updateParentId')]
|
||||
|
||||
// [ENTITY: Function('updatePurchaseFrom')]
|
||||
/**
|
||||
* @summary Updates the purchase source of the item in the UI state.
|
||||
* @param newPurchaseFrom The new purchase source for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updatePurchaseFrom(newPurchaseFrom: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_purchase_from] Updating item purchase from to: %s", newPurchaseFrom)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(purchaseFrom = newPurchaseFrom))
|
||||
}
|
||||
// [END_ENTITY: Function('updatePurchaseFrom')]
|
||||
|
||||
// [ENTITY: Function('updatePurchasePrice')]
|
||||
/**
|
||||
* @summary Updates the purchase price of the item in the UI state.
|
||||
* @param newPurchasePrice The new purchase price for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updatePurchasePrice(newPurchasePrice: Double?) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_purchase_price] Updating item purchase price to: %s", newPurchasePrice)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(purchasePrice = newPurchasePrice))
|
||||
}
|
||||
// [END_ENTITY: Function('updatePurchasePrice')]
|
||||
|
||||
// [ENTITY: Function('updatePurchaseTime')]
|
||||
/**
|
||||
* @summary Updates the purchase time of the item in the UI state.
|
||||
* @param newPurchaseTime The new purchase time for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updatePurchaseTime(newPurchaseTime: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_purchase_time] Updating item purchase time to: %s", newPurchaseTime)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(purchaseTime = newPurchaseTime))
|
||||
}
|
||||
// [END_ENTITY: Function('updatePurchaseTime')]
|
||||
|
||||
// [ENTITY: Function('updateSerialNumber')]
|
||||
/**
|
||||
* @summary Updates the serial number of the item in the UI state.
|
||||
* @param newSerialNumber The new serial number for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateSerialNumber(newSerialNumber: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_serial_number] Updating item serial number to: %s", newSerialNumber)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(serialNumber = newSerialNumber))
|
||||
}
|
||||
// [END_ENTITY: Function('updateSerialNumber')]
|
||||
|
||||
// [ENTITY: Function('updateSoldNotes')]
|
||||
/**
|
||||
* @summary Updates the sold notes of the item in the UI state.
|
||||
* @param newSoldNotes The new sold notes for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateSoldNotes(newSoldNotes: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_sold_notes] Updating item sold notes to: %s", newSoldNotes)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(soldNotes = newSoldNotes))
|
||||
}
|
||||
// [END_ENTITY: Function('updateSoldNotes')]
|
||||
|
||||
// [ENTITY: Function('updateSoldPrice')]
|
||||
/**
|
||||
* @summary Updates the sold price of the item in the UI state.
|
||||
* @param newSoldPrice The new sold price for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateSoldPrice(newSoldPrice: Double?) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_sold_price] Updating item sold price to: %s", newSoldPrice)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(soldPrice = newSoldPrice))
|
||||
}
|
||||
// [END_ENTITY: Function('updateSoldPrice')]
|
||||
|
||||
// [ENTITY: Function('updateSoldTime')]
|
||||
/**
|
||||
* @summary Updates the sold time of the item in the UI state.
|
||||
* @param newSoldTime The new sold time for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateSoldTime(newSoldTime: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_sold_time] Updating item sold time to: %s", newSoldTime)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(soldTime = newSoldTime))
|
||||
}
|
||||
// [END_ENTITY: Function('updateSoldTime')]
|
||||
|
||||
// [ENTITY: Function('updateSoldTo')]
|
||||
/**
|
||||
* @summary Updates the sold to field of the item in the UI state.
|
||||
* @param newSoldTo The new sold to for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateSoldTo(newSoldTo: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_sold_to] Updating item sold to to: %s", newSoldTo)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(soldTo = newSoldTo))
|
||||
}
|
||||
// [END_ENTITY: Function('updateSoldTo')]
|
||||
|
||||
// [ENTITY: Function('updateSyncChildItemsLocations')]
|
||||
/**
|
||||
* @summary Updates the sync child items locations status of the item in the UI state.
|
||||
* @param newSyncChildItemsLocations The new sync child items locations status for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateSyncChildItemsLocations(newSyncChildItemsLocations: Boolean) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_sync_child_items_locations] Updating item sync child items locations status to: %s", newSyncChildItemsLocations)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(syncChildItemsLocations = newSyncChildItemsLocations))
|
||||
}
|
||||
// [END_ENTITY: Function('updateSyncChildItemsLocations')]
|
||||
|
||||
// [ENTITY: Function('updateWarrantyDetails')]
|
||||
/**
|
||||
* @summary Updates the warranty details of the item in the UI state.
|
||||
* @param newWarrantyDetails The new warranty details for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateWarrantyDetails(newWarrantyDetails: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_warranty_details] Updating item warranty details to: %s", newWarrantyDetails)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(warrantyDetails = newWarrantyDetails))
|
||||
}
|
||||
// [END_ENTITY: Function('updateWarrantyDetails')]
|
||||
|
||||
// [ENTITY: Function('updateWarrantyExpires')]
|
||||
/**
|
||||
* @summary Updates the warranty expires date of the item in the UI state.
|
||||
* @param newWarrantyExpires The new warranty expires date for the item.
|
||||
* @sideeffect Updates the `item` in `_uiState`.
|
||||
*/
|
||||
fun updateWarrantyExpires(newWarrantyExpires: String) {
|
||||
Timber.d("[DEBUG][ACTION][updating_item_warranty_expires] Updating item warranty expires date to: %s", newWarrantyExpires)
|
||||
_uiState.value = _uiState.value.copy(item = _uiState.value.item?.copy(warrantyExpires = newWarrantyExpires))
|
||||
}
|
||||
// [END_ENTITY: Function('updateWarrantyExpires')]
|
||||
}
|
||||
// [END_ENTITY: ViewModel('ItemEditViewModel')]
|
||||
// [END_FILE_ItemEditViewModel.kt]
|
||||
|
||||
// Placeholder for ItemEditUiState to resolve compilation errors
|
||||
data class ItemEditUiState(
|
||||
val isSaved: Boolean = false,
|
||||
val isEditing: Boolean = false,
|
||||
val name: String = "",
|
||||
val description: String = "",
|
||||
val quantity: String = "",
|
||||
val nameError: Int? = null,
|
||||
val quantityError: Int? = null
|
||||
)
|
||||
@@ -0,0 +1,119 @@
|
||||
// [FILE] LabelEditScreen.kt
|
||||
// [SEMANTICS] app, ui, screen, edit, label
|
||||
|
||||
package com.homebox.lens.ui.screen.labeledit
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.layout.*
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.automirrored.filled.ArrowBack
|
||||
import androidx.compose.material.icons.filled.Check
|
||||
import androidx.compose.material3.*
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.LaunchedEffect
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.ui.components.ColorPicker
|
||||
import com.homebox.lens.ui.components.LoadingOverlay
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('LabelEditScreen')]
|
||||
// [RELATION: Function('LabelEditScreen')] -> [DEPENDS_ON] -> [ViewModel('LabelEditViewModel')]
|
||||
/**
|
||||
* @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
|
||||
fun LabelEditScreen(
|
||||
labelId: String?,
|
||||
onBack: () -> Unit,
|
||||
onLabelSaved: () -> Unit,
|
||||
viewModel: LabelEditViewModel = hiltViewModel()
|
||||
) {
|
||||
val uiState = viewModel.uiState
|
||||
val snackbarHostState = SnackbarHostState()
|
||||
|
||||
LaunchedEffect(uiState.isSaved) {
|
||||
if (uiState.isSaved) {
|
||||
onLabelSaved()
|
||||
}
|
||||
}
|
||||
|
||||
LaunchedEffect(uiState.error) {
|
||||
uiState.error?.let {
|
||||
snackbarHostState.showSnackbar(
|
||||
message = it,
|
||||
actionLabel = "Dismiss",
|
||||
duration = SnackbarDuration.Short
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
Scaffold(
|
||||
snackbarHost = { SnackbarHost(snackbarHostState) },
|
||||
topBar = {
|
||||
TopAppBar(
|
||||
title = {
|
||||
Text(
|
||||
text = if (labelId == null) {
|
||||
stringResource(id = R.string.label_edit_title_create)
|
||||
} else {
|
||||
stringResource(id = R.string.label_edit_title_edit)
|
||||
}
|
||||
)
|
||||
},
|
||||
navigationIcon = {
|
||||
IconButton(onClick = onBack) {
|
||||
Icon(Icons.AutoMirrored.Filled.ArrowBack, contentDescription = stringResource(R.string.back))
|
||||
}
|
||||
},
|
||||
actions = {
|
||||
IconButton(onClick = viewModel::saveLabel) {
|
||||
Icon(Icons.Default.Check, contentDescription = stringResource(R.string.save))
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
) { paddingValues ->
|
||||
Column(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.padding(paddingValues)
|
||||
.padding(16.dp)
|
||||
) {
|
||||
OutlinedTextField(
|
||||
value = uiState.name,
|
||||
onValueChange = viewModel::onNameChange,
|
||||
label = { Text(stringResource(R.string.label_name)) },
|
||||
isError = uiState.nameError != null,
|
||||
supportingText = { uiState.nameError?.let { Text(it) } },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
OutlinedTextField(
|
||||
value = uiState.description.orEmpty(),
|
||||
onValueChange = viewModel::onDescriptionChange,
|
||||
label = { Text(stringResource(R.string.label_description)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
ColorPicker(
|
||||
selectedColor = uiState.color,
|
||||
onColorSelected = viewModel::onColorChange,
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
}
|
||||
|
||||
if (uiState.isLoading) {
|
||||
LoadingOverlay()
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LabelEditScreen')]
|
||||
// [END_FILE_LabelEditScreen.kt]
|
||||
@@ -0,0 +1,125 @@
|
||||
// [FILE] LabelEditViewModel.kt
|
||||
// [SEMANTICS] app, ui, viewmodel, edit, label
|
||||
|
||||
package com.homebox.lens.ui.screen.labeledit
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.mutableStateOf
|
||||
import androidx.compose.runtime.setValue
|
||||
import androidx.lifecycle.SavedStateHandle
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.homebox.lens.domain.model.LabelCreate
|
||||
import com.homebox.lens.domain.model.LabelOut
|
||||
import com.homebox.lens.domain.model.LabelUpdate
|
||||
import com.homebox.lens.domain.usecase.CreateLabelUseCase
|
||||
import com.homebox.lens.domain.usecase.GetLabelDetailsUseCase
|
||||
import com.homebox.lens.domain.usecase.UpdateLabelUseCase
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.launch
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: ViewModel('LabelEditViewModel')]
|
||||
// [RELATION: ViewModel('LabelEditViewModel')] -> [DEPENDS_ON] -> [UseCase('GetLabelDetailsUseCase')]
|
||||
// [RELATION: ViewModel('LabelEditViewModel')] -> [DEPENDS_ON] -> [UseCase('CreateLabelUseCase')]
|
||||
// [RELATION: ViewModel('LabelEditViewModel')] -> [DEPENDS_ON] -> [UseCase('UpdateLabelUseCase')]
|
||||
// [RELATION: ViewModel('LabelEditViewModel')] -> [EMITS_STATE] -> [DataClass('LabelEditUiState')]
|
||||
@HiltViewModel
|
||||
class LabelEditViewModel @Inject constructor(
|
||||
private val savedStateHandle: SavedStateHandle,
|
||||
private val getLabelDetailsUseCase: GetLabelDetailsUseCase,
|
||||
private val createLabelUseCase: CreateLabelUseCase,
|
||||
private val updateLabelUseCase: UpdateLabelUseCase
|
||||
) : ViewModel() {
|
||||
|
||||
var uiState by mutableStateOf(LabelEditUiState())
|
||||
private set
|
||||
|
||||
private val labelId: String? = savedStateHandle["labelId"]
|
||||
|
||||
init {
|
||||
if (labelId != null) {
|
||||
loadLabelDetails(labelId)
|
||||
}
|
||||
}
|
||||
|
||||
fun onNameChange(newName: String) {
|
||||
uiState = uiState.copy(name = newName, nameError = null)
|
||||
}
|
||||
|
||||
fun onDescriptionChange(newDescription: String) {
|
||||
uiState = uiState.copy(description = newDescription)
|
||||
}
|
||||
|
||||
fun onColorChange(newColor: String) {
|
||||
uiState = uiState.copy(color = newColor)
|
||||
}
|
||||
|
||||
fun saveLabel() {
|
||||
viewModelScope.launch {
|
||||
if (uiState.name.isBlank()) {
|
||||
uiState = uiState.copy(nameError = "Label name cannot be empty.")
|
||||
return@launch
|
||||
}
|
||||
|
||||
uiState = uiState.copy(isLoading = true, error = null)
|
||||
try {
|
||||
val result = if (labelId == null) {
|
||||
// [LOG_EVENT] [EVENT_TYPE: LabelCreationAttempt] [DATA: { "labelName": "${uiState.name}" }]
|
||||
val newLabel = LabelCreate(name = uiState.name, color = uiState.color, description = uiState.description)
|
||||
createLabelUseCase(newLabel)
|
||||
} else {
|
||||
// [LOG_EVENT] [EVENT_TYPE: LabelUpdateAttempt] [DATA: { "labelId": "$labelId", "labelName": "${uiState.name}" }]
|
||||
val updatedLabel = LabelUpdate(name = uiState.name, color = uiState.color, description = uiState.description)
|
||||
updateLabelUseCase(labelId, updatedLabel)
|
||||
}
|
||||
// [LOG_EVENT] [EVENT_TYPE: LabelSaveSuccess] [DATA: { "labelName": "${uiState.name}", "isNew": ${labelId == null} }]
|
||||
uiState = uiState.copy(isSaved = true)
|
||||
} catch (e: Exception) {
|
||||
// [LOG_EVENT] [EVENT_TYPE: LabelSaveFailure] [ERROR: "${e.message}"] [DATA: { "labelName": "${uiState.name}", "isNew": ${labelId == null} }]
|
||||
uiState = uiState.copy(error = e.message, isLoading = false)
|
||||
} finally {
|
||||
uiState = uiState.copy(isLoading = false)
|
||||
}
|
||||
}
|
||||
}
|
||||
private fun loadLabelDetails(id: String) {
|
||||
viewModelScope.launch {
|
||||
uiState = uiState.copy(isLoading = true, error = null)
|
||||
try {
|
||||
// [LOG_EVENT] [EVENT_TYPE: LabelDetailsFetchAttempt] [DATA: { "labelId": "$id" }]
|
||||
val label = getLabelDetailsUseCase(id)
|
||||
// [LOG_EVENT] [EVENT_TYPE: LabelDetailsFetchSuccess] [DATA: { "labelId": "$id", "labelName": "${label.name}" }]
|
||||
uiState = uiState.copy(
|
||||
name = label.name,
|
||||
color = label.color,
|
||||
description = label.description,
|
||||
isLoading = false,
|
||||
originalLabel = label
|
||||
)
|
||||
} catch (e: Exception) {
|
||||
// [LOG_EVENT] [EVENT_TYPE: LabelDetailsFetchFailure] [ERROR: "${e.message}"] [DATA: { "labelId": "$id" }]
|
||||
uiState = uiState.copy(error = e.message, isLoading = false)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// [ENTITY: DataClass('LabelEditUiState')]
|
||||
/**
|
||||
* @summary Состояние UI для экрана редактирования метки.
|
||||
*/
|
||||
data class LabelEditUiState(
|
||||
val name: String = "",
|
||||
val description: String? = null,
|
||||
val color: String = "#FFFFFF", // Default color
|
||||
val nameError: String? = null,
|
||||
val isLoading: Boolean = false,
|
||||
val error: String? = null,
|
||||
val isSaved: Boolean = false,
|
||||
val originalLabel: LabelOut? = null // To hold original label details if editing
|
||||
)
|
||||
// [END_ENTITY: DataClass('LabelEditUiState')]
|
||||
// [END_FILE_LabelEditViewModel.kt]
|
||||
@@ -1,14 +1,14 @@
|
||||
// [PACKAGE]com.homebox.lens.ui.screen.labelslist
|
||||
// [FILE]LabelsListScreen.kt
|
||||
// [SEMANTICS]ui, screen, labels, list, compose
|
||||
// [FILE] LabelsListScreen.kt
|
||||
// [SEMANTICS] app, ui, screen, list, label
|
||||
package com.homebox.lens.ui.screen.labelslist
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Box
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.PaddingValues
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
@@ -26,178 +26,144 @@ import androidx.compose.material3.Scaffold
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.material3.TopAppBar
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.collectAsState
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.domain.model.Label
|
||||
import com.homebox.lens.ui.screen.labelslist.LabelsListUiState
|
||||
import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.navigation.Screen
|
||||
import com.homebox.lens.ui.common.MainScaffold
|
||||
import timber.log.Timber
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('LabelsListScreen')]
|
||||
// [RELATION: Function('LabelsListScreen') -> [DEPENDS_ON] -> SealedInterface('LabelsListUiState')]
|
||||
// [RELATION: Function('LabelsListScreen') -> [CREATES_INSTANCE_OF] -> Class('Scaffold')]
|
||||
// [RELATION: Function('LabelsListScreen') -> [CALLS] -> Function('LabelsListContent')]
|
||||
// [RELATION: Function('LabelsListScreen') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('LabelsListScreen') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('LabelsListScreen') -> [CALLS] -> Function('IconButton')]
|
||||
// [RELATION: Function('LabelsListScreen') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('LabelsListScreen') -> [CALLS] -> Function('FloatingActionButton')]
|
||||
// [RELATION: Function('LabelsListScreen') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('LabelsListScreen') -> [CALLS] -> Function('CircularProgressIndicator')]
|
||||
// [RELATION: Function('LabelsListScreen')] -> [DEPENDS_ON] -> [ViewModel('LabelsListViewModel')]
|
||||
// [RELATION: Function('LabelsListScreen')] -> [DEPENDS_ON] -> [Framework('NavController')]
|
||||
/**
|
||||
* [MAIN-CONTRACT]
|
||||
* Экран для отображения списка всех меток.
|
||||
*
|
||||
* Этот Composable является точкой входа для UI, определенного в спецификации `screen_labels_list`.
|
||||
* Он получает состояние от [LabelsListViewModel] и отображает его, делегируя обработку
|
||||
* пользовательских событий в ViewModel.
|
||||
*
|
||||
* @param uiState Текущее состояние UI для экрана списка меток.
|
||||
* @param onLabelClick Функция обратного вызова для обработки нажатия на метку.
|
||||
* @param onAddClick Функция обратного вызова для обработки нажатия на кнопку добавления метки.
|
||||
* @param onNavigateBack Функция обратного вызова для навигации назад.
|
||||
* @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
|
||||
fun labelsListScreen(
|
||||
uiState: LabelsListUiState,
|
||||
onLabelClick: (Label) -> Unit,
|
||||
onAddClick: () -> Unit,
|
||||
onNavigateBack: () -> Unit,
|
||||
fun LabelsListScreen(
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions,
|
||||
viewModel: LabelsListViewModel = hiltViewModel()
|
||||
) {
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.screen_title_labels),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) { paddingValues ->
|
||||
Scaffold(
|
||||
topBar = {
|
||||
TopAppBar(
|
||||
title = { Text(stringResource(id = R.string.screen_title_labels)) },
|
||||
navigationIcon = {
|
||||
IconButton(onClick = onNavigateBack) {
|
||||
Icon(
|
||||
imageVector = Icons.AutoMirrored.Filled.ArrowBack,
|
||||
contentDescription = stringResource(id = R.string.content_desc_navigate_back)
|
||||
)
|
||||
}
|
||||
},
|
||||
)
|
||||
},
|
||||
floatingActionButton = {
|
||||
FloatingActionButton(onClick = onAddClick) {
|
||||
FloatingActionButton(onClick = {
|
||||
Timber.i("[INFO][ACTION][navigate_to_label_edit] FAB clicked: Navigate to create new label screen.")
|
||||
navigationActions.navigateToLabelEdit(null)
|
||||
}) {
|
||||
Icon(
|
||||
imageVector = Icons.Filled.Add,
|
||||
contentDescription = stringResource(id = R.string.content_desc_add_label)
|
||||
imageVector = Icons.Default.Add,
|
||||
contentDescription = stringResource(id = R.string.content_desc_create_label)
|
||||
)
|
||||
}
|
||||
}
|
||||
) { innerPadding ->
|
||||
Box(modifier = Modifier.padding(innerPadding)) {
|
||||
when (uiState) {
|
||||
is LabelsListUiState.Loading -> {
|
||||
Column(
|
||||
modifier = Modifier.fillMaxSize(),
|
||||
verticalArrangement = Arrangement.Center,
|
||||
horizontalAlignment = Alignment.CenterHorizontally
|
||||
) { innerPaddingValues ->
|
||||
val currentState = uiState
|
||||
|
||||
Box(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.padding(innerPaddingValues), // Use innerPaddingValues here
|
||||
contentAlignment = Alignment.Center
|
||||
) {
|
||||
when (val state = uiState) {
|
||||
is LabelsListUiState.Loading -> {
|
||||
CircularProgressIndicator()
|
||||
}
|
||||
is LabelsListUiState.Error -> {
|
||||
Text(text = state.message)
|
||||
}
|
||||
is LabelsListUiState.Success -> {
|
||||
LabelsListContent(
|
||||
uiState = uiState,
|
||||
onLabelClick = onLabelClick
|
||||
if (state.labels.isEmpty()) {
|
||||
Text(text = stringResource(id = R.string.no_labels_found))
|
||||
} else {
|
||||
LabelsList(
|
||||
labels = state.labels,
|
||||
onLabelClick = { label ->
|
||||
Timber.i("[INFO][ACTION][navigate_to_label_edit] Label clicked: ${label.id}. Navigating to label edit screen.")
|
||||
navigationActions.navigateToLabelEdit(label.id)
|
||||
}
|
||||
)
|
||||
}
|
||||
is LabelsListUiState.Error -> {
|
||||
Column(
|
||||
modifier = Modifier.fillMaxSize(),
|
||||
verticalArrangement = Arrangement.Center,
|
||||
horizontalAlignment = Alignment.CenterHorizontally
|
||||
) {
|
||||
Text(text = uiState.message)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LabelsListScreen')]
|
||||
|
||||
// [ENTITY: Function('LabelsListContent')]
|
||||
// [RELATION: Function('LabelsListContent') -> [CALLS] -> Function('LabelListItem')]
|
||||
// [RELATION: Function('LabelsListContent') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('LabelsListContent') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('LabelsListContent') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('LabelsListContent') -> [CALLS] -> Function('LazyColumn')]
|
||||
// [ENTITY: Function('LabelsList')]
|
||||
// [RELATION: Function('LabelsList')] -> [DEPENDS_ON] -> [DataClass('Label')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Отображает основной контент экрана: список меток.
|
||||
*
|
||||
* @param uiState Состояние успеха, содержащее список меток.
|
||||
* @param onLabelClick Обработчик нажатия на элемент списка.
|
||||
* @sideeffect Отсутствуют.
|
||||
* @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 LabelsListContent(
|
||||
uiState: LabelsListUiState.Success,
|
||||
onLabelClick: (Label) -> Unit
|
||||
private fun LabelsList(
|
||||
labels: List<Label>,
|
||||
onLabelClick: (Label) -> Unit,
|
||||
modifier: Modifier = Modifier
|
||||
) {
|
||||
if (uiState.labels.isEmpty()) {
|
||||
Column(
|
||||
modifier = Modifier.fillMaxSize(),
|
||||
verticalArrangement = Arrangement.Center,
|
||||
horizontalAlignment = Alignment.CenterHorizontally
|
||||
LazyColumn(
|
||||
modifier = modifier.fillMaxSize(),
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(8.dp)
|
||||
) {
|
||||
Text(text = stringResource(id = R.string.no_labels_found))
|
||||
}
|
||||
} else {
|
||||
LazyColumn {
|
||||
items(uiState.labels, key = { it.id }) { label ->
|
||||
items(labels, key = { it.id }) { label ->
|
||||
LabelListItem(
|
||||
label = label,
|
||||
onClick = {
|
||||
Timber.i("[INFO][ACTION][ui_interaction] Label clicked: ${label.name}")
|
||||
onLabelClick(label)
|
||||
}
|
||||
onClick = { onLabelClick(label) }
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LabelsListContent')]
|
||||
// [END_ENTITY: Function('LabelsList')]
|
||||
|
||||
// [ENTITY: Function('LabelListItem')]
|
||||
// [RELATION: Function('LabelListItem') -> [CALLS] -> Function('ListItem')]
|
||||
// [RELATION: Function('LabelListItem') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('LabelListItem') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('LabelListItem')] -> [DEPENDS_ON] -> [DataClass('Label')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Отображает один элемент в списке меток.
|
||||
*
|
||||
* @param label Метка для отображения.
|
||||
* @param onClick Обработчик нажатия на элемент.
|
||||
* @sideeffect Отсутствуют.
|
||||
* @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(
|
||||
label: Label,
|
||||
onClick: () -> Unit
|
||||
) {
|
||||
// [PRECONDITION]
|
||||
require(label.name.isNotBlank()) { "Label name cannot be blank." }
|
||||
|
||||
// [CORE-LOGIC]
|
||||
ListItem(
|
||||
headlineContent = { Text(label.name) },
|
||||
headlineContent = { Text(text = label.name) },
|
||||
leadingContent = {
|
||||
Icon(
|
||||
imageVector = Icons.AutoMirrored.Filled.Label,
|
||||
contentDescription = null // Декоративный элемент
|
||||
contentDescription = stringResource(id = R.string.content_desc_label_icon)
|
||||
)
|
||||
},
|
||||
modifier = Modifier.clickable(onClick = onClick)
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('LabelListItem')]
|
||||
// [END_CONTRACT]
|
||||
|
||||
// [END_FILE_LabelsListScreen.kt]
|
||||
@@ -1,53 +1,47 @@
|
||||
// [PACKAGE]com.homebox.lens.ui.screen.labelslist
|
||||
// [FILE]LabelsListUiState.kt
|
||||
// [SEMANTICS]ui_state, sealed_interface, contract
|
||||
// [FILE] LabelsListUiState.kt
|
||||
// [SEMANTICS] app, ui, state, list, label
|
||||
package com.homebox.lens.ui.screen.labelslist
|
||||
|
||||
// [IMPORTS]
|
||||
import com.homebox.lens.domain.model.Label
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: SealedInterface('LabelsListUiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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') -> [IMPLEMENTS] -> SealedInterface('LabelsListUiState')]
|
||||
// [RELATION: DataClass('Success') -> [DEPENDS_ON] -> DataStructure('Label')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('Label')]
|
||||
/**
|
||||
* @summary Состояние успеха, содержит список меток и состояние диалога.
|
||||
* @property labels Список меток для отображения.
|
||||
* @property 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>,
|
||||
val isShowingCreateDialog: Boolean = false
|
||||
) : LabelsListUiState
|
||||
// [END_ENTITY: DataClass('Success')]
|
||||
|
||||
// [ENTITY: DataClass('Error')]
|
||||
// [RELATION: DataClass('Error') -> [IMPLEMENTS] -> SealedInterface('LabelsListUiState')]
|
||||
/**
|
||||
* @summary Состояние ошибки.
|
||||
* @property message Текст ошибки для отображения пользователю, или `null` при отсутствии ошибки.
|
||||
* @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
|
||||
data class Error(val message: String) : LabelsListUiState
|
||||
// [END_ENTITY: DataClass('Error')]
|
||||
|
||||
// [ENTITY: Object('Loading')]
|
||||
// [RELATION: Object('Loading') -> [IMPLEMENTS] -> SealedInterface('LabelsListUiState')]
|
||||
/**
|
||||
* @summary Состояние загрузки данных.
|
||||
* @description Указывает, что идет процесс загрузки меток.
|
||||
* @summary The data loading state.
|
||||
* @description Indicates that the process of loading labels is in progress.
|
||||
*/
|
||||
object Loading : LabelsListUiState
|
||||
data object Loading : LabelsListUiState
|
||||
// [END_ENTITY: Object('Loading')]
|
||||
}
|
||||
// [END_ENTITY: SealedInterface('LabelsListUiState')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_LabelsListUiState.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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]
|
||||
@@ -17,99 +16,72 @@ import timber.log.Timber
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: ViewModel('LabelsListViewModel')]
|
||||
// [RELATION: ViewModel('LabelsListViewModel') -> [INHERITS_FROM] -> Class('ViewModel')]
|
||||
// [RELATION: ViewModel('LabelsListViewModel') -> [DEPENDS_ON] -> Annotation('HiltViewModel')]
|
||||
// [RELATION: ViewModel('LabelsListViewModel') -> [DEPENDS_ON] -> Class('GetAllLabelsUseCase')]
|
||||
// [RELATION: ViewModel('LabelsListViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLabelsUseCase')]
|
||||
// [RELATION: ViewModel('LabelsListViewModel')] -> [EMITS_STATE] -> [SealedInterface('LabelsListUiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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(
|
||||
private val getAllLabelsUseCase: GetAllLabelsUseCase,
|
||||
) : ViewModel() {
|
||||
// [STATE]
|
||||
class LabelsListViewModel @Inject constructor(
|
||||
private val getAllLabelsUseCase: GetAllLabelsUseCase
|
||||
) : ViewModel() {
|
||||
|
||||
private val _uiState = MutableStateFlow<LabelsListUiState>(LabelsListUiState.Loading)
|
||||
val uiState = _uiState.asStateFlow()
|
||||
|
||||
// [INIT]
|
||||
init {
|
||||
loadLabels()
|
||||
}
|
||||
|
||||
// [ENTITY: Function('loadLabels')]
|
||||
// [RELATION: Function('loadLabels') -> [CALLS] -> Function('viewModelScope.launch')]
|
||||
// [RELATION: Function('loadLabels') -> [WRITES_TO] -> Property('_uiState')]
|
||||
// [RELATION: Function('loadLabels') -> [CALLS] -> Function('Timber.i')]
|
||||
// [RELATION: Function('loadLabels') -> [CALLS] -> Function('runCatching')]
|
||||
// [RELATION: Function('loadLabels') -> [CALLS] -> Function('getAllLabelsUseCase')]
|
||||
// [RELATION: Function('loadLabels') -> [CALLS] -> Function('result.fold')]
|
||||
// [RELATION: Function('loadLabels') -> [CALLS] -> Function('Timber.e')]
|
||||
// [RELATION: Function('loadLabels') -> [CREATES_INSTANCE_OF] -> Class('Label')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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`.
|
||||
*/
|
||||
// [ACTION]
|
||||
fun loadLabels() {
|
||||
viewModelScope.launch {
|
||||
_uiState.value = LabelsListUiState.Loading
|
||||
Timber.i("[ACTION] Starting labels list load. State -> Loading.")
|
||||
Timber.i("[INFO][ENTRYPOINT][loading_labels] Starting labels list load. State -> Loading.")
|
||||
|
||||
// [CORE-LOGIC]
|
||||
val result =
|
||||
runCatching {
|
||||
val result = runCatching {
|
||||
getAllLabelsUseCase()
|
||||
}
|
||||
|
||||
// [RESULT_HANDLER]
|
||||
result.fold(
|
||||
onSuccess = { labelOuts ->
|
||||
Timber.i("[SUCCESS] Labels loaded successfully. Count: ${labelOuts.size}. State -> Success.")
|
||||
// [DATA-FLOW] Map List<LabelOut> to List<Label> for the UI state.
|
||||
// The 'Label' model for the UI is simpler and only contains 'id' and 'name'.
|
||||
val labels =
|
||||
labelOuts.map { labelOut ->
|
||||
Timber.i("[INFO][SUCCESS][labels_loaded] Labels loaded successfully. Count: ${labelOuts.size}. State -> Success.")
|
||||
val labels = labelOuts.map { labelOut ->
|
||||
Label(
|
||||
id = labelOut.id,
|
||||
name = labelOut.name,
|
||||
name = labelOut.name
|
||||
)
|
||||
}
|
||||
_uiState.value = LabelsListUiState.Success(labels, isShowingCreateDialog = false)
|
||||
},
|
||||
onFailure = { exception ->
|
||||
Timber.e(exception, "[ERROR] Failed to load labels. State -> Error.")
|
||||
_uiState.value =
|
||||
LabelsListUiState.Error(
|
||||
message = exception.message ?: "Could not load labels.",
|
||||
Timber.e(exception, "[ERROR][EXCEPTION][loading_failed] Failed to load labels. State -> Error.")
|
||||
_uiState.value = LabelsListUiState.Error(
|
||||
message = exception.message ?: "Could not load labels."
|
||||
)
|
||||
},
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('loadLabels')]
|
||||
|
||||
// [ENTITY: Function('onShowCreateDialog')]
|
||||
// [RELATION: Function('onShowCreateDialog') -> [CALLS] -> Function('Timber.i')]
|
||||
// [RELATION: Function('onShowCreateDialog') -> [CALLS] -> Function('_uiState.update')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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`.
|
||||
*/
|
||||
// [ACTION]
|
||||
fun onShowCreateDialog() {
|
||||
Timber.i("[ACTION] Show create label dialog requested.")
|
||||
Timber.i("[INFO][ACTION][show_create_dialog] Show create label dialog requested.")
|
||||
if (_uiState.value is LabelsListUiState.Success) {
|
||||
_uiState.update {
|
||||
(it as LabelsListUiState.Success).copy(isShowingCreateDialog = true)
|
||||
@@ -119,17 +91,13 @@ class LabelsListViewModel
|
||||
// [END_ENTITY: Function('onShowCreateDialog')]
|
||||
|
||||
// [ENTITY: Function('onDismissCreateDialog')]
|
||||
// [RELATION: Function('onDismissCreateDialog') -> [CALLS] -> Function('Timber.i')]
|
||||
// [RELATION: Function('onDismissCreateDialog') -> [CALLS] -> Function('_uiState.update')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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`.
|
||||
*/
|
||||
// [ACTION]
|
||||
fun onDismissCreateDialog() {
|
||||
Timber.i("[ACTION] Dismiss create label dialog requested.")
|
||||
Timber.i("[INFO][ACTION][dismiss_create_dialog] Dismiss create label dialog requested.")
|
||||
if (_uiState.value is LabelsListUiState.Success) {
|
||||
_uiState.update {
|
||||
(it as LabelsListUiState.Success).copy(isShowingCreateDialog = false)
|
||||
@@ -139,32 +107,24 @@ class LabelsListViewModel
|
||||
// [END_ENTITY: Function('onDismissCreateDialog')]
|
||||
|
||||
// [ENTITY: Function('createLabel')]
|
||||
// [RELATION: Function('createLabel') -> [CALLS] -> Function('require')]
|
||||
// [RELATION: Function('createLabel') -> [CALLS] -> Function('Timber.i')]
|
||||
// [RELATION: Function('createLabel') -> [CALLS] -> Function('onDismissCreateDialog')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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.
|
||||
*/
|
||||
// [ACTION]
|
||||
fun createLabel(name: String) {
|
||||
// [PRECONDITION]
|
||||
require(name.isNotBlank()) { "[CONTRACT_VIOLATION] Label name cannot be blank." }
|
||||
|
||||
Timber.i("[ACTION] Create label called with name: '$name'. [STUBBED]")
|
||||
Timber.i("[INFO][ACTION][create_label] Create label called with name: '$name'. [STUBBED]")
|
||||
|
||||
// [CORE-LOGIC] - Заглушка. Здесь будет вызов CreateLabelUseCase.
|
||||
// [AI_NOTE]: Здесь будет вызов CreateLabelUseCase.
|
||||
|
||||
// [POSTCONDITION] Скрываем диалог после "создания".
|
||||
onDismissCreateDialog()
|
||||
// [REFACTORING_NOTE] На следующем этапе нужно добавить вызов UseCase и обновить список.
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('createLabel')]
|
||||
}
|
||||
// [END_ENTITY: ViewModel('LabelsListViewModel')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_LabelsListViewModel.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -17,21 +16,16 @@ import androidx.compose.ui.res.stringResource
|
||||
import com.homebox.lens.R
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('LocationEditScreen')]
|
||||
// [RELATION: Function('LocationEditScreen') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('LocationEditScreen') -> [CALLS] -> Function('Scaffold')]
|
||||
// [RELATION: Function('LocationEditScreen') -> [CALLS] -> Function('Box')]
|
||||
// [RELATION: Function('LocationEditScreen') -> [CALLS] -> Function('Text')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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(locationId: String?) {
|
||||
val title =
|
||||
if (locationId == "new") {
|
||||
fun LocationEditScreen(
|
||||
locationId: String?
|
||||
) {
|
||||
val title = if (locationId == "new") {
|
||||
stringResource(id = R.string.location_edit_title_create)
|
||||
} else {
|
||||
stringResource(id = R.string.location_edit_title_edit)
|
||||
@@ -39,16 +33,15 @@ fun LocationEditScreen(locationId: String?) {
|
||||
|
||||
Scaffold { paddingValues ->
|
||||
Box(
|
||||
modifier =
|
||||
Modifier
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.padding(paddingValues),
|
||||
contentAlignment = Alignment.Center,
|
||||
contentAlignment = Alignment.Center
|
||||
) {
|
||||
Text(text = "TODO: Location Edit Screen for ID: $locationId")
|
||||
// [AI_NOTE]: Implement Location Edit Screen UI
|
||||
Text(text = "Location Edit Screen for ID: $locationId")
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationEditScreen')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_LocationEditScreen.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -51,26 +50,17 @@ import com.homebox.lens.ui.common.MainScaffold
|
||||
import com.homebox.lens.ui.theme.HomeboxLensTheme
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('LocationsListScreen')]
|
||||
// [RELATION: Function('LocationsListScreen') -> [DEPENDS_ON] -> Class('NavigationActions')]
|
||||
// [RELATION: Function('LocationsListScreen') -> [DEPENDS_ON] -> Class('LocationsListViewModel')]
|
||||
// [RELATION: Function('LocationsListScreen') -> [CALLS] -> Function('hiltViewModel')]
|
||||
// [RELATION: Function('LocationsListScreen') -> [CALLS] -> Function('collectAsState')]
|
||||
// [RELATION: Function('LocationsListScreen') -> [CALLS] -> Function('MainScaffold')]
|
||||
// [RELATION: Function('LocationsListScreen') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('LocationsListScreen') -> [CALLS] -> Function('Scaffold')]
|
||||
// [RELATION: Function('LocationsListScreen') -> [CALLS] -> Function('FloatingActionButton')]
|
||||
// [RELATION: Function('LocationsListScreen') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('LocationsListScreen') -> [CALLS] -> Function('LocationsListContent')]
|
||||
// [RELATION: Function('LocationsListScreen')] -> [DEPENDS_ON] -> [ViewModel('LocationsListViewModel')]
|
||||
// [RELATION: Function('LocationsListScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('LocationsListScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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(
|
||||
@@ -78,16 +68,14 @@ fun LocationsListScreen(
|
||||
navigationActions: NavigationActions,
|
||||
onLocationClick: (String) -> Unit,
|
||||
onAddNewLocationClick: () -> Unit,
|
||||
viewModel: LocationsListViewModel = hiltViewModel(),
|
||||
viewModel: LocationsListViewModel = hiltViewModel()
|
||||
) {
|
||||
// [STATE]
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
// [UI_COMPONENT]
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.locations_list_title),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions,
|
||||
navigationActions = navigationActions
|
||||
) { paddingValues ->
|
||||
Scaffold(
|
||||
modifier = Modifier.padding(paddingValues),
|
||||
@@ -95,17 +83,17 @@ fun LocationsListScreen(
|
||||
FloatingActionButton(onClick = onAddNewLocationClick) {
|
||||
Icon(
|
||||
Icons.Default.Add,
|
||||
contentDescription = stringResource(id = R.string.cd_add_new_location),
|
||||
contentDescription = stringResource(id = R.string.cd_add_new_location)
|
||||
)
|
||||
}
|
||||
},
|
||||
}
|
||||
) { innerPadding ->
|
||||
LocationsListContent(
|
||||
modifier = Modifier.padding(innerPadding),
|
||||
uiState = uiState,
|
||||
onLocationClick = onLocationClick,
|
||||
onEditLocation = { /* TODO */ },
|
||||
onDeleteLocation = { /* TODO */ },
|
||||
onEditLocation = { /* [AI_NOTE]: Implement onEditLocation */ },
|
||||
onDeleteLocation = { /* [AI_NOTE]: Implement onDeleteLocation */ }
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -113,22 +101,14 @@ fun LocationsListScreen(
|
||||
// [END_ENTITY: Function('LocationsListScreen')]
|
||||
|
||||
// [ENTITY: Function('LocationsListContent')]
|
||||
// [RELATION: Function('LocationsListContent') -> [DEPENDS_ON] -> SealedInterface('LocationsListUiState')]
|
||||
// [RELATION: Function('LocationsListContent') -> [CALLS] -> Function('Box')]
|
||||
// [RELATION: Function('LocationsListContent') -> [CALLS] -> Function('CircularProgressIndicator')]
|
||||
// [RELATION: Function('LocationsListContent') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('LocationsListContent') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('LocationsListContent') -> [CALLS] -> Function('MaterialTheme.colorScheme.error')]
|
||||
// [RELATION: Function('LocationsListContent') -> [CALLS] -> Function('LazyColumn')]
|
||||
// [RELATION: Function('LocationsListContent') -> [CALLS] -> Function('LocationCard')]
|
||||
// [RELATION: Function('LocationsListContent')] -> [CONSUMES_STATE] -> [SealedInterface('LocationsListUiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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(
|
||||
@@ -136,7 +116,7 @@ private fun LocationsListContent(
|
||||
uiState: LocationsListUiState,
|
||||
onLocationClick: (String) -> Unit,
|
||||
onEditLocation: (String) -> Unit,
|
||||
onDeleteLocation: (String) -> Unit,
|
||||
onDeleteLocation: (String) -> Unit
|
||||
) {
|
||||
Box(modifier = modifier.fillMaxSize()) {
|
||||
when (uiState) {
|
||||
@@ -148,10 +128,9 @@ private fun LocationsListContent(
|
||||
text = uiState.message,
|
||||
color = MaterialTheme.colorScheme.error,
|
||||
textAlign = TextAlign.Center,
|
||||
modifier =
|
||||
Modifier
|
||||
modifier = Modifier
|
||||
.align(Alignment.Center)
|
||||
.padding(16.dp),
|
||||
.padding(16.dp)
|
||||
)
|
||||
}
|
||||
is LocationsListUiState.Success -> {
|
||||
@@ -159,22 +138,21 @@ private fun LocationsListContent(
|
||||
Text(
|
||||
text = stringResource(id = R.string.locations_not_found),
|
||||
textAlign = TextAlign.Center,
|
||||
modifier =
|
||||
Modifier
|
||||
modifier = Modifier
|
||||
.align(Alignment.Center)
|
||||
.padding(16.dp),
|
||||
.padding(16.dp)
|
||||
)
|
||||
} else {
|
||||
LazyColumn(
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(12.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(12.dp)
|
||||
) {
|
||||
items(uiState.locations, key = { it.id }) { location ->
|
||||
LocationCard(
|
||||
location = location,
|
||||
onClick = { onLocationClick(location.id) },
|
||||
onEditClick = { onEditLocation(location.id) },
|
||||
onDeleteClick = { onDeleteLocation(location.id) },
|
||||
onDeleteClick = { onDeleteLocation(location.id) }
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -186,56 +164,38 @@ private fun LocationsListContent(
|
||||
// [END_ENTITY: Function('LocationsListContent')]
|
||||
|
||||
// [ENTITY: Function('LocationCard')]
|
||||
// [RELATION: Function('LocationCard') -> [DEPENDS_ON] -> Class('LocationOutCount')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('remember')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('mutableStateOf')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('Card')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('clickable')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('Row')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('MaterialTheme.typography.titleMedium')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('MaterialTheme.typography.bodyMedium')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('Spacer')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('Box')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('IconButton')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('DropdownMenu')]
|
||||
// [RELATION: Function('LocationCard') -> [CALLS] -> Function('DropdownMenuItem')]
|
||||
// [RELATION: Function('LocationCard')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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(
|
||||
location: LocationOutCount,
|
||||
onClick: () -> Unit,
|
||||
onEditClick: () -> Unit,
|
||||
onDeleteClick: () -> Unit,
|
||||
onDeleteClick: () -> Unit
|
||||
) {
|
||||
var menuExpanded by remember { mutableStateOf(false) }
|
||||
|
||||
Card(
|
||||
modifier =
|
||||
Modifier
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.clickable(onClick = onClick),
|
||||
.clickable(onClick = onClick)
|
||||
) {
|
||||
Row(
|
||||
modifier = Modifier.padding(start = 16.dp, end = 8.dp, top = 16.dp, bottom = 16.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
horizontalArrangement = Arrangement.SpaceBetween,
|
||||
horizontalArrangement = Arrangement.SpaceBetween
|
||||
) {
|
||||
Column(modifier = Modifier.weight(1f)) {
|
||||
Text(text = location.name, style = MaterialTheme.typography.titleMedium)
|
||||
Text(
|
||||
text = stringResource(id = R.string.item_count, location.itemCount),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
style = MaterialTheme.typography.bodyMedium
|
||||
)
|
||||
}
|
||||
Spacer(Modifier.width(16.dp))
|
||||
@@ -245,21 +205,21 @@ private fun LocationCard(
|
||||
}
|
||||
DropdownMenu(
|
||||
expanded = menuExpanded,
|
||||
onDismissRequest = { menuExpanded = false },
|
||||
onDismissRequest = { menuExpanded = false }
|
||||
) {
|
||||
DropdownMenuItem(
|
||||
text = { Text(stringResource(id = R.string.edit)) },
|
||||
onClick = {
|
||||
menuExpanded = false
|
||||
onEditClick()
|
||||
},
|
||||
}
|
||||
)
|
||||
DropdownMenuItem(
|
||||
text = { Text(stringResource(id = R.string.delete)) },
|
||||
onClick = {
|
||||
menuExpanded = false
|
||||
onDeleteClick()
|
||||
},
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -269,36 +229,26 @@ private fun LocationCard(
|
||||
// [END_ENTITY: Function('LocationCard')]
|
||||
|
||||
// [ENTITY: Function('LocationsListSuccessPreview')]
|
||||
// [RELATION: Function('LocationsListSuccessPreview') -> [CALLS] -> Function('LocationOutCount')]
|
||||
// [RELATION: Function('LocationsListSuccessPreview') -> [CALLS] -> Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('LocationsListSuccessPreview') -> [CALLS] -> Function('LocationsListContent')]
|
||||
// [RELATION: Function('LocationsListSuccessPreview') -> [CALLS] -> Function('LocationsListUiState.Success')]
|
||||
// [PREVIEW]
|
||||
@Preview(showBackground = true, name = "Locations List Success")
|
||||
@Composable
|
||||
fun LocationsListSuccessPreview() {
|
||||
val previewLocations =
|
||||
listOf(
|
||||
val previewLocations = listOf(
|
||||
LocationOutCount("1", "Garage", "#FF0000", false, 12, "", ""),
|
||||
LocationOutCount("2", "Kitchen", "#00FF00", false, 5, "", ""),
|
||||
LocationOutCount("3", "Office", "#0000FF", false, 23, "", ""),
|
||||
LocationOutCount("3", "Office", "#0000FF", false, 23, "", "")
|
||||
)
|
||||
HomeboxLensTheme {
|
||||
LocationsListContent(
|
||||
uiState = LocationsListUiState.Success(previewLocations),
|
||||
onLocationClick = {},
|
||||
onEditLocation = {},
|
||||
onDeleteLocation = {},
|
||||
onDeleteLocation = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsListSuccessPreview')]
|
||||
|
||||
// [ENTITY: Function('LocationsListEmptyPreview')]
|
||||
// [RELATION: Function('LocationsListEmptyPreview') -> [CALLS] -> Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('LocationsListEmptyPreview') -> [CALLS] -> Function('LocationsListContent')]
|
||||
// [RELATION: Function('LocationsListEmptyPreview') -> [CALLS] -> Function('LocationsListUiState.Success')]
|
||||
// [PREVIEW]
|
||||
@Preview(showBackground = true, name = "Locations List Empty")
|
||||
@Composable
|
||||
fun LocationsListEmptyPreview() {
|
||||
@@ -307,17 +257,13 @@ fun LocationsListEmptyPreview() {
|
||||
uiState = LocationsListUiState.Success(emptyList()),
|
||||
onLocationClick = {},
|
||||
onEditLocation = {},
|
||||
onDeleteLocation = {},
|
||||
onDeleteLocation = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsListEmptyPreview')]
|
||||
|
||||
// [ENTITY: Function('LocationsListLoadingPreview')]
|
||||
// [RELATION: Function('LocationsListLoadingPreview') -> [CALLS] -> Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('LocationsListLoadingPreview') -> [CALLS] -> Function('LocationsListContent')]
|
||||
// [RELATION: Function('LocationsListLoadingPreview') -> [CALLS] -> Function('LocationsListUiState.Loading')]
|
||||
// [PREVIEW]
|
||||
@Preview(showBackground = true, name = "Locations List Loading")
|
||||
@Composable
|
||||
fun LocationsListLoadingPreview() {
|
||||
@@ -326,18 +272,13 @@ fun LocationsListLoadingPreview() {
|
||||
uiState = LocationsListUiState.Loading,
|
||||
onLocationClick = {},
|
||||
onEditLocation = {},
|
||||
onDeleteLocation = {},
|
||||
onDeleteLocation = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsListLoadingPreview')]
|
||||
|
||||
// [ENTITY: Function('LocationsListErrorPreview')]
|
||||
// [RELATION: Function('LocationsListErrorPreview') -> [CALLS] -> Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('LocationsListErrorPreview') -> [CALLS] -> Function('LocationsListContent')]
|
||||
// [RELATION: Function('LocationsListErrorPreview') -> [CALLS] -> Function('LocationsListUiState.Error')]
|
||||
// [RELATION: Function('LocationsListErrorPreview') -> [CALLS] -> Function('stringResource')]
|
||||
// [PREVIEW]
|
||||
@Preview(showBackground = true, name = "Locations List Error")
|
||||
@Composable
|
||||
fun LocationsListErrorPreview() {
|
||||
@@ -346,10 +287,9 @@ fun LocationsListErrorPreview() {
|
||||
uiState = LocationsListUiState.Error("Failed to load locations. Please try again."),
|
||||
onLocationClick = {},
|
||||
onEditLocation = {},
|
||||
onDeleteLocation = {},
|
||||
onDeleteLocation = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsListErrorPreview')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_LocationsListScreen.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,41 +7,35 @@ package com.homebox.lens.ui.screen.locationslist
|
||||
import com.homebox.lens.domain.model.LocationOutCount
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: SealedInterface('LocationsListUiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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] -> Class('LocationOutCount')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
|
||||
/**
|
||||
* [STATE]
|
||||
* @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')]
|
||||
/**
|
||||
* [STATE]
|
||||
* @summary Состояние ошибки.
|
||||
* @param message Сообщение об ошибке.
|
||||
* @summary The error state.
|
||||
* @param message The error message.
|
||||
*/
|
||||
data class Error(val message: String) : LocationsListUiState
|
||||
// [END_ENTITY: DataClass('Error')]
|
||||
|
||||
// [ENTITY: DataObject('Loading')]
|
||||
// [ENTITY: Object('Loading')]
|
||||
/**
|
||||
* [STATE]
|
||||
* @summary Состояние загрузки данных.
|
||||
* @summary The data loading state.
|
||||
*/
|
||||
object Loading : LocationsListUiState
|
||||
// [END_ENTITY: DataObject('Loading')]
|
||||
// [END_ENTITY: Object('Loading')]
|
||||
}
|
||||
// [END_ENTITY: SealedInterface('LocationsListUiState')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_LocationsListUiState.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -13,58 +12,52 @@ import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.launch
|
||||
import timber.log.Timber
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: ViewModel('LocationsListViewModel')]
|
||||
// [RELATION: ViewModel('LocationsListViewModel') -> [INHERITS_FROM] -> Class('ViewModel')]
|
||||
// [RELATION: ViewModel('LocationsListViewModel') -> [DEPENDS_ON] -> Annotation('HiltViewModel')]
|
||||
// [RELATION: ViewModel('LocationsListViewModel') -> [DEPENDS_ON] -> Class('GetAllLocationsUseCase')]
|
||||
// [RELATION: ViewModel('LocationsListViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLocationsUseCase')]
|
||||
// [RELATION: ViewModel('LocationsListViewModel')] -> [EMITS_STATE] -> [SealedInterface('LocationsListUiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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(
|
||||
private val getAllLocationsUseCase: GetAllLocationsUseCase,
|
||||
) : ViewModel() {
|
||||
// [STATE]
|
||||
class LocationsListViewModel @Inject constructor(
|
||||
private val getAllLocationsUseCase: GetAllLocationsUseCase
|
||||
) : ViewModel() {
|
||||
|
||||
private val _uiState = MutableStateFlow<LocationsListUiState>(LocationsListUiState.Loading)
|
||||
val uiState: StateFlow<LocationsListUiState> = _uiState.asStateFlow()
|
||||
|
||||
// [INITIALIZER]
|
||||
init {
|
||||
loadLocations()
|
||||
}
|
||||
|
||||
// [ENTITY: Function('loadLocations')]
|
||||
// [RELATION: Function('loadLocations') -> [CALLS] -> Function('viewModelScope.launch')]
|
||||
// [RELATION: Function('loadLocations') -> [WRITES_TO] -> Property('_uiState')]
|
||||
// [RELATION: Function('loadLocations') -> [CALLS] -> Function('getAllLocationsUseCase')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @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.")
|
||||
viewModelScope.launch {
|
||||
_uiState.value = LocationsListUiState.Loading
|
||||
try {
|
||||
Timber.d("[DEBUG][ACTION][fetching_locations] Fetching locations from use case.")
|
||||
val locations = getAllLocationsUseCase()
|
||||
_uiState.value = LocationsListUiState.Success(locations)
|
||||
Timber.d("[DEBUG][SUCCESS][locations_loaded] Successfully loaded locations.")
|
||||
} catch (e: Exception) {
|
||||
Timber.e(e, "[ERROR][EXCEPTION][loading_failed] Failed to load locations.")
|
||||
_uiState.value = LocationsListUiState.Error(e.message ?: "Unknown error")
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('loadLocations')]
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: ViewModel('LocationsListViewModel')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_LocationsListViewModel.kt]
|
||||
@@ -1,129 +1,38 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.search
|
||||
// [FILE] SearchScreen.kt
|
||||
// [SEMANTICS] ui, screen, search, compose
|
||||
// [SEMANTICS] app, ui, screen, search
|
||||
|
||||
package com.homebox.lens.ui.screen.search
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.*
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.automirrored.filled.ArrowBack
|
||||
import androidx.compose.material3.*
|
||||
import androidx.compose.runtime.*
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.domain.model.Item
|
||||
import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.ui.common.MainScaffold
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('SearchScreen')]
|
||||
// [RELATION: Function('SearchScreen') -> [DEPENDS_ON] -> Class('SearchViewModel')]
|
||||
// [RELATION: Function('SearchScreen') -> [CALLS] -> Function('hiltViewModel')]
|
||||
// [RELATION: Function('SearchScreen') -> [CALLS] -> Function('collectAsState')]
|
||||
// [RELATION: Function('SearchScreen') -> [CALLS] -> Function('Scaffold')]
|
||||
// [RELATION: Function('SearchScreen') -> [CALLS] -> Function('TopAppBar')]
|
||||
// [RELATION: Function('SearchScreen') -> [CALLS] -> Function('TextField')]
|
||||
// [RELATION: Function('SearchScreen') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('SearchScreen') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('SearchScreen') -> [CALLS] -> Function('IconButton')]
|
||||
// [RELATION: Function('SearchScreen') -> [CALLS] -> Function('Icon')]
|
||||
// [RELATION: Function('SearchScreen') -> [CALLS] -> Function('SearchContent')]
|
||||
// [RELATION: Function('SearchScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('SearchScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* [MAIN-CONTRACT]
|
||||
* Специализированный экран для поиска товаров.
|
||||
*
|
||||
* Реализует спецификацию `screen_search`.
|
||||
*
|
||||
* @param onNavigateBack Обработчик для возврата на предыдущий экран.
|
||||
* @param onItemClick Обработчик нажатия на найденный товар.
|
||||
* @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.
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
fun SearchScreen(
|
||||
viewModel: SearchViewModel = hiltViewModel(),
|
||||
onNavigateBack: () -> Unit,
|
||||
onItemClick: (Item) -> Unit
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions
|
||||
) {
|
||||
// [STATE]
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
Scaffold(
|
||||
topBar = {
|
||||
TopAppBar(
|
||||
title = {
|
||||
TextField(
|
||||
value = uiState.searchQuery,
|
||||
onValueChange = viewModel::onSearchQueryChanged,
|
||||
placeholder = { Text(stringResource(R.string.placeholder_search_items)) },
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
},
|
||||
navigationIcon = {
|
||||
IconButton(onClick = onNavigateBack) {
|
||||
Icon(Icons.AutoMirrored.Filled.ArrowBack, contentDescription = stringResource(R.string.content_desc_navigate_back))
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
) { innerPadding ->
|
||||
SearchContent(
|
||||
modifier = Modifier.padding(innerPadding),
|
||||
isLoading = uiState.isLoading,
|
||||
results = uiState.results,
|
||||
onItemClick = onItemClick
|
||||
)
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.search_title),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) {
|
||||
// [AI_NOTE]: Implement Search Screen UI
|
||||
Text(text = "Search Screen")
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('SearchScreen')]
|
||||
|
||||
// [ENTITY: Function('SearchContent')]
|
||||
// [RELATION: Function('SearchContent') -> [CALLS] -> Function('CircularProgressIndicator')]
|
||||
// [RELATION: Function('SearchContent') -> [CALLS] -> Function('LazyColumn')]
|
||||
// [RELATION: Function('SearchContent') -> [CALLS] -> Function('ListItem')]
|
||||
// [RELATION: Function('SearchContent') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('SearchContent') -> [CALLS] -> Function('clickable')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Отображает основной контент экрана: фильтры и результаты поиска.
|
||||
*/
|
||||
@Composable
|
||||
private fun SearchContent(
|
||||
modifier: Modifier = Modifier,
|
||||
isLoading: Boolean,
|
||||
results: List<Item>,
|
||||
onItemClick: (Item) -> Unit
|
||||
) {
|
||||
Column(modifier = modifier.fillMaxSize()) {
|
||||
// [SECTION] FILTERS
|
||||
// TODO: Implement FilterSection with chips for locations/labels
|
||||
// Spacer(modifier = Modifier.height(8.dp))
|
||||
|
||||
// [SECTION] RESULTS
|
||||
Box(modifier = Modifier.weight(1f)) {
|
||||
if (isLoading) {
|
||||
// [STATE]
|
||||
CircularProgressIndicator(modifier = Modifier.align(Alignment.Center))
|
||||
} else {
|
||||
// [CORE-LOGIC]
|
||||
LazyColumn {
|
||||
items(results, key = { it.id }) { item ->
|
||||
ListItem(
|
||||
headlineContent = { Text(item.name) },
|
||||
supportingContent = { Text(item.location?.name ?: "") },
|
||||
modifier = Modifier.then(Modifier.clickable { onItemClick(item) })
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('SearchContent')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_SearchScreen.kt]
|
||||
@@ -1,44 +1,20 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.search
|
||||
// [FILE] SearchViewModel.kt
|
||||
// [SEMANTICS] ui_logic, search, viewmodel
|
||||
|
||||
// [SEMANTICS] app, ui, viewmodel, search
|
||||
package com.homebox.lens.ui.screen.search
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import javax.inject.Inject
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: ViewModel('SearchViewModel')]
|
||||
// [RELATION: ViewModel('SearchViewModel') -> [INHERITS_FROM] -> Class('ViewModel')]
|
||||
// [RELATION: ViewModel('SearchViewModel') -> [DEPENDS_ON] -> Annotation('HiltAndroidApp')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @summary ViewModel for the SearchScreen.
|
||||
* @summary ViewModel for the search screen.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class SearchViewModel
|
||||
@Inject
|
||||
constructor() : ViewModel() {
|
||||
// [STATE]
|
||||
// TODO: Implement UI state
|
||||
val uiState = MutableStateFlow(SearchUiState()).asStateFlow()
|
||||
|
||||
fun onSearchQueryChanged(query: String) {
|
||||
// TODO: Implement search query change logic
|
||||
}
|
||||
}
|
||||
class SearchViewModel @Inject constructor() : ViewModel() {
|
||||
// [AI_NOTE]: Implement UI state
|
||||
}
|
||||
// [END_ENTITY: ViewModel('SearchViewModel')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_SearchViewModel.kt]
|
||||
|
||||
// Placeholder for SearchUiState to resolve compilation errors
|
||||
data class SearchUiState(
|
||||
val searchQuery: String = "",
|
||||
val isLoading: Boolean = false,
|
||||
val results: List<com.homebox.lens.domain.model.Item> = emptyList()
|
||||
)
|
||||
@@ -0,0 +1,52 @@
|
||||
// [FILE] SettingsScreen.kt
|
||||
// [SEMANTICS] app, ui, screen, settings
|
||||
|
||||
package com.homebox.lens.ui.screen.settings
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.layout.Box
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.material3.ExperimentalMaterial3Api
|
||||
import androidx.compose.material3.Scaffold
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.material3.TopAppBar
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.ui.common.MainScaffold
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('SettingsScreen')]
|
||||
// [RELATION: Function('SettingsScreen')] -> [DEPENDS_ON] -> [Class('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
|
||||
fun SettingsScreen(
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions
|
||||
) {
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.screen_title_settings),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) { paddingValues ->
|
||||
Box(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.padding(paddingValues),
|
||||
contentAlignment = Alignment.Center
|
||||
) {
|
||||
Text(text = "Settings Screen (Under Construction)")
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('SettingsScreen')]
|
||||
// [END_FILE_SettingsScreen.kt]
|
||||
@@ -1,126 +1,175 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.setup
|
||||
// [FILE] SetupScreen.kt
|
||||
// [SEMANTICS] ui, screen, setup, login, compose
|
||||
// [SEMANTICS] app, ui, screen, setup
|
||||
|
||||
@file:OptIn(ExperimentalMaterial3Api::class)
|
||||
|
||||
package com.homebox.lens.ui.screen.setup
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.Image
|
||||
import androidx.compose.foundation.layout.*
|
||||
import androidx.compose.foundation.text.KeyboardOptions
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.filled.Lock
|
||||
import androidx.compose.material3.*
|
||||
import androidx.compose.runtime.*
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.collectAsState
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.painterResource
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.text.input.KeyboardType
|
||||
import androidx.compose.ui.text.input.PasswordVisualTransformation
|
||||
import androidx.compose.ui.tooling.preview.Preview
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.compose.ui.unit.sp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import com.homebox.lens.R
|
||||
import timber.log.Timber
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Function('SetupScreen')]
|
||||
// [RELATION: Function('SetupScreen') -> [DEPENDS_ON] -> Class('SetupViewModel')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('hiltViewModel')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('collectAsState')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('LaunchedEffect')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('Timber.i')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('Box')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('Column')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('Text')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('stringResource')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('MaterialTheme.typography.headlineMedium')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('OutlinedTextField')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('KeyboardOptions')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('KeyboardType.Uri')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('PasswordVisualTransformation')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('CircularProgressIndicator')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('Button')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('MaterialTheme.colorScheme.error')]
|
||||
// [RELATION: Function('SetupScreen') -> [CALLS] -> Function('MaterialTheme.typography.bodyMedium')]
|
||||
// [RELATION: Function('SetupScreen')] -> [DEPENDS_ON] -> [ViewModel('SetupViewModel')]
|
||||
// [RELATION: Function('SetupScreen')] -> [CALLS] -> [Function('SetupScreenContent')]
|
||||
/**
|
||||
* [MAIN-CONTRACT]
|
||||
* Экран для начальной настройки соединения с сервером Homebox.
|
||||
*
|
||||
* @param onSetupComplete Обработчик, вызываемый после успешной настройки и входа.
|
||||
* @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.
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
fun SetupScreen(
|
||||
viewModel: SetupViewModel = hiltViewModel(),
|
||||
onSetupComplete: () -> Unit
|
||||
) {
|
||||
// [STATE]
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
// [SIDE-EFFECT]
|
||||
LaunchedEffect(uiState.isSetupComplete) {
|
||||
if (uiState.isSetupComplete) {
|
||||
Timber.i("[INFO][SIDE_EFFECT][navigation] Setup complete, navigating to main screen.")
|
||||
onSetupComplete()
|
||||
}
|
||||
}
|
||||
|
||||
// [CORE-LOGIC]
|
||||
Box(
|
||||
modifier = Modifier.fillMaxSize(),
|
||||
contentAlignment = Alignment.Center
|
||||
) {
|
||||
SetupScreenContent(
|
||||
uiState = uiState,
|
||||
onServerUrlChange = viewModel::onServerUrlChange,
|
||||
onUsernameChange = viewModel::onUsernameChange,
|
||||
onPasswordChange = viewModel::onPasswordChange,
|
||||
onConnectClick = viewModel::connect
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('SetupScreen')]
|
||||
|
||||
// [ENTITY: Function('SetupScreenContent')]
|
||||
// [RELATION: Function('SetupScreenContent')] -> [CONSUMES_STATE] -> [DataClass('SetupUiState')]
|
||||
/**
|
||||
* @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(
|
||||
uiState: SetupUiState,
|
||||
onServerUrlChange: (String) -> Unit,
|
||||
onUsernameChange: (String) -> Unit,
|
||||
onPasswordChange: (String) -> Unit,
|
||||
onConnectClick: () -> Unit
|
||||
) {
|
||||
Scaffold { paddingValues ->
|
||||
Column(
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(32.dp),
|
||||
horizontalAlignment = Alignment.CenterHorizontally,
|
||||
verticalArrangement = Arrangement.spacedBy(16.dp)
|
||||
.fillMaxSize()
|
||||
.padding(paddingValues)
|
||||
.padding(16.dp),
|
||||
verticalArrangement = Arrangement.Center,
|
||||
horizontalAlignment = Alignment.CenterHorizontally
|
||||
) {
|
||||
Text(text = stringResource(id = R.string.screen_title_setup), style = MaterialTheme.typography.headlineMedium)
|
||||
Image(
|
||||
imageVector = Icons.Default.Lock,
|
||||
contentDescription = stringResource(id = R.string.app_name),
|
||||
modifier = Modifier.size(128.dp)
|
||||
)
|
||||
Spacer(modifier = Modifier.height(16.dp))
|
||||
Text(
|
||||
text = stringResource(id = R.string.setup_title),
|
||||
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))
|
||||
|
||||
Card(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
elevation = CardDefaults.cardElevation(defaultElevation = 4.dp)
|
||||
) {
|
||||
Column(
|
||||
modifier = Modifier.padding(16.dp)
|
||||
) {
|
||||
OutlinedTextField(
|
||||
value = uiState.serverUrl,
|
||||
onValueChange = viewModel::onServerUrlChange,
|
||||
onValueChange = onServerUrlChange,
|
||||
label = { Text(stringResource(id = R.string.setup_server_url_label)) },
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Uri),
|
||||
isError = uiState.error != null
|
||||
)
|
||||
|
||||
OutlinedTextField(
|
||||
value = uiState.password, // Changed from uiState.apiKey to uiState.password
|
||||
onValueChange = viewModel::onPasswordChange, // Changed from viewModel::onApiKeyChange to viewModel::onPasswordChange
|
||||
label = { Text(stringResource(id = R.string.setup_password_label)) }, // Changed from label_api_key to setup_password_label
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
visualTransformation = PasswordVisualTransformation(),
|
||||
isError = uiState.error != null
|
||||
)
|
||||
|
||||
if (uiState.isLoading) {
|
||||
// [STATE]
|
||||
CircularProgressIndicator()
|
||||
} else {
|
||||
// [ACTION]
|
||||
Button(
|
||||
onClick = {
|
||||
Timber.i("[INFO][ACTION][ui_interaction] Login button clicked.")
|
||||
viewModel.connect() // Changed from viewModel.login() to viewModel.connect()
|
||||
},
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
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(8.dp))
|
||||
OutlinedTextField(
|
||||
value = uiState.password,
|
||||
onValueChange = onPasswordChange,
|
||||
label = { Text(stringResource(id = R.string.setup_password_label)) },
|
||||
visualTransformation = PasswordVisualTransformation(),
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
}
|
||||
}
|
||||
Spacer(modifier = Modifier.height(24.dp))
|
||||
Button(
|
||||
onClick = onConnectClick,
|
||||
enabled = !uiState.isLoading,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.height(50.dp)
|
||||
) {
|
||||
Text(text = stringResource(id = R.string.setup_connect_button)) // Changed from button_connect to setup_connect_button
|
||||
if (uiState.isLoading) {
|
||||
CircularProgressIndicator(
|
||||
modifier = Modifier.size(24.dp),
|
||||
color = MaterialTheme.colorScheme.onPrimary
|
||||
)
|
||||
} else {
|
||||
Text(stringResource(id = R.string.setup_connect_button))
|
||||
}
|
||||
}
|
||||
|
||||
uiState.error?.let {
|
||||
// [FALLBACK]
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
Text(
|
||||
text = it,
|
||||
color = MaterialTheme.colorScheme.error,
|
||||
style = MaterialTheme.typography.bodyMedium
|
||||
color = MaterialTheme.colorScheme.error
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('SetupScreen')]
|
||||
// [END_CONTRACT]
|
||||
// [END_ENTITY: Function('SetupScreenContent')]
|
||||
|
||||
// [ENTITY: Function('SetupScreenPreview')]
|
||||
@Preview(showBackground = true)
|
||||
@Composable
|
||||
fun SetupScreenPreview() {
|
||||
SetupScreenContent(
|
||||
uiState = SetupUiState(error = "Failed to connect"),
|
||||
onServerUrlChange = {},
|
||||
onUsernameChange = {},
|
||||
onPasswordChange = {},
|
||||
onConnectClick = {}
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('SetupScreenPreview')]
|
||||
// [END_FILE_SetupScreen.kt]
|
||||
@@ -1,25 +1,18 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.setup
|
||||
// [FILE] SetupUiState.kt
|
||||
// [SEMANTICS] ui_state, data_model, immutable
|
||||
|
||||
package com.homebox.lens.ui.screen.setup
|
||||
|
||||
// [IMPORTS]
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: DataClass('SetupUiState')]
|
||||
/**
|
||||
* [ENTITY: DataClass('SetupUiState')]
|
||||
* [CONTRACT]
|
||||
* Неизменяемая модель данных, представляющая полное состояние экрана настройки (Setup Screen).
|
||||
* Использование `data class` предоставляет метод `copy()` для легкого создания новых состояний.
|
||||
* @property serverUrl URL-адрес сервера Homebox.
|
||||
* @property username Имя пользователя для входа.
|
||||
* @property password Пароль пользователя.
|
||||
* @property isLoading Флаг, указывающий, выполняется ли в данный момент сетевой запрос.
|
||||
* @property error Сообщение об ошибке для отображения пользователю, или `null` при отсутствии ошибки.
|
||||
* @property isSetupComplete Флаг, указывающий на успешное завершение настройки и входа.
|
||||
* @summary Неизменяемая модель данных, представляющая полное состояние экрана настройки (Setup Screen).
|
||||
* @description Использование `data class` предоставляет метод `copy()` для легкого создания новых состояний.
|
||||
* @param serverUrl URL-адрес сервера Homebox.
|
||||
* @param username Имя пользователя для входа.
|
||||
* @param password Пароль пользователя.
|
||||
* @param isLoading Флаг, указывающий, выполняется ли в данный момент сетевой запрос.
|
||||
* @param error Сообщение об ошибке для отображения пользователю, или `null` при отсутствии ошибки.
|
||||
* @param isSetupComplete Флаг, указывающий на успешное завершение настройки и входа.
|
||||
*/
|
||||
data class SetupUiState(
|
||||
val serverUrl: String = "",
|
||||
@@ -27,8 +20,7 @@ data class SetupUiState(
|
||||
val password: String = "",
|
||||
val isLoading: Boolean = false,
|
||||
val error: String? = null,
|
||||
val isSetupComplete: Boolean = false,
|
||||
val isSetupComplete: Boolean = false
|
||||
)
|
||||
// [END_ENTITY: DataClass('SetupUiState')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_SetupUiState.kt]
|
||||
@@ -1,4 +1,3 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.setup
|
||||
// [FILE] SetupViewModel.kt
|
||||
// [SEMANTICS] ui_logic, viewmodel, state_management, user_setup, authentication_flow
|
||||
package com.homebox.lens.ui.screen.setup
|
||||
@@ -14,64 +13,45 @@ import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.update
|
||||
import kotlinx.coroutines.launch
|
||||
import timber.log.Timber
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: ViewModel('SetupViewModel')]
|
||||
// [RELATION: ViewModel('SetupViewModel') -> [INHERITS_FROM] -> Class('ViewModel')]
|
||||
// [RELATION: ViewModel('SetupViewModel') -> [DEPENDS_ON] -> Annotation('HiltViewModel')]
|
||||
// [RELATION: ViewModel('SetupViewModel') -> [DEPENDS_ON] -> Class('CredentialsRepository')]
|
||||
// [RELATION: ViewModel('SetupViewModel') -> [DEPENDS_ON] -> Class('LoginUseCase')]
|
||||
// [RELATION: ViewModel('SetupViewModel')] -> [DEPENDS_ON] -> [Repository('CredentialsRepository')]
|
||||
// [RELATION: ViewModel('SetupViewModel')] -> [DEPENDS_ON] -> [UseCase('LoginUseCase')]
|
||||
// [RELATION: ViewModel('SetupViewModel')] -> [EMITS_STATE] -> [DataClass('SetupUiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* ViewModel для экрана первоначальной настройки (Setup).
|
||||
* Отвечает за:
|
||||
* 1. Загрузку и сохранение учетных данных (URL сервера, логин, пароль).
|
||||
* 2. Управление состоянием UI экрана (`SetupUiState`).
|
||||
* 3. Инициацию процесса входа в систему через `LoginUseCase`.
|
||||
* @property credentialsRepository Репозиторий для операций с учетными данными.
|
||||
* @property loginUseCase Use case для выполнения логики входа.
|
||||
* @summary ViewModel для экрана первоначальной настройки (Setup).
|
||||
* @param credentialsRepository Репозиторий для операций с учетными данными.
|
||||
* @param loginUseCase Use case для выполнения логики входа.
|
||||
* @invariant Состояние `uiState` всегда является единственным источником истины для UI.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class SetupViewModel
|
||||
@Inject
|
||||
constructor(
|
||||
class SetupViewModel @Inject constructor(
|
||||
private val credentialsRepository: CredentialsRepository,
|
||||
private val loginUseCase: LoginUseCase,
|
||||
) : ViewModel() {
|
||||
// [STATE]
|
||||
private val loginUseCase: LoginUseCase
|
||||
) : ViewModel() {
|
||||
|
||||
private val _uiState = MutableStateFlow(SetupUiState())
|
||||
val uiState = _uiState.asStateFlow()
|
||||
|
||||
// [LIFECYCLE_HANDLER]
|
||||
init {
|
||||
// [ACTION] Загружаем учетные данные при создании ViewModel.
|
||||
loadCredentials()
|
||||
}
|
||||
|
||||
// [ENTITY: Function('loadCredentials')]
|
||||
// [RELATION: Function('loadCredentials') -> [CALLS] -> Function('viewModelScope.launch')]
|
||||
// [RELATION: Function('loadCredentials') -> [CALLS] -> Function('credentialsRepository.getCredentials')]
|
||||
// [RELATION: Function('loadCredentials') -> [CALLS] -> Function('collect')]
|
||||
// [RELATION: Function('loadCredentials') -> [WRITES_TO] -> Property('_uiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @summary Загружает учетные данные из репозитория при инициализации.
|
||||
* @sideeffect Асинхронно обновляет `_uiState` полученными учетными данными.
|
||||
*/
|
||||
private fun loadCredentials() {
|
||||
Timber.d("[DEBUG][ENTRYPOINT][loading_credentials] Loading credentials from repository.")
|
||||
viewModelScope.launch {
|
||||
// [CORE-LOGIC] Подписываемся на поток учетных данных.
|
||||
credentialsRepository.getCredentials().collect { credentials ->
|
||||
// [ACTION] Обновляем состояние, если учетные данные существуют.
|
||||
if (credentials != null) {
|
||||
Timber.d("[DEBUG][ACTION][updating_state] Credentials found, updating UI state.")
|
||||
_uiState.update {
|
||||
it.copy(
|
||||
serverUrl = credentials.serverUrl,
|
||||
username = credentials.username,
|
||||
password = credentials.password,
|
||||
password = credentials.password
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -81,92 +61,73 @@ class SetupViewModel
|
||||
// [END_ENTITY: Function('loadCredentials')]
|
||||
|
||||
// [ENTITY: Function('onServerUrlChange')]
|
||||
// [RELATION: Function('onServerUrlChange') -> [WRITES_TO] -> Property('_uiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* [ACTION] Обновляет URL сервера в состоянии UI в ответ на ввод пользователя.
|
||||
* @param newUrl Новое значение URL.
|
||||
* @sideeffect Обновляет поле `serverUrl` в `_uiState`.
|
||||
*/
|
||||
fun onServerUrlChange(newUrl: String) {
|
||||
_uiState.update { it.copy(serverUrl = newUrl) }
|
||||
}
|
||||
// [END_ENTITY: Function('onServerUrlChange')]
|
||||
|
||||
// [ENTITY: Function('onUsernameChange')]
|
||||
// [RELATION: Function('onUsernameChange') -> [WRITES_TO] -> Property('_uiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* [ACTION] Обновляет имя пользователя в состоянии UI в ответ на ввод пользователя.
|
||||
* @param newUsername Новое значение имени пользователя.
|
||||
* @sideeffect Обновляет поле `username` в `_uiState`.
|
||||
*/
|
||||
fun onUsernameChange(newUsername: String) {
|
||||
_uiState.update { it.copy(username = newUsername) }
|
||||
}
|
||||
// [END_ENTITY: Function('onUsernameChange')]
|
||||
|
||||
// [ENTITY: Function('onPasswordChange')]
|
||||
// [RELATION: Function('onPasswordChange') -> [WRITES_TO] -> Property('_uiState')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* [ACTION] Обновляет пароль в состоянии UI в ответ на ввод пользователя.
|
||||
* @param newPassword Новое значение пароля.
|
||||
* @sideeffect Обновляет поле `password` в `_uiState`.
|
||||
* @summary Updates the password in the UI state.
|
||||
* @param newPassword The new password.
|
||||
* @sideeffect Updates the `password` in `_uiState`.
|
||||
*/
|
||||
fun onPasswordChange(newPassword: String) {
|
||||
_uiState.update { it.copy(password = newPassword) }
|
||||
}
|
||||
// [END_ENTITY: Function('onPasswordChange')]
|
||||
|
||||
// [ENTITY: Function('connect')]
|
||||
// [RELATION: Function('connect') -> [CALLS] -> Function('viewModelScope.launch')]
|
||||
// [RELATION: Function('connect') -> [WRITES_TO] -> Property('_uiState')]
|
||||
// [RELATION: Function('connect') -> [CREATES_INSTANCE_OF] -> Class('Credentials')]
|
||||
// [RELATION: Function('connect') -> [CALLS] -> Function('credentialsRepository.saveCredentials')]
|
||||
// [RELATION: Function('connect') -> [CALLS] -> Function('loginUseCase')]
|
||||
// [RELATION: Function('connect') -> [CALLS] -> Function('fold')]
|
||||
// [ENTITY: Function('areCredentialsSaved')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* [ACTION] Запускает процесс подключения и входа в систему по действию пользователя.
|
||||
* Выполняет две основные операции:
|
||||
* 1. Сохраняет введенные учетные данные для последующих сессий.
|
||||
* 2. Выполняет вход в систему с использованием этих данных.
|
||||
* @sideeffect Обновляет `_uiState`, управляя флагами `isLoading`, `error` и `isSetupComplete`.
|
||||
* @sideeffect Вызывает `credentialsRepository.saveCredentials`, изменяя сохраненные данные.
|
||||
* @sideeffect Вызывает `loginUseCase`, который, в свою очередь, сохраняет токен.
|
||||
* @summary Checks synchronously if credentials are saved.
|
||||
* @return true if credentials are saved, false otherwise.
|
||||
* @sideeffect None.
|
||||
*/
|
||||
fun areCredentialsSaved(): Boolean {
|
||||
Timber.d("[DEBUG][ENTRYPOINT][checking_credentials_saved] Checking if credentials are saved.")
|
||||
return credentialsRepository.areCredentialsSavedSync()
|
||||
}
|
||||
// [END_ENTITY: Function('areCredentialsSaved')]
|
||||
|
||||
// [ENTITY: Function('connect')]
|
||||
/**
|
||||
* @summary Initiates the connection process, saving credentials and attempting to log in.
|
||||
* @sideeffect Updates `_uiState` with loading, error, and completion states.
|
||||
*/
|
||||
fun connect() {
|
||||
Timber.d("[DEBUG][ENTRYPOINT][connecting] Starting connection process.")
|
||||
viewModelScope.launch {
|
||||
// [ACTION] Устанавливаем состояние загрузки и сбрасываем предыдущую ошибку.
|
||||
_uiState.update { it.copy(isLoading = true, error = null) }
|
||||
|
||||
// [PREPARATION] Готовим данные для операций, очищая их от лишних пробелов.
|
||||
val credentials =
|
||||
Credentials(
|
||||
val credentials = Credentials(
|
||||
serverUrl = _uiState.value.serverUrl.trim(),
|
||||
username = _uiState.value.username.trim(),
|
||||
password = _uiState.value.password,
|
||||
password = _uiState.value.password
|
||||
)
|
||||
|
||||
// [ACTION] Сохраняем учетные данные для будущего использования.
|
||||
Timber.d("[DEBUG][ACTION][saving_credentials] Saving credentials.")
|
||||
credentialsRepository.saveCredentials(credentials)
|
||||
|
||||
// [CORE-LOGIC] Выполняем UseCase и обрабатываем результат.
|
||||
Timber.d("[DEBUG][ACTION][executing_login] Executing login use case.")
|
||||
loginUseCase(credentials).fold(
|
||||
onSuccess = {
|
||||
// [ACTION] Обработка успеха: обновляем UI, отмечая завершение настройки.
|
||||
Timber.d("[DEBUG][SUCCESS][login_successful] Login successful.")
|
||||
_uiState.update { it.copy(isLoading = false, isSetupComplete = true) }
|
||||
},
|
||||
onFailure = { exception ->
|
||||
// [ERROR_HANDLER] Обработка ошибки: обновляем UI с сообщением об ошибке.
|
||||
Timber.e(exception, "[ERROR][EXCEPTION][login_failed] Login failed.")
|
||||
_uiState.update { it.copy(isLoading = false, error = exception.message ?: "Login failed") }
|
||||
},
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('connect')]
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: ViewModel('SetupViewModel')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_SetupViewModel.kt]
|
||||
@@ -0,0 +1,58 @@
|
||||
// [FILE] SplashScreen.kt
|
||||
// [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
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.LaunchedEffect
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
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: Composable('SplashScreen')]
|
||||
// [RELATION: Composable('SplashScreen')] -> [DEPENDS_ON] -> [Framework('NavController')]
|
||||
// [RELATION: Composable('SplashScreen')] -> [DEPENDS_ON] -> [ViewModel('SetupViewModel')]
|
||||
/**
|
||||
* @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()
|
||||
) {
|
||||
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: Composable('SplashScreen')]
|
||||
// [END_FILE_SplashScreen.kt]
|
||||
@@ -1,36 +1,17 @@
|
||||
// [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]
|
||||
import androidx.compose.ui.graphics.Color
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Constant('Purple80')]
|
||||
val Purple80 = Color(0xFFD0BCFF)
|
||||
// [END_ENTITY: Constant('Purple80')]
|
||||
|
||||
// [ENTITY: Constant('PurpleGrey80')]
|
||||
val PurpleGrey80 = Color(0xFFCCC2DC)
|
||||
// [END_ENTITY: Constant('PurpleGrey80')]
|
||||
|
||||
// [ENTITY: Constant('Pink80')]
|
||||
val Pink80 = Color(0xFFEFB8C8)
|
||||
// [END_ENTITY: Constant('Pink80')]
|
||||
|
||||
// [ENTITY: Constant('Purple40')]
|
||||
val Purple40 = Color(0xFF6650a4)
|
||||
// [END_ENTITY: Constant('Purple40')]
|
||||
|
||||
// [ENTITY: Constant('PurpleGrey40')]
|
||||
val PurpleGrey40 = Color(0xFF625b71)
|
||||
// [END_ENTITY: Constant('PurpleGrey40')]
|
||||
|
||||
// [ENTITY: Constant('Pink40')]
|
||||
val Pink40 = Color(0xFF7D5260)
|
||||
// [END_ENTITY: Constant('Pink40')]
|
||||
// [END_CONTRACT]
|
||||
|
||||
// [END_FILE_Color.kt]
|
||||
@@ -1,7 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.theme
|
||||
// [FILE] Theme.kt
|
||||
// [SEMANTICS] ui, theme, color_scheme
|
||||
|
||||
// [SEMANTICS] app, ui, theme
|
||||
package com.homebox.lens.ui.theme
|
||||
|
||||
// [IMPORTS]
|
||||
@@ -21,55 +19,33 @@ import androidx.compose.ui.platform.LocalView
|
||||
import androidx.core.view.WindowCompat
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Constant('DarkColorScheme')]
|
||||
// [RELATION: Constant('DarkColorScheme') -> [CALLS] -> Function('darkColorScheme')]
|
||||
// [RELATION: Constant('DarkColorScheme') -> [DEPENDS_ON] -> Constant('Purple80')]
|
||||
// [RELATION: Constant('DarkColorScheme') -> [DEPENDS_ON] -> Constant('PurpleGrey80')]
|
||||
// [RELATION: Constant('DarkColorScheme') -> [DEPENDS_ON] -> Constant('Pink80')]
|
||||
private val DarkColorScheme =
|
||||
darkColorScheme(
|
||||
private val DarkColorScheme = darkColorScheme(
|
||||
primary = Purple80,
|
||||
secondary = PurpleGrey80,
|
||||
tertiary = Pink80,
|
||||
)
|
||||
// [END_ENTITY: Constant('DarkColorScheme')]
|
||||
tertiary = Pink80
|
||||
)
|
||||
|
||||
// [ENTITY: Constant('LightColorScheme')]
|
||||
// [RELATION: Constant('LightColorScheme') -> [CALLS] -> Function('lightColorScheme')]
|
||||
// [RELATION: Constant('LightColorScheme') -> [DEPENDS_ON] -> Constant('Purple40')]
|
||||
// [RELATION: Constant('LightColorScheme') -> [DEPENDS_ON] -> Constant('PurpleGrey40')]
|
||||
// [RELATION: Constant('LightColorScheme') -> [DEPENDS_ON] -> Constant('Pink40')]
|
||||
private val LightColorScheme =
|
||||
lightColorScheme(
|
||||
private val LightColorScheme = lightColorScheme(
|
||||
primary = Purple40,
|
||||
secondary = PurpleGrey40,
|
||||
tertiary = Pink40,
|
||||
)
|
||||
// [END_ENTITY: Constant('LightColorScheme')]
|
||||
tertiary = Pink40
|
||||
)
|
||||
|
||||
// [ENTITY: Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [CALLS] -> Function('isSystemInDarkTheme')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [CALLS] -> Function('LocalContext.current')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [CALLS] -> Function('dynamicDarkColorScheme')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [CALLS] -> Function('dynamicLightColorScheme')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [CALLS] -> Function('LocalView.current')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [CALLS] -> Function('SideEffect')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [CALLS] -> Function('toArgb')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [CALLS] -> Function('WindowCompat.getInsetsController')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [CALLS] -> Function('MaterialTheme')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [DEPENDS_ON] -> Constant('DarkColorScheme')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [DEPENDS_ON] -> Constant('LightColorScheme')]
|
||||
// [RELATION: Function('HomeboxLensTheme') -> [DEPENDS_ON] -> Constant('Typography')]
|
||||
// [RELATION: Function('HomeboxLensTheme')] -> [DEPENDS_ON] -> [DataStructure('Typography')]
|
||||
/**
|
||||
* @summary The main theme for the Homebox Lens application.
|
||||
* @param darkTheme Whether the theme should be dark or light.
|
||||
* @param dynamicColor Whether to use dynamic color (on Android 12+).
|
||||
* @param content The content to be displayed within the theme.
|
||||
*/
|
||||
@Composable
|
||||
fun HomeboxLensTheme(
|
||||
darkTheme: Boolean = isSystemInDarkTheme(),
|
||||
// Dynamic color is available on Android 12+
|
||||
dynamicColor: Boolean = true,
|
||||
content: @Composable () -> Unit,
|
||||
content: @Composable () -> Unit
|
||||
) {
|
||||
val colorScheme =
|
||||
when {
|
||||
val colorScheme = when {
|
||||
dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> {
|
||||
val context = LocalContext.current
|
||||
if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context)
|
||||
@@ -90,9 +66,8 @@ fun HomeboxLensTheme(
|
||||
MaterialTheme(
|
||||
colorScheme = colorScheme,
|
||||
typography = Typography,
|
||||
content = content,
|
||||
content = content
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('HomeboxLensTheme')]
|
||||
// [END_CONTRACT]
|
||||
// [END_FILE_Theme.kt]
|
||||
@@ -1,7 +1,5 @@
|
||||
// [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]
|
||||
@@ -12,26 +10,19 @@ import androidx.compose.ui.text.font.FontWeight
|
||||
import androidx.compose.ui.unit.sp
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Constant('Typography')]
|
||||
// [RELATION: Constant('Typography') -> [CALLS] -> Function('Typography')]
|
||||
// [RELATION: Constant('Typography') -> [CALLS] -> Function('TextStyle')]
|
||||
// [RELATION: Constant('Typography') -> [DEPENDS_ON] -> Class('FontFamily')]
|
||||
// [RELATION: Constant('Typography') -> [DEPENDS_ON] -> Class('FontWeight')]
|
||||
// [ENTITY: DataStructure('Typography')]
|
||||
/**
|
||||
* Set of Material typography styles to start with
|
||||
* @summary Defines the typography for the application.
|
||||
*/
|
||||
val Typography =
|
||||
Typography(
|
||||
bodyLarge =
|
||||
TextStyle(
|
||||
val Typography = Typography(
|
||||
bodyLarge = TextStyle(
|
||||
fontFamily = FontFamily.Default,
|
||||
fontWeight = FontWeight.Normal,
|
||||
fontSize = 16.sp,
|
||||
lineHeight = 24.sp,
|
||||
letterSpacing = 0.5.sp,
|
||||
),
|
||||
letterSpacing = 0.5.sp
|
||||
)
|
||||
// [END_ENTITY: Constant('Typography')]
|
||||
// [END_CONTRACT]
|
||||
)
|
||||
// [END_ENTITY: DataStructure('Typography')]
|
||||
|
||||
// [END_FILE_Typography.kt]
|
||||
@@ -17,35 +17,6 @@
|
||||
<string name="cd_navigate_back">Navigate back</string>
|
||||
<string name="cd_add_new_location">Add new location</string>
|
||||
<string name="content_desc_add_label">Add new label</string>
|
||||
<string name="content_desc_sync_inventory">Sync inventory</string>
|
||||
<string name="content_desc_edit_item">Edit item</string>
|
||||
<string name="content_desc_delete_item">Delete item</string>
|
||||
<string name="content_desc_save_item">Save item</string>
|
||||
<string name="content_desc_create_label">Create new label</string>
|
||||
<string name="content_desc_label_icon">Label icon</string>
|
||||
<string name="cd_more_options">More options</string>
|
||||
|
||||
<!-- Inventory List Screen -->
|
||||
<string name="inventory_list_title">Inventory</string>
|
||||
|
||||
<!-- Item Details Screen -->
|
||||
<string name="item_details_title">Details</string>
|
||||
<string name="section_title_description">Description</string>
|
||||
<string name="placeholder_no_description">No description</string>
|
||||
<string name="section_title_details">Details</string>
|
||||
<string name="label_quantity">Quantity</string>
|
||||
<string name="label_location">Location</string>
|
||||
<string name="section_title_labels">Labels</string>
|
||||
|
||||
<!-- Item Edit Screen -->
|
||||
<string name="item_edit_title_create">Create item</string>
|
||||
<string name="item_edit_title">Edit item</string>
|
||||
<string name="label_name">Name</string>
|
||||
<string name="label_description">Description</string>
|
||||
|
||||
<!-- Search Screen -->
|
||||
<string name="placeholder_search_items">Search items...</string>
|
||||
<string name="search_title">Search</string>
|
||||
|
||||
<!-- Dashboard Screen -->
|
||||
<string name="dashboard_title">Dashboard</string>
|
||||
@@ -66,19 +37,30 @@
|
||||
<string name="nav_labels">Labels</string>
|
||||
|
||||
<!-- Screen Titles -->
|
||||
<string name="inventory_list_title">Inventory</string>
|
||||
|
||||
<!-- Screen Titles -->
|
||||
<string name="item_details_title">Details</string>
|
||||
<string name="item_edit_title">Edit Item</string>
|
||||
<string name="labels_list_title">Labels</string>
|
||||
<string name="locations_list_title">Locations</string>
|
||||
<string name="search_title">Search</string>
|
||||
|
||||
<string name="save_item">Save</string>
|
||||
<string name="item_name">Name</string>
|
||||
<string name="item_description">Description</string>
|
||||
<string name="item_quantity">Quantity</string>
|
||||
|
||||
<!-- Location Edit Screen -->
|
||||
<string name="location_edit_title_create">Create location</string>
|
||||
<string name="location_edit_title_edit">Edit location</string>
|
||||
<string name="location_edit_title_create">Create Location</string>
|
||||
<string name="location_edit_title_edit">Edit Location</string>
|
||||
|
||||
<!-- Locations List Screen -->
|
||||
<string name="locations_not_found">Locations not found. Press + to add a new one.</string>
|
||||
<string name="item_count">Items: %1$d</string>
|
||||
<string name="cd_more_options">More options</string>
|
||||
|
||||
<!-- Setup Screen -->
|
||||
<string name="screen_title_setup">Setup</string>
|
||||
<string name="setup_title">Server Setup</string>
|
||||
<string name="setup_server_url_label">Server URL</string>
|
||||
<string name="setup_username_label">Username</string>
|
||||
@@ -87,10 +69,53 @@
|
||||
|
||||
<!-- Labels List Screen -->
|
||||
<string name="screen_title_labels">Labels</string>
|
||||
<string name="content_desc_navigate_back">Navigate back</string>
|
||||
<string name="content_desc_create_label">Create new label</string>
|
||||
<string name="content_desc_label_icon">Label icon</string>
|
||||
<string name="no_labels_found">No labels found.</string>
|
||||
<string name="dialog_title_create_label">Create label</string>
|
||||
<string name="dialog_field_label_name">Label name</string>
|
||||
<string name="dialog_title_create_label">Create Label</string>
|
||||
<string name="dialog_field_label_name">Label Name</string>
|
||||
<string name="dialog_button_create">Create</string>
|
||||
<string name="dialog_button_cancel">Cancel</string>
|
||||
|
||||
|
||||
|
||||
<!-- Inventory List Screen -->
|
||||
<string name="content_desc_sync_inventory">Sync inventory</string>
|
||||
|
||||
<!-- Item Details Screen -->
|
||||
<string name="content_desc_edit_item">Edit item</string>
|
||||
<string name="content_desc_delete_item">Delete item</string>
|
||||
<string name="section_title_description">Description</string>
|
||||
<string name="placeholder_no_description">No description</string>
|
||||
<string name="section_title_details">Details</string>
|
||||
<string name="label_quantity">Quantity</string>
|
||||
<string name="label_location">Location</string>
|
||||
<string name="section_title_labels">Labels</string>
|
||||
|
||||
<!-- Item Edit Screen -->
|
||||
<string name="item_edit_title_create">Create item</string>
|
||||
<string name="content_desc_save_item">Save item</string>
|
||||
<string name="label_name">Name</string>
|
||||
<string name="label_description">Description</string>
|
||||
|
||||
<!-- Search Screen -->
|
||||
<string name="placeholder_search_items">Search items...</string>
|
||||
|
||||
<!-- Setup Screen -->
|
||||
<string name="screen_title_setup">Setup</string>
|
||||
|
||||
<!-- Label Edit Screen -->
|
||||
<string name="label_edit_title_create">Create label</string>
|
||||
<string name="label_edit_title_edit">Edit label</string>
|
||||
<string name="label_name_edit">Label name</string>
|
||||
|
||||
<!-- Common Actions -->
|
||||
<string name="back">Back</string>
|
||||
<string name="save">Save</string>
|
||||
|
||||
<!-- Color Picker -->
|
||||
<string name="label_color">Color</string>
|
||||
<string name="label_hex_color">HEX color code</string>
|
||||
|
||||
</resources>
|
||||
@@ -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>
|
||||
@@ -35,7 +36,6 @@
|
||||
<string name="item_edit_title_create">Создать элемент</string>
|
||||
<string name="content_desc_save_item">Сохранить элемент</string>
|
||||
<string name="label_name">Название</string>
|
||||
<string name="label_description">Описание</string>
|
||||
|
||||
<!-- Search Screen -->
|
||||
<string name="placeholder_search_items">Поиск элементов...</string>
|
||||
@@ -66,6 +66,41 @@
|
||||
<string name="locations_list_title">Места хранения</string>
|
||||
<string name="search_title">Поиск</string>
|
||||
|
||||
<string name="save_item">Сохранить</string>
|
||||
<string name="item_name">Название</string>
|
||||
<string name="item_description">Описание</string>
|
||||
<string name="item_quantity">Количество</string>
|
||||
<string name="item_edit_general_information">General Information</string>
|
||||
<string name="item_edit_location">Location</string>
|
||||
<string name="item_edit_select_location">Select Location</string>
|
||||
<string name="item_edit_labels">Labels</string>
|
||||
<string name="item_edit_select_labels">Select Labels</string>
|
||||
<string name="item_edit_purchase_information">Purchase Information</string>
|
||||
<string name="item_edit_purchase_price">Purchase Price</string>
|
||||
<string name="item_edit_purchase_from">Purchase From</string>
|
||||
<string name="item_edit_purchase_time">Purchase Date</string>
|
||||
<string name="item_edit_select_date">Select Date</string>
|
||||
<string name="dialog_ok">OK</string>
|
||||
<string name="dialog_cancel">Cancel</string>
|
||||
<string name="item_edit_warranty_information">Warranty Information</string>
|
||||
<string name="item_edit_lifetime_warranty">Lifetime Warranty</string>
|
||||
<string name="item_edit_warranty_details">Warranty Details</string>
|
||||
<string name="item_edit_warranty_expires">Warranty Expires</string>
|
||||
<string name="item_edit_identification">Identification</string>
|
||||
<string name="item_edit_asset_id">Asset ID</string>
|
||||
<string name="item_edit_serial_number">Serial Number</string>
|
||||
<string name="item_edit_manufacturer">Manufacturer</string>
|
||||
<string name="item_edit_model_number">Model Number</string>
|
||||
<string name="item_edit_status_notes">Status & Notes</string>
|
||||
<string name="item_edit_archived">Archived</string>
|
||||
<string name="item_edit_insured">Insured</string>
|
||||
<string name="item_edit_notes">Notes</string>
|
||||
<string name="item_edit_sold_information">Sold Information</string>
|
||||
<string name="item_edit_sold_price">Sold Price</string>
|
||||
<string name="item_edit_sold_to">Sold To</string>
|
||||
<string name="item_edit_sold_notes">Sold Notes</string>
|
||||
<string name="item_edit_sold_time">Sold Date</string>
|
||||
|
||||
<!-- Location Edit Screen -->
|
||||
<string name="location_edit_title_create">Создать локацию</string>
|
||||
<string name="location_edit_title_edit">Редактировать локацию</string>
|
||||
@@ -85,6 +120,8 @@
|
||||
|
||||
<!-- Labels List Screen -->
|
||||
<string name="screen_title_labels">Метки</string>
|
||||
<!-- Settings Screen -->
|
||||
<string name="screen_title_settings">Настройки</string>
|
||||
<string name="content_desc_navigate_back" translatable="false">Вернуться назад</string>
|
||||
<string name="content_desc_create_label">Создать новую метку</string>
|
||||
<string name="content_desc_label_icon">Иконка метки</string>
|
||||
@@ -94,4 +131,18 @@
|
||||
<string name="dialog_button_create">Создать</string>
|
||||
<string name="dialog_button_cancel">Отмена</string>
|
||||
|
||||
<!-- Label Edit Screen -->
|
||||
<string name="label_edit_title_create">Создать метку</string>
|
||||
<string name="label_edit_title_edit">Редактировать метку</string>
|
||||
<string name="label_name_edit">Название метки</string>
|
||||
<string name="label_description">Описание</string>
|
||||
|
||||
<!-- Common Actions -->
|
||||
<string name="back">Назад</string>
|
||||
<string name="save">Сохранить</string>
|
||||
<!-- Common Actions -->
|
||||
|
||||
<!-- Color Picker -->
|
||||
<string name="label_color">Цвет</string>
|
||||
<string name="label_hex_color">HEX-код цвета</string>
|
||||
</resources>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
plugins {
|
||||
// [PLUGIN] Android Application plugin
|
||||
id("com.android.application") version "8.11.1" apply false
|
||||
id("com.android.application") version "8.13.0" apply false
|
||||
// [PLUGIN] Kotlin Android plugin
|
||||
id("org.jetbrains.kotlin.android") version "1.9.22" apply false
|
||||
// [PLUGIN] Hilt Android plugin
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
// [FILE] Dependencies.kt
|
||||
// [PURPOSE] Centralized dependency management for the entire project.
|
||||
// [SEMANTICS] build, dependencies
|
||||
|
||||
// [ENTITY: Object('Versions')]
|
||||
object Versions {
|
||||
// Build
|
||||
const val compileSdk = 34
|
||||
@@ -44,8 +45,14 @@ object Versions {
|
||||
const val junit = "4.13.2"
|
||||
const val extJunit = "1.1.5"
|
||||
const val espresso = "3.5.1"
|
||||
}
|
||||
|
||||
// Testing
|
||||
const val kotest = "5.8.0"
|
||||
const val mockk = "1.13.10"
|
||||
}
|
||||
// [END_ENTITY: Object('Versions')]
|
||||
|
||||
// [ENTITY: Object('Libs')]
|
||||
object Libs {
|
||||
// Kotlin
|
||||
const val coroutinesCore = "org.jetbrains.kotlinx:kotlinx-coroutines-core:${Versions.coroutines}"
|
||||
@@ -95,6 +102,10 @@ object Libs {
|
||||
const val composeUiTooling = "androidx.compose.ui:ui-tooling"
|
||||
const val composeUiTestManifest = "androidx.compose.ui:ui-test-manifest"
|
||||
|
||||
const val kotestRunnerJunit5 = "io.kotest:kotest-runner-junit5:${Versions.kotest}"
|
||||
const val kotestAssertionsCore = "io.kotest:kotest-assertions-core:${Versions.kotest}"
|
||||
const val mockk = "io.mockk:mockk:${Versions.mockk}"
|
||||
}
|
||||
// [END_ENTITY: Object('Libs')]
|
||||
|
||||
// [END_FILE_Dependencies.kt]
|
||||
@@ -62,6 +62,9 @@ dependencies {
|
||||
implementation(Libs.hiltAndroid)
|
||||
kapt(Libs.hiltCompiler)
|
||||
|
||||
// [DEPENDENCY] Logging
|
||||
implementation(Libs.timber)
|
||||
|
||||
// [DEPENDENCY] Testing
|
||||
testImplementation(Libs.junit)
|
||||
androidTestImplementation(Libs.extJunit)
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
// [FILE] ExampleInstrumentedTest.kt
|
||||
// [SEMANTICS] testing, android, ktlint, rules
|
||||
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import androidx.test.platform.app.InstrumentationRegistry
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
// Путь: data/semantic-ktlint-rules/src/main/java/com/busya/ktlint/rules/CustomRuleSetProvider.kt
|
||||
// [FILE] CustomRuleSetProvider.kt
|
||||
// [SEMANTICS] ktlint, rules, provider
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import com.pinterest.ktlint.rule.engine.core.api.RuleProvider
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
// Путь: data/semantic-ktlint-rules/src/main/java/com/busya/ktlint/rules/FileHeaderRule.kt
|
||||
// [FILE] FileHeaderRule.kt
|
||||
// [SEMANTICS] ktlint, rules, file_header
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import com.pinterest.ktlint.rule.engine.core.api.ElementType
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
// Путь: data/semantic-ktlint-rules/src/main/java/com/busya/ktlint/rules/MandatoryEntityDeclarationRule.kt
|
||||
// [FILE] MandatoryEntityDeclarationRule.kt
|
||||
// [SEMANTICS] ktlint, rules, entity_declaration
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import com.pinterest.ktlint.rule.engine.core.api.ElementType
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
// Путь: data/semantic-ktlint-rules/src/main/java/com/busya/ktlint/rules/NoStrayCommentsRule.kt
|
||||
// [FILE] NoStrayCommentsRule.kt
|
||||
// [SEMANTICS] ktlint, rules, comments
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import com.pinterest.ktlint.rule.engine.core.api.ElementType
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
// [FILE] ExampleUnitTest.kt
|
||||
// [SEMANTICS] testing, ktlint, rules
|
||||
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import com.pinterest.ktlint.test.KtLintAssertThat.Companion.assertThatRule
|
||||
|
||||
@@ -1,74 +1,96 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api
|
||||
// [FILE] HomeboxApiService.kt
|
||||
// [SEMANTICS] data, api, retrofit
|
||||
package com.homebox.lens.data.api
|
||||
|
||||
import com.homebox.lens.data.api.dto.GroupStatisticsDto
|
||||
import com.homebox.lens.data.api.dto.ItemCreateDto
|
||||
import com.homebox.lens.data.api.dto.ItemOutDto
|
||||
import com.homebox.lens.data.api.dto.ItemSummaryDto
|
||||
import com.homebox.lens.data.api.dto.ItemUpdateDto
|
||||
import com.homebox.lens.data.api.dto.LabelCreateDto
|
||||
import com.homebox.lens.data.api.dto.LabelOutDto
|
||||
import com.homebox.lens.data.api.dto.LabelSummaryDto
|
||||
import com.homebox.lens.data.api.dto.LocationOutCountDto
|
||||
import com.homebox.lens.data.api.dto.LoginFormDto
|
||||
import com.homebox.lens.data.api.dto.PaginationResultDto
|
||||
import com.homebox.lens.data.api.dto.TokenResponseDto
|
||||
// [IMPORTS]
|
||||
import com.homebox.lens.data.api.dto.*
|
||||
import retrofit2.Response
|
||||
import retrofit2.http.Body
|
||||
import retrofit2.http.DELETE
|
||||
import retrofit2.http.GET
|
||||
import retrofit2.http.Headers
|
||||
import retrofit2.http.POST
|
||||
import retrofit2.http.PUT
|
||||
import retrofit2.http.Path
|
||||
import retrofit2.http.Query
|
||||
import retrofit2.http.*
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CONTRACT]
|
||||
// [ENTITY: Interface('HomeboxApiService')]
|
||||
/**
|
||||
* [ENTITY: Interface('HomeboxApiService')]
|
||||
* [PURPOSE] Определяет эндпоинты для взаимодействия с Homebox API, используя DTO.
|
||||
* @summary Defines the endpoints for interacting with the Homebox API using DTOs.
|
||||
*/
|
||||
interface HomeboxApiService {
|
||||
|
||||
// [ENDPOINT] Auth
|
||||
// [ENTITY: ApiEndpoint('login')]
|
||||
@Headers("Content-Type: application/json")
|
||||
@POST("v1/users/login")
|
||||
suspend fun login(@Body loginForm: LoginFormDto): TokenResponseDto
|
||||
// [END_ENTITY: ApiEndpoint('login')]
|
||||
|
||||
// [ENDPOINT] Items
|
||||
// [ENTITY: ApiEndpoint('getItems')]
|
||||
@GET("v1/items")
|
||||
suspend fun getItems(
|
||||
@Query("q") query: String? = null,
|
||||
@Query("page") page: Int? = null,
|
||||
@Query("pageSize") pageSize: Int? = null
|
||||
): PaginationResultDto<ItemSummaryDto>
|
||||
// [END_ENTITY: ApiEndpoint('getItems')]
|
||||
|
||||
// [ENTITY: ApiEndpoint('createItem')]
|
||||
@POST("v1/items")
|
||||
suspend fun createItem(@Body item: ItemCreateDto): ItemSummaryDto
|
||||
// [END_ENTITY: ApiEndpoint('createItem')]
|
||||
|
||||
// [ENTITY: ApiEndpoint('getItem')]
|
||||
@GET("v1/items/{id}")
|
||||
suspend fun getItem(@Path("id") itemId: String): ItemOutDto
|
||||
// [END_ENTITY: ApiEndpoint('getItem')]
|
||||
|
||||
// [ENTITY: ApiEndpoint('updateItem')]
|
||||
@PUT("v1/items/{id}")
|
||||
suspend fun updateItem(@Path("id") itemId: String, @Body item: ItemUpdateDto): ItemOutDto
|
||||
// [END_ENTITY: ApiEndpoint('updateItem')]
|
||||
|
||||
// [ENTITY: ApiEndpoint('deleteItem')]
|
||||
@DELETE("v1/items/{id}")
|
||||
suspend fun deleteItem(@Path("id") itemId: String): Response<Unit>
|
||||
// [END_ENTITY: ApiEndpoint('deleteItem')]
|
||||
|
||||
// [ENDPOINT] Locations
|
||||
// [ENTITY: ApiEndpoint('getLocations')]
|
||||
@GET("v1/locations")
|
||||
suspend fun getLocations(): List<LocationOutCountDto>
|
||||
// [END_ENTITY: ApiEndpoint('getLocations')]
|
||||
|
||||
// [ENDPOINT] Labels
|
||||
// [ENTITY: ApiEndpoint('getLabels')]
|
||||
@GET("v1/labels")
|
||||
suspend fun getLabels(): List<LabelOutDto>
|
||||
// [END_ENTITY: ApiEndpoint('getLabels')]
|
||||
|
||||
// [ENTITY: ApiEndpoint('createLabel')]
|
||||
@POST("v1/labels")
|
||||
suspend fun createLabel(@Body newLabel: LabelCreateDto): LabelSummaryDto
|
||||
// [END_ENTITY: ApiEndpoint('createLabel')]
|
||||
|
||||
// [ENDPOINT] Statistics
|
||||
// [ENTITY: ApiEndpoint('updateLabel')]
|
||||
@PUT("v1/labels/{id}")
|
||||
suspend fun updateLabel(@Path("id") labelId: String, @Body label: LabelUpdateDto): LabelOutDto
|
||||
// [END_ENTITY: ApiEndpoint('updateLabel')]
|
||||
|
||||
// [ENTITY: ApiEndpoint('deleteLabel')]
|
||||
@DELETE("v1/labels/{id}")
|
||||
suspend fun deleteLabel(@Path("id") labelId: String): Response<Unit>
|
||||
|
||||
// [ENTITY: ApiEndpoint('createLocation')]
|
||||
@POST("v1/locations")
|
||||
suspend fun createLocation(@Body newLocation: LocationCreateDto): LocationOutDto
|
||||
// [END_ENTITY: ApiEndpoint('createLocation')]
|
||||
|
||||
// [ENTITY: ApiEndpoint('updateLocation')]
|
||||
@PUT("v1/locations/{id}")
|
||||
suspend fun updateLocation(@Path("id") locationId: String, @Body location: LocationUpdateDto): LocationOutDto
|
||||
// [END_ENTITY: ApiEndpoint('updateLocation')]
|
||||
|
||||
// [ENTITY: ApiEndpoint('deleteLocation')]
|
||||
@DELETE("v1/locations/{id}")
|
||||
suspend fun deleteLocation(@Path("id") locationId: String): Response<Unit>
|
||||
|
||||
// [ENTITY: ApiEndpoint('getStatistics')]
|
||||
@GET("v1/groups/statistics")
|
||||
suspend fun getStatistics(): GroupStatisticsDto
|
||||
// [END_ENTITY: ApiEndpoint('getStatistics')]
|
||||
}
|
||||
// [END_ENTITY: Interface('HomeboxApiService')]
|
||||
// [END_FILE_HomeboxApiService.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,11 +7,11 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.CustomField
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('CustomFieldDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для кастомного поля.
|
||||
* @summary DTO for a custom field.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class CustomFieldDto(
|
||||
@@ -20,10 +19,12 @@ data class CustomFieldDto(
|
||||
@Json(name = "value") val value: String,
|
||||
@Json(name = "type") val type: String
|
||||
)
|
||||
// [END_ENTITY: DataClass('CustomFieldDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('CustomField')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из CustomFieldDto в доменную модель CustomField.
|
||||
* @summary Mapper from CustomFieldDto to the CustomField domain model.
|
||||
*/
|
||||
fun CustomFieldDto.toDomain(): CustomField {
|
||||
return CustomField(
|
||||
@@ -32,3 +33,4 @@ fun CustomFieldDto.toDomain(): CustomField {
|
||||
type = this.type
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,14 +7,11 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.GroupStatistics
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('GroupStatisticsDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для статистики.
|
||||
* [COHERENCE_NOTE] Этот DTO был исправлен, чтобы точно соответствовать JSON-ответу от сервера.
|
||||
* Поля `items`, `labels`, `locations`, `totalValue` были заменены на `totalItems`, `totalLabels`,
|
||||
* `totalLocations`, `totalItemPrice` и т.д., чтобы устранить ошибку парсинга `JsonDataException`.
|
||||
* @summary DTO for statistics.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class GroupStatisticsDto(
|
||||
@@ -23,19 +19,17 @@ data class GroupStatisticsDto(
|
||||
@Json(name = "totalLabels") val totalLabels: Int,
|
||||
@Json(name = "totalLocations") val totalLocations: Int,
|
||||
@Json(name = "totalItemPrice") val totalItemPrice: Double,
|
||||
// [FIX] Добавляем недостающие поля, которые присутствуют в JSON, но отсутствовали в DTO.
|
||||
// Делаем их nullable на случай, если API перестанет их присылать в будущем.
|
||||
@Json(name = "totalUsers") val totalUsers: Int? = null,
|
||||
@Json(name = "totalWithWarranty") val totalWithWarranty: Int? = null
|
||||
)
|
||||
// [END_ENTITY: DataClass('GroupStatisticsDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('GroupStatistics')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из GroupStatisticsDto в доменную модель GroupStatistics.
|
||||
* [COHERENCE_NOTE] Маппер обновлен для использования правильных полей из исправленного DTO.
|
||||
* @summary Mapper from GroupStatisticsDto to the GroupStatistics domain model.
|
||||
*/
|
||||
fun GroupStatisticsDto.toDomain(): GroupStatistics {
|
||||
// [ACTION] Маппим данные из DTO в доменную модель.
|
||||
return GroupStatistics(
|
||||
items = this.totalItems,
|
||||
labels = this.totalLabels,
|
||||
@@ -43,4 +37,5 @@ fun GroupStatisticsDto.toDomain(): GroupStatistics {
|
||||
totalValue = this.totalItemPrice
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
// [END_FILE_GroupStatisticsDto.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,14 +7,14 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.Image
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('ImageDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для изображения.
|
||||
* @property id Уникальный идентификатор.
|
||||
* @property path Путь к файлу.
|
||||
* @property 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(
|
||||
@@ -23,10 +22,12 @@ data class ImageDto(
|
||||
@Json(name = "path") val path: String,
|
||||
@Json(name = "isPrimary") val isPrimary: Boolean
|
||||
)
|
||||
// [END_ENTITY: DataClass('ImageDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('Image')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из ImageDto в доменную модель Image.
|
||||
* @summary Mapper from ImageDto to the Image domain model.
|
||||
*/
|
||||
fun ImageDto.toDomain(): Image {
|
||||
return Image(
|
||||
@@ -35,3 +36,4 @@ fun ImageDto.toDomain(): Image {
|
||||
isPrimary = this.isPrimary
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,11 +7,11 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.ItemAttachment
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('ItemAttachmentDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для вложения.
|
||||
* @summary DTO for an attachment.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class ItemAttachmentDto(
|
||||
@@ -23,10 +22,12 @@ data class ItemAttachmentDto(
|
||||
@Json(name = "createdAt") val createdAt: String,
|
||||
@Json(name = "updatedAt") val updatedAt: String
|
||||
)
|
||||
// [END_ENTITY: DataClass('ItemAttachmentDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('ItemAttachment')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из ItemAttachmentDto в доменную модель ItemAttachment.
|
||||
* @summary Mapper from ItemAttachmentDto to the ItemAttachment domain model.
|
||||
*/
|
||||
fun ItemAttachmentDto.toDomain(): ItemAttachment {
|
||||
return ItemAttachment(
|
||||
@@ -38,3 +39,4 @@ fun ItemAttachmentDto.toDomain(): ItemAttachment {
|
||||
updatedAt = this.updatedAt
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,47 +7,72 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.ItemCreate
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('ItemCreateDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для создания вещи.
|
||||
* @summary DTO for creating an item.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class ItemCreateDto(
|
||||
@Json(name = "name") val name: String,
|
||||
@Json(name = "assetId") val assetId: String?,
|
||||
@Json(name = "description") val description: String?,
|
||||
@Json(name = "notes") val notes: String?,
|
||||
@Json(name = "serialNumber") val serialNumber: String?,
|
||||
@Json(name = "quantity") val quantity: Int?,
|
||||
@Json(name = "value") val value: Double?,
|
||||
@Json(name = "purchasePrice") val purchasePrice: Double?,
|
||||
@Json(name = "purchaseDate") val purchaseDate: String?,
|
||||
@Json(name = "warrantyUntil") val warrantyUntil: String?,
|
||||
@Json(name = "locationId") val locationId: String?,
|
||||
@Json(name = "archived") val archived: Boolean?,
|
||||
@Json(name = "assetId") val assetId: String?,
|
||||
@Json(name = "insured") val insured: Boolean?,
|
||||
@Json(name = "lifetimeWarranty") val lifetimeWarranty: Boolean?,
|
||||
@Json(name = "manufacturer") val manufacturer: String?,
|
||||
@Json(name = "modelNumber") val modelNumber: String?,
|
||||
@Json(name = "notes") val notes: String?,
|
||||
@Json(name = "parentId") val parentId: String?,
|
||||
@Json(name = "purchaseFrom") val purchaseFrom: String?,
|
||||
@Json(name = "purchasePrice") val purchasePrice: Double?,
|
||||
@Json(name = "purchaseTime") val purchaseTime: String?,
|
||||
@Json(name = "serialNumber") val serialNumber: String?,
|
||||
@Json(name = "soldNotes") val soldNotes: String?,
|
||||
@Json(name = "soldPrice") val soldPrice: Double?,
|
||||
@Json(name = "soldTime") val soldTime: String?,
|
||||
@Json(name = "soldTo") val soldTo: String?,
|
||||
@Json(name = "syncChildItemsLocations") val syncChildItemsLocations: Boolean?,
|
||||
@Json(name = "warrantyDetails") val warrantyDetails: String?,
|
||||
@Json(name = "warrantyExpires") val warrantyExpires: String?,
|
||||
@Json(name = "locationId") val locationId: String?,
|
||||
@Json(name = "labelIds") val labelIds: List<String>?
|
||||
)
|
||||
// [END_ENTITY: DataClass('ItemCreateDto')]
|
||||
|
||||
// [ENTITY: Function('toDto')]
|
||||
// [RELATION: Function('toDto')] -> [RETURNS] -> [DataClass('ItemCreateDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из доменной модели ItemCreate в ItemCreateDto.
|
||||
* @summary Mapper from the ItemCreate domain model to ItemCreateDto.
|
||||
*/
|
||||
fun ItemCreate.toDto(): ItemCreateDto {
|
||||
fun ItemCreate.toItemCreateDto(): ItemCreateDto {
|
||||
return ItemCreateDto(
|
||||
name = this.name,
|
||||
assetId = this.assetId,
|
||||
description = this.description,
|
||||
notes = this.notes,
|
||||
serialNumber = this.serialNumber,
|
||||
quantity = this.quantity,
|
||||
value = this.value,
|
||||
purchasePrice = this.purchasePrice,
|
||||
purchaseDate = this.purchaseDate,
|
||||
warrantyUntil = this.warrantyUntil,
|
||||
locationId = this.locationId,
|
||||
archived = this.archived,
|
||||
assetId = this.assetId,
|
||||
insured = this.insured,
|
||||
lifetimeWarranty = this.lifetimeWarranty,
|
||||
manufacturer = this.manufacturer,
|
||||
modelNumber = this.modelNumber,
|
||||
notes = this.notes,
|
||||
parentId = this.parentId,
|
||||
purchaseFrom = this.purchaseFrom,
|
||||
purchasePrice = this.purchasePrice,
|
||||
purchaseTime = this.purchaseTime,
|
||||
serialNumber = this.serialNumber,
|
||||
soldNotes = this.soldNotes,
|
||||
soldPrice = this.soldPrice,
|
||||
soldTime = this.soldTime,
|
||||
soldTo = this.soldTo,
|
||||
syncChildItemsLocations = this.syncChildItemsLocations,
|
||||
warrantyDetails = this.warrantyDetails,
|
||||
warrantyExpires = this.warrantyExpires,
|
||||
locationId = this.locationId,
|
||||
labelIds = this.labelIds
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDto')]
|
||||
@@ -1,66 +0,0 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api.dto
|
||||
// [FILE] ItemDto.kt
|
||||
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import java.math.BigDecimal
|
||||
|
||||
// [CONTRACT]
|
||||
/**
|
||||
* [ENTITY: DataClass('ItemOut')]
|
||||
* [PURPOSE] 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?
|
||||
)
|
||||
|
||||
/**
|
||||
* [ENTITY: DataClass('ItemSummary')]
|
||||
* [PURPOSE] 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?
|
||||
)
|
||||
|
||||
/**
|
||||
* [ENTITY: DataClass('ItemCreate')]
|
||||
* [PURPOSE] 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?
|
||||
)
|
||||
|
||||
/**
|
||||
* [ENTITY: DataClass('ItemUpdate')]
|
||||
* [PURPOSE] 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_FILE_ItemDto.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,11 +7,11 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.ItemOut
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('ItemOutDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для полной модели вещи.
|
||||
* @summary DTO для полной модели вещи.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class ItemOutDto(
|
||||
@@ -24,10 +23,20 @@ data class ItemOutDto(
|
||||
@Json(name = "serialNumber") val serialNumber: String?,
|
||||
@Json(name = "quantity") val quantity: Int,
|
||||
@Json(name = "isArchived") val isArchived: Boolean,
|
||||
@Json(name = "value") val value: Double,
|
||||
@Json(name = "purchasePrice") val purchasePrice: Double?,
|
||||
@Json(name = "purchaseDate") val purchaseDate: String?,
|
||||
@Json(name = "warrantyUntil") val warrantyUntil: String?,
|
||||
@Json(name = "purchaseTime") val purchaseTime: String?,
|
||||
@Json(name = "purchaseFrom") val purchaseFrom: String?,
|
||||
@Json(name = "warrantyExpires") val warrantyExpires: String?,
|
||||
@Json(name = "warrantyDetails") val warrantyDetails: String?,
|
||||
@Json(name = "lifetimeWarranty") val lifetimeWarranty: Boolean?,
|
||||
@Json(name = "insured") val insured: Boolean?,
|
||||
@Json(name = "manufacturer") val manufacturer: String?,
|
||||
@Json(name = "modelNumber") val modelNumber: String?,
|
||||
@Json(name = "soldPrice") val soldPrice: Double?,
|
||||
@Json(name = "soldTime") val soldTime: String?,
|
||||
@Json(name = "soldTo") val soldTo: String?,
|
||||
@Json(name = "soldNotes") val soldNotes: String?,
|
||||
@Json(name = "syncChildItemsLocations") val syncChildItemsLocations: Boolean?,
|
||||
@Json(name = "location") val location: LocationOutDto?,
|
||||
@Json(name = "parent") val parent: ItemSummaryDto?,
|
||||
@Json(name = "children") val children: List<ItemSummaryDto>,
|
||||
@@ -39,10 +48,12 @@ data class ItemOutDto(
|
||||
@Json(name = "createdAt") val createdAt: String,
|
||||
@Json(name = "updatedAt") val updatedAt: String
|
||||
)
|
||||
// [END_ENTITY: DataClass('ItemOutDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('ItemOut')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из ItemOutDto в доменную модель ItemOut.
|
||||
* @summary Mapper from ItemOutDto to the ItemOut domain model.
|
||||
*/
|
||||
fun ItemOutDto.toDomain(): ItemOut {
|
||||
return ItemOut(
|
||||
@@ -54,10 +65,20 @@ fun ItemOutDto.toDomain(): ItemOut {
|
||||
serialNumber = this.serialNumber,
|
||||
quantity = this.quantity,
|
||||
isArchived = this.isArchived,
|
||||
value = this.value,
|
||||
purchasePrice = this.purchasePrice,
|
||||
purchaseDate = this.purchaseDate,
|
||||
warrantyUntil = this.warrantyUntil,
|
||||
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() },
|
||||
@@ -70,3 +91,4 @@ fun ItemOutDto.toDomain(): ItemOut {
|
||||
updatedAt = this.updatedAt
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,11 +7,11 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.ItemSummary
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('ItemSummaryDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для сокращенной модели вещи.
|
||||
* @summary DTO для сокращенной модели вещи.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class ItemSummaryDto(
|
||||
@@ -27,10 +26,12 @@ data class ItemSummaryDto(
|
||||
@Json(name = "createdAt") val createdAt: String,
|
||||
@Json(name = "updatedAt") val updatedAt: String
|
||||
)
|
||||
// [END_ENTITY: DataClass('ItemSummaryDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('ItemSummary')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из ItemSummaryDto в доменную модель ItemSummary.
|
||||
* @summary Mapper from ItemSummaryDto to the ItemSummary domain model.
|
||||
*/
|
||||
fun ItemSummaryDto.toDomain(): ItemSummary {
|
||||
return ItemSummary(
|
||||
@@ -46,3 +47,4 @@ fun ItemSummaryDto.toDomain(): ItemSummary {
|
||||
updatedAt = this.updatedAt
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,49 +7,72 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.ItemUpdate
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('ItemUpdateDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для обновления вещи.
|
||||
* @summary DTO для обновления вещи.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class ItemUpdateDto(
|
||||
@Json(name = "name") val name: String?,
|
||||
@Json(name = "assetId") val assetId: String?,
|
||||
@Json(name = "description") val description: String?,
|
||||
@Json(name = "notes") val notes: String?,
|
||||
@Json(name = "serialNumber") val serialNumber: String?,
|
||||
@Json(name = "quantity") val quantity: Int?,
|
||||
@Json(name = "isArchived") val isArchived: Boolean?,
|
||||
@Json(name = "value") val value: Double?,
|
||||
@Json(name = "purchasePrice") val purchasePrice: Double?,
|
||||
@Json(name = "purchaseDate") val purchaseDate: String?,
|
||||
@Json(name = "warrantyUntil") val warrantyUntil: String?,
|
||||
@Json(name = "locationId") val locationId: String?,
|
||||
@Json(name = "archived") val archived: Boolean?,
|
||||
@Json(name = "assetId") val assetId: String?,
|
||||
@Json(name = "insured") val insured: Boolean?,
|
||||
@Json(name = "lifetimeWarranty") val lifetimeWarranty: Boolean?,
|
||||
@Json(name = "manufacturer") val manufacturer: String?,
|
||||
@Json(name = "modelNumber") val modelNumber: String?,
|
||||
@Json(name = "notes") val notes: String?,
|
||||
@Json(name = "parentId") val parentId: String?,
|
||||
@Json(name = "purchaseFrom") val purchaseFrom: String?,
|
||||
@Json(name = "purchasePrice") val purchasePrice: Double?,
|
||||
@Json(name = "purchaseTime") val purchaseTime: String?,
|
||||
@Json(name = "serialNumber") val serialNumber: String?,
|
||||
@Json(name = "soldNotes") val soldNotes: String?,
|
||||
@Json(name = "soldPrice") val soldPrice: Double?,
|
||||
@Json(name = "soldTime") val soldTime: String?,
|
||||
@Json(name = "soldTo") val soldTo: String?,
|
||||
@Json(name = "syncChildItemsLocations") val syncChildItemsLocations: Boolean?,
|
||||
@Json(name = "warrantyDetails") val warrantyDetails: String?,
|
||||
@Json(name = "warrantyExpires") val warrantyExpires: String?,
|
||||
@Json(name = "locationId") val locationId: String?,
|
||||
@Json(name = "labelIds") val labelIds: List<String>?
|
||||
)
|
||||
// [END_ENTITY: DataClass('ItemUpdateDto')]
|
||||
|
||||
// [ENTITY: Function('toDto')]
|
||||
// [RELATION: Function('toDto')] -> [RETURNS] -> [DataClass('ItemUpdateDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из доменной модели ItemUpdate в ItemUpdateDto.
|
||||
* @summary Маппер из доменной модели ItemUpdate в ItemUpdateDto.
|
||||
*/
|
||||
fun ItemUpdate.toDto(): ItemUpdateDto {
|
||||
fun ItemUpdate.toItemUpdateDto(): ItemUpdateDto {
|
||||
return ItemUpdateDto(
|
||||
name = this.name,
|
||||
assetId = this.assetId,
|
||||
description = this.description,
|
||||
notes = this.notes,
|
||||
serialNumber = this.serialNumber,
|
||||
quantity = this.quantity,
|
||||
isArchived = this.isArchived,
|
||||
value = this.value,
|
||||
purchasePrice = this.purchasePrice,
|
||||
purchaseDate = this.purchaseDate,
|
||||
warrantyUntil = this.warrantyUntil,
|
||||
locationId = this.locationId,
|
||||
archived = this.archived,
|
||||
assetId = this.assetId,
|
||||
insured = this.insured,
|
||||
lifetimeWarranty = this.lifetimeWarranty,
|
||||
manufacturer = this.manufacturer,
|
||||
modelNumber = this.modelNumber,
|
||||
notes = this.notes,
|
||||
parentId = this.parentId,
|
||||
purchaseFrom = this.purchaseFrom,
|
||||
purchasePrice = this.purchasePrice,
|
||||
purchaseTime = this.purchaseTime,
|
||||
serialNumber = this.serialNumber,
|
||||
soldNotes = this.soldNotes,
|
||||
soldPrice = this.soldPrice,
|
||||
soldTime = this.soldTime,
|
||||
soldTo = this.soldTo,
|
||||
syncChildItemsLocations = this.syncChildItemsLocations,
|
||||
warrantyDetails = this.warrantyDetails,
|
||||
warrantyExpires = this.warrantyExpires,
|
||||
locationId = this.locationId,
|
||||
labelIds = this.labelIds
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDto')]
|
||||
@@ -1,23 +1,24 @@
|
||||
// [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]
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: DataClass('LabelCreateDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для тела запроса на создание метки (POST /v1/labels).
|
||||
* @property name Название метки.
|
||||
* @property color Цвет метки в формате HEX (например, "#FF0000").
|
||||
* @property description Описание метки.
|
||||
* @coherence_note Структура этого класса точно соответствует схеме `repo.LabelCreate` из OpenAPI.
|
||||
* @summary DTO для тела запроса на создание метки (POST /v1/labels).
|
||||
* @param name Название метки.
|
||||
* @param color Цвет метки в формате HEX (например, "#FF0000").
|
||||
* @param description Описание метки.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class LabelCreateDto(
|
||||
@Json(name = "name") val name: String,
|
||||
@Json(name = "color") val color: String?,
|
||||
@Json(name = "description") val description: String? = null // Описание не используется в приложении, но может быть в API
|
||||
@Json(name = "description") val description: String? = null // [AI_NOTE]: Описание не используется в приложении, но может быть в API
|
||||
)
|
||||
// [END_ENTITY: DataClass('LabelCreateDto')]
|
||||
// [END_FILE_LabelCreateDto.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,44 +7,39 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.LabelOut
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('LabelOutDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для метки.
|
||||
* [COHERENCE_NOTE] Поле `isArchived` сделано nullable (`Boolean?`),
|
||||
* так как оно отсутствует в JSON-ответе от сервера. Это исправляет ошибку парсинга
|
||||
* `JsonDataException: Required value 'isArchived' missing`.
|
||||
* @summary DTO для метки.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class LabelOutDto(
|
||||
@Json(name = "id") val id: String,
|
||||
@Json(name = "name") val name: String,
|
||||
// [COHERENCE_NOTE] Поле `color` может быть null или отсутствовать, делаем его nullable для безопасности.
|
||||
@Json(name = "color") val color: String?,
|
||||
// [FIX] Поле отсутствует в JSON, делаем nullable.
|
||||
@Json(name = "isArchived") val isArchived: Boolean?,
|
||||
@Json(name = "createdAt") val createdAt: String,
|
||||
@Json(name = "updatedAt") val updatedAt: String,
|
||||
// [COHERENCE_NOTE] Поле `description` также может отсутствовать, добавляем его как nullable.
|
||||
@Json(name = "description") val description: String?
|
||||
)
|
||||
// [END_ENTITY: DataClass('LabelOutDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('LabelOut')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из LabelOutDto в доменную модель LabelOut.
|
||||
* [COHERENCE_NOTE] Маппер обновлен для безопасной обработки nullable полей
|
||||
* и предоставления non-nullable значений по умолчанию для доменной модели.
|
||||
* @summary Mapper from LabelOutDto to the LabelOut domain model.
|
||||
*/
|
||||
fun LabelOutDto.toDomain(): LabelOut {
|
||||
return LabelOut(
|
||||
id = this.id,
|
||||
name = this.name,
|
||||
// [FIX] Используем Elvis-оператор для предоставления значения по умолчанию.
|
||||
color = this.color ?: "", // Пустая строка как дефолтный цвет
|
||||
isArchived = this.isArchived ?: false, // `false` как дефолтное состояние архива
|
||||
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]
|
||||
@@ -1,16 +1,16 @@
|
||||
// [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]
|
||||
import com.homebox.lens.domain.model.LabelSummary
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: DataClass('LabelSummaryDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для ответа от API при создании метки.
|
||||
* @coherence_note Структура этого класса точно соответствует схеме `repo.LabelSummary` из OpenAPI.
|
||||
* @summary DTO для ответа от API при создании метки.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class LabelSummaryDto(
|
||||
@@ -21,9 +21,11 @@ data class LabelSummaryDto(
|
||||
@Json(name = "createdAt") val createdAt: String?,
|
||||
@Json(name = "updatedAt") val updatedAt: String?
|
||||
)
|
||||
// [END_ENTITY: DataClass('LabelSummaryDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('LabelSummary')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* @summary Маппер из DTO в доменную модель.
|
||||
* @return Объект доменной модели [LabelSummary].
|
||||
* @sideeffect Отбрасывает поля, ненужные доменному слою (`color`, `description`, etc.),
|
||||
@@ -32,7 +34,9 @@ data class LabelSummaryDto(
|
||||
fun LabelSummaryDto.toDomain(): LabelSummary {
|
||||
return LabelSummary(
|
||||
id = this.id,
|
||||
name = this.name
|
||||
name = this.name,
|
||||
color = this.color ?: ""
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
// [END_FILE_LabelSummaryDto.kt]
|
||||
@@ -0,0 +1,24 @@
|
||||
// [FILE] LabelUpdateDto.kt
|
||||
// [SEMANTICS] data, dto, label, update
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
// [IMPORTS]
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: DataClass('LabelUpdateDto')]
|
||||
/**
|
||||
* @summary DTO for updating a label.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class LabelUpdateDto(
|
||||
@Json(name = "name")
|
||||
val name: String?,
|
||||
@Json(name = "color")
|
||||
val color: String?,
|
||||
@Json(name = "description")
|
||||
val description: String?
|
||||
)
|
||||
// [END_ENTITY: DataClass('LabelUpdateDto')]
|
||||
// [END_FILE_LabelUpdateDto.kt]
|
||||
@@ -0,0 +1,26 @@
|
||||
// [FILE] LocationCreateDto.kt
|
||||
// [SEMANTICS] data, dto, location, create
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
// [IMPORTS]
|
||||
import com.squareup.moshi.Json
|
||||
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")
|
||||
val name: String,
|
||||
@Json(name = "parentId")
|
||||
val parentId: String?,
|
||||
@Json(name = "color")
|
||||
val color: String?,
|
||||
@Json(name = "description")
|
||||
val description: String?
|
||||
)
|
||||
// [END_ENTITY: DataClass('LocationCreateDto')]
|
||||
// [END_FILE_LocationCreateDto.kt]
|
||||
@@ -1,31 +0,0 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api.dto
|
||||
// [FILE] LocationDto.kt
|
||||
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
|
||||
// [CONTRACT]
|
||||
/**
|
||||
* [ENTITY: DataClass('LocationOut')]
|
||||
* [PURPOSE] DTO для информации о местоположении.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class LocationOut(
|
||||
@Json(name = "id") val id: String,
|
||||
@Json(name = "name") val name: String
|
||||
)
|
||||
|
||||
/**
|
||||
* [ENTITY: DataClass('LocationOutCount')]
|
||||
* [PURPOSE] 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_FILE_LocationDto.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,47 +7,40 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.LocationOutCount
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('LocationOutCountDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для местоположения со счетчиком.
|
||||
* [COHERENCE_NOTE] Поля `color` и `isArchived` сделаны nullable (`String?`, `Boolean?`),
|
||||
* так как они отсутствуют в JSON-ответе от сервера. Это исправляет ошибку парсинга
|
||||
* `JsonDataException: Required value '...' missing`.
|
||||
* @summary DTO for a location with an item count.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class LocationOutCountDto(
|
||||
@Json(name = "id") val id: String,
|
||||
@Json(name = "name") val name: String,
|
||||
// [FIX] Поле отсутствует в JSON, делаем nullable.
|
||||
@Json(name = "color") val color: String?,
|
||||
// [FIX] Поле отсутствует в JSON, делаем nullable.
|
||||
@Json(name = "isArchived") val isArchived: Boolean?,
|
||||
@Json(name = "itemCount") val itemCount: Int,
|
||||
@Json(name = "createdAt") val createdAt: String,
|
||||
@Json(name = "updatedAt") val updatedAt: String,
|
||||
// [COHERENCE_NOTE] Поле `description` также может отсутствовать или быть null,
|
||||
// поэтому его тоже безопасно сделать nullable.
|
||||
@Json(name = "description") val description: String?
|
||||
)
|
||||
// [END_ENTITY: DataClass('LocationOutCountDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('LocationOutCount')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из LocationOutCountDto в доменную модель LocationOutCount.
|
||||
* [COHERENCE_NOTE] Маппер обновлен для безопасной обработки nullable полей
|
||||
* и предоставления non-nullable значений по умолчанию для доменной модели.
|
||||
* @summary Mapper from LocationOutCountDto to the LocationOutCount domain model.
|
||||
*/
|
||||
fun LocationOutCountDto.toDomain(): LocationOutCount {
|
||||
return LocationOutCount(
|
||||
id = this.id,
|
||||
name = this.name,
|
||||
// [FIX] Используем Elvis-оператор для предоставления значения по умолчанию, если поле null.
|
||||
color = this.color ?: "", // Пустая строка как дефолтный цвет
|
||||
isArchived = this.isArchived ?: false, // `false` как дефолтное состояние архива
|
||||
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]
|
||||
@@ -1,32 +1,35 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api.dto
|
||||
// [FILE] LocationOutDto.kt
|
||||
// [SEMANTICS] data_transfer_object, location
|
||||
|
||||
// [SEMANTICS] data, dto, location
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
// [IMPORTS]
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.LocationOut
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для местоположения.
|
||||
*/
|
||||
// [ENTITY: DataClass('LocationOutDto')]
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class LocationOutDto(
|
||||
@Json(name = "id") val id: String,
|
||||
@Json(name = "name") val name: String,
|
||||
@Json(name = "color") val color: String,
|
||||
@Json(name = "isArchived") val isArchived: Boolean,
|
||||
@Json(name = "createdAt") val createdAt: String,
|
||||
@Json(name = "updatedAt") val updatedAt: String
|
||||
@Json(name = "id")
|
||||
val id: String,
|
||||
@Json(name = "name")
|
||||
val name: String,
|
||||
@Json(name = "color")
|
||||
val color: String,
|
||||
@Json(name = "isArchived")
|
||||
val isArchived: Boolean,
|
||||
@Json(name = "createdAt")
|
||||
val createdAt: String,
|
||||
@Json(name = "updatedAt")
|
||||
val updatedAt: String
|
||||
)
|
||||
// [END_ENTITY: DataClass('LocationOutDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('LocationOut')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из LocationOutDto в доменную модель LocationOut.
|
||||
* @summary Mapper from LocationOutDto to the LocationOut domain model.
|
||||
*/
|
||||
fun LocationOutDto.toDomain(): LocationOut {
|
||||
return LocationOut(
|
||||
@@ -38,3 +41,5 @@ fun LocationOutDto.toDomain(): LocationOut {
|
||||
updatedAt = this.updatedAt
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
// [END_FILE_LocationOutDto.kt]
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
// [FILE] LocationUpdateDto.kt
|
||||
// [SEMANTICS] data, dto, location, update
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
// [IMPORTS]
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: DataClass('LocationUpdateDto')]
|
||||
/**
|
||||
* @summary DTO for updating a location.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class LocationUpdateDto(
|
||||
@Json(name = "name")
|
||||
val name: String?,
|
||||
@Json(name = "color")
|
||||
val color: String?,
|
||||
@Json(name = "description")
|
||||
val description: String?
|
||||
)
|
||||
// [END_ENTITY: DataClass('LocationUpdateDto')]
|
||||
|
||||
// [END_FILE_LocationUpdateDto.kt]
|
||||
@@ -1,15 +1,21 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api.dto
|
||||
// [FILE] LoginFormDto.kt
|
||||
|
||||
// [SEMANTICS] data, dto, login
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
// [IMPORTS]
|
||||
import com.squareup.moshi.Json
|
||||
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,
|
||||
@Json(name = "password") val password: String,
|
||||
@Json(name = "stayLoggedIn") val stayLoggedIn: Boolean = true
|
||||
)
|
||||
// [END_ENTITY: DataClass('LoginFormDto')]
|
||||
// [END_FILE_LoginFormDto.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,11 +7,11 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.MaintenanceEntry
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('MaintenanceEntryDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для записи об обслуживании.
|
||||
* @summary DTO for a maintenance entry.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class MaintenanceEntryDto(
|
||||
@@ -25,10 +24,12 @@ data class MaintenanceEntryDto(
|
||||
@Json(name = "createdAt") val createdAt: String,
|
||||
@Json(name = "updatedAt") val updatedAt: String
|
||||
)
|
||||
// [END_ENTITY: DataClass('MaintenanceEntryDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('MaintenanceEntry')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из MaintenanceEntryDto в доменную модель MaintenanceEntry.
|
||||
* @summary Mapper from MaintenanceEntryDto to the MaintenanceEntry domain model.
|
||||
*/
|
||||
fun MaintenanceEntryDto.toDomain(): MaintenanceEntry {
|
||||
return MaintenanceEntry(
|
||||
@@ -42,3 +43,4 @@ fun MaintenanceEntryDto.toDomain(): MaintenanceEntry {
|
||||
updatedAt = this.updatedAt
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
@@ -1,23 +0,0 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api.dto
|
||||
// [FILE] PaginationDto.kt
|
||||
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
|
||||
// [CONTRACT]
|
||||
/**
|
||||
* [ENTITY: DataClass('PaginationResult')]
|
||||
* [PURPOSE] 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_FILE_PaginationDto.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [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
|
||||
|
||||
@@ -8,11 +7,11 @@ package com.homebox.lens.data.api.dto
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import com.homebox.lens.domain.model.PaginationResult
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [CORE-LOGIC]
|
||||
// [ENTITY: DataClass('PaginationResultDto')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* DTO для постраничных результатов.
|
||||
* @summary DTO для постраничных результатов.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class PaginationResultDto<T>(
|
||||
@@ -21,17 +20,19 @@ data class PaginationResultDto<T>(
|
||||
@Json(name = "pageSize") val pageSize: Int,
|
||||
@Json(name = "total") val total: Int
|
||||
)
|
||||
// [END_ENTITY: DataClass('PaginationResultDto')]
|
||||
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('PaginationResult')]
|
||||
/**
|
||||
* [CONTRACT]
|
||||
* Маппер из PaginationResultDto в доменную модель PaginationResult.
|
||||
* @param transform Функция для преобразования каждого элемента из DTO в доменную модель.
|
||||
* @summary Mapper from PaginationResultDto to the PaginationResult domain model.
|
||||
*/
|
||||
fun <T, R> PaginationResultDto<T>.toDomain(transform: (T) -> R): PaginationResult<R> {
|
||||
fun <T, R> PaginationResultDto<T>.toDomain(mapper: (T) -> R): PaginationResult<R> {
|
||||
return PaginationResult(
|
||||
items = this.items.map(transform),
|
||||
items = this.items.map(mapper),
|
||||
page = this.page,
|
||||
pageSize = this.pageSize,
|
||||
total = this.total
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api.dto
|
||||
// [FILE] StatisticsDto.kt
|
||||
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
import com.squareup.moshi.Json
|
||||
import com.squareup.moshi.JsonClass
|
||||
import java.math.BigDecimal
|
||||
|
||||
// [CONTRACT]
|
||||
/**
|
||||
* [ENTITY: DataClass('GroupStatistics')]
|
||||
* [PURPOSE] 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_FILE_StatisticsDto.kt]
|
||||
@@ -1,15 +1,36 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api.dto
|
||||
// [FILE] TokenResponseDto.kt
|
||||
|
||||
// [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,
|
||||
@Json(name = "attachmentToken") val attachmentToken: String,
|
||||
@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,
|
||||
attachmentToken = this.attachmentToken,
|
||||
expiresAt = this.expiresAt
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toDomain')]
|
||||
// [END_FILE_TokenResponseDto.kt]
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user