488 / Обработка "Генератор кода" для КонструкторОбъектов() по ссылкам #495
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughДанный pull request вводит новый процессор данных "ЮТГенераторКода" (Code Generator) в систему YaxUnit. Процессор предназначен для генерации кода на основе метаданных, с поддержкой различных типов кодогенерации, включая основной код и конструктор объектов. Изменения включают создание новых модулей, форм и конфигурационных файлов, расширяющих функциональность системы возможностями автоматической генерации кода. Changes
Possibly related PRs
Suggested labels
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (9)
exts/yaxunit/src/DataProcessors/ЮТГенераторКода/ObjectModule.bsl (3)
35-54: Рекомендуется провести валидaцию входных параметров.
У функцииСформироватьКодПоСсылкамНаОбъекты(строки 35–54) отсутствует проверка корректности типа элементов массиваСсылкиНаОбъекты. Это может приводить к ошибкам во время выполнения, если в массив попадут посторонние ссылки или значения.Функция СформироватьКодПоСсылкамНаОбъекты(СсылкиНаОбъекты, ПараметрыФормирования) Экспорт + // Дополнительно проверим, что элементы массива действительно являются ссылками нужного типа. + Для Каждого ЗначениеСсылка Из СсылкиНаОбъекты Цикл + Если ТипЗнч(ЗначениеСсылка) <> Тип("ДокументСсылка.Объект") + И ТипЗнч(ЗначениеСсылка) <> Тип("СправочникСсылка.Объект") + И ТипЗнч(ЗначениеСсылка) <> Тип("ПланВидовХарактеристикСсылка.Объект") Тогда + Продолжить; // Или ВызватьИсключение, в зависимости от требуемой логики + КонецЕсли; + КонецЦикла;
84-95: Формирование структуры реквизитов может быть вынесено в отдельную функцию.
В процедуреДобавитьРеквизит(строки 84–95) соблюдается единообразный принцип заполнения структуры, который повторяется в коде. Рекомендуется вынести логику создания структуры реквизита в отдельную функцию, чтобы повысить читаемость.
656-670: Добавить протоколирование ошибок.
При работе с предопределёнными значениями (строки 656–670) в ситуации, когда имя предопределённых данных отсутcтвует, стоит логировать потенциально сбойную ситуацию. При большом количестве метаданных отладка облегчается, если ошибки фиксируются в журнале.exts/yaxunit/src/DataProcessors/ЮТГенераторКода/Forms/Форма/Module.bsl (2)
56-59: Уточнить сообщение для пользователя.
В строках 56–59, при формировании сообщения «Для Yaxunit нельзя выполнить код», стоит уточнить, каким образом пользователь может действовать (например, скопировать код, вставить в тест и т. п.).
38-46: Объединить команды «СформироватьКодПоМетаданным» и «СформироватьКодПоСписку» при необходимости.
МетодыСформироватьКодПоМетаданным(Команда)иСформироватьКодПоСписку(Команда)(строки 38–46) реализуют схожую логику вызова серверных процедур, отличаясь лишь деталями. Если бизнес-задача позволяет, можно объединить обе команды в один метод с параметрами.exts/yaxunit/src/DataProcessors/ЮТГенераторКода/Forms/Форма/Form.form (4)
47-63: Добавьте подсказки для вариантов выбора типа кода.Для улучшения UX рекомендуется добавить подсказки, объясняющие разницу между "Основной код" и "Yaxunit: Конструктор объекта".
<choiceList> <presentation> <key>ru</key> <value>Основной код</value> </presentation> + <toolTip> + <key>ru</key> + <value>Генерация основного кода для работы с объектами</value> + </toolTip> <value xsi:type="core:StringValue"> <value>ОсновнойКод</value> </value> </choiceList> <choiceList> <presentation> <key>ru</key> <value>Yaxunit: Конструктор объекта</value> </presentation> + <toolTip> + <key>ru</key> + <value>Генерация кода для конструктора объектов в тестах</value> + </toolTip> <value xsi:type="core:StringValue"> <value>КонструкторОбъектаYaxunit</value> </value> </choiceList>
674-1260: Оптимизируйте ширину колонок дерева метаданных.Для улучшения читаемости рекомендуется задать оптимальные начальные размеры колонок дерева метаданных.
<items xsi:type="form:Table"> <name>ДеревоМетаданных</name> <id>14</id> + <columns> + <name>Представление</name> + <width>30</width> + </columns> + <columns> + <name>ТипыРеквизитов</name> + <width>20</width> + </columns> + <columns> + <name>Данные</name> + <width>15</width> + </columns>
1994-2189: Добавьте сочетания клавиш для основных команд.Для улучшения эргономики рекомендуется добавить горячие клавиши для часто используемых действий.
<formCommands> <name>СформироватьКод</name> + <shortcut>Ctrl+G</shortcut> </formCommands> <formCommands> <name>СкопироватьВБуфер</name> + <shortcut>Ctrl+C</shortcut> </formCommands> <formCommands> <name>Очистить</name> + <shortcut>Ctrl+Del</shortcut> </formCommands>
456-500: Улучшите доступность предупреждающего сообщения.Текущая реализация использует HTML-форматирование, но может быть улучшена для лучшей доступности.
<items xsi:type="form:Decoration"> <name>ИнформацияОбИспользовании</name> <id>117</id> <title> <key>ru</key> - <value><font Arial><fontsize 12><b><color #ff0000>Функционал работает только для режима "Основной код"</></></></></value> + <value>Функционал работает только для режима "Основной код"</value> </title> + <font xsi:type="core:FontRef"> + <font>Style.TextFont</font> + <bold>true</bold> + <scale>12</scale> + </font> + <textColor xsi:type="core:ColorRef"> + <color>Style.SpecialTextColor</color> + </textColor>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
exts/yaxunit/src/Configuration/Configuration.mdo(1 hunks)exts/yaxunit/src/DataProcessors/ЮТГенераторКода/Forms/Форма/Form.form(1 hunks)exts/yaxunit/src/DataProcessors/ЮТГенераторКода/Forms/Форма/Module.bsl(1 hunks)exts/yaxunit/src/DataProcessors/ЮТГенераторКода/Help/ru.html(1 hunks)exts/yaxunit/src/DataProcessors/ЮТГенераторКода/ObjectModule.bsl(1 hunks)exts/yaxunit/src/DataProcessors/ЮТГенераторКода/ЮТГенераторКода.mdo(1 hunks)exts/yaxunit/src/Subsystems/ЮТПубличный/CommandInterface.cmi(1 hunks)exts/yaxunit/src/Subsystems/ЮТПубличный/ЮТПубличный.mdo(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- exts/yaxunit/src/Subsystems/ЮТПубличный/CommandInterface.cmi
- exts/yaxunit/src/DataProcessors/ЮТГенераторКода/ЮТГенераторКода.mdo
- exts/yaxunit/src/DataProcessors/ЮТГенераторКода/Help/ru.html
🔇 Additional comments (3)
exts/yaxunit/src/Subsystems/ЮТПубличный/ЮТПубличный.mdo (2)
51-51: Подтверждаю добавление нового процессора данных.Добавление
ЮТГенераторКодасоответствует целям PR по реализации функционала автоматической генерации кода для конструктора объектов.
55-55: Перемещение процессора данных ЮТЮнитТесты.Перемещение записи
ЮТЮнитТестыне влияет на функциональность, так как это только изменение порядка элементов в конфигурационном файле.exts/yaxunit/src/Configuration/Configuration.mdo (1)
165-165: Проверьте конфликт с уже существующими именами обработок.
Добавление<dataProcessors>DataProcessor.ЮТГенераторКода</dataProcessors>(строка 165) – верный шаг; однако убедитесь, что нет конфликта имени с другими объектами. Если где-то уже использовался такой объект, могут возникнуть дубликаты метаданных.
| Иначе | ||
| Значение = ЗначениеСсылка[ИмяТЧ][ИмяРеквизита]; | ||
| КонецЕсли; | ||
|
|
||
| Если НЕ ЗначениеЗаполнено(Значение) Тогда | ||
| Возврат Результат; | ||
| КонецЕсли; | ||
|
|
||
| ТекТип = ТипЗнч(Значение); | ||
|
|
||
| Если ТекТип = Тип("Булево") Тогда | ||
| Результат = Формат(Значение, "БЛ=Ложь; БИ=Истина"); |
There was a problem hiding this comment.
Учесть сценарий частичного совпадения типов.
В ПолучитьТекстЗначения (строки 628–639), при проверке типов внутри ТипВсеСсылки() возможны коллизии, когда один тип (например, ПланВидовХарактеристик) входит одновременно в несколько наборов ссылок. Рекомендуется уточнить условие, используя точную проверку принадлежности к конкретному типу, чтобы избежать некорректных преобразований.
| Процедура ВыполнитьКодНаСервере() | ||
| Выполнить(ТекстКод1С.ПолучитьТекст()); | ||
| КонецПроцедуры |
There was a problem hiding this comment.
Учесть обработку исключений при выполнении кода на сервере.
В процедуре ВыполнитьКодНаСервере (строки 72–74) вызывается Выполнить(), но нет блока Попытка…Исключение. Необработанные исключения приведут к прерыванию работы, что нежелательно в пользовательском сценарии.
&НаСервере
Процедура ВыполнитьКодНаСервере()
+ Попытка
Выполнить(ТекстКод1С.ПолучитьТекст());
+ Исключение
+ // Логирование и обработка ошибки
+ Сообщить("Ошибка при выполнении кода: " + ОписаниеОшибки(), СтатусСообщения.Важно);
+ КонецПопытки;
КонецПроцедуры📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Процедура ВыполнитьКодНаСервере() | |
| Выполнить(ТекстКод1С.ПолучитьТекст()); | |
| КонецПроцедуры | |
| &НаСервере | |
| Процедура ВыполнитьКодНаСервере() | |
| Попытка | |
| Выполнить(ТекстКод1С.ПолучитьТекст()); | |
| Исключение | |
| // Логирование и обработка ошибки | |
| Сообщить("Ошибка при выполнении кода: " + ОписаниеОшибки(), СтатусСообщения.Важно); | |
| КонецПопытки; | |
| КонецПроцедуры |
There was a problem hiding this comment.
@Kyrales А точно нужен метод "Выполнить" в генераторе?
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
Kyrales
changed the title
|
@Kyrales Можешь сделать небольшое описание инструмента в документации, например тут |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
documentation/docs/features/test-data/object-builder-generator.md (2)
1-4: Рекомендуется добавить дополнительные метаданные.Для улучшения SEO и навигации рекомендуется добавить следующие метаданные:
- description: краткое описание функционала
- keywords: ключевые слова для поиска
--- tags: [Начало, Тестовые данные] sidebar_position: 2 +description: Автоматическая генерация кода для конструктора объектов на основе выбранных ссылок +keywords: [генератор кода, конструктор объектов, тестовые данные] ---
7-15: Улучшите форматирование для повышения читаемости.Рекомендуется:
- Добавить подзаголовки для разделения контента
- Использовать маркированные списки для шагов
- Выделить ключевые термины
# Генератор кода для Конструктор объекта -Для возможности быстрой генерации данных используйте обработку автоматической генерации кода `Генератор кода`. Работает по любым выбранным ссылкам из справочника и документа. На основе выбранных ссылок формируется готовый код в виде `КонструкторОбъектов()`. +## Описание + +Для возможности быстрой генерации данных используйте обработку автоматической генерации кода `Генератор кода`. Функционал включает: +* Работу с любыми выбранными ссылками из справочника и документа +* Формирование готового кода в виде `КонструкторОбъектов()`  Обработка позволяет быстро создавать необходимый набор тестовых данных, которые в дальнейшем можно использовать для написания тестов. +## Использование + Перед выбором ссылок необходимо выбрать режим: "Yaxunit: Конструктор объектов" +## Пример использования + Например: Требуется создать контрагента с наличием контактной информации (КИ). Если собирать это вручную, то займет очень много времени, т.к. много разных специализированных реквизитов КИ надо заполнить. Обработка позволит создать тут же по выбранной ссылке нужный код, который можем перенести в тест и там уже отредактировать.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
documentation/docs/features/test-data/images/gen-code.pngis excluded by!**/*.png
📒 Files selected for processing (1)
documentation/docs/features/test-data/object-builder-generator.md(1 hunks)
|
|
||
| Перед выбором ссылок необходимо выбрать режим: "Yaxunit: Конструктор объектов" | ||
|
|
||
| Например: Требуется создать контрагента с наличием контактной информации (КИ). Если собирать это вручную, то займет очень много времени, т.к. много разных специализированных реквизитов КИ надо заполнить. Обработка позволит создать тут же по выбранной ссылке нужный код, который можем перенести в тест и там уже отредактировать. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Добавьте важные разделы в документацию.
Для полноты документации рекомендуется добавить следующие разделы:
- Предварительные требования
- Ограничения и известные проблемы
- Обработка ошибок
- Примеры кода до и после генерации
Хотите, чтобы я помог составить содержание для этих разделов?
documentation/docs/features/test-data/object-builder-generator.md
Outdated
Show resolved
Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Close #488
Описание изменений
Автоматическая генерация кода по выбранным ссылкам Справочника и Документа в виде КонструкторОбъектов().
Позволяет быстро и эффективно создавать необходимый набор тестовых данных, которые в дальнейшем можно использовать для написания тестов.
Перед выбором ссылок необходимо выбрать режим: "Yaxunit: Конструктор объектов"
Например: Требуется создать контрагента с наличием контактной информации (КИ). Если собирать это вручную, то займет очень много времени, т.к. много разных специализированных реквизитов КИ надо заполнить. Обработка позволит создать тут же по выбранной ссылке нужный код, который можем перенести в тест и там уже отредактировать.
Close #<Укажите номер issue для автоматического закрытия после принятия реквеста>
Summary by CodeRabbit
Заметки о выпуске
Новые функции
Улучшения
Документация