SDWebImagePDFCoder icon indicating copy to clipboard operation
SDWebImagePDFCoder copied to clipboard
verified publisher icon SDWebImage

Render by PDFKit on iOS

Open PandexLee opened this issue 1 year ago • 2 comments

Summary by CodeRabbit

  • Refactor

    • Enhanced the PDF rendering process to deliver more accurate page display and robust error handling, ensuring a clearer and more reliable viewing experience.

  • Chore

    • Implemented internal configuration improvements to optimize compatibility and performance on Mac systems.

This update contributes to a smoother, more stable experience when viewing PDFs.

PandexLee avatar Mar 28 '25 10:03 PandexLee

Walkthrough

This pull request introduces two main changes. A new IDEWorkspaceChecks.plist file has been added to the Xcode workspace in the SDWebImagePDFCoder project, which includes a key for indicating that a 32-bit Mac compatibility warning has been computed. Additionally, the createVectorPDFWithData:pageNumber: method in SDImagePDFCoder.m has been refactored to leverage PDFKit, replacing the earlier Core Graphics approach. This refactor includes creating a PDFDocument, validating the document and page bounds, and adjusting the drawing process.

Changes

File Path Change Summary
SDWebImagePDFCoder.xcodeproj/.../IDEWorkspaceChecks.plist Added a new XML plist file containing the key IDEDidComputeMac32BitWarning set to true to flag a computed 32-bit Mac warning.
SDWebImagePDFCoder/Classes/SDImagePDFCoder.m Refactored createVectorPDFWithData:pageNumber: to use PDFKit. Replaced Core Graphics PDF handling with PDFDocument creation, enhanced page range checks, and updated drawing logic.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant S as SDImagePDFCoder
    participant P as PDFKit

    C->>S: createVectorPDFWithData(data, pageNumber)
    S->>P: Initialize PDFDocument with data
    P-->>S: Return PDFDocument
    S->>S: Validate document & check page bounds
    alt Valid Page
        S->>P: Retrieve PDFPage for pageNumber
        P-->>S: Return PDFPage
        S->>S: Apply drawing transformation and render page
        S->>C: Return rendered image
    else Invalid Page
        S->>C: Return error/nil
    end

Poem

I hop into code with a skip and a cheer,
New plist files whisper changes that are clear.
PDF pages now twirl in a newfound light,
With PDFKit magic making rendering bright.
From my rabbit ears to each keystroke in flight,
I celebrate this update with playful delight!

🪧 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

coderabbitai[bot] avatar Mar 28 '25 10:03 coderabbitai[bot]

It's welcomed to see your PR!

This lib should support iOS 9+ (at least currently). But PDFKit needs iOS 11+

In the past 3 years, I already have a try for this and has a custom branch. If you can provide a fallback to use PDFKit on iOS 11+, and use CoreGraphics CGPDFContext on iOS 9, it's OK to merge now.

Or, maybe we still need to wait for some day when I decided to drop iOS 9 support.

dreampiggy avatar Apr 03 '25 09:04 dreampiggy