Skip to content
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

Sync upstream commits December #3

Merged
merged 1 commit into from
Dec 15, 2024

Conversation

HungNgien
Copy link

@HungNgien HungNgien commented Dec 15, 2024

Commit Description
4d40c5faeb88456db4d58e6fadd725b94950fd92 Use new safelinks, reuse cleaner

Summary by Sourcery

Enhancements:

  • Refactor the HTML cleaning process by reusing a centralized cleaner configuration.

Summary by Sourcery

Enhancements:

  • Refactor the HTML cleaning process by centralizing the cleaner configuration using a reusable cleaner object.

Copy link

sourcery-ai bot commented Dec 15, 2024

Reviewer's Guide by Sourcery

The PR refactors the HTML cleaning process in the pages view by introducing a centralized bleach Cleaner configuration. The changes move the cleaning configuration from being defined inline to a module-level constant, while also updating the implementation to use new safelinks functionality.

Class diagram for the updated HTML cleaning process

classDiagram
    class PageList {
        +get_context_data(**kwargs)
    }
    class CLEANER {
        +tags
        +attributes
        +protocols
        +filters
    }
    PageList --> CLEANER : uses
    CLEANER : tags = rich_text.ALLOWED_TAGS | {"img", "p", "br", "s", "sup", "sub", "u", "h3", "h4", "h5", "h6"}
    CLEANER : attributes = ALLOWED_ATTRIBUTES
    CLEANER : protocols = rich_text.ALLOWED_PROTOCOLS | {"data"}
    CLEANER : filters = [partial(bleach.linkifier.LinkifyFilter, ...)]
    note for CLEANER "Centralized bleach Cleaner configuration"
Loading

File-Level Changes

Change Details Files
Centralize HTML cleaning configuration
  • Define ALLOWED_ATTRIBUTES as a module-level constant
  • Create a configured CLEANER instance with bleach.Cleaner
  • Add support for safelink_callback in link filtering
  • Update HTML cleaning implementation to use the new CLEANER constant
pretalx_pages/views.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@HungNgien HungNgien marked this pull request as ready for review December 15, 2024 05:53
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @HungNgien - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@mariobehling mariobehling merged commit c4cc2ef into fossasia:main Dec 15, 2024
5 checks passed
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.

3 participants