schedule_fu 0.2

data/lib/schedule_fu.rb

@@ -0,0 +1,8 @@
+require "schedule_fu/calendar_helper"
+require "schedule_fu/engine"
+require "schedule_fu/parser"
+require "schedule_fu/finder"
+require "schedule_fu/schedule_fu_helper"
+
+module ScheduleFu
+end

data/lib/schedule_fu/calendar_helper.rb

@@ -0,0 +1,247 @@
+require 'date'
+
+# CalendarHelper allows you to draw a databound calendar with fine-grained CSS formatting
+module ScheduleFu
+  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.
+    #   :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_name_array => Date::MONTHNAMES   # Array of months
+    #   :display_year => options[:year]         # Year to display
+    #
+    # 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}
+  
+      options = defaults(options).merge(options)
+      vars = setup_variables(options)
+      
+      content_tag(:table, :class => options[:table_class], :border => 0, 
+          :cellspacing => 0, :cellpadding => 0) do
+        text = calendar_head(options, vars).html_safe
+        text << calendar_body(options, vars, &block).html_safe
+      end
+    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
+    
+    def defaults(options)
+      { 
+        :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,
+        :accessible => false,
+        :show_today => true,
+        :previous_month_text => nil,
+        :next_month_text => nil,
+        :month_name_array => Date::MONTHNAMES,
+        :display_year => options[:year]
+      }
+    end
+    
+    def setup_variables(options)
+      vars = {}
+      vars[:first] = Date.civil(options[:year], options[:month], 1)
+      vars[:last] = Date.civil(options[:year], options[:month], -1)
+  
+      vars[:first_weekday] = first_day_of_week(options[:first_day_of_week])
+      vars[:last_weekday] = last_day_of_week(options[:first_day_of_week])
+      vars
+    end
+    
+    def calendar_head(options, vars)
+      content_tag(:thead) do
+        contents = content_tag(:tr) do
+          text = "".html_safe
+          text << content_tag(:th, :colspan => determine_colspan(text, options), 
+              :class => options[:month_name_class]) do
+            "#{options[:month_name_array][options[:month]]} #{options[:display_year]}"
+          end
+          text << content_tag(:th, options[:next_month_text], :colspan => 2) if options[:next_month_text]
+          text
+        end
+        contents << content_tag(:tr, :class => options[:day_name_class]) do
+          add_day_names(options, vars)
+        end
+      end
+    end
+    
+    def add_day_names(options, vars)
+      text = "".html_safe
+      day_names(vars[:first_weekday]).each do |d|
+        text << content_tag(:th, :scope => 'col') do
+          unless d[options[:abbrev]].eql? d
+            content_tag(:abbr, d[options[:abbrev]], :title => d)
+          else
+            d[options[:abbrev]]
+          end
+        end
+      end
+      text
+    end
+    
+    def day_names(first_weekday)
+      day_names = Date::DAYNAMES.dup
+      first_weekday.times do
+        day_names.push(day_names.shift)
+      end
+      day_names
+    end
+    
+    def determine_colspan(contents, options)
+      if options[:previous_month_text] || options[:next_month_text]
+        contents << content_tag(:th, :colspan => 2) do
+          options[:previous_month_text]
+        end
+        3
+      else
+        7
+      end
+    end
+    
+    def calendar_body(options, vars, &block)
+      content_tag(:tbody) do
+        content_tag(:tr) do
+          text = fill_days_last_month(options, vars[:first], vars[:first_weekday], &block)
+          text << fill_days_this_month(options, vars[:first], vars[:last], vars[:last_weekday], &block)
+          text << fill_days_next_month(options, vars[:last], vars[:first_weekday], vars[:last_weekday], &block)
+        end
+      end
+    end
+    
+    def fill_days_last_month(options, first, first_weekday, &block)
+      text = "".html_safe
+      beginning_of_week(first, first_weekday).upto(first - 1) do |d|
+        text << fill_day(d, options, false, &block)
+      end unless first.wday == first_weekday
+      text
+    end
+    
+    def fill_days_this_month(options, first, last, last_weekday, &block)
+      text = "".html_safe
+      first.upto(last) do |d|
+        text << fill_day(d, options, true, &block)
+        text << "</tr><tr>".html_safe if d.wday == last_weekday
+      end
+      text
+    end
+    
+    def fill_days_next_month(options, last, first_weekday, last_weekday, &block)
+      text = "".html_safe
+      (last + 1).upto(beginning_of_week(last + 7, first_weekday) - 1)  do |d|
+        text << fill_day(d, options, false, &block)
+      end unless last.wday == last_weekday
+      text
+    end
+    
+    def fill_day(d, options = nil, current = false, &block)
+      cell_text, cell_attrs = block.call(d)
+      cell_text  ||= d.mday
+      cell_attrs ||= {}
+      cell_attrs[:class] ||= options[:day_class]
+      cell_attrs[:class] += " weekendDay" if weekend?(d) 
+      cell_attrs[:class] += " today" if (d == Date.today) && options[:show_today]
+      content_tag(:td, cell_attrs) do
+        text = cell_text
+        text << accessible_text(options) if current
+        text
+      end
+    end
+    
+    def accessible_text(options)
+      options[:accessible] ? 
+          "<span class='hidden'> #{options[:month_name_array][d.mon]}</span>" : ""
+    end
+  end
+end

data/lib/schedule_fu/engine.rb

@@ -0,0 +1,5 @@
+module ScheduleFu
+  class Engine < ::Rails::Engine
+    isolate_namespace ScheduleFu
+  end
+end

data/lib/schedule_fu/finder.rb

@@ -0,0 +1,16 @@
+module ScheduleFu
+  module Finder
+    include ScheduleFu::Parser
+    
+    def conditions_for_date_finders(*args)
+      dates = parse(*args)
+      case dates
+        when Date then ['value = ?', dates]
+        when Range then ['value BETWEEN ? AND ?', dates.first, dates.last]
+        when Enumerable then ['value IN (?)', dates]
+        else
+          raise ArgumentError
+      end
+    end
+  end
+end

data/lib/schedule_fu/parser.rb

@@ -0,0 +1,108 @@
+# Some methods for parsing date expressions from strings
+module ScheduleFu
+  module Parser
+    def parse(*args)
+      raise ArgumentError unless args.length > 0
+      if args.length == 1
+        case args[0]
+          when String then parse_dates(args[0])
+          when Date then args[0]
+          when Time then args[0]
+          when Enumerable then args[0].map {|arg| parse(arg)}
+          else raise ArgumentError, args[0].class.to_s
+        end
+      elsif args.length == 2
+        (parse_date(args[0]) .. parse_date(args[1]))
+      else
+        args.map {|arg| parse(arg) }
+      end
+    end
+  
+    def parse_date(string)
+      unless string.nil?
+        begin
+          Date.parse(string)
+        rescue; end
+      end
+    end
+  
+    def parse_dates(string)
+      parse_recurring_dates(string) || parse_specific_dates(string)
+    end
+  
+    private
+  
+    def parse_specific_dates(value)
+      if (parts = value.split('-')).length == 2
+        first = parse_date(parts[0])
+        last = parse_date(parts[1])
+        if first && last
+          return (first .. last)
+        end
+      elsif (parts = value.split(',')).length > 1
+        parts = parts.map {|part| parse_date(part) }
+        if parts.all? {|part| !part.nil? }
+          return parts
+        end
+      elsif date = parse_date(value)
+        return date
+      end
+    end
+  
+    # Parses the given value for repeating date strings of the form:
+    #
+    # * Saturdays
+    # * Every Friday
+    # * every 3rd tuesday
+    # * 2nd and 4th Fridays of the month
+    #
+    # and returns a hash with keys :weekday and :monthweek, where the weekday
+    # is the index of the day in the Date::DAYNAMES array (0-based) and the
+    # monthweek is either nil, an integer, or an array of integers,
+    # corresponding to the offset of the week(s) of the month.
+    def parse_weekly_dates(value)
+      # FIXME repeats data from monthweek. we should probably get a more
+      # robust parser going here
+      unless md = /^\s*(?:Every )?\s*(1st|2nd|3rd|4th|last|first|second|third|fourth)?(?:\s*(?:and|&)\s*(1st|2nd|3rd|4th|last|first|second|third|fourth))?\s*((?:Sun|Mon|Tues|Wednes|Thurs|Fri|Satur)day)s?\s*(?:of each month|of the month|every month)?\s*$/i.match(value)
+        return nil
+      end
+      weekday = Date::DAYNAMES.index(md[3].downcase.capitalize)
+      if md[2]
+        monthweek = [monthweek(md[1]), monthweek(md[2])]
+        return [{:weekday => weekday, :monthweek => md[1]}, {:weekday => weekday, :monthweek => md[2]}]
+      elsif md[1]
+        monthweek = monthweek(md[1])
+      else
+        monthweek = nil
+      end
+      {:weekday => weekday, :monthweek => monthweek }
+    end
+  
+    # Returns the monthweek integer value of the given string, e.g.
+    # first -> 0. It ignores case, and allows both full and abbreviated
+    # ordinal number names, as well as the special name 'last'. If unable
+    # to convert, it will raise an ArgumentError.
+    def monthweek(value)
+      case value.downcase
+        when 'last' then -1
+        when '1st' then 0
+        when 'first' then 0
+        when '2nd' then 1
+        when 'second' then 1
+        when '3rd' then 2
+        when 'third' then 2
+        when '4th' then 3
+        when 'fourth' then 3
+        else raise ArgumentError, value
+      end
+    end
+  end
+end
+
+#module Icalendar
+#  DAYCODES = ['SU', 'MO', 'TU', 'WE', 'TH', 'FR', 'SA']
+#
+#  class Calendar < Component
+#    ical_property :x_wr_calname, :name
+#  end
+#end

data/lib/schedule_fu/schedule_fu_helper.rb

@@ -0,0 +1,17 @@
+module ScheduleFu
+  module ScheduleFuHelper
+    
+    def previous_sunday(date)
+      date = parse_date_or_now(date)
+      date.wday.ago date
+    end
+    
+    def parse_date_or_now(date)
+      begin
+        Date.parse(date)
+      rescue
+        Time.now.to_date
+      end
+    end
+  end
+end

data/lib/schedule_fu/version.rb

@@ -0,0 +1,3 @@
+module ScheduleFu
+  VERSION = "0.2"
+end

data/lib/tasks/schedule_fu_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :schedule_fu do
+#   # Task goes here
+# end

data/test/calendar_event_test.rb

@@ -0,0 +1,229 @@
+require 'test_helper'
+
+class CalendarEventTest < ActiveSupport::TestCase
+  describe CalendarEvent do
+    it { should validate_presence_of :calendar }
+    it { should validate_presence_of :start_date }
+    it { should validate_presence_of :calendar_event_type_id }
+  end
+
+  context "norepeat event" do
+    setup do
+      @event = FactoryGirl.create(:calendar_event_norepeat, :start_date => 1.day.from_now, 
+          :end_date => 2.weeks.from_now)
+    end
+
+    should "have no recurrences" do
+      assert_equal 0, @event.recurrences.count
+    end
+
+    should "have 1 event date that matches the start date" do
+      assert_equal 1, @event.dates.count
+      assert_equal @event.start_date.to_date, @event.dates.first.value
+    end
+  end
+
+  context "weekdays event" do
+    setup do
+      @event = FactoryGirl.create(:calendar_event_weekdays, :start_date => 1.day.from_now, 
+          :end_date => 2.weeks.from_now)
+      @count_of_weekdays = Hash.new {|hash, key| hash[key] = 0}
+      @event.dates.each do |d|
+        @count_of_weekdays[d.weekday] += 1
+      end
+    end
+
+    should "have no recurrences" do
+      assert_equal 0, @event.recurrences.count
+    end
+
+    should "have 10 event dates" do
+      assert_equal 10, @event.event_dates.count
+    end
+
+    should "have 2 of each weekday" do
+      (1..5).each do |n|
+        assert_equal 2, @count_of_weekdays[n]
+      end
+    end  
+    
+    should "not have Sunday or Saturday" do
+      [0,6].each do |n|
+        assert_equal 0, @count_of_weekdays[n]
+      end
+    end
+  end
+
+  context "daily event with 14 event dates" do
+    setup do
+      @event = FactoryGirl.create(:calendar_event_daily, :start_date => 1.day.from_now,
+          :end_date => 2.weeks.from_now)
+    end
+
+    should "have no recurrences" do
+      assert_equal 0, @event.recurrences.count
+    end
+
+    should "have 14 event dates" do
+      assert_equal 14, @event.event_dates.count
+    end 
+
+    should "be in the correct range" do
+      @event.dates.each do |d|
+        assert d.value >= @event.start_date.to_date
+        assert d.value <= @event.end_date.to_date
+      end
+    end
+  end
+
+  context "weekly event" do
+    context "on Monday, Wednesday, and Friday with 6 event dates" do
+      setup do
+        @event = FactoryGirl.create(:calendar_event_weekly, :repeat_0 => false, :repeat_1 => true,
+            :repeat_2 => false, :repeat_3 => true, :repeat_4 => false, 
+            :repeat_5 => true, :repeat_6 => false, :start_date => 1.day.from_now,
+            :end_date => 2.weeks.from_now)
+        @count_of_weekdays = Hash.new {|hash, key| hash[key] = 0}
+        @event.dates.each do |d|
+          @count_of_weekdays[d.weekday] += 1
+        end
+      end
+
+      should "have 3 recurrences" do
+        assert_equal 3, @event.recurrences.count
+      end
+
+      should "have 6 event dates" do
+        assert_equal 6, @event.event_dates.count
+      end
+
+      should "have 2 each of Monday, Wednesday, and Friday" do
+        [1,3,5].each do |n|
+          assert_equal 2, @count_of_weekdays[n]
+        end
+      end  
+      
+      should "not have Sunday, Tuesday, Thursday, or Saturday" do
+        [0,2,4,6].each do |n|
+          assert_equal 0, @count_of_weekdays[n]
+        end
+      end
+    end
+  end
+
+  context "monthly event" do
+    context "by day of month with 6 event dates" do
+      setup do
+        @event = FactoryGirl.create(:calendar_event_monthly, :by_day_of_month => true,
+            :start_date => 1.week.ago, :end_date => 5.months.from_now)
+        @recurrence = @event.recurrences.first
+      end
+
+      should "have 1 recurrence" do
+        assert_equal 1, @event.recurrences.count
+      end
+
+      should "have 6 event dates" do
+        assert_equal 6, @event.event_dates.count
+      end 
+
+      should "have the correct day of month" do
+        @event.dates.each do |d|
+          assert_equal @recurrence.monthday, d.monthday
+        end
+      end
+    end
+
+    context "by day of week with 6 event dates" do
+      setup do
+        @event = FactoryGirl.create(:calendar_event_monthly, :by_day_of_month => false,
+            :start_date => 1.week.ago, :end_date => 5.months.from_now)
+        @recurrence = @event.recurrences.first
+      end
+
+      should "have 1 recurrence" do
+        assert_equal 1, @event.recurrences.count
+      end
+
+      should "have 6 event dates" do
+        assert_equal 6, @event.event_dates.count
+      end 
+
+      should "have the correct day of week" do
+        @event.dates.each do |d|
+          assert_equal @recurrence.weekday, d.weekday
+        end
+      end
+
+      should "have the correct week" do
+        @event.dates.each do |d|
+          assert_equal @recurrence.monthweek, d.monthweek
+        end
+      end
+    end
+  end
+
+  context "yearly event" do
+    context "by day of month with 2 event dates" do
+      setup do
+        @event = FactoryGirl.create(:calendar_event_yearly, :by_day_of_month => true,
+            :start_date => 1.month.ago, :end_date => 1.year.from_now)
+        @recurrence = @event.recurrences.first
+      end
+
+      should "have 1 recurrence" do
+        assert_equal 1, @event.recurrences.count
+      end
+
+      should "have 2 event dates" do
+        assert_equal 2, @event.event_dates.count
+      end 
+
+      should "have the correct month" do
+        @event.dates.each do |d|
+          assert_equal @recurrence.month, d.month
+        end
+      end
+
+      should "have the correct day of month" do
+        @event.dates.each do |d|
+          assert_equal @recurrence.monthday, d.monthday
+        end
+      end
+    end
+
+    context "by day of week with 2 event dates" do
+      setup do
+        @event = FactoryGirl.create(:calendar_event_yearly, :by_day_of_month => false,
+            :start_date => 1.month.ago, :end_date => 1.year.from_now)
+        @recurrence = @event.recurrences.first
+      end
+
+      should "have 1 recurrence" do
+        assert_equal 1, @event.recurrences.count
+      end
+
+      should "have 2 event dates" do
+        assert_equal 2, @event.event_dates.count
+      end 
+
+      should "have the correct month" do
+        @event.dates.each do |d|
+          assert_equal @recurrence.month, d.month
+        end
+      end
+
+      should "have the correct day of week" do
+        @event.dates.each do |d|
+          assert_equal @recurrence.weekday, d.weekday
+        end
+      end
+
+      should "have the correct week" do
+        @event.dates.each do |d|
+          assert_equal @recurrence.monthweek, d.monthweek
+        end
+      end
+    end
+  end
+end