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

[Feature] Improve legal code language selection/fallback #483

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

manulthanura
Copy link

@manulthanura manulthanura commented Oct 13, 2024

Fixes

Description

This pull request addresses the improvement of the legal code language selection and fallback logic in the cc-legal-tools-app. The current fallback mechanism for legal code translations uses a naive method, which has been updated to a more robust approach similar to the Deeds & UX translation logic.

The changes include:

  1. Adding a new function load_legal_code_translations() to populate available legal code translations.
  2. Replacing the get_default_language_for_jurisdiction_naive() function with get_default_language_for_jurisdiction_legal_code() for a more sophisticated fallback logic based on the newly added settings.LANGUAGES_AVAILABLE_LEGAL_CODE.
  3. Renaming get_default_language_for_jurisdiction_deed() to get_default_language_for_jurisdiction_deed_ux() to clarify its scope.

Technical details

  • The load_legal_code_translations() function populates settings.LANGUAGES_AVAILABLE_LEGAL_CODE with the available languages for each jurisdiction.
  • The fallback logic for legal code languages now checks whether the default language for a jurisdiction exists in the settings.LANGUAGES_AVAILABLE_LEGAL_CODE. If not, it falls back to the default language specified in the settings.LANGUAGE_CODE.

Tests

To verify:

  1. Ensure that the updated fallback logic for legal code languages works correctly based on the settings.LANGUAGES_AVAILABLE_LEGAL_CODE.
  2. Test the Deeds & UX translations to confirm that the renaming of the fallback logic does not break existing behavior.

Checklist

  • [x ] My pull request has a descriptive title (not a vague title like Update index.md).
  • [x ] My pull request targets the default branch of the repository (main or master).
  • [x ] My commit messages follow best practices.
  • [x ] My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@manulthanura manulthanura requested review from a team as code owners October 13, 2024 01:49
@manulthanura manulthanura requested review from TimidRobot and Shafiya-Heena and removed request for a team October 13, 2024 01:49
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

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

Please run the static analysis tools and resolve any issues identified (./dev/tools.sh).

There are also a few test failures (run tests with ./dev/coverage.sh)

i18n/utils.py Show resolved Hide resolved
i18n/utils.py Show resolved Hide resolved
@TimidRobot
Copy link
Member

@manulthanura thank you for this work! There's a few items to resolve before I can properly verify it.

@TimidRobot TimidRobot self-assigned this Oct 31, 2024
Copy link
Author

@manulthanura manulthanura left a comment

Choose a reason for hiding this comment

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

Thank you for the updates.

@TimidRobot
Copy link
Member

@manulthanura Please also fix the checklist formatting in the pull request (PR) description

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

2 participants