String repr of Dimension is system culture sensitive
Gotenberg do not support decimal numbers with comma decimal separator.
Summary by CodeRabbit
-
Chores
- Updated internal configuration to standardize file formatting and manage ignored content.
-
Refactor
- Improved numeric formatting for dimensions to ensure a consistent decimal display across all locales.
-
Tests
- Added automated tests to validate HTML request processing and accurate handling of paper dimensions.
These updates enhance overall consistency and reliability while ensuring uniform behavior in document processing.
Walkthrough
The changes add new configuration rules to handle files with extensions such as .received, .verified, .json, .txt, and .xml by updating the .editorconfig settings. The .gitignore file is modified to exclude received files. New test classes are added for the HTML request builder and for dimension formatting, ensuring that numeric values use a dot as a decimal separator. A corresponding test project targeting .NET 9.0 has also been created and integrated into the solution. Additionally, the Dimension class was updated to use culture-invariant formatting in its string representation.
Changes
| File(s) | Summary |
|---|---|
.editorconfig, .gitignore |
Added settings for files with extensions .received, .verified, .json, .txt, .xml and ignore patterns for .received. |
Gotenberg.Sharp.Api.Client.Tests/.../HtmlRequestBuilderTests.csGotenberg.Sharp.Api.Client.Tests/.../HtmlRequestBuilderTests.*.verified.txt |
Added HTML request builder tests verifying paper dimensions with decimal values and ensuring use of dot as decimal separator. |
lib/Domain/Dimensions/Dimension.cs.../DimensionTests.cs |
Updated Dimension's ToString() to use InvariantCulture and introduced tests confirming correct formatting (dot separator). |
Gotenberg.Sharp.Api.Client.Tests.csprojGotenbergSharpApiClient.sln |
Introduced new .NET 9.0 testing project with required package references and integrated it into the solution. |
Sequence Diagram(s)
sequenceDiagram
participant Test
participant HtmlRequestBuilder
Test->>HtmlRequestBuilder: Create instance
HtmlRequestBuilder->>HtmlRequestBuilder: Add HTML content and parameters (scale, paper dimensions, etc.)
HtmlRequestBuilder->>Test: Build API request message
Test->>Test: Verify correct formatting and decimal separator
sequenceDiagram
participant Test
participant Dimension
Test->>Dimension: Instantiate with value (e.g., 11.7)
Dimension->>Dimension: Convert value to string using InvariantCulture
Dimension-->>Test: Return formatted string "11.7in"
Poem
I'm a rabbit hopping with cheer,
New configs and tests have appeared,
From editor rules to test suite play,
Decimal dots now lead the way.
With each code hop, I dance and rhyme—
A PR celebration, sweet as thyme!
🐰✨
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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR. (Beta)@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
This change is already merged. Thanks for your PR, etc.