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.

Sign up for GitHub

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

Jump to bottom

DocumentContext сделан Comparable #3389

Merged
merged 1 commit into from
Jan 19, 2025
Merged

DocumentContext сделан Comparable #3389

merged 1 commit into from
Jan 19, 2025

Conversation

nixel2007
Copy link
Member

@nixel2007 nixel2007 commented Jan 19, 2025 •
edited
Loading

Т.к. он используется как ключ Map, класс обязан имплементировать Comparable

Описание

Связанные задачи

Closes

Чеклист

Общие

  • Ветка PR обновлена из develop
  • Отладочные, закомментированные и прочие, не имеющие смысла участки кода удалены
  • Изменения покрыты тестами
  • Обязательные действия перед коммитом выполнены (запускал команду gradlew precommit)

Для диагностик

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

Дополнительно

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 19, 2025 •
edited
Loading

Walkthrough

Изменения в классе DocumentContext направлены на улучшение его функциональности и соответствие современным практикам Java. Класс теперь реализует интерфейс Comparable, что позволяет сравнивать экземпляры на основе uri и version. Добавлены новые аннотации для генерации методов equals и hashCode, улучшена обработка nullable-полей, обновлены методы работы с токенами и комментариями, а также добавлен геттер для поля version.

Changes

Файл Изменения
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/DocumentContext.java - Добавлена реализация Comparable<DocumentContext>
- Введена аннотация @EqualsAndHashCode
- Добавлен метод compareTo
- Добавлен геттер для version
- Обновлены методы работы с токенами и комментариями

Poem

🐰 В мире кода, где строки танцуют,
DocumentContext теперь сравнивает и внемлет,
Версии, URI - всё на своих местах,
Сравнение стало легким, как птицы в полёт,
Lombok и Java слились в дружный аккорд! 🌟

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d5c952a and a991795.

📒 Files selected for processing (1)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/context/DocumentContext.java (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (21)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: build (23, macOS-latest)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: qodana
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: Analyse
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: Benchmark
🔇 Additional comments (4)
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/DocumentContext.java (4)

46-46: Корректная реализация сравнения объектов!

Добавление интерфейса Comparable и аннотации @EqualsAndHashCode с явным указанием полей - правильное решение для использования DocumentContext в качестве ключа Map.

Also applies to: 49-49, 70-70, 84-85

90-90: Правильный выбор полей для сравнения!

Поля uri и version являются подходящими для реализации equals/hashCode и сравнения, так как они однозначно идентифицируют документ и его состояние.

Also applies to: 97-98

438-443: Отличная реализация метода compareTo!

Реализация:

  • Использует правильный паттерн с Comparator.comparing()
  • Согласована с equals/hashCode
  • Защищена от null значений
  • Обеспечивает естественный порядок сортировки

167-167: Проверьте версию Java в проекте.

Использование метода toList() вместо collect(Collectors.toList()) - это улучшение, но оно требует Java 16+.

Also applies to: 173-173

✅ Verification successful

Использование toList() безопасно

Проект настроен на использование Java 17, поэтому применение метода toList() (требует Java 16+) полностью совместимо.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check Java version requirements in the project
grep -r "sourceCompatibility" . || grep -r "java.version" . || find . -name "pom.xml" -exec grep -l "<java.version>" {} \;

Length of output: 99

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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.

coderabbitai[bot]
coderabbitai bot reviewed Jan 19, 2025
View reviewed changes
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)
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/DocumentContext.java (1)

438-443: Корректная реализация compareTo с защитой от null

Реализация метода compareTo:

  • Использует правильный порядок сравнения (сначала uri, затем version)
  • Защищена от null с помощью @nonnull
  • Согласована с equals/hashCode

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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between df086dc and d5c952a.

📒 Files selected for processing (1)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/context/DocumentContext.java (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (20)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: Analyse
  • GitHub Check: qodana
  • GitHub Check: Benchmark
  • GitHub Check: build (23, macOS-latest)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (17, ubuntu-latest)
🔇 Additional comments (3)
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/DocumentContext.java (3)

46-46: Корректная реализация для использования в качестве ключа Map

Добавление интерфейса Comparable и аннотации @EqualsAndHashCode обеспечивает корректное поведение класса при использовании в качестве ключа Map. Импорты логично дополняют новую функциональность.

Also applies to: 49-49, 70-70, 84-85

90-91: Правильный выбор полей для сравнения и хеширования

Аннотация @EqualsAndHashCode.Include для полей uri и version обеспечивает согласованность между equals/hashCode и compareTo, что является важным требованием для корректной работы коллекций.

Also applies to: 97-98

167-167: Улучшение безопасности при работе с токенами

Использование toList() вместо collect(Collectors.toList()) не только упрощает код, но и возвращает неизменяемый список, что повышает безопасность API.

Also applies to: 173-173

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 19, 2025 •
edited
Loading

Qodana for JVM

76 new problems were found

Inspection name Severity Problems
Field may be 'final' 🔶 Warning 55
Lombok @Getter may be used 🔶 Warning 11
@NotNull/@Nullable problems 🔶 Warning 5
Stream API call chain can be simplified 🔶 Warning 5

💡 Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Detected 100 dependencies

Third-party software list

This page lists the third-party software dependencies used in bsl-language-server

Dependency Version Licenses
aho-corasick-double-array-trie 1.2.2 Apache-2.0
aspectjrt 1.9.22.1 Apache-2.0
checker-qual 3.43.0 MIT
classgraph 4.8.179 MIT
commons-beanutils 1.9.4 Apache-2.0
commons-collections 3.2.2 Apache-2.0
commons-collections4 4.4 Apache-2.0
commons-digester 2.1 Apache-2.0
commons-exec 1.4.0 Apache-2.0
commons-io 2.17.0 Apache-2.0
commons-lang3 3.17.0 Apache-2.0
commons-logging 1.2 Apache-2.0
commons-pool2 2.12.0 Apache-2.0
commons-text 1.10.0 Apache-2.0
commons-validator 1.7 Apache-2.0
english-pos-dict 0.3 LGPL-2.1-only
error_prone_annotations 2.28.0 Apache-2.0
grpc-netty-shaded 1.66.0 Apache-2.0
gson 2.11.0 Apache-2.0
guava 33.3.1-jre Apache-2.0
hunspell 2.1.2 Apache-2.0
istack-commons-runtime 4.1.2 BSD-3-Clause
j2objc-annotations 3.0.0 Apache-2.0
jackson-annotations 2.18.2 Apache-2.0
jackson-core 2.18.2 Apache-2.0
jackson-databind 2.18.2 Apache-2.0
jackson-datatype-jdk8 2.18.2 Apache-2.0
jackson-datatype-jsr310 2.18.2 Apache-2.0
jackson-module-parameter-names 2.18.2 Apache-2.0
jakarta.activation-api 2.1.3 BSD-3-Clause
jakarta.annotation-api 2.1.1 Classpath-exception-2.0
EPL-2.0
GPL-2.0-only
jakarta.websocket-api 2.1.1 Classpath-exception-2.0
EPL-2.0
GPL-2.0-only
jakarta.xml.bind-api 4.0.2 BSD-3-Clause
java-diff-utils 4.12 Apache-2.0
java-sarif 2.0 MIT
javax.activation-api 1.2.0 CDDL-1.1
GPL-2.0-only
javax.annotation-api 1.3.2 CDDL-1.0
GPL-2.0-only
ORACLE-OPENJDK-EXCEPTION-2.0
jaxb-api 2.3.0 CDDL-1.1
GPL-2.0-only
ORACLE-OPENJDK-EXCEPTION-2.0
jaxb-core 4.0.5 BSD-3-Clause
jaxb-runtime 4.0.5 BSD-3-Clause
jgrapht-core 1.5.2 EPL-1.0
LGPL-2.0-or-later
jline-native 3.24.1 BSD-3-Clause
jline-terminal 3.24.1 BSD-3-Clause
jna-platform 5.12.1 Apache-2.0
jna 5.12.1 Apache-2.0
jsr305 3.0.2 Apache-2.0
jul-to-slf4j 2.0.16 MIT
language-detector 0.6 Apache-2.0
language-en 6.5 LGPL-2.0-or-later
language-ru 6.5 LGPL-2.0-or-later
languagetool-core 6.5 LGPL-2.0-or-later
log4j-api 2.24.3 Apache-2.0
log4j-to-slf4j 2.24.3 Apache-2.0
lombok 1.18.36 BSD-3-CLAUSE-NO-TRADEMARK
MIT
lucene-backward-codecs 5.5.5 Apache-2.0
lucene-core 5.5.5 Apache-2.0
micrometer-commons 1.14.2 Apache-2.0
micrometer-core 1.14.2 Apache-2.0
micrometer-observation 1.14.2 Apache-2.0
micrometer-registry-prometheus 1.14.2 Apache-2.0
mxparser 1.2.2 xpp
opennlp-chunk-models 1.5 Apache-2.0
opennlp-postag-models 1.5 Apache-2.0
opennlp-tokenize-models 1.5 Apache-2.0
opennlp-tools 1.9.4 Apache-2.0
openregex 1.1.1 LGPL-2.0-or-later
progressbar 0.10.1 MIT
proto-google-common-protos 2.41.0 Apache-2.0
segment 2.0.1 MIT
simpleclient 0.16.0 Apache-2.0
simpleclient_guava 0.16.0 Apache-2.0
simpleclient_tracer_common 0.16.0 Apache-2.0
simpleclient_tracer_otel 0.16.0 Apache-2.0
simpleclient_tracer_otel_agent 0.16.0 Apache-2.0
slf4j-api 2.0.16 MIT
snakeyaml 2.3 Apache-2.0
spring-aop 6.2.1 Apache-2.0
spring-beans 6.2.1 Apache-2.0
spring-boot-autoconfigure 3.4.1 Apache-2.0
spring-boot-starter-json 3.4.1 Apache-2.0
spring-boot-starter-logging 3.4.1 Apache-2.0
spring-boot-starter-tomcat 3.4.1 Apache-2.0
spring-boot-starter-web 3.4.1 Apache-2.0
spring-boot-starter-websocket 3.4.1 Apache-2.0
spring-boot-starter 3.4.1 Apache-2.0
spring-boot 3.4.1 Apache-2.0
spring-context 6.2.1 Apache-2.0
spring-core 6.2.1 Apache-2.0
spring-expression 6.2.1 Apache-2.0
spring-jcl 6.2.1 Apache-2.0
spring-messaging 6.2.1 Apache-2.0
spring-web 6.2.1 Apache-2.0
spring-webmvc 6.2.1 Apache-2.0
spring-websocket 6.2.1 Apache-2.0
tomcat-embed-core 10.1.34 Apache-2.0
CDDL-1.0
PROPRIETARY-LICENSE
tomcat-embed-el 10.1.34 Apache-2.0
tomcat-embed-websocket 10.1.34 Apache-2.0
txw2 4.0.5 BSD-3-Clause
vavr-match 0.10.2 Apache-2.0
vavr 0.10.2 Apache-2.0
Contact Qodana team

Contact us at [email protected]

@nixel2007
DocumentContext сделан Comparable
a991795 
Т.к. он используется как ключ Map, класс обязан имплементировать Comparable
@nixel2007 nixel2007 force-pushed the fix/document-context-comparable branch from d5c952a to a991795 Compare January 19, 2025 13:59
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
E Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

@nixel2007 nixel2007 merged commit ebc617b into develop Jan 19, 2025
40 of 41 checks passed
@nixel2007 nixel2007 deleted the fix/document-context-comparable branch January 19, 2025 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@nixel2007