Question

I’m building a calendar system from the ground up (requirement, as I’m working with a special type of calendar alongside Gregorian) , and I need some help with logic. I’m writing the application in Django and Python.

Essentially, the logical issues I’m running into is how to persist as few objects as possible as smartly as possible without running up the tab on CPU cycles. I’m feeling that polymorphism would be a solution to this, but I’m not exactly sure how to express it here.

I have two basic subsets of events, repeating events and one-shot events.

Repeating events will have subscribers, people which are notified about their changes. If, for example, a class is canceled or moved to a different address or time, people who have subscribed need to know about this. Some events simply happen every day until the end of time, won’t be edited, and “just happen.” The problem is that if I have one object that stores the event info and its repeating policy, then canceling or modifying one event in the series really screws things up and I’ll have to account for that somehow, keeping subscribers aware of the change and keeping the series together as a logical group.

Paradox: generating unique event objects for each normal event in a series until the end of time (if it repeats indefinitely) doesn’t make sense if they’re all going to store the same information; however, if any change happens to a single event in the series, I’ll almost have to create a different object in the database to represent a cancellation.

Can someone help me with the logic here? It’s really twisting my mind and I can’t really think straight anymore. I’d really like some input on how to solve this issue, as repeating events isn’t exactly the easiest logical thing either (repeat every other day, or every M/W/F, or on the 1st M of each month, or every 3 months, or once a year on this date, or once a week on this date, or once a month on this date, or at 9:00 am on Tuesdays and 11:00am on Thursdays, etc.) and I’d like help understanding the best route of logic for repeating events as well.

Here’s a thought on how to do it:

class EventSeries(models.Model):
    series_name = models.TextField()
    series_description = models.TextField()
    series_repeat_policy = models.IHaveNoIdeaInTheWorldOnHowToRepresentThisField()
    series_default_time = models.TimeField()
    series_start_date = models.DateField()
    series_end_date = models.DateField()
    location = models.ForeignKey('Location')

class EventSeriesAnomaly(models.Model):
    event_series = models.ForeignKey('EventSeries', related_name="exceptions")
    override_name = models.TextField()
    override_description = models.TextField()
    override_time = models.TimeField()
    override_location = models.ForeignKey('Location')
    event_date = models.DateField()

class EventSeriesCancellation(models.Model):
    event_series = models.ForeignKey('EventSeries', related_name="cancellations")
    event_date = models.TimeField()
    cancellation_explanation = models.TextField()

This seems to make a bit of sense, but as stated above, this is ruining my brain right now so anything seems like it would work. (Another problem and question, if someone wants to modify all remaining events in the series, what in the heck do I do!?!? I suppose that I could change ‘series_default_time’ and then generate anomaly instances for all past instances to set them to the original time, but AHHHHHH!!!)

Boiling it down to three simple, concrete questions, we have:

1. How can I have a series of repeating events, yet allow for cancellations and modifications on individual events and modifications on the rest of the series as a whole, while storing as few objects in the database as absolutely necessary, never generating objects for individual events in advance?
2. How can I repeat events in a highly customizable way, without losing my mind, in that I can allow events to repeat in a number of ways, but again making things easy and storing as few objects as possible?
3. How can I do all of the above, allowing for a switch on each event series to make it not happen if it falls out on a holiday?

Answer 1

I want to address only question 3, about holidays.

In several reporting databases, I have found it handy to define a table, let’s call it “Almanac”, that has one row for each date, within a certain range. If the range spans ten years, the table will contain about 3,652 rows. That’s small by today’s standards. The primary key is the date.

Some other columns are things like whether the date is a holiday, a normal working day, or a weekend day. I know, I know, you could compute the weekend stuff by using a built in function. But it turns out to be convenient to include this stuff as data. It makes your joins simpler and more similar to each other.

Then you have one application program that populates the Almanac. It has all the calendar quirks built into it, including the enterprise rules for figuring out which days are holidays. You can even include columns for which “fiscal month” a given date belongs to, if that’s relevant to your case. The rest of the application, both entry programs and extraction programs, all treat the Almanac like plain old data.

This may seem suboptimal because it’s not minimal. But trust me, this design pattern is useful in a wide variety of situations. It’s up to you to figure how it applies to your case.

The Almanac is really a subset of the principles of data warehousing and star schema design.

if you want to do the same thing inside the CPU, you could have an “Almanac” object with public features such as Almanac.holiday(date).