8000 fix: Grouper models must not assume language grouper (#8194) by fsbraun · Pull Request #8195 · django-cms/django-cms · GitHub
[go: up one dir, main page]
Skip to content

fix: Grouper models must not assume language grouper (#8194) #8195

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 2, 2025
Merged

fix: Grouper models must not assume language grouper (#8194) #8195

merged 2 commits into from
Apr 2, 2025

Conversation

fsbraun
Copy link
Member
@fsbraun fsbraun commented Apr 2, 2025 •
edited by sourcery-ai bot
Loading

Description

Backport of #8194

Related resources

Checklist

  • I have opened this pull request against main
  • I have added or modified the tests when changing logic
  • I have followed the conventional commits guidelines to add meaningful information into the changelog
  • I have read the contribution guidelines and I have joined the channel #pr-reviews on our Discord Server to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Enhance the grouper models admin functionality to support more flexible language and content handling in the test utilities

Bug Fixes:

  • Fix language validation in content forms to use a more robust language checking method

Enhancements:

  • Extend the grouper model admin to support more flexible content and language management
  • Add a new SimpleGrouperModel and related admin class to improve testing capabilities

Tests:

  • Add comprehensive test cases for the new SimpleGrouperModel and its admin functionality
  • Expand test coverage for grouper model content creation and editing

@fsbraun @sourcery-ai
fix: Grouper models w/o must not assume language grouper (#8194)
5de81ff 
* fix: Grouper models w/o language grouper

* Keep language field, but not as grouper

* Update cms/tests/test_grouper_admin.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update cms/admin/utils.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update cms/tests/test_grouper_admin.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update cms/tests/test_grouper_admin.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update cms/tests/test_grouper_admin.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update cms/tests/test_grouper_admin.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Fix ruff issues

---------

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@sourcery-ai Sourcery AI
Copy link
Contributor
sourcery-ai bot commented Apr 2, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request addresses an issue where Grouper models without a language field were incorrectly assuming a language grouper. It introduces a new simplified Grouper model for testing, refactors and expands the test suite, and modifies the GrouperAdminFormMixin to correctly validate the language field.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a new model SimpleGrouperModel and its content model SimpleGrouperModelContent to test the fix.
  • Added SimpleGrouperModel and SimpleGrouperModelContent models.
  • Added corresponding admin class SimpleGrouperAdmin.
  • Registered the new model and admin class.
 cms/test_utils/project/sampleapp/models.py
cms/test_utils/project/sampleapp/admin.py
Refactored and expanded test cases to cover scenarios where Grouper models don't necessarily have a language field.
  • Introduced SimpleSetupMixin and SimpleChangeListActionsTestCase to avoid code duplication.
  • Added tests for change list actions, change form content, and saving/creating grouper and content models.
  • Adjusted existing tests to work with the new SimpleGrouperModel.
 cms/tests/test_grouper_admin.py
Modified the clean method in GrouperAdminFormMixin to check if the language exists in the available language list.
  • Updated the condition to check for the existence of the language key in cleaned_data and whether the language is in the language list.
  • Used get_language_list instead of get_language_dict for language validation.
 cms/admin/utils.py

Possibly linked issues

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

@github-actions GitHub Actions
Copy link
github-actions bot commented Apr 2, 2025

👋 Hi there!

Please remember to MERGE COMMIT pull requests from develop or develop-4!

Do not SQUASH commits to preserve history for the changelog.

sourcery-ai[bot]
sourcery-ai bot reviewed Apr 2, 2025
View reviewed changes
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:

  • Consider adding a comment explaining why ChangeListActionsTestCase inherits from SimpleChangeListActionsTestCase.
  • It looks like you've duplicated some code in SimpleSetupMixin that already exists in SetupMixin - can you consolidate?
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.

@github-actions GitHub Actions
Copy link
github-actions bot commented Apr 2, 2025

👋 Hi there!

Please remember to MERGE COMMIT pull requests from develop or develop-4!

Do not SQUASH commits to preserve history for the changelog.

@fsbraun fsbraun merged commit 35521bc into release/4.1.x Apr 2, 2025
92 checks passed
@fsbraun fsbraun deleted the fix/grouper-admin branch April 5, 2025 06:03
@fsbraun fsbraun changed the title fix: Grouper models w/o must not assume language grouper (#8194) fix: Grouper models must not assume language grouper (#8194) May 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@fsbraun
0