fix: default to the UI locale instead of jvm default locale

[elPeiretti]

fixes #8

Summary by CodeRabbit

• New Features

  • Improved handling of locale values in the LocaleComboBox, enhancing clarity and reliability.

• Bug Fixes

  • Enhanced null safety for locale management, providing a fallback mechanism for default locale retrieval.

[coderabbitai]

Walkthrough

The changes in the LocaleComboBox.java file enhance locale handling by modifying the customDisplayLocale variable to allow null values, removing the default assignment to Locale.getDefault(). The getLocaleForDisplay method now uses Optional.ofNullable() for improved null safety, ensuring that the UI locale is used when available. This update clarifies locale management within the component.

Changes

Files	Change Summary
src/main/java/com/flowingcode/vaadin/addons/localecombobox/LocaleComboBox.java	Modified customDisplayLocale to allow null values and updated getLocaleForDisplay for better null safety.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LocaleComboBox

    User->>LocaleComboBox: Set display locale
    LocaleComboBox->>LocaleComboBox: Check if customDisplayLocale is null
    alt customDisplayLocale is null
        LocaleComboBox->>LocaleComboBox: Use UI locale
    else
        LocaleComboBox->>LocaleComboBox: Use customDisplayLocale
    end
    LocaleComboBox-->>User: Display selected locale

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Use UI locale instead of Locale.getDefault() (#8)	✅

Possibly related PRs

• Feature/custom locales #6: Enhances locale handling and introduces a new constructor, relevant to locale management.
• Feature/optional flags #7: Introduces new methods for displaying flags, which relates to the overall functionality of LocaleComboBox.

Poem

🐰 In the meadow where locales play,
A rabbit hops, brightening the day.
Nulls now handled with care and grace,
UI locale shines in its rightful place.
With every change, a leap we make,
LocaleComboBox, for all our sake! 🌼

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e24b044 and 786f216.

Files selected for processing (1)

• src/main/java/com/flowingcode/vaadin/addons/localecombobox/LocaleComboBox.java (4 hunks)

Additional comments not posted (5)

src/main/java/com/flowingcode/vaadin/addons/localecombobox/LocaleComboBox.java (5)

30-30: LGTM!

The import statement is approved.

---

80-80: LGTM!

The field declaration change is approved as it aligns with the PR objective to allow customDisplayLocale to be null.

---

128-128: LGTM!

The direct assignment of displayLocale to customDisplayLocale is approved as it allows the field to be explicitly set to null when needed, aligning with the PR objective.

---

182-182: LGTM!

The use of Optional.ofNullable() with a fallback mechanism is approved as it enhances the null safety of the code and ensures that the UI locale is used as the default locale when customDisplayLocale is null, aligning with the PR objective.

---

185-185: LGTM!

The use of Optional.ofNullable() with a fallback mechanism is approved as it enhances the null safety of the code and ensures that the UI locale is used as the default locale when the value is null, aligning with the PR objective.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.