Оптимизация API для получения представления ссылок на объекты, включая локализацию представления #501
Conversation
…и MDO 2. Добавлены методы получения локализованного представления ссылки
WalkthroughВ данном изменении добавлены новые методы для поддержки локализации ссылок на метаданные (MDO-ссылок) в интерфейсах. В интерфейсе CF появляется метод Changes
Sequence Diagram(s)sequenceDiagram
participant Caller as Клиент
participant CF as CF-интерфейс
participant MD as MD-интерфейс
participant Ref as MdoReference
Caller->>CF: getMdoRefLocal(md)
CF->>MD: getMdoRef(getScriptVariant())
alt Скриптовый вариант = ENGLISH
MD->>Ref: getMdoRef()
else Другой вариант
MD->>Ref: getMdoRefRu()
end
Ref-->>MD: Возвращает строковое представление
MD-->>CF: Передаёт локализованную ссылку
CF-->>Caller: Возвращает MDO ссылку
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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: 0
🧹 Nitpick comments (1)
src/main/java/com/github/_1c_syntax/bsl/mdo/MD.java (1)
64-74: Реализация метода getMdoRef с параметром локализации.Метод корректно обрабатывает различные варианты языка разработки, возвращая соответствующее представление ссылки на объект метаданных. Обратите внимание, что метод трактует
ScriptVariant.UNKNOWNтак же, как иScriptVariant.RUSSIAN, что следует из блокаelse. Это поведение подтверждено тестами, но можно было бы уточнить это в документации.Предлагаю уточнить в документации, что
ScriptVariant.UNKNOWNобрабатывается какScriptVariant.RUSSIAN:/** * Строковое представление MDO-Ссылки на объект, локализованное для указанного языка разработки + * Если scriptVariant равен ScriptVariant.ENGLISH, возвращается представление на английском языке. + * В противном случае (включая ScriptVariant.UNKNOWN) возвращается представление на русском языке. */
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
src/main/java/com/github/_1c_syntax/bsl/mdclasses/CF.java(1 hunks)src/main/java/com/github/_1c_syntax/bsl/mdo/MD.java(2 hunks)src/test/java/com/github/_1c_syntax/bsl/mdo/EnumTest.java(2 hunks)src/test/java/com/github/_1c_syntax/bsl/test_utils/MDTestUtils.java(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (13)
- GitHub Check: build (23, ubuntu-latest)
- GitHub Check: build (23, macOS-latest)
- GitHub Check: build (17, windows-latest)
- GitHub Check: build (21, macOS-latest)
- GitHub Check: build (23, windows-latest)
- GitHub Check: build (17, ubuntu-latest)
- GitHub Check: build (21, ubuntu-latest)
- GitHub Check: build (21, windows-latest)
- GitHub Check: build (17, macOS-latest)
- GitHub Check: QA
- GitHub Check: build (23, windows-latest)
- GitHub Check: build (21, windows-latest)
- GitHub Check: build (17, windows-latest)
🔇 Additional comments (5)
src/main/java/com/github/_1c_syntax/bsl/mdclasses/CF.java (1)
164-171: Метод для локализованного представления ссылок соответствует цели PR.Метод
getMdoRefLocal(MD md)корректно реализует требование по получению локализованного представления ссылок на объекты метаданных, используя текущий вариант языка разработки. Документация и реализация выполнены правильно.src/test/java/com/github/_1c_syntax/bsl/test_utils/MDTestUtils.java (1)
113-113: Правильно исключено поле mdoRef из сериализации.Исключение поля
mdoRefиз JSON-сериализации соответствует новому подходу работы с представлениями ссылок через методы, а не через прямой доступ к полю.src/test/java/com/github/_1c_syntax/bsl/mdo/EnumTest.java (2)
24-27: Добавлены необходимые импорты.Корректно добавлены импорты для
ScriptVariantиMdoReference, которые требуются для тестирования новой функциональности.
46-56: Тесты охватывают все варианты локализации ссылок.Добавленные тесты проверяют все сценарии использования новых методов:
- Получение ссылки на английском языке (
ScriptVariant.ENGLISH)- Получение ссылки на русском языке (
ScriptVariant.RUSSIAN)- Обработка неизвестного варианта языка (
ScriptVariant.UNKNOWN)- Проверка метода без параметров (
getMdoRef())Хорошо, что проверяется корректность возвращаемых значений в каждом случае.
src/main/java/com/github/_1c_syntax/bsl/mdo/MD.java (1)
76-81: Реализация метода getMdoRef по умолчанию.Метод без параметров корректно возвращает представление ссылки на английском языке, что является хорошим выбором для значения по умолчанию. Это также подтверждено тестами.
|
Описание
Связанные задачи
Closes
Чеклист
Общие
gradlew precommit)Дополнительно