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 dynamic filename #143

Merged
merged 1 commit into from
Sep 30, 2024
Merged

feat: add support for dynamic filename #143

merged 1 commit into from
Sep 30, 2024

Conversation

javier-godoy
Copy link
Member

@javier-godoy javier-godoy commented Sep 26, 2024

Close #113

Summary by CodeRabbit

  • New Features

    • Enhanced file name handling for exported resources, allowing for dynamic file name generation.
    • Introduced a method to append file extensions for exported files.
  • Version Update

    • Updated the version of the grid-exporter-addon to 2.5.0-SNAPSHOT.

Copy link

coderabbitai bot commented Sep 26, 2024

Walkthrough

The pull request introduces changes to the grid-exporter-addon, updating its version and enhancing the GridExporter class. The version number is incremented from 2.4.1-SNAPSHOT to 2.5.0-SNAPSHOT. The GridExporter class is modified to support dynamic file name generation by replacing the static fileName variable with a fileNameSupplier, allowing users to specify file names using a supplier function.

Changes

File Change Summary
pom.xml Updated version number from 2.4.1-SNAPSHOT to 2.5.0-SNAPSHOT.
src/main/java/com/flowingcode/vaadin/addons/gridexporter/GridExporter.java Replaced fileName variable with fileNameSupplier, updated methods for dynamic file name handling, and added a method for appending file extensions.

Assessment against linked issues

Objective Addressed Explanation
Add support for dynamic filename (#113)

🐰 Hop, hop, hooray! The filenames now play,
With a supplier so bright, they dance in the light.
No more fixed names to bind,
Just dynamic joy, oh so kind!
Exporting with flair, a rabbit's delight,
In the world of code, everything feels right! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fbc1e9f and 9ab519b.

📒 Files selected for processing (2)
  • pom.xml (1 hunks)
  • src/main/java/com/flowingcode/vaadin/addons/gridexporter/GridExporter.java (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • pom.xml
  • src/main/java/com/flowingcode/vaadin/addons/gridexporter/GridExporter.java

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

@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: 3

🧹 Outside diff range and nitpick comments (2)
src/main/java/com/flowingcode/vaadin/addons/gridexporter/GridExporter.java (2)

497-497: Provide custom message in Objects.requireNonNull

In the getFileName(String extension) method, adding a custom message to Objects.requireNonNull(getFileName()) will provide clearer feedback if the file name is null.

Suggested change:

-return Objects.requireNonNull(getFileName()) + "." + extension;
+return Objects.requireNonNull(getFileName(), "File name cannot be null") + "." + extension;

506-507: Add Javadoc comment for setFileName(String fileName)

To maintain consistency and improve documentation, consider adding a Javadoc comment for the setFileName(String fileName) method, explaining its purpose and usage.

Suggested addition:

/**
 * Sets a static filename for the exported file.
 *
 * @param fileName the static name of the exported file, without extension.
 */
public void setFileName(String fileName) {
    fileNameSupplier = () -> fileName;
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7ac1962 and fbc1e9f.

📒 Files selected for processing (2)
  • pom.xml (1 hunks)
  • src/main/java/com/flowingcode/vaadin/addons/gridexporter/GridExporter.java (5 hunks)
🔇 Additional comments (1)
pom.xml (1)

7-7: Version update looks good.

The version increment from 2.4.1-SNAPSHOT to 2.5.0-SNAPSHOT is appropriate for introducing new features like dynamic filename support. This change aligns with semantic versioning principles.

Let's verify if this version change is consistent across the project:

✅ Verification successful

The initial version update is correct, but let's ensure consistency across the project.


Version update is consistent across the project.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any inconsistencies in version numbers across the project

# Search for version numbers in all files
echo "Files containing version numbers:"
rg -n '2\.5\.0-SNAPSHOT|2\.4\.1-SNAPSHOT' --type-add 'xml:*.xml' --type-add 'java:*.java' --type xml --type java

# Check for any remaining occurrences of the old version
echo -e "\nFiles still containing the old version (2.4.1-SNAPSHOT):"
rg -n '2\.4\.1-SNAPSHOT' --type-add 'xml:*.xml' --type-add 'java:*.java' --type xml --type java

# Check for any premature occurrences of the new version
echo -e "\nFiles already containing the new version (2.5.0-SNAPSHOT) outside pom.xml:"
rg -n '2\.5\.0-SNAPSHOT' --type-add 'xml:*.xml' --type-add 'java:*.java' --type xml --type java | grep -v 'pom.xml'

Length of output: 744


Script:

#!/bin/bash
# Description: Verify that all instances of version 2.4.1-SNAPSHOT have been updated to 2.5.0-SNAPSHOT

# Check for any files still containing the old version
echo "Checking for remaining occurrences of 2.4.1-SNAPSHOT:"
rg -n '2\.4\.1-SNAPSHOT' --type-add 'xml:*.xml' --type-add 'java:*.java' --type xml --type java

# Confirm that pom.xml contains the new version
echo -e "\nConfirming pom.xml contains 2.5.0-SNAPSHOT:"
rg -n '2\.5\.0-SNAPSHOT' pom.xml

# Check that no other files contain the new version
echo -e "\nChecking for 2.5.0-SNAPSHOT outside of pom.xml:"
rg -n '2\.5\.0-SNAPSHOT' --type-add 'xml:*.xml' --type-add 'java:*.java' --type xml --type java | grep -v 'pom.xml'

Length of output: 616

Copy link

Copy link
Member

@paodb paodb left a comment

Choose a reason for hiding this comment

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

LGTM

@paodb paodb merged commit 543b4a4 into master Sep 30, 2024
3 checks passed
@paodb paodb deleted the feat-113 branch September 30, 2024 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Pending release
Development

Successfully merging this pull request may close these issues.

Add support for dynamic filename
2 participants