Skip to content

fix: Only show language menu for more than one language #457

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 3 commits into from
Mar 15, 2025
Merged

fix: Only show language menu for more than one language #457

merged 3 commits into from
Mar 15, 2025

Conversation

fsbraun
Copy link
Member

@fsbraun fsbraun commented Mar 14, 2025 •
edited by sourcery-ai bot
Loading

Description

django CMS versioning "takes over" the language menu for pages. In accordance with the behavior of the django CMS core it should only show the language menu if there is more than one language configured.

Fixes one of django-cms/django-cms#8158

Related resources

Checklist

  • I have opened this pull request against master
  • 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 #workgroup-pr-review on
    Slack to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Bug Fixes:

  • Fixes an issue where the language menu was displayed even when only one language was configured.

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Mar 14, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request fixes an issue where the language menu was being displayed even when only one language was configured for the site. The fix ensures that the language menu is only rendered when there are multiple languages available. A test case has been added to verify this behavior.

Sequence diagram for adding language menu

sequenceDiagram
  participant Toolbar
  participant cms_toolbars.add_language_menu
  participant get_language_tuple

  Toolbar->>cms_toolbars.add_language_menu: Call add_language_menu()
  cms_toolbars.add_language_menu->>get_language_tuple: Get languages for site
  alt len(languages) < 2
    cms_toolbars.add_language_menu-->>Toolbar: Return (no menu added)
  else len(languages) >= 2
    cms_toolbars.add_language_menu->>Toolbar: Add language menu
  end
Loading

File-Level Changes

Change Details Files
The language menu is now only displayed when there are multiple languages configured for the current site.
  • Added a check to ensure that the number of languages is greater than 1 before rendering the language menu.
  • If there is only one language, the function returns early, preventing the menu from being created.
 djangocms_versioning/cms_toolbars.py
Added a test case to verify that the language menu is not displayed when only one language is configured.
  • Created a new test case test_change_language_menu_page_toolbar_one_languages.
  • Overrode the CMS_LANGUAGES setting to configure only one language.
  • Asserted that the language menu is not present in the toolbar.
 tests/test_toolbars.py

Possibly linked issues

  • #8158: The PR fixes the issue by only showing the language menu if there is more than one language configured, addressing the problem of the language chooser not showing all options.
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 Codecov
Copy link

codecov bot commented Mar 14, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.55%. Comparing base (c6a54e6) to head (edba5e8).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #457      +/-   ##
==========================================
+ Coverage   90.54%   90.55%   +0.01%     
==========================================
  Files          72       72              
  Lines        2729     2732       +3     
  Branches      321      322       +1     
==========================================
+ Hits         2471     2474       +3     
  Misses        182      182              
  Partials       76       76

☔ 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.

sourcery-ai[bot]
sourcery-ai bot reviewed Mar 14, 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:

  • The test case added is good, but it would be better if it also asserted that the language menu would be present with multiple languages configured.
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 mentioned this pull request Mar 14, 2025
Closed
@vinitkumar vinitkumar merged commit 1b4dbfc into master Mar 15, 2025
99 checks passed
@fsbraun fsbraun mentioned this pull request May 16, 2025
Open
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

@vinitkumar vinitkumar vinitkumar approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@fsbraun @vinitkumar