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

search for a match by ID #62

Merged
merged 5 commits into from
May 2, 2024
Merged

search for a match by ID #62

merged 5 commits into from
May 2, 2024

Conversation

denisushakov
Copy link
Contributor

@denisushakov denisushakov commented May 2, 2024

Summary by CodeRabbit

  • Refactor
    • Updated parameter names in exported functions for improved clarity and configuration management, enhancing user interaction with object correspondence and key-value retrieval functions.

Copy link

coderabbitai bot commented May 2, 2024

Walkthrough

The recent software update involves standardizing the parameter name ТипСоответствия to ИдентификаторНастройки in functions related to object correspondences across multiple modules. This change aims to enhance consistency in configuration management while retaining the core functionality of the modules.

Changes

File Path Change Summary
.../__ОбщегоНазначенияПовтИсп/Ext/Module.bsl
.../__ОбщегоНазначенияСервер/Ext/Module.bsl
.../__СоответствияОбъектовИБ/Ext/ManagerModule.bsl
Renamed parameter ТипСоответствия to ИдентификаторНастройки in functions related to object correspondences.

🐇✨

In fields of code where logic threads tight,

A tiny change flickers in the night.

ТипСоответствия fades away,

ИдентификаторНастройки here to stay.

Hop, skip, a code rabbit's delight!

🌟📜✨


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 3ec1143 and c68f2d4.
Files selected for processing (1)
  • src/InformationRegisters/__СоответствияОбъектовИБ/Ext/ManagerModule.bsl (6 hunks)
Additional Context Used
GitHub Check Runs (1)
1C: Project SubSystems Library Sonarqube Results success (5)

src/InformationRegisters/__СоответствияОбъектовИБ/Ext/ManagerModule.bsl: [warning] 36-36: src/InformationRegisters/__СоответствияОбъектовИБ/Ext/ManagerModule.bsl#L36
Длина строки 142 превышает максимально допустимую 120

Additional comments not posted (1)
src/InformationRegisters/__СоответствияОбъектовИБ/Ext/ManagerModule.bsl (1)

108-108: Update the function documentation to reflect the new parameter name.

- //  ТипСоответствия	 - СправочникСсылка.__ТипСоответствияОбъектовИБ - Тип соответствия.
+ //  ИдентификаторНастройки	 - СправочникСсылка.__ТипСоответствияОбъектовИБ - Идентификатор настройки.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

This comment has been minimized.

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: 9

Out of diff range and nitpick comments (2)
src/InformationRegisters/__СоответствияОбъектовИБ/Ext/ManagerModule.bsl (1)

36-36: Ensure the line length does not exceed 120 characters.

Consider breaking the SQL query into multiple lines to adhere to the maximum line length standard.

src/CommonModules/__ОбщегоНазначенияПовтИсп/Ext/Module.bsl (1)

69-69: Ensure the line length does not exceed 120 characters.

Consider breaking the function call into multiple lines to adhere to the maximum line length standard.

@@ -104,7 +105,7 @@
// - Массив - Значения объекта из регистра сведений __СоответствияОбъектовИБ,
// если соответствие одно в массив будет один элемент
//
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ТипСоответствия, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта) Экспорт
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта) Экспорт
Copy link

@coderabbitai coderabbitai bot May 2, 2024

Choose a reason for hiding this comment

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

Update the function documentation to reflect the new parameter name.

- //  ТипСоответствия	 - СправочникСсылка.__ТипСоответствияОбъектовИБ - Тип соответствия.
+ //  ИдентификаторНастройки	 - СправочникСсылка.__ТипСоответствияОбъектовИБ - Идентификатор настройки.

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.

Suggested change
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта) Экспорт
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта) Экспорт
// ИдентификаторНастройки - СправочникСсылка.__ТипСоответствияОбъектовИБ - Идентификатор настройки.

Copy link
Member

Choose a reason for hiding this comment

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

@denisushakov тут тоже

Copy link

Choose a reason for hiding this comment

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

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!

@@ -66,9 +66,13 @@
// Возвращаемое значение:
// - ТаблицаЗначений - Таблица соответствий по отбору.
//
Функция ПолучитьСоответствиеОбъектовИБ(ТипСоответствия, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
Copy link
Member

Choose a reason for hiding this comment

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

@denisushakov тут он прав, в описании осталось старое название параметра

Copy link

Choose a reason for hiding this comment

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

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!

@@ -84,10 +88,10 @@
// - Массив - Значения объекта из регистра сведений __СоответствияОбъектовИБ,
// если соответствие одно в массив будет один элемент
//
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ТипСоответствия, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта) Экспорт
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта) Экспорт
Copy link

Choose a reason for hiding this comment

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

Update the function documentation to reflect the new parameter name.

- //  ТипСоответствия	 - СправочникСсылка.__ТипСоответствияОбъектовИБ - Тип соответствия.
+ //  ИдентификаторНастройки	 - СправочникСсылка.__ТипСоответствияОбъектовИБ - Идентификатор настройки.

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.

Suggested change
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта) Экспорт
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта) Экспорт
// ИдентификаторНастройки - СправочникСсылка.__ТипСоответствияОбъектовИБ - Идентификатор настройки.

This comment has been minimized.

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: 4

@@ -107,12 +107,16 @@
// Возвращаемое значение:
// - Массив - соответствие объектов ИБ в виде структур.
//
Функция ПолучитьСоответствиеОбъектовИБ(ТипСоответствия, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено, ИспользоватьКэш = Ложь) Экспорт
Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено, ИспользоватьКэш = Ложь) Экспорт
Copy link

Choose a reason for hiding this comment

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

Reduce the line length to adhere to the maximum recommended line length of 120 characters.

- Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено, ИспользоватьКэш = Ложь) Экспорт
+ Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, ИспользоватьКэш = Ложь) Экспорт

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.

Suggested change
Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено, ИспользоватьКэш = Ложь) Экспорт
Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, ИспользоватьКэш = Ложь) Экспорт

@@ -132,17 +133,19 @@

ТекстЗапроса =
"ВЫБРАТЬ
| __СоответствияОбъектовИБ.%1 КАК Объект
| СоответствияОбъектовИБ.%1 КАК Объект
Copy link

@coderabbitai coderabbitai bot May 2, 2024

Choose a reason for hiding this comment

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

Correct the SQL query to include the keyword КАК for aliasing.

- |	СоответствияОбъектовИБ.%1 КАК Объект
+ |	СоответствияОбъектовИБ.%1 AS Объект

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.

Suggested change
| СоответствияОбъектовИБ.%1 КАК Объект
| СоответствияОбъектовИБ.%1 AS Объект

Copy link
Member

Choose a reason for hiding this comment

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

@coderabbitai это не язык запросов SQL, в данном контексте для языка запросов 1С используется русскоязычное КАК

Copy link

Choose a reason for hiding this comment

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

@ivanmolodec, thank you for the clarification regarding the use of "КАК" in the 1C query language. I appreciate your guidance and will use this correct terminology in future reviews related to 1C environments.

(\_/)
(o.o)
(> <) Bunny is grateful for your help!


New Learnings Added
User: ivanmolodec
PR: firstBitSportivnaya/PSSL#62
File: src/InformationRegisters/__СоответствияОбъектовИБ/Ext/ManagerModule.bsl:0-0
Timestamp: 2024-05-02T08:05:18.694Z
Learning: In the context of 1C query language, the Russian word "КАК" is used instead of "AS" for aliasing.

Note: Learnings are effective only in the context of specific code segments. To apply general coding guidelines, please configure review instructions.

@@ -789,17 +793,17 @@
// - Массив - Значения объекта из регистра сведений __СоответствияОбъектовИБ,
// если соответствие одно в массив будет один элемент
//
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ТипСоответствия, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта, ИспользоватьКэш = Ложь) Экспорт
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта, ИспользоватьКэш = Ложь) Экспорт
Copy link

Choose a reason for hiding this comment

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

Reduce the line length to adhere to the maximum recommended line length of 120 characters.

- Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта, ИспользоватьКэш = Ложь) Экспорт
+ Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта, ИспользоватьКэш = Ложь) Экспорт

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.

Suggested change
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта, ИспользоватьКэш = Ложь) Экспорт
Функция ПолучитьЗначенияОбъектаСоответствияПоКлючу(ИдентификаторНастройки, ИмяКлюча, ЗначениеКлюча, ИмяОбъекта, ИспользоватьКэш = Ложь) Экспорт

This comment has been minimized.

@denisushakov denisushakov requested a review from ivanmolodec May 2, 2024 07:33
@@ -66,9 +66,13 @@
// Возвращаемое значение:
// - ТаблицаЗначений - Таблица соответствий по отбору.
//
Функция ПолучитьСоответствиеОбъектовИБ(ТипСоответствия, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
Copy link
Member

Choose a reason for hiding this comment

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

@denisushakov тут он прав, в описании осталось старое название параметра

@ivanmolodec ivanmolodec added the invalid This doesn't seem right label May 2, 2024

This comment has been minimized.

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

// Объект1 - ПроизвольныйТип - Объект1.
// Объект2 - ПроизвольныйТип - Объект2.
// Объект3 - ПроизвольныйТип - Объект3.
//
// Возвращаемое значение:
// - ТаблицаЗначений - Таблица соответствий по отбору.
//
Функция ПолучитьСоответствиеОбъектовИБ(ТипСоответствия, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
Copy link

Choose a reason for hiding this comment

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

Consider breaking the function declaration into multiple lines to comply with best practices regarding line length.

- Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
+ Функция ПолучитьСоответствиеОбъектовИБ(
+   ИдентификаторНастройки, 
+   Объект1 = Неопределено, 
+   Объект2 = Неопределено, 
+   Объект3 = Неопределено
+ ) Экспорт

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.

Suggested change
Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
Функция ПолучитьСоответствиеОбъектовИБ(
ИдентификаторНастройки,
Объект1 = Неопределено,
Объект2 = Неопределено,
Объект3 = Неопределено
) Экспорт

"ВЫБРАТЬ
| __СоответствияОбъектовИБ.%1 КАК Объект
"ВЫБРАТЬ РАЗЛИЧНЫЕ
// Подставляем ниже
Copy link
Member

Choose a reason for hiding this comment

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

Подставляем что?)

| РегистрСведений.__СоответствияОбъектовИБ КАК СоответствияОбъектовИБ
|ГДЕ
| СоответствияОбъектовИБ.ТипСоответствия = &ТипСоответствия";
| СоответствияОбъектовИБ.ТипСоответствия КАК ТипСоответствия,
Copy link
Member

Choose a reason for hiding this comment

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

Тут форматирование поплыло, надо один таб вместо много точек (как было в исходном запросе)

Copy link

Passed

Analysis Details

5 Issues

  • Bug 0 Bugs
  • Vulnerability 0 Vulnerabilities
  • Code Smell 5 Code Smells

Coverage and Duplications

  • Coverage No coverage information (0.00% Estimated after merge)
  • Duplications 0.00% Duplicated Code (0.50% Estimated after merge)

Project ID: PSSL

View in SonarQube

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

// Объект1 - ПроизвольныйТип - Объект1.
// Объект2 - ПроизвольныйТип - Объект2.
// Объект3 - ПроизвольныйТип - Объект3.
//
// Возвращаемое значение:
// - Массив - соответствие объектов ИБ в виде структур.
//
Функция ПолучитьСоответствиеОбъектовИБ(ТипСоответствия, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
Copy link

Choose a reason for hiding this comment

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

Consider breaking the function declaration into multiple lines to comply with best practices regarding line length.

- Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
+ Функция ПолучитьСоответствиеОбъектовИБ(
+   ИдентификаторНастройки, 
+   Объект1 = Неопределено, 
+   Объект2 = Неопределено, 
+   Объект3 = Неопределено
+ ) Экспорт

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.

Suggested change
Функция ПолучитьСоответствиеОбъектовИБ(ИдентификаторНастройки, Объект1 = Неопределено, Объект2 = Неопределено, Объект3 = Неопределено) Экспорт
Функция ПолучитьСоответствиеОбъектовИБ(
ИдентификаторНастройки,
Объект1 = Неопределено,
Объект2 = Неопределено,
Объект3 = Неопределено
) Экспорт

@ivanmolodec ivanmolodec merged commit 99a7374 into develop May 2, 2024
4 checks passed
@ivanmolodec ivanmolodec deleted the matchingObj branch May 2, 2024 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
invalid This doesn't seem right
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Изменить получение соответствия объектов ИБ
2 participants