Initial import

vendor/plugins/calendar_helper/lib/calendar_helper.rb

@@ -0,0 +1,138 @@
+require 'date'
+
+# CalendarHelper allows you to draw a databound calendar with fine-grained CSS formatting
+module CalendarHelper
+  # 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_class       => "calendar"        # The class for the <table> tag.
+  #   :month_name_class  => "monthName"       # The class for the name of the month, at the top of the table.
+  #   :other_month_class => "otherMonth" # Not implemented yet.
+  #   :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            => (0..2)            # This option specifies how the day names should be abbreviated.
+  #                                             Use (0..2) for the first three letters, (0..0) for the first, and
+  #                                             (0..-1) for the entire name.
+  #   :first_day_of_week => 0                 # Renders calendar starting on Sunday. Use 1 for Monday, and so on.
+  # 
+  # 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.
+  # 
+  def calendar(options = {}, &block)
+    raise(ArgumentError, "No year given")  unless options.has_key?(:year)
+    raise(ArgumentError, "No month given") unless options.has_key?(:month)
+
+    block                        ||= Proc.new {|d| nil}
+
+    defaults = {
+      :table_class => 'calendar',
+      :month_name_class => 'monthName',
+      :other_month_class => 'otherMonth',
+      :day_name_class => 'dayName',
+      :day_class => 'day',
+      :abbrev => (0..2),
+      :first_day_of_week => 0
+    }
+    options = defaults.merge options
+
+    first = Date.civil(options[:year], options[:month], 1)
+    last = Date.civil(options[:year], options[:month], -1)
+
+    first_weekday = first_day_of_week(options[:first_day_of_week])
+    last_weekday = last_day_of_week(options[:first_day_of_week])
+    
+    day_names = Date::DAYNAMES.dup
+    first_weekday.times do
+      day_names.push(day_names.shift)
+    end
+
+    cal = %(<table class="#{options[:table_class]}" border="0" cellspacing="0" cellpadding="0">) 
+    cal << %(<thead><tr class="#{options[:month_name_class]}"><th><a href="#" id="calendar_prev">&laquo;</a></th><th colspan="5">#{Date::MONTHNAMES[options[:month]]}</th><th><a href="#" id="calendar_next">&raquo;</a></th></tr><tr class="#{options[:day_name_class]}">)
+    day_names.each {|d| cal << "<th>#{d[options[:abbrev]]}</th>"}
+    cal << "</tr></thead><tbody><tr>"
+    beginning_of_week(first, first_weekday).upto(first - 1) do |d|
+      cal << %(<td class="#{options[:other_month_class]})
+      cal << " weekendDay" if weekend?(d)
+      cal << %(">#{d.day}</td>)
+    end unless first.wday == first_weekday
+    first.upto(last) do |cur|
+      cell_text, cell_attrs = block.call(cur)
+      cell_text  ||= cur.mday
+      cell_attrs ||= {:class => options[:day_class]}
+      cell_attrs[:class] += " weekendDay" if [0, 6].include?(cur.wday) 
+      cell_attrs = cell_attrs.map {|k, v| %(#{k}="#{v}") }.join(" ")
+      cal << "<td #{cell_attrs}>#{cell_text}</td>"
+      cal << "</tr><tr>" if cur.wday == last_weekday
+    end
+    (last + 1).upto(beginning_of_week(last + 7, first_weekday) - 1)  do |d|
+      cal << %(<td class="#{options[:other_month_class]})
+      cal << " weekendDay" if weekend?(d)
+      cal << %(">#{d.day}</td>)
+    end unless last.wday == last_weekday
+    cal << "</tr></tbody></table>"
+  end
+  
+  private
+  
+  def first_day_of_week(day)
+    day
+  end
+  
+  def last_day_of_week(day)
+    if day > 0
+      day - 1
+    else
+      6
+    end
+  end
+  
+  def days_between(first, second)
+    if first > second
+      second + (7 - first)
+    else
+      second - first
+    end
+  end
+  
+  def beginning_of_week(date, start = 1)
+    days_to_beg = days_between(start, date.wday)
+    date - days_to_beg
+  end
+  
+  def weekend?(date)
+    [0, 6].include?(date.wday)
+  end
+  
+end