CalendarRecurrence

CalendarRecurrence is an Elixir library for working with recurring dates.

Examples

iex> recurrence = CalendarRecurrence.new(start: ~D[2018-01-01], step: 2)
iex> Enum.take(recurrence, 3)
[~D[2018-01-01], ~D[2018-01-03], ~D[2018-01-05]]

CalendarRecurrence additionally includes a RRULE parser:

iex> alias CalendarRecurrence.RRULE

iex> RRULE.parse("FREQ=DAILY;COUNT=10")
iex> {:ok, %RRULE{freq: :daily, count: 10}}

iex> RRULE.to_recurrence("FREQ=WEEKLY;COUNT=4;BYDAY=MO,WE", ~D[2018-01-01]) |> Enum.to_list()
[~D[2018-01-01], ~D[2018-01-03], ~D[2018-01-08], ~D[2018-01-10]]

It also implements the String.Chars protocol:

iex> %RRULE{freq: :daily, bysecond: [5, 10]} |> to_string()
iex> "FREQ=DAILY;BYSECOND=5,10"

Currently a small subset of RRULE grammar is implemented, more support coming soon.

Installation

Add to mix.exs:

defp deps do
  [
    {:calendar_recurrence, "~> 0.2.0"}
  ]
end

License

Copyright 2018 Wojciech Mach

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.