collective/jquery.recurrenceinput.js

jQuery recurrence widget based on the icalendar RFC5545 standard

jQuery recurrenceinput widget

jQuery plugin widget which support the definition of complex recurrence rulesets based on RFC5545, the iCalendar standard.

The recurrence rule string, generated by this package, should be directly usable in ics calendar files. It was developed for the Plone, but is completely independent of the web-framework. This widget is production ready and used in several sites.

Features

• The recurrence widget supports most of the options of the iCalendar RRULE as well as EXDATE and RDATE.
• It supports internationalization.
• It supports predetermined recurrence rules, so called "templates".

Non-Features

This widget does not support all features of RRULE's. For example:

• It does not support recurrence on smaller than daily basis.
• In RRULE's end-dates can end either be in local time or in UTC. This widget only supports UTC, which means the start and end dates of the event as a whole, when exported may not be in local time. They must either specify a timezone or be in UTC. If the RRULE fed to the widget is in local time, this will be made into UTC with no timezone translation.
• Any parameters will be ignored and stripped on saving the rule.

Requirements

Requires jQuery and jQuery Tools datetime widget and overlay support. It is currently being tested with jQuery 1.4, because that's what plone uses, and jQuery 1.7, because that is the last version supported by jQuery Tools.

jQuery 1.5 may work but is untested. Bugs in jQuery 1.6.4 means it does not work. jQuery Tools doesn't support jQuery 1.8 yet.

It's tested on Chromium 20 (Linux), Firefox 16 (Linux), IE 8 and IE 9 (Windows).

To Do

High priority:

• 100% code coverage from tests (currently 95%).

Medium priority:

• Make it possible to change the order of the fields as a part of the i18n. (jQuery templates)?
• The human readable output should probably be done directly from the RRULE and not by using the form i18n, to improve the grammar and rule support.

Low priority:

• Support more obscure RFC5545 options, either in the form or by providing warnings that the option is unsupported.

Developer information

To test, demo or develop jquery.recurrenceinput locally you need to run a local server, provided in the test_server.py script.

This server requires the dateutil module, so you must install it first. Here are some examples of how to do this, depending on your platform:

Debian/Ubuntu:

$ sudo apt-get install python-dateutil

A non-system Python 2 with setuptools or distribute installed:

$ <pathtopython>/easy_install python-dateutil

Then start the tests server like so:

$ python ./test_server.py

Open the demo pages http://localhost:8000/demo/input.html and http://localhost:8000/demo/localized.html

And Open the tests: http://localhost:8000/tests/tests.html

The demo/input.html document contains basic usecases and can be used when developing on this widget.

You also need to run the tests. These are located in tests/tests.js, and use the QUnit test framework. You run them by opening tests/test.html in the browser. The same issue with allowing Ajax from the local hard drive is in effect for the tests as well.

In the tests directory there is also a copy of jslint.js, for easy access. To run these you need to install a JavaScript engine, such as Rhino or SpiderMonkey. You then run it with:

$ js tests/jslint.js <file>

The following files should be jslinted:

src/jquery.recurrenceinput.js
src/tests.js

To keep the Coverage tests updated you need to install jscoverage ( http://siliconforks.com/jscoverage/ ). You then keep the coverage code updated by running:

jscoverage src/ coverage/

To run the coverage tests you go to http://localhost:8000/coverage/jscoverage.html?/tests/coveragetest.html

Contributors

This project was originally started by Rok Garbas.

Authors:

• Lennart Regebro
• Rok Garbas
• Vilmos Somogyi
• Johannes Raggam
• Mike Rhodes
• Kai Lautaportti

Thanks to Hexagon IT, http://www.hexagonit.fi/, who funded the main body of work, done by Lennart Regebro.

jquery.recurrenceinput.js's Issues

Add support for IE8

When loading a recurrence rule in Internet Explorer 8, with a jquery version > 1.7.0 (I tried with 1.7.1, and 1.7.2) I get an "Object Expected" error in the console, and the rule dialog isn't initialized.

Thanks!

  <html>

  <head>
      <title>JQuery.RecurrenceInput Demo</title>

      <link type="text/css" href="jquery.tools.dateinput.css" rel="stylesheet"></link>
      <link type="text/css" href="jquery.recurrenceinput.css" rel="stylesheet"></link>
      <link type="text/css" href="overlays.css" rel="stylesheet"></link>
      <script type="text/javascript" src="http://code.jquery.com/jquery-1.7.2.min.js"></script>

      <script type="text/javascript" src="../lib/jquery.tmpl-beta1.js"></script>
      <script type="text/javascript" src="../lib/jquery.tools.dateinput-1.2.5.js"></script>
      <script type="text/javascript" src="../lib/jquery.tools.overlay-1.2.5.js"></script>
      <script type="text/javascript" src="../src/jquery.recurrenceinput.js"></script>
  </head>

  <body>
      <h2>Minimal setup</h2>

      <!-- Make a text area for the RRULE, which also works as a
           non-javascript fallback -->
      <textarea name="repeat">RRULE:FREQ=DAILY;INTERVAL=2;COUNT=5</textarea>
      <!-- Make the text area a recurrenceinput -->
      <script type="text/javascript">
          $("textarea[name=repeat]").recurrenceinput();
      </script>

  </body>

  </html>

Weekly RRULE on 'Mo,Tu,We,Th,Fr,Sa' gets parsed as weekdays and forgets the Saturday when resaving

Hi,

Firstly, thanks for providing a great plugin. I wanted to raise a possible issue where a Weekly recurring event gets incorrectly saved as a Weekday rrule after it is opened and resaved. It seems setting a weekly recurrence of "Mo,Tu,We,Th,Fr,Sa" matches the Weekdays recurrence rule format ("Mo,Tu,We,Th,Fr") without check for the occurence of the ",Sa", leading to the "Saturday" being lost.

From my tests this seems to happen only in the exact situation outlined above where an event is Weekly and "Mo,Tu,We,Th,Fr,Sa". Any other combination of days is not affected by this as it will not match "Mo,Tu,We,Th,Fr". I believe this is because the Weekdays rule comes before the Weekly rule here, thus matching it without checking for the Saturday on the end.

// RECURRENCE TEMPLATES (Line 41)
rtemplate: { ..., weekdays: { rrule: 'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR', fields: [ 'rirangeoptions' ] }, weekly: { rrule: 'FREQ=WEEKLY', fields: [ 'riweeklyinterval', 'riweeklyweekdays', 'rirangeoptions' ] }, ... }

I have worked on finding a fix locally, with the intention of then forking the code and submitting a PR, but have been unable to solve the problem myself. Is anyone able to help?

Kind regards, Kyle

Jquery >2 support

Are there any plans to support jquery >2.0 ?

text inputs don't work with jquery >2.0

I have been testing 1.5 against jquery v2.0

It seems none of the text inputs are
Working

Weekly/Monthly Recurrence always only offers Thursday

Do not know if this is a bug here or in plone.formwidget.recurrence. So to let you know, posting it here too. Please see:

plone/plone.formwidget.recurrence#10
Weekly/Monthly Recurrence always only offers Thursday

breaks with jquery 1.8.2

complains about 'template' method not found

get rid of jquery.templ dependency

jquery.templ is the templating engine used by jquery.recurrenceinput.js. there is no further development with this lib but many other good alternatives which popped up in the last years.
plone/mockup is using http://underscorejs.org/#template , which might be a good choice.

register package with bower

No copyright/license information

There isn't any copyright or license file in the repository. Given the way copyright law works, this means no one is allowed to do anything with the code, which is probably not what you want.

No way to destroy the plugin once intialized

Once the plugin is initialized, there is no way to destroy it. Also after recurrenceinput is initialized, if we change the textbox using some other source, the recurrence rule is not updated

get rid of jquerytools dependencies

get rid of jquerytools dependencies by not depending on those libs at all and letting integrators choose their own libs.

ship with other mockup's picks of libs for demo/tests: pickadate instead of jquerytools dateinput, modal instead of jquerytools overlay.

Eventually migrate tests to Mocha

Mocha is used with mockup and seems to have much momentum at the moment.
Migrating tests shouldn't be too hard.
There is no guarantee, but maybe this can fix issue #8, the heisenbugs, assuming they provide better support for async calls, which might the cause of the heisenbugs.

Check if the Italian Issue affects us.

What happens if you are in Europe/Rome timezone and try to set a date to 28th of May 1972?

See http://lists.opensuse.org/opensuse-bugs/2012-01/msg04191.html for more info.

Any Plans on Supporting to latest Jquery Version?

Hi, I love this package and it's a great package. I realised that the Jquery 3+ has deprecated the function that this plugin will use.
Will it have support for the latest JQuery version?

Thank you
@thet @regebro

recurrenceinput does not support EXDATE/RDATE definitions over multiple lines

recurrenceinput does not support EXDATE or RDATE definitions over multiple lines like this (real-world example):

RRULE:FREQ=WEEKLY;INTERVAL=1;UNTIL=20130305T225959Z
EXDATE;TZID=Europe/Berlin:20121031T140000
EXDATE;TZID=Europe/Berlin:20121226T140000
EXDATE;TZID=Europe/Berlin:20130102T140000
EXDATE;TZID=Europe/Berlin:20130206T140000
EXDATE;TZID=Europe/Berlin:20130213T140000
EXDATE;TZID=Europe/Berlin:20130220T140000
EXDATE;TZID=Europe/Berlin:20130227T140000

tough, the recurrenceinput does support EXDATE/RDATE definitions like:

EXDATE:20130227T140000,20121031T140000,20130102T140000

use grunt, use bower

Upgrade build-infrastructure, like in plone/mockup:

• use grunt taskrunner as build tool
• use bower for managing dependencies
• eventually use yeoman

Demo page doesn't work with updated jquery?

The tests are plagued by heisenbugs

Many tests will not work reliably. Some tests will always fail if you reload the page. Some tests will fail every second reload, and pass every second reload. All tests will however run if run in isolation. Trying to debug the issue (in any case including alerts or having a debugger) will make the tests pass.

I suspect timing issues, but adding delays seem to make no difference.

I suspect a JS/jQuery/qUnit guru is needed to look at this.