Add support for converting from Hijri calendar to undate and undate interval

rlskoeser commented 2 days ago

lark parser for Hijri dates - supports year, year month, and year month day
lark transformer that turns the lark parse tree into an undate objects
undate converter that connects the lark parser and transformer into the undate converter class
unit tests for all, borrowing examples from Princeton Geniza Project (PGP) and ISMI datasets

related to #10

todo

[ ] improve documentation (with example usage) and include in sphinx docs

Questions:

How reasonable is it to limit support to 3+ digit Hijri years? If we can make this assumption the parsing is much faster and more efficient, AND we can support both the year month day format in your ISMI data as well as the day month year in PGP data. ... but it might be an unreasonable limitation.
We don't yet have a notion of a precision or size for undate intervals, but this code suggests that it would be a useful option, for when the length of the interval is known
I'd like to write a notebook to test this logic against PGP dates, but prefer to do that in a subsequent PR - does that make sense, or would a demo notebook make it easier to review this code?

Summary by CodeRabbit

Release Notes

New Features
- Introduced HijriDateConverter for converting Hijri calendar dates to Gregorian dates.
- Added grammar rules for parsing Hijri dates, supporting various formats.
- Implemented HijriDateTransformer for transforming parsed Hijri dates into Undate or UndateInterval objects.
Bug Fixes
- Updated EDTF date parsing rules to include the 20th day of the month.
Tests
- Added comprehensive test suites for HijriDateConverter, hijri_parser, and HijriDateTransformer to ensure functionality and error handling.

coderabbitai[bot] commented 2 days ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces several changes, primarily focusing on the addition of the HijriDateConverter class and related components for converting Hijri calendar dates to Gregorian dates. The pyproject.toml file is updated to modify dependencies, including the addition of convertdate and a change in the lark dependency. New grammar specifications for parsing Hijri dates are also introduced, along with tests to validate the new functionality.

Changes

File Path	Change Summary
`pyproject.toml`	Updated dependencies: added `convertdate`, changed `lark` to `lark[interegular]`.
`src/undate/converters/calendars/__init__.py`	Added `HijriDateConverter` to `__all__` for public API.
`src/undate/converters/calendars/hijri/__init__.py`	Imported `HijriDateConverter` and updated `__all__` to include it.
`src/undate/converters/calendars/hijri/converter.py`	Introduced `HijriDateConverter` class with a `parse` method for converting Hijri dates.
`src/undate/converters/calendars/hijri/hijri.lark`	Added grammar rules for parsing Hijri dates, including definitions for years, months, and days.
`src/undate/converters/calendars/hijri/parser.py`	Introduced `parser.py` to initialize `hijri_parser` using `hijri.lark`.
`src/undate/converters/calendars/hijri/transformer.py`	Added `HijriDateTransformer` class for transforming Hijri date parse trees.
`src/undate/converters/edtf/edtf.lark`	Updated `day` rule regex to include the 20th day of the month.
`src/undate/converters/edtf/parser.py`	Changed import from `os.path` to `pathlib`, removed commented-out test cases.
`src/undate/undate.py`	Updated comments and type annotations in `UndateInterval` class.
`tests/test_converters/test_calendars/test_hijri/test_hijri_converter.py`	Added tests for `HijriDateConverter` functionality.
`tests/test_converters/test_calendars/test_hijri/test_hijri_parser.py`	Introduced tests for `hijri_parser` to validate various Hijri date formats.
`tests/test_converters/test_calendars/test_hijri/test_hijri_transformer.py`	Added tests for `HijriDateTransformer` class and its conversion logic.

Possibly related PRs

#84: The changes in the main PR regarding the pyproject.toml file and its dependencies may relate to the updates in the numpy handling in PR #84, as both involve modifications to dependencies and project configuration.
#88: The restructuring of the pyproject.toml file in the main PR aligns with the consolidation efforts in PR #88, which also focuses on streamlining project configuration and documentation.
#101: The renaming of the "formatters" submodule to "converters" in PR #101 is relevant as it reflects a broader change in the handling of date conversion functionalities, which may relate to the dependency updates in the main PR that could affect how these converters are utilized.

Suggested reviewers

ColeDCrawford
robcast
jdamerow

🐰 In the garden where dates bloom bright,
A converter hops with all its might.
From Hijri to Gregorian, it leaps with glee,
Transforming dates for you and me!
With tests in place, it’s sure to shine,
A joyful change, oh how divine! 🌼

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

rlskoeser commented 2 days ago

@coderabbitai review

coderabbitai[bot] commented 2 days ago

:white_check_mark: Actions performed

Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

robcast commented 1 day ago

Should a month or year in another calendar be represented in a single Undate or should it always be a UndateInterval?

I would find it more elegant if non-Gregorian months or years could also be represented as a single Undate. Does that make other Undate functions too complex? The default constructor assumes Gregorian and it would have to be changed.

Does this change what precision=year means? Is it too weird to have an Undate "year" based on the Gregorian calendar where the Gregorian text representation does not align on a year? Maybe we should have a "non-gregorian" flag for cases when you really care about this.

rlskoeser commented 1 day ago

Should a month or year in another calendar be represented in a single Undate or should it always be a UndateInterval?

I would find it more elegant if non-Gregorian months or years could also be represented as a single Undate. Does that make other Undate functions too complex? The default constructor assumes Gregorian and it would have to be changed.

Does this change what precision=year means? Is it too weird to have an Undate "year" based on the Gregorian calendar where the Gregorian text representation does not align on a year? Maybe we should have a "non-gregorian" flag for cases when you really care about this.

@robcast these are fantastic questions and I like where you are going with it. I had been intending to add a calendar property to Undate so that we could be explicit about what calendar the date is in. Can you help me sketch out what it would look like and how it would operate? I agree that this would be much more elegant and powerful.

Here's what I'm thinking based on what you're proposing: when parsing a Hijri date, instead of converting to Gregorian before creating Undate objects, we initialize the Undate with numeric year, month, day values and a calendar. This allows us to keep them a single Undate instead of an UndateInterval, and also preserves the date precision logic. There are lots of benefits to this approach. If we do that, then would we calculate the earliest/latest dates in the Hijri calendar or Gregorian? Or have options for both? Or maybe the comparison logic needs to be calendar aware and we only do the conversion when it matters or is explicitly requested? I'm leaning towards this last option, but let me know what you think!

rlskoeser commented 1 day ago

decisions from discussion with @robcast :

revise this code to test out the new approach
- add a calendar property to undate (default gregorian)
- initialize undate object with numeric year, month, day and add optional calendar (default gregorian)
- when initializing with hijri calendar, convert to gregorian for earliest/latest to compare
- confirm date precision is set as expected
3-digit year is not a reasonable constraint; choose a format (day month year) and document that constraint

dh-tech / undate-python