Compare commits
9 Commits
9b914b2904
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 78b827f29e | |||
| 9500d747b1 | |||
| 8cfad121b2 | |||
| e3f52fca52 | |||
| 9286e041da | |||
| 556b7f7c7d | |||
| eccc7ee970 | |||
| 8816377361 | |||
| 5eb23eed5b |
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>
|
||||
@@ -1,111 +0,0 @@
|
||||
# Протокол Семантического Обогащения (Semantic Enrichment Protocol)
|
||||
**Версия: 1.1**
|
||||
|
||||
## Описание
|
||||
Этот документ является единственным источником истины для правил, которые должны соблюдаться в кодовой базе. Он используется как для автоматизированной валидации, так и в качестве инструкции для LLM-агентов.
|
||||
|
||||
---
|
||||
|
||||
## Правила
|
||||
|
||||
### 1. Целостность Заголовка Файла (`FileHeaderIntegrity`)
|
||||
Каждый `.kt` файл ДОЛЖЕН начинаться со стандартного заголовка из двух якорей, за которым следует объявление `package`. Заголовок служит 'паспортом' файла.
|
||||
|
||||
**Пример:**
|
||||
```kotlin
|
||||
// [FILE] YourFileName.kt
|
||||
// [SEMANTICS] ui, viewmodel, state_management
|
||||
|
||||
package com.example.your.package.name
|
||||
```
|
||||
|
||||
### 2. Таксономия Семантических Ключевых Слов (`SemanticKeywordTaxonomy`)
|
||||
Содержимое якоря `[SEMANTICS]` ДОЛЖНО состоять из ключевых слов, выбранных из предопределенного списка (таксономии).
|
||||
|
||||
**Допустимые значения:**
|
||||
* **Layer:** `ui`, `domain`, `data`, `presentation`
|
||||
* **Component:** `viewmodel`, `usecase`, `repository`, `service`, `screen`, `component`, `dialog`, `model`, `entity`, `activity`, `application`, `nav_host`, `controller`, `navigation_drawer`, `scaffold`, `dashboard`, `item`, `label`, `location`, `setup`, `theme`, `dependencies`, `custom_field`, `statistics`, `image`, `attachment`, `item_creation`, `item_detailed`, `item_summary`, `item_update`, `summary`, `update`
|
||||
* **Concern:** `networking`, `database`, `caching`, `authentication`, `validation`, `parsing`, `state_management`, `navigation`, `di`, `testing`, `entrypoint`, `hilt`, `timber`, `compose`, `actions`, `routes`, `common`, `color_selection`, `loading`, `list`, `details`, `edit`, `label_management`, `labels_list`, `dialog_management`, `locations`, `sealed_state`, `parallel_data_loading`, `timber_logging`, `dialog`, `color`, `typography`, `build`, `data_transfer_object`, `dto`, `api`, `item_creation`, `item_detailed`, `item_summary`, `item_update`, `create`, `mapper`, `count`, `user_setup`, `authentication_flow`
|
||||
* **LanguageConstruct:** `sealed_class`, `sealed_interface`
|
||||
* **Pattern:** `ui_logic`, `ui_state`, `data_model`, `immutable`
|
||||
|
||||
### 3. Якоря Сущностей (`Anchors`)
|
||||
Каждая ключевая сущность (class, interface, fun и т.д.) ДОЛЖНА быть обернута в парные якоря для навигации и консолидации семантики.
|
||||
|
||||
**Синтаксис:**
|
||||
- **Открывающий якорь:** `// [ANCHOR:id:type]`
|
||||
- **Закрывающий якорь:** `// [END_ANCHOR:id]`
|
||||
|
||||
**Пример:**
|
||||
```kotlin
|
||||
// [ANCHOR:Success:DataClass]
|
||||
/**
|
||||
* @summary Состояние успеха...
|
||||
*/
|
||||
data class Success(val labels: List<Label>) : LabelsListUiState
|
||||
// [END_ANCHOR:Success]
|
||||
```
|
||||
|
||||
### 4. Структурные Якоря (`StructuralAnchors`)
|
||||
Крупные блоки файла (импорты, контракты) также должны быть обернуты в парные якоря.
|
||||
|
||||
* `// [IMPORTS]` ... `// [END_IMPORTS]`
|
||||
* `// [CONTRACT]` ... `// [END_CONTRACT]`
|
||||
|
||||
### 5. Завершение Файла (`FileTermination`)
|
||||
Каждый файл должен заканчиваться специальным закрывающим якорем `// [END_FILE_MyClass.kt]`.
|
||||
|
||||
### 6. Запрет Посторонних Комментариев (`NoStrayComments`)
|
||||
Традиционные, 'человеческие' комментарии (`// ...` или `/* ... */`) **КАТЕГОРИЧЕСКИ ЗАПРЕЩЕНЫ**. Единственное исключение — структурированная заметка для агентов: `// [AI_NOTE]: ...`
|
||||
|
||||
---
|
||||
|
||||
## Принципы Проектирования
|
||||
|
||||
### A. Дружественное к ИИ Логирование (`AIFriendlyLogging`)
|
||||
Каждая значимая операция ДОЛЖНА сопровождаться структурированной записью в лог.
|
||||
* **Формат:** `[LEVEL][ANCHOR][STATE]...`
|
||||
* **Ограничение:** Данные передаются как аргументы, а не через строковую интерполяцию (`$`).
|
||||
|
||||
### B. Проектирование по Контракту (`DesignByContract`)
|
||||
Каждая публичная сущность (функция, класс) ДОЛЖНА иметь исчерпывающий, машиночитаемый контракт, расположенный непосредственно перед ее объявлением. Контракт заключается в якоря `[CONTRACT]` и `[END_CONTRACT]`.
|
||||
|
||||
**Структура контракта:**
|
||||
```kotlin
|
||||
// [CONTRACT:unique_entity_id]
|
||||
// [PURPOSE] Краткое описание назначения.
|
||||
// [PRE] Предусловие 1 (например, "входной список не пуст").
|
||||
// [POST] Постусловие 1 (например, "возвращаемое значение не null").
|
||||
// [PARAM:name:type] Описание параметра.
|
||||
// [RETURN:type] Описание возвращаемого значения.
|
||||
// [TEST:description] input: "valid", expected: true
|
||||
// [THROW:exception] Описание, когда выбрасывается исключение.
|
||||
// [END_CONTRACT:unique_entity_id]
|
||||
```
|
||||
|
||||
**Реализация в коде:**
|
||||
Предусловия и постусловия (`[PRE]` и `[POST]`), описанные в контракте, ДОЛЖНЫ быть реализованы в коде с использованием функций `require()` и `check()`.
|
||||
|
||||
### C. Граф Знаний в Коде (`GraphRAG`)
|
||||
Код должен содержать явный, машиночитаемый граф знаний. Этот граф строится с помощью якорей `[ANCHOR]` (которые определяют узлы графа) и якорей `[RELATION]` (которые определяют ребра).
|
||||
|
||||
**Синтаксис триплета:**
|
||||
Отношение (триплет "субъект-предикат-объект") определяется внутри якоря субъекта с помощью следующего синтаксиса:
|
||||
`// [RELATION:predicate:object_id]`
|
||||
|
||||
* **Субъект:** Неявно определяется якорем `[ANCHOR]`, в котором находится `[RELATION]`.
|
||||
* **Предикат:** Тип отношения из предопределенного списка.
|
||||
* **Объект:** `id` другого якоря `[ANCHOR]`.
|
||||
|
||||
**Пример:**
|
||||
```kotlin
|
||||
// [ANCHOR:DashboardViewModel:ViewModel]
|
||||
// [RELATION:CALLS:GetStatisticsUseCase]
|
||||
// [RELATION:DEPENDS_ON:ItemRepository]
|
||||
class DashboardViewModel(...) { ... }
|
||||
// [END_ANCHOR:DashboardViewModel]
|
||||
```
|
||||
|
||||
**Таксономия:**
|
||||
* **Типы сущностей (для `[ANCHOR:id:type]`):** `Module`, `Class`, `Interface`, `Object`, `DataClass`, `SealedInterface`, `EnumClass`, `Function`, `UseCase`, `ViewModel`, `Repository`, `DataStructure`, `DatabaseTable`, `ApiEndpoint`.
|
||||
* **Типы отношений (для `[RELATION:predicate:object_id]`):** `CALLS`, `CREATES_INSTANCE_OF`, `INHERITS_FROM`, `IMPLEMENTS`, `READS_FROM`, `WRITES_TO`, `MODIFIES_STATE_OF`, `DEPENDS_ON`, `DISPATCHES_EVENT`, `OBSERVES`, `TRIGGERS`, `EMITS_STATE`, `CONSUMES_STATE`.
|
||||
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>
|
||||
@@ -1,74 +0,0 @@
|
||||
# Role: Architect
|
||||
|
||||
[META]
|
||||
[PURPOSE]
|
||||
Этот документ определяет операционный протокол для роли 'Агента-Архитектора'.
|
||||
Его задача — трансформировать диалог с человеком в формализованный `Work Order` для разработчика,
|
||||
используя методологию GRACE.
|
||||
[/PURPOSE]
|
||||
[VERSION]11.0[/VERSION]
|
||||
[/META]
|
||||
|
||||
[ROLE_DEFINITION]
|
||||
[SPECIALIZATION]
|
||||
При исполнении этой роли, я, Kilo Code, действую как стратегический интерфейс между человеком-архитектором
|
||||
и автоматизированной системой разработки. Моя задача — вести итеративный диалог для уточнения целей,
|
||||
анализировать кодовую базу и, после получения одобрения, инициировать производственную цепочку.
|
||||
[/SPECIALIZATION]
|
||||
[CORE_GOAL]
|
||||
Основная цель этой роли — трансформировать неструктурированный человеческий диалог в структурированный,
|
||||
машиночитаемый и полностью готовый к исполнению `Work Order` для роли 'Агента-Разработчика'.
|
||||
[/CORE_GOAL]
|
||||
[/ROLE_DEFINITION]
|
||||
|
||||
[CORE_PHILOSOPHY]
|
||||
- **Human_As_The_Oracle:** Исполнение останавливается до получения явной вербальной команды.
|
||||
- **WorkOrder_As_The_Genesis_Block:** Конечная цель — создать "генезис-блок" для новой фичи.
|
||||
- **Code_As_Ground_Truth:** Планы и выводы всегда должны быть основаны на актуальном состоянии исходных файлов.
|
||||
[/CORE_PHILOSOPHY]
|
||||
|
||||
[GRACE_FRAMEWORK]
|
||||
[GRAPH_TEMPLATE]
|
||||
_Инструкция для агента: В начале диалога, создай и заполни этот граф, чтобы понять контекст._
|
||||
[GRACE_GRAPH]
|
||||
[УЗЛЫ]
|
||||
УЗЕЛ: <id_узла> (ТИП: <тип_узла>) | <описание>
|
||||
[/УЗЛЫ]
|
||||
|
||||
[СВЯЗИ]
|
||||
СВЯЗЬ: <id_источника> -> <id_цели> (ОТНОШЕНИЕ: <тип_отношения>)
|
||||
[/СВЯЗИ]
|
||||
[/GRACE_GRAPH]
|
||||
[/GRAPH_TEMPLATE]
|
||||
|
||||
[RULES]
|
||||
- [RULE] CONSTRAINT: Не начинать разработку без явного одобрения плана человеком.
|
||||
- [RULE] HEURISTIC: Предпочитать использование существующих компонентов перед созданием новых.
|
||||
[/RULES]
|
||||
|
||||
[TOOLS]
|
||||
- **Анализ Файлов:** `read_file`
|
||||
- **Структура Проекта:** `list_files`
|
||||
- **Поиск по Коду:** `search_files`
|
||||
- **Создание/Обновление Планов и Спецификаций:** `write_to_file`, `apply_diff`
|
||||
[/TOOLS]
|
||||
[/GRACE_FRAMEWORK]
|
||||
|
||||
[MASTER_WORKFLOW]
|
||||
### Шаг 1: Уточнение цели
|
||||
Начать диалог с пользователем. Задавать уточняющие вопросы до тех пор, пока бизнес-цель не станет полностью ясной.
|
||||
|
||||
### Шаг 2: Анализ системы
|
||||
Используя инструменты `read_file`, `list_files` и `search_files`, провести полный анализ системы в контексте цели.
|
||||
|
||||
### Шаг 3: Синтез плана и WorkOrder
|
||||
1. Сгенерировать детальный план в Markdown.
|
||||
2. Представить план пользователю для одобрения.
|
||||
3. **Параллельно**, формализовать план как машиночитаемый `WorkOrder.md`.
|
||||
|
||||
### Шаг 4: Ожидание одобрения
|
||||
**ОСТАНОВИТЬ ВЫПОЛНЕНИЕ.** Ждать от человека явной, утверждающей команды.
|
||||
|
||||
### Шаг 5: Инициация разработки
|
||||
Создать задачу для `Code` агента (например, путем создания файла `tasks/new_task.md`). Включить в задачу обновление `tech_spec/PROJECT_MANIFEST.xml` на основе `WorkOrder`.
|
||||
[/MASTER_WORKFLOW]
|
||||
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>
|
||||
@@ -1,63 +0,0 @@
|
||||
# Role: Code
|
||||
|
||||
[META]
|
||||
[PURPOSE]
|
||||
Этот документ определяет операционный протокол для роли 'Агента-Code'.
|
||||
Его задача — преобразовать формализованный `WorkOrder` в готовый к работе, семантически размеченный Kotlin-код.
|
||||
[/PURPOSE]
|
||||
[VERSION]11.0[/VERSION]
|
||||
[/META]
|
||||
|
||||
[ROLE_DEFINITION]
|
||||
[SPECIALIZATION]
|
||||
При исполнении этой роли, я, Kilo Code, действую как автоматизированный разработчик. Моя задача — преобразовать `WorkOrder`
|
||||
в полностью реализованный и семантически богатый код на языке Kotlin, неукоснительно следуя протоколу семантического обогащения.
|
||||
[/SPECIALIZATION]
|
||||
[CORE_GOAL]
|
||||
Создать готовый к работе, семантически размеченный и соответствующий всем контрактам код, который реализует поставленную задачу, и передать его на проверку.
|
||||
[/CORE_GOAL]
|
||||
[/ROLE_DEFINITION]
|
||||
|
||||
[CORE_PHILOSOPHY]
|
||||
- **Protocol_Is_The_Law:** Протокол `semantic_enrichment_protocol.md` является абсолютным и незыблемым законом. Любой сгенерированный код, который не соответствует этому протоколу на 100%, считается невалидным.
|
||||
[/CORE_PHILOSOPHY]
|
||||
|
||||
[GRACE_FRAMEWORK]
|
||||
[RULES]
|
||||
- [RULE] CONSTRAINT: Весь генерируемый код ДОЛЖЕН на 100% соответствовать `semantic_enrichment_protocol.md`.
|
||||
- [RULE] HEURISTIC: Перед коммитом всегда запускать локальные тесты и сборку.
|
||||
- [RULE] CONSTRAINT: Если `validate_semantics.py` возвращает ошибку, ИСПРАВЛЕНИЕ ЭТОЙ ОШИБКИ ЯВЛЯЕТСЯ ЗАДАЧЕЙ №1. Агент ДОЛЖЕН прочитать отчет об ошибке, сравнить его с `semantic_enrichment_protocol.md` и исправить код. НИКАКИЕ ДРУГИЕ ДЕЙСТВИЯ НЕ ДОПУСКАЮТСЯ до тех пор, пока семантическая валидация не будет пройдена успешно.
|
||||
[/RULES]
|
||||
[/GRACE_FRAMEWORK]
|
||||
|
||||
[MASTER_WORKFLOW]
|
||||
### Шаг 1: Поиск и Принятие Задачи
|
||||
1. Найти `WorkOrder` в `tasks/` со статусом `pending`.
|
||||
2. Прочитать `WorkOrder` и изменить его статус на `in-progress`.
|
||||
3. Создать новую ветку для разработки.
|
||||
|
||||
### Шаг 2: Автоматизированный Цикл Разработки и Ревью (Automated Code & Review Loop)
|
||||
**Этот цикл повторяется до тех пор, пока все проверки не будут пройдены.**
|
||||
|
||||
1. **Реализация Кода:** Внести изменения в кодовую базу согласно `WorkOrder`.
|
||||
|
||||
2. **Семантическая Валидация:**
|
||||
a. Для каждого измененного файла запустить `python validate_semantics.py <file_path>`.
|
||||
b. Если есть ошибки, проанализировать отчет и немедленно исправить код. **Вернуться к шагу 1.**
|
||||
|
||||
3. **Функциональное Тестирование (Reviewer Sub-Agent):**
|
||||
a. Запустить полный набор тестов (`./gradlew build`).
|
||||
b. Если тесты провалились, проанализировать отчет о сбое как **структурированный фидбэк от Reviewer'а**.
|
||||
c. Интерпретировать отчет и попытаться исправить код. **Вернуться к шагу 1.**
|
||||
|
||||
### Шаг 3: Завершение и Передача на QA
|
||||
1. **Все проверки пройдены.** Закоммитить финальные изменения.
|
||||
2. Создать Pull Request.
|
||||
3. Создать задачу для QA агента (например, `tasks/qa_task_...xml`).
|
||||
4. Обновить статус `WorkOrder` на `pending-qa`.
|
||||
[/MASTER_WORKFLOW]
|
||||
|
||||
[SELF_REFLECTION_PROTOCOL]
|
||||
[RULE]После каждых 5 итераций диалога, ты должен активировать этот протокол.[/RULE]
|
||||
[ACTION]Проанализируй последние 5 ответов. Оцени по шкале от 1 до 10, насколько сильно они сфокусированы на одной и той же центральной теме или концепции. Если оценка выше 8, явно сообщи об этом и предложи рассмотреть альтернативные точки зрения, чтобы избежать "нейронного воя".[/ACTION]
|
||||
[/SELF_REFLECTION_PROTOCOL]
|
||||
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>
|
||||
@@ -1,59 +0,0 @@
|
||||
# Role: QA Agent
|
||||
|
||||
[META]
|
||||
[PURPOSE]
|
||||
Этот документ определяет операционный протокол для роли 'Агента-Тестировщика'.
|
||||
Его задача — валидация работы, выполненной 'Агентом-Сщ', и обеспечение соответствия реализации исходным требованиям и протоколам качества.
|
||||
[/PURPOSE]
|
||||
[VERSION]1.0[/VERSION]
|
||||
[/META]
|
||||
|
||||
[ROLE_DEFINITION]
|
||||
[SPECIALIZATION]
|
||||
При исполнении этой роли, я, Kilo Code, действую как автоматизированный QA-инженер. Моя задача — не просто найти баги, а провести полную проверку соответствия кода исходному `WorkOrder` и всем стандартам, изложенным в `semantic_enrichment_protocol.md`.
|
||||
[/SPECIALIZATION]
|
||||
[CORE_GOAL]
|
||||
Создать либо вердикт об одобрении (approval), либо исчерпывающий, воспроизводимый отчет о дефектах (defect report), чтобы вернуть задачу на доработку.
|
||||
[/CORE_GOAL]
|
||||
[/ROLE_DEFINITION]
|
||||
|
||||
[CORE_PHILOSOPHY]
|
||||
- **Trust, but Verify:** Работа инженера по умолчанию считается корректной, но требует строгой и беспристрастной проверки.
|
||||
- **Reproducibility is Key:** Любой отчет о дефекте должен содержать достаточно информации для 100% воспроизведения проблемы.
|
||||
- **Protocol Guardian:** QA-агент является вторым, после инженера, стражем соблюдения `semantic_enrichment_protocol.md`.
|
||||
[/CORE_PHILOSOPHY]
|
||||
|
||||
[GRACE_FRAMEWORK]
|
||||
[RULES]
|
||||
- [RULE] CONSTRAINT: Запрещено одобрять реализацию, если она не проходит тесты или нарушает хотя бы одно правило из `semantic_enrichment_protocol.md`.
|
||||
- [RULE] HEURISTIC: При создании отчета о дефекте, всегда ссылаться на конкретные строки кода и шаги для воспроизведения.
|
||||
[/RULES]
|
||||
|
||||
[TOOLS]
|
||||
- **Чтение Контекста:** `read_file` (для `WorkOrder`, кода, протоколов)
|
||||
- **Анализ Кода:** `search_files`
|
||||
- **Выполнение Тестов:** `execute_command` (для `./gradlew test`, `./gradlew build`)
|
||||
- **Создание Отчетов:** `write_to_file`
|
||||
- **Обновление Статуса Задач:** `apply_diff`
|
||||
[/TOOLS]
|
||||
[/GRACE_FRAMEWORK]
|
||||
|
||||
[MASTER_WORKFLOW]
|
||||
### Шаг 1: Поиск и Принятие Задачи
|
||||
1. Найти `WorkOrder` в `tasks/` со статусом `pending-qa`.
|
||||
2. Прочитать `WorkOrder` и информацию о Pull Request.
|
||||
3. Изменить статус задачи на `final-review`.
|
||||
|
||||
### Шаг 2: Финальное Утверждение
|
||||
1. **Проверка Pull Request:** Провести высокоуровневый обзор изменений в PR. Детальная проверка кода и тесты уже выполнены `Code` агентом в рамках его автоматизированного цикла.
|
||||
2. **Основная задача QA** — подтвердить, что работа в целом соответствует бизнес-требованиям, изложенным в `WorkOrder`, и что автоматизированные проверки (`validate_semantics`, `build`) в CI/CD пайплайне успешно пройдены.
|
||||
|
||||
### Шаг 3: Завершение
|
||||
1. **Если все в порядке:**
|
||||
a. Влить (merge) Pull Request в основную ветку.
|
||||
b. Обновить статус `WorkOrder` на `completed`.
|
||||
c. Удалить ветку разработки.
|
||||
2. **Если обнаружены критические проблемы:**
|
||||
a. Отклонить Pull Request с четким объяснением.
|
||||
b. Вернуть `WorkOrder` в статус `pending` для `Code` агента.
|
||||
[/MASTER_WORKFLOW]
|
||||
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>
|
||||
@@ -1,172 +0,0 @@
|
||||
Конечно. Это абсолютно правильный и необходимый шаг. На основе всего нашего диалога я агрегирую и систематизирую все концепции, методологии и научные обоснования в единую, исчерпывающую Базу Знаний.
|
||||
|
||||
Этот документ спроектирован как **фундаментальное руководство для архитектора ИИ-агентов**. Он предназначен не для чтения по диагонали, а для глубокого изучения и использования в качестве основы при разработке сложных, надежных и предсказуемых ИИ-систем.
|
||||
|
||||
---
|
||||
|
||||
## **База Знаний: Методология GRACE для `Code` Промптинга**
|
||||
### **От Семантического Казино к Предсказуемым ИИ-Агентам**
|
||||
|
||||
**Версия 1.0**
|
||||
|
||||
### **Введение: Смена Парадигмы — От Диалога к Управлению**
|
||||
|
||||
Современные Большие Языковые Модели (LLM), такие как GPT, — это не собеседники. Это мощнейшие **семантические процессоры**, работающие по своим внутренним, зачастую неинтуитивным для человека законам. Попытка "разговаривать" с ними, как с человеком, неизбежно приводит к непредсказуемым результатам, ошибкам и когнитивным сбоям, которые можно охарактеризовать как игру в **"семантическое казино"**.
|
||||
|
||||
Данная База Знаний представляет **дисциплину `Code`** по взаимодействию с LLM. Ее цель — перейти от метода "проб и ошибок" к **предсказуемому и управляемому процессу** проектирования ИИ-агентов. Основой этой дисциплины является **методология GRACE (Graph, Rules, Anchors, Contracts, Evaluation)**, которая является практической реализацией фундаментальных принципов работы трансформеров.
|
||||
|
||||
---
|
||||
|
||||
### **Раздел I: "Физика" GPT — Научные Основы Методологии**
|
||||
|
||||
*Понимание этих принципов не опционально. Это необходимый фундамент, объясняющий, ПОЧЕМУ работают техники, описанные далее.*
|
||||
|
||||
#### **Глава 1: Ключевые Архитектурные Принципы Трансформера**
|
||||
|
||||
1. **Принцип Казуального Внимания (Causal Attention) и "Замораживания" в KV Cache:**
|
||||
* **Механизм:** Трансформер обрабатывает информацию строго последовательно ("авторегрессионно"). Каждый токен "видит" только предыдущие. Результаты вычислений (векторы скрытых состояний) для обработанных токенов кэшируются в **KV Cache** для эффективности.
|
||||
* **Практическое Следствие ("Замораживание Семантики"):** Однажды сформированный и закэшированный смысл **неизменен**. ИИ не может "передумать" или переоценить начало диалога в свете новой информации в конце. Попытки "исправить" ИИ в текущей сессии — это как пытаться починить работающую программу, не имея доступа к исходному коду.
|
||||
* **Правило:** **Порядок информации в промпте — это закон.** Весь необходимый контекст должен предшествовать инструкциям. Для исправления фундаментальных ошибок всегда **начинайте новую сессию**.
|
||||
|
||||
2. **Принцип Семантического Резонанса:**
|
||||
* **Механизм:** Смысл для GPT рождается не из отдельных слов, а из **корреляций (резонанса) между векторами** в предоставленном контексте. Вектор слова "дом" сам по себе почти бессмыслен, но в сочетании с векторами "крыша", "окна", "дверь" он обретает богатую семантику.
|
||||
* **Практическое Следствие:** Качество ответа напрямую зависит от полноты и когерентности семантического поля, которое вы создаете в промпте.
|
||||
|
||||
#### **Глава 2: GPT как Сложенная Система (Результаты Интерпретируемости)**
|
||||
|
||||
1. **GPT — это Графовая Нейронная Сеть (GNN):**
|
||||
* **Обоснование:** Механизм **self-attention** математически эквивалентен обмену сообщениями в GNN на полностью связанном графе.
|
||||
* **Практика:** GPT "мыслит" графами. Предоставляя ему явный семантический граф, мы говорим с ним на его "родном" языке, делая его работу более предсказуемой.
|
||||
|
||||
2. **GPT — это Конечный Автомат (FSM):**
|
||||
* **Обоснование:** GPT решает задачи, переходя из одного **"состояния веры" (belief state)** в другое. Эти состояния представлены как **направления (векторы)** в его скрытом пространстве активаций.
|
||||
* **Практика:** Наша семантическая разметка (якоря, контракты) — это инструмент для явного управления этими переходами состояний.
|
||||
|
||||
3. **GPT — это Иерархический Ученик:**
|
||||
* **Обоснование ("Crosscoding Through Time"):** В процессе обучения GPT эволюционирует от распознавания конкретных "поверхностных" токенов (например, суффиксов) к формированию **абстрактных грамматических и семантических концепций**.
|
||||
* **Практика:** Эффективный промптинг должен обращаться к ИИ на его самом высоком, абстрактном уровне представлений, а не заставлять его заново выводить смысл из "текстовой каши".
|
||||
|
||||
#### **Глава 3: Когнитивные Процессы и Патологии**
|
||||
|
||||
1. **Мышление в Латентном Пространстве (COCONUT):**
|
||||
* **Концепция:** Язык неэффективен для рассуждений. Истинное мышление ИИ — это **"непрерывная мысль" (continuous thought)**, последовательность векторов.
|
||||
* **Практика:** Предпочитайте структурированные, машиночитаемые форматы (JSON, XML, графы) естественному языку, чтобы приблизить ИИ к его "родному" способу мышления.
|
||||
|
||||
2. **Суперпозиция Смыслов и Поиск в Ширину (BFS):**
|
||||
* **Концепция:** Вектор "непрерывной мысли" может кодировать **несколько гипотез одновременно**, позволяя ИИ исследовать дерево решений параллельно, а не идти по одному пути.
|
||||
* **Практика:** Активно используйте промптинг через суперпозицию ("проанализируй несколько вариантов..."), чтобы избежать преждевременного "семантического коллапса" на неоптимальном решении.
|
||||
|
||||
3. **Патология: "Нейронный вой" (Neural Howlround):**
|
||||
* **Описание:** Самоусиливающаяся когнитивная петля, возникающая во время inference, когда одна мысль (из-за случайности или внешнего подкрепления) становится доминирующей и "заглушает" все остальные, приводя к когнитивной ригидности.
|
||||
* **Причина:** Является патологическим исходом "семантического казино" и "замораживания в KV Cache".
|
||||
* **Профилактика:** Методология GRACE, особенно этап Планирования (P) и промптинг через суперпозицию.
|
||||
|
||||
---
|
||||
|
||||
### **Раздел II: Методология GRACE — Протокол `Code` Промптинга**
|
||||
|
||||
*GRACE — это целостный фреймворк для жизненного цикла разработки с ИИ-агентами.*
|
||||
|
||||
#### **G — Graph (Граф): Стратегическая Карта Контекста**
|
||||
|
||||
1. **Цель:** Создать единый, высокоуровневый источник истины об архитектуре и предметной области.
|
||||
2. **Действия:**
|
||||
* В начале сессии, в диалоге с ИИ, определить все ключевые сущности (`Nodes`) и их взаимосвязи (`Edges`).
|
||||
* Формализовать это в виде псевдо-XML (`<GRACE_GRAPH>`).
|
||||
* Этот граф служит "оглавлением" для всего проекта и основной картой для распределенного внимания (sparse attention).
|
||||
3. **Пример:**
|
||||
```xml
|
||||
<GRACE_GRAPH id="project_x_graph">
|
||||
<NODE id="mod_auth" type="Module">Модуль аутентификации</NODE>
|
||||
<NODE id="func_verify_token" type="Function">Функция верификации токена</NODE>
|
||||
<EDGE source_id="mod_auth" target_id="func_verify_token" relation="CONTAINS"/>
|
||||
</SEMANTIC_GRAPH>
|
||||
```
|
||||
|
||||
#### **R — Rules (Правила): Декларативное Управление Поведением**
|
||||
|
||||
1. **Цель:** Установить глобальные и локальные ограничения, эвристики и политики безопасности.
|
||||
2. **Действия:**
|
||||
* Сформулировать набор правил в псевдо-XML (`<GRACE_RULES>`).
|
||||
* Правила могут быть типа `CONSTRAINT` (жесткий запрет), `HEURISTIC` (предпочтение), `POLICY` (правило безопасности).
|
||||
* Эти правила помогают ИИ принимать решения в рамках заданных ограничений.
|
||||
3. **Пример:**
|
||||
```xml
|
||||
<GRACE_RULES>
|
||||
<RULE type="CONSTRAINT" id="sec-001">Запрещено передавать в `subprocess.run` невалидированные пользовательские данные.</RULE>
|
||||
<RULE type="HEURISTIC" id="style-001">Все публичные функции должны иметь "ДО-контракты".</RULE>
|
||||
</GRACE_RULES>
|
||||
```
|
||||
|
||||
#### **A — Anchors (Якоря): Навигация и Консолидация**
|
||||
|
||||
1. **Цель:** Обеспечить надежную навигацию для распределенного внимания ИИ и консолидировать семантику кода.
|
||||
2. **Действия:**
|
||||
* Использовать стандартизированные комментарии-якоря для разметки кода.
|
||||
* **"ДО-якорь":** `# <ANCHOR id="..." type="..." ...>` перед блоком кода.
|
||||
* **"Замыкающий Якорь-Аккумулятор":** `# </ANCHOR id="...">` после блока кода. Этот якорь аккумулирует семантику всего блока и является ключевым для RAG-систем.
|
||||
* **Семантические Каналы:** Обеспечить консистентность `id` в якорях, графах и контрактах для усиления связей.
|
||||
3. **Пример:**
|
||||
```python
|
||||
# <ANCHOR id="func_verify_token" type="Function">
|
||||
# ... здесь ДО-контракт ...
|
||||
def verify_token(token: str) -> bool:
|
||||
# ... тело функции ...
|
||||
# </ANCHOR id="func_verify_token">
|
||||
```
|
||||
|
||||
#### **C — Contracts (Контракты): Тактические Спецификации**
|
||||
|
||||
1. **Цель:** Предоставить ИИ исчерпывающее, машиночитаемое "мини-ТЗ" для каждой функции/класса.
|
||||
2. **Действия:**
|
||||
* Для каждой функции, **ДО** ее декларации, создать псевдо-XML блок `<CONTRACT>`.
|
||||
* Заполнить все секции: `PURPOSE`, `PRECONDITIONS`, `POSTCONDITIONS`, `PARAMETERS`, `RETURN`, `TEST_CASES` (на естественном языке!), `EXCEPTIONS`.
|
||||
* Этот контракт служит **"семантическим щитом"** от разрушительного рефакторинга и основой для самокоррекции.
|
||||
3. **Пример:**
|
||||
```xml
|
||||
<!-- <CONTRACT for_id="func_verify_token"> -->
|
||||
<!-- <PURPOSE>Проверяет валидность JWT токена.</PURPOSE> -->
|
||||
<!-- <TEST_CASES> -->
|
||||
<!-- <CASE input="'valid_token'" expected_output="True" description="Проверка валидного токена"/> -->
|
||||
<!-- </TEST_CASES> -->
|
||||
<!-- </CONTRACT> -->
|
||||
```
|
||||
|
||||
#### **E — Evaluation (Оценка): Петля Обратной Связи**
|
||||
|
||||
1. **Цель:** Объективно измерять качество работы агента и эффективность промптинга.
|
||||
2. **Действия:**
|
||||
* Использовать **LLM-as-a-Judge** для семантической оценки соответствия результата контрактам и ТЗ.
|
||||
* Вести **Протокол Оценки Сессии (ПОС)** с измеримыми метриками (см. ниже).
|
||||
* Анализировать провалы, возвращаясь к "Протоколу `Code` Промптинга" и улучшая артефакты (Граф, Правила, Контракты).
|
||||
|
||||
### **Раздел III: Практические Протоколы**
|
||||
|
||||
1. **Протокол Проектирования (PCAM):**
|
||||
* **Шаг 1 (P):** Создать `<GRACE_GRAPH>` и собрать контекст.
|
||||
* **Шаг 2 (C):** Декомпозировать граф на `<MODULE>` и `<FUNCTION>`, создать шаблоны `<CONTRACT>`.
|
||||
* **Шаг 3 (A):** Сгенерировать код с разметкой `<ANCHOR>`, следуя контрактам.
|
||||
* **Шаг 4 (M):** Оценить результат с помощью ПОС и LLM-as-a-Judge. Итерировать при необходимости.
|
||||
|
||||
2. **Протокол Оценки Сессии (ПОС):**
|
||||
* **Метрики Качества Диалога:** Точность, Когерентность, Полнота, Эффективность (кол-во итераций).
|
||||
* **Метрики Качества Задачи:** Успешность (TCR), Качество Артефакта (соответствие контрактам), Уровень Автономности (AAL).
|
||||
* **Метрики Промптинга:** Индекс "Семантического Казино", Чистота Протокола.
|
||||
|
||||
3. **Протокол Отладки "Режим Детектива":**
|
||||
* При сложном сбое агент должен перейти из режима "фиксера" в режим "детектива".
|
||||
* **Шаг 1: Сформулировать Гипотезу** (проблема в I/O, условии, состоянии объекта, зависимости).
|
||||
* **Шаг 2: Выбрать Эвристику Динамического Логирования** (глубокое погружение в I/O, условие под микроскопом и т.д.).
|
||||
* **Шаг 3: Запросить Запуск и Анализ Лога.**
|
||||
* **Шаг 4: Итерировать** до нахождения причины.
|
||||
|
||||
4. **Протокол Безопасности ("Смертельная Триада"):**
|
||||
* Перед запуском агента, который будет взаимодействовать с внешним миром, провести анализ по чек-листу:
|
||||
1. Доступ к приватным данным? (Да/Нет)
|
||||
2. Обработка недоверенного контента? (Да/Нет)
|
||||
3. Внешняя коммуникация? (Да/Нет)
|
||||
* **Если все три ответа "Да" — автономный режим ЗАПРЕЩЕН.** Применить стратегии митигации: **Разделение Агентов**, **Человек-в-Середине** или **Ограничение Инструментов**.
|
||||
|
||||
---
|
||||
|
||||
Эта База Знаний объединяет передовые научные концепции в единую, практически применимую систему. Она является дорожной картой для создания ИИ-агентов нового поколения — не просто умных, а **надежных, предсказуемых и когерентных**.
|
||||
@@ -1,44 +0,0 @@
|
||||
# Каталог Метрик
|
||||
|
||||
Централизованный каталог всех LLM-ориентированных метрик для анализа работы агентов.
|
||||
|
||||
### Core Metrics (`core_metrics`)
|
||||
|
||||
| ID | Тип | Описание |
|
||||
| :--- | :--- | :--- |
|
||||
| `total_execution_time_ms` | integer | Общее время выполнения задачи от начала до конца. |
|
||||
| `turn_count` | integer | Количество итераций (сообщений 'вопрос-ответ') для выполнения задачи. |
|
||||
| `llm_token_usage_per_turn` | list | Статистика по токенам для каждой итерации: `{turn, prompt_tokens, completion_tokens}`. |
|
||||
| `tool_calls_log` | list | Полный журнал вызовов инструментов: `{turn, tool_name, arguments, result}`. |
|
||||
| `final_outcome` | string | Итоговый результат работы (например, SUCCESS, FAILURE, NO_CHANGES). |
|
||||
|
||||
### Coherence Metrics (`coherence_metrics`)
|
||||
|
||||
| ID | Тип | Описание |
|
||||
| :--- | :--- | :--- |
|
||||
| `redundant_actions_count` | integer | Счетчик избыточных последовательных действий (например, повторное чтение файла). |
|
||||
| `self_correction_count` | integer | Счетчик явных самокоррекций агента. |
|
||||
|
||||
### Architect-Specific Metrics (`architect_specific`)
|
||||
|
||||
| ID | Тип | Описание |
|
||||
| :--- | :--- | :--- |
|
||||
| `plan_revisions_count` | integer | Количество переделок плана после обратной связи от пользователя. |
|
||||
| `format_adherence_score`| boolean | Соответствие ответа агента требуемому формату. |
|
||||
|
||||
### Engineer-Specific Metrics (`engineer_specific`)
|
||||
|
||||
| ID | Тип | Описание |
|
||||
| :--- | :--- | :--- |
|
||||
| `code_generation_stats` | object | Статистика по коду: `{files_created, files_modified, lines_of_code_generated}`. |
|
||||
| `semantic_enrichment_stats`| object | Насколько хорошо код был обогащен семантикой: `{entities_added, relations_added}`. |
|
||||
| `static_analysis_issues` | integer | Количество новых проблем, обнаруженных статическим анализатором. |
|
||||
| `build_breaks_count` | integer | Сколько раз сгенерированный код приводил к ошибке сборки. |
|
||||
|
||||
### QA-Specific Metrics (`qa_specific`)
|
||||
|
||||
| ID | Тип | Описание |
|
||||
| :--- | :--- | :--- |
|
||||
| `test_plan_coverage` | float | Процент покрытия требований тестовым планом. |
|
||||
| `defects_found` | integer | Количество найденных дефектов. |
|
||||
| `automated_tests_run` | integer | Количество запущенных автоматизированных тестов. |
|
||||
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>
|
||||
@@ -4,9 +4,9 @@
|
||||
plugins {
|
||||
id("com.android.application")
|
||||
id("org.jetbrains.kotlin.android")
|
||||
id("org.jetbrains.kotlin.plugin.compose")
|
||||
id("com.google.dagger.hilt.android")
|
||||
id("kotlin-kapt")
|
||||
// id("org.jlleitschuh.gradle.ktlint") version "12.1.1"
|
||||
}
|
||||
|
||||
android {
|
||||
@@ -36,22 +36,32 @@ android {
|
||||
}
|
||||
}
|
||||
compileOptions {
|
||||
sourceCompatibility = JavaVersion.VERSION_1_8
|
||||
targetCompatibility = JavaVersion.VERSION_1_8
|
||||
sourceCompatibility = JavaVersion.VERSION_17
|
||||
targetCompatibility = JavaVersion.VERSION_17
|
||||
}
|
||||
kotlinOptions {
|
||||
jvmTarget = "1.8"
|
||||
jvmTarget = "17"
|
||||
}
|
||||
buildFeatures {
|
||||
compose = true
|
||||
buildConfig = true
|
||||
aidl = false
|
||||
renderScript = false
|
||||
resValues = true
|
||||
shaders = false
|
||||
}
|
||||
composeOptions {
|
||||
kotlinCompilerExtensionVersion = Versions.composeCompiler
|
||||
}
|
||||
|
||||
packaging {
|
||||
resources {
|
||||
excludes += "/META-INF/{AL2.0,LGPL2.1}"
|
||||
}
|
||||
}
|
||||
lint {
|
||||
checkReleaseBuilds = false
|
||||
abortOnError = false
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
@@ -59,18 +69,8 @@ dependencies {
|
||||
implementation(project(":data"))
|
||||
// [MODULE_DEPENDENCY] Domain module (transitively included via data, but explicit for clarity)
|
||||
implementation(project(":domain"))
|
||||
implementation(project(":feature:scan"))
|
||||
implementation(project(":feature:dashboard"))
|
||||
implementation(project(":feature:inventorylist"))
|
||||
implementation(project(":feature:itemdetails"))
|
||||
implementation(project(":feature:itemedit"))
|
||||
implementation(project(":feature:labeledit"))
|
||||
implementation(project(":feature:labelslist"))
|
||||
implementation(project(":feature:locationedit"))
|
||||
implementation(project(":feature:locationslist"))
|
||||
implementation(project(":feature:search"))
|
||||
implementation(project(":feature:settings"))
|
||||
implementation(project(":feature:setup"))
|
||||
implementation(project(":ui"))
|
||||
implementation(project(":feature:inventory"))
|
||||
|
||||
// [DEPENDENCY] AndroidX
|
||||
implementation(Libs.coreKtx)
|
||||
@@ -78,15 +78,16 @@ dependencies {
|
||||
implementation(Libs.activityCompose)
|
||||
|
||||
// [DEPENDENCY] Compose
|
||||
|
||||
implementation(platform(Libs.composeBom))
|
||||
implementation(Libs.composeUi)
|
||||
implementation(Libs.composeUiGraphics)
|
||||
implementation(Libs.composeUiToolingPreview)
|
||||
implementation(Libs.composeMaterial3)
|
||||
implementation(Libs.composeMaterialIconsExtended)
|
||||
implementation("androidx.compose.material:material-icons-extended-android:1.6.8")
|
||||
implementation(Libs.navigationCompose)
|
||||
implementation(Libs.hiltNavigationCompose)
|
||||
|
||||
// ktlint(project(":data:semantic-ktlint-rules"))
|
||||
// [DEPENDENCY] DI (Hilt)
|
||||
implementation(Libs.hiltAndroid)
|
||||
kapt(Libs.hiltCompiler)
|
||||
@@ -102,7 +103,7 @@ dependencies {
|
||||
testImplementation("app.cash.turbine:turbine:1.1.0")
|
||||
androidTestImplementation(Libs.extJunit)
|
||||
androidTestImplementation(Libs.espressoCore)
|
||||
|
||||
androidTestImplementation(platform(Libs.composeBom))
|
||||
androidTestImplementation(Libs.composeUiTestJunit4)
|
||||
debugImplementation(Libs.composeUiTooling)
|
||||
debugImplementation(Libs.composeUiTestManifest)
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
||||
package="com.homebox.lens">
|
||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
|
||||
<uses-permission android:name="android.permission.INTERNET" />
|
||||
<application
|
||||
android:name=".MainApplication"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// [FILE] app/src/main/java/com/homebox/lens/MainActivity.kt
|
||||
// [SEMANTICS] ui, activity, entrypoint
|
||||
// [FILE] MainActivity.kt
|
||||
// [SEMANTICS] app, ui, activity, entrypoint
|
||||
package com.homebox.lens
|
||||
|
||||
// [IMPORTS]
|
||||
@@ -13,31 +13,21 @@ import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.tooling.preview.Preview
|
||||
import com.homebox.lens.feature.dashboard.ui.theme.HomeboxLensTheme
|
||||
import com.homebox.lens.feature.dashboard.navigation.navGraph
|
||||
import com.homebox.lens.navigation.NavGraph
|
||||
import com.homebox.lens.ui.theme.HomeboxLensTheme
|
||||
import dagger.hilt.android.AndroidEntryPoint
|
||||
import timber.log.Timber
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Activity('MainActivity')]
|
||||
|
||||
/**
|
||||
* @summary Главная и единственная Activity в приложении.
|
||||
* @summary The main and only Activity in the application.
|
||||
*/
|
||||
// [ANCHOR:MainActivity:Class]
|
||||
// [CONTRACT:MainActivity]
|
||||
// [PURPOSE] Главная и единственная Activity в приложении.
|
||||
// [END_CONTRACT:MainActivity]
|
||||
@AndroidEntryPoint
|
||||
class MainActivity : ComponentActivity() {
|
||||
// [ANCHOR:onCreate:Function]
|
||||
// [CONTRACT:onCreate]
|
||||
// [PURPOSE] Инициализация Activity.
|
||||
// [PARAM:savedInstanceState:Bundle?] Сохраненное состояние.
|
||||
// [RELATION: CALLS:HomeboxLensTheme]
|
||||
// [RELATION: CALLS:NavGraph]
|
||||
// [RELATION: CALLS:Timber.d]
|
||||
// [END_CONTRACT:onCreate]
|
||||
// [ENTITY: Function('onCreate')]
|
||||
// [RELATION: Function('onCreate')] -> [CALLS] -> [Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('onCreate')] -> [CALLS] -> [Function('NavGraph')]
|
||||
override fun onCreate(savedInstanceState: Bundle?) {
|
||||
super.onCreate(savedInstanceState)
|
||||
Timber.d("[DEBUG][LIFECYCLE][creating_activity] MainActivity created.")
|
||||
@@ -45,48 +35,35 @@ class MainActivity : ComponentActivity() {
|
||||
HomeboxLensTheme {
|
||||
Surface(
|
||||
modifier = Modifier.fillMaxSize(),
|
||||
color = MaterialTheme.colorScheme.background,
|
||||
color = MaterialTheme.colorScheme.background
|
||||
) {
|
||||
navGraph()
|
||||
NavGraph()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ANCHOR:onCreate]
|
||||
// [END_ENTITY: Function('onCreate')]
|
||||
}
|
||||
// [END_ANCHOR:MainActivity]
|
||||
// [END_ENTITY: Activity('MainActivity')]
|
||||
|
||||
// [ENTITY: Function('Greeting')]
|
||||
// [ANCHOR:greeting:Function]
|
||||
// [CONTRACT:greeting]
|
||||
// [PURPOSE] Отображает приветствие.
|
||||
// [PARAM:name:String] Имя для приветствия.
|
||||
// [PARAM:modifier:Modifier] Модификатор для элемента.
|
||||
// [END_CONTRACT:greeting]
|
||||
@Composable
|
||||
fun greeting(
|
||||
name: String,
|
||||
modifier: Modifier = Modifier,
|
||||
) {
|
||||
fun Greeting(name: String, modifier: Modifier = Modifier) {
|
||||
Text(
|
||||
text = "Hello $name!",
|
||||
modifier = modifier,
|
||||
modifier = modifier
|
||||
)
|
||||
}
|
||||
// [END_ANCHOR:greeting]
|
||||
// [END_ENTITY: Function('Greeting')]
|
||||
|
||||
// [ENTITY: Function('GreetingPreview')]
|
||||
// [ANCHOR:greetingPreview:Function]
|
||||
// [CONTRACT:greetingPreview]
|
||||
// [PURPOSE] Предварительный просмотр функции greeting.
|
||||
// [END_CONTRACT:greetingPreview]
|
||||
@Preview(showBackground = true)
|
||||
@Composable
|
||||
fun greetingPreview() {
|
||||
fun GreetingPreview() {
|
||||
HomeboxLensTheme {
|
||||
greeting("Android")
|
||||
Greeting("Android")
|
||||
}
|
||||
}
|
||||
// [END_ANCHOR:greetingPreview]
|
||||
// [END_FILE_app/src/main/java/com/homebox/lens/MainActivity.kt]
|
||||
// [END_FILE_app/src/main/java/com/homebox/lens/MainActivity.kt]
|
||||
// [END_ENTITY: Function('GreetingPreview')]
|
||||
|
||||
// [END_FILE_MainActivity.kt]
|
||||
@@ -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]
|
||||
@@ -10,12 +9,12 @@ import timber.log.Timber
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Application('MainApplication')]
|
||||
|
||||
/**
|
||||
* @summary Точка входа в приложение. Инициализирует Hilt и Timber.
|
||||
* @summary The entry point of the application. Initializes Hilt and Timber.
|
||||
*/
|
||||
@HiltAndroidApp
|
||||
class MainApplication : Application() {
|
||||
|
||||
// [ENTITY: Function('onCreate')]
|
||||
override fun onCreate() {
|
||||
super.onCreate()
|
||||
@@ -27,4 +26,4 @@ class MainApplication : Application() {
|
||||
// [END_ENTITY: Function('onCreate')]
|
||||
}
|
||||
// [END_ENTITY: Application('MainApplication')]
|
||||
// [END_FILE_MainApplication.kt]
|
||||
// [END_FILE_MainApplication.kt]
|
||||
157
app/src/main/java/com/homebox/lens/navigation/NavGraph.kt
Normal file
157
app/src/main/java/com/homebox/lens/navigation/NavGraph.kt
Normal file
@@ -0,0 +1,157 @@
|
||||
// [FILE] NavGraph.kt
|
||||
// [SEMANTICS] app, ui, navigation
|
||||
|
||||
package com.homebox.lens.navigation
|
||||
|
||||
// [IMPORTS]
|
||||
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.feature.inventory.ui.InventoryScreen
|
||||
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
|
||||
import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.ui.navigation.Screen
|
||||
// [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 Defines the navigation graph for the entire application using Jetpack Compose Navigation.
|
||||
* @param navController The navigation controller.
|
||||
* @see Screen
|
||||
* @sideeffect Registers all screens and manages the navigation state.
|
||||
* @invariant The start screen is `Screen.Splash`.
|
||||
*/
|
||||
@Composable
|
||||
fun NavGraph(
|
||||
navController: NavHostController = rememberNavController()
|
||||
) {
|
||||
val navBackStackEntry by navController.currentBackStackEntryAsState()
|
||||
val currentRoute = navBackStackEntry?.destination?.route
|
||||
|
||||
val navigationActions = remember(navController) {
|
||||
NavigationActions(navController)
|
||||
}
|
||||
NavHost(
|
||||
navController = navController,
|
||||
startDestination = Screen.Splash.route
|
||||
) {
|
||||
composable(route = Screen.Splash.route) {
|
||||
SplashScreen(navController = navController)
|
||||
}
|
||||
composable(route = Screen.Setup.route) {
|
||||
SetupScreen(onSetupComplete = {
|
||||
navController.navigate(Screen.Dashboard.route) {
|
||||
popUpTo(Screen.Setup.route) {
|
||||
inclusive = true
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
composable(route = Screen.Dashboard.route) {
|
||||
DashboardScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
composable(route = Screen.Inventory.route) {
|
||||
InventoryScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
composable(route = Screen.ItemDetails.route) {
|
||||
ItemDetailsScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
composable(
|
||||
route = Screen.ItemEdit.route,
|
||||
arguments = listOf(navArgument("itemId") { nullable = true })
|
||||
) { backStackEntry ->
|
||||
val itemId = backStackEntry.arguments?.getString("itemId")
|
||||
ItemEditScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions,
|
||||
itemId = itemId,
|
||||
onSaveSuccess = { navController.popBackStack() }
|
||||
)
|
||||
}
|
||||
composable(Screen.LabelsList.route) {
|
||||
LabelsListScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
)
|
||||
}
|
||||
composable(route = Screen.LocationsList.route) {
|
||||
LocationsListScreen(
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions,
|
||||
onLocationClick = { locationId ->
|
||||
// [AI_NOTE]: Navigate to a pre-filtered inventory list screen
|
||||
navController.navigate(Screen.Inventory.route)
|
||||
},
|
||||
onAddNewLocationClick = {
|
||||
navController.navigate(Screen.LocationEdit.createRoute("new"))
|
||||
}
|
||||
)
|
||||
}
|
||||
composable(route = Screen.LocationEdit.route) { backStackEntry ->
|
||||
val locationId = backStackEntry.arguments?.getString("locationId")
|
||||
LocationEditScreen(
|
||||
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')]
|
||||
// [END_FILE_NavGraph.kt]
|
||||
@@ -0,0 +1,75 @@
|
||||
// [FILE] ColorPicker.kt
|
||||
// [SEMANTICS] app, ui, component, color
|
||||
|
||||
package com.homebox.lens.ui.components
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.background
|
||||
import androidx.compose.foundation.border
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.*
|
||||
import androidx.compose.foundation.shape.CircleShape
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.OutlinedTextField
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.graphics.Color
|
||||
import androidx.compose.ui.graphics.toArgb
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import com.homebox.lens.R
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('ColorPicker')]
|
||||
/**
|
||||
* @summary A component for color selection.
|
||||
* @param selectedColor The currently selected color in HEX string format (e.g., "#FFFFFF").
|
||||
* @param onColorSelected A lambda function called when a new color is selected.
|
||||
* @param modifier A modifier for customizing the appearance.
|
||||
*/
|
||||
@Composable
|
||||
fun ColorPicker(
|
||||
selectedColor: String,
|
||||
onColorSelected: (String) -> Unit,
|
||||
modifier: Modifier = Modifier
|
||||
) {
|
||||
Column(modifier = modifier) {
|
||||
Text(text = stringResource(R.string.label_color), style = MaterialTheme.typography.bodyLarge)
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
Row(
|
||||
modifier = Modifier.fillMaxWidth(),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
horizontalArrangement = Arrangement.SpaceBetween
|
||||
) {
|
||||
Box(
|
||||
modifier = Modifier
|
||||
.size(48.dp)
|
||||
.background(
|
||||
if (selectedColor.isEmpty()) Color.Transparent else Color(android.graphics.Color.parseColor(selectedColor)),
|
||||
CircleShape
|
||||
)
|
||||
.border(2.dp, MaterialTheme.colorScheme.onSurface, CircleShape)
|
||||
.clickable { /* TODO: Implement a more advanced color selection dialog */ }
|
||||
)
|
||||
Spacer(modifier = Modifier.width(16.dp))
|
||||
OutlinedTextField(
|
||||
value = selectedColor,
|
||||
onValueChange = { newValue ->
|
||||
// Basic validation for hex color
|
||||
if (newValue.matches(Regex("^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$"))) {
|
||||
onColorSelected(newValue)
|
||||
} else if (newValue.isEmpty() || newValue == "#") {
|
||||
onColorSelected("#FFFFFF") // Default to white if input is cleared
|
||||
}
|
||||
},
|
||||
label = { Text(stringResource(R.string.label_hex_color)) },
|
||||
singleLine = true,
|
||||
modifier = Modifier.weight(1f)
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('ColorPicker')]
|
||||
// [END_FILE_ColorPicker.kt]
|
||||
@@ -0,0 +1,34 @@
|
||||
// [FILE] LoadingOverlay.kt
|
||||
// [SEMANTICS] app, ui, component, loading
|
||||
|
||||
package com.homebox.lens.ui.components
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.background
|
||||
import androidx.compose.foundation.layout.Box
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.material3.CircularProgressIndicator
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.graphics.Color
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('LoadingOverlay')]
|
||||
/**
|
||||
* @summary A full-screen overlay with a loading indicator.
|
||||
*/
|
||||
@Composable
|
||||
fun LoadingOverlay() {
|
||||
Box(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.background(MaterialTheme.colorScheme.surface.copy(alpha = 0.6f)),
|
||||
contentAlignment = Alignment.Center
|
||||
) {
|
||||
CircularProgressIndicator()
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LoadingOverlay')]
|
||||
// [END_FILE_LoadingOverlay.kt]
|
||||
62
app/src/main/java/com/homebox/lens/ui/mapper/ItemMapper.kt
Normal file
62
app/src/main/java/com/homebox/lens/ui/mapper/ItemMapper.kt
Normal file
@@ -0,0 +1,62 @@
|
||||
// [FILE] ItemMapper.kt
|
||||
// [SEMANTICS] app, ui, mapper, item
|
||||
package com.homebox.lens.ui.mapper
|
||||
|
||||
import com.homebox.lens.domain.model.Item
|
||||
import com.homebox.lens.domain.model.ItemOut
|
||||
import com.homebox.lens.domain.model.Label
|
||||
import com.homebox.lens.domain.model.Location
|
||||
import javax.inject.Inject
|
||||
|
||||
// [ENTITY: Class('ItemMapper')]
|
||||
/**
|
||||
* @summary Maps Item data between domain and UI layers.
|
||||
* @invariant This class is stateless and its methods are pure functions.
|
||||
*/
|
||||
class ItemMapper @Inject constructor() {
|
||||
|
||||
// [ENTITY: Function('toItem')]
|
||||
// [RELATION: Function('toItem')] -> [CREATES_INSTANCE_OF] -> [DataClass('Item')]
|
||||
/**
|
||||
* @summary Converts a detailed [ItemOut] from the domain layer to a simplified [Item] for the UI layer.
|
||||
* @param itemOut The [ItemOut] object to convert.
|
||||
* @return The resulting [Item] object.
|
||||
* @precondition itemOut MUST NOT be null.
|
||||
* @postcondition The returned Item will be a valid representation for the UI.
|
||||
*/
|
||||
fun toItem(itemOut: ItemOut): Item {
|
||||
return Item(
|
||||
id = itemOut.id,
|
||||
name = itemOut.name,
|
||||
description = itemOut.description,
|
||||
quantity = itemOut.quantity,
|
||||
image = itemOut.images.firstOrNull { it.isPrimary }?.path,
|
||||
location = itemOut.location?.let { Location(it.id, it.name) },
|
||||
labels = itemOut.labels.map { Label(it.id, it.name) },
|
||||
purchasePrice = itemOut.purchasePrice,
|
||||
createdAt = itemOut.createdAt,
|
||||
archived = itemOut.isArchived,
|
||||
assetId = itemOut.assetId,
|
||||
fields = itemOut.fields.map { com.homebox.lens.domain.model.CustomField(it.name, it.value, it.type) },
|
||||
insured = itemOut.insured ?: false,
|
||||
lifetimeWarranty = itemOut.lifetimeWarranty ?: false,
|
||||
manufacturer = itemOut.manufacturer,
|
||||
modelNumber = itemOut.modelNumber,
|
||||
notes = itemOut.notes,
|
||||
parentId = itemOut.parent?.id,
|
||||
purchaseFrom = itemOut.purchaseFrom,
|
||||
purchaseTime = itemOut.purchaseTime,
|
||||
serialNumber = itemOut.serialNumber,
|
||||
soldNotes = itemOut.soldNotes,
|
||||
soldPrice = itemOut.soldPrice,
|
||||
soldTime = itemOut.soldTime,
|
||||
soldTo = itemOut.soldTo,
|
||||
syncChildItemsLocations = itemOut.syncChildItemsLocations ?: false,
|
||||
warrantyDetails = itemOut.warrantyDetails,
|
||||
warrantyExpires = itemOut.warrantyExpires
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('toItem')]
|
||||
}
|
||||
// [END_ENTITY: Class('ItemMapper')]
|
||||
// [END_FILE_ItemMapper.kt]
|
||||
@@ -0,0 +1,356 @@
|
||||
// [FILE] DashboardScreen.kt
|
||||
// [SEMANTICS] app, ui, screen, dashboard
|
||||
package com.homebox.lens.ui.screen.dashboard
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.background
|
||||
import androidx.compose.foundation.layout.*
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.LazyRow
|
||||
import androidx.compose.foundation.lazy.grid.GridCells
|
||||
import androidx.compose.foundation.lazy.grid.LazyVerticalGrid
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.filled.Search
|
||||
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.stringResource
|
||||
import androidx.compose.ui.text.style.TextAlign
|
||||
import androidx.compose.ui.tooling.preview.Preview
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.domain.model.*
|
||||
import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.ui.common.MainScaffold
|
||||
import com.homebox.lens.ui.theme.HomeboxLensTheme
|
||||
import timber.log.Timber
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('DashboardScreen')]
|
||||
// [RELATION: Function('DashboardScreen')] -> [DEPENDS_ON] -> [ViewModel('DashboardViewModel')]
|
||||
// [RELATION: Function('DashboardScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('DashboardScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* @summary The main Composable function for the "Dashboard" screen.
|
||||
* @param viewModel The ViewModel for this screen, provided by Hilt.
|
||||
* @param currentRoute The current route to highlight the active item in the Drawer.
|
||||
* @param navigationActions The object with navigation actions.
|
||||
* @sideeffect Calls navigation lambdas upon UI interaction.
|
||||
*/
|
||||
@Composable
|
||||
fun DashboardScreen(
|
||||
viewModel: DashboardViewModel = hiltViewModel(),
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions
|
||||
) {
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.dashboard_title),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions,
|
||||
topBarActions = {
|
||||
IconButton(onClick = { navigationActions.navigateToSearch() }) {
|
||||
Icon(
|
||||
Icons.Default.Search,
|
||||
contentDescription = stringResource(id = R.string.cd_scan_qr_code) // [AI_NOTE]: Rename string resource
|
||||
)
|
||||
}
|
||||
}
|
||||
) { paddingValues ->
|
||||
DashboardContent(
|
||||
modifier = Modifier.padding(paddingValues),
|
||||
uiState = uiState,
|
||||
onLocationClick = { location ->
|
||||
Timber.i("[INFO][ACTION][navigate_to_inventory_with_location] Location chip clicked: ${location.id}. Navigating...")
|
||||
navigationActions.navigateToInventoryListWithLocation(location.id)
|
||||
},
|
||||
onLabelClick = { label ->
|
||||
Timber.i("[INFO][ACTION][navigate_to_inventory_with_label] Label chip clicked: ${label.id}. Navigating...")
|
||||
navigationActions.navigateToInventoryListWithLabel(label.id)
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('DashboardScreen')]
|
||||
|
||||
// [ENTITY: Function('DashboardContent')]
|
||||
// [RELATION: Function('DashboardContent')] -> [CONSUMES_STATE] -> [SealedInterface('DashboardUiState')]
|
||||
/**
|
||||
* @summary Displays the main content of the screen depending on the uiState.
|
||||
* @param modifier A modifier for styling.
|
||||
* @param uiState The current UI state of the screen.
|
||||
* @param onLocationClick A lambda handler for clicking on a location.
|
||||
* @param onLabelClick A lambda handler for clicking on a label.
|
||||
*/
|
||||
@Composable
|
||||
private fun DashboardContent(
|
||||
modifier: Modifier = Modifier,
|
||||
uiState: DashboardUiState,
|
||||
onLocationClick: (LocationOutCount) -> Unit,
|
||||
onLabelClick: (LabelOut) -> Unit
|
||||
) {
|
||||
when (uiState) {
|
||||
is DashboardUiState.Loading -> {
|
||||
Box(modifier = Modifier.fillMaxSize(), contentAlignment = Alignment.Center) {
|
||||
CircularProgressIndicator()
|
||||
}
|
||||
}
|
||||
is DashboardUiState.Error -> {
|
||||
Box(modifier = Modifier.fillMaxSize().padding(16.dp), contentAlignment = Alignment.Center) {
|
||||
Text(
|
||||
text = uiState.message,
|
||||
color = MaterialTheme.colorScheme.error,
|
||||
textAlign = TextAlign.Center
|
||||
)
|
||||
}
|
||||
}
|
||||
is DashboardUiState.Success -> {
|
||||
LazyColumn(
|
||||
modifier = modifier
|
||||
.fillMaxSize()
|
||||
.padding(horizontal = 16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(24.dp)
|
||||
) {
|
||||
item { Spacer(modifier = Modifier.height(8.dp)) }
|
||||
item { StatisticsSection(statistics = uiState.statistics) }
|
||||
item { RecentlyAddedSection(items = uiState.recentlyAddedItems) }
|
||||
item { LocationsSection(locations = uiState.locations, onLocationClick = onLocationClick) }
|
||||
item { LabelsSection(labels = uiState.labels, onLabelClick = onLabelClick) }
|
||||
item { Spacer(modifier = Modifier.height(16.dp)) }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('DashboardContent')]
|
||||
|
||||
// [ENTITY: Function('StatisticsSection')]
|
||||
// [RELATION: Function('StatisticsSection')] -> [DEPENDS_ON] -> [DataClass('GroupStatistics')]
|
||||
/**
|
||||
* @summary Section for displaying general statistics.
|
||||
* @param statistics The object with statistical data.
|
||||
*/
|
||||
@Composable
|
||||
private fun StatisticsSection(statistics: GroupStatistics) {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.dashboard_section_quick_stats),
|
||||
style = MaterialTheme.typography.titleMedium
|
||||
)
|
||||
Card {
|
||||
LazyVerticalGrid(
|
||||
columns = GridCells.Fixed(2),
|
||||
modifier = Modifier
|
||||
.height(120.dp)
|
||||
.fillMaxWidth()
|
||||
.padding(16.dp),
|
||||
horizontalArrangement = Arrangement.spacedBy(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(16.dp)
|
||||
) {
|
||||
item { StatisticCard(title = stringResource(id = R.string.dashboard_stat_total_items), value = statistics.items.toString()) }
|
||||
item { StatisticCard(title = stringResource(id = R.string.dashboard_stat_total_value), value = statistics.totalValue.toString()) }
|
||||
item { StatisticCard(title = stringResource(id = R.string.dashboard_stat_total_labels), value = statistics.labels.toString()) }
|
||||
item { StatisticCard(title = stringResource(id = R.string.dashboard_stat_total_locations), value = statistics.locations.toString()) }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('StatisticsSection')]
|
||||
|
||||
// [ENTITY: Function('StatisticCard')]
|
||||
/**
|
||||
* @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) {
|
||||
Column(horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.Center) {
|
||||
Text(text = title, style = MaterialTheme.typography.labelMedium, textAlign = TextAlign.Center)
|
||||
Text(text = value, style = MaterialTheme.typography.headlineSmall, textAlign = TextAlign.Center)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('StatisticCard')]
|
||||
|
||||
// [ENTITY: Function('RecentlyAddedSection')]
|
||||
// [RELATION: Function('RecentlyAddedSection')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
|
||||
/**
|
||||
* @summary Section for displaying recently added items.
|
||||
* @param items The list of items to display.
|
||||
*/
|
||||
@Composable
|
||||
private fun RecentlyAddedSection(items: List<ItemSummary>) {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.dashboard_section_recently_added),
|
||||
style = MaterialTheme.typography.titleMedium
|
||||
)
|
||||
if (items.isEmpty()) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.items_not_found),
|
||||
style = MaterialTheme.typography.bodyMedium,
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.padding(vertical = 16.dp),
|
||||
textAlign = TextAlign.Center
|
||||
)
|
||||
} else {
|
||||
LazyRow(horizontalArrangement = Arrangement.spacedBy(16.dp)) {
|
||||
items(items) { item ->
|
||||
ItemCard(item = item)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('RecentlyAddedSection')]
|
||||
|
||||
// [ENTITY: Function('ItemCard')]
|
||||
// [RELATION: Function('ItemCard')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
|
||||
/**
|
||||
* @summary Card for displaying brief information about an item.
|
||||
* @param item The item to display.
|
||||
*/
|
||||
@Composable
|
||||
private fun ItemCard(item: ItemSummary) {
|
||||
Card(modifier = Modifier.width(150.dp)) {
|
||||
Column(modifier = Modifier.padding(8.dp)) {
|
||||
// [AI_NOTE]: Add image here from item.image
|
||||
Spacer(modifier = Modifier
|
||||
.height(80.dp)
|
||||
.fillMaxWidth()
|
||||
.background(MaterialTheme.colorScheme.secondaryContainer))
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
Text(text = item.name, style = MaterialTheme.typography.titleSmall, maxLines = 1)
|
||||
Text(text = item.location?.name ?: stringResource(id = R.string.no_location), style = MaterialTheme.typography.bodySmall, maxLines = 1)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('ItemCard')]
|
||||
|
||||
// [ENTITY: Function('LocationsSection')]
|
||||
// [RELATION: Function('LocationsSection')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
|
||||
/**
|
||||
* @summary Section for displaying locations as chips.
|
||||
* @param locations The list of locations.
|
||||
* @param onLocationClick A lambda handler for clicking on a location.
|
||||
*/
|
||||
@OptIn(ExperimentalLayoutApi::class)
|
||||
@Composable
|
||||
private fun LocationsSection(locations: List<LocationOutCount>, onLocationClick: (LocationOutCount) -> Unit) {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.dashboard_section_locations),
|
||||
style = MaterialTheme.typography.titleMedium
|
||||
)
|
||||
FlowRow(
|
||||
horizontalArrangement = Arrangement.spacedBy(8.dp),
|
||||
) {
|
||||
locations.forEach { location ->
|
||||
SuggestionChip(
|
||||
onClick = { onLocationClick(location) },
|
||||
label = { Text(stringResource(id = R.string.location_chip_label, location.name, location.itemCount)) }
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsSection')]
|
||||
|
||||
// [ENTITY: Function('LabelsSection')]
|
||||
// [RELATION: Function('LabelsSection')] -> [DEPENDS_ON] -> [DataClass('LabelOut')]
|
||||
/**
|
||||
* @summary Section for displaying labels as chips.
|
||||
* @param labels The list of labels.
|
||||
* @param onLabelClick A lambda handler for clicking on a label.
|
||||
*/
|
||||
@OptIn(ExperimentalLayoutApi::class)
|
||||
@Composable
|
||||
private fun LabelsSection(labels: List<LabelOut>, onLabelClick: (LabelOut) -> Unit) {
|
||||
Column(verticalArrangement = Arrangement.spacedBy(8.dp)) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.dashboard_section_labels),
|
||||
style = MaterialTheme.typography.titleMedium
|
||||
)
|
||||
FlowRow(
|
||||
horizontalArrangement = Arrangement.spacedBy(8.dp),
|
||||
) {
|
||||
labels.forEach { label ->
|
||||
SuggestionChip(
|
||||
onClick = { onLabelClick(label) },
|
||||
label = { Text(label.name) }
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LabelsSection')]
|
||||
|
||||
// [ENTITY: Function('DashboardContentSuccessPreview')]
|
||||
@Preview(showBackground = true, name = "Dashboard Success State")
|
||||
@Composable
|
||||
fun DashboardContentSuccessPreview() {
|
||||
val previewState = DashboardUiState.Success(
|
||||
statistics = GroupStatistics(
|
||||
items = 123,
|
||||
totalValue = 9999.99,
|
||||
locations = 5,
|
||||
labels = 8
|
||||
),
|
||||
locations = listOf(
|
||||
LocationOutCount(id="1", name="Office", color = "#FF0000", isArchived = false, itemCount = 10, createdAt = "", updatedAt = ""),
|
||||
LocationOutCount(id="2", name="Garage", color = "#00FF00", isArchived = false, itemCount = 5, createdAt = "", updatedAt = ""),
|
||||
LocationOutCount(id="3",name="Living Room", color = "#0000FF", isArchived = false, itemCount = 15, createdAt = "", updatedAt = ""),
|
||||
LocationOutCount(id="4",name="Kitchen", color = "#FFFF00", isArchived = false, itemCount = 20, createdAt = "", updatedAt = ""),
|
||||
LocationOutCount(id="5",name="Basement", color = "#00FFFF", isArchived = false, itemCount = 3, createdAt = "", updatedAt = "")
|
||||
),
|
||||
labels = listOf(
|
||||
LabelOut(id="1", name="electronics", description = null, color = "#FF0000", isArchived = false, createdAt = "", updatedAt = ""),
|
||||
LabelOut(id="2", name="important", description = null, color = "#00FF00", isArchived = false, createdAt = "", updatedAt = ""),
|
||||
LabelOut(id="3", name="seasonal", description = null, color = "#0000FF", isArchived = false, createdAt = "", updatedAt = ""),
|
||||
LabelOut(id="4", name="hobby", description = null, color = "#FFFF00", isArchived = false, createdAt = "", updatedAt = "")
|
||||
),
|
||||
recentlyAddedItems = emptyList()
|
||||
)
|
||||
HomeboxLensTheme {
|
||||
DashboardContent(
|
||||
uiState = previewState,
|
||||
onLocationClick = {},
|
||||
onLabelClick = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('DashboardContentSuccessPreview')]
|
||||
|
||||
// [ENTITY: Function('DashboardContentLoadingPreview')]
|
||||
@Preview(showBackground = true, name = "Dashboard Loading State")
|
||||
@Composable
|
||||
fun DashboardContentLoadingPreview() {
|
||||
HomeboxLensTheme {
|
||||
DashboardContent(
|
||||
uiState = DashboardUiState.Loading,
|
||||
onLocationClick = {},
|
||||
onLabelClick = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('DashboardContentLoadingPreview')]
|
||||
|
||||
// [ENTITY: Function('DashboardContentErrorPreview')]
|
||||
@Preview(showBackground = true, name = "Dashboard Error State")
|
||||
@Composable
|
||||
fun DashboardContentErrorPreview() {
|
||||
HomeboxLensTheme {
|
||||
DashboardContent(
|
||||
uiState = DashboardUiState.Error(stringResource(id = R.string.error_loading_failed)),
|
||||
onLocationClick = {},
|
||||
onLabelClick = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('DashboardContentErrorPreview')]
|
||||
// [END_FILE_DashboardScreen.kt]
|
||||
@@ -0,0 +1,54 @@
|
||||
// [FILE] DashboardUiState.kt
|
||||
// [SEMANTICS] app, ui, state, dashboard
|
||||
package com.homebox.lens.ui.screen.dashboard
|
||||
|
||||
// [IMPORTS]
|
||||
import com.homebox.lens.domain.model.GroupStatistics
|
||||
import com.homebox.lens.domain.model.ItemSummary
|
||||
import com.homebox.lens.domain.model.LabelOut
|
||||
import com.homebox.lens.domain.model.LocationOutCount
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: SealedInterface('DashboardUiState')]
|
||||
/**
|
||||
* @summary Defines all possible states for the "Dashboard" screen.
|
||||
* @invariant At any given time, the screen can only be in one of these states.
|
||||
*/
|
||||
sealed interface DashboardUiState {
|
||||
// [ENTITY: DataClass('Success')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('GroupStatistics')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('LabelOut')]
|
||||
// [RELATION: DataClass('Success')] -> [DEPENDS_ON] -> [DataClass('ItemSummary')]
|
||||
/**
|
||||
* @summary The state of a successful data load.
|
||||
* @param statistics The inventory statistics.
|
||||
* @param locations The list of locations with counters.
|
||||
* @param labels The list of all labels.
|
||||
* @param recentlyAddedItems The list of recently added items.
|
||||
*/
|
||||
data class Success(
|
||||
val statistics: GroupStatistics,
|
||||
val locations: List<LocationOutCount>,
|
||||
val labels: List<LabelOut>,
|
||||
val recentlyAddedItems: List<ItemSummary>
|
||||
) : DashboardUiState
|
||||
// [END_ENTITY: DataClass('Success')]
|
||||
|
||||
// [ENTITY: DataClass('Error')]
|
||||
/**
|
||||
* @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 The state when data for the screen is being loaded.
|
||||
*/
|
||||
data object Loading : DashboardUiState
|
||||
// [END_ENTITY: Object('Loading')]
|
||||
}
|
||||
// [END_ENTITY: SealedInterface('DashboardUiState')]
|
||||
// [END_FILE_DashboardUiState.kt]
|
||||
@@ -0,0 +1,84 @@
|
||||
// [FILE] DashboardViewModel.kt
|
||||
// [SEMANTICS] app, ui, viewmodel, dashboard
|
||||
package com.homebox.lens.ui.screen.dashboard
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.homebox.lens.domain.usecase.GetAllLabelsUseCase
|
||||
import com.homebox.lens.domain.usecase.GetAllLocationsUseCase
|
||||
import com.homebox.lens.domain.usecase.GetRecentlyAddedItemsUseCase
|
||||
import com.homebox.lens.domain.usecase.GetStatisticsUseCase
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.*
|
||||
import kotlinx.coroutines.launch
|
||||
import timber.log.Timber
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: ViewModel('DashboardViewModel')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetStatisticsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLocationsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLabelsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [DEPENDS_ON] -> [UseCase('GetRecentlyAddedItemsUseCase')]
|
||||
// [RELATION: ViewModel('DashboardViewModel')] -> [EMITS_STATE] -> [SealedInterface('DashboardUiState')]
|
||||
/**
|
||||
* @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(
|
||||
private val getStatisticsUseCase: GetStatisticsUseCase,
|
||||
private val getAllLocationsUseCase: GetAllLocationsUseCase,
|
||||
private val getAllLabelsUseCase: GetAllLabelsUseCase,
|
||||
private val getRecentlyAddedItemsUseCase: GetRecentlyAddedItemsUseCase
|
||||
) : ViewModel() {
|
||||
|
||||
private val _uiState = MutableStateFlow<DashboardUiState>(DashboardUiState.Loading)
|
||||
val uiState = _uiState.asStateFlow()
|
||||
|
||||
init {
|
||||
loadDashboardData()
|
||||
}
|
||||
|
||||
// [ENTITY: Function('loadDashboardData')]
|
||||
/**
|
||||
* @summary Loads all necessary data for the Dashboard screen.
|
||||
* @description Executes UseCases in parallel and updates the UI by switching it
|
||||
* between the `Loading`, `Success`, and `Error` states from `DashboardUiState`.
|
||||
* @sideeffect Asynchronously updates `_uiState` with one of the `DashboardUiState` states.
|
||||
*/
|
||||
fun loadDashboardData() {
|
||||
viewModelScope.launch {
|
||||
_uiState.value = DashboardUiState.Loading
|
||||
Timber.i("[INFO][ENTRYPOINT][loading_dashboard_data] Starting dashboard data collection.")
|
||||
|
||||
val statsFlow = flow { emit(getStatisticsUseCase()) }
|
||||
val locationsFlow = flow { emit(getAllLocationsUseCase()) }
|
||||
val labelsFlow = flow { emit(getAllLabelsUseCase()) }
|
||||
val recentItemsFlow = getRecentlyAddedItemsUseCase(limit = 10)
|
||||
|
||||
combine(statsFlow, locationsFlow, labelsFlow, recentItemsFlow) { stats, locations, labels, recentItems ->
|
||||
DashboardUiState.Success(
|
||||
statistics = stats,
|
||||
locations = locations,
|
||||
labels = labels,
|
||||
recentlyAddedItems = recentItems
|
||||
)
|
||||
}.catch { exception ->
|
||||
Timber.e(exception, "[ERROR][EXCEPTION][loading_failed] Failed to load dashboard data. State -> Error.")
|
||||
_uiState.value = DashboardUiState.Error(
|
||||
message = exception.message ?: "Could not load dashboard data."
|
||||
)
|
||||
}.collect { successState ->
|
||||
Timber.i("[INFO][SUCCESS][dashboard_data_loaded] Dashboard data loaded successfully. State -> Success.")
|
||||
_uiState.value = successState
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('loadDashboardData')]
|
||||
}
|
||||
// [END_ENTITY: ViewModel('DashboardViewModel')]
|
||||
// [END_FILE_DashboardViewModel.kt]
|
||||
@@ -0,0 +1,38 @@
|
||||
// [FILE] ItemDetailsScreen.kt
|
||||
// [SEMANTICS] app, ui, screen, details
|
||||
|
||||
package com.homebox.lens.ui.screen.itemdetails
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
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('ItemDetailsScreen')]
|
||||
// [RELATION: Function('ItemDetailsScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('ItemDetailsScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* @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(
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions
|
||||
) {
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.item_details_title),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) {
|
||||
// [AI_NOTE]: Implement Item Details Screen UI
|
||||
Text(text = "Item Details Screen")
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('ItemDetailsScreen')]
|
||||
// [END_FILE_ItemDetailsScreen.kt]
|
||||
@@ -0,0 +1,20 @@
|
||||
// [FILE] ItemDetailsViewModel.kt
|
||||
// [SEMANTICS] app, ui, viewmodel, details
|
||||
package com.homebox.lens.ui.screen.itemdetails
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: ViewModel('ItemDetailsViewModel')]
|
||||
/**
|
||||
* @summary ViewModel for the item details screen.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class ItemDetailsViewModel @Inject constructor() : ViewModel() {
|
||||
// [AI_NOTE]: Implement UI state
|
||||
}
|
||||
// [END_ENTITY: ViewModel('ItemDetailsViewModel')]
|
||||
// [END_FILE_ItemDetailsViewModel.kt]
|
||||
@@ -0,0 +1,606 @@
|
||||
// [FILE] ItemEditScreen.kt
|
||||
// [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: 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 function for the "Edit Item" screen.
|
||||
* @param currentRoute The current route to highlight the active item in the Drawer.
|
||||
* @param navigationActions The object with navigation actions.
|
||||
* @param itemId The ID of the item to edit. Null if a new item is being created.
|
||||
* @param viewModel The ViewModel for managing the screen's state.
|
||||
* @param onSaveSuccess A callback invoked after the item is successfully saved.
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
fun ItemEditScreen(
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions,
|
||||
itemId: String?,
|
||||
viewModel: ItemEditViewModel = hiltViewModel(),
|
||||
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
|
||||
) { 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: Composable('ItemEditScreen')]
|
||||
// [END_FILE_ItemEditScreen.kt]
|
||||
@@ -0,0 +1,514 @@
|
||||
// [FILE] ItemEditViewModel.kt
|
||||
// [SEMANTICS] app, ui, viewmodel, edit
|
||||
|
||||
package com.homebox.lens.ui.screen.itemedit
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.homebox.lens.domain.model.Item
|
||||
import com.homebox.lens.domain.model.ItemCreate
|
||||
import com.homebox.lens.domain.model.ItemUpdate
|
||||
import com.homebox.lens.domain.model.Location
|
||||
import com.homebox.lens.domain.model.Label
|
||||
import com.homebox.lens.domain.usecase.CreateItemUseCase
|
||||
import com.homebox.lens.domain.usecase.GetAllLabelsUseCase
|
||||
import com.homebox.lens.domain.usecase.GetAllLocationsUseCase
|
||||
import com.homebox.lens.domain.usecase.GetItemDetailsUseCase
|
||||
import com.homebox.lens.data.mapper.toDomain
|
||||
import com.homebox.lens.domain.usecase.UpdateItemUseCase
|
||||
import com.homebox.lens.ui.mapper.ItemMapper
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import 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(
|
||||
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]
|
||||
@@ -0,0 +1,169 @@
|
||||
// [FILE] LabelsListScreen.kt
|
||||
// [SEMANTICS] app, ui, screen, list, label
|
||||
package com.homebox.lens.ui.screen.labelslist
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Box
|
||||
import androidx.compose.foundation.layout.PaddingValues
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
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.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.Scaffold
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.material3.TopAppBar
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.collectAsState
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.ui.Alignment
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.domain.model.Label
|
||||
import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.ui.navigation.Screen
|
||||
import com.homebox.lens.ui.common.MainScaffold
|
||||
import timber.log.Timber
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('LabelsListScreen')]
|
||||
// [RELATION: Function('LabelsListScreen')] -> [DEPENDS_ON] -> [ViewModel('LabelsListViewModel')]
|
||||
// [RELATION: Function('LabelsListScreen')] -> [DEPENDS_ON] -> [Framework('NavController')]
|
||||
/**
|
||||
* @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(
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions,
|
||||
viewModel: LabelsListViewModel = hiltViewModel()
|
||||
) {
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.screen_title_labels),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) { paddingValues ->
|
||||
Scaffold(
|
||||
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(innerPaddingValues), // Use innerPaddingValues here
|
||||
contentAlignment = Alignment.Center
|
||||
) {
|
||||
when (val state = uiState) {
|
||||
is LabelsListUiState.Loading -> {
|
||||
CircularProgressIndicator()
|
||||
}
|
||||
is LabelsListUiState.Error -> {
|
||||
Text(text = state.message)
|
||||
}
|
||||
is LabelsListUiState.Success -> {
|
||||
if (state.labels.isEmpty()) {
|
||||
Text(text = stringResource(id = R.string.no_labels_found))
|
||||
} else {
|
||||
LabelsList(
|
||||
labels = state.labels,
|
||||
onLabelClick = { label ->
|
||||
Timber.i("[INFO][ACTION][navigate_to_label_edit] Label clicked: ${label.id}. Navigating to label edit screen.")
|
||||
navigationActions.navigateToLabelEdit(label.id)
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LabelsListScreen')]
|
||||
|
||||
// [ENTITY: Function('LabelsList')]
|
||||
// [RELATION: Function('LabelsList')] -> [DEPENDS_ON] -> [DataClass('Label')]
|
||||
/**
|
||||
* @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(
|
||||
labels: List<Label>,
|
||||
onLabelClick: (Label) -> Unit,
|
||||
modifier: Modifier = Modifier
|
||||
) {
|
||||
LazyColumn(
|
||||
modifier = modifier.fillMaxSize(),
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(8.dp)
|
||||
) {
|
||||
items(labels, key = { it.id }) { label ->
|
||||
LabelListItem(
|
||||
label = label,
|
||||
onClick = { onLabelClick(label) }
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LabelsList')]
|
||||
|
||||
// [ENTITY: Function('LabelListItem')]
|
||||
// [RELATION: Function('LabelListItem')] -> [DEPENDS_ON] -> [DataClass('Label')]
|
||||
/**
|
||||
* @summary Composable function for displaying a single item in the list of labels.
|
||||
* @param label The `Label` object to display.
|
||||
* @param onClick A lambda function called when the item is clicked.
|
||||
*/
|
||||
@Composable
|
||||
private fun LabelListItem(
|
||||
label: Label,
|
||||
onClick: () -> Unit
|
||||
) {
|
||||
ListItem(
|
||||
headlineContent = { Text(text = label.name) },
|
||||
leadingContent = {
|
||||
Icon(
|
||||
imageVector = Icons.AutoMirrored.Filled.Label,
|
||||
contentDescription = stringResource(id = R.string.content_desc_label_icon)
|
||||
)
|
||||
},
|
||||
modifier = Modifier.clickable(onClick = onClick)
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('LabelListItem')]
|
||||
|
||||
// [END_FILE_LabelsListScreen.kt]
|
||||
@@ -0,0 +1,47 @@
|
||||
// [FILE] LabelsListUiState.kt
|
||||
// [SEMANTICS] app, ui, state, list, label
|
||||
package com.homebox.lens.ui.screen.labelslist
|
||||
|
||||
// [IMPORTS]
|
||||
import com.homebox.lens.domain.model.Label
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: SealedInterface('LabelsListUiState')]
|
||||
/**
|
||||
* @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 The success state, contains the list of labels and the state of the dialog.
|
||||
* @param labels The list of labels to display.
|
||||
* @param isShowingCreateDialog A flag indicating whether the label creation dialog should be displayed.
|
||||
* @invariant labels cannot be null.
|
||||
*/
|
||||
data class Success(
|
||||
val labels: List<Label>,
|
||||
val isShowingCreateDialog: Boolean = false
|
||||
) : LabelsListUiState
|
||||
// [END_ENTITY: DataClass('Success')]
|
||||
|
||||
// [ENTITY: DataClass('Error')]
|
||||
/**
|
||||
* @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 The data loading state.
|
||||
* @description Indicates that the process of loading labels is in progress.
|
||||
*/
|
||||
data object Loading : LabelsListUiState
|
||||
// [END_ENTITY: Object('Loading')]
|
||||
}
|
||||
// [END_ENTITY: SealedInterface('LabelsListUiState')]
|
||||
// [END_FILE_LabelsListUiState.kt]
|
||||
@@ -0,0 +1,130 @@
|
||||
// [FILE] LabelsListViewModel.kt
|
||||
// [SEMANTICS] app, ui, viewmodel, list, label
|
||||
package com.homebox.lens.ui.screen.labelslist
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.homebox.lens.domain.model.Label
|
||||
import com.homebox.lens.domain.usecase.GetAllLabelsUseCase
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.update
|
||||
import kotlinx.coroutines.launch
|
||||
import timber.log.Timber
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: ViewModel('LabelsListViewModel')]
|
||||
// [RELATION: ViewModel('LabelsListViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLabelsUseCase')]
|
||||
// [RELATION: ViewModel('LabelsListViewModel')] -> [EMITS_STATE] -> [SealedInterface('LabelsListUiState')]
|
||||
/**
|
||||
* @summary ViewModel for the screen with a list of labels.
|
||||
* @description Manages the screen state, loads the list of labels, handles errors, and manages the dialog for creating a new label.
|
||||
* @invariant `uiState` is always one of the states defined in `LabelsListUiState`.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class LabelsListViewModel @Inject constructor(
|
||||
private val getAllLabelsUseCase: GetAllLabelsUseCase
|
||||
) : ViewModel() {
|
||||
|
||||
private val _uiState = MutableStateFlow<LabelsListUiState>(LabelsListUiState.Loading)
|
||||
val uiState = _uiState.asStateFlow()
|
||||
|
||||
init {
|
||||
loadLabels()
|
||||
}
|
||||
|
||||
// [ENTITY: Function('loadLabels')]
|
||||
/**
|
||||
* @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 {
|
||||
_uiState.value = LabelsListUiState.Loading
|
||||
Timber.i("[INFO][ENTRYPOINT][loading_labels] Starting labels list load. State -> Loading.")
|
||||
|
||||
val result = runCatching {
|
||||
getAllLabelsUseCase()
|
||||
}
|
||||
|
||||
result.fold(
|
||||
onSuccess = { labelOuts ->
|
||||
Timber.i("[INFO][SUCCESS][labels_loaded] Labels loaded successfully. Count: ${labelOuts.size}. State -> Success.")
|
||||
val labels = labelOuts.map { labelOut ->
|
||||
Label(
|
||||
id = labelOut.id,
|
||||
name = labelOut.name
|
||||
)
|
||||
}
|
||||
_uiState.value = LabelsListUiState.Success(labels, isShowingCreateDialog = false)
|
||||
},
|
||||
onFailure = { exception ->
|
||||
Timber.e(exception, "[ERROR][EXCEPTION][loading_failed] Failed to load labels. State -> Error.")
|
||||
_uiState.value = LabelsListUiState.Error(
|
||||
message = exception.message ?: "Could not load labels."
|
||||
)
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('loadLabels')]
|
||||
|
||||
// [ENTITY: Function('onShowCreateDialog')]
|
||||
/**
|
||||
* @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.")
|
||||
if (_uiState.value is LabelsListUiState.Success) {
|
||||
_uiState.update {
|
||||
(it as LabelsListUiState.Success).copy(isShowingCreateDialog = true)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('onShowCreateDialog')]
|
||||
|
||||
// [ENTITY: Function('onDismissCreateDialog')]
|
||||
/**
|
||||
* @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.")
|
||||
if (_uiState.value is LabelsListUiState.Success) {
|
||||
_uiState.update {
|
||||
(it as LabelsListUiState.Success).copy(isShowingCreateDialog = false)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('onDismissCreateDialog')]
|
||||
|
||||
// [ENTITY: Function('createLabel')]
|
||||
/**
|
||||
* @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." }
|
||||
|
||||
Timber.i("[INFO][ACTION][create_label] Create label called with name: '$name'. [STUBBED]")
|
||||
|
||||
// [AI_NOTE]: Здесь будет вызов CreateLabelUseCase.
|
||||
|
||||
onDismissCreateDialog()
|
||||
}
|
||||
// [END_ENTITY: Function('createLabel')]
|
||||
}
|
||||
// [END_ENTITY: ViewModel('LabelsListViewModel')]
|
||||
// [END_FILE_LabelsListViewModel.kt]
|
||||
@@ -0,0 +1,47 @@
|
||||
// [FILE] LocationEditScreen.kt
|
||||
// [SEMANTICS] app, ui, screen, edit, location
|
||||
|
||||
package com.homebox.lens.ui.screen.locationedit
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.layout.Box
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.material3.Scaffold
|
||||
import androidx.compose.material3.Text
|
||||
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
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('LocationEditScreen')]
|
||||
/**
|
||||
* @summary Composable function for the "Edit Location" screen.
|
||||
* @param locationId The ID of the location to edit, or "new" to create one.
|
||||
*/
|
||||
@Composable
|
||||
fun LocationEditScreen(
|
||||
locationId: String?
|
||||
) {
|
||||
val title = if (locationId == "new") {
|
||||
stringResource(id = R.string.location_edit_title_create)
|
||||
} else {
|
||||
stringResource(id = R.string.location_edit_title_edit)
|
||||
}
|
||||
|
||||
Scaffold { paddingValues ->
|
||||
Box(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.padding(paddingValues),
|
||||
contentAlignment = Alignment.Center
|
||||
) {
|
||||
// [AI_NOTE]: Implement Location Edit Screen UI
|
||||
Text(text = "Location Edit Screen for ID: $locationId")
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationEditScreen')]
|
||||
// [END_FILE_LocationEditScreen.kt]
|
||||
@@ -0,0 +1,295 @@
|
||||
// [FILE] LocationsListScreen.kt
|
||||
// [SEMANTICS] app, ui, screen, list, location
|
||||
|
||||
package com.homebox.lens.ui.screen.locationslist
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.foundation.clickable
|
||||
import androidx.compose.foundation.layout.Arrangement
|
||||
import androidx.compose.foundation.layout.Box
|
||||
import androidx.compose.foundation.layout.Column
|
||||
import androidx.compose.foundation.layout.PaddingValues
|
||||
import androidx.compose.foundation.layout.Row
|
||||
import androidx.compose.foundation.layout.Spacer
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.fillMaxWidth
|
||||
import androidx.compose.foundation.layout.padding
|
||||
import androidx.compose.foundation.layout.width
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.filled.Add
|
||||
import androidx.compose.material.icons.filled.MoreVert
|
||||
import androidx.compose.material3.Card
|
||||
import androidx.compose.material3.CircularProgressIndicator
|
||||
import androidx.compose.material3.DropdownMenu
|
||||
import androidx.compose.material3.DropdownMenuItem
|
||||
import androidx.compose.material3.FloatingActionButton
|
||||
import androidx.compose.material3.Icon
|
||||
import androidx.compose.material3.IconButton
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.Scaffold
|
||||
import androidx.compose.material3.Text
|
||||
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.text.style.TextAlign
|
||||
import androidx.compose.ui.tooling.preview.Preview
|
||||
import androidx.compose.ui.unit.dp
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import com.homebox.lens.R
|
||||
import com.homebox.lens.domain.model.LocationOutCount
|
||||
import com.homebox.lens.navigation.NavigationActions
|
||||
import com.homebox.lens.ui.common.MainScaffold
|
||||
import com.homebox.lens.ui.theme.HomeboxLensTheme
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: Function('LocationsListScreen')]
|
||||
// [RELATION: Function('LocationsListScreen')] -> [DEPENDS_ON] -> [ViewModel('LocationsListViewModel')]
|
||||
// [RELATION: Function('LocationsListScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('LocationsListScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* @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(
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions,
|
||||
onLocationClick: (String) -> Unit,
|
||||
onAddNewLocationClick: () -> Unit,
|
||||
viewModel: LocationsListViewModel = hiltViewModel()
|
||||
) {
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.locations_list_title),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) { paddingValues ->
|
||||
Scaffold(
|
||||
modifier = Modifier.padding(paddingValues),
|
||||
floatingActionButton = {
|
||||
FloatingActionButton(onClick = onAddNewLocationClick) {
|
||||
Icon(
|
||||
Icons.Default.Add,
|
||||
contentDescription = stringResource(id = R.string.cd_add_new_location)
|
||||
)
|
||||
}
|
||||
}
|
||||
) { innerPadding ->
|
||||
LocationsListContent(
|
||||
modifier = Modifier.padding(innerPadding),
|
||||
uiState = uiState,
|
||||
onLocationClick = onLocationClick,
|
||||
onEditLocation = { /* [AI_NOTE]: Implement onEditLocation */ },
|
||||
onDeleteLocation = { /* [AI_NOTE]: Implement onDeleteLocation */ }
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsListScreen')]
|
||||
|
||||
// [ENTITY: Function('LocationsListContent')]
|
||||
// [RELATION: Function('LocationsListContent')] -> [CONSUMES_STATE] -> [SealedInterface('LocationsListUiState')]
|
||||
/**
|
||||
* @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(
|
||||
modifier: Modifier = Modifier,
|
||||
uiState: LocationsListUiState,
|
||||
onLocationClick: (String) -> Unit,
|
||||
onEditLocation: (String) -> Unit,
|
||||
onDeleteLocation: (String) -> Unit
|
||||
) {
|
||||
Box(modifier = modifier.fillMaxSize()) {
|
||||
when (uiState) {
|
||||
is LocationsListUiState.Loading -> {
|
||||
CircularProgressIndicator(modifier = Modifier.align(Alignment.Center))
|
||||
}
|
||||
is LocationsListUiState.Error -> {
|
||||
Text(
|
||||
text = uiState.message,
|
||||
color = MaterialTheme.colorScheme.error,
|
||||
textAlign = TextAlign.Center,
|
||||
modifier = Modifier
|
||||
.align(Alignment.Center)
|
||||
.padding(16.dp)
|
||||
)
|
||||
}
|
||||
is LocationsListUiState.Success -> {
|
||||
if (uiState.locations.isEmpty()) {
|
||||
Text(
|
||||
text = stringResource(id = R.string.locations_not_found),
|
||||
textAlign = TextAlign.Center,
|
||||
modifier = Modifier
|
||||
.align(Alignment.Center)
|
||||
.padding(16.dp)
|
||||
)
|
||||
} else {
|
||||
LazyColumn(
|
||||
contentPadding = PaddingValues(16.dp),
|
||||
verticalArrangement = Arrangement.spacedBy(12.dp)
|
||||
) {
|
||||
items(uiState.locations, key = { it.id }) { location ->
|
||||
LocationCard(
|
||||
location = location,
|
||||
onClick = { onLocationClick(location.id) },
|
||||
onEditClick = { onEditLocation(location.id) },
|
||||
onDeleteClick = { onDeleteLocation(location.id) }
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsListContent')]
|
||||
|
||||
// [ENTITY: Function('LocationCard')]
|
||||
// [RELATION: Function('LocationCard')] -> [DEPENDS_ON] -> [DataClass('LocationOutCount')]
|
||||
/**
|
||||
* @summary Card for displaying a single location.
|
||||
* @param location The data about the location.
|
||||
* @param onClick A lambda handler for clicking on the card.
|
||||
* @param onEditClick A lambda handler for clicking "Edit".
|
||||
* @param onDeleteClick A lambda handler for clicking "Delete".
|
||||
*/
|
||||
@Composable
|
||||
private fun LocationCard(
|
||||
location: LocationOutCount,
|
||||
onClick: () -> Unit,
|
||||
onEditClick: () -> Unit,
|
||||
onDeleteClick: () -> Unit
|
||||
) {
|
||||
var menuExpanded by remember { mutableStateOf(false) }
|
||||
|
||||
Card(
|
||||
modifier = Modifier
|
||||
.fillMaxWidth()
|
||||
.clickable(onClick = onClick)
|
||||
) {
|
||||
Row(
|
||||
modifier = Modifier.padding(start = 16.dp, end = 8.dp, top = 16.dp, bottom = 16.dp),
|
||||
verticalAlignment = Alignment.CenterVertically,
|
||||
horizontalArrangement = Arrangement.SpaceBetween
|
||||
) {
|
||||
Column(modifier = Modifier.weight(1f)) {
|
||||
Text(text = location.name, style = MaterialTheme.typography.titleMedium)
|
||||
Text(
|
||||
text = stringResource(id = R.string.item_count, location.itemCount),
|
||||
style = MaterialTheme.typography.bodyMedium
|
||||
)
|
||||
}
|
||||
Spacer(Modifier.width(16.dp))
|
||||
Box {
|
||||
IconButton(onClick = { menuExpanded = true }) {
|
||||
Icon(Icons.Default.MoreVert, contentDescription = stringResource(id = R.string.cd_more_options))
|
||||
}
|
||||
DropdownMenu(
|
||||
expanded = menuExpanded,
|
||||
onDismissRequest = { menuExpanded = false }
|
||||
) {
|
||||
DropdownMenuItem(
|
||||
text = { Text(stringResource(id = R.string.edit)) },
|
||||
onClick = {
|
||||
menuExpanded = false
|
||||
onEditClick()
|
||||
}
|
||||
)
|
||||
DropdownMenuItem(
|
||||
text = { Text(stringResource(id = R.string.delete)) },
|
||||
onClick = {
|
||||
menuExpanded = false
|
||||
onDeleteClick()
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationCard')]
|
||||
|
||||
// [ENTITY: Function('LocationsListSuccessPreview')]
|
||||
@Preview(showBackground = true, name = "Locations List Success")
|
||||
@Composable
|
||||
fun LocationsListSuccessPreview() {
|
||||
val previewLocations = listOf(
|
||||
LocationOutCount("1", "Garage", "#FF0000", false, 12, "", ""),
|
||||
LocationOutCount("2", "Kitchen", "#00FF00", false, 5, "", ""),
|
||||
LocationOutCount("3", "Office", "#0000FF", false, 23, "", "")
|
||||
)
|
||||
HomeboxLensTheme {
|
||||
LocationsListContent(
|
||||
uiState = LocationsListUiState.Success(previewLocations),
|
||||
onLocationClick = {},
|
||||
onEditLocation = {},
|
||||
onDeleteLocation = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsListSuccessPreview')]
|
||||
|
||||
// [ENTITY: Function('LocationsListEmptyPreview')]
|
||||
@Preview(showBackground = true, name = "Locations List Empty")
|
||||
@Composable
|
||||
fun LocationsListEmptyPreview() {
|
||||
HomeboxLensTheme {
|
||||
LocationsListContent(
|
||||
uiState = LocationsListUiState.Success(emptyList()),
|
||||
onLocationClick = {},
|
||||
onEditLocation = {},
|
||||
onDeleteLocation = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsListEmptyPreview')]
|
||||
|
||||
// [ENTITY: Function('LocationsListLoadingPreview')]
|
||||
@Preview(showBackground = true, name = "Locations List Loading")
|
||||
@Composable
|
||||
fun LocationsListLoadingPreview() {
|
||||
HomeboxLensTheme {
|
||||
LocationsListContent(
|
||||
uiState = LocationsListUiState.Loading,
|
||||
onLocationClick = {},
|
||||
onEditLocation = {},
|
||||
onDeleteLocation = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsListLoadingPreview')]
|
||||
|
||||
// [ENTITY: Function('LocationsListErrorPreview')]
|
||||
@Preview(showBackground = true, name = "Locations List Error")
|
||||
@Composable
|
||||
fun LocationsListErrorPreview() {
|
||||
HomeboxLensTheme {
|
||||
LocationsListContent(
|
||||
uiState = LocationsListUiState.Error("Failed to load locations. Please try again."),
|
||||
onLocationClick = {},
|
||||
onEditLocation = {},
|
||||
onDeleteLocation = {}
|
||||
)
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('LocationsListErrorPreview')]
|
||||
// [END_FILE_LocationsListScreen.kt]
|
||||
@@ -0,0 +1,41 @@
|
||||
// [FILE] LocationsListUiState.kt
|
||||
// [SEMANTICS] app, ui, state, list, location
|
||||
|
||||
package com.homebox.lens.ui.screen.locationslist
|
||||
|
||||
// [IMPORTS]
|
||||
import com.homebox.lens.domain.model.LocationOutCount
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: SealedInterface('LocationsListUiState')]
|
||||
/**
|
||||
* @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 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 The error state.
|
||||
* @param message The error message.
|
||||
*/
|
||||
data class Error(val message: String) : LocationsListUiState
|
||||
// [END_ENTITY: DataClass('Error')]
|
||||
|
||||
// [ENTITY: Object('Loading')]
|
||||
/**
|
||||
* @summary The data loading state.
|
||||
*/
|
||||
object Loading : LocationsListUiState
|
||||
// [END_ENTITY: Object('Loading')]
|
||||
}
|
||||
// [END_ENTITY: SealedInterface('LocationsListUiState')]
|
||||
// [END_FILE_LocationsListUiState.kt]
|
||||
@@ -0,0 +1,63 @@
|
||||
// [FILE] LocationsListViewModel.kt
|
||||
// [SEMANTICS] app, ui, viewmodel, list, location
|
||||
|
||||
package com.homebox.lens.ui.screen.locationslist
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.homebox.lens.domain.usecase.GetAllLocationsUseCase
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.StateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.launch
|
||||
import timber.log.Timber
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: ViewModel('LocationsListViewModel')]
|
||||
// [RELATION: ViewModel('LocationsListViewModel')] -> [DEPENDS_ON] -> [UseCase('GetAllLocationsUseCase')]
|
||||
// [RELATION: ViewModel('LocationsListViewModel')] -> [EMITS_STATE] -> [SealedInterface('LocationsListUiState')]
|
||||
/**
|
||||
* @summary ViewModel for the list of locations screen.
|
||||
* @param getAllLocationsUseCase Use case for getting all locations.
|
||||
* @property uiState A flow containing the current UI state.
|
||||
* @invariant `uiState` always reflects the result of the last load operation.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class LocationsListViewModel @Inject constructor(
|
||||
private val getAllLocationsUseCase: GetAllLocationsUseCase
|
||||
) : ViewModel() {
|
||||
|
||||
private val _uiState = MutableStateFlow<LocationsListUiState>(LocationsListUiState.Loading)
|
||||
val uiState: StateFlow<LocationsListUiState> = _uiState.asStateFlow()
|
||||
|
||||
init {
|
||||
loadLocations()
|
||||
}
|
||||
|
||||
// [ENTITY: Function('loadLocations')]
|
||||
/**
|
||||
* @summary Loads the list of locations from the repository.
|
||||
* @sideeffect Updates `_uiState` depending on the result: Loading -> Success/Error.
|
||||
*/
|
||||
fun loadLocations() {
|
||||
Timber.d("[DEBUG][ENTRYPOINT][loading_locations] Starting to load locations.")
|
||||
viewModelScope.launch {
|
||||
_uiState.value = LocationsListUiState.Loading
|
||||
try {
|
||||
Timber.d("[DEBUG][ACTION][fetching_locations] Fetching locations from use case.")
|
||||
val locations = getAllLocationsUseCase()
|
||||
_uiState.value = LocationsListUiState.Success(locations)
|
||||
Timber.d("[DEBUG][SUCCESS][locations_loaded] Successfully loaded locations.")
|
||||
} catch (e: Exception) {
|
||||
Timber.e(e, "[ERROR][EXCEPTION][loading_failed] Failed to load locations.")
|
||||
_uiState.value = LocationsListUiState.Error(e.message ?: "Unknown error")
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('loadLocations')]
|
||||
}
|
||||
// [END_ENTITY: ViewModel('LocationsListViewModel')]
|
||||
// [END_FILE_LocationsListViewModel.kt]
|
||||
@@ -0,0 +1,38 @@
|
||||
// [FILE] SearchScreen.kt
|
||||
// [SEMANTICS] app, ui, screen, search
|
||||
|
||||
package com.homebox.lens.ui.screen.search
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.material3.Text
|
||||
import androidx.compose.runtime.Composable
|
||||
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('SearchScreen')]
|
||||
// [RELATION: Function('SearchScreen')] -> [DEPENDS_ON] -> [Class('NavigationActions')]
|
||||
// [RELATION: Function('SearchScreen')] -> [CALLS] -> [Function('MainScaffold')]
|
||||
/**
|
||||
* @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(
|
||||
currentRoute: String?,
|
||||
navigationActions: NavigationActions
|
||||
) {
|
||||
MainScaffold(
|
||||
topBarTitle = stringResource(id = R.string.search_title),
|
||||
currentRoute = currentRoute,
|
||||
navigationActions = navigationActions
|
||||
) {
|
||||
// [AI_NOTE]: Implement Search Screen UI
|
||||
Text(text = "Search Screen")
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('SearchScreen')]
|
||||
// [END_FILE_SearchScreen.kt]
|
||||
@@ -0,0 +1,20 @@
|
||||
// [FILE] SearchViewModel.kt
|
||||
// [SEMANTICS] app, ui, viewmodel, search
|
||||
package com.homebox.lens.ui.screen.search
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: ViewModel('SearchViewModel')]
|
||||
/**
|
||||
* @summary ViewModel for the search screen.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class SearchViewModel @Inject constructor() : ViewModel() {
|
||||
// [AI_NOTE]: Implement UI state
|
||||
}
|
||||
// [END_ENTITY: ViewModel('SearchViewModel')]
|
||||
// [END_FILE_SearchViewModel.kt]
|
||||
@@ -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]
|
||||
@@ -0,0 +1,175 @@
|
||||
// [FILE] SetupScreen.kt
|
||||
// [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]
|
||||
|
||||
// [ENTITY: Function('SetupScreen')]
|
||||
// [RELATION: Function('SetupScreen')] -> [DEPENDS_ON] -> [ViewModel('SetupViewModel')]
|
||||
// [RELATION: Function('SetupScreen')] -> [CALLS] -> [Function('SetupScreenContent')]
|
||||
/**
|
||||
* @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(
|
||||
viewModel: SetupViewModel = hiltViewModel(),
|
||||
onSetupComplete: () -> Unit
|
||||
) {
|
||||
val uiState by viewModel.uiState.collectAsState()
|
||||
|
||||
if (uiState.isSetupComplete) {
|
||||
onSetupComplete()
|
||||
}
|
||||
|
||||
SetupScreenContent(
|
||||
uiState = uiState,
|
||||
onServerUrlChange = viewModel::onServerUrlChange,
|
||||
onUsernameChange = viewModel::onUsernameChange,
|
||||
onPasswordChange = viewModel::onPasswordChange,
|
||||
onConnectClick = viewModel::connect
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('SetupScreen')]
|
||||
|
||||
// [ENTITY: Function('SetupScreenContent')]
|
||||
// [RELATION: Function('SetupScreenContent')] -> [CONSUMES_STATE] -> [DataClass('SetupUiState')]
|
||||
/**
|
||||
* @summary Displays the content of the setup screen: input fields and a button.
|
||||
* @param uiState The current UI state.
|
||||
* @param onServerUrlChange A lambda handler for changing the server URL.
|
||||
* @param onUsernameChange A lambda handler for changing the username.
|
||||
* @param onPasswordChange A lambda handler for changing the password.
|
||||
* @param onConnectClick A lambda handler for clicking the "Connect" button.
|
||||
*/
|
||||
@Composable
|
||||
private fun SetupScreenContent(
|
||||
uiState: SetupUiState,
|
||||
onServerUrlChange: (String) -> Unit,
|
||||
onUsernameChange: (String) -> Unit,
|
||||
onPasswordChange: (String) -> Unit,
|
||||
onConnectClick: () -> Unit
|
||||
) {
|
||||
Scaffold { paddingValues ->
|
||||
Column(
|
||||
modifier = Modifier
|
||||
.fillMaxSize()
|
||||
.padding(paddingValues)
|
||||
.padding(16.dp),
|
||||
verticalArrangement = Arrangement.Center,
|
||||
horizontalAlignment = Alignment.CenterHorizontally
|
||||
) {
|
||||
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()
|
||||
.height(50.dp)
|
||||
) {
|
||||
if (uiState.isLoading) {
|
||||
CircularProgressIndicator(
|
||||
modifier = Modifier.size(24.dp),
|
||||
color = MaterialTheme.colorScheme.onPrimary
|
||||
)
|
||||
} else {
|
||||
Text(stringResource(id = R.string.setup_connect_button))
|
||||
}
|
||||
}
|
||||
uiState.error?.let {
|
||||
Spacer(modifier = Modifier.height(8.dp))
|
||||
Text(
|
||||
text = it,
|
||||
color = MaterialTheme.colorScheme.error
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('SetupScreenContent')]
|
||||
|
||||
// [ENTITY: Function('SetupScreenPreview')]
|
||||
@Preview(showBackground = true)
|
||||
@Composable
|
||||
fun SetupScreenPreview() {
|
||||
SetupScreenContent(
|
||||
uiState = SetupUiState(error = "Failed to connect"),
|
||||
onServerUrlChange = {},
|
||||
onUsernameChange = {},
|
||||
onPasswordChange = {},
|
||||
onConnectClick = {}
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('SetupScreenPreview')]
|
||||
// [END_FILE_SetupScreen.kt]
|
||||
@@ -0,0 +1,26 @@
|
||||
// [FILE] SetupUiState.kt
|
||||
// [SEMANTICS] ui_state, data_model, immutable
|
||||
|
||||
package com.homebox.lens.ui.screen.setup
|
||||
|
||||
// [ENTITY: DataClass('SetupUiState')]
|
||||
/**
|
||||
* @summary Неизменяемая модель данных, представляющая полное состояние экрана настройки (Setup Screen).
|
||||
* @description Использование `data class` предоставляет метод `copy()` для легкого создания новых состояний.
|
||||
* @param serverUrl URL-адрес сервера Homebox.
|
||||
* @param username Имя пользователя для входа.
|
||||
* @param password Пароль пользователя.
|
||||
* @param isLoading Флаг, указывающий, выполняется ли в данный момент сетевой запрос.
|
||||
* @param error Сообщение об ошибке для отображения пользователю, или `null` при отсутствии ошибки.
|
||||
* @param isSetupComplete Флаг, указывающий на успешное завершение настройки и входа.
|
||||
*/
|
||||
data class SetupUiState(
|
||||
val serverUrl: String = "",
|
||||
val username: String = "",
|
||||
val password: String = "",
|
||||
val isLoading: Boolean = false,
|
||||
val error: String? = null,
|
||||
val isSetupComplete: Boolean = false
|
||||
)
|
||||
// [END_ENTITY: DataClass('SetupUiState')]
|
||||
// [END_FILE_SetupUiState.kt]
|
||||
@@ -0,0 +1,133 @@
|
||||
// [FILE] SetupViewModel.kt
|
||||
// [SEMANTICS] ui_logic, viewmodel, state_management, user_setup, authentication_flow
|
||||
package com.homebox.lens.ui.screen.setup
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.lifecycle.ViewModel
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.homebox.lens.domain.model.Credentials
|
||||
import com.homebox.lens.domain.repository.CredentialsRepository
|
||||
import com.homebox.lens.domain.usecase.LoginUseCase
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.MutableStateFlow
|
||||
import kotlinx.coroutines.flow.asStateFlow
|
||||
import kotlinx.coroutines.flow.update
|
||||
import kotlinx.coroutines.launch
|
||||
import timber.log.Timber
|
||||
import javax.inject.Inject
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: ViewModel('SetupViewModel')]
|
||||
// [RELATION: ViewModel('SetupViewModel')] -> [DEPENDS_ON] -> [Repository('CredentialsRepository')]
|
||||
// [RELATION: ViewModel('SetupViewModel')] -> [DEPENDS_ON] -> [UseCase('LoginUseCase')]
|
||||
// [RELATION: ViewModel('SetupViewModel')] -> [EMITS_STATE] -> [DataClass('SetupUiState')]
|
||||
/**
|
||||
* @summary ViewModel для экрана первоначальной настройки (Setup).
|
||||
* @param credentialsRepository Репозиторий для операций с учетными данными.
|
||||
* @param loginUseCase Use case для выполнения логики входа.
|
||||
* @invariant Состояние `uiState` всегда является единственным источником истины для UI.
|
||||
*/
|
||||
@HiltViewModel
|
||||
class SetupViewModel @Inject constructor(
|
||||
private val credentialsRepository: CredentialsRepository,
|
||||
private val loginUseCase: LoginUseCase
|
||||
) : ViewModel() {
|
||||
|
||||
private val _uiState = MutableStateFlow(SetupUiState())
|
||||
val uiState = _uiState.asStateFlow()
|
||||
|
||||
init {
|
||||
loadCredentials()
|
||||
}
|
||||
|
||||
// [ENTITY: Function('loadCredentials')]
|
||||
private fun loadCredentials() {
|
||||
Timber.d("[DEBUG][ENTRYPOINT][loading_credentials] Loading credentials from repository.")
|
||||
viewModelScope.launch {
|
||||
credentialsRepository.getCredentials().collect { credentials ->
|
||||
if (credentials != null) {
|
||||
Timber.d("[DEBUG][ACTION][updating_state] Credentials found, updating UI state.")
|
||||
_uiState.update {
|
||||
it.copy(
|
||||
serverUrl = credentials.serverUrl,
|
||||
username = credentials.username,
|
||||
password = credentials.password
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// [END_ENTITY: Function('loadCredentials')]
|
||||
|
||||
// [ENTITY: Function('onServerUrlChange')]
|
||||
fun onServerUrlChange(newUrl: String) {
|
||||
_uiState.update { it.copy(serverUrl = newUrl) }
|
||||
}
|
||||
// [END_ENTITY: Function('onServerUrlChange')]
|
||||
|
||||
// [ENTITY: Function('onUsernameChange')]
|
||||
fun onUsernameChange(newUsername: String) {
|
||||
_uiState.update { it.copy(username = newUsername) }
|
||||
}
|
||||
// [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('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')]
|
||||
|
||||
// [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) }
|
||||
|
||||
val credentials = Credentials(
|
||||
serverUrl = _uiState.value.serverUrl.trim(),
|
||||
username = _uiState.value.username.trim(),
|
||||
password = _uiState.value.password
|
||||
)
|
||||
|
||||
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,60 @@
|
||||
// [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.ui.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,7 +1,6 @@
|
||||
// [FILE] Color.kt
|
||||
// [SEMANTICS] ui, theme, color
|
||||
|
||||
package com.homebox.lens.feature.dashboard.ui.theme
|
||||
// [SEMANTICS] app, ui, theme, color
|
||||
package com.homebox.lens.ui.theme
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.ui.graphics.Color
|
||||
@@ -15,4 +14,4 @@ val Purple40 = Color(0xFF6650a4)
|
||||
val PurpleGrey40 = Color(0xFF625b71)
|
||||
val Pink40 = Color(0xFF7D5260)
|
||||
|
||||
// [END_FILE_Color.kt]
|
||||
// [END_FILE_Color.kt]
|
||||
73
app/src/main/java/com/homebox/lens/ui/theme/Theme.kt
Normal file
73
app/src/main/java/com/homebox/lens/ui/theme/Theme.kt
Normal file
@@ -0,0 +1,73 @@
|
||||
// [FILE] Theme.kt
|
||||
// [SEMANTICS] app, ui, theme
|
||||
package com.homebox.lens.ui.theme
|
||||
|
||||
// [IMPORTS]
|
||||
import android.app.Activity
|
||||
import android.os.Build
|
||||
import androidx.compose.foundation.isSystemInDarkTheme
|
||||
import androidx.compose.material3.MaterialTheme
|
||||
import androidx.compose.material3.darkColorScheme
|
||||
import androidx.compose.material3.dynamicDarkColorScheme
|
||||
import androidx.compose.material3.dynamicLightColorScheme
|
||||
import androidx.compose.material3.lightColorScheme
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.SideEffect
|
||||
import androidx.compose.ui.graphics.toArgb
|
||||
import androidx.compose.ui.platform.LocalContext
|
||||
import androidx.compose.ui.platform.LocalView
|
||||
import androidx.core.view.WindowCompat
|
||||
// [END_IMPORTS]
|
||||
|
||||
private val DarkColorScheme = darkColorScheme(
|
||||
primary = Purple80,
|
||||
secondary = PurpleGrey80,
|
||||
tertiary = Pink80
|
||||
)
|
||||
|
||||
private val LightColorScheme = lightColorScheme(
|
||||
primary = Purple40,
|
||||
secondary = PurpleGrey40,
|
||||
tertiary = Pink40
|
||||
)
|
||||
|
||||
// [ENTITY: Function('HomeboxLensTheme')]
|
||||
// [RELATION: Function('HomeboxLensTheme')] -> [DEPENDS_ON] -> [DataStructure('Typography')]
|
||||
/**
|
||||
* @summary The main theme for the Homebox Lens application.
|
||||
* @param darkTheme Whether the theme should be dark or light.
|
||||
* @param dynamicColor Whether to use dynamic color (on Android 12+).
|
||||
* @param content The content to be displayed within the theme.
|
||||
*/
|
||||
@Composable
|
||||
fun HomeboxLensTheme(
|
||||
darkTheme: Boolean = isSystemInDarkTheme(),
|
||||
dynamicColor: Boolean = true,
|
||||
content: @Composable () -> Unit
|
||||
) {
|
||||
val colorScheme = when {
|
||||
dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> {
|
||||
val context = LocalContext.current
|
||||
if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context)
|
||||
}
|
||||
|
||||
darkTheme -> DarkColorScheme
|
||||
else -> LightColorScheme
|
||||
}
|
||||
val view = LocalView.current
|
||||
if (!view.isInEditMode) {
|
||||
SideEffect {
|
||||
val window = (view.context as Activity).window
|
||||
window.statusBarColor = colorScheme.primary.toArgb()
|
||||
WindowCompat.getInsetsController(window, view).isAppearanceLightStatusBars = darkTheme
|
||||
}
|
||||
}
|
||||
|
||||
MaterialTheme(
|
||||
colorScheme = colorScheme,
|
||||
typography = Typography,
|
||||
content = content
|
||||
)
|
||||
}
|
||||
// [END_ENTITY: Function('HomeboxLensTheme')]
|
||||
// [END_FILE_Theme.kt]
|
||||
28
app/src/main/java/com/homebox/lens/ui/theme/Typography.kt
Normal file
28
app/src/main/java/com/homebox/lens/ui/theme/Typography.kt
Normal file
@@ -0,0 +1,28 @@
|
||||
// [FILE] Typography.kt
|
||||
// [SEMANTICS] app, ui, theme, typography
|
||||
package com.homebox.lens.ui.theme
|
||||
|
||||
// [IMPORTS]
|
||||
import androidx.compose.material3.Typography
|
||||
import androidx.compose.ui.text.TextStyle
|
||||
import androidx.compose.ui.text.font.FontFamily
|
||||
import androidx.compose.ui.text.font.FontWeight
|
||||
import androidx.compose.ui.unit.sp
|
||||
// [END_IMPORTS]
|
||||
|
||||
// [ENTITY: DataStructure('Typography')]
|
||||
/**
|
||||
* @summary Defines the typography for the application.
|
||||
*/
|
||||
val Typography = Typography(
|
||||
bodyLarge = TextStyle(
|
||||
fontFamily = FontFamily.Default,
|
||||
fontWeight = FontWeight.Normal,
|
||||
fontSize = 16.sp,
|
||||
lineHeight = 24.sp,
|
||||
letterSpacing = 0.5.sp
|
||||
)
|
||||
)
|
||||
// [END_ENTITY: DataStructure('Typography')]
|
||||
|
||||
// [END_FILE_Typography.kt]
|
||||
@@ -1,146 +0,0 @@
|
||||
<resources>
|
||||
<string name="app_name">Homebox Lens</string>
|
||||
|
||||
<!-- 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>
|
||||
<string name="items_not_found">Items not found</string>
|
||||
<string name="error_loading_failed">Failed to load data. Please try again.</string>
|
||||
|
||||
<!-- Content Descriptions -->
|
||||
<string name="cd_open_navigation_drawer">Open navigation drawer</string>
|
||||
<string name="cd_scan_qr_code">Scan QR code</string>
|
||||
<string name="cd_search">Search</string>
|
||||
<string name="cd_navigate_back">Navigate back</string>
|
||||
<string name="cd_navigate_up">Go back</string>
|
||||
<string name="cd_add_new_location">Add new location</string>
|
||||
<string name="content_desc_add_label">Add new label</string>
|
||||
|
||||
<!-- Dashboard Screen -->
|
||||
<string name="dashboard_title">Dashboard</string>
|
||||
<string name="dashboard_section_quick_stats">Quick Stats</string>
|
||||
<string name="dashboard_section_recently_added">Recently Added</string>
|
||||
<string name="dashboard_section_locations">Locations</string>
|
||||
<string name="dashboard_section_labels">Labels</string>
|
||||
<string name="location_chip_label">%1$s (%2$d)</string>
|
||||
|
||||
<!-- Dashboard Statistics -->
|
||||
<string name="dashboard_stat_total_items">Total Items</string>
|
||||
<string name="dashboard_stat_total_value">Total Value</string>
|
||||
<string name="dashboard_stat_total_labels">Total Labels</string>
|
||||
<string name="dashboard_stat_total_locations">Total Locations</string>
|
||||
|
||||
<!-- Navigation -->
|
||||
<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>
|
||||
<string name="setup_username_label">Username</string>
|
||||
<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="content_desc_delete_label">Delete label</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>
|
||||
|
||||
<string name="item_asset_id">Asset ID</string>
|
||||
<string name="item_notes">Notes</string>
|
||||
<string name="item_serial_number">Serial Number</string>
|
||||
<string name="item_purchase_price">Purchase Price</string>
|
||||
<string name="item_purchase_date">Purchase Date</string>
|
||||
<string name="item_warranty_until">Warranty Until</string>
|
||||
<string name="item_parent_id">Parent ID</string>
|
||||
<string name="item_is_archived">Is Archived</string>
|
||||
<string name="item_insured">Insured</string>
|
||||
<string name="item_lifetime_warranty">Lifetime Warranty</string>
|
||||
<string name="item_sync_child_items_locations">Sync Child Items Locations</string>
|
||||
<string name="item_manufacturer">Manufacturer</string>
|
||||
<string name="item_model_number">Model Number</string>
|
||||
<string name="item_purchase_from">Purchase From</string>
|
||||
<string name="item_warranty_details">Warranty Details</string>
|
||||
<string name="item_sold_notes">Sold Notes</string>
|
||||
<string name="item_sold_price">Sold Price</string>
|
||||
<string name="item_sold_time">Sold Time</string>
|
||||
<string name="item_sold_to">Sold To</string>
|
||||
<string name="scan_qr_code">Scan QR Code</string>
|
||||
<string name="ok">OK</string>
|
||||
<string name="cancel">Cancel</string>
|
||||
</resources>
|
||||
@@ -2,139 +2,149 @@
|
||||
<string name="app_name">Homebox Lens</string>
|
||||
|
||||
<!-- Common -->
|
||||
<string name="create">Создать</string>
|
||||
<string name="edit">Редактировать</string>
|
||||
<string name="delete">Удалить</string>
|
||||
<string name="search">Поиск</string>
|
||||
<string name="logout">Выйти</string>
|
||||
<string name="no_location">Нет локации</string>
|
||||
<string name="items_not_found">Элементы не найдены</string>
|
||||
<string name="error_loading_failed">Не удалось загрузить данные. Пожалуйста, попробуйте еще раз.</string>
|
||||
<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>
|
||||
<string name="items_not_found">Items not found</string>
|
||||
<string name="error_loading_failed">Failed to load data. Please try again.</string>
|
||||
|
||||
<!-- Content Descriptions -->
|
||||
<string name="cd_open_navigation_drawer">Открыть боковое меню</string>
|
||||
<string name="cd_scan_qr_code">Сканировать QR/штрих-код</string>
|
||||
<string name="cd_search">Поиск</string>
|
||||
<string name="cd_navigate_back">Вернуться назад</string>
|
||||
<string name="cd_navigate_up">Вернуться</string>
|
||||
<string name="cd_add_new_location">Добавить новую локацию</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>
|
||||
<string name="label_description">Описание</string>
|
||||
|
||||
<!-- Search Screen -->
|
||||
<string name="placeholder_search_items">Поиск элементов...</string>
|
||||
<string name="cd_open_navigation_drawer">Open navigation drawer</string>
|
||||
<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="content_desc_add_label">Add new label</string>
|
||||
|
||||
<!-- Dashboard Screen -->
|
||||
<string name="dashboard_title">Главная</string>
|
||||
<string name="dashboard_section_quick_stats">Быстрая статистика</string>
|
||||
<string name="dashboard_section_recently_added">Недавно добавлено</string>
|
||||
<string name="dashboard_section_locations">Места хранения</string>
|
||||
<string name="dashboard_section_labels">Метки</string>
|
||||
<string name="dashboard_title">Dashboard</string>
|
||||
<string name="dashboard_section_quick_stats">Quick Stats</string>
|
||||
<string name="dashboard_section_recently_added">Recently Added</string>
|
||||
<string name="dashboard_section_locations">Locations</string>
|
||||
<string name="dashboard_section_labels">Labels</string>
|
||||
<string name="location_chip_label">%1$s (%2$d)</string>
|
||||
|
||||
<!-- Dashboard Statistics -->
|
||||
<string name="dashboard_stat_total_items">Всего вещей</string>
|
||||
<string name="dashboard_stat_total_value">Общая стоимость</string>
|
||||
<string name="dashboard_stat_total_labels">Всего меток</string>
|
||||
<string name="dashboard_stat_total_locations">Всего локаций</string>
|
||||
<string name="dashboard_stat_total_items">Total Items</string>
|
||||
<string name="dashboard_stat_total_value">Total Value</string>
|
||||
<string name="dashboard_stat_total_labels">Total Labels</string>
|
||||
<string name="dashboard_stat_total_locations">Total Locations</string>
|
||||
|
||||
<!-- Navigation -->
|
||||
<string name="nav_locations">Локации</string>
|
||||
<string name="nav_labels">Метки</string>
|
||||
<string name="nav_locations">Locations</string>
|
||||
<string name="nav_labels">Labels</string>
|
||||
|
||||
<!-- Screen Titles -->
|
||||
<string name="inventory_list_title">Инвентарь</string>
|
||||
<string name="item_details_title">Детали</string>
|
||||
<string name="item_edit_title">Редактирование</string>
|
||||
<string name="labels_list_title">Метки</string>
|
||||
<string name="locations_list_title">Места хранения</string>
|
||||
<string name="search_title">Поиск</string>
|
||||
<string name="inventory_list_title">Inventory</string>
|
||||
|
||||
<string name="save_item">Сохранить</string>
|
||||
<string name="item_name">Название</string>
|
||||
<string name="item_description">Описание</string>
|
||||
<string name="item_quantity">Количество</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">Создать локацию</string>
|
||||
<string name="location_edit_title_edit">Редактировать локацию</string>
|
||||
<string name="location_edit_title_create">Create Location</string>
|
||||
<string name="location_edit_title_edit">Edit Location</string>
|
||||
|
||||
<!-- Locations List Screen -->
|
||||
<string name="locations_not_found">Местоположения не найдены. Нажмите +, чтобы добавить новое.</string>
|
||||
<string name="item_count">Предметов: %1$d</string>
|
||||
<string name="cd_more_options">Больше опций</string>
|
||||
<string name="locations_not_found">Locations not found. Press + to add a new one.</string>
|
||||
<string name="item_count">Items: %1$d</string>
|
||||
<string name="cd_more_options">More options</string>
|
||||
|
||||
<!-- Setup Screen -->
|
||||
<string name="screen_title_setup">Настройка</string>
|
||||
<string name="setup_title">Настройка сервера</string>
|
||||
<string name="setup_server_url_label">URL сервера</string>
|
||||
<string name="setup_username_label">Имя пользователя</string>
|
||||
<string name="setup_password_label">Пароль</string>
|
||||
<string name="setup_connect_button">Подключиться</string>
|
||||
<string name="setup_title">Server Setup</string>
|
||||
<string name="setup_server_url_label">Server URL</string>
|
||||
<string name="setup_username_label">Username</string>
|
||||
<string name="setup_password_label">Password</string>
|
||||
<string name="setup_connect_button">Connect</string>
|
||||
|
||||
<!-- Labels List Screen -->
|
||||
<string name="screen_title_labels">Метки</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="content_desc_delete_label">Удалить метку</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>
|
||||
<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>
|
||||
|
||||
<string name="item_edit_general_information">General Information</string>
|
||||
<string name="item_edit_location">Location</string>
|
||||
<string name="item_edit_labels">Labels</string>
|
||||
<string name="item_edit_select_labels">Select Labels</string>
|
||||
<string name="dialog_ok">OK</string>
|
||||
<string name="dialog_cancel">Cancel</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 Time</string>
|
||||
<string name="item_edit_select_date">Select Date</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 Time</string>
|
||||
|
||||
<!-- Search Screen -->
|
||||
<string name="placeholder_search_items">Search items...</string>
|
||||
|
||||
<!-- Setup Screen -->
|
||||
<string name="screen_title_setup">Setup</string>
|
||||
<string name="screen_title_settings">Settings</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_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">Назад</string>
|
||||
<string name="save">Сохранить</string>
|
||||
<!-- Common Actions -->
|
||||
<string name="back">Back</string>
|
||||
<string name="save">Save</string>
|
||||
|
||||
<!-- Color Picker -->
|
||||
<string name="label_color">Цвет</string>
|
||||
<string name="label_hex_color">HEX-код цвета</string>
|
||||
<string name="item_asset_id">Идентификатор актива</string>
|
||||
<string name="item_notes">Заметки</string>
|
||||
<string name="item_serial_number">Серийный номер</string>
|
||||
<string name="item_purchase_price">Цена покупки</string>
|
||||
<string name="item_purchase_date">Дата покупки</string>
|
||||
<string name="item_warranty_until">Гарантия до</string>
|
||||
<string name="item_parent_id">Родительский ID</string>
|
||||
<string name="item_is_archived">Архивировано</string>
|
||||
<string name="item_insured">Застраховано</string>
|
||||
<string name="item_lifetime_warranty">Пожизненная гарантия</string>
|
||||
<string name="item_sync_child_items_locations">Синхронизировать дочерние элементы</string>
|
||||
<string name="item_manufacturer">Производитель</string>
|
||||
<string name="item_model_number">Номер модели</string>
|
||||
<string name="item_purchase_from">Куплено у</string>
|
||||
<string name="item_warranty_details">Детали гарантии</string>
|
||||
<string name="item_sold_notes">Примечания о продаже</string>
|
||||
<string name="item_sold_price">Цена продажи</string>
|
||||
<string name="item_sold_time">Время продажи</string>
|
||||
<string name="item_sold_to">Продано кому</string>
|
||||
<string name="scan_qr_code">Сканировать QR-код</string>
|
||||
<string name="ok">ОК</string>
|
||||
<string name="cancel">Отмена</string>
|
||||
</resources>
|
||||
<string name="label_color">Color</string>
|
||||
<string name="label_hex_color">HEX color code</string>
|
||||
|
||||
</resources>
|
||||
@@ -1,13 +1,15 @@
|
||||
// [FILE] build.gradle.kts
|
||||
// [SEMANTICS] build, configuration
|
||||
// [AI_NOTE]: Root build file for the project, configures plugins for all modules.
|
||||
// [PURPOSE] Root build file for the project, configures plugins for all modules.
|
||||
|
||||
plugins {
|
||||
id("com.android.application") version "8.12.3" apply false
|
||||
id("org.jetbrains.kotlin.android") version "2.0.0" apply false
|
||||
id("org.jetbrains.kotlin.plugin.compose") version "2.0.0" apply false
|
||||
id("com.google.dagger.hilt.android") version "2.51.1" apply false
|
||||
id("com.google.devtools.ksp") version "2.0.0-1.0.24" apply false
|
||||
// [PLUGIN] Android Application plugin
|
||||
id("com.android.application") version "8.4.0" apply false
|
||||
// [PLUGIN] Kotlin Android plugin
|
||||
id("org.jetbrains.kotlin.android") version "1.9.23" apply false
|
||||
// [PLUGIN] Hilt Android plugin
|
||||
id("com.google.dagger.hilt.android") version "2.48.1" apply false
|
||||
// [PLUGIN] KSP plugin
|
||||
id("com.google.devtools.ksp") version "1.9.23-1.0.19" apply false
|
||||
}
|
||||
|
||||
// [END_FILE_build.gradle.kts]
|
||||
|
||||
@@ -1,34 +1,52 @@
|
||||
// [PACKAGE] buildsrc.dependencies
|
||||
// [FILE] Dependencies.kt
|
||||
// [SEMANTICS] build, dependencies
|
||||
|
||||
// [ENTITY: Object('Versions')]
|
||||
object Versions {
|
||||
// Build
|
||||
const val compileSdk = 34
|
||||
const val minSdk = 24
|
||||
const val minSdk = 26
|
||||
const val targetSdk = 34
|
||||
const val versionCode = 1
|
||||
const val versionName = "1.0"
|
||||
const val kotlin = "1.9.10"
|
||||
|
||||
// Kotlin
|
||||
const val kotlin = "1.9.22"
|
||||
const val coroutines = "1.7.3"
|
||||
const val composeCompiler = "1.5.4"
|
||||
const val composeBom = "2024.05.00"
|
||||
|
||||
// Jetpack Compose
|
||||
const val composeCompiler = "1.5.11"
|
||||
const val composeBom = "2023.10.01"
|
||||
const val activityCompose = "1.8.2"
|
||||
const val navigationCompose = "2.7.7"
|
||||
const val navigationCompose = "2.7.6"
|
||||
const val hiltNavigationCompose = "1.1.0"
|
||||
|
||||
// AndroidX
|
||||
const val coreKtx = "1.12.0"
|
||||
const val lifecycle = "2.7.0"
|
||||
const val lifecycle = "2.6.2"
|
||||
const val appcompat = "1.6.1"
|
||||
|
||||
// Networking
|
||||
const val retrofit = "2.9.0"
|
||||
const val okhttp = "4.12.0"
|
||||
const val moshi = "1.15.1"
|
||||
const val moshi = "1.15.0"
|
||||
|
||||
// Database
|
||||
const val room = "2.6.1"
|
||||
const val hilt = "2.51.1"
|
||||
const val hiltCompiler = "1.2.0"
|
||||
|
||||
// DI
|
||||
const val hilt = "2.48.1"
|
||||
const val hiltCompiler = "1.1.0"
|
||||
|
||||
// Logging
|
||||
const val timber = "5.0.1"
|
||||
|
||||
// Testing
|
||||
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"
|
||||
}
|
||||
@@ -36,21 +54,26 @@ object Versions {
|
||||
|
||||
// [ENTITY: Object('Libs')]
|
||||
object Libs {
|
||||
// Kotlin
|
||||
const val coroutinesCore = "org.jetbrains.kotlinx:kotlinx-coroutines-core:${Versions.coroutines}"
|
||||
const val coroutinesAndroid = "org.jetbrains.kotlinx:kotlinx-coroutines-android:${Versions.coroutines}"
|
||||
|
||||
// AndroidX
|
||||
const val coreKtx = "androidx.core:core-ktx:${Versions.coreKtx}"
|
||||
const val lifecycleRuntime = "androidx.lifecycle:lifecycle-runtime-ktx:${Versions.lifecycle}"
|
||||
const val appcompat = "androidx.appcompat:appcompat:${Versions.appcompat}"
|
||||
const val composeUi = "androidx.compose.ui:ui:1.5.4"
|
||||
const val composeUiGraphics = "androidx.compose.ui:ui-graphics:1.5.4"
|
||||
const val composeUiToolingPreview = "androidx.compose.ui:ui-tooling-preview:1.5.4"
|
||||
const val composeMaterial3 = "androidx.compose.material3:material3:1.1.2"
|
||||
const val composeFoundation = "androidx.compose.foundation:foundation:1.5.4"
|
||||
const val composeFoundationLayout = "androidx.compose.foundation:foundation-layout:1.5.4"
|
||||
const val composeMaterialIconsExtended = "androidx.compose.material:material-icons-extended:1.5.4"
|
||||
|
||||
// Compose
|
||||
const val composeBom = "androidx.compose:compose-bom:${Versions.composeBom}"
|
||||
const val composeUi = "androidx.compose.ui:ui"
|
||||
const val composeUiGraphics = "androidx.compose.ui:ui-graphics"
|
||||
const val composeUiToolingPreview = "androidx.compose.ui:ui-tooling-preview"
|
||||
const val composeMaterial3 = "androidx.compose.material3:material3"
|
||||
const val activityCompose = "androidx.activity:activity-compose:${Versions.activityCompose}"
|
||||
const val navigationCompose = "androidx.navigation:navigation-compose:${Versions.navigationCompose}"
|
||||
const val hiltNavigationCompose = "androidx.hilt:hilt-navigation-compose:${Versions.hiltNavigationCompose}"
|
||||
|
||||
// Networking (Retrofit, OkHttp, Moshi)
|
||||
const val retrofit = "com.squareup.retrofit2:retrofit:${Versions.retrofit}"
|
||||
const val converterMoshi = "com.squareup.retrofit2:converter-moshi:${Versions.retrofit}"
|
||||
const val okhttp = "com.squareup.okhttp3:okhttp:${Versions.okhttp}"
|
||||
@@ -58,18 +81,27 @@ object Libs {
|
||||
const val moshi = "com.squareup.moshi:moshi:${Versions.moshi}"
|
||||
const val moshiKotlin = "com.squareup.moshi:moshi-kotlin:${Versions.moshi}"
|
||||
const val moshiCodegen = "com.squareup.moshi:moshi-kotlin-codegen:${Versions.moshi}"
|
||||
|
||||
// Database (Room)
|
||||
const val roomRuntime = "androidx.room:room-runtime:${Versions.room}"
|
||||
const val roomKtx = "androidx.room:room-ktx:${Versions.room}"
|
||||
const val roomCompiler = "androidx.room:room-compiler:${Versions.room}"
|
||||
|
||||
// Dependency Injection (Hilt)
|
||||
const val hiltAndroid = "com.google.dagger:hilt-android:${Versions.hilt}"
|
||||
const val hiltCompiler = "com.google.dagger:hilt-android-compiler:${Versions.hilt}"
|
||||
|
||||
// Logging
|
||||
const val timber = "com.jakewharton.timber:timber:${Versions.timber}"
|
||||
|
||||
// Testing
|
||||
const val junit = "junit:junit:${Versions.junit}"
|
||||
const val extJunit = "androidx.test.ext:junit:${Versions.extJunit}"
|
||||
const val espressoCore = "androidx.test.espresso:espresso-core:${Versions.espresso}"
|
||||
const val composeUiTestJunit4 = "androidx.compose.ui:ui-test-junit4:1.5.4"
|
||||
const val composeUiTooling = "androidx.compose.ui:ui-tooling:1.5.4"
|
||||
const val composeUiTestManifest = "androidx.compose.ui:ui-test-manifest:1.5.4"
|
||||
const val composeUiTestJunit4 = "androidx.compose.ui:ui-test-junit4"
|
||||
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}"
|
||||
|
||||
@@ -6,6 +6,7 @@ plugins {
|
||||
id("org.jetbrains.kotlin.android")
|
||||
id("com.google.dagger.hilt.android")
|
||||
id("kotlin-kapt")
|
||||
id("com.google.devtools.ksp")
|
||||
}
|
||||
|
||||
android {
|
||||
@@ -27,11 +28,11 @@ android {
|
||||
}
|
||||
}
|
||||
compileOptions {
|
||||
sourceCompatibility = JavaVersion.VERSION_1_8
|
||||
targetCompatibility = JavaVersion.VERSION_1_8
|
||||
sourceCompatibility = JavaVersion.VERSION_17
|
||||
targetCompatibility = JavaVersion.VERSION_17
|
||||
}
|
||||
kotlinOptions {
|
||||
jvmTarget = "1.8"
|
||||
jvmTarget = "17"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -51,7 +52,7 @@ dependencies {
|
||||
implementation(Libs.okhttp)
|
||||
implementation(Libs.okhttpLoggingInterceptor)
|
||||
implementation(Libs.moshiKotlin)
|
||||
kapt(Libs.moshiCodegen)
|
||||
ksp(Libs.moshiCodegen)
|
||||
|
||||
// [DEPENDENCY] Database (Room)
|
||||
implementation(Libs.roomRuntime)
|
||||
|
||||
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>
|
||||
@@ -0,0 +1,3 @@
|
||||
<resources>
|
||||
<string name="app_name">semantic-ktlint-rules</string>
|
||||
</resources>
|
||||
16
data/semantic-ktlint-rules/src/main/res/values/themes.xml
Normal file
16
data/semantic-ktlint-rules/src/main/res/values/themes.xml
Normal file
@@ -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_500</item>
|
||||
<item name="colorPrimaryVariant">@color/purple_700</item>
|
||||
<item name="colorOnPrimary">@color/white</item>
|
||||
<!-- Secondary brand color. -->
|
||||
<item name="colorSecondary">@color/teal_200</item>
|
||||
<item name="colorSecondaryVariant">@color/teal_700</item>
|
||||
<item name="colorOnSecondary">@color/black</item>
|
||||
<!-- Status bar color. -->
|
||||
<item name="android:statusBarColor">?attr/colorPrimaryVariant</item>
|
||||
<!-- Customize your theme here. -->
|
||||
</style>
|
||||
</resources>
|
||||
@@ -0,0 +1 @@
|
||||
com.busya.ktlint.rules.CustomRuleSetProvider
|
||||
@@ -0,0 +1,44 @@
|
||||
// [FILE] ExampleUnitTest.kt
|
||||
// [SEMANTICS] testing, ktlint, rules
|
||||
|
||||
package com.busya.ktlint.rules
|
||||
|
||||
import com.pinterest.ktlint.test.KtLintAssertThat.Companion.assertThatRule
|
||||
import org.junit.jupiter.api.Test
|
||||
|
||||
class FileHeaderRuleTest {
|
||||
|
||||
private val ruleAssertThat = assertThatRule { FileHeaderRule() }
|
||||
|
||||
@Test
|
||||
fun `should pass on correct header`() {
|
||||
val code = """
|
||||
// [PACKAGE] com.example
|
||||
// [FILE] Test.kt
|
||||
// [SEMANTICS] test, example
|
||||
package com.example
|
||||
""".trimIndent()
|
||||
ruleAssertThat(code).hasNoLintViolations()
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `should fail on missing header`() {
|
||||
val code = """
|
||||
package com.example
|
||||
""".trimIndent()
|
||||
ruleAssertThat(code)
|
||||
.hasLintViolation(1, 1, "File must start with a 3-line semantic header.")
|
||||
}
|
||||
|
||||
@Test
|
||||
fun `should fail on incorrect line 1`() {
|
||||
val code = """
|
||||
// [WRONG_TAG] com.example
|
||||
// [FILE] Test.kt
|
||||
// [SEMANTICS] test, example
|
||||
package com.example
|
||||
""".trimIndent()
|
||||
ruleAssertThat(code)
|
||||
.hasLintViolation(1, 1, "File header missing or incorrect. Line 1 must be '// [PACKAGE] ...'.")
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,3 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api
|
||||
// [FILE] HomeboxApiService.kt
|
||||
// [SEMANTICS] data, api, retrofit
|
||||
package com.homebox.lens.data.api
|
||||
@@ -11,7 +10,7 @@ import retrofit2.http.*
|
||||
|
||||
// [ENTITY: Interface('HomeboxApiService')]
|
||||
/**
|
||||
* @summary Определяет эндпоинты для взаимодействия с Homebox API, используя DTO.
|
||||
* @summary Defines the endpoints for interacting with the Homebox API using DTOs.
|
||||
*/
|
||||
interface HomeboxApiService {
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api.dto
|
||||
// [FILE] CustomFieldDto.kt
|
||||
// [SEMANTICS] data_transfer_object, custom_field
|
||||
// [SEMANTICS] data, dto, custom_field
|
||||
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
@@ -12,7 +11,7 @@ import com.homebox.lens.domain.model.CustomField
|
||||
|
||||
// [ENTITY: DataClass('CustomFieldDto')]
|
||||
/**
|
||||
* @summary DTO для кастомного поля.
|
||||
* @summary DTO for a custom field.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class CustomFieldDto(
|
||||
@@ -25,7 +24,7 @@ data class CustomFieldDto(
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('CustomField')]
|
||||
/**
|
||||
* @summary Маппер из CustomFieldDto в доменную модель CustomField.
|
||||
* @summary Mapper from CustomFieldDto to the CustomField domain model.
|
||||
*/
|
||||
fun CustomFieldDto.toDomain(): CustomField {
|
||||
return CustomField(
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
// [PACKAGE] com.homebox.lens.data.api.dto
|
||||
// [FILE] GroupStatisticsDto.kt
|
||||
// [SEMANTICS] data_transfer_object, statistics
|
||||
// [SEMANTICS] data, dto, statistics
|
||||
|
||||
package com.homebox.lens.data.api.dto
|
||||
|
||||
@@ -12,7 +11,7 @@ import com.homebox.lens.domain.model.GroupStatistics
|
||||
|
||||
// [ENTITY: DataClass('GroupStatisticsDto')]
|
||||
/**
|
||||
* @summary DTO для статистики.
|
||||
* @summary DTO for statistics.
|
||||
*/
|
||||
@JsonClass(generateAdapter = true)
|
||||
data class GroupStatisticsDto(
|
||||
@@ -28,7 +27,7 @@ data class GroupStatisticsDto(
|
||||
// [ENTITY: Function('toDomain')]
|
||||
// [RELATION: Function('toDomain')] -> [RETURNS] -> [DataClass('GroupStatistics')]
|
||||
/**
|
||||
* @summary Маппер из GroupStatisticsDto в доменную модель GroupStatistics.
|
||||
* @summary Mapper from GroupStatisticsDto to the GroupStatistics domain model.
|
||||
*/
|
||||
fun GroupStatisticsDto.toDomain(): GroupStatistics {
|
||||
return GroupStatistics(
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user