event_calendar 0.0.0 → 0.0.1

data/lib/{calendar → event_calendar}/stylesheet.sass

@@ -24,7 +24,7 @@
   :-webkit-border-top-right-radius= 0px
   :border-top-right-radius= 0px
 
-.calendar
+.event_calendar
   
   table
     border-collapse: collapse
@@ -92,7 +92,7 @@
 !label_background_color = #EBEDE2
 !label_color = #000
 
-.calendar
+.event_calendar
   border-bottom= !border_width "solid" !border_color
   
   table td

data/lib/{calendar → event_calendar}/template.mab

@@ -1,71 +1,71 @@
-div.calendar.send(calendar.date.strftime('%B').downcase).send("#{calendar.id}!") do
+div.event_calendar.send(event_calendar.date.strftime('%B').downcase).send("#{event_calendar.id}!") do
   div.header do
     table do
       tbody do
         tr.navigation do
           td.previous_month(:colspan => 2) do
-            a(:rel => 'previous', :href => calendar.navigation_url.call(calendar.date.last_month)) do
-              calendar.evaluate_date_format_option(:navigation_label, calendar.date.last_month, calendar.date)
+            a(:rel => 'previous', :href => event_calendar.navigation_url.call(event_calendar.date.last_month)) do
+              event_calendar.evaluate_date_format_option(:navigation_label, event_calendar.date.last_month, event_calendar.date)
             end
           end
-          td.current_month calendar.evaluate_date_format_option(:header_label, calendar.date), :colspan => 3
+          td.current_month event_calendar.evaluate_date_format_option(:header_label, event_calendar.date), :colspan => 3
           td.next_month(:colspan => 2) do
-            a(:rel => 'next', :href => calendar.navigation_url.call(calendar.date.next_month)) do
-              calendar.evaluate_date_format_option(:navigation_label, calendar.date.next_month, calendar.date)
+            a(:rel => 'next', :href => event_calendar.navigation_url.call(event_calendar.date.next_month)) do
+              event_calendar.evaluate_date_format_option(:navigation_label, event_calendar.date.next_month, event_calendar.date)
             end
           end
         end
         tr.labels do
-          calendar.weeks.first.each_with_index do |day, index|
+          event_calendar.weeks.first.each_with_index do |day, index|
             day_label = td.day
             day_label = day_label.send(day.strftime('%A').downcase)
             day_label = day_label.today if day.cwday == Time.now.to_date.cwday
-            day_label.label calendar.evaluate_date_format_option(:header_day_label, day)
+            day_label.label event_calendar.evaluate_date_format_option(:header_day_label, day)
           end
         end
       end
     end
   end
   div.body do
-    calendar.weeks.each do |week|
-      div.week.send("#{calendar.id}_week_#{week.first}_#{week.last}!") do
-        table.send("#{calendar.id}_labels_#{week.first}_#{week.last}!") do
+    event_calendar.weeks.each do |week|
+      div.week.send("#{event_calendar.id}_week_#{week.first}_#{week.last}!") do
+        table.send("#{event_calendar.id}_labels_#{week.first}_#{week.last}!") do
           tbody do
             tr.labels do
               week.each do |day|
                 day_label = td.day
-                day_label = day_label.send(day.month == calendar.date.month ? 'current_month' : day < calendar.date ? 'previous_month' : 'next_month')
+                day_label = day_label.send(day.month == event_calendar.date.month ? 'current_month' : day < event_calendar.date ? 'previous_month' : 'next_month')
                 day_label = day_label.send([6, 7].include?(day.cwday) ? 'weekend' : 'weekday')
                 day_label = day_label.send(day.strftime('%A').downcase)
                 day_label = day_label.send(day.strftime('%B').downcase)
                 day_label = day_label.send("day_#{day.strftime('%d').gsub(/^0/, '')}")
                 day_label = day_label.today if day == Time.now.to_date
-                day_label = day_label.scheduled if calendar.events.any? { |event| event.start_date <= day && event.end_date >= day }
-                day_label.label calendar.evaluate_date_format_option(:day_label, day)
+                day_label = day_label.scheduled if event_calendar.events.any? { |event| event.start_date <= day && event.end_date >= day }
+                day_label.label event_calendar.evaluate_date_format_option(:day_label, day)
               end
             end
           end
         end
-        div.days.send("#{calendar.id}_days_#{week.first}_#{week.last}!") do
-          table.grid.send("#{calendar.id}_grid_#{week.first}_#{week.last}!") do
+        div.days.send("#{event_calendar.id}_days_#{week.first}_#{week.last}!") do
+          table.grid.send("#{event_calendar.id}_grid_#{week.first}_#{week.last}!") do
             tbody do
               tr do
                 week.each do |day| 
                   day_grid = td.day
-                  day_grid = day_grid.send(day.month == calendar.date.month ? 'current_month' : day < calendar.date ? 'previous_month' : 'next_month')
+                  day_grid = day_grid.send(day.month == event_calendar.date.month ? 'current_month' : day < event_calendar.date ? 'previous_month' : 'next_month')
                   day_grid = day_grid.send([6, 7].include?(day.cwday) ? 'weekend' : 'weekday')
                   day_grid = day_grid.send(day.strftime('%A').downcase)
                   day_grid = day_grid.send(day.strftime('%B').downcase)
                   day_grid = day_grid.send("day_#{day.strftime('%d').gsub(/^0/, '')}")
                   day_grid = day_grid.today if day == Time.now.to_date
-                  day_grid = day_grid.scheduled if calendar.events.any? { |event| event.start_date <= day && event.end_date >= day }
-                  day_grid.send("#{calendar.id}_day_#{day}!") {}
+                  day_grid = day_grid.scheduled if event_calendar.events.any? { |event| event.start_date <= day && event.end_date >= day }
+                  day_grid.send("#{event_calendar.id}_day_#{day}!") {}
                 end
               end
             end
           end
           unless week.events.empty?
-            table.events.send("#{calendar.id}_events_#{week.first}_#{week.last}!") do
+            table.events.send("#{event_calendar.id}_events_#{week.first}_#{week.last}!") do
               tbody do
                 tr.grid do
                   week.each { |day| td('') }
@@ -78,7 +78,7 @@ div.calendar.send(calendar.date.strftime('%B').downcase).send("#{calendar.id}!")
                       else
                         html_options = { :class => 'event' }
                         html_options[:colspan] = cell[:span] unless cell[:span] == 1
-                        html_options[:class] << " #{calendar.event_class}" unless calendar.event_class.nil?
+                        html_options[:class] << " #{event_calendar.event_class}" unless event_calendar.event_class.nil?
                         if cell[:continued]
                           html_options[:class] << ' continuation' if cell[:event].start_date < week.first
                           html_options[:class] << ' continued' if cell[:event].end_date > week.last
@@ -86,8 +86,8 @@ div.calendar.send(calendar.date.strftime('%B').downcase).send("#{calendar.id}!")
                         event_id = "event_#{cell[:event].id}"
                         begin
                           td.send("#{event_id}!", html_options) do
-                            calendar.event_output.call(cell[:event]) + div.fields do
-                              calendar.event_fields.each do |field|
+                            event_calendar.event_output.call(cell[:event]) + div.fields do
+                              event_calendar.event_fields.each do |field|
                                 span(cell[:event].send(field), :title => field)
                               end
                             end

data/lib/event_calendar/week.rb

@@ -0,0 +1,67 @@
+class EventCalendar
+  
+  # Contains an array of days representing a calendar week
+  class Week < Array
+    
+    extend ActiveSupport::Memoizable
+    
+    # Accepts two arguments, an array of days and an array of events
+    def initialize(days, events)
+      super days
+      add_associated_events_to_days(events)
+    end
+    
+    # Returns an array of arrays containing hashes of events to fit in an HTML calendar week row.
+    #
+    # Each hash in the array represents a table cell <tt>td</tt> when the calendar is generated.
+    # If the hash is empty, an empty <tt>td</tt> would be generated. Otherwise, the <tt>td</tt>
+    # will contain information related to the associated event. An event hash contains:
+    #
+    #   :event      =>  The event object.
+    #   :span       =>  The number of days this event takes up in the current week row.
+    #   :continued  =>  A boolean determining if this event starts before or ends after the current week.
+    #
+    # For example:
+    #
+    #   puts @week.events.inspect
+    #
+    #   # [
+    #   #   [{}, {}, { :event => ..., :span => 1, :continued => false }, { :event => ..., :span => 1, :continued => false}, {}, {}, {}],
+    #   #   [{}, {}, { :event => ..., :span => 1, :continued => false }, {}, {}, {}, { :event => ..., :span => 1, :continued => true }],
+    #   #   [{}, {}, { :event => ..., :span => 1, :continued => false }, {}, {}, {}, {}],
+    #   #   [{}, {}, { :event => ..., :span => 1, :continued => false }, {}, {}, {}, {}],
+    #   #   [{}, {}, { :event => ..., :span => 4, :continued => false }, {}]
+    #   # ]
+    def events
+      events = []
+      day_events_index = inject({}) { |hash, day| hash.merge! day => 0 }
+      until all? { |day| day_events_index[day] == day.events.size }
+        row = []
+        each_with_index do |day, index|
+          cell_count = row.inject(0) { |sum, cell| sum += (cell.empty? ? 1 : cell[:span]) }
+          next if cell_count > index || cell_count >= 7
+          
+          cell = {}
+          unless day_events_index[day] == day.events.size
+            cell[:event] = day.events[day_events_index[day]]
+            cell[:span] = cell[:event].days(first, last)
+            cell[:continued] = cell[:event].days != cell[:span]
+            day_events_index[day] += 1
+          end
+          row << cell
+        end
+        events << row
+      end
+      events
+    end
+    memoize :events
+    
+    protected
+    
+      # Loops through each day in this week and adds any associated events to its <tt>:events</tt> array.
+      def add_associated_events_to_days(events)
+        each { |day| day.events = events.select { |event| event.start_date == day || (event.start_date < day && event.end_date >= day && day == first) } }
+      end
+    
+  end
+end

data/lib/tasks/generate.rake

@@ -1,28 +1,26 @@
 require 'fileutils'
 
-CALENDAR_ROOT = File.join(File.dirname(__FILE__), '..', '..')
-ASSETS_ROOT = File.join(CALENDAR_ROOT, 'assets')
-SANDBOX_ROOT = File.join(CALENDAR_ROOT, 'sandbox')
+EVENT_CALENDAR_ROOT = File.join(File.dirname(__FILE__), '..', '..')
+ASSETS_ROOT = File.join(EVENT_CALENDAR_ROOT, 'assets')
+SANDBOX_ROOT = File.join(EVENT_CALENDAR_ROOT, 'sandbox')
 
-namespace :calendar do
+namespace :event_calendar do
   namespace :generate do
-    desc 'Generates css for the calendar'
+    desc 'Generates css for the event calendar'
     task :css => :build_css do
-      puts File.read(File.join(ASSETS_ROOT, 'stylesheets', 'calendar.css'))
+      puts File.read(File.join(ASSETS_ROOT, 'stylesheets', 'event_calendar.css'))
     end
     
-    desc 'Generates js for the calendar'
+    desc 'Generates js for the event calendar'
     task :js do
-      puts File.read(File.join(ASSETS_ROOT, 'javascripts', 'calendar.js'))
+      puts File.read(File.join(ASSETS_ROOT, 'javascripts', 'event_calendar.prototype.js'))
     end
     
-    desc 'Creates a sandbox in the gem root for testing'
+    desc 'Creates a sandbox in the current working directory for testing'
     task :sandbox => [:build_css] do
-      $:.unshift(File.join(CALENDAR_ROOT, 'lib'))
+      $:.unshift(File.join(EVENT_CALENDAR_ROOT, 'lib'))
       require 'timecop'
-      require 'active_support'
-      require 'markaby'
-      require 'calendar'
+      require 'event_calendar'
       
       FileUtils.mkdir(SANDBOX_ROOT) unless File.exists?(SANDBOX_ROOT)
       FileUtils.cp_r(File.join(ASSETS_ROOT, '.'), SANDBOX_ROOT)
@@ -42,7 +40,7 @@ namespace :calendar do
           Event.new('Event 4 has a longer title', 3.days.from_now, 5.days.from_now),
           Event.new('Event 5 spans across multiple weeks', 4.days.from_now, 12.days.from_now)
         ]
-        @calendar = Calendar.new(Time.now.year, Time.now.month, :events => events)
+        @event_calendar = EventCalendar.new(Time.now.year, Time.now.month, :events => events)
       end
       
       File.open(File.join(SANDBOX_ROOT, 'index.html'), 'w+') do |file|
@@ -50,24 +48,24 @@ namespace :calendar do
         <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
         <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
             <head>
-                <title>Calendar</title>
+                <title>Event Calendar</title>
                 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-                <link href="stylesheets/yui-2.7.0.css" media="screen" rel="stylesheet" type="text/css" />
-                <link href="stylesheets/calendar.css" media="screen" rel="stylesheet" type="text/css" />
-                <script src="javascripts/prototype-1.6.1.js" type="text/javascript"></script>
-                <script src="javascripts/calendar.js" type="text/javascript"></script>
+                <link href="http://yui.yahooapis.com/combo?2.7.0/build/reset-fonts-grids/reset-fonts-grids.css&amp;2.7.0/build/base/base-min.css" media="screen" rel="stylesheet" type="text/css" />
+                <link href="stylesheets/event_calendar.css" media="screen" rel="stylesheet" type="text/css" />
+                <script src="http://ajax.googleapis.com/ajax/libs/prototype/1.6.1.0/prototype.js" type="text/javascript"></script>
+                <script src="javascripts/event_calendar.prototype.js" type="text/javascript"></script>
                 <script type="text/javascript">
                     //<![CDATA[
                     document.observe('dom:loaded', function() {
-                      $$('.calendar').each(function(element) {
-                        new Calendar(element);
+                      $$('.event_calendar').each(function(element) {
+                        new EventCalendar(element);
                       });
                     });
                     //]]>
                 </script>
             </head>
             <body>
-              #{@calendar}
+              #{@event_calendar}
             </body>
         </html>
         EOF
@@ -78,8 +76,8 @@ namespace :calendar do
       require 'haml'
       require 'sass/engine'
       
-      sass = File.join(CALENDAR_ROOT, 'lib', 'calendar', 'stylesheet.sass')
-      File.open(File.join(ASSETS_ROOT, 'stylesheets', 'calendar.css'), 'w+') do |file| 
+      sass = File.join(EVENT_CALENDAR_ROOT, 'lib', 'event_calendar', 'stylesheet.sass')
+      File.open(File.join(ASSETS_ROOT, 'stylesheets', 'event_calendar.css'), 'w+') do |file| 
         file.write Sass::Engine.new(File.read(sass)).to_css
       end
     end

data/test/date_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class DateTest < Test::Unit::TestCase
+
+  context 'a date' do
+    setup { @date = Time.now.to_date }
+    
+    should 'have an events attr_accessor' do
+      assert @date.respond_to?(:events)
+      assert @date.respond_to?(:events=)
+    end
+  end
+  
+end

data/test/event_calendar_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+class EventCalendarTest < Test::Unit::TestCase
+
+  context 'an EventCalendar instance' do
+    setup do
+      Timecop.freeze(Date.civil(2009, 10, 6)) do
+        @event_calendar = EventCalendar.new(Time.now.year, Time.now.month, 
+          :events => events,
+          :date_format_string => '%B',
+          :date_format_symbol => :year,
+          :date_format_proc => proc { |date| date.year },
+          :date_format_integer => 2009
+        )
+      end
+    end
+    
+    should 'return the first day of its specified month and year when calling date' do
+      assert_equal Date.civil(2009, 10, 1), @event_calendar.date
+    end
+    
+    context 'when calling evaluate_date_format_option it' do
+      setup { @date = @event_calendar.date }
+      
+      should 'evaluate strings' do
+        assert_equal @date.strftime('%B'), @event_calendar.evaluate_date_format_option(:date_format_string, @date)
+      end
+      
+      should 'evaluate symbols' do
+        assert_equal @date.year, @event_calendar.evaluate_date_format_option(:date_format_symbol, @date)
+      end
+      
+      should 'evaluate procs' do
+        assert_equal @date.year, @event_calendar.evaluate_date_format_option(:date_format_proc, @date)
+      end
+      
+      should 'return all other values' do
+        assert_equal 2009, @event_calendar.evaluate_date_format_option(:date_format_integer, @date)
+      end
+    end
+    
+    context 'when calling method_missing it' do
+      should 'read an option' do
+        assert_equal @event_calendar.options[:date_format_string], @event_calendar.date_format_string
+      end
+      
+      should 'write an option' do
+        assert_equal @event_calendar.options[:date_format_string], @event_calendar.date_format_string
+        @event_calendar.date_format_string = 'testing'
+        assert_equal 'testing', @event_calendar.options[:date_format_string]
+      end
+      
+      should 'call super if an option does not exist' do
+        assert_raises NoMethodError do
+          @event_calendar.missing_option
+        end
+      end
+    end
+    
+    context 'when rendering it' do
+      should 'render the default template' do
+        assert_match /id="#{@event_calendar.id}"/, @event_calendar.to_s
+      end
+      
+      should 'read and render a different template file' do
+        @event_calendar.template = File.join(fixtures_path, 'template.mab')
+        assert_equal '<div class="event_calendar"></div>', @event_calendar.to_s
+      end
+      
+      should 'render a template string' do
+        @event_calendar.template = "div.testing do\nend"
+        assert_equal '<div class="testing"></div>', @event_calendar.to_s
+      end
+    end
+    
+    should 'return an array of weeks containing seven days when calling weeks' do
+      @weeks = (Date.civil(2009, 9, 27)..Date.civil(2009, 10, 31)).to_a.in_groups_of(7).collect { |week| EventCalendar::Week.new(week, @event_calendar.events) }
+      assert_equal @weeks, @event_calendar.weeks
+    end
+  end
+  
+end

data/test/event_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+class EventTest < Test::Unit::TestCase
+
+  context 'an EventCalendar::Event' do
+    setup do 
+      @event_title = 'testing'
+      @start_time = Time.local(2010, 1, 3, 10, 5, 0)
+      @end_time = Time.local(2010, 1, 5, 11, 35, 0)
+      @raw_event = Event.new(@event_title, @start_time, @end_time)
+      @event = EventCalendar::Event.new(@raw_event, EventCalendar.default_options.merge({
+        :event_title_symbol => :title, 
+        :event_title_string => 'string', 
+        :event_title_proc   => proc { |event| event.title + '_proc' }
+      }))
+    end
+    
+    should 'have a start_date' do
+      assert_equal @start_time.to_date, @event.start_date
+    end
+    
+    should 'have an end_date' do
+      assert_equal @end_time.to_date, @event.end_date
+    end
+    
+    should 'return the number of days it spans' do
+      assert_equal 3, @event.days
+    end
+    
+    should 'return the number of days it spans with a starting week offset' do
+      assert_equal 2, @event.days(@event.start_date + 1.day)
+    end
+    
+    should 'return the number of days it spans with an ending week offset' do
+      assert_equal 2, @event.days(@event.start_date, @event.end_date - 1.day)
+    end
+    
+    should 'return the number of days it spans with a starting and ending week offset' do
+      assert_equal 1, @event.days(@event.start_date + 1.day, @event.end_date - 1.day)
+    end
+    
+    should 'evaluate missing attributes as symbols' do
+      assert_equal @event_title, @event.title_symbol
+    end
+    
+    should 'evaluate missing attributes as objects' do
+      assert_equal 'string', @event.title_string
+    end
+    
+    should 'evaluate missing attributes as procs and pass the raw event' do
+      assert_equal @event_title + '_proc', @event.title_proc
+    end
+    
+    should 'delegate all other missing attributes to the raw event' do
+      assert_equal @raw_event.id, @event.id
+    end
+  end
+  
+end