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

feat: add support for builder pattern in QuerySpec #94

Merged
merged 2 commits into from
Jul 1, 2024
Merged

Conversation

mlopezFC
Copy link
Member

@mlopezFC mlopezFC commented Jun 25, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced QuerySpec model with the @Builder annotation for easier instantiation.
  • Chores

    • Updated project version to 1.1.0-SNAPSHOT for various modules to align with new release.

@mlopezFC mlopezFC requested a review from javier-godoy June 25, 2024 21:57
Copy link

coderabbitai bot commented Jun 25, 2024

Walkthrough

The primary changes across multiple pom.xml files involve updating the version from 1.0.1-SNAPSHOT to 1.1.0-SNAPSHOT. Additionally, the QuerySpec.java file in backend-core-model has been modified to replace an AccessLevel import with a Builder annotation, enhancing the class’s functionality.

Changes

Files Change Summary
backend-core-data/pom.xml, backend-core-model/pom.xml, backend-core-business-impl/pom.xml, backend-core-business-spring-impl/pom.xml, pom.xml Updated version from 1.0.1-SNAPSHOT to 1.1.0-SNAPSHOT.
backend-core-model/src/main/java/.../QuerySpec.java Replaced import lombok.AccessLevel; with import lombok.Builder; and added @Builder annotation.

Poem

In files of code, the numbers rise,
From 1.0.1 to newer skies,
With Builder's touch, the changes flow,
To guide our queries, set to go!
A version bump, a small delight,
Embracing progress, day and night.
~ CodeRabbit 🐇✨


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

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.
    • @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 as 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.

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.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6c23b71 and 2b677c7.

Files selected for processing (8)
  • backend-core-business-impl/pom.xml (1 hunks)
  • backend-core-business-spring-impl/pom.xml (1 hunks)
  • backend-core-business/pom.xml (1 hunks)
  • backend-core-data-impl/pom.xml (1 hunks)
  • backend-core-data/pom.xml (1 hunks)
  • backend-core-model/pom.xml (1 hunks)
  • backend-core-model/src/main/java/com/flowingcode/backendcore/model/QuerySpec.java (1 hunks)
  • pom.xml (1 hunks)
Files skipped from review due to trivial changes (7)
  • backend-core-business-impl/pom.xml
  • backend-core-business-spring-impl/pom.xml
  • backend-core-business/pom.xml
  • backend-core-data-impl/pom.xml
  • backend-core-data/pom.xml
  • backend-core-model/pom.xml
  • pom.xml
Additional comments not posted (2)
backend-core-model/src/main/java/com/flowingcode/backendcore/model/QuerySpec.java (2)

29-29: Updated import statement to include lombok.Builder.

The change from AccessLevel to Builder reflects the addition of the @Builder annotation, aligning with the PR's objectives to enhance the QuerySpec class with builder pattern functionality.


33-33: Addition of @Builder annotation to QuerySpec.

This enhancement introduces a builder pattern, which is beneficial for creating instances of QuerySpec with optional parameters in a clean and readable manner. Ensure that all fields in the class are compatible with the builder pattern, especially considering the presence of final fields and complex initializations.

@javier-godoy javier-godoy changed the title Issue 93 feat: add support for builder pattern in QuerySpec Jun 26, 2024
@javier-godoy
Copy link
Member

May we discuss whether fluent setters would provide better DX than Lombok @Builder?

Copy link
Member

@javier-godoy javier-godoy left a comment

Choose a reason for hiding this comment

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

mlopezFC added 2 commits July 1, 2024 13:39
Make the creation of new QuerySpec instances easier by using chained
Accessors. This make the feature not binary compatible, but given that
we're just returning QuerySpecs instead of void, everything should
compile, thus this is not a breaking change.

Closes #93
Copy link

sonarqubecloud bot commented Jul 1, 2024

@mlopezFC
Copy link
Member Author

mlopezFC commented Jul 1, 2024

#94 (comment)

Made a different approach with Accessors

@mlopezFC mlopezFC requested a review from javier-godoy July 1, 2024 16:46
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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2b677c7 and a852b5d.

Files selected for processing (8)
  • backend-core-business-impl/pom.xml (1 hunks)
  • backend-core-business-spring-impl/pom.xml (1 hunks)
  • backend-core-business/pom.xml (1 hunks)
  • backend-core-data-impl/pom.xml (1 hunks)
  • backend-core-data/pom.xml (1 hunks)
  • backend-core-model/pom.xml (1 hunks)
  • backend-core-model/src/main/java/com/flowingcode/backendcore/model/QuerySpec.java (3 hunks)
  • pom.xml (1 hunks)
Files skipped from review as they are similar to previous changes (8)
  • backend-core-business-impl/pom.xml
  • backend-core-business-spring-impl/pom.xml
  • backend-core-business/pom.xml
  • backend-core-data-impl/pom.xml
  • backend-core-data/pom.xml
  • backend-core-model/pom.xml
  • backend-core-model/src/main/java/com/flowingcode/backendcore/model/QuerySpec.java
  • pom.xml

@javier-godoy javier-godoy merged commit 239ffdd into master Jul 1, 2024
2 checks passed
@javier-godoy javier-godoy deleted the issue-93 branch July 1, 2024 17:08
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.

2 participants