Fixed exception not being thrown when too long a sheet name was passed as dictionary key #878
Conversation
…d as dictionary key Co-Authored-By: RiRiSharp <30719799+RiRiSharp@users.noreply.github.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @michelebastione, 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 resolves an issue where an exception was not consistently thrown when an invalid sheet name, specifically one exceeding the maximum allowed length, was provided as a dictionary key during Excel export. The changes centralize sheet name validation into a dedicated helper method and integrate this validation across all relevant OpenXmlWriter methods, ensuring that any attempt to use an invalid sheet name now correctly results in an ArgumentException. A new test case confirms this corrected behavior.
Highlights
- Centralized Sheet Name Validation: A new static helper method,
ThrowIfInvalidSheetName, has been introduced inThrowHelper.csto centralize the validation logic for Excel sheet names, checking for null/empty names and names exceeding 31 characters. - Consistent Validation Application: Existing inline sheet name validation in
OpenXmlWriter.cshas been replaced with a call to the newThrowIfInvalidSheetNamehelper. Additionally, this validation is now applied when processing sheets from a dictionary inOpenXmlWriter.DefaultOpenXml.cs, ensuring consistent error handling. - New Test Case: A new test,
TestIssue876, has been added toMiniExcelIssueTests.csto specifically verify that anArgumentExceptionis correctly thrown when an attempt is made to create an Excel sheet with a name longer than 31 characters, addressing the reported issue.
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.
Code Review
This pull request effectively addresses the issue of not throwing an exception for overly long sheet names when using a dictionary. The introduction of a centralized ThrowIfInvalidSheetName helper method is a great improvement for code maintainability and consistency. I've added one suggestion to enhance the new helper method by including the parameter name in the thrown exceptions, which improves debuggability. The addition of a unit test is also excellent.
Resolves #876