CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.13.0 (2024-08-03)

• Fix to respect timezone when serializing EXDATE and RDATE
• Generic dependency updates
• Remove lifetime from iterator types
• Fix to render weekdays as valid rrule strings

0.12.0 (2024-04-04)

• Fix to ensure freq is capitalized in the string representation
• MSRV is bumped to v1.74.0 from v1.64.0
• Make ParseError and ValidationError public
• EXRULEs are now correctly added as exrules on the RRuleSet when parsed from a string, instead of being incorrectly added as an rrule.
• Add a RRuleSet::set_from_string method to support loading rules without DTSTART. This is useful particularly when working with the Google Calendar API.
• Fix to include RDATE, EXRULE and EXDATE values if used in the Display implementation of RRuleSet.
• Fix #104 which had invalid occurrences for "every 2 months on the last Monday"

0.11.0 (2023-07-18)

Changed

• RRuleSet::all returns an RRuleResult struct instead of a tuple.
• Update chrono-tz version to 0.8
• MSRV is bumped to v1.64.0 from v1.56.1

0.10.0 (2022-08-08)

Changed

• EXRULE functionality is put behind the feature flag exrule which is not enabled by default.
• RRuleSet::all takes a limit argument to protect against long-running iteration.
• The iterator API does not have any validation limits by default. So rrule_set.into_iter().map(|dt| format!("{dt}")).collect<Vec<_>>() could lead to an infinite loop.
• RRuleSet::all returns a tuple (Vec<DateTime>, bool) instead of the previous Result type. The boolean in the tuple indicates if the iteration was limited or not.
• Datetime type returned from iteration is chrono::DateTime<rrule::Tz> rather than chrono::DateTime<chrono_tz::Tz>. Please use .with_timezone if you still want to use chrono_tz::Tz.

Removed

• no-validation-limits feature is removed and is replaced by arguments to RRuleSet.
• RRuleSet::just_before was removed to keep the public API leaner. Please use the iterator API directly if you need this use-case.
• RRuleSet::just_after was removed to keep the public API leaner. Please use the iterator API directly if you need this use-case.
• RRuleSet::all_between was replaced by rrule_set.before(dt).after(dt).all(limit).

Added

• RRuleSet::after and RRuleSet::before was added to configure the boundaries of the recurrences before calling RRuleSet::all.
• RRuleSet::all_unchecked was added to allow for iterating without any validation limits.
• RRule<Unvalidated> implements FromStr and Deserialize
• rrule::Tz "replaced" chrono_tz::Tz by wrapping it and adding support for the chrono::Local timezone.

0.9.2 (2022-07-22)

Fixes

• Removed a println that accidentally was part of the previous release.

0.9.1 (2022-07-22)

Fixes

• Fixed typos in security docs
• Fixed an infinite loop issue in the iteration phase where the counter date increment method didn't increment the counter date, and it was unable to make progress. This was solved by using a custom date time implementation for the counter date.
• Fixes issue where iterations that passed a daylight saving time had incorrect hour.

0.9.0 (2022-07-18)

Changed

• MSRV is bumped to v1.57.0 from v1.56.1
• Internal Time type has been replaced by chrono::NaiveTime
• Iterator module has been refactored
• The parser module has been rewritten from scratch to be more Rust idiomatic and use terminology more consistent with the RFC. The end result of the parser phase is now a Grammar.
• Added cargo clippy -- -D warnings back to the CI

Removed

• RRule no longer implements FromStr or Deserialize. Use RRuleSet for these use-cases.

Fixes

• The DTSTART and UNTIL values weren't synced before this release. They're now synced according to the RFC.
• Fix #61 where collect_with_error would not return an error in the case where RRuleSet iteration had an error.

0.8.0 (2022-06-21)

Changed

• RRule represents only RRULE in the iCalendar specification. And RRuleSet is for the whole iCalendar string.
• RRule has two stages, Unvalidated and Validated. When you initialize it, it is Unvalidated and by calling the validate method, it will change to Validated.
• All fields of RRule and RRuleSet are private, instead there are a set of new methods to get and set values of fields on both structs. It's been done to have a safer API.
• tz is removed from all structs. It was a duplicated copy of the timezone inside the dt_start. Instead, you can control it by having a proper timezone for [RRuleSet::dt_start].

Removed

• Removed dt_start and dt_end from RRule.
• There is no Default for RRuleSet, instead use new(UTC.ymd(1970, 1, 1).and_hms(0, 0, 0)) method to have the same behavior.
• Removed RRuleProperties, instead you can use RRule<Unvalidated>.
• DateFilter trait has been removed, since now we can only iterate over RRuleSet and the methods are inside RRuleSet itself.
• The iterator over RRule is not public anymore.

0.7.3 (2022-05-05)

Added

• There is a new serde feature to enable serialization and deserialization on RRuleProperties and RRule.
• RRuleProperties and RRule structs now implement Display and FromStr to convert from and to strings.

Changed

• dt_start and tz moved from RRuleProperties to RRule

0.7.2 (2022-04-16)

Fixed

• Fix #33
• Fix #34
• Many tests were ignored because they were either invalid or the test didn't pass. Most ignored tests are now deleted, or the code is fixed so that they pass.
• Better error handling

Changed

Internal refactorings:

• Added ParseError and ValidationError which contains more specific errors during the parsing and validation phase respectively.

0.7.1 (2022-03-07)

Fixed

• Fix #48

0.7.0 (2021-02-04)

Added

• Added forbid(unsafe_code) into repo. We don't ever need unsafe code.
• Added additional testing crates: rrule-debugger and rrule-afl-fuzz. (only used internally and for debugging)
• Added examples folder and moved some code from documentation into examples.
• New and improved error handling consolidated into one object, RRuleError.
• Added new trait DateFilter for implementing methods like: all_with_error, all_before_with_error, all_after_with_error and all_between_with_error and moved/added methods like all, just_before, etc.
• Added arbitrary limits for safety reasons. See ReadMe for more info.
• Improved rrule command line tool.
• New WithError trait, implemented for RRuleIter and RRuleSetIter.

Changed

• License change, from MIT to (MIT or Apache 2.0). (#27)
• Massive code restructuring. Split into core, iter, parser and validator.
• Renamed Frequenzy to Frequency.
• Add limit to all(), prevent infinite loops.
• ParsedOptions and Options are merged together into RRuleProperties. (#22)
• Options functions changed, for example byminute -> by_minute.
• by_easter is now opt-in with feature flag by-easter. (#26)
• RRule can only be crated using new function with a valid RRuleProperties.
• RRule.option is no longer public, but can be read by using get_properties().
• RRuleIter and RRuleSetIter are now part of the public API.
• NWeekday has totally changed but serves the same purpose.
• Updated chrono-tz from 0.5.3 to 0.6.0.
• Function all was moved to DateFilter and returns a Result now.

Deprecated

Removed

• RRuleSet::new() replaced with RRuleSet::default().
• ParsedOptions and Options are now combined as RRuleProperties. (#22)
• NWeekdayIdentifier replaced with new of NWeekday.
• by_n_weekday field removed from ParsedOptions, combined into by_weekday.
• concat and build in Options are removed, no longer needed.
• Removed serde dependency. (#21)
• Removed function between, use DateFilter::all_between instead.
• Removed function after, use DateFilter::just_after instead.
• Removed function before, use DateFilter::just_before instead.

Fixed

• Replaced panic on incorrect datetime with error.
• Fix timezone conversions when TZID and Z is present.
• Stabilized RRule parsing from string. Fixed a lot of possible panics.

Security

• Added security notice to README.md.
• The validation of RRule improved the stability of the crate a lot.

Pre 0.6.0 (2021-07-02)

All changes before 2021-07-02 where not documented. This is everything before and including fa8308944a4d2ead0a6ccfa6ee53b76b399e045f