Skip to content

Conversation

@fsbraun
Copy link
Member

@fsbraun fsbraun commented Mar 20, 2025

{% plugin %} template tags cannot offer inline editing and hence need to disable it.

Summary by Sourcery

Bug Fixes:

  • Disables inline editing for DummyPlugins, which prevents crashes when inline editing is enabled for plugin template tags.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 20, 2025

Reviewer's Guide by Sourcery

This pull request disables inline editing for {% plugin %} template tags by adding a check to ensure the CMSPlugin instance has a primary key before allowing inline editing. This prevents errors when inline editing is attempted on these tags.

Sequence diagram for inline editing check

sequenceDiagram
  participant User
  participant TemplateTag
  participant Request
  participant CMSPlugin

  User->>TemplateTag: Renders template tag
  TemplateTag->>Request: Checks if inline editing is active
  Request-->>TemplateTag: Returns inline editing status (True)
  TemplateTag->>CMSPlugin: Checks if instance is a CMSPlugin
  CMSPlugin-->>TemplateTag: Returns instance type (CMSPlugin)
  TemplateTag->>CMSPlugin: Checks if CMSPlugin instance has a primary key (pk)
  alt pk is present
    TemplateTag->>TemplateTag: Renders inline field
  else pk is not present
    TemplateTag->>TemplateTag: Renders without inline field
  end
Loading

File-Level Changes

Change Details Files
Disabled inline editing for {% plugin %} template tags.
  • Added a check to ensure the CMSPlugin instance has a primary key before allowing inline editing.
  • This prevents errors when inline editing is attempted on {% plugin %} template tags, as they cannot offer inline editing.
djangocms_frontend/templatetags/frontend.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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@codecov
Copy link

codecov bot commented Mar 20, 2025

Codecov Report

Attention: Patch coverage is 81.81818% with 2 lines in your changes missing coverage. Please review.

Project coverage is 88.41%. Comparing base (6d8dc1c) to head (0d931a0).
Report is 33 commits behind head on master.

Files with missing lines Patch % Lines
djangocms_frontend/contrib/image/forms.py 50.00% 1 Missing ⚠️
djangocms_frontend/templatetags/frontend.py 75.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master     #260   +/-   ##
=======================================
  Coverage   88.41%   88.41%           
=======================================
  Files         123      123           
  Lines        3245     3245           
  Branches      259      259           
=======================================
  Hits         2869     2869           
  Misses        266      266           
  Partials      110      110           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@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 @fsbraun - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The commit message could be improved to explain why DummyPlugins don't have a pk.
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.

@fsbraun fsbraun merged commit 1e6d2c2 into master Mar 20, 2025
35 of 36 checks passed
@fsbraun fsbraun deleted the fix/no-inline-in-plugin-tag branch March 20, 2025 16:17
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.

2 participants