Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

349 / добавлен метод генерации комбинаций вариантов #454

Merged
merged 4 commits into from
Dec 8, 2024

Conversation

alkoleft
Copy link
Member

@alkoleft alkoleft commented Dec 7, 2024

Описание изменений


  • Добавлены тесты
  • Изменения отражены в документации (при необходимости)

Close #349

Summary by CodeRabbit

  • Новые функции

    • Добавлена функция ДобавитьКомбинации для обработки массивов параметров.
    • Введены процедуры для тестирования комбинаций параметров: ИсполняемыеСценарии, Варианты, ДобавитьКомбинации_2х3, ДобавитьКомбинации_3х2, ДобавитьКомбинации_1х1, ДобавитьКомбинации_РазнаяРазмерность, Добавить, и СписокВариантов.
  • Исправления ошибок

    • Улучшена обработка ошибок в функции Варианты с более информативными сообщениями.
    • Добавлена процедура для обработки ошибок чтения метаданных.
  • Документация

    • Обновлена документация по тестовой вариативности, включая примеры использования параметризованных тестов и тестовых вариантов.
  • Общие изменения

    • Обновлены тесты для учёта новых наборов и улучшена обработка ошибок при загрузке тестов.
    • Добавлен новый общий модуль "ОМ_ЮТКонструкторВариантов" в конфигурацию.

Copy link

coderabbitai bot commented Dec 7, 2024

Walkthrough

В данном пулл-запросе внесены изменения в файл Module.bsl, улучшая функциональность функций Варианты и Добавить, а также добавляя новую функцию ДобавитьКомбинации. Функция Варианты теперь включает улучшенное управление ошибками и новую структуру для параметров. Функция Добавить обновлена для работы с новой структурой, а ДобавитьКомбинации позволяет обрабатывать массивы параметров. Также добавлены новые процедуры для тестирования этих функций и создан новый XML файл для метаданных модуля.

Changes

Файл Изменения
exts/yaxunit/src/CommonModules/ЮТКонструкторВариантов/Module.bsl Добавлены функции: ДобавитьКомбинации, ДобавитьВарианты; улучшено управление ошибками в Варианты.
tests/src/CommonModules/ОМ_ЮТКонструкторВариантов/Module.bsl Добавлены процедуры для тестирования: ИсполняемыеСценарии, Варианты, ДобавитьКомбинации_X, Добавить.
tests/src/CommonModules/ОМ_ЮТКонструкторВариантов/ОМ_ЮТКонструкторВариантов.mdo Добавлен новый класс метаданных для модуля с атрибутами.
tests/src/CommonModules/ОМ_ЮТЧитательСлужебный/Module.bsl Добавлена процедура ИсполняемыеСценарииМодуляСОшибкойЧтения; обновлены процедуры ЗагрузитьТесты, ИсполняемыеСценарииМодуля.
tests/src/Configuration/Configuration.mdo Добавлен новый общий модуль ОМ_ЮТКонструкторВариантов.

Assessment against linked issues

Objective Addressed Explanation
Реализовать метод для генерации комбинаций значений (349)

Possibly related PRs

  • 120 / Конструктор движений #413: Изменения в этом PR вводят новые функции, связанные с управлением данными в контексте, что может быть актуально для новой функции ДобавитьКомбинации.
  • Доработать сравнение таблиц. Добавить вывод различий #290: Этот PR улучшает сравнение таблиц и табличных документов, что может быть связано с изменениями в основном PR, касающимися обработки и проверки новых структур и параметров в функциях Варианты и Добавить.

🐇 В мире комбинаций, где варианты растут,
Я, кролик, с радостью новые функции несу!
Добавить, проверить — всё в одном месте,
С комбинациями играем, без лишнего бремени.
Пусть каждый вариант будет в радость,
В нашем коде — порядок и сладость! 🌼


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SonarQube Quality Gate failed! failed

bug 0 Bugs
vulnerability 0 Vulnerabilities
code_smell 1 Code Smells

No data Coverage
duplication_lt_3 0.00% Duplication

Варианты.КоличествоРеквизитов = Вариант.Количество();
Попытка
//@skip-check module-unused-local-variable
Проверка = Новый Структура(Реквизиты);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔗Удалите неиспользуемую переменную Проверка

CODE_SMELL Codesmell  MAJOR Major

badpractice brainoverload unused  Why is this an issue?

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
exts/yaxunit/src/CommonModules/ЮТКонструкторВариантов/Module.bsl (1)

74-86: Рефакторинг функции Добавить для устранения дублирования кода

В условных операторах функции Добавить присутствует дублирование кода при создании структуры Вариант. Рекомендуется упростить логику, используя массив параметров и цикл для создания структуры с переменным количеством реквизитов.

Предлагаемый рефакторинг:

Параметры = Новый Массив();
Параметры.Добавить(Параметр1);
Параметры.Добавить(Параметр2);
Параметры.Добавить(Параметр3);
Параметры.Добавить(Параметр4);
Параметры.Добавить(Параметр5);
Параметры.Добавить(Параметр6);
Параметры.Добавить(Параметр7);

Параметры = Параметры[0:Варианты.КоличествоРеквизитов - 1];
Вариант = Новый Структура(Варианты.СтрокаРеквизиты, Параметры);
tests/src/CommonModules/ОМ_ЮТКонструкторВариантов/Module.bsl (1)

56-82: Проверка генерации комбинаций в ДобавитьКомбинации_2х3

Тест проверяет корректность генерации комбинаций для двух реквизитов с тремя значениями каждого. Логика теста верна, ожидаемый результат соответствует заданным параметрам.

Рекомендуется добавить проверку на случай, если массивы значений реквизитов пусты или содержат Неопределено.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 604f56d and 1807089.

📒 Files selected for processing (5)
  • exts/yaxunit/src/CommonModules/ЮТКонструкторВариантов/Module.bsl (4 hunks)
  • tests/src/CommonModules/ОМ_ЮТКонструкторВариантов/Module.bsl (1 hunks)
  • tests/src/CommonModules/ОМ_ЮТКонструкторВариантов/ОМ_ЮТКонструкторВариантов.mdo (1 hunks)
  • tests/src/CommonModules/ОМ_ЮТЧитательСлужебный/Module.bsl (1 hunks)
  • tests/src/Configuration/Configuration.mdo (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • tests/src/CommonModules/ОМ_ЮТКонструкторВариантов/ОМ_ЮТКонструкторВариантов.mdo
🔇 Additional comments (8)
exts/yaxunit/src/CommonModules/ЮТКонструкторВариантов/Module.bsl (2)

30-35: Улучшение обработки ошибок при инициализации структуры

Добавление блока Попытка...Исключение при инициализации структуры Проверка = Новый Структура(Реквизиты); обеспечивает более надежную обработку некорректных имен реквизитов, улучшая устойчивость функции Варианты.


160-179: Проверка корректности рекурсии в процедуре ДобавитьВарианты

В процедуре ДобавитьВарианты используется рекурсия для генерации комбинаций вариантов. Рекомендуется убедиться, что базовый случай и условия рекурсии определены корректно, чтобы избежать возможных ошибок переполнения стека или неверного вычисления комбинаций.

tests/src/Configuration/Configuration.mdo (1)

48-48: Добавление нового общего модуля ОМ_ЮТКонструкторВариантов

Включение нового модуля в конфигурацию корректно и синхронизировано с остальными изменениями в коде.

tests/src/CommonModules/ОМ_ЮТКонструкторВариантов/Module.bsl (3)

21-33: Корректная регистрация исполняемых сценариев в процедуре ИсполняемыеСценарии

Процедура ИсполняемыеСценарии правильно добавляет тесты для исполнения, имена тестов и их представления установлены корректно.


37-54: Проверка процедуры Варианты на корректность инициализации контекста

Процедура Варианты корректно инициализирует контекст вариантов и проверяет его параметры. Ассерты в тесте подтверждают правильность работы функции.


85-110: Тестирование комбинаций с тремя реквизитами в ДобавитьКомбинации_3х2

Тест успешно проверяет генерацию комбинаций для трех реквизитов с двумя значениями. Код теста корректен.

tests/src/CommonModules/ОМ_ЮТЧитательСлужебный/Module.bsl (2)

93-93: Обновление ожидаемого количества наборов тестов

В процедуре ЗагрузитьТесты изменено ожидаемое количество наборов тестов с 39 на 40. Это корректно, если в системе действительно добавлен новый набор тестов.


Line range hint 123-135: Добавлена процедура ИсполняемыеСценарииМодуляСОшибкойЧтения для обработки ошибок чтения

Добавление новой процедуры для тестирования сценариев с ошибкой чтения повышает надежность и полноту тестирования.

@github-actions github-actions bot deleted a comment from coderabbitai bot Dec 8, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
exts/yaxunit/src/CommonModules/ЮТКонструкторВариантов/Module.bsl (1)

184-184: Неочевидное присваивание результата сравнения переменной

В строке 184 выражение ПоследняяИтерация = Инд = Ключи.ВГраница(); может быть неправильно истолковано и усложняет понимание кода. Рекомендуется явно выполнить сравнение и присвоение для повышения читаемости.

Примените следующий дифф для исправления:

- ПоследняяИтерация = Инд = Ключи.ВГраница();
+ ПоследняяИтерация = (Инд = Ключи.ВГраница());
documentation/docs/features/variants.md (2)

29-30: Повторяющиеся вызовы .СПараметрами с одинаковыми значениями

В строках 29 и 30 метод .СПараметрами("1", 1, Ложь) вызывается дважды с идентичными параметрами. Возможно, это опечатка. Рекомендуется проверить необходимость дублирования и при необходимости удалить один из вызовов или изменить параметры.


155-155: Орфографическая ошибка в тексте

В строке 155 обнаружена ошибка: следует использовать слово в единственном числе.

Примените следующий дифф для исправления:

- * Падения теста на одном из вариантов не влияет на другие.
+ * Падение теста на одном из вариантов не влияет на другие.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1807089 and ca282f0.

📒 Files selected for processing (2)
  • documentation/docs/features/variants.md (1 hunks)
  • exts/yaxunit/src/CommonModules/ЮТКонструкторВариантов/Module.bsl (5 hunks)
🔇 Additional comments (2)
exts/yaxunit/src/CommonModules/ЮТКонструкторВариантов/Module.bsl (2)

134-134: 🛠️ Refactor suggestion

Использование магического числа "7"

В строке 134 используется магическое число 7 для задания количества параметров. Рекомендуется создать константу с понятным названием, например МаксимальноеКоличествоПараметров, и использовать её вместо числа 7. Это улучшит читаемость и поддерживаемость кода.

Примените следующий дифф для исправления:

+ Константа МаксимальноеКоличествоПараметров = 7;
...
- КоличествоПараметров = 7;
+ КоличествоПараметров = МаксимальноеКоличествоПараметров;

126-132: 🛠️ Refactor suggestion

Слишком много необязательных параметров в функции ДобавитьКомбинации

Функция ДобавитьКомбинации принимает 7 необязательных параметров, что превышает рекомендуемое количество. Рекомендуется уменьшить количество необязательных параметров до 3 или менее и передавать параметры в виде массива или структуры. Это упростит вызов функции и дальнейшую поддержку кода.

Пример исправления:

Функция ДобавитьКомбинации(МассивПараметров) Экспорт
    // МассивПараметров - Массив из массивов значений параметров
    // Дальнейший код адаптировать для работы с массивом параметров
КонецФункции

@alkoleft alkoleft merged commit 0d1bcf2 into develop Dec 8, 2024
4 of 7 checks passed
@alkoleft alkoleft deleted the feature/349 branch December 8, 2024 23:10
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (2)
tests/src/CommonModules/ОМ_ЮТКонструкторВариантов/Module.bsl (2)

28-28: Удалите лишний пробел в названии теста

В строке 28 в представлении теста имеется лишний пробел в конце строки "Комбинация из одного реквизита ". Это может привести к некорректному отображению названия теста.

Предлагаемая правка:

-      .ДобавитьТест("ДобавитьКомбинации_1х1").Представление("Комбинация из одного реквизита ")
+      .ДобавитьТест("ДобавитьКомбинации_1х1").Представление("Комбинация из одного реквизита")

57-156: Устраните дублирование кода в тестовых процедурах

Тестовые процедуры ДобавитьКомбинации_2х3, ДобавитьКомбинации_3х2, ДобавитьКомбинации_1х1 и ДобавитьКомбинации_РазнаяРазмерность содержат повторяющийся код для подготовки ожидаемых результатов и вызова методов. Рекомендуется обобщить их, используя параметризованные тесты или вспомогательные функции, чтобы повысить читаемость и упростить поддержку кода.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ca282f0 and fba49ce.

📒 Files selected for processing (2)
  • exts/yaxunit/src/CommonModules/ЮТКонструкторВариантов/Module.bsl (5 hunks)
  • tests/src/CommonModules/ОМ_ЮТКонструкторВариантов/Module.bsl (1 hunks)
🔇 Additional comments (1)
exts/yaxunit/src/CommonModules/ЮТКонструкторВариантов/Module.bsl (1)

32-32: Удалите неиспользуемую переменную Проверка

Переменная Проверка в строке 32 не используется после инициализации. Рекомендуется удалить переменную или переписать код без ее использования.

Процедура Добавить() Экспорт

Варианты = ЮТКонструкторВариантов.Варианты("Р1, Р2, Р3")
.Добавить(1, , 3, 4)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Исправьте синтаксис вызова метода с пропущенным параметром

В строке 161 при вызове метода Добавить пропущен второй параметр без указания значения: .Добавить(1, , 3, 4). В языке 1С следует явно указывать Неопределено для пропущенных параметров, чтобы избежать ошибок во время выполнения.

Предлагаемая правка:

-    		.Добавить(1, , 3, 4)
+    		.Добавить(1, Неопределено, 3, 4)
📝 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.

Suggested change
.Добавить(1, , 3, 4)
.Добавить(1, Неопределено, 3, 4)

Comment on lines +126 to +161
Функция ДобавитьКомбинации(ЗначенияПараметра1, // BSLLS:NumberOfOptionalParams-off
ЗначенияПараметра2 = Неопределено,
ЗначенияПараметра3 = Неопределено,
ЗначенияПараметра4 = Неопределено,
ЗначенияПараметра5 = Неопределено,
ЗначенияПараметра6 = Неопределено,
ЗначенияПараметра7 = Неопределено) Экспорт

КоличествоПараметров = 7;

ВсеПараметры = Новый Массив(КоличествоПараметров);
ВсеПараметры[0] = ЗначенияПараметра1;
ВсеПараметры[1] = ЗначенияПараметра2;
ВсеПараметры[2] = ЗначенияПараметра3;
ВсеПараметры[3] = ЗначенияПараметра4;
ВсеПараметры[4] = ЗначенияПараметра5;
ВсеПараметры[5] = ЗначенияПараметра6;
ВсеПараметры[6] = ЗначенияПараметра7;

ПараметрыВариантов = ЮТКонтекстСлужебный.ЗначениеКонтекста(КлючКонтекста());
ЗначенияПараметров = Новый Массив(ПараметрыВариантов.КоличествоРеквизитов);

Для Инд = 0 По ПараметрыВариантов.КоличествоРеквизитов - 1 Цикл
ЮТПроверкиСлужебный.ПроверитьТипПараметра(ВсеПараметры[Инд], Тип("Массив"), "ДобавитьКомбинации", "ЗначенияПараметра" + (Инд + 1));
ЗначенияПараметров[Инд] = ВсеПараметры[Инд];
КонецЦикла;

ДобавитьВарианты(ПараметрыВариантов.Варианты,
ЗначенияПараметров,
ПараметрыВариантов.Реквизиты,
0,
Новый Структура(ПараметрыВариантов.СтрокаРеквизиты));

Возврат ЮТКонструкторВариантов;

КонецФункции
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Используйте массив параметров вместо множества опциональных

Метод ДобавитьКомбинации принимает до семи опциональных параметров, что усложняет его расширение и поддержку. Рекомендуется изменить сигнатуру метода так, чтобы он принимал массив или коллекцию параметров. Это позволит работать с произвольным количеством параметров и упростит логику функции.

Предлагаемая сигнатура метода:

Функция ДобавитьКомбинации(МассивЗначенийПараметров) Экспорт
    // Реализация метода с использованием МассивЗначенийПараметров
КонецФункции

alkoleft added a commit that referenced this pull request Dec 9, 2024
349 / добавлен метод генерации комбинаций вариантов
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[NEW] Комбинация значений для конструктора вариантов
1 participant