app/views/admin/calendars/_form.html.haml
app/views/admin/calendars/edit.html.haml
app/views/admin/calendars/new.html.haml
app/views/admin/icals/refresh.html.haml
app/views/admin/icals/refresh_all.html.haml
db/migrate/20090818133511_simpler_ical_columns.rb
lib/event_calendar_admin_ui.rb
spec/datasets/calendar_pages_dataset.rb
spec/datasets/calendar_sites_dataset.rb
spec/datasets/calendars_dataset.rb
spec/lib/event_calendar_page_spec.rb
spec/models/calendar_spec.rb
spec/models/event_spec.rb
spec/models/ical_spec.rb
@@ -8,6 +8,8 @@ We can take feeds either from an ical file (which is your normal .ics calendar s
The radius tag structure has changed. Those few people who have old event_calendar pages will need to tweak them to use the new `r:calendar` and `r:event` namespaces, of which more below.
+Next job is to add some proper tests.
+
## Requirements
You need the `vpim` gem to handle event data:
@@ -41,7 +43,7 @@ Each calendar subscription will have its own address and authentication settings
2. Find the subscription address of your calendar.
3. Choose 'new calendar' in the radiant admin menu and enter the address and any authentication information you need to get at it. See below for notes about connecting to CalDAV. In the case of an ical file you should only need an address. Give the calendar a slug, just as you would for a page, and optionally a category. Let's say you call it 'test'.
4. Your calendar should appear in the subscription list. Click through to browse its events and make sure everything is as it should be.
-5. Set up a new page at /calendar/ with the type 'Calendar' and fill it with something this:
+5. Set up a new page at /calendar/ with the type 'EventCalendar' and fill it with something this:
<div class="event_list">
<r:events:each year="now">
@@ -68,6 +70,12 @@ Point your browser at /calendar/test and you should see a list of this year's ev
Note that the `event:header` tag only shows when it changes, which in this case gives you a non-repeating date slip. For more about the available radius tags, see the extension wiki or the 'available tags' documentation.
+If you have another column in your layout, try adding this:
+
+ <r:events:as_calendar calendar_months="6" date_links="true" month_links="false" />
+
+For clickable thumbnails of coming months.
+
## Notes
This is developing quite quickly at the moment but it's in production use on a couple of small sites and seems stable enough.
README.md
@@ -5,6 +5,7 @@ class Calendar < ActiveRecord::Base
validates_presence_of :name
validates_uniqueness_of :name
validates_uniqueness_of :slug, :scope => :category
+ accepts_nested_attributes_for :ical
named_scope :in_category, lambda { |category| # string. needs to match exactly
{ :conditions => [ "calendars.category = ?", category ] }
app/models/calendar.rb
@@ -57,5 +57,13 @@ class Event < ActiveRecord::Base
def allday?
start_date.hour == 0 && end_date.hour == 0
end
+
+ def nice_start_time
+ if start_date.min == 0
+ start_date.to_datetime.strftime("%-1I%p").downcase
+ else
+ start_date.to_datetime.strftime("%-1I:%M%p").downcase
+ end
+ end
end
app/models/event.rb
@@ -5,31 +5,31 @@ require 'date'
class Ical < ActiveRecord::Base
belongs_to :calendar
- validates_presence_of :ical_url
+ validates_presence_of :url
@@calendars_path = Radiant::Config["event_calendar.icals_path"]
# Download and save the .ics calendar file, parse and save events to database
def refresh
- ical_filename = RAILS_ROOT + "/public/" + @@calendars_path + "/" + self.calendar.slug + ".ics"
+ filename = RAILS_ROOT + "/public/" + @@calendars_path + "/" + self.calendar.slug + ".ics"
# Retrieve calendar specified by URL and Name attributes
begin
- uri = URI.parse(ical_url)
+ uri = URI.parse(url)
if authenticated?
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
req = Net::HTTP::Get.new(uri.path)
- req.basic_auth ical_username, ical_password
+ req.basic_auth username, password
response = http.request(req)
else
response = Net::HTTP.get_response(uri)
end
- File.open(ical_filename, "w") { |file|
+ File.open(filename, "w") { |file|
file << response.body
}
rescue
- logger.error "iCal url or file error with: #{self.calendar.name} - #{ical_url} -> (#{ical_filename}) -- error."
+ logger.error "iCal url or file error with: #{self.calendar.name} - #{url} -> (#{filename}) -- error."
return false
end
@@ -38,7 +38,7 @@ class Ical < ActiveRecord::Base
self.calendar.events.delete_all
# Open file for reading, parse and store to DB
- File.open(ical_filename, "r") do |file|
+ File.open(filename, "r") do |file|
cal = Vpim::Icalendar.decode(file).first
event_count = 0
cal.events.each do |parsed_event|
@@ -71,11 +71,11 @@ class Ical < ActiveRecord::Base
end
def refresh_automatically?
- ical_refresh_interval.nil? || ical_refresh_interval.to_i != 0
+ refresh_interval.nil? || refresh_interval.to_i != 0
end
def refresh_interval_or_default
- (ical_refresh_interval || Radiant::Config['event_calendar.default_refresh_interval'] || 3600).to_i.seconds
+ (refresh_interval || Radiant::Config['event_calendar.default_refresh_interval'] || 3600).to_i.seconds
end
def needs_refreshment?
@@ -98,11 +98,11 @@ class Ical < ActiveRecord::Base
protected
def authenticated?
- not ical_username.blank?
+ !username.blank?
end
def secured?
- ical_url.match(/^https/)
+ url.match(/^https/)
end
end
\ No newline at end of file
app/models/ical.rb
@@ -1,4 +1,5 @@
- include_stylesheet 'admin/calendar'
+= render_region :top
%h1
Calendar subscriptions
@@ -6,35 +7,54 @@
%table.index
%thead
%tr
- %th Name
- %th URL (category/slug)
- %th Last Refresh
- %th Refresh automatically?
- %th
+ - render_region :thead do |thead|
+ - thead.name_header do
+ %th Name
+
+ - thead.url_header do
+ %th URL (category/slug)
+
+ - thead.refresh_header do
+ %th Last Refresh
+ %th Refresh automatically?
+
+ - thead.action_header do
+ %th
%tbody
- @calendars.each do |calendar|
%tr{:class => "node level-1"}
- %td.subscription-title
- = link_to calendar.name, admin_calendar_url(calendar)
- = "(#{calendar.ical.last_refresh_count || '0'} events)"
- %td.url
- =h calendar.category.to_s.downcase
- \/
- =h calendar.slug.downcase
- %td.refreshed
- =h calendar.ical.last_refresh_date.strftime("%m/%d at %H:%M") unless calendar.ical.last_refresh_date.blank?
- %td.autorefresh
- = calendar.ical.refresh_automatically? ? "after #{distance_of_time_in_words(calendar.ical.refresh_interval_or_default.to_i.seconds)}" : "no"
- %td
- = link_to 'Refresh', refresh_admin_ical_url(calendar.ical.id), :method => :put
- |
- = link_to 'Edit', edit_admin_calendar_path(calendar)
- |
- = link_to 'Delete', admin_calendar_path(calendar), :confirm => 'Are you sure?', :method => :delete
-
-.footnote
- %p
- = link_to "Refresh All", refresh_all_admin_icals_path, :method => :put
- |
- = link_to 'Add a calendar', new_admin_calendar_url
+
+ - render_region :tbody do |tbody|
+ - tbody.name_cell do
+ %td.subscription-title
+ = link_to calendar.name, admin_calendar_url(calendar)
+ = "(#{calendar.ical.last_refresh_count || '0'} events)"
+
+ - tbody.url_cell do
+ %td.url
+ =h calendar.category.to_s.downcase
+ \/
+ =h calendar.slug.downcase
+
+ - tbody.refresh_cell do
+ %td.refreshed
+ =h calendar.ical.last_refresh_date.strftime("%m/%d at %H:%M") unless calendar.ical.last_refresh_date.blank?
+ %td.autorefresh
+ = calendar.ical.refresh_automatically? ? "after #{distance_of_time_in_words(calendar.ical.refresh_interval_or_default.to_i.seconds)}" : "no"
+
+ - tbody.action_cell do
+ %td
+ = link_to 'Refresh', refresh_admin_ical_url(calendar.ical.id), :method => :put
+ |
+ = link_to 'Edit', edit_admin_calendar_path(calendar)
+ |
+ = link_to 'Delete', admin_calendar_path(calendar), :confirm => 'Are you sure?', :method => :delete
+
+- render_region :bottom do |bottom|
+ - bottom.buttons do
+ .footnote
+ %p
+ = link_to "Refresh All", refresh_all_admin_icals_path, :method => :put
+ |
+ = link_to 'Add a calendar', new_admin_calendar_url
\ No newline at end of file
app/views/admin/calendars/index.html.haml
@@ -16,15 +16,15 @@
%li
%strong
address:
- = link_to @calendar.ical.ical_url
+ = link_to @calendar.ical.url
%li
%strong
username:
- = link_to @calendar.ical.ical_username
+ = link_to @calendar.ical.username
%li
%strong
password:
- = link_to @calendar.ical.ical_password
+ = link_to @calendar.ical.password
%p
This may be part of a master calendar with several individual calendars. In that case there will be a different address that lets you access all the calendars at once. Consult your site administrator if unsure.
app/views/admin/calendars/show.html.haml
@@ -1,5 +1,3 @@
-<%= render :partial => 'layouts/nav' %>
-
<h1>Events for next 6 months</h1>
<% @events.each do |event| %>
<div style="border-bottom: solid 1px rgb(100,100,100); padding: 10px">
app/views/admin/events/index.html.erb
@@ -23,8 +23,16 @@ class EventCalendarExtension < Radiant::Extension
Radiant::Config["event_calendar.icals_path"] = "icals"
end
+ unless defined? admin.calendar
+ Radiant::AdminUI.send :include, EventCalendarAdminUI
+ admin.calendar = Radiant::AdminUI.load_default_calendar_regions
+ if defined? admin.sites
+ admin.calendar.index.add :top, "admin/shared/site_jumper"
+ end
+ end
+
admin.tabs.add "Calendars", EXT_ROOT + "/calendars", :after => "Snippets", :visibility => [:all]
- if admin.tabs["Calendars"].respond_to?(:add_link)
+ if admin.tabs["Calendars"].respond_to?(:add_link) # that is, if the submenu extension is installed
admin.tabs["Calendars"].add_link "calendar list", EXT_ROOT + "/calendars"
admin.tabs["Calendars"].add_link "new subscription", EXT_ROOT + "/calendars/new"
admin.tabs["Calendars"].add_link "refresh all", EXT_ROOT + "/icals/refresh_all"
event_calendar_extension.rb
@@ -1,62 +1,62 @@
class CalendarPeriod
- attr_accessor :begin_date, :end_date, :name, :amount, :end_set
-
- def initialize(from=nil, to=nil)
- @begin_date = from ? from.to_date : first_day_of_month
- if to
- @end_date = to.to_date
- @end_set = true
- else
- @end_set = false
- @name = "month"
- @amount = 1
- end
- end
+ include ActionView::Helpers::DateHelper
+
+ attr_accessor :start, :duration
+
+ def initialize(from=nil, length=nil)
+ @start = from ? from.to_date : Date.today.beginning_of_month
+ @duration = length || 1.month
+ end
+
+ def self.between(from,to)
+ period = self.new(from)
+ period.finish = to
+ period
+ end
+ def finish
+ start + duration
+ end
+
+ def finish=(datetime)
+ duration = datetime - start
+ end
+
def to_s
- @name
+ "#{distance_of_time_in_words(start, finish)} from #{start}"
end
def inspect
- self.calculate_dates!
- %{#{@begin_date} to #{@end_date}}
+ %{#{start} to #{finish}}
end
- def begin_date
- self.calculate_dates!
- @begin_date
- end
+ # to expand the period to full calendar months
+ # @period.pad
- def end_date
- self.calculate_dates!
- @end_date
+ def pad
+ start = start.beginning_of_month
+ finish = finish.end_of_month
end
-
- def end_date=(date)
- @end_set = true
- @end_date = date
+
+ # to shift the period forward one month
+ # @period += 1.month
+
+ def +(s)
+ CalendarPeriod.new(start + s, duration)
end
- def calculate_dates!
- return if @end_set && @end_date
- case @name
- when "day"
- @end_date = @begin_date + (1 * @amount)
- when "week"
- @end_date = @begin_date + (7 * @amount)
- when "month"
- @end_date = @begin_date >> (1 * @amount)
- when "year"
- @end_date = @begin_date >> (12 * @amount)
- end
- end
+ # to shift the period back one month
+ # @period -= 1.month
- def first_day_of_month(date=Date.today)
- date.beginning_of_month
+ def -(s)
+ CalendarPeriod.new(start - s, duration)
end
- def last_day_of_month(date=Date.today)
- date.end_of_month
+ # to extend the period by one month
+ # @period << 1.month
+
+ def <<(s)
+ @duration += s
end
end
lib/calendar_period.rb
@@ -15,4 +15,6 @@ class EventCalendarPage < Page
end
end
+ # something to munch date input into a Date object ?
+
end
lib/event_calendar_page.rb
@@ -68,84 +68,6 @@ module EventCalendarTags
end
result
end
-
- [:from, :to, :duration, :description].each do |attribute|
- # pass to the period
- end
-
- tag "events:period" do |tag|
- # nice description of the enclosed period
- end
-
-
-
- desc %{
- Renders a calendar table for a single month. Like all events: tags, if no period is specified, it defaults to the present month.
- Usually you'll want to specify month and year attributes. An EventCalendar page will also obey month and year request parameters.
- If a period is specified longer than a month, we just render the first month: in that case you might want to use r:events:months to get several displayed at once.
-
- Usage:
- <pre><code><r:event:month [year=""] [month=""] [compact="true"] /></code></pre>
-
- }
- tag "events:month" do |tag|
- attr = tag.attr.symbolize_keys
- tag.locals.events ||= get_events(tag)
- compact = attr[:compact] || tag.attr[:list_events].nil?
- table_class = compact ? 'small_month' : 'month'
-
- first_day = tag.locals.calendar_start ? tag.locals.calendar_start.beginning_of_month : tag.locals.period.begin_date.beginning_of_month
- last_day = first_day.end_of_month
- first_shown = first_day.beginning_of_week # padding of period to show whole months
- last_shown = last_day.end_of_week
- previous = first_day - 1.day
- following = last_day + 1.day
-
- month_names = compact ? Date::ABBR_MONTHNAMES : Date::MONTHNAMES
- day_names = compact ? Date::DAYNAMES.map {|d| d.first} : Date::DAYNAMES
- day_names.push(day_names.shift) # Class::Date and ActiveSupport::CoreExtensions::Time::Calculations have different ideas of when is the start of the week. we've gone for the rails standard.
-
- cal = %(<table class="#{table_class}"><thead><tr>)
- cal << %(<th colspan="2" class="month_link"><a href="?year=#{previous.year}&month=#{previous.month}">< #{month_names[previous.month]}</a></th>) if attr[:month_links]
- cal << %(<th colspan="#{attr[:month_links] ? 3 : 7}" class="month_name">#{month_names[first_day.month]} #{first_day.year}</th>)
- cal << %(<th colspan="2" class="month_link"><a href="?year=#{following.year}&month=#{following.month}">#{month_names[following.month]} ></a></th>) if attr[:month_links]
- cal << %(</tr><tr class="day_name">)
- cal << day_names.map { |d| "<th scope='col'>#{d}</th>" }.join
- cal << "</tr></thead><tbody>"
-
- first_shown.upto(last_shown) do |day|
- events_today = tag.locals.events.select{ |e| e.start_date <= day + 1.day && e.end_date >= day }
- event_list = cell_text = date_label = ""
- cell_class = "day"
- cell_class += " other_month" if day.month != first_day.month
- unless compact && day.month != first_day.month
- cell_class += " weekend_day" if weekend?(day)
- cell_class += " today" if today?(day)
- cell_class += " weekend_today" if weekend?(day) && today?(day)
- date_label = day.mday
-
- if events_today.any?
- cell_class += " eventful"
- cell_class += " eventful_weekend" if weekend?(day)
- cell_class += events_today.map{|e| " #{e.calendar.slug}"}.join
- if compact
- date_label = %{<a href="#event_#{events_today.first.id}">#{date_label}</a>}
- else
- event_list << %{<ul>} << events_today.map { |e| "<li>#{e.title}</li>" }.join << "</ul>"
- end
- else
- cell_class += " uneventful"
- end
- date_label = %{<h4>#{date_label}</h4>} unless compact
- cell_text = %{<div class="event_holder">#{date_label}#{event_list}</div>}
- end
- cal << "<tr>" if day == day.beginning_of_week
- cal << %{<td class="#{cell_class}">#{cell_text}</td>}
- cal << "</tr>" if day == day.end_of_week
- end
- cal << %{</tbody></table>}
- cal
- end
desc %{
This is a shortcut that returns a set of tabulated months covering the period defined. It works in the same way as r:events:each but presents the results in a familiar calendar format.
@@ -167,7 +89,7 @@ module EventCalendarTags
Note that if you set 'months=3' instead of 'calendar_months=3' then it means three months from today, which actually extends over four calendar months.
- Big months until the end of the year:
+ Full size months until the end of the year:
<pre><code><r:events:as_calendar until="12-12" /></code></pre>
@@ -175,13 +97,15 @@ module EventCalendarTags
}
tag "events:as_calendar" do |tag|
+ attr = parse_boolean_attributes(tag)
tag.locals.events ||= get_events(tag)
result = ''
this_month = nil
- tag.locals.period.begin_date.upto(tag.locals.period.end_date) do |day|
+ tag.locals.period.start.upto(tag.locals.period.finish) do |day|
if day.month != this_month
tag.locals.calendar_start = day
- result << tag.render('events:month')
+ display = attr[:compact] ? 'events:minimonth' : 'events:month'
+ result << tag.render(display, attr.dup)
this_month = day.month
end
end
@@ -189,30 +113,137 @@ module EventCalendarTags
end
+ [:from, :to, :duration, :description].each do |attribute|
+
+ end
+
+ tag "events:period" do |tag|
+
+ end
+
+
+ # Calendars:* tags
+ # iterate over the set of calendars
+
+ desc %{
+ Loop over a set of calendars specified by the usual search conditions.
+
+ *Usage:*
+ <pre><code><r:calendars:each>...</r:calendars:each></code></pre>
+ }
+ tag 'calendars' do |tag|
+ tag.locals.calendars = Calendar.find(:all, calendars_find_options(tag))
+ tag.expand
+ end
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ tag 'calendars:each' do |tag|
+ result = []
+ tag.locals.calendars.each do |cal|
+ tag.locals.calendar = cal
+ result << tag.expand
+ end
+ result
+ end
+
+
+
+ # Calendar:* tags
+ # select and display attributes of a single calendar
+ # many of these are shortcuts to events: tags that set a calendar parameter and pass through.
+
+ tag 'calendar' do |tag|
+ tag.locals.calendar ||= get_calendar(tag)
+ raise TagError, "No calendar" unless tag.locals.calendar
+ tag.attr['calendar'] = tag.locals.calendar.slug
+ tag.expand
+ end
+
+ [:id, :name, :description, :category, :slug].each do |attribute|
+ desc %{
+ Renders the #{attribute} attribute of the current calendar.
+
+ Usage:
+ <pre><code><r:calendar:#{attribute} /></code></pre>
+ }
+ tag "calendar:#{attribute}" do |tag|
+ tag.locals.calendar.send(attribute)
+ end
+ end
+
+ [:last_refresh_date, :last_refresh_count, :url, :username, :password].each do |attribute|
+ desc %{
+ Renders the #{attribute} attribute of the ical subscription associated with the present calendar.
+
+ Usage:
+ <pre><code><r:calendar:#{attribute} /></code></pre>
+ }
+ tag "calendar:#{attribute}" do |tag|
+ tag.locals.calendar.ical.send(attribute)
+ end
+ end
+
+ desc %{
+ Loops over the events of the present calendar.
+ Takes the same sort and selection options as r:events (except for those that specify which calendars to show), and within it you can use all the usual r:event and r:calendar tags.
+
+ *Usage:*
+ <pre><code><r:calendar:events:each>...</r:calendar:events:each></code></pre>
+ }
+ tag 'calendar:events' do |tag|
+ tag.locals.events = get_events(tag)
+ end
+
+ tag 'calendar:events:each' do |tag|
+ result = []
+ tag.locals.events.each do |event|
+ tag.locals.event = event
+ result << tag.expand
+ end
+ result
+ end
+
+ # month, week and day tags
+ # tabulate a period and show any events in the current set that fall into that period
+
+ [:year, :month, :week, :day].each do |period|
+ desc %{
+ Shortcut tag that renders a #{period} view of the current calendar with all contained events.
+ On EventCalendar pages, these tags will obey relevant year, month, week and day request parameters.
+ Any other period tags are ignored.
+
+ Usage:
+ <pre><code><r:calendar:#{period} [year=""] [month=""] [week=""] [day=""] /></code></pre>
+ }
+ end
+
+ tag "calendar:day" do |tag|
+ tag.locals.period = period_from_parts(:day => tag.attr['day'], :month => tag.attr['month'], :year => tag.attr['year'])
+ tag.render("events:day")
+ end
+
+ tag "calendar:month" do |tag|
+ tag.locals.period = period_from_parts(:month => tag.attr['month'], :year => tag.attr['year'])
+ tag.render("events:month")
+ end
+
+ tag "calendar:week" do |tag|
+ tag.locals.period = period_from_parts(:week => tag.attr['week'], :year => tag.attr['year'])
+ tag.render("events:week")
+ end
+
+ tag "calendar:year" do |tag|
+ tag.locals.period = period_from_parts(:year => tag.attr['year'])
+ tag.render("events:year")
+ end
+
# Event:* tags
# display attributes of a single event
-
+
tag "event" do |tag|
raise TagError, "can't have r:event without an event" unless tag.locals.event
tag.expand
end
-
+
desc %{
We display the content between these tags only when it has changed.
Here this is normally used to display the date above a list of events for that day but you can also list by calendar or by week, or whatever.
@@ -237,27 +268,27 @@ module EventCalendarTags
[:id, :title, :description, :location, :url].each do |attribute|
desc %{
Renders the #{attribute} attribute of the current event.
-
+
Usage:
<pre><code><r:event:#{attribute} /></code></pre>
}
tag "event:#{attribute}" do |tag|
tag.locals.event.send(attribute)
end
-
+
desc %{
Contents are rendered if the event has a #{attribute}.
-
+
Usage:
<pre><code><r:event:if_#{attribute}>...</r:event:if_#{attribute}></code></pre>
}
tag "event:if_#{attribute}" do |tag|
tag.expand if tag.locals.event.send(attribute)
end
-
+
desc %{
Contents are rendered unless the event has a #{attribute}.
-
+
Usage:
<pre><code><r:event:unless_#{attribute}>...</r:event:unless_#{attribute}></code></pre>
}
@@ -265,11 +296,11 @@ module EventCalendarTags
tag.expand unless tag.locals.event.send(attribute)
end
end
-
+
desc %{
If the event has a url, renders a link to that address around the title of the event. If not, just the title without a link.
As usual, if the tag is double the contents are used instead, and any other attributes are passed through to the link tag, if any.
-
+
Usage:
<pre><code>
<r:event:link />
@@ -287,11 +318,11 @@ module EventCalendarTags
%{<span #{attributes}>#{text}</span>}
end
end
-
+
[:start, :end].each do |attribute|
desc %{
Renders the #{attribute} time of the current event with the specified strftime format. Default is 24 hour hh:mm.
-
+
Usage:
<pre><code><r:event:#{attribute} [format=""] /></code></pre>
}
@@ -302,7 +333,7 @@ module EventCalendarTags
end
desc %{
- Renders the start time of the current event with the specified strftime format. Unlike start and end, the default here is %m/%d/%Y
+ Renders the start time of the current event with the specified strftime format. Unlike start and end, the default here is '%d %M'
Usage:
<pre><code>
@@ -319,7 +350,7 @@ module EventCalendarTags
tag "event:date" do |tag|
tag.locals.event.start_date.strftime(tag.attr['format'] || "%m/%d/%Y")
end
-
+
desc %{
Prints the day-of-month of the start date of the current event.
Equivalent to calling <r:event:date format="%d" /> but a bit clearer.
@@ -367,7 +398,7 @@ module EventCalendarTags
desc %{
Prints the year of the start date of the current event.
Equivalent to calling <r:event:date format="%Y" /> but a bit clearer.
-
+
Usage:
<pre><code><r:event:year /></code></pre>
}
@@ -394,7 +425,7 @@ module EventCalendarTags
result = tag.locals.event.start_date.strftime(tagformat) << separator << tag.locals.event.end_date.strftime(format)
end
end
-
+
desc %{
Contents are rendered only if this is an all-day event.
@@ -404,7 +435,7 @@ module EventCalendarTags
tag "event:if_all_day" do |tag|
tag.expand if tag.locals.event.allday?
end
-
+
desc %{
Contents are rendered only if this is not an all-day event.
@@ -416,222 +447,285 @@ module EventCalendarTags
end
-
-
-
-
-
-
-
-
- # Calendars:* tags
- # iterate over the set of calendars
-
- desc %{
- Loop over a set of calendars specified by the usual search conditions.
-
- *Usage:*
- <pre><code><r:calendars:each>...</r:calendars:each></code></pre>
- }
- tag 'calendars' do |tag|
- tag.locals.calendars = Calendar.find(:all, calendars_find_options(tag))
- tag.expand
- end
+ # calendar month blocks large and small. need some drying.
- tag 'calendars:each' do |tag|
- result = []
- tag.locals.calendars.each do |cal|
- tag.locals.calendar = cal
- result << tag.expand
- end
- result
- end
-
-
-
-
-
-
-
-
-
-
- # Calendar:* tags
- # select and display attributes of a single calendar
- # many of these are shortcuts to events: tags that set a calendar parameter and pass through.
-
- tag 'calendar' do |tag|
- tag.locals.calendar ||= get_calendar(tag)
- raise TagError, "No calendar" unless tag.locals.calendar
- tag.attr['calendar'] = tag.locals.calendar.slug
- tag.expand
- end
+ desc %{
+ Renders a minimal calendar table for a single month. Like all events: tags, if no period is specified, it defaults to the present month.
+ Usually you'll want to specify month and year attributes. An EventCalendar page will also obey month and year request parameters.
+ If a period is specified longer than a month, we just render the first month: in that case you might want to use r:events:months to get several displayed at once.
+
+ Usage:
+ <pre><code><r:event:minimonth [year=""] [month=""] /></code></pre>
+
+ }
+ tag "events:minimonth" do |tag|
+ attr = parse_boolean_attributes(tag)
+ tag.locals.events ||= get_events(tag)
+
+ first_day = tag.locals.calendar_start ? tag.locals.calendar_start.beginning_of_month : tag.locals.period.start.beginning_of_month
+ last_day = first_day.end_of_month
+ first_shown = first_day.beginning_of_week # padding of period to show whole months
+ last_shown = last_day.end_of_week
+ previous = first_day - 1.day
+ following = last_day + 1.day
- [:id, :name, :description, :category, :slug].each do |attribute|
- desc %{
- Renders the #{attribute} attribute of the current calendar.
-
- Usage:
- <pre><code><r:calendar:#{attribute} /></code></pre>
- }
- tag "calendar:#{attribute}" do |tag|
- tag.locals.calendar.send(attribute)
- end
- end
+ month_names = Date::ABBR_MONTHNAMES.dup
+ day_names = Date::DAYNAMES.dup
+ day_names.push(day_names.shift) # Class::Date and ActiveSupport::CoreExtensions::Time::Calculations have different ideas of when is the start of the week. we've gone for the rails standard.
+
+ cal = %(<table class="minimonth"><thead><tr>)
+ cal << %(<th colspan="2" class="month_link"><a href="?year=#{previous.year}&month=#{previous.month}">< #{month_names[previous.month]}</a></th>) if attr[:month_links]
+ cal << %(<th colspan="#{attr[:month_links] ? 3 : 7}" class="month_name">#{month_names[first_day.month]} #{first_day.year}</th>)
+ cal << %(<th colspan="2" class="month_link"><a href="?year=#{following.year}&month=#{following.month}">#{month_names[following.month]} ></a></th>) if attr[:month_links]
+ cal << %(</tr><tr class="day_name">)
+ cal << day_names.map { |d| "<th scope='col'>#{d.first}</th>" }.join
+ cal << "</tr></thead><tbody>"
- [:last_refresh_date, :last_refresh_count, :ical_url, :ical_username, :ical_password].each do |attribute|
- desc %{
- Renders the #{attribute} attribute of the ical subscription associated with the current calendar.
-
- Usage:
- <pre><code><r:calendar:#{attribute} /></code></pre>
- }
- tag "calendar:#{attribute}" do |tag|
- tag.locals.calendar.ical.send(attribute)
+ first_shown.upto(last_shown) do |day|
+ events_today = tag.locals.events.select{ |e| e.start_date <= day + 1.day && e.end_date >= day }
+ event_list = cell_text = date_label = ""
+ cell_class = "day"
+ cell_class += " other_month" if day.month != first_day.month
+ unless day.month != first_day.month
+ cell_class += " weekend_day" if weekend?(day)
+ cell_class += " today" if today?(day)
+ cell_class += " weekend_today" if weekend?(day) && today?(day)
+ date_label = day.mday
+
+ if events_today.any?
+ cell_class += " eventful"
+ cell_class += " eventful_weekend" if weekend?(day)
+ cell_class += events_today.map{|e| " #{e.calendar.slug}"}.join
+ date_label = %{<a href="#event_#{events_today.first.id}">#{date_label}</a>}
+ else
+ cell_class += " uneventful"
+ end
+ cell_text = %{<div class="event_holder">#{date_label}#{event_list}</div>}
+ end
+ cal << "<tr>" if day == day.beginning_of_week
+ cal << %{<td class="#{cell_class}">#{cell_text}</td>}
+ cal << "</tr>" if day == day.end_of_week
end
+ cal << %{</tbody></table>}
+ cal
end
-
- desc %{
- Loops over the events of the present calendar.
- Takes the same sort and selection options as r:events (except for those that specify which calendars to show), and within it you can use all the usual r:event and r:calendar tags.
-
- *Usage:*
- <pre><code><r:calendar:events:each>...</r:calendar:events:each></code></pre>
+
+ desc %{
+ Renders a full calendar table for a single month. Like all events: tags, if no period is specified, it defaults to the present month.
+ Usually you'll want to specify month and year attributes. An EventCalendar page will also obey month and year request parameters
+ but only if the corresponding attributes have been specified.
+
+ If a period is specified longer than a month, we just render the first month.
+
+ If you use 'previous', 'now' and 'next' in your period attributes, an EventCalendar page will show the right period relative to input.
+
+ Usage:
+ <pre><code><r:event:month [year=""] [month=""] [compact="true"] /></code></pre>
+
}
- tag 'calendar:events' do |tag|
- tag.locals.events = get_events(tag)
- end
-
- tag 'calendar:events:each' do |tag|
- result = []
- tag.locals.events.each do |event|
- tag.locals.event = event
- result << tag.expand
- end
- result
- end
+ tag "events:month" do |tag|
+ attr = parse_boolean_attributes(tag)
+ tag.locals.events ||= get_events(tag)
+ table_class = 'month'
+
+ first_day = tag.locals.calendar_start ? tag.locals.calendar_start.beginning_of_month : tag.locals.period.start.beginning_of_month
+ first_shown = first_day.beginning_of_week # padding of period to fill month table
+ last_day = first_day.end_of_month
+ last_shown = last_day.end_of_week
+ previous = first_day - 1.day
+ following = last_day + 1.day
- # month, week and day tags
- # tabulate a period and show any events in the current set that fall into that period
+ month_names = Date::MONTHNAMES.dup
+ day_names = Date::DAYNAMES.dup
+ day_names.push(day_names.shift) # Class::Date and ActiveSupport::CoreExtensions::Time::Calculations have different ideas of when is the start of the week. We've gone for the rails standard.
+
+ cal = %(<table class="#{table_class}"><thead><tr>)
+ cal << %(<th colspan="2" class="month_link"><a href="?year=#{previous.year}&month=#{previous.month}">< #{month_names[previous.month]}</a></th>) if attr[:month_links]
+ cal << %(<th colspan="#{attr[:month_links] ? 3 : 7}" class="month_name">#{month_names[first_day.month]} #{first_day.year}</th>)
+ cal << %(<th colspan="2" class="month_link"><a href="?year=#{following.year}&month=#{following.month}">#{month_names[following.month]} ></a></th>) if attr[:month_links]
+ cal << %(</tr><tr class="day_name">)
+ cal << day_names.map { |d| "<th scope='col'>#{d}</th>" }.join
+ cal << "</tr></thead><tbody>"
- [:year, :month, :week, :day].each do |period|
- desc %{
- Shortcut tag that renders a #{period} view of the current calendar with all contained events.
- On EventCalendar pages, these tags will obey relevant year, month, week and day request parameters.
- Any other period tags are ignored.
+ first_shown.upto(last_shown) do |day|
+ events_today = tag.locals.events.select{ |e| e.start_date <= day + 1.day && e.end_date >= day }
+ event_list = cell_text = date_label = ""
+ cell_class = "day"
+ cell_class += " other_month" if day.month != first_day.month
+ cell_class += " weekend_day" if weekend?(day)
+ cell_class += " today" if today?(day)
+ cell_class += " weekend_today" if weekend?(day) && today?(day)
+ date_label = day.mday
+
+ if events_today.any?
+ cell_class += " eventful"
+ cell_class += " eventful_weekend" if weekend?(day)
+ cell_class += events_today.map{|e| " #{e.calendar.slug}"}.join
+ event_list << %{<ul>} << events_today.map { |e| %{<li><span class="time">#{e.nice_start_time}:</span> #{e.title}</li>} }.join << "</ul>"
+ else
+ cell_class += " uneventful"
+ end
- Usage:
- <pre><code><r:calendar:#{period} [year=""] [month=""] [week=""] [day=""] /></code></pre>
- }
- end
-
- tag "calendar:day" do |tag|
- tag.locals.period = period_from_parts(:day => tag.attr['day'], :month => tag.attr['month'], :year => tag.attr['year'])
- tag.render("events:day")
- end
-
- tag "calendar:month" do |tag|
- tag.locals.period = period_from_parts(:month => tag.attr['month'], :year => tag.attr['year'])
- tag.render("events:month")
- end
-
- tag "calendar:week" do |tag|
- tag.locals.period = period_from_parts(:week => tag.attr['week'], :year => tag.attr['year'])
- tag.render("events:week")
- end
-
- tag "calendar:year" do |tag|
- tag.locals.period = period_from_parts(:year => tag.attr['year'])
- tag.render("events:year")
+ date_label = %{<h4>#{date_label}</h4>}
+ cell_text = %{<div class="event_holder">#{date_label}#{event_list}</div>}
+ cal << "<tr>" if day == day.beginning_of_week
+ cal << %{<td class="#{cell_class}">#{cell_text}</td>}
+ cal << "</tr>" if day == day.end_of_week
+ end
+ cal << %{</tbody></table>}
+ cal
end
+
+
+
+
+
+
+
+
+
+
+
+
private
- # set_period turns supplied attributes into a start and end point and returns a CalendarCalendarPeriod object
- # and so defines most of the attribute interface
+ # parse_boolean_attributes turns "true" into true and everything else into false
+ # and incidentally symbolizes the keys
+
+ def parse_boolean_attributes(tag)
+ attr = tag.attr.symbolize_keys
+ [:month_links, :event_links, :compact].each do |param|
+ attr[param] = false unless attr[param] == 'true'
+ end
+ attr
+ end
+
+ # set_period turns supplied attributes into a start point and duration and returns a CalendarPeriod object
def set_period(tag)
attr = tag.attr.symbolize_keys
+ date_parts = [:year, :month, :week, :day]
+ interval_parts = [:months, :days, :since, :until, :from, :to]
+ relatives = {'previous' => -1, 'now' => 0, 'next' => 1}
+
+ logger.warn "~~ set_period: attr is #{attr.inspect}"
- [:year, :month, :week, :day].each do |p|
- case attr[p]
- when 'now'
- marker = Date.today
- when 'next'
- marker = Date.today + 1.send(p)
- when 'previous'
- marker = Date.today - 1.send(p)
- end
+ # 1. fully specified period: any numeric date part found
+ # not overridable
+
+ specific_date_parts = date_parts.select {|p| attr[p] && attr[p] == attr[p].to_i.to_s}
+ return period_from_parts(attr.slice(*specific_date_parts)) if specific_date_parts.any?
+
+ # 2. relative period: any relative date part specified and no numeric date part
+ # overridable on an EventCalendarPage: input date parts have the effect of shifting now but leave the rest of the period calculation the same
+ # this ought to be the most common case
+
+ relative_date_parts = date_parts.select {|p| relatives.keys.include? attr[p]}
+
+ logger.warn "~~ set_period: date_parts is #{date_parts.inspect} and relatives.keys is #{relatives.keys.inspect} and relative_date_parts is #{relative_date_parts.inspect}"
+
+ if p = relative_date_parts.last # if more than one - which there shouldn't be - we take the finest.
+
+ # read date parts from tag and request
+ parts = attr.slice(*date_parts)
+
+ if self.class == EventCalendarPage
+ params = @request.parameters.symbolize_keys
+
+ logger.warn "~~ set_period: params are #{params.inspect} and params sliced by #{date_parts.inspect} are #{params.slice(*date_parts).inspect}"
- # nb. containing periods might have rolled over
- # so we must specify those too
- if marker
- case p
- when :year
- attr[:year] = marker.year
- when :month
- attr[:month] = marker.month
- attr[:year] = marker.year
- when :week
- attr[:week] = marker.cweek
- attr[:year] = marker.year
- when :day
- attr[:day] = marker.mday
- attr[:month] = marker.month
- attr[:year] = marker.year
- end
+ parts.merge!( params.slice(*date_parts) )
end
+
+ logger.warn "~~ set_period: parts paramified are #{parts.inspect}"
+
+ # replace any remaining magic words with the present date part
+ parts.each {|k,v| parts[k] = Date.today.send(k) unless parts[k].to_i.to_s == parts[k]}
+
+ logger.warn "~~ set_period: parts demagicated are #{parts.inspect}"
+
+ # params now holds an up to date mixture of tag attributes and input parameters
+ period = period_from_parts(parts)
+
+ logger.warn "~~ set_period: period before shift is #{period}"
+
+ # but the magic words are still in attr and are used to shift the period:
+ period += 1.send(p) if attr[p] == 'next'
+ period -= 1.send(p) if attr[p] == 'previous'
+
+ logger.warn "~~ set_period: period after shift is #{period}"
+
+ return period
end
-
- # request parameters are accepted for attributes that have been specified in the tag
- # so for a pageable calendar you would want to use <r:events:month month="now" /> rather than relying on the default
+
+ # 3. relative interval
+ # parameters specified in the tag can be overridden by input (on an EventCalendar page). Others are ignored.
- if self.class == EventCalendarPage
- params = @request.parameters.symbolize_keys
- logger.warn "! reading request parameters"
- [:year, :month, :day, :years, :months, :days, :since, :until, :from, :to].select {|a|
- defined? attr[a]
- }.each do |a|
- attr[a] = params[a] unless params[a].nil? || params[a] == 'default' || params[a] == '0'
+ specified_interval_parts = interval_parts.select {|p| !attr[p].blank?}
+ if specified_interval_parts.any?
+ parts = attr.slice(specified_interval_parts)
+ if self.class == EventCalendarPage
+ params = @request.parameters.symbolize_keys
+ parts.merge(params.slice(interval_parts))
end
+ return period_from_interval(parts)
end
-
- period_from_interval(attr) || period_from_duration(attr) || period_from_parts(attr)
+
+ # default is the present month
+ period_from_parts
end
- def period_from_interval(int={})
- return CalendarPeriod.new(Time.now, int[:until].to_date) if int[:until]
- return CalendarPeriod.new(int[:since].to_date, Time.now) if int[:since]
- return CalendarPeriod.new(int[:from].to_date, int[:to].to_date) if int[:from] && int[:to]
- nil
+ def date_from_input
+ return unless self.class == EventCalendarPage
+ params = @request.parameters.symbolize_keys
+ Date.civil(params[:year], params[:month], params[:day])
end
- def period_from_duration(dur={})
- dur[:from] ||= Date.today
- if dur[:calendar_months]
- from = dur[:from].beginning_of_month
- to = from + dur[:calendar_months].to_i.months
- return CalendarPeriod.new(from, to - 1.day) # -1 to bring us to the end of the last month rather than the first of the one after
- end
- return CalendarPeriod.new(dur[:from], dur[:from] + dur[:years].to_i.years) if dur[:years]
- return CalendarPeriod.new(dur[:from], dur[:from] + dur[:months].to_i.months) if dur[:months]
- return CalendarPeriod.new(dur[:from], dur[:from] + dur[:weeks].to_i.days) if dur[:weeks]
- return CalendarPeriod.new(dur[:from], dur[:from] + dur[:days].to_i.days) if dur[:days]
- nil
- end
def period_from_parts(parts={})
- return CalendarPeriod.new(Date.civil(parts[:year], 1, 1), Date.civil(parts[:year], -1, -1)) if parts[:year] && !parts[:month]
+ parts.each {|k,v| parts[k] = parts[k].to_i}
+
+ logger.warn "~~ period_from_parts(#{parts.inspect})"
+ return CalendarPeriod.new(Date.civil(parts[:year], 1, 1), 1.year) if parts[:year] and not parts[:month]
parts[:year] ||= Date.today.year
+ return CalendarPeriod.new(Date.civil(parts[:year], parts[:month], 1), 1.month) if parts[:month] && !parts[:week] && !parts[:day]
parts[:month] ||= Date.today.month
- if parts[:day]
- day = Date.civil(parts[:year], parts[:month], parts[:day])
- return CalendarPeriod.new(day, day+1)
- end
- return CalendarPeriod.new(Date.commercial(parts[:year], parts[:week], 1), Date.commercial(parts[:year], parts[:week], -1)) if parts[:week]
- return CalendarPeriod.new(Date.civil(parts[:year], parts[:month], 1))
+ return CalendarPeriod.new(Date.commercial(parts[:year], parts[:week], 1), 1.week ) if parts[:week]
+ return CalendarPeriod.new(Date.civil(parts[:year], parts[:month], parts[:day]), 1.day) if parts[:day]
+ # if all defaults apply, you get the present month
+ return CalendarPeriod.new(Date.civil(parts[:year], parts[:month], 1), 1.month)
end
+ def period_from_interval(parts={})
+
+ logger.warn "~~ period_from_interval(#{parts.inspect})"
+
+ # starting point defaults to now
+ parts[:from] ||= Date.today
+
+ # from and to fully specified (including since and until as they are always relative to the present)
+ return CalendarPeriod.between(Time.now, parts[:until].to_date) if parts[:until]
+ return CalendarPeriod.between(parts[:since].to_date, Time.now) if parts[:since]
+ return CalendarPeriod.between(parts[:from].to_date, parts[:to].to_date) if parts[:from] && parts[:to]
+
+ # start moves to the first of the month if we're displaying calendar months
+ return CalendarPeriod.new(parts[:from].beginning_of_month, parts[:calendar_months].to_i.months) if parts[:calendar_months]
+
+ # and in the end it's just a question of how much of the future to show
+ return CalendarPeriod.new(parts[:from], parts[:years].to_i.years) if parts[:years]
+ return CalendarPeriod.new(parts[:from], parts[:months].to_i.months) if parts[:months]
+ return CalendarPeriod.new(parts[:from], parts[:weeks].to_i.weeks) if parts[:weeks]
+ return CalendarPeriod.new(parts[:from], parts[:days].to_i.days) if parts[:days]
+ end
+
+
+
+
+
+
+
+
def set_calendars(tag)
attr = tag.attr.symbolize_keys
if tag.locals.calendar # either we're in a calendar:* shortcut or we're eaching calendars. either way, it's set for us and parameters have no effect
@@ -651,10 +745,16 @@ module EventCalendarTags
end
def get_events(tag)
+
+ logger.warn "~~ get_events: attr will be #{tag.attr.inspect}"
+
Ical.check_refreshments
tag.locals.period ||= set_period(tag)
+
+ logger.warn "~~ get_events: tag.locals.period is #{tag.locals.period.inspect}"
+
tag.locals.calendars ||= set_calendars(tag)
- event_finder = Event.between(tag.locals.period.begin_date, tag.locals.period.end_date)
+ event_finder = Event.between(tag.locals.period.start, tag.locals.period.finish)
event_finder = event_finder.in_calendars(tag.locals.calendars) if tag.locals.calendars
tag.attr[:by] ||= 'start_date'
lib/event_calendar_tags.rb
app/views/admin/calendars/edit.html.erb
app/views/admin/calendars/new.html.erb
app/views/admin/icals/_edit.html.erb
app/views/admin/icals/refresh.html.erb
app/views/admin/icals/refresh_all.html.erb
329cf1d5179fbc29ed6e424a84ee4d8958d4a350
will
will@spanner.org
http://github.com/radiant/radiant-event-calendar-extension/commit/3d7dc750b9e8ed29d52cec35e3a3f21072a07d79
3d7dc750b9e8ed29d52cec35e3a3f21072a07d79
2009-08-19T05:58:39-07:00
2009-08-19T05:58:39-07:00
CalendarPeriod rewritten. tags clarified. first few tests. ical columns changed so migration required
1d0e01355937f767dc35d3a399e44dab28ce83f7
will
will@spanner.org