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

Добавлен параметр ИсключаемыеОбязательныеРеквизиты в ФикцияОбязательныхПолей() #504

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

Kyrales
Copy link

@Kyrales Kyrales commented Feb 5, 2025

Решение проблем из:
#498
#417

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

Добавлен параметр ИсключаемыеОбязательныеРеквизиты в ФикцияОбязательныхПолей().
Решает проблему лишней генерации данных, в случае если будет точечно далее установлен реквизит через .Установить().
Обновлена справка по методу.


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

Close #498 #417

Summary by CodeRabbit

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

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

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

    • Обновлена информация об авторских правах для отражения текущего года.

Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

Walkthrough

Изменения затрагивают обновление сигнатуры метода ФикцияОбязательныхПолей во всех соответствующих файлах, путем добавления опционального параметра ИсключаемыеОбязательныеРеквизиты. Это позволяет исключать определённые обязательные реквизиты из автоматической генерации данных, оставляя возможность их дальнейшей установки через метод .Установить(). Помимо обновления логики метода, внесены изменения в примеры использования и в заголовки файлов (год авторского права обновлён с 2024 на 2025).

Changes

Файл Изменения
documentation/docs/features/test-data/.../object-builder.md Обновлена сигнатура метода с добавлением параметра ИсключаемыеОбязательныеРеквизиты, обновлён пример использования и добавлены пояснения.
exts/yaxunit/src/{CommonModules/ЮТКонструкторТестовыхДанныхСлужебный/Module.bsl, DataProcessors/ЮТКонструкторТестовыхДанных/Forms/КлиентскийКонструктор/Module.bsl, DataProcessors/ЮТКонструкторТестовыхДанных/ObjectModule.bsl} Обновлена сигнатура процедуры/функции ФикцияОбязательныхПолей с новым параметром (дефолтное значение — пустая строка), обновлены внутренние вызовы и заголовки (год с 2024 на 2025).

Sequence Diagram(s)

sequenceDiagram
    participant Пользователь
    participant Конструктор
    Пользователь->>Конструктор: Вызов ФикцияОбязательныхПолей(ИсключаемыеОбязательныеРеквизиты)
    Конструктор->>Конструктор: Формирование списка исключений
    Конструктор->>Конструктор: Итерация по обязательным полям
    alt Если поле найдено в списке исключений
        Конструктор-->>Конструктор: Пропуск заполнения поля
    else
        Конструктор-->>Конструктор: Заполнение поля
    end
    Конструктор-->>Пользователь: Возврат объекта с заполненными полями
Loading

Assessment against linked issues

Objective Addressed Explanation
Функция исключения обязательных реквизитов (#498)

Possibly related PRs

Suggested reviewers

  • alkoleft

Poem

Я заяц-кодер, скачу по строкам,
Вношу правки легко, словно в мечтах.
Исключаю поля, где их не ждали,
Скрываю реквизиты — код мне по плечу.
Пусть тесты в такт стучат, чуден мой путь!

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

@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

🧹 Nitpick comments (1)
exts/yaxunit/src/CommonModules/ЮТКонструкторТестовыхДанныхСлужебный/Module.bsl (1)

83-88: Рекомендуется добавить комментарий к условию исключения

Комментарий о сложных объектах может быть более информативным. Предлагается уточнить, почему именно эти объекты исключаются.

-			// Исключаем возможность создания, сложных объектов (Например: Организация).
+			// Исключаем возможность автоматического создания сложных объектов (например, Организация),
+			// которые требуют специфической настройки или имеют особые правила заполнения
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2cfb86b and 40b6dbc.

📒 Files selected for processing (4)
  • documentation/docs/features/test-data/data-generation/object-builder.md (3 hunks)
  • exts/yaxunit/src/CommonModules/ЮТКонструкторТестовыхДанныхСлужебный/Module.bsl (2 hunks)
  • exts/yaxunit/src/DataProcessors/ЮТКонструкторТестовыхДанных/Forms/КлиентскийКонструктор/Module.bsl (2 hunks)
  • exts/yaxunit/src/DataProcessors/ЮТКонструкторТестовыхДанных/ObjectModule.bsl (2 hunks)
🔇 Additional comments (8)
exts/yaxunit/src/DataProcessors/ЮТКонструкторТестовыхДанных/Forms/КлиентскийКонструктор/Module.bsl (2)

3-3: LGTM!

Обновление года в информации об авторских правах.


152-154: LGTM!

Добавлен новый параметр ИсключаемыеОбязательныеРеквизиты с корректной документацией и реализацией.

Also applies to: 159-161

exts/yaxunit/src/DataProcessors/ЮТКонструкторТестовыхДанных/ObjectModule.bsl (2)

3-3: LGTM!

Обновление года в информации об авторских правах.


147-148: LGTM!

Добавлен новый параметр ИсключаемыеОбязательныеРеквизиты с корректной документацией и реализацией.

Also applies to: 152-154

exts/yaxunit/src/CommonModules/ЮТКонструкторТестовыхДанныхСлужебный/Module.bsl (2)

3-3: LGTM!

Обновление года в информации об авторских правах.


67-67: LGTM!

Корректная реализация обработки исключаемых обязательных реквизитов с использованием массива.

Also applies to: 74-77

documentation/docs/features/test-data/data-generation/object-builder.md (2)

227-234: LGTM!

Добавлена корректная документация для нового параметра ИсключаемыеОбязательныеРеквизиты.


246-251: LGTM!

Добавлен наглядный пример использования нового параметра с исключением реквизита "Организация".

@alkoleft
Copy link
Member

alkoleft commented Feb 6, 2025

@Kyrales Нет желания дожидаться #285?

@Kyrales
Copy link
Author

Kyrales commented Feb 6, 2025

@Kyrales Нет желания дожидаться #285?

Долго ждать, а вопрос актуален в любом случае

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants