-
-
Notifications
You must be signed in to change notification settings - Fork 399
Add option to trim sheet names #877
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @RiRiSharp, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the Excel export functionality by adding an optional setting to automatically trim sheet names. This feature addresses the common problem of sheet names exceeding Excel's 31-character limit, preventing potential errors during file generation. By enabling the TrimSheetNames option, users can ensure that all generated sheet names conform to Excel's specifications without manual intervention.
Highlights
- New Configuration Option: Introduced
TrimSheetNamesinOpenXmlConfigurationto allow users to control sheet name trimming. - Sheet Name Trimming Logic: Implemented functionality to automatically truncate sheet names to a maximum of 31 characters when
TrimSheetNamesis enabled. - Unit Tests: Added a new theory test (
TestIssue876) to thoroughly validate the sheet name trimming behavior under different conditions.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a new TrimSheetNames option in OpenXmlConfiguration to automatically truncate Excel sheet names that exceed the 31-character limit. The implementation is straightforward and a new constant for the maximum length improves code clarity. The change is accompanied by unit tests to verify the new functionality. However, I've found an issue in one of the new test cases which seems to be based on an incorrect assumption about the library's behavior when trimming is disabled, potentially leading to a failing test. My review includes a detailed comment on how to address this to ensure the test suite is robust.
|
|
||
| [Theory(DisplayName = "#876: Enabling trimming only trims too long values when enabled")] | ||
| [InlineData("ShortName", false, "ShortName")] | ||
| [InlineData("SomeVeryLongNameWithMoreThan32Characters", false, "SomeVeryLongNameWithMoreThan32Characters")] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This test case appears to be based on an incorrect assumption. With TrimSheetNames = false, the library is expected to throw an ArgumentException for sheet names longer than 31 characters, which is the standard Excel limitation and is verified by other tests in this file (e.g., Test_Issue_693_SaveSheetWithLongName). This test case expects the export to succeed, which will likely cause the test to fail.
I recommend removing this InlineData and creating a separate [Fact] test to assert that an ArgumentException is thrown for long sheet names when trimming is disabled. This would ensure both the new feature and the existing validation are correctly tested.
|
Thank you for your contribution, however I feel it's a waste to give users a full fledged configuration option for such a particular edge case. Throwing an exception will do fine in my opinion. I will open another PR and credit you. |
Closes #876