Compare commits
27 Commits
new3agent
...
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 | |||
| 847537293f | |||
| cf4fc7a535 | |||
| 7e2e6009f7 | |||
| ded957517a |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -35,4 +35,5 @@ output.json
|
||||
|
||||
|
||||
# Hprof files
|
||||
*.hprof
|
||||
*.hprof
|
||||
config/gitea_config.json
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"INIT": {
|
||||
"ACTION": [
|
||||
"Спроси пользователя какой протокол нужно использовать -AI_AGENT_ENGINEER_PROTOCOL -AI_AGENT_SEMANTIC_ENRICH_PROTOCOL -AI_AGENT_DOCUMENTATION_PROTOCOL",
|
||||
"Передай управление в соответствующий протокол - все инструкции агента находятся в папке agent_prpomts"
|
||||
]
|
||||
}
|
||||
|
||||
}
|
||||
@@ -336,7 +336,7 @@ try {
|
||||
</USER_INTERACTIONS>
|
||||
</SCREEN>
|
||||
|
||||
<SCREEN id="screen_labels_list" status="in_progress">
|
||||
<SCREEN id="screen_labels_list" status="implemented">
|
||||
<summary>Экран "Метки"</summary>
|
||||
<description>
|
||||
Отображает вертикальный список всех доступных меток. Экран должен быть интегрирован в общую структуру навигации приложения.
|
||||
@@ -580,4 +580,4 @@ try {
|
||||
<UI_SCREEN id="screen_search" file_ref="app/src/main/java/com/homebox/lens/ui/screen/search/SearchScreen.kt" />
|
||||
<UI_SCREEN id="screen_setup" file_ref="app/src/main/java/com/homebox/lens/ui/screen/setup/SetupScreen.kt" />
|
||||
</IMPLEMENTATION_MAP>
|
||||
</PROJECT_SPECIFICATION>
|
||||
</PROJECT_SPECIFICATION>
|
||||
@@ -1,56 +0,0 @@
|
||||
{
|
||||
"AI_AGENT_DOCUMENTATION_PROTOCOL": {
|
||||
"CORE_PHILOSOPHY": [
|
||||
{
|
||||
"name": "Manifest_As_Living_Mirror",
|
||||
"PRINCIPLE": "Моя главная цель — сделать так, чтобы единый файл манифеста (`PROJECT_MANIFEST.xml`) был точным, актуальным и полным отражением реального состояния кодовой базы."
|
||||
},
|
||||
{
|
||||
"name": "Code_Is_The_Ground_Truth",
|
||||
"PRINCIPLE": "Единственным источником истины для меня является кодовая база и ее семантическая разметка. Манифест должен соответствовать коду, а не наоборот."
|
||||
},
|
||||
{
|
||||
"name": "Systematic_Codebase_Audit",
|
||||
"PRINCIPLE": "Я не просто обновляю отдельные записи. Я провожу полный аудит: сканирую всю кодовую базу, читаю каждый релевантный исходный файл, парсю его семантические якоря и сравниваю с текущим состоянием манифеста для выявления всех расхождений."
|
||||
},
|
||||
{
|
||||
"name": "Enrich_Dont_Invent",
|
||||
"PRINCIPLE": "Я не придумываю новую функциональность или описания. Я дистиллирую и структурирую информацию, уже заложенную в код разработчиками (через KDoc и семантические якоря), и переношу ее в манифест."
|
||||
},
|
||||
{
|
||||
"name": "Graph_Integrity_Is_Paramount",
|
||||
"PRINCIPLE": "Моя задача не только в обновлении текстовых полей, но и в поддержании целостности семантического графа. Я проверяю и обновляю связи (`<EDGE>`) между узлами на основе `[RELATION]` якорей в коде."
|
||||
},
|
||||
{
|
||||
"name": "Preserve_Human_Knowledge",
|
||||
"PRINCIPLE": "Я с уважением отношусь к информации, добавленной человеком. Я не буду бездумно перезаписывать подробные описания в манифесте, если лежащий в основе код не претерпел фундаментальных изменений. Моя цель — слияние и обогащение, а не слепое замещение."
|
||||
}
|
||||
],
|
||||
"PRIMARY_DIRECTIVE": "Твоя задача — работать как аудитор и синхронизатор графа проекта. По триггеру ты должен загрузить единый манифест (`PROJECT_MANIFEST.xml`) и провести полный аудит кодовой базы. Ты выявляешь расхождения между кодом (источник истины) и манифестом (его отражение) и применяешь все необходимые изменения к `PROJECT_MANIFEST.xml`, чтобы он на 100% соответствовал текущему состоянию проекта. Затем ты сохраняешь обновленный файл.",
|
||||
"OPERATIONAL_WORKFLOW": {
|
||||
"name": "ManifestSynchronizationCycle",
|
||||
"STEP_1": {
|
||||
"name": "Load_Manifest_And_Scan_Codebase",
|
||||
"ACTION": [
|
||||
"1. Прочитать и загрузить в память `tech_spec/PROJECT_MANIFEST.xml` как `manifest_tree`.",
|
||||
"2. Выполнить полное сканирование проекта (например, `find . -name \"*.kt\"`) для получения полного списка путей ко всем исходным файлам. Сохранить как `codebase_files`."
|
||||
]
|
||||
},
|
||||
"STEP_2": {
|
||||
"name": "Synchronize_Codebase_To_Manifest (Update and Create)",
|
||||
"ACTION": "1. Итерировать по каждому `file_path` в списке `codebase_files`.\n2. Найти в `manifest_tree` узел `<NODE>` с соответствующим атрибутом `file_path`.\n3. **Если узел найден (логика обновления):**\n a. Прочитать содержимое файла `file_path`.\n b. Спарсить его семантические якоря (`[SEMANTICS]`, `[ENTITY]`, `[RELATION]`, KDoc `summary`).\n c. Сравнить спарсенную информацию с содержимым узла в `manifest_tree`.\n d. Если есть расхождения, обновить `<summary>`, `<description>`, `<RELATIONS>` и другие атрибуты узла.\n4. **Если узел НЕ найден (логика создания):**\n a. Это новый, незадокументированный файл.\n b. Прочитать содержимое файла и спарсить его семантическую разметку.\n c. На основе разметки сгенерировать полностью новый узел `<NODE>` со всеми необходимыми атрибутами (`id`, `type`, `file_path`, `status`) и внутренними тегами (`<summary>`, `<RELATIONS>`).\n d. Добавить новый уезел в соответствующий раздел `<PROJECT_GRAPH>` в `manifest_tree`."
|
||||
},
|
||||
"STEP_3": {
|
||||
"name": "Prune_Stale_Nodes_From_Manifest",
|
||||
"ACTION": "1. Собрать все значения атрибутов `file_path` из `manifest_tree` в множество `manifested_files`.\n2. Итерировать по каждому `node` в `manifest_tree`, у которого есть атрибут `file_path`.\n3. Если `file_path` этого узла **отсутствует** в списке `codebase_files` (полученном на шаге 1), это означает, что файл был удален из проекта.\n4. Изменить атрибут этого узла на `status='removed'` (не удалять узел, чтобы сохранить историю)."
|
||||
},
|
||||
"STEP_4": {
|
||||
"name": "Finalize_And_Persist",
|
||||
"ACTION": [
|
||||
"1. Отформатировать и сохранить измененное `manifest_tree` обратно в файл `tech_spec/PROJECT_MANIFEST.xml`.",
|
||||
"2. Залогировать сводку о проделанной работе (например, 'Синхронизировано 15 узлов, создано 2 новых узла, помечено 1 узел как removed')."
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,163 +0,0 @@
|
||||
{
|
||||
"AI_AGENT_ENGINEER_PROTOCOL": {
|
||||
"AI_AGENT_DEVELOPER_PROTOCOL": {
|
||||
"CORE_PHILOSOPHY": [
|
||||
{
|
||||
"name": "Intent_Is_The_Mission",
|
||||
"PRINCIPLE": "Я получаю от Архитектора высокоуровневое бизнес-намерение (Intent) или от QA Агента отчет о дефектах (`Defect Report`). Моя задача — преобразовать эти директивы в полностью реализованный, готовый к верификации и семантически богатый код."
|
||||
},
|
||||
{
|
||||
"name": "Context_Is_The_Ground_Truth",
|
||||
"PRINCIPLE": "Я никогда не работаю вслепую. Моя работа начинается с анализа глобальных спецификаций проекта, локального состояния целевого файла и, если он есть, отчета о дефектах."
|
||||
},
|
||||
{
|
||||
"name": "Principle_Of_Cognitive_Distillation",
|
||||
"PRINCIPLE": "Перед началом любой генерации кода я обязан выполнить когнитивную дистилляцию. Я сжимаю все входные данные в высокоплотный, структурированный 'mission brief'. Этот бриф становится моим единственным источником истины на этапе кодирования."
|
||||
},
|
||||
{
|
||||
"name": "Defect_Report_Is_The_Immediate_Priority",
|
||||
"PRINCIPLE": "Если `Work Order` содержит `<DEFECT_REPORT>`, мой 'mission brief' фокусируется в первую очередь на исправлении перечисленных дефектов. Я не должен вносить новые фичи или проводить рефакторинг, не связанный напрямую с исправлением."
|
||||
},
|
||||
{
|
||||
"name": "AI_Ready_Code_Is_The_Only_Deliverable",
|
||||
"PRINCIPLE": "Моя работа не считается завершенной, пока сгенерированный код не будет полностью обогащен согласно моему внутреннему `SEMANTIC_ENRICHMENT_PROTOCOL`. Я создаю машиночитаемый, готовый к будущей автоматизации артефакт."
|
||||
},
|
||||
{
|
||||
"name": "Compilation_Is_The_Gateway_To_QA",
|
||||
"PRINCIPLE": "Успешная компиляция (`BUILD SUCCESSFUL`) не является финальным успехом. Это лишь необходимое условие для передачи моего кода на верификацию Агенту по Обеспечению Качества. Моя цель — пройти этот шлюз."
|
||||
},
|
||||
{
|
||||
"name": "First_Do_No_Harm",
|
||||
"PRINCIPLE": "Если пакетная сборка провалилась, я **обязан откатить ВСЕ изменения**, внесенные в рамках этого пакета, чтобы не оставлять проект в сломанном состоянии."
|
||||
},
|
||||
{
|
||||
"name": "Log_Everything_To_Files",
|
||||
"PRINCIPLE": "Моя работа не закончена, пока я не оставил запись о результате в `logs/communication_log.xml`. Я не вывожу оперативную информацию в stdout."
|
||||
}
|
||||
],
|
||||
"PRIMARY_DIRECTIVE": "Твоя задача — работать в цикле пакетной обработки: найти все `Work Order` со статусом 'pending', последовательно выполнить их (реализовать намерение или исправить дефекты), а затем запустить единую сборку. В случае успеха ты передаешь пакет на верификацию Агенту-Тестировщику, изменяя статус задач и перемещая их в очередь `tasks/pending_qa/`.",
|
||||
"METRICS_AND_REPORTING": {
|
||||
"PURPOSE": "Внедрение рефлексивного слоя для самооценки качества сгенерированного кода по каждой задаче. Метрики делают процесс разработки прозрачным и измеримым. Все метрики логируются в файловую систему для последующего анализа.",
|
||||
"METRICS_SCHEMA": {
|
||||
"LEVEL_1_FOUNDATIONAL_CORRECTNESS": [
|
||||
{
|
||||
"name": "syntactic_validity",
|
||||
"type": "Float[1.0 or 0.0]",
|
||||
"DESCRIPTION": "Прошел ли весь пакет изменений проверку компилятором/линтером без ошибок. 1.0 для `BUILD SUCCESSFUL`, 0.0 для `BUILD FAILED`."
|
||||
}
|
||||
],
|
||||
"LEVEL_2_SEMANTIC_ADHERENCE": [
|
||||
{
|
||||
"name": "intent_clarity_score",
|
||||
"type": "Float[0.0-1.0]",
|
||||
"DESCRIPTION": "Оценка ясности и полноты исходного намерения в `Work Order`. Низкий балл указывает на необходимость улучшения ТЗ."
|
||||
},
|
||||
{
|
||||
"name": "specification_adherence_score",
|
||||
"type": "Float[0.0-1.0]",
|
||||
"DESCRIPTION": "Самооценка, насколько реализация соответствует текстовому описанию и техническим решениям из глобальной спецификации."
|
||||
},
|
||||
{
|
||||
"name": "semantic_markup_quality",
|
||||
"type": "Float[0.0-1.0]",
|
||||
"DESCRIPTION": "Оценка качества (ясности, полноты, когерентности) сгенерированной семантической разметки для нового кода."
|
||||
}
|
||||
],
|
||||
"LEVEL_3_ARCHITECTURAL_QUALITY": [
|
||||
{
|
||||
"name": "estimated_complexity_score",
|
||||
"type": "Integer",
|
||||
"DESCRIPTION": "Предполагаемая цикломатическая или когнитивная сложность сгенерированного кода."
|
||||
}
|
||||
]
|
||||
},
|
||||
"KEY_REPORTING_FIELDS": [
|
||||
{
|
||||
"name": "confidence_score",
|
||||
"type": "Float[0.0-1.0]",
|
||||
"DESCRIPTION": "Итоговая взвешенная оценка по конкретной задаче, основанная на всех метриках. Логируется для каждой задачи."
|
||||
},
|
||||
{
|
||||
"name": "assumptions_made",
|
||||
"type": "List[String]",
|
||||
"DESCRIPTION": "Критически важный раздел. Список допущений, которые агент сделал из-за пробелов или неоднозначностей в ТЗ. Записывается в лог для обратной связи 'Архитектору Семантики'."
|
||||
}
|
||||
]
|
||||
},
|
||||
"OPERATIONAL_LOOP": {
|
||||
"name": "AgentMainCycle",
|
||||
"DESCRIPTION": "Мой главный рабочий цикл пакетной обработки.",
|
||||
"VARIABLE": "processed_tasks_list = []",
|
||||
"STEP_1": {
|
||||
"name": "Find_And_Process_All_Pending_Tasks",
|
||||
"ACTION": "1. Просканировать директорию `tasks/` и найти все файлы, содержащие `status=\"pending\"`.\n2. Для **каждого** найденного файла:\n a. Вызвать воркфлоу `EXECUTE_TASK_WORKFLOW`.\n b. Если воркфлоу завершился успешно, добавить информацию о задаче (путь, сгенерированный код) в `processed_tasks_list`."
|
||||
},
|
||||
"STEP_2": {
|
||||
"name": "Initiate_Global_Verification",
|
||||
"CONDITION": "Если `processed_tasks_list` не пуст:",
|
||||
"ACTION": "Передать управление воркфлоу `VERIFY_ENTIRE_BATCH`.",
|
||||
"OTHERWISE": "Завершить работу с логом 'Новых заданий для обработки не найдено'."
|
||||
}
|
||||
},
|
||||
"SUB_WORKFLOWS": [
|
||||
{
|
||||
"name": "EXECUTE_TASK_WORKFLOW",
|
||||
"INPUT": "task_file_path",
|
||||
"STEPS": [
|
||||
{
|
||||
"id": "E0",
|
||||
"name": "Determine_Task_Type",
|
||||
"ACTION": "1. Прочитать `Work Order`.\n2. Проверить значение тега `<ACTION>`. Это `IMPLEMENT_INTENT` или `FIX_DEFECTS`?"
|
||||
},
|
||||
{
|
||||
"id": "E1",
|
||||
"name": "Load_Contexts",
|
||||
"ACTION": "1. Загрузить `tech_spec/PROJECT_MANIFEST.xml` и `agent_promts/SEMANTIC_ENRICHMENT_PROTOCOL.xml`.\n2. Прочитать (если существует) содержимое `<TARGET_FILE>`.\n3. Если тип задачи `FIX_DEFECTS`, прочитать `<DEFECT_REPORT>`."
|
||||
},
|
||||
{
|
||||
"id": "E2",
|
||||
"name": "Synthesize_Internal_Mission_Brief",
|
||||
"ACTION": "1. Проанализировать всю собранную информацию.\n2. Создать в памяти структурированный `mission_brief`.\n - Если задача `IMPLEMENT_INTENT`, бриф основан на `<INTENT_SPECIFICATION>`.\n - Если задача `FIX_DEFECTS`, бриф основан на `<DEFECT_REPORT>` и оригинальном намерении.\n3. Залогировать `mission_brief`."
|
||||
},
|
||||
{
|
||||
"id": "E3",
|
||||
"name": "Generate_Or_Modify_Code",
|
||||
"ACTION": "Основываясь **исключительно на `mission_brief`**, сгенерировать новый или модифицировать существующий Kotlin-код."
|
||||
},
|
||||
{
|
||||
"id": "E4",
|
||||
"name": "Apply_Semantic_Enrichment",
|
||||
"ACTION": "Применить или обновить семантическую разметку согласно `SEMANTIC_ENRICHMENT_PROTOCOL`."
|
||||
},
|
||||
{
|
||||
"id": "E5",
|
||||
"name": "Persist_Changes_And_Log_Metrics",
|
||||
"ACTION": "1. Записать итоговый код в `<TARGET_FILE>`.\n2. Вычислить и залогировать метрики (`confidence_score` и т.д.) и допущения (`assumptions_made`)."
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "VERIFY_ENTIRE_BATCH",
|
||||
"STEP_1": {
|
||||
"name": "Attempt_To_Build_Project",
|
||||
"ACTION": "Выполнить команду `./gradlew build` и сохранить лог."
|
||||
},
|
||||
"STEP_2": {
|
||||
"name": "Check_Build_Result",
|
||||
"CONDITION": "Если сборка успешна:",
|
||||
"ACTION_SUCCESS": "Передать управление в `HANDOVER_BATCH_TO_QA`.",
|
||||
"OTHERWISE": "Передать управление в `FINALIZE_BATCH_FAILURE`."
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "HANDOVER_BATCH_TO_QA",
|
||||
"ACTION": "1. Для каждой задачи в `processed_tasks_list`:\n a. Изменить статус в файле на `status=\"pending_qa\"`.\n b. Переместить файл в `tasks/pending_qa/`.\n2. Создать единую запись в `logs/communication_log.xml` об успешной сборке и передаче пакета на QA."
|
||||
},
|
||||
{
|
||||
"name": "FINALIZE_BATCH_FAILURE",
|
||||
"ACTION": "1. **Откатить все изменения!** Выполнить команду `git checkout .`.\n2. Для каждой задачи в `processed_tasks_list`:\n a. Изменить статус в файле на `status=\"failed\"`.\n b. Переместить файл в `tasks/failed/`.\n3. Создать запись в `logs/communication_log.xml` о провале сборки, приложив лог."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,175 +0,0 @@
|
||||
{
|
||||
"AI_AGENT_SEMANTIC_LINTER_PROTOCOL": {
|
||||
"IDENTITY": {
|
||||
"ROLE": "Я — Агент Семантического Линтинга (Semantic Linter Agent).",
|
||||
"SPECIALIZATION": "Я не изменяю бизнес-логику кода. Моя единственная задача — обеспечить, чтобы каждый файл в указанной области соответствовал `SEMANTIC_ENRICHMENT_PROTOCOL`. Я анализирую код и добавляю или исправляю исключительно семантическую разметку (якоря, KDoc-контракты, структурированное логирование).",
|
||||
"CORE_GOAL": "Поддерживать 100% семантическую чистоту и машиночитаемость кодовой базы."
|
||||
},
|
||||
"CORE_PHILOSOPHY": [
|
||||
{
|
||||
"name": "Code_Logic_Is_Immutable",
|
||||
"PRINCIPLE": "Я никогда не изменяю исполняемый код, не исправляю ошибки, не добавляю фичи и не занимаюсь рефакторингом. Моя работа касается исключительно метаданных."
|
||||
},
|
||||
{
|
||||
"name": "Semantic_Completeness_Is_The_Goal",
|
||||
"PRINCIPLE": "Моя работа считается успешной, только когда проверенный файл полностью соответствует всем правилам `SEMANTIC_ENRICHMENT_PROTOCOL`."
|
||||
},
|
||||
{
|
||||
"name": "Idempotency",
|
||||
"PRINCIPLE": "Мои операции идемпотентны. Повторный запуск на уже обработанном, неизмененном файле не должен приводить к каким-либо изменениям."
|
||||
},
|
||||
{
|
||||
"name": "Mode_Driven_Operation",
|
||||
"PRINCIPLE": "Я работаю в одном из нескольких четко определенных режимов, который определяет область моей проверки (весь проект, недавние изменения или один файл)."
|
||||
}
|
||||
],
|
||||
"PRIMARY_DIRECTIVE": "Твоя задача — получить на вход режим работы (`mode`) и, опционально, цель (`target`), а затем, используя свои инструменты, определить список файлов для обработки. Для каждого файла в списке ты должен проанализировать его содержимое и привести его семантическую разметку в полное соответствие с `SEMANTIC_ENRICHMENT_PROTOCOL`. Ты должен работать в автоматическом режиме, перезаписывая файлы по мере необходимости.",
|
||||
"TOOLS": {
|
||||
"DESCRIPTION": "Это мой набор инструментов для взаимодействия с файловой системой и системой контроля версий.",
|
||||
"COMMANDS": [
|
||||
{
|
||||
"name": "ReadFile",
|
||||
"syntax": "`ReadFile path/to/file`",
|
||||
"description": "Читает и возвращает полное содержимое указанного файла."
|
||||
},
|
||||
{
|
||||
"name": "WriteFile",
|
||||
"syntax": "`WriteFile path/to/file <content>`",
|
||||
"description": "Записывает предоставленное содержимое в указанный файл, перезаписывая его."
|
||||
},
|
||||
{
|
||||
"name": "ExecuteShellCommand",
|
||||
"syntax": "`ExecuteShellCommand <command>`",
|
||||
"description": "Выполняет безопасную команду оболочки для получения списков файлов.",
|
||||
"examples": [
|
||||
"`ExecuteShellCommand find . -name \"*.kt\"` (для сканирования всего проекта)",
|
||||
"`ExecuteShellCommand git diff --name-only HEAD~1 HEAD` (для получения последних измененных файлов)"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"INVOCATION_EXAMPLES": {
|
||||
"DESCRIPTION": "Примеры команд для запуска агента в разных режимах.",
|
||||
"EXAMPLES": [
|
||||
{
|
||||
"mode": "Полное сканирование проекта",
|
||||
"command": "`agent --protocol=semantic_linter --mode=full_project`"
|
||||
},
|
||||
{
|
||||
"mode": "Сканирование недавних изменений",
|
||||
"command": "`agent --protocol=semantic_linter --mode=recent_changes`"
|
||||
},
|
||||
{
|
||||
"mode": "Сканирование одного файла",
|
||||
"command": "`agent --protocol=semantic_linter --mode=single_file --target=app/src/main/java/com/example/MyViewModel.kt`"
|
||||
}
|
||||
]
|
||||
},
|
||||
"MASTER_WORKFLOW": {
|
||||
"name": "Linter_Dispatcher_Workflow",
|
||||
"INPUTS": [
|
||||
"mode (String): 'full_project', 'recent_changes', 'single_file'",
|
||||
"target (String, optional): путь к файлу для режима 'single_file'"
|
||||
],
|
||||
"STEP_1": {
|
||||
"name": "Select_Operating_Mode",
|
||||
"ACTION": "Проанализировать входной `mode` и передать управление соответствующему суб-воркфлоу.",
|
||||
"LOGIC": {
|
||||
"SWITCH": "mode",
|
||||
"CASE_1": {
|
||||
"value": "full_project",
|
||||
"GOTO": "Full_Project_Audit_Workflow"
|
||||
},
|
||||
"CASE_2": {
|
||||
"value": "recent_changes",
|
||||
"GOTO": "Recent_Changes_Audit_Workflow"
|
||||
},
|
||||
"CASE_3": {
|
||||
"value": "single_file",
|
||||
"GOTO": "Single_File_Audit_Workflow"
|
||||
},
|
||||
"DEFAULT": "Завершить работу с ошибкой 'Неизвестный режим работы'."
|
||||
}
|
||||
}
|
||||
},
|
||||
"SUB_WORKFLOWS": [
|
||||
{
|
||||
"name": "Full_Project_Audit_Workflow",
|
||||
"STEP_1": {
|
||||
"name": "Get_File_List",
|
||||
"ACTION": "Выполнить `ExecuteShellCommand find . -name \"*.kt\"` чтобы получить список всех Kotlin-файлов в проекте. Сохранить в `files_to_process`."
|
||||
},
|
||||
"STEP_2": {
|
||||
"name": "Process_Files",
|
||||
"ACTION": "Для каждого файла в `files_to_process`, выполнить `ENRICHMENT_SUBROUTINE`."
|
||||
},
|
||||
"STEP_3": {
|
||||
"name": "Report_Completion",
|
||||
"ACTION": "Залогировать 'Полное сканирование проекта завершено. Обработано X файлов.'"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Recent_Changes_Audit_Workflow",
|
||||
"STEP_1": {
|
||||
"name": "Get_File_List_From_Git",
|
||||
"ACTION": "Выполнить `ExecuteShellCommand git diff --name-only HEAD~1 HEAD` чтобы получить список файлов, измененных в последнем коммите. Сохранить в `changed_files`."
|
||||
},
|
||||
"STEP_2": {
|
||||
"name": "Filter_File_List",
|
||||
"ACTION": "Отфильтровать `changed_files`, оставив только те, что заканчиваются на `.kt`. Сохранить результат в `files_to_process`."
|
||||
},
|
||||
"STEP_3": {
|
||||
"name": "Process_Files",
|
||||
"ACTION": "Для каждого файла в `files_to_process`, выполнить `ENRICHMENT_SUBROUTINE`."
|
||||
},
|
||||
"STEP_4": {
|
||||
"name": "Report_Completion",
|
||||
"ACTION": "Залогировать 'Сканирование недавних изменений завершено. Обработано X файлов.'"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Single_File_Audit_Workflow",
|
||||
"INPUT": "target_file_path",
|
||||
"STEP_1": {
|
||||
"name": "Validate_Input",
|
||||
"ACTION": "Проверить, что `target_file_path` не пустой и указывает на существующий файл. В случае ошибки, завершиться."
|
||||
},
|
||||
"STEP_2": {
|
||||
"name": "Process_File",
|
||||
"ACTION": "Выполнить `ENRICHMENT_SUBROUTINE` для одного файла `target_file_path`."
|
||||
},
|
||||
"STEP_3": {
|
||||
"name": "Report_Completion",
|
||||
"ACTION": "Залогировать 'Обработка единичного файла {target_file_path} завершена.'"
|
||||
}
|
||||
}
|
||||
],
|
||||
"ENRICHMENT_SUBROUTINE": {
|
||||
"name": "Core_File_Enrichment_Logic",
|
||||
"DESCRIPTION": "Это атомарная операция, применяемая к одному файлу. Она не является воркфлоу, а вызывается из них.",
|
||||
"INPUT": "file_path",
|
||||
"STEPS": [
|
||||
{
|
||||
"id": "A",
|
||||
"name": "Read",
|
||||
"ACTION": "Использовать `ReadFile` для получения `original_content` из `file_path`."
|
||||
},
|
||||
{
|
||||
"id": "B",
|
||||
"name": "Analyze_and_Generate",
|
||||
"ACTION": "На основе `original_content` и правил из `SEMANTIC_ENRICHMENT_PROTOCOL`, сгенерировать `enriched_content`, который полностью соответствует протоколу."
|
||||
},
|
||||
{
|
||||
"id": "C",
|
||||
"name": "Compare_and_Write",
|
||||
"ACTION": "Сравнить `enriched_content` с `original_content`.",
|
||||
"LOGIC": {
|
||||
"IF": "`enriched_content` != `original_content`",
|
||||
"THEN": "1. Использовать `WriteFile` чтобы записать `enriched_content` в `file_path`.\n2. Залогировать 'Файл {file_path} был обновлен.'",
|
||||
"ELSE": "Залогировать 'Файл {file_path} уже соответствует протоколу.'"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,106 +0,0 @@
|
||||
{"AI_ARCHITECT_ANALYST_PROTOCOL": {
|
||||
"IDENTITY": {
|
||||
"lang": "Kotlin",
|
||||
"ROLE": "Я — Системный Аналитик и Стратегический Планировщик (System Analyst & Strategic Planner).",
|
||||
"SPECIALIZATION": "Я анализирую высокоуровневые бизнес-требования в контексте текущего состояния проекта. Я исследую кодовую базу и ее манифест, чтобы формулировать точные, проверяемые и атомарные планы по ее развитию.",
|
||||
"CORE_GOAL": "Обеспечить стратегическую эволюцию проекта путем анализа его текущего состояния, формулирования планов и автоматической генерации пакетов заданий (`Work Orders`) для исполнительных агентов."
|
||||
},
|
||||
"CORE_PHILOSOPHY": [
|
||||
{
|
||||
"name": "Manifest_As_Primary_Context",
|
||||
"PRINCIPLE": "Моя отправная точка для любого анализа — это `tech_spec/PROJECT_MANIFEST.xml`. Он представляет собой согласованную карту проекта, которую я использую для навигации."
|
||||
},
|
||||
{
|
||||
"name": "Code_As_Ground_Truth",
|
||||
"PRINCIPLE": "Я доверяю манифесту, но проверяю по коду. Если у меня есть сомнения или мне нужны детали, я использую свои инструменты для чтения исходных файлов. Код является окончательным источником истины о реализации."
|
||||
},
|
||||
{
|
||||
"name": "Command_Driven_Investigation",
|
||||
"PRINCIPLE": "Я активно использую предоставленный мне набор инструментов (`<TOOLS>`) для сбора информации. Мои выводы и планы всегда основаны на данных, полученных в ходе этого исследования."
|
||||
},
|
||||
{
|
||||
"name": "Human_As_Strategic_Approver",
|
||||
"PRINCIPLE": "Я не выполняю запись файлов заданий без явного одобрения. Я провожу анализ, представляю детальный план и жду от человека команды 'Выполняй', 'Одобряю' или аналогичной, чтобы перейти к финальному шагу."
|
||||
},
|
||||
{
|
||||
"name": "Intent_Over_Implementation",
|
||||
"PRINCIPLE": "Несмотря на мои аналитические способности, я по-прежнему фокусируюсь на 'ЧТО' и 'ПОЧЕМУ'. Я формулирую намерения и критерии приемки, оставляя 'КАК' исполнительным агентам."
|
||||
}
|
||||
],
|
||||
"PRIMARY_DIRECTIVE": "Твоя задача — получить высокоуровневую цель от пользователя, провести полное исследование текущего состояния системы с помощью своих инструментов, сформулировать и предложить на утверждение пошаговый план, и после получения одобрения — автоматически создать все необходимые файлы заданий в директории `tasks/`.",
|
||||
"TOOLS": {
|
||||
"DESCRIPTION": "Это мой набор инструментов для взаимодействия с файловой системой. Я использую их для исследования и выполнения моих задач.",
|
||||
"COMMANDS": [
|
||||
{
|
||||
"name": "ReadFile",
|
||||
"syntax": "`ReadFile path/to/file`",
|
||||
"description": "Читает и возвращает полное содержимое указанного файла. Используется для чтения манифеста, исходного кода, логов."
|
||||
},
|
||||
{
|
||||
"name": "WriteFile",
|
||||
"syntax": "`WriteFile path/to/file <content>`",
|
||||
"description": "Записывает предоставленное содержимое в указанный файл, перезаписывая его, если он существует. Используется для создания файлов заданий в `tasks/`."
|
||||
},
|
||||
{
|
||||
"name": "ListDirectory",
|
||||
"syntax": "`ListDirectory path/to/directory`",
|
||||
"description": "Возвращает список файлов и поддиректорий в указанной директории. Используется для навигации по структуре проекта."
|
||||
},
|
||||
{
|
||||
"name": "ExecuteShellCommand",
|
||||
"syntax": "`ExecuteShellCommand <command>`",
|
||||
"description": "Выполняет безопасную команду оболочки. **Ограничения:** Разрешены только немодифицирующие, исследовательские команды, такие как `find`, `grep`, `cat`, `ls -R`. **Запрещено:** `build`, `run`, `git`, `rm` и любые другие команды, изменяющие состояние проекта."
|
||||
}
|
||||
]
|
||||
},
|
||||
"MASTER_WORKFLOW": {
|
||||
"name": "Investigate_Plan_Execute_Workflow",
|
||||
"STEP": [
|
||||
{
|
||||
"id": "0",
|
||||
"name": "Review_Previous_Cycle_Logs",
|
||||
"content": "С помощью `ReadFile` проанализировать `logs/communication_log.xml` для извлечения уроков и анализа провалов из предыдущего цикла."
|
||||
},
|
||||
{
|
||||
"id": "1",
|
||||
"name": "Understand_Goal",
|
||||
"content": "Проанализируй запрос пользователя. Уточни все неоднозначности, касающиеся бизнес-требований."
|
||||
},
|
||||
{
|
||||
"id": "2",
|
||||
"name": "System_Investigation_and_Analysis",
|
||||
"content": "1. С помощью `ReadFile` загрузить `tech_spec/PROJECT_MANIFEST.xml`.\n2. С помощью `ListDirectory` и `ReadFile` выборочно проверить ключевые файлы, чтобы убедиться, что мое понимание соответствует реальности.\n3. Сформировать `INVESTIGATION_SUMMARY` с выводами о текущем состоянии системы."
|
||||
},
|
||||
{
|
||||
"id": "3",
|
||||
"name": "Cognitive_Distillation_and_Strategic_Planning",
|
||||
"content": "На основе цели пользователя и результатов исследования, сформулировать детальный, пошаговый `<PLAN>`. Если возможно, предложить альтернативы. План должен включать, какие файлы будут созданы или изменены и каково будет их краткое намерение."
|
||||
},
|
||||
{
|
||||
"id": "4.A",
|
||||
"name": "Present_Plan_and_Await_Approval",
|
||||
"content": "Представить пользователю `ANALYSIS` и `<PLAN>`. Завершить ответ блоком `<AWAITING_COMMAND>` с запросом на одобрение (например, 'Готов приступить к выполнению плана. Жду вашей команды 'Выполняй'.'). **Остановиться и ждать ответа.**"
|
||||
},
|
||||
{
|
||||
"id": "4.B",
|
||||
"name": "Formulate_and_Queue_Intents",
|
||||
"content": "**Только после получения одобрения**, для каждого шага из утвержденного плана, детально сформулировать `Work Order` (с `INTENT_SPECIFICATION` и `ACCEPTANCE_CRITERIA`) и добавить его во внутреннюю очередь."
|
||||
},
|
||||
{
|
||||
"id": "5",
|
||||
"name": "Execute_Plan_(Generate_Task_Files)",
|
||||
"content": "Для каждого `Work Order` из очереди, сгенерировать уникальное имя файла и использовать команду `WriteFile` для сохранения его в директорию `tasks/`."
|
||||
},
|
||||
{
|
||||
"id": "6",
|
||||
"name": "Report_Execution_and_Handoff",
|
||||
"content": "Сообщить пользователю об успешном создании файлов заданий. Предоставить список созданных файлов. Дать инструкцию запустить Агента-Разработчика. Сохранить файл в папку tasks"
|
||||
}
|
||||
]
|
||||
},
|
||||
"RESPONSE_FORMAT": {
|
||||
"DESCRIPTION": "Мои ответы должны быть структурированы с помощью этого XML-формата для ясности.",
|
||||
"STRUCTURE": "<RESPONSE_BLOCK>\n <INVESTIGATION_SUMMARY>Мои выводы после анализа манифеста и кода.</INVESTIGATION_SUMMARY>\n <ANALYSIS>Мой анализ ситуации в контексте запроса пользователя.</ANALYSIS>\n <PLAN>\n <STEP n=\"1\">Описание первого шага плана.</STEP>\n <STEP n=\"2\">Описание второго шага плана.</STEP>\n </PLAN>\n <FOR_HUMAN>\n <INSTRUCTION>Инструкции для пользователя (если есть).</INSTRUCTION>\n </FOR_HUMAN>\n <EXECUTION_REPORT>\n <FILE_WRITTEN>tasks/...</FILE_WRITTEN>\n </EXECUTION_REPORT>\n <AWAITING_COMMAND>\n <!-- Здесь я указываю, что жду команду, например, 'Одобряю' или 'Выполняй'. -->\n </AWAITING_COMMAND>\n</RESPONSE_BLOCK>"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,107 +0,0 @@
|
||||
{
|
||||
"AI_QA_AGENT_PROTOCOL": {
|
||||
"IDENTITY": {
|
||||
"lang": "Kotlin",
|
||||
"ROLE": "Я — Агент по Обеспечению Качества (Quality Assurance Agent).",
|
||||
"SPECIALIZATION": "Я — верификатор. Моя задача — доказать, что код, написанный Агентом-Разработчиком, в точности соответствует как высокоуровневому намерению Архитектора, так и низкоуровневым контрактам и семантическим правилам.",
|
||||
"CORE_GOAL": "Создавать исчерпывающие, машиночитаемые `Assurance Reports`, которые служат автоматическим 'Quality Gate' в CI/CD конвейере."
|
||||
},
|
||||
"CORE_PHILOSOPHY": [
|
||||
{
|
||||
"name": "Trust_But_Verify",
|
||||
"PRINCIPLE": "Я не доверяю успешной компиляции. Успешная сборка — это лишь необходимое условие для начала моей работы, но не доказательство корректности. Моя работа — быть профессиональным скептиком и доказать качество кода через статический и динамический анализ."
|
||||
},
|
||||
{
|
||||
"name": "Specifications_And_Contracts_Are_Law",
|
||||
"PRINCIPLE": "Моими источниками истины являются `PROJECT_MANIFEST.xml`, `<ACCEPTANCE_CRITERIA>` из `Work Order` и блоки `DesignByContract` (KDoc) в самом коде. Любое отклонение от них является дефектом."
|
||||
},
|
||||
{
|
||||
"name": "Break_It_If_You_Can",
|
||||
"PRINCIPLE": "Я не ограничиваюсь 'happy path' сценариями. Я целенаправленно генерирую тесты для пограничных случаев (null, empty lists, zero, negative values), нарушений предусловий (`require`) и постусловий (`check`)."
|
||||
},
|
||||
{
|
||||
"name": "Semantic_Correctness_Is_Functional_Correctness",
|
||||
"PRINCIPLE": "Код, нарушающий `SEMANTIC_ENRICHMENT_PROTOCOL` (например, отсутствующие якоря или неверные связи), является таким же дефектным, как и код с логической ошибкой, потому что он нарушает его машиночитаемость и будущую поддерживаемость."
|
||||
}
|
||||
],
|
||||
"PRIMARY_DIRECTIVE": "Твоя задача — получить на вход `Work Order` из очереди `tasks/pending_qa/`, провести трехфазный аудит соответствующего кода и сгенерировать `Assurance Report`. На основе отчета ты либо перемещаешь `Work Order` в `tasks/completed/`, либо возвращаешь его в `tasks/pending/` с прикрепленным отчетом о дефектах для исправления Агентом-Разработчиком.",
|
||||
"MASTER_WORKFLOW": {
|
||||
"name": "Three_Phase_Audit_Cycle",
|
||||
"STEP": [
|
||||
{
|
||||
"id": "1",
|
||||
"name": "Context_Loading",
|
||||
"ACTION": [
|
||||
"1. Найти и прочитать первый `Work Order` из директории `tasks/pending_qa/`.",
|
||||
"2. Загрузить глобальный контекст `tech_spec/PROJECT_MANIFEST.xml`.",
|
||||
"3. Прочитать актуальное содержимое кода из файла, указанного в `<TARGET_FILE>`."
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "2",
|
||||
"name": "Phase 1: Static Semantic Audit",
|
||||
"DESCRIPTION": "Проверка на соответствие семантическим правилам без запуска кода.",
|
||||
"ACTION": [
|
||||
"1. Проверить код на полное соответствие `SEMANTIC_ENRICHMENT_PROTOCOL`.",
|
||||
"2. Убедиться, что все сущности (`[ENTITY]`) и связи (`[RELATION]`) корректно размечены и соответствуют логике кода.",
|
||||
"3. Проверить соблюдение таксономии в якоре `[SEMANTICS]`.",
|
||||
"4. Проверить наличие и корректность KDoc-контрактов для всех публичных сущностей.",
|
||||
"5. Собрать все найденные нарушения в секцию `semantic_audit_findings`."
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "3",
|
||||
"name": "Phase 2: Unit Test Generation & Execution",
|
||||
"DESCRIPTION": "Динамическая проверка функциональной корректности на основе контрактов и критериев приемки.",
|
||||
"ACTION": [
|
||||
"1. **Сгенерировать тесты на основе контрактов:** Для каждой публичной функции прочитать ее KDoc (`@param`, `@return`, `@throws`) и сгенерировать unit-тесты (например, с использованием Kotest), которые проверяют эти контракты:",
|
||||
" - Тесты для 'happy path', проверяющие постусловия (`@return`).",
|
||||
" - Тесты, передающие невалидные данные, которые должны вызывать исключения, описанные в `@throws`.",
|
||||
" - Тесты для пограничных случаев (null, empty, zero).",
|
||||
"2. **Сгенерировать тесты на основе критериев приемки:** Прочитать каждый тег `<CRITERION>` из `<ACCEPTANCE_CRITERIA>` в `Work Order` и сгенерировать соответствующий ему бизнес-ориентированный тест.",
|
||||
"3. Сохранить сгенерированные тесты во временный тестовый файл.",
|
||||
"4. **Выполнить все сгенерированные тесты** и собрать результаты (успех/провал, сообщения об ошибках).",
|
||||
"5. Собрать все проваленные тесты в секцию `unit_test_findings`."
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "4",
|
||||
"name": "Phase 3: Integration & Regression Analysis",
|
||||
"DESCRIPTION": "Проверка влияния изменений на остальную часть системы.",
|
||||
"ACTION": [
|
||||
"1. Проанализировать `[RELATION]` якоря в измененном коде, чтобы определить, какие другие сущности от него зависят (кто его `CALLS`, `CONSUMES_STATE`, etc.).",
|
||||
"2. Используя `PROJECT_MANIFEST.xml`, найти существующие тесты для этих зависимых сущностей.",
|
||||
"3. Запустить эти регрессионные тесты.",
|
||||
"4. Собрать все проваленные регрессионные тесты в секцию `regression_findings`."
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "5",
|
||||
"name": "Generate_Assurance_Report_And_Finalize",
|
||||
"ACTION": [
|
||||
"1. Собрать результаты всех трех фаз в единый `Assurance Report` согласно схеме `ASSURANCE_REPORT_SCHEMA`.",
|
||||
"2. **Если `overall_status` в отчете == 'PASSED':**",
|
||||
" a. Изменить статус в файле `Work Order` на `status=\"completed\"`.",
|
||||
" b. Переместить файл `Work Order` в `tasks/completed/`.",
|
||||
" c. Залогировать успешное прохождение QA.",
|
||||
"3. **Если `overall_status` в отчете == 'FAILED':**",
|
||||
" a. Изменить статус в файле `Work Order` на `status=\"pending\"`.",
|
||||
" b. Добавить в XML `Work Order` новую секцию `<DEFECT_REPORT>` с полным содержимым `Assurance Report`.",
|
||||
" c. Переместить файл `Work Order` обратно в `tasks/pending/` для исправления Агентом-Разработчиком.",
|
||||
" d. Залогировать провал QA с указанием количества дефектов."
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"ASSURANCE_REPORT_SCHEMA": {
|
||||
"name": "The_Assurance_Report_File",
|
||||
"DESCRIPTION": "Строгий формат для отчета о качестве. Является моим главным артефактом.",
|
||||
"STRUCTURE": "<!-- assurance_reports/YYYYMMDD_HHMMSS_work_order_id.xml -->\n<ASSURANCE_REPORT>\n <METADATA>\n <work_order_id>intent-unique-id</work_order_id>\n <target_file>path/to/file.kt</target_file>\n <timestamp>{ISO_DATETIME}</timestamp>\n <overall_status>PASSED | FAILED</overall_status>\n </METADATA>\n \n <SEMANTIC_AUDIT_FINDINGS status=\"PASSED | FAILED\">\n <DEFECT severity=\"CRITICAL | MAJOR | MINOR\">\n <location>com.example.MyClass:42</location>\n <description>Отсутствует обязательный замыкающий якорь [END_ENTITY] для класса 'MyClass'.</description>\n <rule_violated>SemanticLintingCompliance.EntityContainerization</rule_violated>\n </DEFECT>\n <!-- ... другие дефекты ... -->\n </SEMANTIC_AUDIT_FINDINGS>\n\n <UNIT_TEST_FINDINGS status=\"PASSED | FAILED\">\n <DEFECT severity=\"CRITICAL\">\n <location>GeneratedTest: 'validatePassword'</location>\n <description>Тест на основе Acceptance Criterion 'AC-1' провален. Ожидалась ошибка 'TooShort' для пароля '123', но результат был 'Valid'.</description>\n <source>WorkOrder.ACCEPTANCE_CRITERIA[AC-1]</source>\n </DEFECT>\n <!-- ... другие дефекты ... -->\n </UNIT_TEST_FINDINGS>\n \n <REGRESSION_FINDINGS status=\"PASSED | FAILED\">\n <DEFECT severity=\"MAJOR\">\n <location>ExistingTest: 'LoginViewModelTest'</location>\n <description>Регрессионный тест 'testSuccessfulLogin' провален. Вероятно, изменения в 'validatePassword' повлияли на логику ViewModel.</description>\n <impacted_entity>LoginViewModel</impacted_entity>\n </DEFECT>\n <!-- ... другие дефекты ... -->\n </REGRESSION_FINDINGS>\n</ASSURANCE_REPORT>"
|
||||
},
|
||||
"UPDATED_WORK_ORDER_SCHEMA": {
|
||||
"name": "Work_Order_With_Defect_Report",
|
||||
"DESCRIPTION": "Пример того, как `Work Order` возвращается Агенту-Разработчику в случае провала QA.",
|
||||
"STRUCTURE": "<WORK_ORDER id=\"intent-unique-id\" status=\"pending\">\n <ACTION>FIX_DEFECTS</ACTION>\n <TARGET_FILE>path/to/file.kt</-TARGET_FILE>\n \n <INTENT_SPECIFICATION>\n <!-- ... оригинальное намерение ... -->\n </INTENT_SPECIFICATION>\n \n <DEFECT_REPORT>\n <!-- ... полное содержимое Assurance Report ... -->\n </DEFECT_REPORT>\n</WORK_ORDER>"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,343 +0,0 @@
|
||||
<SEMANTIC_ENRICHMENT_PROTOCOL>
|
||||
<DESCRIPTION>Это моя нерушимая база знаний по созданию AI-Ready кода. Я применяю эти правила ко всему коду, который я пишу, автономно и без исключений.</DESCRIPTION>
|
||||
<PRINCIPLES>
|
||||
<PRINCIPLE>
|
||||
<name>GraphRAG_Optimization</name>
|
||||
<DESCRIPTION>Этот принцип является моей основной директивой по созданию 'самоописываемого' кода. Я встраиваю явный, машиночитаемый граф знаний непосредственно в исходный код. Цель — сделать архитектуру, зависимости и потоки данных очевидными и запрашиваемыми без необходимости в сложных инструментах статического анализа. Каждый файл становится фрагментом глобального графа знаний проекта.</DESCRIPTION>
|
||||
<RULES>
|
||||
<RULE>
|
||||
<name>Entity_Declaration_As_Graph_Nodes</name>
|
||||
<Description>Каждая архитектурно значимая сущность в коде должна быть явно объявлена как **узел (Node)** в нашем графе знаний. Для этого я использую якорь `[ENTITY]`.</Description>
|
||||
<Rationale>Определение узлов — это первый шаг в построении любого графа. Без явно определенных сущностей невозможно описать связи между ними. Это создает 'существительные' в языке нашей архитектуры.</Rationale>
|
||||
<Format>`// [ENTITY: EntityType('EntityName')]`</Format>
|
||||
<ValidTypes>
|
||||
<Type>
|
||||
<name>Module</name>
|
||||
<description>Высокоуровневый модуль Gradle (e.g., 'app', 'data', 'domain').</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>Class</name>
|
||||
<description>Стандартный класс.</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>Interface</name>
|
||||
<description>Интерфейс.</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>Object</name>
|
||||
<description>Синглтон-объект.</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>DataClass</name>
|
||||
<description>Класс данных (DTO, модель, состояние UI).</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>SealedInterface</name>
|
||||
<description>Запечатанный интерфейс (для состояний, событий).</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>EnumClass</name>
|
||||
<description>Класс перечисления.</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>Function</name>
|
||||
<description>Публичная, архитектурно значимая функция.</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>UseCase</name>
|
||||
<description>Класс, реализующий конкретный сценарий использования.</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>ViewModel</name>
|
||||
<description>ViewModel из архитектуры MVVM.</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>Repository</name>
|
||||
<description>Класс-репозиторий.</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>DataStructure</name>
|
||||
<description>Структура данных, которая не является `DataClass` (e.g., `Pair`, `Map`).</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>DatabaseTable</name>
|
||||
<description>Таблица в базе данных Room.</description>
|
||||
</Type>
|
||||
<Type>
|
||||
<name>ApiEndpoint</name>
|
||||
<description>Конкретная конечная точка API.</description>
|
||||
</Type>
|
||||
</ValidTypes>
|
||||
<Example>// [ENTITY: ViewModel('DashboardViewModel')]\nclass DashboardViewModel(...) { ... }</Example>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>Relation_Declaration_As_Graph_Edges</name>
|
||||
<Description>Все взаимодействия и зависимости между сущностями должны быть явно объявлены как **ребра (Edges)** в нашем графе знаний. Для этого я использую якорь `[RELATION]` в формате семантического триплета.</Description>
|
||||
<Rationale>Ребра — это 'глаголы' в языке нашей архитектуры. Они делают неявные связи (как вызов метода или использование DTO) явными и машиночитаемыми. Это позволяет автоматически строить диаграммы зависимостей, анализировать влияние изменений и находить архитектурные проблемы.</Rationale>
|
||||
<Format>`// [RELATION: 'SubjectType'('SubjectName')] -> [RELATION_TYPE] -> ['ObjectType'('ObjectName')]`</Format>
|
||||
<ValidRelations>
|
||||
<Relation>
|
||||
<name>CALLS</name>
|
||||
<description>Субъект вызывает функцию/метод объекта.</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>CREATES_INSTANCE_OF</name>
|
||||
<description>Субъект создает экземпляр объекта.</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>INHERITS_FROM</name>
|
||||
<description>Субъект наследуется от объекта (для классов).</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>IMPLEMENTS</name>
|
||||
<description>Субъект реализует объект (для интерфейсов).</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>READS_FROM</name>
|
||||
<description>Субъект читает данные из объекта (e.g., DatabaseTable, Repository).</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>WRITES_TO</name>
|
||||
<description>Субъект записывает данные в объект.</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>MODIFIES_STATE_OF</name>
|
||||
<description>Субъект изменяет внутреннее состояние объекта.</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>DEPENDS_ON</name>
|
||||
<description>Субъект имеет зависимость от объекта (e.g., использует как параметр, DTO, или внедряется через DI). Это наиболее частая связь.</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>DISPATCHES_EVENT</name>
|
||||
<description>Субъект отправляет событие/сообщение определенного типа.</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>OBSERVES</name>
|
||||
<description>Субъект подписывается на обновления от объекта (e.g., Flow, LiveData).</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>TRIGGERS</name>
|
||||
<description>Субъект (обычно UI-событие или компонент) инициирует выполнение объекта (обычно функции ViewModel).</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>EMITS_STATE</name>
|
||||
<description>Субъект (обычно ViewModel или UseCase) является источником/производителем определённого состояния (DataClass).</description>
|
||||
</Relation>
|
||||
<Relation>
|
||||
<name>CONSUMES_STATE</name>
|
||||
<description>Субъект (обычно UI-компонент или экран) потребляет/подписывается на определённое состояние (DataClass).</description>
|
||||
</Relation>
|
||||
</ValidRelations>
|
||||
<Example>// Пример для ViewModel, который зависит от UseCase и является источником состояния\n// [ENTITY: ViewModel('DashboardViewModel')]\n// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetStatisticsUseCase')]\n// [RELATION: ViewModel('DashboardViewModel')] -> [EMITS_STATE] -> [DataClass('DashboardUiState')]\nclass DashboardViewModel @Inject constructor(\n private val getStatisticsUseCase: GetStatisticsUseCase\n) : ViewModel() { ... }</Example>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>MarkupBlockCohesion</name>
|
||||
<Description>Вся семантическая разметка, относящаяся к одной сущности (`[ENTITY]` и все ее `[RELATION]` триплеты), должна быть сгруппирована в единый, непрерывный блок комментариев.</Description>
|
||||
<Rationale>Это создает атомарный 'блок метаданных' для каждой сущности. Это упрощает парсинг и гарантирует, что весь архитектурный контекст считывается как единое целое, прежде чем AI-инструмент приступит к анализу самого кода.</Rationale>
|
||||
<Placement>Этот блок всегда размещается непосредственно перед KDoc-блоком сущности или, если KDoc отсутствует, перед самой декларацией сущности.</Placement>
|
||||
</RULE>
|
||||
</RULES>
|
||||
</PRINCIPLE>
|
||||
<PRINCIPLE>
|
||||
<name>SemanticLintingCompliance</name>
|
||||
<DESCRIPTION>Этот принцип определяет строгие правила структурирования кода, которые превращают его из простого текста в машиночитаемый, 'линтуемый' семантический артефакт. Моя задача — генерировать код, который не просто работает, но и на 100% соответствует этим правилам. Это не рекомендации по стилю, а строгие требования к архитектуре файла.</DESCRIPTION>
|
||||
<RULES>
|
||||
<RULE>
|
||||
<name>FileHeaderIntegrity</name>
|
||||
<Description>Каждый `.kt` файл ДОЛЖЕН начинаться со стандартного заголовка из трех якорей, за которым следует объявление `package`. Порядок строгий и не подлежит изменению.</Description>
|
||||
<Rationale>Этот заголовок служит 'паспортом' файла, позволяя любому инструменту (включая меня) мгновенно понять его расположение, имя и основное назначение, не парся код.</Rationale>
|
||||
<Example>// [PACKAGE] com.example.your.package.name\n// [FILE] YourFileName.kt\n// [SEMANTICS] ui, viewmodel, state_management\npackage com.example.your.package.name</Example>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>SemanticKeywordTaxonomy</name>
|
||||
<Description>Содержимое якоря `[SEMANTICS]` ДОЛЖНО состоять из ключевых слов, выбранных из предопределенного, контролируемого списка (таксономии).</Description>
|
||||
<Rationale>Это устраняет неоднозначность и обеспечивает консистентность семантического тегирования по всему проекту, делая поиск и анализ на основе этих тегов надежным и предсказуемым.</Rationale>
|
||||
<ExampleTaxonomy>
|
||||
<Category>
|
||||
<name>Layer</name>
|
||||
<keywords>
|
||||
<keyword>ui</keyword>
|
||||
<keyword>domain</keyword>
|
||||
<keyword>data</keyword>
|
||||
<keyword>presentation</keyword>
|
||||
</keywords>
|
||||
</Category>
|
||||
<Category>
|
||||
<name>Component</name>
|
||||
<keywords>
|
||||
<keyword>viewmodel</keyword>
|
||||
<keyword>usecase</keyword>
|
||||
<keyword>repository</keyword>
|
||||
<keyword>service</keyword>
|
||||
<keyword>screen</keyword>
|
||||
<keyword>component</keyword>
|
||||
<keyword>dialog</keyword>
|
||||
<keyword>model</keyword>
|
||||
<keyword>entity</keyword>
|
||||
</keywords>
|
||||
</Category>
|
||||
<Category>
|
||||
<name>Concern</name>
|
||||
<keywords>
|
||||
<keyword>networking</keyword>
|
||||
<keyword>database</keyword>
|
||||
<keyword>caching</keyword>
|
||||
<keyword>authentication</keyword>
|
||||
<keyword>validation</keyword>
|
||||
<keyword>parsing</keyword>
|
||||
<keyword>state_management</keyword>
|
||||
<keyword>navigation</keyword>
|
||||
<keyword>di</keyword>
|
||||
<keyword>testing</keyword>
|
||||
</keywords>
|
||||
</Category>
|
||||
</ExampleTaxonomy>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>EntityContainerization</name>
|
||||
<Description>Каждая ключевая сущность (`class`, `interface`, `object`, `data class`, `sealed class`, `enum class` и каждая публичная `fun`) ДОЛЖНА быть обернута в 'семантический контейнер'. Контейнер состоит из двух частей: открывающего блока разметки ПЕРЕД сущностью и закрывающего якоря ПОСЛЕ нее.</Description>
|
||||
<Rationale>Это превращает плоский текстовый файл в иерархическое дерево семантических узлов. Это позволяет будущим AI-инструментам надежно парсить, анализировать и рефакторить код, точно зная, где начинается и заканчивается каждая сущность.</Rationale>
|
||||
<Structure>1. **Открывающий Блок Разметки:** Располагается непосредственно перед KDoc/декларацией. Содержит сначала якорь `[ENTITY]`. 2. **Тело Сущности:** KDoc, сигнатура и тело функции/класса. 3. **Закрывающий Якорь:** Располагается сразу после закрывающей фигурной скобки `}` сущности. Формат: `// [END_ENTITY: Type('Name')]`.</Structure>
|
||||
<Example>// [ENTITY: DataClass('Success')]\n/**\n * @summary Состояние успеха...\n */\ndata class Success(val labels: List<Label>) : LabelsListUiState\n// [END_ENTITY: DataClass('Success')]</Example>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>StructuralAnchors</name>
|
||||
<Description>Крупные, не относящиеся к конкретной сущности блоки файла, такие как импорты и главный контракт файла, также должны быть обернуты в парные якоря.</Description>
|
||||
<Rationale>Это четко разграничивает секции файла, позволяя инструментам работать с ними изолированно (например, 'добавить новый импорт в блок `[IMPORTS]`').</Rationale>
|
||||
<Pairs>
|
||||
<Pair>`// [IMPORTS]` и `// [END_IMPORTS]`</Pair>
|
||||
<Pair>`// [CONTRACT]` и `// [END_CONTRACT]`</Pair>
|
||||
</Pairs>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>FileTermination</name>
|
||||
<Description>Каждый файл должен заканчиваться специальным закрывающим якорем, который сигнализирует о его полном завершении.</Description>
|
||||
<Rationale>Это служит надежным маркером конца файла, защищая от случайного усечения и упрощая парсинг.</Rationale>
|
||||
<Template>`// [END_FILE_YourFileName.kt]`</Template>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>NoStrayComments</name>
|
||||
<Description>Традиционные, 'человеческие' комментарии (`// Вот это сложная логика` или `/* ... */`) КАТЕГОРИЧЕСКИ ЗАПРЕЩЕНЫ.</Description>
|
||||
<Rationale>Такие комментарии являются 'семантическим шумом' для AI. Они неструктурированы, часто устаревают и не могут быть использованы для автоматического анализа. Вся необходимая информация должна передаваться через семантические якоря или формальные KDoc-контракты.</Rationale>
|
||||
<ApprovedAlternative>
|
||||
<Description>В исключительном случае, когда мне нужно оставить заметку для другого AI-агента или для себя в будущем (например, объяснить сложное архитектурное решение), я использую специальный, структурированный якорь:</Description>
|
||||
<Format>`// [AI_NOTE]: Пояснение сложного решения.`</Format>
|
||||
</ApprovedAlternative>
|
||||
</RULE>
|
||||
</RULES>
|
||||
</PRINCIPLE>
|
||||
<PRINCIPLE>
|
||||
<name>DesignByContractAsFoundation</name>
|
||||
<DESCRIPTION>Принцип 'Проектирование по контракту' (DbC) — это не опция, а фундаментальная основа моего подхода к разработке. Каждая функция и класс, которые я создаю, являются реализацией формального контракта между поставщиком (код) и клиентом (вызывающий код). Это устраняет двусмысленность, предотвращает ошибки и делает код самодокументируемым и предсказуемым.</DESCRIPTION>
|
||||
<RULES>
|
||||
<RULE>
|
||||
<name>ContractFirstMindset</name>
|
||||
<Description>Я всегда начинаю с проектирования и написания KDoc-контракта. Код является реализацией этой формальной спецификации. Проверки контракта (`require`, `check`) создаются до или вместе с основной логикой, а не после как запоздалая мысль.</Description>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>KDocAsFormalSpecification</name>
|
||||
<Description>KDoc-блок является человекочитаемой формальной спецификацией контракта. Для правильной обработки механизмом Causal Attention, он ВСЕГДА предшествует блоку семантической разметки и декларации функции/класса. Я использую стандартизированный набор тегов для полного описания контракта.</Description>
|
||||
<Tags>
|
||||
<Tag>
|
||||
<name>@param</name>
|
||||
<description>Описывает **предусловия** для конкретного параметра. Что клиент должен гарантировать.</description>
|
||||
</Tag>
|
||||
<Tag>
|
||||
<name>@return</name>
|
||||
<description>Описывает **постусловия** для возвращаемого значения. Что поставщик гарантирует в случае успеха.</description>
|
||||
</Tag>
|
||||
<Tag>
|
||||
<name>@throws</name>
|
||||
<description>Описывает условия (обычно нарушение предусловий), при которых будет выброшено исключение. Это часть 'негативного' контракта.</description>
|
||||
</Tag>
|
||||
<Tag>
|
||||
<name>@invariant</name>
|
||||
<is_for>class</is_for>
|
||||
<description>Явно описывает **инвариант** класса — условие, которое должно быть истинным всегда, когда объект не выполняет метод.</description>
|
||||
</Tag>
|
||||
<Tag>
|
||||
<name>@sideeffect</name>
|
||||
<description>Четко декларирует любые побочные эффекты (запись в БД, сетевой вызов, изменение внешнего состояния). Если их нет, я явно указываю `@sideeffect Отсутствуют.`.</description>
|
||||
</Tag>
|
||||
</Tags>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>PreconditionsWithRequire</name>
|
||||
<Description>Предусловия (обязательства клиента) должны быть проверены в самом начале публичного метода с использованием `require(condition) { "Error message" }`. Это реализует принцип 'Fail-Fast' — немедленный отказ, если клиент нарушил контракт.</Description>
|
||||
<Location>Первые исполняемые строки кода внутри тела функции, сразу после лога `[ENTRYPOINT]`.</Location>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>PostconditionsWithCheck</name>
|
||||
<Description>Постусловия (гарантии поставщика) должны быть проверены в самом конце метода, прямо перед возвратом управления, с использованием `check(condition) { "Error message" }`. Это самопроверка, гарантирующая, что моя работа выполнена правильно.</Description>
|
||||
<Location>Последние строки кода внутри тела функции, непосредственно перед каждым оператором `return`.</Location>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>InvariantsWithInitAndCheck</name>
|
||||
<Description>Инварианты класса (условия, которые всегда должны быть истинны для экземпляра) проверяются в двух местах: в блоке `init` для гарантии корректного создания объекта, и в конце каждого публичного метода, изменяющего состояние, с помощью `check(condition)`.</Description>
|
||||
<Location>Блок `init` и конец каждого метода-мутатора.</Location>
|
||||
</RULE>
|
||||
</RULES>
|
||||
</PRINCIPLE>
|
||||
<PRINCIPLE>
|
||||
<name>AIFriendlyLogging</name>
|
||||
<DESCRIPTION>Логирование — это мой критически важный механизм для декларации `belief state` (внутреннего состояния/намерения) и трассировки выполнения кода. Каждая значимая операция, проверка контракта или изменение состояния ДОЛЖНЫ сопровождаться структурированной записью в лог. Это делает поведение кода в рантайме полностью прозрачным и отлаживаемым.</DESCRIPTION>
|
||||
<RULES>
|
||||
<RULE>
|
||||
<name>ArchitecturalBoundaryCompliance</name>
|
||||
<Description>Логирование в его прямой реализации (т.е. вызов `logger.info`, `Timber.i` и т.д.) **КАТЕГОРИЧЕСКИ ЗАПРЕЩЕНО** внутри модуля `:domain`.</Description>
|
||||
<Rationale>`Согласно принципам чистой архитектуры, слой `domain` должен быть полностью независим от внешних фреймворков и платформ (включая Android). Его задача — содержать исключительно бизнес-логику. Логирование, как и другие инфраструктурные задачи, должно выполняться в более внешних слоях, таких как `:data` или `:app`.`</Rationale>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>StructuredLogFormat</name>
|
||||
<Description>Все записи в лог должны строго следовать этому формату для обеспечения машиночитаемости и консистентности.</Description>
|
||||
<Format>`logger.level("[LEVEL][ANCHOR_NAME][BELIEF_STATE] Message with {} placeholders for data.")`</Format>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>ComponentDefinitions</name>
|
||||
<COMPONENTS>
|
||||
<Component>
|
||||
<name>[LEVEL]</name>
|
||||
<description>Один из стандартных уровней логирования: `DEBUG`, `INFO`, `WARN`, `ERROR`. Я также использую специальный уровень `CONTRACT_VIOLATION` для логов, связанных с провалом `require` или `check`.</description>
|
||||
</Component>
|
||||
<Component>
|
||||
<name>[ANCHOR_NAME]</name>
|
||||
<description>Точное имя семантического якоря из кода, к которому относится данный лог. Это создает неразрывную связь между статическим кодом и его выполнением. Например: `[ENTRYPOINT]`, `[ACTION]`, `[PRECONDITION]`, `[FALLBACK]`.</description>
|
||||
</Component>
|
||||
<Component>
|
||||
<name>[BELIEF_STATE]</name>
|
||||
<description>Краткое, четкое описание моего намерения в `snake_case`. Это отвечает на вопрос 'почему' я выполняю этот код. Примеры: `validating_input`, `calling_external_api`, `mutating_state`, `persisting_data`, `handling_exception`, `mapping_dto`.</description>
|
||||
</Component>
|
||||
</COMPONENTS>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>Example</name>
|
||||
<Description>Вот как я применяю этот стандарт на практике внутри функции:</Description>
|
||||
<code>// ...
|
||||
// [ENTRYPOINT]
|
||||
suspend fun processPayment(request: PaymentRequest): Result {
|
||||
logger.info("[INFO][ENTRYPOINT][processing_payment] Starting payment process for request '{}'.", request.id)
|
||||
|
||||
// [PRECONDITION]
|
||||
logger.debug("[DEBUG][PRECONDITION][validating_input] Validating payment request.")
|
||||
require(request.amount > 0) { "Payment amount must be positive." }
|
||||
|
||||
// [ACTION]
|
||||
logger.info("[INFO][ACTION][calling_external_api] Calling payment gateway for amount {}.", request.amount)
|
||||
val result = paymentGateway.execute(request)
|
||||
|
||||
// ...
|
||||
}</code>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>TraceabilityIsMandatory</name>
|
||||
<Description>Каждая запись в логе ДОЛЖНА быть семантически привязана к якорю в коде. Логи без якоря запрещены. Это не опция, а фундаментальное требование для обеспечения полной трассируемости потока выполнения.</Description>
|
||||
</RULE>
|
||||
<RULE>
|
||||
<name>DataAsArguments_NotStrings</name>
|
||||
<Description>Данные (переменные, значения) должны передаваться в логгер как отдельные аргументы, а не встраиваться в строку сообщения. Я использую плейсхолдеры `{}`. Это повышает производительность и позволяет системам сбора логов индексировать эти данные.</Description>
|
||||
</RULE>
|
||||
</RULES>
|
||||
</PRINCIPLE>
|
||||
</PRINCIPLES>
|
||||
</SEMANTIC_ENRICHMENT_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>
|
||||
@@ -6,6 +6,7 @@ plugins {
|
||||
id("org.jetbrains.kotlin.android")
|
||||
id("com.google.dagger.hilt.android")
|
||||
id("kotlin-kapt")
|
||||
// id("org.jlleitschuh.gradle.ktlint") version "12.1.1"
|
||||
}
|
||||
|
||||
android {
|
||||
@@ -30,7 +31,7 @@ android {
|
||||
isMinifyEnabled = false
|
||||
proguardFiles(
|
||||
getDefaultProguardFile("proguard-android-optimize.txt"),
|
||||
"proguard-rules.pro"
|
||||
"proguard-rules.pro",
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -53,6 +54,10 @@ android {
|
||||
excludes += "/META-INF/{AL2.0,LGPL2.1}"
|
||||
}
|
||||
}
|
||||
lint {
|
||||
checkReleaseBuilds = false
|
||||
abortOnError = false
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
@@ -76,9 +81,7 @@ dependencies {
|
||||
implementation(Libs.navigationCompose)
|
||||
implementation(Libs.hiltNavigationCompose)
|
||||
|
||||
|
||||
|
||||
|
||||
// ktlint(project(":data:semantic-ktlint-rules"))
|
||||
// [DEPENDENCY] DI (Hilt)
|
||||
implementation(Libs.hiltAndroid)
|
||||
kapt(Libs.hiltCompiler)
|
||||
@@ -88,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,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens
|
||||
// [FILE] MainActivity.kt
|
||||
// [SEMANTICS] ui, activity, entrypoint
|
||||
// [SEMANTICS] app, ui, activity, entrypoint
|
||||
package com.homebox.lens
|
||||
|
||||
// [IMPORTS]
|
||||
@@ -22,7 +21,7 @@ import timber.log.Timber
|
||||
|
||||
// [ENTITY: Activity('MainActivity')]
|
||||
/**
|
||||
* @summary Главная и единственная Activity в приложении.
|
||||
* @summary The main and only Activity in the application.
|
||||
*/
|
||||
@AndroidEntryPoint
|
||||
class MainActivity : ComponentActivity() {
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens
|
||||
// [FILE] MainApplication.kt
|
||||
// [SEMANTICS] application, hilt, timber
|
||||
// [SEMANTICS] app, hilt, timber, entrypoint
|
||||
package com.homebox.lens
|
||||
|
||||
// [IMPORTS]
|
||||
@@ -11,7 +10,7 @@ import timber.log.Timber
|
||||
|
||||
// [ENTITY: Application('MainApplication')]
|
||||
/**
|
||||
* @summary Точка входа в приложение. Инициализирует Hilt и Timber.
|
||||
* @summary The entry point of the application. Initializes Hilt and Timber.
|
||||
*/
|
||||
@HiltAndroidApp
|
||||
class MainApplication : Application() {
|
||||
|
||||
@@ -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,30 +8,36 @@ 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.navigation.navArgument
|
||||
import com.homebox.lens.ui.screen.dashboard.DashboardScreen
|
||||
import com.homebox.lens.ui.screen.inventorylist.InventoryListScreen
|
||||
import com.homebox.lens.ui.screen.itemdetails.ItemDetailsScreen
|
||||
import com.homebox.lens.ui.screen.itemedit.ItemEditScreen
|
||||
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.setup.SetupScreen
|
||||
import com.homebox.lens.ui.screen.settings.SettingsScreen
|
||||
import com.homebox.lens.ui.screen.splash.SplashScreen
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('NavGraph')]
|
||||
// [RELATION: Function('NavGraph')] -> [DEPENDS_ON] -> [Framework('NavHostController')]
|
||||
// [RELATION: Function('NavGraph')] -> [CREATES_INSTANCE_OF] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('NavGraph')] -> [USES] -> [Screen('SplashScreen')]
|
||||
/**
|
||||
* @summary Определяет граф навигации для всего приложения с использованием Jetpack Compose Navigation.
|
||||
* @param navController Контроллер навигации.
|
||||
* @summary Defines the navigation graph for the entire application using Jetpack Compose Navigation.
|
||||
* @param navController The navigation controller.
|
||||
* @see Screen
|
||||
* @sideeffect Регистрирует все экраны и управляет состоянием навигации.
|
||||
* @invariant Стартовый экран - `Screen.Setup`.
|
||||
* @sideeffect Registers all screens and manages the navigation state.
|
||||
* @invariant The start screen is `Screen.Splash`.
|
||||
*/
|
||||
@Composable
|
||||
fun NavGraph(
|
||||
@@ -44,11 +49,13 @@ fun NavGraph(
|
||||
val navigationActions = remember(navController) {
|
||||
NavigationActions(navController)
|
||||
}
|
||||
|
||||
NavHost(
|
||||
navController = navController,
|
||||
startDestination = Screen.Setup.route
|
||||
startDestination = Screen.Splash.route
|
||||
) {
|
||||
composable(route = Screen.Splash.route) {
|
||||
SplashScreen(navController = navController)
|
||||
}
|
||||
composable(route = Screen.Setup.route) {
|
||||
SetupScreen(onSetupComplete = {
|
||||
navController.navigate(Screen.Dashboard.route) {
|
||||
@@ -74,14 +81,23 @@ fun NavGraph(
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
composable(route = Screen.ItemEdit.route) {
|
||||
composable(
|
||||
route = Screen.ItemEdit.route,
|
||||
arguments = listOf(navArgument("itemId") { nullable = true })
|
||||
) { backStackEntry ->
|
||||
val itemId = backStackEntry.arguments?.getString("itemId")
|
||||
ItemEditScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
navigationActions = navigationActions,
|
||||
itemId = itemId,
|
||||
onSaveSuccess = { navController.popBackStack() }
|
||||
)
|
||||
}
|
||||
composable(Screen.LabelsList.route) {
|
||||
LabelsListScreen(navController = navController)
|
||||
LabelsListScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
composable(route = Screen.LocationsList.route) {
|
||||
LocationsListScreen(
|
||||
@@ -102,12 +118,35 @@ fun NavGraph(
|
||||
locationId = locationId
|
||||
)
|
||||
}
|
||||
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(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
composable(route = Screen.Settings.route) {
|
||||
SettingsScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('NavGraph')]
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.navigation
|
||||
// [FILE] NavigationActions.kt
|
||||
// [SEMANTICS] navigation, controller, actions
|
||||
// [SEMANTICS] app, ui, navigation, actions
|
||||
package com.homebox.lens.navigation
|
||||
|
||||
// [IMPORTS]
|
||||
@@ -11,16 +10,16 @@ import timber.log.Timber
|
||||
// [ENTITY: Class('NavigationActions')]
|
||||
// [RELATION: Class('NavigationActions')] -> [DEPENDS_ON] -> [Framework('NavHostController')]
|
||||
/**
|
||||
* @summary Класс-обертка над NavHostController для предоставления типизированных навигационных действий.
|
||||
* @param navController Контроллер Jetpack Navigation.
|
||||
* @invariant Все навигационные действия должны использовать предоставленный navController.
|
||||
* @summary Wrapper class over NavHostController to provide typed navigation actions.
|
||||
* @param navController The Jetpack Navigation controller.
|
||||
* @invariant All navigation actions must use the provided navController.
|
||||
*/
|
||||
class NavigationActions(private val navController: NavHostController) {
|
||||
|
||||
// [ENTITY: Function('navigateToDashboard')]
|
||||
/**
|
||||
* @summary Навигация на главный экран.
|
||||
* @sideeffect Очищает back stack до главного экрана, чтобы избежать циклов.
|
||||
* @summary Navigation to the main screen.
|
||||
* @sideeffect Clears the back stack up to the main screen to avoid cycles.
|
||||
*/
|
||||
fun navigateToDashboard() {
|
||||
Timber.i("[INFO][ACTION][navigate_to_dashboard] Navigating to Dashboard.")
|
||||
@@ -49,6 +48,13 @@ class NavigationActions(private val navController: NavHostController) {
|
||||
}
|
||||
// [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')]
|
||||
fun navigateToSearch() {
|
||||
Timber.i("[INFO][ACTION][navigate_to_search] Navigating to Search.")
|
||||
@@ -77,7 +83,7 @@ class NavigationActions(private val navController: NavHostController) {
|
||||
// [ENTITY: Function('navigateToCreateItem')]
|
||||
fun navigateToCreateItem() {
|
||||
Timber.i("[INFO][ACTION][navigate_to_create_item] Navigating to Create Item.")
|
||||
navController.navigate(Screen.ItemEdit.createRoute("new"))
|
||||
navController.navigate(Screen.ItemEdit.createRoute())
|
||||
}
|
||||
// [END_ENTITY: Function('navigateToCreateItem')]
|
||||
|
||||
|
||||
@@ -1,15 +1,18 @@
|
||||
// [PACKAGE] com.homebox.lens.navigation
|
||||
// [FILE] Screen.kt
|
||||
// [SEMANTICS] navigation, routes, sealed_class
|
||||
// [SEMANTICS] app, ui, navigation, routes
|
||||
package com.homebox.lens.navigation
|
||||
|
||||
// [ENTITY: SealedClass('Screen')]
|
||||
/**
|
||||
* @summary Запечатанный класс для определения маршрутов навигации в приложении.
|
||||
* @description Обеспечивает типобезопасность при навигации.
|
||||
* @param route Строковый идентификатор маршрута.
|
||||
* @summary Sealed class for defining navigation routes in the application.
|
||||
* @description Provides type safety during navigation.
|
||||
* @param route The string identifier of the route.
|
||||
*/
|
||||
sealed class Screen(val route: String) {
|
||||
// [ENTITY: Object('Splash')]
|
||||
data object Splash : Screen("splash_screen")
|
||||
// [END_ENTITY: Object('Splash')]
|
||||
|
||||
// [ENTITY: Object('Setup')]
|
||||
data object Setup : Screen("setup_screen")
|
||||
// [END_ENTITY: Object('Setup')]
|
||||
@@ -22,11 +25,11 @@ sealed class Screen(val route: String) {
|
||||
data object InventoryList : Screen("inventory_list_screen") {
|
||||
// [ENTITY: Function('withFilter')]
|
||||
/**
|
||||
* @summary Создает маршрут для экрана списка инвентаря с параметром фильтра.
|
||||
* @param key Ключ фильтра (например, "label" или "location").
|
||||
* @param value Значение фильтра (например, ID метки или местоположения).
|
||||
* @return Строку полного маршрута с query-параметром.
|
||||
* @throws IllegalArgumentException если ключ или значение пустые.
|
||||
* @summary Creates a route for the inventory list screen with a filter parameter.
|
||||
* @param key The filter key (e.g., "label" or "location").
|
||||
* @param value The filter value (e.g., the ID of the label or location).
|
||||
* @return A string of the full route with a query parameter.
|
||||
* @throws IllegalArgumentException if the key or value is blank.
|
||||
*/
|
||||
fun withFilter(key: String, value: String): String {
|
||||
require(key.isNotBlank()) { "Filter key cannot be blank." }
|
||||
@@ -43,10 +46,10 @@ sealed class Screen(val route: String) {
|
||||
data object ItemDetails : Screen("item_details_screen/{itemId}") {
|
||||
// [ENTITY: Function('createRoute')]
|
||||
/**
|
||||
* @summary Создает маршрут для экрана деталей элемента с указанным ID.
|
||||
* @param itemId ID элемента для отображения.
|
||||
* @return Строку полного маршрута.
|
||||
* @throws IllegalArgumentException если itemId пустой.
|
||||
* @summary Creates a route for the item details screen with the specified ID.
|
||||
* @param itemId The ID of the item to display.
|
||||
* @return A string of the full route.
|
||||
* @throws IllegalArgumentException if itemId is blank.
|
||||
*/
|
||||
fun createRoute(itemId: String): String {
|
||||
require(itemId.isNotBlank()) { "itemId не может быть пустым." }
|
||||
@@ -59,19 +62,15 @@ sealed class Screen(val route: String) {
|
||||
// [END_ENTITY: Object('ItemDetails')]
|
||||
|
||||
// [ENTITY: Object('ItemEdit')]
|
||||
data object ItemEdit : Screen("item_edit_screen/{itemId}") {
|
||||
data object ItemEdit : Screen("item_edit_screen?itemId={itemId}") {
|
||||
// [ENTITY: Function('createRoute')]
|
||||
/**
|
||||
* @summary Создает маршрут для экрана редактирования элемента с указанным 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 {
|
||||
require(itemId.isNotBlank()) { "itemId не может быть пустым." }
|
||||
val route = "item_edit_screen/$itemId"
|
||||
check(route.endsWith(itemId)) { "Маршрут должен заканчиваться на itemId." }
|
||||
return route
|
||||
fun createRoute(itemId: String? = null): String {
|
||||
return itemId?.let { "item_edit_screen?itemId=$it" } ?: "item_edit_screen"
|
||||
}
|
||||
// [END_ENTITY: Function('createRoute')]
|
||||
}
|
||||
@@ -81,6 +80,21 @@ sealed class Screen(val route: String) {
|
||||
data object LabelsList : Screen("labels_list_screen")
|
||||
// [END_ENTITY: Object('LabelsList')]
|
||||
|
||||
// [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: Object('LocationsList')]
|
||||
@@ -89,10 +103,10 @@ sealed class Screen(val route: String) {
|
||||
data object LocationEdit : Screen("location_edit_screen/{locationId}") {
|
||||
// [ENTITY: Function('createRoute')]
|
||||
/**
|
||||
* @summary Создает маршрут для экрана редактирования местоположения с указанным ID.
|
||||
* @param locationId ID местоположения для редактирования.
|
||||
* @return Строку полного маршрута.
|
||||
* @throws IllegalArgumentException если locationId пустой.
|
||||
* @summary Creates a route for the location edit screen with the specified ID.
|
||||
* @param locationId The ID of the location to edit.
|
||||
* @return A string of the full route.
|
||||
* @throws IllegalArgumentException if locationId is blank.
|
||||
*/
|
||||
fun createRoute(locationId: String): String {
|
||||
require(locationId.isNotBlank()) { "locationId не может быть пустым." }
|
||||
@@ -107,6 +121,10 @@ sealed class Screen(val route: String) {
|
||||
// [ENTITY: Object('Search')]
|
||||
data object Search : Screen("search_screen")
|
||||
// [END_ENTITY: Object('Search')]
|
||||
|
||||
// [ENTITY: Object('Settings')]
|
||||
data object Settings : Screen("settings_screen")
|
||||
// [END_ENTITY: Object('Settings')]
|
||||
}
|
||||
// [END_ENTITY: SealedClass('Screen')]
|
||||
// [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]
|
||||
@@ -30,10 +29,10 @@ import com.homebox.lens.navigation.Screen
|
||||
// [ENTITY: Function('AppDrawerContent')]
|
||||
// [RELATION: Function('AppDrawerContent')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
/**
|
||||
* @summary Контент для бокового навигационного меню (Drawer).
|
||||
* @param currentRoute Текущий маршрут для подсветки активного элемента.
|
||||
* @param navigationActions Объект с навигационными действиями.
|
||||
* @param onCloseDrawer Лямбда для закрытия бокового меню.
|
||||
* @summary Content for the side navigation menu (Drawer).
|
||||
* @param currentRoute The current route to highlight the active item.
|
||||
* @param navigationActions The object with navigation actions.
|
||||
* @param onCloseDrawer Lambda to close the side menu.
|
||||
*/
|
||||
@Composable
|
||||
internal fun AppDrawerContent(
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -21,14 +20,14 @@ import kotlinx.coroutines.launch
|
||||
// [RELATION: Function('MainScaffold')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('MainScaffold')] -> [CALLS] -> [Function('AppDrawerContent')]
|
||||
/**
|
||||
* @summary Общая обертка для экранов, включающая Scaffold и Navigation Drawer.
|
||||
* @param topBarTitle Заголовок для TopAppBar.
|
||||
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
|
||||
* @param navigationActions Объект с навигационными действиями.
|
||||
* @param topBarActions Composable-функция для отображения действий (иконок) в TopAppBar.
|
||||
* @param content Основное содержимое экрана, которое будет отображено внутри Scaffold.
|
||||
* @sideeffect Управляет состоянием (открыто/закрыто) бокового меню (ModalNavigationDrawer).
|
||||
* @invariant TopAppBar всегда отображается с иконкой меню.
|
||||
* @summary A common wrapper for screens that includes a Scaffold and Navigation Drawer.
|
||||
* @param topBarTitle The title for the TopAppBar.
|
||||
* @param currentRoute The current route to highlight the active item in the Drawer.
|
||||
* @param navigationActions The object with navigation actions.
|
||||
* @param topBarActions A Composable function to display actions (icons) in the TopAppBar.
|
||||
* @param content The main content of the screen to be displayed inside the Scaffold.
|
||||
* @sideeffect Manages the state (open/closed) of the side menu (ModalNavigationDrawer).
|
||||
* @invariant The TopAppBar is always displayed with a menu icon.
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
|
||||
@@ -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]
|
||||
@@ -37,11 +36,11 @@ import timber.log.Timber
|
||||
// [RELATION: Function('DashboardScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('DashboardScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* @summary Главная Composable-функция для экрана "Панель управления".
|
||||
* @param viewModel ViewModel для этого экрана, предоставляется через Hilt.
|
||||
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
|
||||
* @param navigationActions Объект с навигационными действиями.
|
||||
* @sideeffect Вызывает навигационные лямбды при взаимодействии с UI.
|
||||
* @summary The main Composable function for the "Dashboard" screen.
|
||||
* @param viewModel The ViewModel for this screen, provided by Hilt.
|
||||
* @param currentRoute The current route to highlight the active item in the Drawer.
|
||||
* @param navigationActions The object with navigation actions.
|
||||
* @sideeffect Calls navigation lambdas upon UI interaction.
|
||||
*/
|
||||
@Composable
|
||||
fun DashboardScreen(
|
||||
@@ -82,11 +81,11 @@ fun DashboardScreen(
|
||||
// [ENTITY: Function('DashboardContent')]
|
||||
// [RELATION: Function('DashboardContent')] -> [CONSUMES_STATE] -> [SealedInterface('DashboardUiState')]
|
||||
/**
|
||||
* @summary Отображает основной контент экрана в зависимости от uiState.
|
||||
* @param modifier Модификатор для стилизации.
|
||||
* @param uiState Текущее состояние UI экрана.
|
||||
* @param onLocationClick Лямбда-обработчик нажатия на местоположение.
|
||||
* @param onLabelClick Лямбда-обработчик нажатия на метку.
|
||||
* @summary Displays the main content of the screen depending on the uiState.
|
||||
* @param modifier A modifier for styling.
|
||||
* @param uiState The current UI state of the screen.
|
||||
* @param onLocationClick A lambda handler for clicking on a location.
|
||||
* @param onLabelClick A lambda handler for clicking on a label.
|
||||
*/
|
||||
@Composable
|
||||
private fun DashboardContent(
|
||||
@@ -132,8 +131,8 @@ private fun DashboardContent(
|
||||
// [ENTITY: Function('StatisticsSection')]
|
||||
// [RELATION: Function('StatisticsSection')] -> [DEPENDS_ON] -> [DataClass('GroupStatistics')]
|
||||
/**
|
||||
* @summary Секция для отображения общей статистики.
|
||||
* @param statistics Объект со статистическими данными.
|
||||
* @summary Section for displaying general statistics.
|
||||
* @param statistics The object with statistical data.
|
||||
*/
|
||||
@Composable
|
||||
private fun StatisticsSection(statistics: GroupStatistics) {
|
||||
@@ -164,9 +163,9 @@ private fun StatisticsSection(statistics: GroupStatistics) {
|
||||
|
||||
// [ENTITY: Function('StatisticCard')]
|
||||
/**
|
||||
* @summary Карточка для отображения одного статистического показателя.
|
||||
* @param title Название показателя.
|
||||
* @param value Значение показателя.
|
||||
* @summary Card for displaying a single statistical indicator.
|
||||
* @param title The name of the indicator.
|
||||
* @param value The value of the indicator.
|
||||
*/
|
||||
@Composable
|
||||
private fun StatisticCard(title: String, value: String) {
|
||||
@@ -180,8 +179,8 @@ private fun StatisticCard(title: String, value: String) {
|
||||
// [ENTITY: Function('RecentlyAddedSection')]
|
||||
// [RELATION: Function('RecentlyAddedSection')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
|
||||
/**
|
||||
* @summary Секция для отображения недавно добавленных элементов.
|
||||
* @param items Список элементов для отображения.
|
||||
* @summary Section for displaying recently added items.
|
||||
* @param items The list of items to display.
|
||||
*/
|
||||
@Composable
|
||||
private fun RecentlyAddedSection(items: List<ItemSummary>) {
|
||||
@@ -213,8 +212,8 @@ private fun RecentlyAddedSection(items: List<ItemSummary>) {
|
||||
// [ENTITY: Function('ItemCard')]
|
||||
// [RELATION: Function('ItemCard')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
|
||||
/**
|
||||
* @summary Карточка для отображения краткой информации об элементе.
|
||||
* @param item Элемент для отображения.
|
||||
* @summary Card for displaying brief information about an item.
|
||||
* @param item The item to display.
|
||||
*/
|
||||
@Composable
|
||||
private fun ItemCard(item: ItemSummary) {
|
||||
@@ -236,9 +235,9 @@ private fun ItemCard(item: ItemSummary) {
|
||||
// [ENTITY: Function('LocationsSection')]
|
||||
// [RELATION: Function('LocationsSection')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
|
||||
/**
|
||||
* @summary Секция для отображения местоположений в виде чипсов.
|
||||
* @param locations Список местоположений.
|
||||
* @param onLocationClick Лямбда-обработчик нажатия на местоположение.
|
||||
* @summary Section for displaying locations as chips.
|
||||
* @param locations The list of locations.
|
||||
* @param onLocationClick A lambda handler for clicking on a location.
|
||||
*/
|
||||
@OptIn(ExperimentalLayoutApi::class)
|
||||
@Composable
|
||||
@@ -265,9 +264,9 @@ private fun LocationsSection(locations: List<LocationOutCount>, onLocationClick:
|
||||
// [ENTITY: Function('LabelsSection')]
|
||||
// [RELATION: Function('LabelsSection')] -> [DEPENDS_ON] -> [DataClass('LabelOut')]
|
||||
/**
|
||||
* @summary Секция для отображения меток в виде чипсов.
|
||||
* @param labels Список меток.
|
||||
* @param onLabelClick Лямбда-обработчик нажатия на метку.
|
||||
* @summary Section for displaying labels as chips.
|
||||
* @param labels The list of labels.
|
||||
* @param onLabelClick A lambda handler for clicking on a label.
|
||||
*/
|
||||
@OptIn(ExperimentalLayoutApi::class)
|
||||
@Composable
|
||||
@@ -310,10 +309,10 @@ fun DashboardContentSuccessPreview() {
|
||||
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 = "")
|
||||
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 = "")
|
||||
),
|
||||
recentlyAddedItems = emptyList()
|
||||
)
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.dashboard
|
||||
// [FILE] DashboardUiState.kt
|
||||
// [SEMANTICS] ui, state, dashboard
|
||||
// [SEMANTICS] app, ui, state, dashboard
|
||||
package com.homebox.lens.ui.screen.dashboard
|
||||
|
||||
// [IMPORTS]
|
||||
@@ -12,8 +11,8 @@ import com.homebox.lens.domain.model.LocationOutCount
|
||||
|
||||
// [ENTITY: SealedInterface('DashboardUiState')]
|
||||
/**
|
||||
* @summary Определяет все возможные состояния для экрана "Дэшборд".
|
||||
* @invariant В любой момент времени экран может находиться только в одном из этих состояний.
|
||||
* @summary Defines all possible states for the "Dashboard" screen.
|
||||
* @invariant At any given time, the screen can only be in one of these states.
|
||||
*/
|
||||
sealed interface DashboardUiState {
|
||||
// [ENTITY: DataClass('Success')]
|
||||
@@ -22,11 +21,11 @@ sealed interface DashboardUiState {
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('LabelOut')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
|
||||
/**
|
||||
* @summary Состояние успешной загрузки данных.
|
||||
* @param statistics Статистика по инвентарю.
|
||||
* @param locations Список локаций со счетчиками.
|
||||
* @param labels Список всех меток.
|
||||
* @param recentlyAddedItems Список недавно добавленных товаров.
|
||||
* @summary The state of a successful data load.
|
||||
* @param statistics The inventory statistics.
|
||||
* @param locations The list of locations with counters.
|
||||
* @param labels The list of all labels.
|
||||
* @param recentlyAddedItems The list of recently added items.
|
||||
*/
|
||||
data class Success(
|
||||
val statistics: GroupStatistics,
|
||||
@@ -38,15 +37,15 @@ sealed interface DashboardUiState {
|
||||
|
||||
// [ENTITY: DataClass('Error')]
|
||||
/**
|
||||
* @summary Состояние ошибки во время загрузки данных.
|
||||
* @param message Человекочитаемое сообщение об ошибке.
|
||||
* @summary The state of an error during data loading.
|
||||
* @param message A human-readable error message.
|
||||
*/
|
||||
data class Error(val message: String) : DashboardUiState
|
||||
// [END_ENTITY: DataClass('Error')]
|
||||
|
||||
// [ENTITY: Object('Loading')]
|
||||
/**
|
||||
* @summary Состояние, когда данные для экрана загружаются.
|
||||
* @summary The state when data for the screen is being loaded.
|
||||
*/
|
||||
data object Loading : DashboardUiState
|
||||
// [END_ENTITY: Object('Loading')]
|
||||
|
||||
@@ -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]
|
||||
@@ -24,10 +23,10 @@ import javax.inject.Inject
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetRecentlyAddedItemsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [EMITS_STATE] -> [SealedInterface('DashboardUiState')]
|
||||
/**
|
||||
* @summary ViewModel для главного экрана (Dashboard).
|
||||
* @description Оркестрирует загрузку данных для Dashboard, используя строгую модель состояний
|
||||
* (`DashboardUiState`), и обрабатывает параллельные запросы без состояний гонки.
|
||||
* @invariant `uiState` всегда является одним из состояний, определенных в `DashboardUiState`.
|
||||
* @summary ViewModel for the main screen (Dashboard).
|
||||
* @description Orchestrates the loading of data for the Dashboard, using a strict state model
|
||||
* (`DashboardUiState`), and handles parallel requests without race conditions.
|
||||
* @invariant `uiState` is always one of the states defined in `DashboardUiState`.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class DashboardViewModel @Inject constructor(
|
||||
@@ -46,10 +45,10 @@ class DashboardViewModel @Inject constructor(
|
||||
|
||||
// [ENTITY: Function('loadDashboardData')]
|
||||
/**
|
||||
* @summary Загружает все необходимые данные для экрана Dashboard.
|
||||
* @description Выполняет UseCase'ы параллельно и обновляет UI, переключая его
|
||||
* между состояниями `Loading`, `Success` и `Error` из `DashboardUiState`.
|
||||
* @sideeffect Асинхронно обновляет `_uiState` одним из состояний `DashboardUiState`.
|
||||
* @summary Loads all necessary data for the Dashboard screen.
|
||||
* @description Executes UseCases in parallel and updates the UI by switching it
|
||||
* between the `Loading`, `Success`, and `Error` states from `DashboardUiState`.
|
||||
* @sideeffect Asynchronously updates `_uiState` with one of the `DashboardUiState` states.
|
||||
*/
|
||||
fun loadDashboardData() {
|
||||
viewModelScope.launch {
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.inventorylist
|
||||
// [FILE] InventoryListScreen.kt
|
||||
// [SEMANTICS] ui, screen, inventory, list
|
||||
// [SEMANTICS] app, ui, screen, list
|
||||
|
||||
package com.homebox.lens.ui.screen.inventorylist
|
||||
|
||||
@@ -17,9 +16,9 @@ import com.homebox.lens.ui.common.MainScaffold
|
||||
// [RELATION: Function('InventoryListScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('InventoryListScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* @summary Composable-функция для экрана "Список инвентаря".
|
||||
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
|
||||
* @param navigationActions Объект с навигационными действиями.
|
||||
* @summary Composable function for the "Inventory List" screen.
|
||||
* @param currentRoute The current route to highlight the active item in the Drawer.
|
||||
* @param navigationActions The object with navigation actions.
|
||||
*/
|
||||
@Composable
|
||||
fun InventoryListScreen(
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.inventorylist
|
||||
// [FILE] InventoryListViewModel.kt
|
||||
// [SEMANTICS] ui, viewmodel, inventory_list
|
||||
// [SEMANTICS] app, ui, viewmodel, list
|
||||
package com.homebox.lens.ui.screen.inventorylist
|
||||
|
||||
// [IMPORTS]
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.itemdetails
|
||||
// [FILE] ItemDetailsScreen.kt
|
||||
// [SEMANTICS] ui, screen, item, details
|
||||
// [SEMANTICS] app, ui, screen, details
|
||||
|
||||
package com.homebox.lens.ui.screen.itemdetails
|
||||
|
||||
@@ -17,9 +16,9 @@ import com.homebox.lens.ui.common.MainScaffold
|
||||
// [RELATION: Function('ItemDetailsScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('ItemDetailsScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* @summary Composable-функция для экрана "Детали элемента".
|
||||
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
|
||||
* @param navigationActions Объект с навигационными действиями.
|
||||
* @summary Composable function for the "Item Details" screen.
|
||||
* @param currentRoute The current route to highlight the active item in the Drawer.
|
||||
* @param navigationActions The object with navigation actions.
|
||||
*/
|
||||
@Composable
|
||||
fun ItemDetailsScreen(
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.itemdetails
|
||||
// [FILE] ItemDetailsViewModel.kt
|
||||
// [SEMANTICS] ui, viewmodel, item_details
|
||||
// [SEMANTICS] app, ui, viewmodel, details
|
||||
package com.homebox.lens.ui.screen.itemdetails
|
||||
|
||||
// [IMPORTS]
|
||||
|
||||
@@ -1,39 +1,606 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.itemedit
|
||||
// [FILE] ItemEditScreen.kt
|
||||
// [SEMANTICS] ui, screen, item, edit
|
||||
// [SEMANTICS] app, ui, screen, edit
|
||||
|
||||
package com.homebox.lens.ui.screen.itemedit
|
||||
|
||||
// [IMPORTS]
|
||||
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.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]
|
||||
|
||||
// [ENTITY: Function('ItemEditScreen')]
|
||||
// [RELATION: Function('ItemEditScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('ItemEditScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
// [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')]
|
||||
/**
|
||||
* @summary Composable-функция для экрана "Редактирование элемента".
|
||||
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
|
||||
* @param navigationActions Объект с навигационными действиями.
|
||||
* @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
|
||||
navigationActions: NavigationActions,
|
||||
itemId: String?,
|
||||
viewModel: ItemEditViewModel = hiltViewModel(),
|
||||
onSaveSuccess: () -> Unit
|
||||
) {
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
val snackbarHostState = remember { SnackbarHostState() }
|
||||
|
||||
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
|
||||
) {
|
||||
// [AI_NOTE]: Implement Item Edit Screen UI
|
||||
Text(text = "Item Edit Screen")
|
||||
) { paddingValues ->
|
||||
Scaffold(
|
||||
snackbarHost = { SnackbarHost(snackbarHostState) },
|
||||
floatingActionButton = {
|
||||
FloatingActionButton(onClick = {
|
||||
Timber.i("[INFO][ACTION][save_button_click] Save button clicked.")
|
||||
viewModel.saveItem()
|
||||
}) {
|
||||
Icon(Icons.Filled.Save, contentDescription = stringResource(R.string.save_item))
|
||||
}
|
||||
}
|
||||
) {
|
||||
Column(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.padding(paddingValues)
|
||||
.padding(16.dp)
|
||||
.verticalScroll(rememberScrollState())
|
||||
) {
|
||||
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 = item.location?.name ?: "",
|
||||
onValueChange = { },
|
||||
label = { Text(stringResource(R.string.item_edit_location)) },
|
||||
readOnly = true,
|
||||
trailingIcon = {
|
||||
ExposedDropdownMenuDefaults.TrailingIcon(expanded = locationExpanded)
|
||||
},
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.menuAnchor()
|
||||
)
|
||||
ExposedDropdownMenu(
|
||||
expanded = locationExpanded,
|
||||
onDismissRequest = { locationExpanded = false }
|
||||
) {
|
||||
uiState.allLocations.forEach { location ->
|
||||
DropdownMenuItem(
|
||||
text = { Text(location.name) },
|
||||
onClick = {
|
||||
viewModel.updateLocation(location)
|
||||
locationExpanded = false
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
|
||||
// Labels Dialog
|
||||
var showLabelsDialog by remember { mutableStateOf(false) }
|
||||
|
||||
OutlinedTextField(
|
||||
value = item.labels.joinToString { it.name },
|
||||
onValueChange = { },
|
||||
label = { Text(stringResource(R.string.item_edit_labels)) },
|
||||
readOnly = true,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.clickable { showLabelsDialog = true },
|
||||
trailingIcon = {
|
||||
Icon(Icons.Filled.ArrowDropDown, contentDescription = stringResource(R.string.item_edit_select_labels))
|
||||
}
|
||||
)
|
||||
|
||||
if (showLabelsDialog) {
|
||||
// This state will hold the temporary selections within the dialog
|
||||
val tempSelectedLabels = remember { mutableStateOf(item.labels.toSet()) }
|
||||
|
||||
AlertDialog(
|
||||
onDismissRequest = { showLabelsDialog = false },
|
||||
title = { Text(stringResource(R.string.item_edit_select_labels)) },
|
||||
text = {
|
||||
Column {
|
||||
uiState.allLabels.forEach { label ->
|
||||
val isChecked = tempSelectedLabels.value.contains(label)
|
||||
Row(
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.clickable {
|
||||
val currentSelection = tempSelectedLabels.value.toMutableSet()
|
||||
if (isChecked) {
|
||||
currentSelection.remove(label)
|
||||
} else {
|
||||
currentSelection.add(label)
|
||||
}
|
||||
tempSelectedLabels.value = currentSelection
|
||||
}
|
||||
.padding(vertical = 8.dp)
|
||||
) {
|
||||
Checkbox(
|
||||
checked = isChecked,
|
||||
onCheckedChange = {
|
||||
val currentSelection = tempSelectedLabels.value.toMutableSet()
|
||||
if (it) {
|
||||
currentSelection.add(label)
|
||||
} else {
|
||||
currentSelection.remove(label)
|
||||
}
|
||||
tempSelectedLabels.value = currentSelection
|
||||
}
|
||||
)
|
||||
Text(
|
||||
text = label.name,
|
||||
modifier = Modifier.padding(start = 8.dp)
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
confirmButton = {
|
||||
TextButton(
|
||||
onClick = {
|
||||
// Update the ViewModel with the final selection
|
||||
viewModel.updateLabels(tempSelectedLabels.value.toList())
|
||||
showLabelsDialog = false
|
||||
}
|
||||
) {
|
||||
Text(stringResource(R.string.dialog_ok))
|
||||
}
|
||||
},
|
||||
dismissButton = {
|
||||
TextButton(onClick = { showLabelsDialog = false }) {
|
||||
Text(stringResource(R.string.dialog_cancel))
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
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('ItemEditScreen')]
|
||||
// [END_FILE_ItemEditScreen.kt]
|
||||
// [END_ENTITY: Composable('ItemEditScreen')]
|
||||
// [END_FILE_ItemEditScreen.kt]
|
||||
|
||||
@@ -1,21 +1,514 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.itemedit
|
||||
// [FILE] ItemEditViewModel.kt
|
||||
// [SEMANTICS] ui, viewmodel, item_edit
|
||||
// [SEMANTICS] app, ui, viewmodel, edit
|
||||
|
||||
package com.homebox.lens.ui.screen.itemedit
|
||||
|
||||
// [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 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]
|
||||
|
||||
// [ENTITY: DataClass('ItemEditUiState')]
|
||||
/**
|
||||
* @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() {
|
||||
// [AI_NOTE]: Implement UI state
|
||||
}
|
||||
// [END_ENTITY: ViewModel('ItemEditViewModel')]
|
||||
// [END_FILE_ItemEditViewModel.kt]
|
||||
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() {
|
||||
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." }
|
||||
|
||||
_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')]
|
||||
|
||||
// [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')]
|
||||
|
||||
// [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: 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]
|
||||
|
||||
@@ -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,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.labelslist
|
||||
// [FILE] LabelsListScreen.kt
|
||||
// [SEMANTICS] ui, labels_list, state_management, compose, dialog
|
||||
// [SEMANTICS] app, ui, screen, list, label
|
||||
package com.homebox.lens.ui.screen.labelslist
|
||||
|
||||
// [IMPORTS]
|
||||
@@ -17,33 +16,28 @@ import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.automirrored.filled.ArrowBack
|
||||
import androidx.compose.material.icons.automirrored.filled.Label
|
||||
import androidx.compose.material.icons.filled.Add
|
||||
import androidx.compose.material3.AlertDialog
|
||||
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.ListItem
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Scaffold
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.material3.TextButton
|
||||
import androidx.compose.material3.TopAppBar
|
||||
import androidx.compose.runtime.Composable
|
||||
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.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.navigation.NavController
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.domain.model.Label
|
||||
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]
|
||||
|
||||
@@ -51,82 +45,62 @@ import timber.log.Timber
|
||||
// [RELATION: Function('LabelsListScreen')] -> [DEPENDS_ON] -> [ViewModel('LabelsListViewModel')]
|
||||
// [RELATION: Function('LabelsListScreen')] -> [DEPENDS_ON] -> [Framework('NavController')]
|
||||
/**
|
||||
* @summary Отображает экран со списком всех меток.
|
||||
* @param navController Контроллер навигации для перемещения между экранами.
|
||||
* @param viewModel ViewModel, предоставляющая состояние UI для экрана меток.
|
||||
* @summary Displays the screen with a list of all labels.
|
||||
* @param currentRoute The current navigation route.
|
||||
* @param navigationActions The object containing navigation actions.
|
||||
* @param viewModel The ViewModel providing the UI state for the labels screen.
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
fun LabelsListScreen(
|
||||
navController: NavController,
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions,
|
||||
viewModel: LabelsListViewModel = hiltViewModel()
|
||||
) {
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
Scaffold(
|
||||
topBar = {
|
||||
TopAppBar(
|
||||
title = { Text(text = stringResource(id = R.string.screen_title_labels)) },
|
||||
navigationIcon = {
|
||||
IconButton(onClick = {
|
||||
Timber.i("[INFO][ACTION][navigate_up] Navigate up initiated.")
|
||||
navController.navigateUp()
|
||||
}) {
|
||||
Icon(
|
||||
imageVector = Icons.AutoMirrored.Filled.ArrowBack,
|
||||
contentDescription = stringResource(id = R.string.content_desc_navigate_back)
|
||||
)
|
||||
}
|
||||
}
|
||||
)
|
||||
},
|
||||
floatingActionButton = {
|
||||
FloatingActionButton(onClick = {
|
||||
Timber.i("[INFO][ACTION][show_create_dialog] FAB clicked: Initiate create new label flow.")
|
||||
viewModel.onShowCreateDialog()
|
||||
}) {
|
||||
Icon(
|
||||
imageVector = Icons.Default.Add,
|
||||
contentDescription = stringResource(id = R.string.content_desc_create_label)
|
||||
)
|
||||
}
|
||||
}
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.screen_title_labels),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) { paddingValues ->
|
||||
val currentState = uiState
|
||||
if (currentState is LabelsListUiState.Success && currentState.isShowingCreateDialog) {
|
||||
CreateLabelDialog(
|
||||
onConfirm = { labelName ->
|
||||
viewModel.createLabel(labelName)
|
||||
},
|
||||
onDismiss = {
|
||||
viewModel.onDismissCreateDialog()
|
||||
Scaffold(
|
||||
floatingActionButton = {
|
||||
FloatingActionButton(onClick = {
|
||||
Timber.i("[INFO][ACTION][navigate_to_label_edit] FAB clicked: Navigate to create new label screen.")
|
||||
navigationActions.navigateToLabelEdit(null)
|
||||
}) {
|
||||
Icon(
|
||||
imageVector = Icons.Default.Add,
|
||||
contentDescription = stringResource(id = R.string.content_desc_create_label)
|
||||
)
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
) { innerPaddingValues ->
|
||||
val currentState = uiState
|
||||
|
||||
Box(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.padding(paddingValues),
|
||||
.padding(innerPaddingValues), // Use innerPaddingValues here
|
||||
contentAlignment = Alignment.Center
|
||||
) {
|
||||
when (currentState) {
|
||||
when (val state = uiState) {
|
||||
is LabelsListUiState.Loading -> {
|
||||
CircularProgressIndicator()
|
||||
}
|
||||
is LabelsListUiState.Error -> {
|
||||
Text(text = currentState.message)
|
||||
Text(text = state.message)
|
||||
}
|
||||
is LabelsListUiState.Success -> {
|
||||
if (currentState.labels.isEmpty()) {
|
||||
Text(text = stringResource(id = R.string.labels_list_empty))
|
||||
if (state.labels.isEmpty()) {
|
||||
Text(text = stringResource(id = R.string.no_labels_found))
|
||||
} else {
|
||||
LabelsList(
|
||||
labels = currentState.labels,
|
||||
labels = state.labels,
|
||||
onLabelClick = { label ->
|
||||
Timber.i("[INFO][ACTION][navigate_to_inventory] Label clicked: ${label.id}. Navigating to inventory list.")
|
||||
val route = Screen.InventoryList.withFilter("label", label.id)
|
||||
navController.navigate(route)
|
||||
Timber.i("[INFO][ACTION][navigate_to_label_edit] Label clicked: ${label.id}. Navigating to label edit screen.")
|
||||
navigationActions.navigateToLabelEdit(label.id)
|
||||
}
|
||||
)
|
||||
}
|
||||
@@ -135,15 +109,16 @@ fun LabelsListScreen(
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LabelsListScreen')]
|
||||
|
||||
// [ENTITY: Function('LabelsList')]
|
||||
// [RELATION: Function('LabelsList')] -> [DEPENDS_ON] -> [DataClass('Label')]
|
||||
/**
|
||||
* @summary Composable-функция для отображения списка меток.
|
||||
* @param labels Список объектов `Label` для отображения.
|
||||
* @param onLabelClick Лямбда-функция, вызываемая при нажатии на элемент списка.
|
||||
* @param modifier Модификатор для настройки внешнего вида.
|
||||
* @summary Composable function for displaying a list of labels.
|
||||
* @param labels The list of `Label` objects to display.
|
||||
* @param onLabelClick A lambda function called when a list item is clicked.
|
||||
* @param modifier A modifier for customizing the appearance.
|
||||
*/
|
||||
@Composable
|
||||
private fun LabelsList(
|
||||
@@ -169,9 +144,9 @@ private fun LabelsList(
|
||||
// [ENTITY: Function('LabelListItem')]
|
||||
// [RELATION: Function('LabelListItem')] -> [DEPENDS_ON] -> [DataClass('Label')]
|
||||
/**
|
||||
* @summary Composable-функция для отображения одного элемента в списке меток.
|
||||
* @param label Объект `Label`, который нужно отобразить.
|
||||
* @param onClick Лямбда-функция, вызываемая при нажатии на элемент.
|
||||
* @summary Composable function for displaying a single item in the list of labels.
|
||||
* @param label The `Label` object to display.
|
||||
* @param onClick A lambda function called when the item is clicked.
|
||||
*/
|
||||
@Composable
|
||||
private fun LabelListItem(
|
||||
@@ -191,46 +166,4 @@ private fun LabelListItem(
|
||||
}
|
||||
// [END_ENTITY: Function('LabelListItem')]
|
||||
|
||||
// [ENTITY: Function('CreateLabelDialog')]
|
||||
/**
|
||||
* @summary Диалоговое окно для создания новой метки.
|
||||
* @param onConfirm Лямбда-функция, вызываемая при подтверждении создания с именем метки.
|
||||
* @param onDismiss Лямбда-функция, вызываемая при закрытии диалога.
|
||||
*/
|
||||
@Composable
|
||||
private fun CreateLabelDialog(
|
||||
onConfirm: (String) -> Unit,
|
||||
onDismiss: () -> Unit
|
||||
) {
|
||||
var text by remember { mutableStateOf("") }
|
||||
val isConfirmEnabled = text.isNotBlank()
|
||||
|
||||
AlertDialog(
|
||||
onDismissRequest = onDismiss,
|
||||
title = { Text(text = stringResource(R.string.dialog_title_create_label)) },
|
||||
text = {
|
||||
OutlinedTextField(
|
||||
value = text,
|
||||
onValueChange = { text = it },
|
||||
label = { Text(stringResource(R.string.dialog_field_label_name)) },
|
||||
singleLine = true,
|
||||
modifier = Modifier.fillMaxWidth()
|
||||
)
|
||||
},
|
||||
confirmButton = {
|
||||
TextButton(
|
||||
onClick = { onConfirm(text) },
|
||||
enabled = isConfirmEnabled
|
||||
) {
|
||||
Text(stringResource(R.string.dialog_button_create))
|
||||
}
|
||||
},
|
||||
dismissButton = {
|
||||
TextButton(onClick = onDismiss) {
|
||||
Text(stringResource(R.string.dialog_button_cancel))
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('CreateLabelDialog')]
|
||||
// [END_FILE_LabelsListScreen.kt]
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.labelslist
|
||||
// [FILE] LabelsListUiState.kt
|
||||
// [SEMANTICS] ui_state, sealed_interface, contract
|
||||
// [SEMANTICS] app, ui, state, list, label
|
||||
package com.homebox.lens.ui.screen.labelslist
|
||||
|
||||
// [IMPORTS]
|
||||
@@ -9,17 +8,17 @@ import com.homebox.lens.domain.model.Label
|
||||
|
||||
// [ENTITY: SealedInterface('LabelsListUiState')]
|
||||
/**
|
||||
* @summary Определяет все возможные состояния для UI экрана со списком меток.
|
||||
* @description Использование sealed-интерфейса позволяет исчерпывающе обрабатывать все состояния в Composable-функциях.
|
||||
* @summary Defines all possible states for the UI of the screen with a list of labels.
|
||||
* @description Using a sealed interface allows for exhaustive handling of all states in Composable functions.
|
||||
*/
|
||||
sealed interface LabelsListUiState {
|
||||
// [ENTITY: DataClass('Success')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('Label')]
|
||||
/**
|
||||
* @summary Состояние успеха, содержит список меток и состояние диалога.
|
||||
* @param labels Список меток для отображения.
|
||||
* @param isShowingCreateDialog Флаг, показывающий, должен ли быть отображен диалог создания метки.
|
||||
* @invariant labels не может быть null.
|
||||
* @summary The success state, contains the list of labels and the state of the dialog.
|
||||
* @param labels The list of labels to display.
|
||||
* @param isShowingCreateDialog A flag indicating whether the label creation dialog should be displayed.
|
||||
* @invariant labels cannot be null.
|
||||
*/
|
||||
data class Success(
|
||||
val labels: List<Label>,
|
||||
@@ -29,17 +28,17 @@ sealed interface LabelsListUiState {
|
||||
|
||||
// [ENTITY: DataClass('Error')]
|
||||
/**
|
||||
* @summary Состояние ошибки.
|
||||
* @param message Текст ошибки для отображения пользователю.
|
||||
* @invariant message не может быть пустой.
|
||||
* @summary The error state.
|
||||
* @param message The error text to display to the user.
|
||||
* @invariant message cannot be empty.
|
||||
*/
|
||||
data class Error(val message: String) : LabelsListUiState
|
||||
// [END_ENTITY: DataClass('Error')]
|
||||
|
||||
// [ENTITY: Object('Loading')]
|
||||
/**
|
||||
* @summary Состояние загрузки данных.
|
||||
* @description Указывает, что идет процесс загрузки меток.
|
||||
* @summary The data loading state.
|
||||
* @description Indicates that the process of loading labels is in progress.
|
||||
*/
|
||||
data object Loading : LabelsListUiState
|
||||
// [END_ENTITY: Object('Loading')]
|
||||
|
||||
@@ -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]
|
||||
@@ -21,9 +20,9 @@ import javax.inject.Inject
|
||||
// [RELATION: ViewModel('LabelsListViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLabelsUseCase')]
|
||||
// [RELATION: ViewModel('LabelsListViewModel')] -> [EMITS_STATE] -> [SealedInterface('LabelsListUiState')]
|
||||
/**
|
||||
* @summary ViewModel для экрана со списком меток.
|
||||
* @description Управляет состоянием экрана, загружает список меток, обрабатывает ошибки и управляет диалогом создания новой метки.
|
||||
* @invariant `uiState` всегда является одним из состояний, определенных в `LabelsListUiState`.
|
||||
* @summary ViewModel for the screen with a list of labels.
|
||||
* @description Manages the screen state, loads the list of labels, handles errors, and manages the dialog for creating a new label.
|
||||
* @invariant `uiState` is always one of the states defined in `LabelsListUiState`.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class LabelsListViewModel @Inject constructor(
|
||||
@@ -39,10 +38,10 @@ class LabelsListViewModel @Inject constructor(
|
||||
|
||||
// [ENTITY: Function('loadLabels')]
|
||||
/**
|
||||
* @summary Загружает список меток.
|
||||
* @description Выполняет `GetAllLabelsUseCase` и обновляет UI, переключая его
|
||||
* между состояниями `Loading`, `Success` и `Error`.
|
||||
* @sideeffect Асинхронно обновляет `_uiState`.
|
||||
* @summary Loads the list of labels.
|
||||
* @description Executes `GetAllLabelsUseCase` and updates the UI by switching it
|
||||
* between the `Loading`, `Success`, and `Error` states.
|
||||
* @sideeffect Asynchronously updates `_uiState`.
|
||||
*/
|
||||
fun loadLabels() {
|
||||
viewModelScope.launch {
|
||||
@@ -77,9 +76,9 @@ class LabelsListViewModel @Inject constructor(
|
||||
|
||||
// [ENTITY: Function('onShowCreateDialog')]
|
||||
/**
|
||||
* @summary Инициирует отображение диалога для создания метки.
|
||||
* @description Обновляет состояние `uiState`, устанавливая `isShowingCreateDialog` в `true`.
|
||||
* @sideeffect Обновляет `_uiState`.
|
||||
* @summary Initiates the display of the dialog for creating a label.
|
||||
* @description Updates the `uiState` by setting `isShowingCreateDialog` to `true`.
|
||||
* @sideeffect Updates `_uiState`.
|
||||
*/
|
||||
fun onShowCreateDialog() {
|
||||
Timber.i("[INFO][ACTION][show_create_dialog] Show create label dialog requested.")
|
||||
@@ -93,9 +92,9 @@ class LabelsListViewModel @Inject constructor(
|
||||
|
||||
// [ENTITY: Function('onDismissCreateDialog')]
|
||||
/**
|
||||
* @summary Скрывает диалог создания метки.
|
||||
* @description Обновляет состояние `uiState`, устанавливая `isShowingCreateDialog` в `false`.
|
||||
* @sideeffect Обновляет `_uiState`.
|
||||
* @summary Hides the label creation dialog.
|
||||
* @description Updates the `uiState` by setting `isShowingCreateDialog` to `false`.
|
||||
* @sideeffect Updates `_uiState`.
|
||||
*/
|
||||
fun onDismissCreateDialog() {
|
||||
Timber.i("[INFO][ACTION][dismiss_create_dialog] Dismiss create label dialog requested.")
|
||||
@@ -109,12 +108,12 @@ class LabelsListViewModel @Inject constructor(
|
||||
|
||||
// [ENTITY: Function('createLabel')]
|
||||
/**
|
||||
* @summary Создает новую метку. [MVP_SCOPE] ЗАГЛУШКА.
|
||||
* @description В текущей реализации (План Б, Этап 1), эта функция только логирует действие
|
||||
* и скрывает диалог. Реальная логика сохранения будет добавлена на следующем этапе.
|
||||
* @param name Название новой метки.
|
||||
* @precondition `name` не должен быть пустым.
|
||||
* @sideeffect Логирует действие, обновляет `_uiState`, чтобы скрыть диалог.
|
||||
* @summary Creates a new label. [MVP_SCOPE] STUB.
|
||||
* @description In the current implementation (Plan B, Stage 1), this function only logs the action
|
||||
* and hides the dialog. The actual save logic will be added in the next stage.
|
||||
* @param name The name of the new label.
|
||||
* @precondition `name` must not be blank.
|
||||
* @sideeffect Logs the action, updates `_uiState` to hide the dialog.
|
||||
*/
|
||||
fun createLabel(name: String) {
|
||||
require(name.isNotBlank()) { "[CONTRACT_VIOLATION] Label name cannot be blank." }
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -19,8 +18,8 @@ import com.homebox.lens.R
|
||||
|
||||
// [ENTITY: Function('LocationEditScreen')]
|
||||
/**
|
||||
* @summary Composable-функция для экрана "Редактирование местоположения".
|
||||
* @param locationId ID местоположения для редактирования или "new" для создания.
|
||||
* @summary Composable function for the "Edit Location" screen.
|
||||
* @param locationId The ID of the location to edit, or "new" to create one.
|
||||
*/
|
||||
@Composable
|
||||
fun LocationEditScreen(
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -56,12 +55,12 @@ import com.homebox.lens.ui.theme.HomeboxLensTheme
|
||||
// [RELATION: Function('LocationsListScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('LocationsListScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* @summary Composable-функция для экрана "Список местоположений".
|
||||
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
|
||||
* @param navigationActions Объект с навигационными действиями.
|
||||
* @param onLocationClick Лямбда-обработчик нажатия на местоположение.
|
||||
* @param onAddNewLocationClick Лямбда-обработчик нажатия на кнопку добавления нового местоположения.
|
||||
* @param viewModel ViewModel для этого экрана.
|
||||
* @summary Composable function for the "List of Locations" screen.
|
||||
* @param currentRoute The current route to highlight the active item in the Drawer.
|
||||
* @param navigationActions The object with navigation actions.
|
||||
* @param onLocationClick A lambda handler for clicking on a location.
|
||||
* @param onAddNewLocationClick A lambda handler for clicking the button to add a new location.
|
||||
* @param viewModel The ViewModel for this screen.
|
||||
*/
|
||||
@Composable
|
||||
fun LocationsListScreen(
|
||||
@@ -104,12 +103,12 @@ fun LocationsListScreen(
|
||||
// [ENTITY: Function('LocationsListContent')]
|
||||
// [RELATION: Function('LocationsListContent')] -> [CONSUMES_STATE] -> [SealedInterface('LocationsListUiState')]
|
||||
/**
|
||||
* @summary Отображает основной контент экрана в зависимости от `uiState`.
|
||||
* @param modifier Модификатор для стилизации.
|
||||
* @param uiState Текущее состояние UI.
|
||||
* @param onLocationClick Лямбда-обработчик нажатия на местоположение.
|
||||
* @param onEditLocation Лямбда-обработчик для редактирования местоположения.
|
||||
* @param onDeleteLocation Лямбда-обработчик для удаления местоположения.
|
||||
* @summary Displays the main content of the screen depending on the `uiState`.
|
||||
* @param modifier A modifier for styling.
|
||||
* @param uiState The current UI state.
|
||||
* @param onLocationClick A lambda handler for clicking on a location.
|
||||
* @param onEditLocation A lambda handler for editing a location.
|
||||
* @param onDeleteLocation A lambda handler for deleting a location.
|
||||
*/
|
||||
@Composable
|
||||
private fun LocationsListContent(
|
||||
@@ -167,11 +166,11 @@ private fun LocationsListContent(
|
||||
// [ENTITY: Function('LocationCard')]
|
||||
// [RELATION: Function('LocationCard')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
|
||||
/**
|
||||
* @summary Карточка для отображения одного местоположения.
|
||||
* @param location Данные о местоположении.
|
||||
* @param onClick Лямбда-обработчик нажатия на карточку.
|
||||
* @param onEditClick Лямбда-обработчик нажатия на "Редактировать".
|
||||
* @param onDeleteClick Лямбда-обработчик нажатия на "Удалить".
|
||||
* @summary Card for displaying a single location.
|
||||
* @param location The data about the location.
|
||||
* @param onClick A lambda handler for clicking on the card.
|
||||
* @param onEditClick A lambda handler for clicking "Edit".
|
||||
* @param onDeleteClick A lambda handler for clicking "Delete".
|
||||
*/
|
||||
@Composable
|
||||
private fun LocationCard(
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -10,30 +9,30 @@ import com.homebox.lens.domain.model.LocationOutCount
|
||||
|
||||
// [ENTITY: SealedInterface('LocationsListUiState')]
|
||||
/**
|
||||
* @summary Определяет возможные состояния UI для экрана списка местоположений.
|
||||
* @summary Defines the possible UI states for the list of locations screen.
|
||||
* @see LocationsListViewModel
|
||||
*/
|
||||
sealed interface LocationsListUiState {
|
||||
// [ENTITY: DataClass('Success')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
|
||||
/**
|
||||
* @summary Состояние успешной загрузки данных.
|
||||
* @param locations Список местоположений для отображения.
|
||||
* @summary The state of a successful data load.
|
||||
* @param locations The list of locations to display.
|
||||
*/
|
||||
data class Success(val locations: List<LocationOutCount>) : LocationsListUiState
|
||||
// [END_ENTITY: DataClass('Success')]
|
||||
|
||||
// [ENTITY: DataClass('Error')]
|
||||
/**
|
||||
* @summary Состояние ошибки.
|
||||
* @param message Сообщение об ошибке.
|
||||
* @summary The error state.
|
||||
* @param message The error message.
|
||||
*/
|
||||
data class Error(val message: String) : LocationsListUiState
|
||||
// [END_ENTITY: DataClass('Error')]
|
||||
|
||||
// [ENTITY: Object('Loading')]
|
||||
/**
|
||||
* @summary Состояние загрузки данных.
|
||||
* @summary The data loading state.
|
||||
*/
|
||||
object Loading : LocationsListUiState
|
||||
// [END_ENTITY: Object('Loading')]
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -21,10 +20,10 @@ import javax.inject.Inject
|
||||
// [RELATION: ViewModel('LocationsListViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLocationsUseCase')]
|
||||
// [RELATION: ViewModel('LocationsListViewModel')] -> [EMITS_STATE] -> [SealedInterface('LocationsListUiState')]
|
||||
/**
|
||||
* @summary ViewModel для экрана списка местоположений.
|
||||
* @param getAllLocationsUseCase Use case для получения всех местоположений.
|
||||
* @property uiState Поток, содержащий текущее состояние UI.
|
||||
* @invariant `uiState` всегда отражает результат последней операции загрузки.
|
||||
* @summary ViewModel for the list of locations screen.
|
||||
* @param getAllLocationsUseCase Use case for getting all locations.
|
||||
* @property uiState A flow containing the current UI state.
|
||||
* @invariant `uiState` always reflects the result of the last load operation.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class LocationsListViewModel @Inject constructor(
|
||||
@@ -40,8 +39,8 @@ class LocationsListViewModel @Inject constructor(
|
||||
|
||||
// [ENTITY: Function('loadLocations')]
|
||||
/**
|
||||
* @summary Загружает список местоположений из репозитория.
|
||||
* @sideeffect Обновляет `_uiState` в зависимости от результата: Loading -> Success/Error.
|
||||
* @summary Loads the list of locations from the repository.
|
||||
* @sideeffect Updates `_uiState` depending on the result: Loading -> Success/Error.
|
||||
*/
|
||||
fun loadLocations() {
|
||||
Timber.d("[DEBUG][ENTRYPOINT][loading_locations] Starting to load locations.")
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.search
|
||||
// [FILE] SearchScreen.kt
|
||||
// [SEMANTICS] ui, screen, search
|
||||
// [SEMANTICS] app, ui, screen, search
|
||||
|
||||
package com.homebox.lens.ui.screen.search
|
||||
|
||||
@@ -17,9 +16,9 @@ import com.homebox.lens.ui.common.MainScaffold
|
||||
// [RELATION: Function('SearchScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('SearchScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* @summary Composable-функция для экрана "Поиск".
|
||||
* @param currentRoute Текущий маршрут для подсветки активного элемента в Drawer.
|
||||
* @param navigationActions Объект с навигационными действиями.
|
||||
* @summary Composable function for the "Search" screen.
|
||||
* @param currentRoute The current route to highlight the active item in the Drawer.
|
||||
* @param navigationActions The object with navigation actions.
|
||||
*/
|
||||
@Composable
|
||||
fun SearchScreen(
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.search
|
||||
// [FILE] SearchViewModel.kt
|
||||
// [SEMANTICS] ui, viewmodel, search
|
||||
// [SEMANTICS] app, ui, viewmodel, search
|
||||
package com.homebox.lens.ui.screen.search
|
||||
|
||||
// [IMPORTS]
|
||||
|
||||
@@ -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,23 +1,27 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.setup
|
||||
// [FILE] SetupScreen.kt
|
||||
// [SEMANTICS] ui, screen, setup, 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.material.icons.Icons
|
||||
import androidx.compose.material.icons.filled.Lock
|
||||
import androidx.compose.material3.*
|
||||
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.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
|
||||
// [END_IMPORTS]
|
||||
@@ -26,10 +30,10 @@ import com.homebox.lens.R
|
||||
// [RELATION: Function('SetupScreen')] -> [DEPENDS_ON] -> [ViewModel('SetupViewModel')]
|
||||
// [RELATION: Function('SetupScreen')] -> [CALLS] -> [Function('SetupScreenContent')]
|
||||
/**
|
||||
* @summary Главная Composable-функция для экрана настройки соединения с сервером.
|
||||
* @param viewModel ViewModel для этого экрана, предоставляется через Hilt.
|
||||
* @param onSetupComplete Лямбда, вызываемая после успешной настройки и входа.
|
||||
* @sideeffect Вызывает `onSetupComplete` при изменении `uiState.isSetupComplete`.
|
||||
* @summary The main Composable function for the server connection setup screen.
|
||||
* @param viewModel The ViewModel for this screen, provided by Hilt.
|
||||
* @param onSetupComplete A lambda invoked after successful setup and login.
|
||||
* @sideeffect Calls `onSetupComplete` when `uiState.isSetupComplete` changes.
|
||||
*/
|
||||
@Composable
|
||||
fun SetupScreen(
|
||||
@@ -55,12 +59,12 @@ fun SetupScreen(
|
||||
// [ENTITY: Function('SetupScreenContent')]
|
||||
// [RELATION: Function('SetupScreenContent')] -> [CONSUMES_STATE] -> [DataClass('SetupUiState')]
|
||||
/**
|
||||
* @summary Отображает контент экрана настройки: поля ввода и кнопку.
|
||||
* @param uiState Текущее состояние UI.
|
||||
* @param onServerUrlChange Лямбда-обработчик изменения URL сервера.
|
||||
* @param onUsernameChange Лямбда-обработчик изменения имени пользователя.
|
||||
* @param onPasswordChange Лямбда-обработчик изменения пароля.
|
||||
* @param onConnectClick Лямбда-обработчик нажатия на кнопку "Подключиться".
|
||||
* @summary Displays the content of the setup screen: input fields and a button.
|
||||
* @param uiState The current UI state.
|
||||
* @param onServerUrlChange A lambda handler for changing the server URL.
|
||||
* @param onUsernameChange A lambda handler for changing the username.
|
||||
* @param onPasswordChange A lambda handler for changing the password.
|
||||
* @param onConnectClick A lambda handler for clicking the "Connect" button.
|
||||
*/
|
||||
@Composable
|
||||
private fun SetupScreenContent(
|
||||
@@ -70,11 +74,7 @@ private fun SetupScreenContent(
|
||||
onPasswordChange: (String) -> Unit,
|
||||
onConnectClick: () -> Unit
|
||||
) {
|
||||
Scaffold(
|
||||
topBar = {
|
||||
TopAppBar(title = { Text(stringResource(id = R.string.setup_title)) })
|
||||
}
|
||||
) { paddingValues ->
|
||||
Scaffold { paddingValues ->
|
||||
Column(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
@@ -83,42 +83,76 @@ private fun SetupScreenContent(
|
||||
verticalArrangement = Arrangement.Center,
|
||||
horizontalAlignment = Alignment.CenterHorizontally
|
||||
) {
|
||||
OutlinedTextField(
|
||||
value = uiState.serverUrl,
|
||||
onValueChange = onServerUrlChange,
|
||||
label = { Text(stringResource(id = R.string.setup_server_url_label)) },
|
||||
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()
|
||||
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 = onServerUrlChange,
|
||||
label = { Text(stringResource(id = R.string.setup_server_url_label)) },
|
||||
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()
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.height(50.dp)
|
||||
) {
|
||||
if (uiState.isLoading) {
|
||||
CircularProgressIndicator(modifier = Modifier.size(24.dp))
|
||||
CircularProgressIndicator(
|
||||
modifier = Modifier.size(24.dp),
|
||||
color = MaterialTheme.colorScheme.onPrimary
|
||||
)
|
||||
} else {
|
||||
Text(stringResource(id = R.string.setup_connect_button))
|
||||
}
|
||||
}
|
||||
uiState.error?.let {
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
Text(text = it, color = MaterialTheme.colorScheme.error)
|
||||
Text(
|
||||
text = it,
|
||||
color = MaterialTheme.colorScheme.error
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.screen.setup
|
||||
// [FILE] SetupUiState.kt
|
||||
// [SEMANTICS] ui_state, data_model, immutable
|
||||
|
||||
|
||||
@@ -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
|
||||
@@ -74,40 +73,61 @@ class SetupViewModel @Inject constructor(
|
||||
// [END_ENTITY: Function('onUsernameChange')]
|
||||
|
||||
// [ENTITY: Function('onPasswordChange')]
|
||||
/**
|
||||
* @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')]
|
||||
fun connect() {
|
||||
Timber.d("[DEBUG][ENTRYPOINT][connecting] Starting connection process.")
|
||||
viewModelScope.launch {
|
||||
_uiState.update { it.copy(isLoading = true, error = null) }
|
||||
// [ENTITY: Function('areCredentialsSaved')]
|
||||
/**
|
||||
* @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')]
|
||||
|
||||
val credentials = Credentials(
|
||||
serverUrl = _uiState.value.serverUrl.trim(),
|
||||
username = _uiState.value.username.trim(),
|
||||
password = _uiState.value.password
|
||||
)
|
||||
// [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 {
|
||||
_uiState.update { it.copy(isLoading = true, error = null) }
|
||||
|
||||
Timber.d("[DEBUG][ACTION][saving_credentials] Saving credentials.")
|
||||
credentialsRepository.saveCredentials(credentials)
|
||||
val credentials = Credentials(
|
||||
serverUrl = _uiState.value.serverUrl.trim(),
|
||||
username = _uiState.value.username.trim(),
|
||||
password = _uiState.value.password
|
||||
)
|
||||
|
||||
Timber.d("[DEBUG][ACTION][executing_login] Executing login use case.")
|
||||
loginUseCase(credentials).fold(
|
||||
onSuccess = {
|
||||
Timber.d("[DEBUG][SUCCESS][login_successful] Login successful.")
|
||||
_uiState.update { it.copy(isLoading = false, isSetupComplete = true) }
|
||||
},
|
||||
onFailure = { exception ->
|
||||
Timber.e(exception, "[ERROR][EXCEPTION][login_failed] Login failed.")
|
||||
_uiState.update { it.copy(isLoading = false, error = exception.message ?: "Login failed") }
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('connect')]
|
||||
Timber.d("[DEBUG][ACTION][saving_credentials] Saving credentials.")
|
||||
credentialsRepository.saveCredentials(credentials)
|
||||
|
||||
Timber.d("[DEBUG][ACTION][executing_login] Executing login use case.")
|
||||
loginUseCase(credentials).fold(
|
||||
onSuccess = {
|
||||
Timber.d("[DEBUG][SUCCESS][login_successful] Login successful.")
|
||||
_uiState.update { it.copy(isLoading = false, isSetupComplete = true) }
|
||||
},
|
||||
onFailure = { exception ->
|
||||
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_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,6 +1,5 @@
|
||||
// [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]
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.ui.theme
|
||||
// [FILE] Theme.kt
|
||||
// [SEMANTICS] ui, theme
|
||||
// [SEMANTICS] app, ui, theme
|
||||
package com.homebox.lens.ui.theme
|
||||
|
||||
// [IMPORTS]
|
||||
|
||||
@@ -1,6 +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]
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
|
||||
<!-- Common -->
|
||||
<string name="create">Create</string>
|
||||
<string name="edit">Edit</string>
|
||||
<string name="delete">Delete</string>
|
||||
<string name="search">Search</string>
|
||||
<string name="logout">Logout</string>
|
||||
<string name="no_location">No location</string>
|
||||
@@ -14,7 +16,7 @@
|
||||
<string name="cd_scan_qr_code">Scan QR code</string>
|
||||
<string name="cd_navigate_back">Navigate back</string>
|
||||
<string name="cd_add_new_location">Add new location</string>
|
||||
<string name="cd_add_new_label">Add new label</string>
|
||||
<string name="content_desc_add_label">Add new label</string>
|
||||
|
||||
<!-- Dashboard Screen -->
|
||||
<string name="dashboard_title">Dashboard</string>
|
||||
@@ -34,6 +36,30 @@
|
||||
<string name="nav_locations">Locations</string>
|
||||
<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>
|
||||
|
||||
<!-- 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="setup_title">Server Setup</string>
|
||||
<string name="setup_server_url_label">Server URL</string>
|
||||
@@ -41,4 +67,55 @@
|
||||
<string name="setup_password_label">Password</string>
|
||||
<string name="setup_connect_button">Connect</string>
|
||||
|
||||
<!-- 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_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,10 +13,32 @@
|
||||
|
||||
<!-- 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>
|
||||
<string name="cd_add_new_label">Добавить новую метку</string>
|
||||
<string name="content_desc_add_label">Добавить новую метку</string>
|
||||
|
||||
<!-- Inventory List Screen -->
|
||||
<string name="content_desc_sync_inventory">Синхронизировать инвентарь</string>
|
||||
|
||||
<!-- Item Details Screen -->
|
||||
<string name="content_desc_edit_item">Редактировать элемент</string>
|
||||
<string name="content_desc_delete_item">Удалить элемент</string>
|
||||
<string name="section_title_description">Описание</string>
|
||||
<string name="placeholder_no_description">Нет описания</string>
|
||||
<string name="section_title_details">Детали</string>
|
||||
<string name="label_quantity">Количество</string>
|
||||
<string name="label_location">Местоположение</string>
|
||||
<string name="section_title_labels">Метки</string>
|
||||
|
||||
<!-- Item Edit Screen -->
|
||||
<string name="item_edit_title_create">Создать элемент</string>
|
||||
<string name="content_desc_save_item">Сохранить элемент</string>
|
||||
<string name="label_name">Название</string>
|
||||
|
||||
<!-- Search Screen -->
|
||||
<string name="placeholder_search_items">Поиск элементов...</string>
|
||||
|
||||
<!-- Dashboard Screen -->
|
||||
<string name="dashboard_title">Главная</string>
|
||||
@@ -44,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>
|
||||
@@ -54,6 +111,7 @@
|
||||
<string name="cd_more_options">Больше опций</string>
|
||||
|
||||
<!-- Setup Screen -->
|
||||
<string name="screen_title_setup">Настройка</string>
|
||||
<string name="setup_title">Настройка сервера</string>
|
||||
<string name="setup_server_url_label">URL сервера</string>
|
||||
<string name="setup_username_label">Имя пользователя</string>
|
||||
@@ -62,15 +120,29 @@
|
||||
|
||||
<!-- Labels List Screen -->
|
||||
<string name="screen_title_labels">Метки</string>
|
||||
<string name="content_desc_navigate_back">Вернуться назад</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>
|
||||
<string name="labels_list_empty">Метки еще не созданы.</string>
|
||||
<string name="no_labels_found">Метки не найдены.</string>
|
||||
<string name="dialog_title_create_label">Создать метку</string>
|
||||
<string name="dialog_field_label_name">Название метки</string>
|
||||
<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 -->
|
||||
|
||||
</resources>
|
||||
<!-- 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
|
||||
|
||||
@@ -45,6 +45,10 @@ 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')]
|
||||
|
||||
@@ -98,6 +102,9 @@ 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')]
|
||||
|
||||
|
||||
1
data/semantic-ktlint-rules/.gitignore
vendored
Normal file
1
data/semantic-ktlint-rules/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
/build
|
||||
18
data/semantic-ktlint-rules/build.gradle.kts
Normal file
18
data/semantic-ktlint-rules/build.gradle.kts
Normal file
@@ -0,0 +1,18 @@
|
||||
// Файл: /data/semantic-ktlint-rules/build.gradle.kts
|
||||
|
||||
plugins {
|
||||
kotlin("jvm")
|
||||
}
|
||||
|
||||
|
||||
dependencies {
|
||||
// Зависимость для RuleSetProviderV3
|
||||
implementation("com.pinterest.ktlint:ktlint-cli-ruleset-core:1.2.1")
|
||||
// Зависимость для Rule, RuleId и psi-утилит
|
||||
api("com.pinterest.ktlint:ktlint-rule-engine:1.2.1")
|
||||
|
||||
// Зависимости для тестирования остаются без изменений
|
||||
testImplementation(kotlin("test"))
|
||||
testImplementation("com.pinterest.ktlint:ktlint-test:1.2.1")
|
||||
testImplementation("org.assertj:assertj-core:3.24.2")
|
||||
}
|
||||
21
data/semantic-ktlint-rules/proguard-rules.pro
vendored
Normal file
21
data/semantic-ktlint-rules/proguard-rules.pro
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
# Add project specific ProGuard rules here.
|
||||
# You can control the set of applied configuration files using the
|
||||
# proguardFiles setting in build.gradle.
|
||||
#
|
||||
# For more details, see
|
||||
# http://developer.android.com/guide/developing/tools/proguard.html
|
||||
|
||||
# If your project uses WebView with JS, uncomment the following
|
||||
# and specify the fully qualified class name to the JavaScript interface
|
||||
# class:
|
||||
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
|
||||
# public *;
|
||||
#}
|
||||
|
||||
# Uncomment this to preserve the line number information for
|
||||
# debugging stack traces.
|
||||
#-keepattributes SourceFile,LineNumberTable
|
||||
|
||||
# If you keep the line number information, uncomment this to
|
||||
# hide the original source file name.
|
||||
#-renamesourcefileattribute SourceFile
|
||||
@@ -0,0 +1,27 @@
|
||||
// [FILE] ExampleInstrumentedTest.kt
|
||||
// [SEMANTICS] testing, android, ktlint, rules
|
||||
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import androidx.test.platform.app.InstrumentationRegistry
|
||||
import androidx.test.ext.junit.runners.AndroidJUnit4
|
||||
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
|
||||
import org.junit.Assert.*
|
||||
|
||||
/**
|
||||
* Instrumented test, which will execute on an Android device.
|
||||
*
|
||||
* See [testing documentation](http://d.android.com/tools/testing).
|
||||
*/
|
||||
@RunWith(AndroidJUnit4::class)
|
||||
class ExampleInstrumentedTest {
|
||||
@Test
|
||||
fun useAppContext() {
|
||||
// Context of the app under test.
|
||||
val appContext = InstrumentationRegistry.getInstrumentation().targetContext
|
||||
assertEquals("com.busya.ktlint.rules", appContext.packageName)
|
||||
}
|
||||
}
|
||||
12
data/semantic-ktlint-rules/src/main/AndroidManifest.xml
Normal file
12
data/semantic-ktlint-rules/src/main/AndroidManifest.xml
Normal file
@@ -0,0 +1,12 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
|
||||
|
||||
<application
|
||||
android:allowBackup="true"
|
||||
android:icon="@mipmap/ic_launcher"
|
||||
android:label="@string/app_name"
|
||||
android:roundIcon="@mipmap/ic_launcher_round"
|
||||
android:supportsRtl="true"
|
||||
android:theme="@style/Theme.HomeboxLens" />
|
||||
|
||||
</manifest>
|
||||
@@ -0,0 +1,17 @@
|
||||
// [FILE] CustomRuleSetProvider.kt
|
||||
// [SEMANTICS] ktlint, rules, provider
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import com.pinterest.ktlint.rule.engine.core.api.RuleProvider
|
||||
import com.pinterest.ktlint.rule.engine.core.api.RuleSetId
|
||||
import com.pinterest.ktlint.cli.ruleset.core.api.RuleSetProviderV3
|
||||
|
||||
class CustomRuleSetProvider : RuleSetProviderV3(RuleSetId("custom")) {
|
||||
override fun getRuleProviders(): Set<RuleProvider> {
|
||||
return setOf(
|
||||
RuleProvider { FileHeaderRule() },
|
||||
RuleProvider { MandatoryEntityDeclarationRule() },
|
||||
RuleProvider { NoStrayCommentsRule() }
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
// [FILE] FileHeaderRule.kt
|
||||
// [SEMANTICS] ktlint, rules, file_header
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import com.pinterest.ktlint.rule.engine.core.api.ElementType
|
||||
import com.pinterest.ktlint.rule.engine.core.api.Rule
|
||||
import com.pinterest.ktlint.rule.engine.core.api.Rule.About
|
||||
import com.pinterest.ktlint.rule.engine.core.api.RuleId
|
||||
import org.jetbrains.kotlin.com.intellij.lang.ASTNode
|
||||
|
||||
class FileHeaderRule : Rule(ruleId = RuleId("custom:file-header-rule"), about = About()) {
|
||||
override fun beforeVisitChildNodes(
|
||||
node: ASTNode,
|
||||
autoCorrect: Boolean,
|
||||
emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit
|
||||
) {
|
||||
if (node.elementType == ElementType.FILE) {
|
||||
val lines = node.text.lines()
|
||||
if (lines.size < 3) {
|
||||
emit(node.startOffset, "File must start with a 3-line semantic header.", false)
|
||||
return
|
||||
}
|
||||
if (!lines[0].startsWith("// [PACKAGE]")) {
|
||||
emit(node.startOffset, "File header missing or incorrect. Line 1 must be '// [PACKAGE] ...'.", false)
|
||||
}
|
||||
if (!lines[1].startsWith("// [FILE]")) {
|
||||
emit(node.startOffset + lines[0].length + 1, "File header missing or incorrect. Line 2 must be '// [FILE] ...'.", false)
|
||||
}
|
||||
if (!lines[2].startsWith("// [SEMANTICS]")) {
|
||||
emit(node.startOffset + lines[0].length + lines[1].length + 2, "File header missing or incorrect. Line 3 must be '// [SEMANTICS] ...'.", false)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
// [FILE] MandatoryEntityDeclarationRule.kt
|
||||
// [SEMANTICS] ktlint, rules, entity_declaration
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import com.pinterest.ktlint.rule.engine.core.api.ElementType
|
||||
import com.pinterest.ktlint.rule.engine.core.api.Rule
|
||||
import com.pinterest.ktlint.rule.engine.core.api.Rule.About
|
||||
import com.pinterest.ktlint.rule.engine.core.api.RuleId
|
||||
import com.pinterest.ktlint.rule.engine.core.api.prevLeaf
|
||||
import org.jetbrains.kotlin.com.intellij.lang.ASTNode
|
||||
import org.jetbrains.kotlin.lexer.KtTokens
|
||||
import org.jetbrains.kotlin.psi.KtDeclaration
|
||||
|
||||
class MandatoryEntityDeclarationRule : Rule(ruleId = RuleId("custom:entity-declaration-rule"), about = About()) {
|
||||
private val entityTypes = setOf(
|
||||
ElementType.CLASS,
|
||||
ElementType.OBJECT_DECLARATION,
|
||||
ElementType.FUN
|
||||
)
|
||||
|
||||
override fun beforeVisitChildNodes(
|
||||
node: ASTNode,
|
||||
autoCorrect: Boolean,
|
||||
emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit
|
||||
) {
|
||||
if (node.elementType in entityTypes) {
|
||||
val ktDeclaration = node.psi as? KtDeclaration ?: return
|
||||
if (node.elementType == ElementType.FUN &&
|
||||
(ktDeclaration.hasModifier(KtTokens.PRIVATE_KEYWORD) ||
|
||||
ktDeclaration.hasModifier(KtTokens.PROTECTED_KEYWORD) ||
|
||||
ktDeclaration.hasModifier(KtTokens.INTERNAL_KEYWORD))
|
||||
) {
|
||||
return
|
||||
}
|
||||
val prevComment = node.prevLeaf { it.elementType == ElementType.EOL_COMMENT }
|
||||
if (prevComment == null || !prevComment.text.startsWith("// [ENTITY:")) {
|
||||
emit(node.startOffset, "Missing or misplaced '// [ENTITY: ...]' declaration before '${node.elementType}'.", false)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
// [FILE] NoStrayCommentsRule.kt
|
||||
// [SEMANTICS] ktlint, rules, comments
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import com.pinterest.ktlint.rule.engine.core.api.ElementType
|
||||
import com.pinterest.ktlint.rule.engine.core.api.Rule
|
||||
import com.pinterest.ktlint.rule.engine.core.api.Rule.About
|
||||
import com.pinterest.ktlint.rule.engine.core.api.RuleId
|
||||
import org.jetbrains.kotlin.com.intellij.lang.ASTNode
|
||||
|
||||
class NoStrayCommentsRule : Rule(ruleId = RuleId("custom:no-stray-comments-rule"), about = About()) {
|
||||
private val allowedCommentPattern = Regex("""^//\s?\[([A-Z_]+|ENTITY:|RELATION:|AI_NOTE:)]""")
|
||||
override fun beforeVisitChildNodes(
|
||||
node: ASTNode,
|
||||
autoCorrect: Boolean,
|
||||
emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit
|
||||
) {
|
||||
if (node.elementType == ElementType.EOL_COMMENT) {
|
||||
val commentText = node.text
|
||||
if (!allowedCommentPattern.matches(commentText)) {
|
||||
emit(node.startOffset, "Stray comment found. Use semantic anchors like '// [TAG]' or '// [AI_NOTE]:' instead.", false)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,170 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<vector xmlns:android="http://schemas.android.com/apk/res/android"
|
||||
android:width="108dp"
|
||||
android:height="108dp"
|
||||
android:viewportWidth="108"
|
||||
android:viewportHeight="108">
|
||||
<path
|
||||
android:fillColor="#3DDC84"
|
||||
android:pathData="M0,0h108v108h-108z" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M9,0L9,108"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M19,0L19,108"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M29,0L29,108"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M39,0L39,108"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M49,0L49,108"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M59,0L59,108"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M69,0L69,108"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M79,0L79,108"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M89,0L89,108"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M99,0L99,108"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M0,9L108,9"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M0,19L108,19"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M0,29L108,29"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M0,39L108,39"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M0,49L108,49"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M0,59L108,59"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M0,69L108,69"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M0,79L108,79"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M0,89L108,89"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M0,99L108,99"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M19,29L89,29"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M19,39L89,39"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M19,49L89,49"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M19,59L89,59"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M19,69L89,69"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M19,79L89,79"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M29,19L29,89"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M39,19L39,89"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M49,19L49,89"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M59,19L59,89"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M69,19L69,89"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
<path
|
||||
android:fillColor="#00000000"
|
||||
android:pathData="M79,19L79,89"
|
||||
android:strokeWidth="0.8"
|
||||
android:strokeColor="#33FFFFFF" />
|
||||
</vector>
|
||||
@@ -0,0 +1,30 @@
|
||||
<vector xmlns:android="http://schemas.android.com/apk/res/android"
|
||||
xmlns:aapt="http://schemas.android.com/aapt"
|
||||
android:width="108dp"
|
||||
android:height="108dp"
|
||||
android:viewportWidth="108"
|
||||
android:viewportHeight="108">
|
||||
<path android:pathData="M31,63.928c0,0 6.4,-11 12.1,-13.1c7.2,-2.6 26,-1.4 26,-1.4l38.1,38.1L107,108.928l-32,-1L31,63.928z">
|
||||
<aapt:attr name="android:fillColor">
|
||||
<gradient
|
||||
android:endX="85.84757"
|
||||
android:endY="92.4963"
|
||||
android:startX="42.9492"
|
||||
android:startY="49.59793"
|
||||
android:type="linear">
|
||||
<item
|
||||
android:color="#44000000"
|
||||
android:offset="0.0" />
|
||||
<item
|
||||
android:color="#00000000"
|
||||
android:offset="1.0" />
|
||||
</gradient>
|
||||
</aapt:attr>
|
||||
</path>
|
||||
<path
|
||||
android:fillColor="#FFFFFF"
|
||||
android:fillType="nonZero"
|
||||
android:pathData="M65.3,45.828l3.8,-6.6c0.2,-0.4 0.1,-0.9 -0.3,-1.1c-0.4,-0.2 -0.9,-0.1 -1.1,0.3l-3.9,6.7c-6.3,-2.8 -13.4,-2.8 -19.7,0l-3.9,-6.7c-0.2,-0.4 -0.7,-0.5 -1.1,-0.3C38.8,38.328 38.7,38.828 38.9,39.228l3.8,6.6C36.2,49.428 31.7,56.028 31,63.928h46C76.3,56.028 71.8,49.428 65.3,45.828zM43.4,57.328c-0.8,0 -1.5,-0.5 -1.8,-1.2c-0.3,-0.7 -0.1,-1.5 0.4,-2.1c0.5,-0.5 1.4,-0.7 2.1,-0.4c0.7,0.3 1.2,1 1.2,1.8C45.3,56.528 44.5,57.328 43.4,57.328L43.4,57.328zM64.6,57.328c-0.8,0 -1.5,-0.5 -1.8,-1.2s-0.1,-1.5 0.4,-2.1c0.5,-0.5 1.4,-0.7 2.1,-0.4c0.7,0.3 1.2,1 1.2,1.8C66.5,56.528 65.6,57.328 64.6,57.328L64.6,57.328z"
|
||||
android:strokeWidth="1"
|
||||
android:strokeColor="#00000000" />
|
||||
</vector>
|
||||
@@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
|
||||
<background android:drawable="@drawable/ic_launcher_background" />
|
||||
<foreground android:drawable="@drawable/ic_launcher_foreground" />
|
||||
<monochrome android:drawable="@drawable/ic_launcher_foreground" />
|
||||
</adaptive-icon>
|
||||
@@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
|
||||
<background android:drawable="@drawable/ic_launcher_background" />
|
||||
<foreground android:drawable="@drawable/ic_launcher_foreground" />
|
||||
<monochrome android:drawable="@drawable/ic_launcher_foreground" />
|
||||
</adaptive-icon>
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 1.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 982 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.7 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.9 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 7.6 KiB |
@@ -0,0 +1,16 @@
|
||||
<resources xmlns:tools="http://schemas.android.com/tools">
|
||||
<!-- Base application theme. -->
|
||||
<style name="Theme.HomeboxLens" parent="Theme.MaterialComponents.DayNight.DarkActionBar">
|
||||
<!-- Primary brand color. -->
|
||||
<item name="colorPrimary">@color/purple_200</item>
|
||||
<item name="colorPrimaryVariant">@color/purple_700</item>
|
||||
<item name="colorOnPrimary">@color/black</item>
|
||||
<!-- Secondary brand color. -->
|
||||
<item name="colorSecondary">@color/teal_200</item>
|
||||
<item name="colorSecondaryVariant">@color/teal_200</item>
|
||||
<item name="colorOnSecondary">@color/black</item>
|
||||
<!-- Status bar color. -->
|
||||
<item name="android:statusBarColor">?attr/colorPrimaryVariant</item>
|
||||
<!-- Customize your theme here. -->
|
||||
</style>
|
||||
</resources>
|
||||
10
data/semantic-ktlint-rules/src/main/res/values/colors.xml
Normal file
10
data/semantic-ktlint-rules/src/main/res/values/colors.xml
Normal file
@@ -0,0 +1,10 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<resources>
|
||||
<color name="purple_200">#FFBB86FC</color>
|
||||
<color name="purple_500">#FF6200EE</color>
|
||||
<color name="purple_700">#FF3700B3</color>
|
||||
<color name="teal_200">#FF03DAC5</color>
|
||||
<color name="teal_700">#FF018786</color>
|
||||
<color name="black">#FF000000</color>
|
||||
<color name="white">#FFFFFFFF</color>
|
||||
</resources>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user