schedule_fu 0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Angel N. Sciortino
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,34 @@
+# ScheduleFu
+
+ScheduleFu allows scheduling events with dates and times. It includes both the 
+model and view portions of a calendar. See 
+[RSchedule](http://github.com/angelic/rschedule) for an example application using it.
+
+To generate the ScheduleFu migrations, run:
+
+    rake db:migrate:schedule_fu
+
+### Tables
+
+* calendars: distinct calendar that can be associated with your own models
+* calendar_events: distinct event
+* calendar_recurrences: specific information on particular recurring dates
+* calendar_event_mods: modification to a particular calendar_event
+* calendar_event_types: different types of events
+* calendar_dates: has a row for every day and will automatically generate rows for a 
+year before or after any date used in an event. 
+* calendar_event_dates: a view that has a row for each date included in the event, original or modified information if a column was modified (time, description, etc), plus some additional informational columns
+
+### Informational columns in calendar_event_dates
+
+* added: true if this date was added as a mod and not in the original event 
+* modified: for dates that are included in the original event but have been modified (time, description, etc)
+* removed: true if this particular date was removed (named scopes :removed and :not_removed available in calendar_event_dates)
+
+### Database diagram
+The database diagram can also be found in docs/database.png along with the original Dia file.
+
+![database.png](http://angelic.github.com/schedule_fu/database.png)
+
+This plugin borrows a lot from [acts_as_calendar](http://github.com/dball/acts_as_calendar)
+and [calendar_helper](http://github.com/topfunky/calendar_helper).

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ScheduleFu'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/models/calendar.rb

@@ -0,0 +1,26 @@
+class Calendar < ActiveRecord::Base
+  include ScheduleFu::Finder
+  
+  has_many :events, :class_name=>'CalendarEvent', :dependent => :destroy
+  
+  def max_events_per_day_without_time_set(*args)
+    conditions = conditions_for_date_finders(*args)
+    conditions[0] << ' AND (calendar_event_dates.start_time IS NULL OR calendar_event_dates.end_time IS NULL) AND calendars.id = ?'
+    conditions << self.id
+    row = CalendarEvent.count({:joins => [:calendar, :dates], 
+        :conditions => conditions, :group => 'calendar_date_id', 
+        :order => 'count_all DESC', :limit => 1})
+    row.empty? ? 0 : row.first[1]
+  end
+    
+  def to_ical
+    ical = Icalendar::Calendar.new
+    ical.prodid = 'ScheduleFu'
+    ical.name = 'Foo'
+    ical.to_ical
+    events.each do |event|
+      ical.event do
+      end
+    end
+  end
+end

data/app/models/calendar_date.rb

@@ -0,0 +1,76 @@
+require 'set'
+class CalendarDate < ActiveRecord::Base
+  extend ScheduleFu::Finder
+  
+  has_many :event_dates, :class_name=>'CalendarEventDate', :readonly => true
+  has_many :events, :through => :event_dates
+
+  validates_presence_of :value
+  validates_inclusion_of :weekday, :in => 0..6
+  validates_inclusion_of :monthday, :in => 1..31
+  validates_inclusion_of :monthweek, :in => 0..4
+  validates_inclusion_of :month, :in => 1..12
+
+  before_validation :derive_date_parts, :on => :create
+
+  scope :by_dates, lambda {|*args| {:conditions => conditions_for_date_finders(*args)}}
+  scope :by_values, lambda{|*args| {:conditions => ["value in (?)", args]}}
+  
+  def self.find_by_value(value)
+    find(:first, :conditions => { :value => value })
+  end
+  
+  def self.create_for_dates(start_date = nil, end_date = nil)
+    start_date ||= Date.today
+    end_date ||= 5.years.since(start_date)
+    range = start_date..end_date
+    existing_dates = Set.new
+    self.by_dates(range).each {|d| existing_dates << d.value }
+    range.each do |date|
+      begin
+        self.create(:value => date) unless existing_dates.include?(date)
+      rescue; end
+    end
+  end
+
+  def self.create_for_date(date)
+    self.create_for_dates(date, date)
+  end
+
+  @@create_lock = Mutex.new
+  
+  def self.get_and_create_dates(range)
+    range = range.first.to_date..range.last.to_date
+    dates = self.by_dates(range)
+    if dates.size < range.to_a.size
+      CalendarDate.create_for_dates(range.first, range.last)
+      Thread.new do
+        start_date = 1.year.ago(range.first).to_date
+        end_date = 1.year.since(range.last).to_date
+        @@create_lock.synchronize do
+          CalendarDate.create_for_dates(start_date, end_date)
+        end
+      end
+      dates = self.by_dates(range)
+    end
+    dates
+  end
+  
+  private
+
+  def derive_date_parts
+    self.weekday = value.wday
+    self.monthday = value.mday
+    self.monthweek = (monthday - 1) / 7
+    date = value
+    self.month = date.month
+    days_until_next_month = 0
+    while date = date.next
+      days_until_next_month += 1
+      break if date.month != self.month
+    end
+    if days_until_next_month <= 7
+      self.lastweek = true
+    end
+  end
+end

data/app/models/calendar_event.rb

@@ -0,0 +1,157 @@
+class CalendarEvent < ActiveRecord::Base
+  belongs_to :calendar
+  belongs_to :event_type, :class_name => 'CalendarEventType', 
+      :foreign_key => :calendar_event_type_id
+
+  has_many :mods, :class_name => 'CalendarEventMod', :dependent => :destroy
+  has_many :recurrences, :class_name=>'CalendarRecurrence', :dependent => :destroy
+  has_many :event_dates, :class_name=>'CalendarEventDate', :readonly => true
+  has_many :dates, :through => :event_dates, :readonly => true
+
+  (0..6).each do |n|
+     attr_accessor "_repeat_#{n}".to_sym
+     
+     define_method "repeat_#{n}=" do |*args|
+       sym = "@_repeat_#{n}".to_sym
+       selected = args.first == '1'|| args.first == true
+       self.instance_variable_set(sym, selected)
+     end
+     
+     define_method "repeat_#{n}" do
+       var = self.instance_variable_get("@_repeat_#{n}".to_sym)
+       return var unless var.nil?
+       return recurrences.find_by_weekday(n) ? true : false
+     end
+   end
+  
+  validates_presence_of :calendar, :start_date, :calendar_event_type_id
+  before_save :create_dates_for_range
+  # after_save :add_occurrences
+  after_save :add_recurrences
+
+  scope :with_time_set, :conditions => 'calendar_event_dates.start_time IS NOT NULL AND calendar_event_dates.end_time IS NOT NULL'
+  scope :without_time_set, :conditions => 'calendar_event_dates.start_time IS NULL OR calendar_event_dates.end_time IS NULL'
+  
+  # def to_rrules
+  #   return nil unless recurrences
+  #   rrules = []
+  #   weekly = []
+  #   recurrences.each do |recurrence|
+  #     if recurrence.monthly?
+  #       rrules << (params = {'FREQ' => 'MONTHLY'})
+  #       if !recurrence.weekly?
+  #         params['BYMONTHDAY'] = recurrence.monthday.to_s
+  #       else
+  #         icalmw = ((mw = recurrence.monthweek) >= 0) ? mw + 1 : mw
+  #         icaldc = Icalendar::DAYCODES[recurrence.weekday]
+  #         params['BYDAY'] = icalmw.to_s + icaldc
+  #       end
+  #     else
+  #       weekly << recurrence.weekday
+  #     end
+  #   end
+  #   if !weekly.empty?
+  #     rrules << {'FREQ' => 'WEEKLY',
+  #       'BYDAY' => weekly.map {|w| Icalendar::DAYCODES[w]}.join(',')}
+  #   end
+  #   rrules
+  # end
+  
+  def date_range
+    e_date = self.end_date.blank? ? self.start_date : self.end_date
+    self.start_date.to_date..e_date.to_date
+  end
+
+  def event_type_matches?(*event_types)
+    return false unless event_type
+    name = event_type.name.to_sym
+    event_types.each {|et| return true if et.to_sym == name }
+    return false
+  end
+
+  def any_weekday_selected?
+    (0..6).each do |n|
+      return true if weekday_selected?(n)
+    end
+    return false
+  end
+
+  def weekday_selected?(n)
+    self.send("repeat_#{n}") == true
+  end
+
+  # creates Calendar Event Mods for new dates by date value
+  # takes an array 
+  def add_dates_by_date_value(date_values)
+    transaction do
+      date_values.each do |date_value|
+        next if date_value.blank? 
+        begin
+          CalendarDate.create_for_date(date_value.to_date)
+          event_date = event_dates.first(:conditions => {:date_value => date_value})
+          next if event_date && !event_date.removed?
+          if event_date
+            event_date.mod.destroy
+          else
+            date_id = CalendarDate.find_by_value(date_value).id
+            mods.create(:calendar_date_id => date_id)
+          end
+        rescue
+          errors.add_to_base("Invalid date: #{date_value}")
+          raise ActiveRecord::Rollback
+        end
+      end
+    end
+  end
+
+  # creates Calendar Event Mods for removed dates by date id
+  # takes an array
+  def remove_dates_by_id(date_ids)
+    date_ids.each do |id|
+      next if id.blank?
+      event_date = event_dates.first(:conditions => {:calendar_date_id => id})
+      next unless event_date && !event_date.removed?
+      if event_date.added? || event_date.modified?
+        event_date.mod.destroy
+      end
+      unless event_date.added?
+        mods.create(:calendar_date_id => id, :removed => true)
+      end
+    end
+  end
+
+  protected
+  def create_dates_for_range
+    CalendarDate.get_and_create_dates(self.date_range)
+  end
+  
+  # def add_occurrences
+  #   if event_type.name == "norepeat"
+  #     self.recurrences = []
+  #     self.occurrences = []
+  #     date_range.each {|d| self.occurrences << CalendarDate.by_values(d) }
+  #   end
+  # end
+  
+  def add_recurrences
+    if event_type_matches?(:norepeat, :weekdays, :daily)
+      self.recurrences = []
+    else
+      (0..6).each {|n| self.send("repeat_#{n}=", self.send("repeat_#{n}"))}
+      self.recurrences = []
+      # self.occurrences = []
+      self.recurrences.create(parse_recurrence_params_by_type)
+    end
+  end
+  
+  def parse_recurrence_params_by_type
+    if event_type_matches?(:weekly)
+      arr = []
+      (0..6).each {|n| arr << {:weekday => n} if weekday_selected?(n) }
+      arr
+    elsif event_type_matches?(:monthly, :yearly)
+      {:monthday => start_date.mday, :weekday => start_date.wday, 
+       :monthweek => (start_date.mday - 1) / 7, :month => start_date.month}
+    end
+  end
+end

data/app/models/calendar_event_date.rb

@@ -0,0 +1,8 @@
+class CalendarEventDate < ActiveRecord::Base
+  belongs_to :event, :class_name => 'CalendarEvent', :foreign_key => 'calendar_event_id'
+  belongs_to :date, :class_name => 'CalendarDate', :foreign_key => 'calendar_date_id'
+  belongs_to :mod, :class_name => 'CalendarEventMod', :foreign_key => 'calendar_event_mod_id'
+
+  scope :removed, :conditions => {:removed => true}, :order => 'date_value'
+  scope :not_removed, :conditions => {:removed => false}, :order => 'date_value'
+end

data/app/models/calendar_event_mod.rb

@@ -0,0 +1,8 @@
+class CalendarEventMod < ActiveRecord::Base
+  belongs_to :event, :class_name => 'CalendarEvent', :foreign_key => 'calendar_event_id'
+  belongs_to :date, :class_name => 'CalendarDate', :foreign_key => 'calendar_date_id'
+  has_one :event_date, :class_name => 'CalendarEventDate', :foreign_key => 'calendar_event_mod_id'
+
+  validates_presence_of :calendar_event_id, :calendar_date_id
+  validates_uniqueness_of :calendar_event_id, :scope => :calendar_date_id
+end

data/app/models/calendar_event_type.rb

@@ -0,0 +1,3 @@
+class CalendarEventType < ActiveRecord::Base
+  has_many :calendar_events
+end

data/app/models/calendar_recurrence.rb

@@ -0,0 +1,9 @@
+class CalendarRecurrence < ActiveRecord::Base
+  belongs_to :event, :class_name=>'CalendarEvent', :foreign_key => :calendar_event_id
+
+  validates_presence_of :event
+  validates_inclusion_of :weekday, :in => 0..6, :allow_nil => true
+  validates_inclusion_of :monthday, :in => 1..31, :allow_nil => true
+  validates_inclusion_of :monthweek, :in => -1..4, :allow_nil => true
+  validates_inclusion_of :month, :in => 1..12, :allow_nil => true
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+ScheduleFu::Engine.routes.draw do
+end

data/db/migrate/20120121210741_add_schedule_fu_tables.rb

@@ -0,0 +1,167 @@
+require 'calendar'
+require 'calendar_event_type'
+
+class AddScheduleFuTables < ActiveRecord::Migration
+  def self.up
+    create_table :calendars do |t|
+      t.column :desc, :text
+    end
+    Calendar.create
+    
+    create_table :calendar_dates do |t|
+      t.column :value, :date, :null=>false
+      t.column :weekday, :integer, :limit => 1, :null=>false
+      t.column :monthweek, :integer, :limit => 1, :null=>false
+      t.column :monthday, :integer, :limit => 1, :null=>false
+      t.column :month, :integer, :limit => 1, :null=>false
+      t.column :lastweek, :boolean, :null=>false, :default=>false
+    end
+    add_index :calendar_dates, :value, :unique => true
+ 
+    create_table :calendar_event_types do |t|
+      t.column :name, :string
+      t.column :desc, :string
+    end
+    norepeat_id = create_event_type("norepeat", "Does not repeat").id
+    weekdays_id = create_event_type("weekdays", "Weekdays (M-F)").id
+    daily_id = create_event_type("daily", "Daily").id
+    weekly_id = create_event_type("weekly", "Weekly").id
+    monthly_id = create_event_type("monthly", "Monthly").id
+    yearly_id = create_event_type("yearly", "Yearly").id
+
+    create_table :calendar_events do |t|
+      t.column :calendar_id, :integer, :null=>false
+      t.column :calendar_event_type_id, :integer
+      t.column :by_day_of_month, :boolean, :null => false, :default => false
+      t.column :start_date, :date
+      t.column :end_date, :date
+      t.column :start_time, :time
+      t.column :end_time, :time
+      t.column :desc, :text
+      t.column :long_desc, :text
+    end
+
+    create_table :calendar_event_mods do |t|
+      t.column :calendar_event_id, :integer, :null=>false
+      t.column :calendar_date_id, :integer, :null=>false
+      t.column :start_time, :time
+      t.column :end_time, :time
+      t.column :desc, :text
+      t.column :long_desc, :text
+      t.column :removed, :boolean, :null=>false, :default=>false
+    end
+    add_index :calendar_event_mods, [:calendar_event_id, :calendar_date_id], 
+        :unique => true, :name => "calendar_event_mods_for_event_and_date"
+
+    create_table :calendar_recurrences do |t|
+      t.column :calendar_event_id, :integer, :null=>false
+      t.column :weekday, :integer, :limit => 1
+      t.column :monthweek, :integer, :limit => 1
+      t.column :monthday, :integer, :limit => 1
+      t.column :month, :integer, :limit => 1
+    end
+
+    monthly_and_yearly_where_sql = "
+      (
+        ce.by_day_of_month = false 
+        AND cr.weekday = cd.weekday
+        AND (
+          cr.monthweek = cd.monthweek
+          OR (
+            cr.monthweek = -1
+            AND cd.lastweek = true
+          )
+        )
+      ) OR (
+        ce.by_day_of_month = true AND cr.monthday = cd.monthday
+      )
+    "
+
+    execute <<-END_SQL
+      CREATE VIEW calendar_event_dates AS
+      SELECT
+        ce.id 
+          AS calendar_event_id,
+        cd.id 
+          AS calendar_date_id,
+        cem.id
+          AS calendar_event_mod_id,
+        cd.value 
+          AS date_value,
+        COALESCE(cem.start_time, ce.start_time) 
+          AS start_time,
+        COALESCE(cem.end_time, ce.end_time) 
+          AS end_time,
+        COALESCE(cem.desc, ce.desc) 
+          AS 'desc',
+        COALESCE(cem.long_desc, ce.long_desc) 
+          AS long_desc,
+        ((ce.calendar_event_type_id IN (4,5,6) AND cr.id IS NULL)
+        OR (ce.start_date IS NOT NULL AND cd.value < ce.start_date)
+        OR (ce.end_date IS NOT NULL AND cd.value > ce.end_date)
+        OR (ce.calendar_event_type_id = #{weekdays_id} AND cd.weekday not in (1,2,3,4,5)))
+          AS added,
+        (cem.id IS NOT NULL AND cem.removed = true) 
+          AS removed,
+        (cem.id IS NOT NULL AND cem.removed = false AND
+           (cem.start_time IS NOT NULL OR cem.end_time IS NOT NULL
+            OR cem.desc IS NOT NULL OR cem.long_desc IS NOT NULL))
+          AS modified
+      FROM calendar_dates cd
+      LEFT OUTER JOIN calendar_events ce ON
+        (ce.start_date IS NULL OR ce.start_date IS NOT NULL)
+      LEFT OUTER JOIN calendar_event_mods cem
+        ON cem.calendar_date_id = cd.id 
+        AND cem.calendar_event_id = ce.id
+      LEFT OUTER JOIN calendar_recurrences cr ON cr.calendar_event_id = ce.id
+        AND ce.calendar_event_type_id IN (#{weekly_id},#{monthly_id},#{yearly_id})
+      WHERE 
+        (
+          cd.id IS NOT NULL OR cem.id IS NOT NULL 
+        ) AND (
+          ((ce.start_date IS NULL OR cd.value >= ce.start_date)
+          AND (ce.end_date IS NULL OR cd.value <= ce.end_date))
+          OR cem.id IS NOT NULL
+        ) AND (
+          cem.id IS NOT NULL 
+          OR (
+            ce.calendar_event_type_id = #{norepeat_id} 
+            AND ce.start_date = cd.value
+          ) OR (
+            ce.calendar_event_type_id = #{weekdays_id} AND cd.weekday IN (1,2,3,4,5)
+          ) OR (
+            ce.calendar_event_type_id = #{daily_id}
+          ) OR (
+            ce.calendar_event_type_id = #{weekly_id} 
+            AND cr.weekday = cd.weekday
+          ) OR (
+            ce.calendar_event_type_id = #{monthly_id}
+            AND (
+              #{monthly_and_yearly_where_sql}
+            ) OR (
+              ce.calendar_event_type_id = #{yearly_id}
+              AND cd.month = cr.month 
+              AND (
+                #{monthly_and_yearly_where_sql}
+              )
+            )
+          )
+        );
+    END_SQL
+  end
+ 
+  def self.down
+    execute "DROP VIEW calendar_event_dates"
+    drop_table :calendar_recurrences
+    drop_table :calendar_event_mods
+    drop_table :calendar_events
+    drop_table :calendar_event_types
+    remove_index :calendar_dates, :value
+    drop_table :calendar_dates
+    drop_table :calendars
+  end
+
+  def self.create_event_type(name, desc)
+    CalendarEventType.create(:name => name, :desc => desc)
+  end
+end