repeatex

Natural language for repeating dates

Programming language: Elixir

License: MIT License

Tags: Date And Time    

README

Repeatex

[Repeatex](logo.png)

Repeatex is a library for parsing, scheduling, and formatting repeating events. It handles many different expressions from "daily" to "on the 2nd tuesday and 4rd thursday of every other month". See Usage and Examples for more detail. It also can act as a validator / formatter for a JSON client which is described in the Integration with Phoenix section.

Usage

Parsing

Repeatex.parse("mon-sat every week")
# %Repeatex{
#   days: [
#     :monday
#     :tuesday
#     :wednesday
#     :thursday
#     :friday
#     :saturday
#   ]
#   frequency: 1
#   type: :weekly
# }

Repeatex.parse("mumbo jumbo")
# nil

Scheduling

# Every other day:
repeatex = %Repeatex{days: [], frequency: 2, type: :daily}
Repeatex.next_date(repeatex, {2017, 5, 20}) # => {2017, 5, 22}

# Every other week on Fri and Mon:
repeatex = %Repeatex{days: [:friday, :monday], frequency: 2, type: :weekly}
Repeatex.next_date(repeatex, {2017, 5, 20}) # => {2017, 5, 29}

# 3rd Tue every month:
repeatex = %Repeatex{days: %{tuesday: 3}, frequency: 1, type: :monthly}
Repeatex.next_date(repeatex, {2017, 5, 20}) # => {2017, 6, 20}

Formatting

repeatex = %Repeatex{days: %{tuesday: 3}, frequency: 1, type: :monthly}
Repeatex.description(repeatex)
# => "3rd Tue every month"

repeatex = %Repeatex{days: [:monday], frequency: 1, type: :weekly}
Repeatex.description(repeatex)
# => "Every week on Mon"

Installation

As repeatex isn't finished yet, you'll need to specify this repository location to use in your projects:

{:repeatex, github: "rcdilorenzo/repeatex"}

Integration with Phoenix

If you've got a phoenix application and you'd like to integrate repeatex for validation / formatting for a JSON client, simply add the following to your router:

forward "/repeatex", Repeatex.Web

See [test/controllers/README.md](test/controllers/README.md) for how to use the API.

Contribution

If you would like to contribute to the parser of other parts of this project, please check out the demo, and find other expressions that still need to be parsed, filing issues as needed. Even better, feel free to tackle any issues in the repository by submitting a friendly pull-request. Thanks!

Examples

Repeatex.parse("every other day")
# %Repeatex{
#   days: []
#   frequency: 2
#   type: :daily
# }

Repeatex.parse("every other monday")
# %Repeatex{
#   days: [
#     :monday
#   ]
#   frequency: 2
#   type: :weekly
# }

Repeatex.parse("each tues")
# %Repeatex{
#   days: [
#     :tuesday
#   ]
#   frequency: 1
#   type: :weekly
# }

Repeatex.parse("mon-sat every week")
# %Repeatex{
#   days: [
#     :monday
#     :tuesday
#     :wednesday
#     :thursday
#     :friday
#     :saturday
#   ]
#   frequency: 1
#   type: :weekly
# }

Repeatex.parse("every 3rd of the month")
# %Repeatex{
#   days: [
#     3
#   ]
#   frequency: 1
#   type: :monthly
# }

Repeatex.parse("1st and 3rd every 2 months")
# %Repeatex{
#   days: [
#     1
#     3
#   ]
#   frequency: 2
#   type: :monthly
# }

Repeatex.parse("on the 3rd tuesday of every month")
# %Repeatex{
#   days: %{
#     tuesday: 3
#   }
#   frequency: 1
#   type: :monthly
# }

TODO - Parsing

• [ ] "weekly on thursdays"
• [ ] "1st of every quarter"
• [ ] "on the third tuesday of each month"

Roadmap

• [x] Parsing natural language
• [x] Validate parsed structure
• [ ] Scheduler to determine next date - Daily, Weekly, and Monthly are done
• [x] Output natural description of repeat

License

Copyright (c) 2015-2016 Christian Di Lorenzo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.