Make RelativeDateFormatter locale/timeZone aware

[0xh3rman]

It fixes #1707

[gemini-code-assist]

Summary of Changes

Hello @0xh3rman, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the RelativeDateFormatter by introducing explicit Locale and TimeZone awareness. This change ensures that date and time formatting is consistently applied according to the specified regional and temporal settings, addressing potential inconsistencies that arise from relying on system defaults. The accompanying tests have been updated to reflect and validate this new behavior, improving the robustness of date formatting within the application.

Highlights

• Locale and TimeZone Awareness: The RelativeDateFormatter has been refactored to accept Locale and TimeZone in its initializer, allowing for explicit control over date and time formatting based on specific regional and temporal settings.
• Internal Formatter Configuration: All internal DateFormatter and Calendar instances within RelativeDateFormatter are now configured using the locale and timeZone provided during initialization, ensuring consistent behavior.
• Enhanced Test Robustness: The unit tests for RelativeDateFormatter have been updated to explicitly define locale and timeZone for test scenarios, and now use try #require for safer date creation, improving test reliability and accuracy.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• Packages/Formatters/Sources/RelativeDateFormatter.swift
  • Refactored DateFormatter instances from static to instance properties.
  • Introduced a public initializer init(locale:timeZone:) to allow explicit configuration.
  • Configured all internal DateFormatter and Calendar instances with the provided locale and timeZone.
  • Removed the unused dateOnly DateFormatter.
  • Updated the string(from:) method to utilize the newly configured instance properties.
• Packages/Formatters/Tests/FormattersTests/RelativeDateFormatterTests.swift
  • Modified the test struct to initialize RelativeDateFormatter with a fixed en_US locale and America/New_York time zone.
  • Updated test methods (today, yesterday, oneMonthOld) to use the explicitly configured Calendar instance for date creation.
  • Replaced force unwraps (!) with try #require for safer date creation in tests.
  • Ensured the oneMonthOld test explicitly sets the timeZone for its DateComponents.

Activity

• No specific activity (comments, reviews, progress updates) was provided in the context.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request effectively refactors RelativeDateFormatter to be aware of locale and timeZone, which is a great improvement. The changes are well-implemented and the tests are updated accordingly. I've added a couple of suggestions to reduce code duplication between the implementation and the tests, which should improve maintainability.