Skip to content

Add singlePage page Property #58

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

rgomez90
Copy link

@rgomez90 rgomez90 commented May 28, 2025

Summary by CodeRabbit

  • New Features
    • Added support for generating PDFs as a single page, overriding paper size settings. Users can now specify this option when configuring PDF generation.

Fix #57

Copy link

coderabbitai bot commented May 28, 2025

Walkthrough

A new SinglePage property was introduced to control whether a PDF should be generated as a single page. Supporting changes include a new builder method for setting this property and a constant for form data binding. These updates enable easier configuration of the single-page PDF option throughout the codebase.

Changes

File(s) Change Summary
lib/Domain/Builders/Faceted/PagePropertyBuilder.cs Added SetSinglePage(bool singlePage = true) method to set the SinglePage property in the builder.
lib/Domain/Requests/Facets/PageProperties.cs Introduced SinglePage boolean property with attribute and documentation to the PageProperties class.
lib/Infrastructure/Constants.cs Added SinglePage constant string to Constants.Gotenberg.Chromium.Shared.PageProperties.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant PagePropertyBuilder
    participant PageProperties

    Client->>PagePropertyBuilder: SetSinglePage(true)
    PagePropertyBuilder->>PageProperties: SinglePage = true
    Note right of PageProperties: SinglePage property set for PDF generation
Loading

Poem

In the warren of code, a new flag appears,
"SinglePage" now hopping through digital frontiers.
With a builder’s swift paw and a constant so neat,
PDFs unite, their pages complete!
🐇✨ One page to rule them, tidy and bright—
The rabbit approves, it feels just right!

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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: 0

🧹 Nitpick comments (1)
lib/Domain/Requests/Facets/PageProperties.cs (1)

140-144: Well-implemented property with clear documentation.

The SinglePage property is properly implemented with:

  • Correct MultiFormHeader attribute referencing the constant from Constants.cs
  • Appropriate boolean type for the single-page feature
  • Consistent formatting with other properties in the class

The XML documentation clearly explains the purpose, though it could benefit from more specific details about how it interacts with existing paper size settings.

Consider enhancing the documentation to be more specific about the override behavior:

/// <summary>
-/// Get or set a value indicating whether the PDF should be generated as a single page. (Will override the paper size)
+/// Get or set a value indicating whether the PDF should be generated as a single page. 
+/// When true, this setting overrides the PaperWidth and PaperHeight properties to fit all content on a single page.
/// </summary>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 05c1fe7 and ee93213.

📒 Files selected for processing (3)
  • lib/Domain/Builders/Faceted/PagePropertyBuilder.cs (1 hunks)
  • lib/Domain/Requests/Facets/PageProperties.cs (1 hunks)
  • lib/Infrastructure/Constants.cs (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
lib/Domain/Requests/Facets/PageProperties.cs (1)
lib/Infrastructure/Constants.cs (5)
  • Constants (18-294)
  • Gotenberg (51-293)
  • Chromium (175-292)
  • Shared (211-291)
  • PageProperties (226-255)
🔇 Additional comments (2)
lib/Infrastructure/Constants.cs (1)

253-254: LGTM! Clean constant addition following established patterns.

The new SinglePage constant follows the existing naming conventions and is properly placed within the PageProperties class. The camelCase value "singlePage" is consistent with other form field names in the constants.

lib/Domain/Builders/Faceted/PagePropertyBuilder.cs (1)

45-50: Excellent implementation following the builder pattern.

The SetSinglePage method is well-implemented with:

  • Consistent naming convention with other Set* methods
  • Proper method chaining by returning the builder instance
  • Reasonable default value (true) for the optional parameter
  • Clean, focused implementation

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.

How to set SinglePage Property?
1 participant