Module: CalendarHelper
- Defined in:
- lib/calendar_helper.rb
Overview
CalendarHelper allows you to draw a databound calendar with fine-grained CSS formatting
Defined Under Namespace
Classes: Engine
Constant Summary collapse
- VERSION =
'0.2.4'
Instance Method Summary collapse
-
#calendar(options = {}, &block) ⇒ Object
Returns an HTML calendar.
Instance Method Details
#calendar(options = {}, &block) ⇒ Object
Returns an HTML calendar. In its simplest form, this method generates a plain calendar (which can then be customized using CSS) for a given month and year. However, this may be customized in a variety of ways – changing the default CSS classes, generating the individual day entries yourself, and so on.
The following options are required:
:year # The year number to show the calendar for.
:month # The month number to show the calendar for.
The following are optional, available for customizing the default behaviour:
:table_id => "calendar-2008-08" # The id for the <table> tag.
:table_class => "calendar" # The class for the <table> tag.
:summary => "Calendar for August 2008" # The summary attribute for the <table> tag. Required for 508 compliance.
:month_name_class => "monthName" # The class for the name of the month, at the top of the table.
:other_month_class => "otherMonth" # The class for individual day cells for previous and next months.
:day_name_class => "dayName" # The class is for the names of the weekdays, at the top.
:day_class => "day" # The class for the individual day number cells.
This may or may not be used if you specify a block (see below).
:abbrev => true # This option specifies whether day names should be displayed abbrevidated (true)
or in full (false)
:first_day_of_week => 0 # Renders calendar starting on Sunday. Use 1 for Monday, and so on.
:accessible => true # Turns on accessibility mode. This suffixes dates within the
# calendar that are outside the range defined in the <caption> with
# <span class="hidden"> MonthName</span>
# Defaults to false.
# You'll need to define an appropriate style in order to make this disappear.
# Choose your own method of hiding content appropriately.
:show_today => false # Highlights today on the calendar using the CSS class 'today'.
# Defaults to true.
:previous_month_text => nil # Displayed left of the month name if set
:next_month_text => nil # Displayed right of the month name if set
:month_header => false # If you use false, the current month header will disappear.
:calendar_title => month_names[options[:month]] # Pass in a custom title for the calendar. Defaults to month name
For more customization, you can pass a code block to this method, that will get one argument, a Date object, and return a values for the individual table cells. The block can return an array, [cell_text, cell_attrs], cell_text being the text that is displayed and cell_attrs a hash containing the attributes for the <td> tag (this can be used to change the <td>‘s class for customization with CSS). This block can also return the cell_text only, in which case the <td>’s class defaults to the value given in :day_class
. If the block returns nil, the default options are used.
Example usage:
calendar(:year => 2005, :month => 6) # This generates the simplest possible calendar.
calendar({:year => 2005, :month => 6, :table_class => "calendar_helper"}) # This generates a calendar, as
# before, but the <table>'s class
# is set to "calendar_helper".
calendar(:year => 2005, :month => 6, :abbrev => (0..-1)) # This generates a simple calendar but shows the
# entire day name ("Sunday", "Monday", etc.) instead
# of only the first three letters.
calendar(:year => 2005, :month => 5) do |d| # This generates a simple calendar, but gives special days
if listOfSpecialDays.include?(d) # (days that are in the array listOfSpecialDays) one CSS class,
[d.mday, {:class => "specialDay"}] # "specialDay", and gives the rest of the days another CSS class,
else # "normalDay". You can also use this highlight today differently
[d.mday, {:class => "normalDay"}] # from the rest of the days, etc.
end
end
An additional ‘weekend’ class is applied to weekend days.
For consistency with the themes provided in the calendar_styles generator, use “specialDay” as the CSS class for marked days.
Accessibility & 508 Compliance:
The table tag has a summary attribute (overridable).
Each th has an id.
Each td has a headers attribute, containing the element id of the appropriate th.
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/calendar_helper.rb', line 76 def calendar( = {}, &block) raise(ArgumentError, "No year given") unless .has_key?(:year) raise(ArgumentError, "No month given") unless .has_key?(:month) block ||= Proc.new {|d| nil} month_names = (!defined?(I18n) || I18n.t("date.month_names").include?("missing")) ? Date::MONTHNAMES.dup : I18n.t("date.month_names") defaults = { :table_id => "calendar-#{[:year]}-#{"%02d" % [:month]}", :table_class => 'calendar', :month_name_class => 'monthName', :other_month_class => 'otherMonth', :day_name_class => 'dayName', :day_class => 'day', :abbrev => true, :first_day_of_week => 0, :accessible => false, :show_today => true, :previous_month_text => nil, :next_month_text => nil, :month_header => true, :calendar_title => month_names[[:month]], :summary => "Calendar for #{month_names[[:month]]} #{[:year]}" } = defaults.merge first = Date.civil([:year], [:month], 1) last = Date.civil([:year], [:month], -1) first_weekday = first_day_of_week([:first_day_of_week]) last_weekday = last_day_of_week([:first_day_of_week]) day_names = (!defined?(I18n) || I18n.t("date.day_names").include?("missing")) ? Date::DAYNAMES : I18n.t("date.day_names") abbr_day_names = (!defined?(I18n) || I18n.t("date.abbr_day_names").include?("missing")) ? Date::ABBR_DAYNAMES : I18n.t("date.abbr_day_names") week_days = (0..6).to_a first_weekday.times do week_days.push(week_days.shift) end # TODO Use some kind of builder instead of straight HTML cal = %(<table id="#{[:table_id]}" class="#{[:table_class]}" border="0" cellspacing="0" cellpadding="0" summary="#{[:summary]}">) cal << %(<thead>) if ([:month_header]) cal << %(<tr>) if [:previous_month_text] or [:next_month_text] cal << %(<th colspan="2">#{[:previous_month_text]}</th>) colspan=3 else colspan=7 end cal << %(<th colspan="#{colspan}" class="#{[:month_name_class]}">#{[:calendar_title]}</th>) cal << %(<th colspan="2">#{[:next_month_text]}</th>) if [:next_month_text] cal << %(</tr>) end cal << %(<tr class="#{[:day_name_class]}">) week_days.each do |wday| cal << %(<th id="#{th_id(Date::DAYNAMES[wday], [:table_id])}" scope="col">) cal << ([:abbrev] ? %(<abbr title="#{day_names[wday]}">#{abbr_day_names[wday]}</abbr>) : day_names[wday]) cal << %(</th>) end cal << "</tr></thead><tbody><tr>" # previous month beginning_of_week(first, first_weekday).upto(first - 1) do |d| cal << generate_other_month_cell(d, ) end unless first.wday == first_weekday first.upto(last) do |cur| cell_text, cell_attrs = block.call(cur) cell_text ||= cur.mday cell_attrs ||= {} cell_attrs[:headers] = th_id(cur, [:table_id]) cell_attrs[:class] ||= [:day_class] cell_attrs[:class] += " weekendDay" if [0, 6].include?(cur.wday) today = (Time.respond_to?(:zone) && !(zone = Time.zone).nil? ? zone.now.to_date : Date.today) cell_attrs[:class] += " today" if (cur == today) and [:show_today] cal << generate_cell(cell_text, cell_attrs) cal << "</tr><tr>" if cur.wday == last_weekday end # next month (last + 1).upto(beginning_of_week(last + 7, first_weekday) - 1) do |d| cal << generate_other_month_cell(d, ) end unless last.wday == last_weekday cal << "</tr></tbody></table>" cal.respond_to?(:html_safe) ? cal.html_safe : cal end |