farski-calendar_for 0.0.2

data/README.rdoc

@@ -0,0 +1,94 @@
+= CalendarFor
+
+The calendar_for helper method generates standard calendars, in the form of HTML tables. Each day of the calendars being 
+output is a TD element; the content template for each cell is the block being passed to the helper; partials are the 
+easiest to deal with. Each yielded template is given access to a Time object for midnight on the day it's rendering.
+
+All cells are created with a valid Time object. i.e. if you're making a calendar for Oct. 2008, the first day is a 
+Wednesday. Any cells that come before that in the table (e.g. Sunday, Monday, Tuesday) will use the end of September to 
+render the template. If you need those cells to be empty, they are classed in the HTML and you should just knock them 
+out with styles.
+
+Usage
+===========
+
+The most basic implementation of the helper makes a calendar for all of the current month.
+
+  <%= calendar_for { |day| content_tag(:h3, day.mday } %>
+  
+This will generate a table with its first row being a TR element for each weekday's full name (e.g. Sunday, 
+Monday...Saturday), and then rows for each week of the month, where each cell contains an H3 element with the day of the 
+month (1,2...31).
+
+Options
+===========
+
+The first argument is the date to be considered. It can be a Time or Date, a Chronic-parsable string, or a hash ({ :year 
+=> 2009 [, :month => 1 [, :day => 15]] })
+
+Other options include:
+:week_start      is the day of the week the calendars should start on, default is Sunday.
+          accepts 0 – 6 (Sunday – Saturday), or a String or Symbol of the weekday name ("Sunday", :monday)
+:timeframe      is the scope of the calendars being produces. Default is :month
+          :day creates a single cell table for the supplied date
+          :week
+          :month
+          :quarter creates three tables for the months of the quarter the date is in (e.g if supplied date is Feb 2, 
+          shows Jan. Feb, Mar)
+          :year goes back to January of the year for the supplied date and shows all months
+          Integer starts with the month of the supplied date and shows the next i-1 months
+:weekday_headers  false suppressed the row of TRs containing the weekday names
+          Array (length = 7) replaces the default weekday names (always starts with Sunday)
+:html_classes    replaces the default html class names for special cells (today, days outside the month being shown that 
+appear on the calendar)
+          :today
+          :out_of_timeframe
+
+Examples
+===========
+
+  Example 1
+
+  <%= calendar_for(  { :year => 2010, :month => 5 }, 
+            :week_start => :monday, 
+            :timeframe => :quarter, 
+            :weekday_headers => ['S','M','T','W','T','F','S']
+            :html_classes => { :out_of_timeframe => 'blank' }
+          ) { |day| render :partial => 'day', :locals => { :day => day } } %>
+          
+  # _day.html.erb
+  
+  <%= content_tag(:h5, link_to(day.mday, { :controller => 'calendar', :action => 'show', :year => day.year, :month => 
+  day.month, :day => day.mday })
+
+
+  Example 2
+  
+  <%= calendar_for(Time.now, :weekday_start => :monday, :timeframe => :week) { render :partial => 'day', :locals => { 
+  :day => day } }
+  
+  # _day.html.erb
+  
+  <%= link_to(day.mday) %>
+  <ol><%= render :partial => 'event', :collection => @events.select { |e| e.starts_at.midnight == day.midnight } %></ol>
+
+    
+  # _event.html.erb
+  <%= content_tag(:li, event.summary) %>
+  
+Sample output
+===========
+  
+  # for <%= calendar_for({ :year => 2008, :month => 10 }, :week_start => :monday, :timeframe => :week) { |day| 
+  content_tag(:p, day.mday) } %>
+  
+  <table 
+  class="calendar"><tr><th>Monday</th><th>Tuesday</th><th>Wednesday</th><th>Thursday</th><th>Friday</th><th>Saturday</th
+  ><th>Sunday</th></tr><tr><td class="null"><p>29</p></td><td 
+  class="today"><p>30</p></td><td><p>1</p></td><td><p>2</p></td><td><p>3</p></td><td><p>4</p></td><td><p>5</p></td></tr>
+  </table>
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 Chris Kalafarski. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 2
+:major: 0

data/lib/calendar_for.rb

@@ -0,0 +1,104 @@
+module CalendarHelper
+  # Creates a calendar table for a given date within a specified timeframe.
+  # Generic usage:
+  # <%= calendar_for { |day| render :partial => 'day', :locals => { :day => day } } %>
+  # This will default to the current time in a month timeframe.
+  # The date can be specified as a Date or Time object, as a string to be parsed by Chronic, or a hash like { :year => 2001, :month => 6 }
+  # Options:
+  # :week_start, the first day of the week, as an integer (0=Sunday, 6=Saturday), string ("Friday"), or symbol (:monday); default is Sunday.
+  # :timeframe, default is :month. others are, :year (starting with january), :quarter, :week, Integer (e.g. 12 would be specified month and the next 11)
+  # :html_classes, a hash to set custom class attributes for special TD tags, :today when the current day is displayed (default "today"), 
+  #                 and :out_of_timeframe, eg when June 1 is a Friday and the week_start is Monday, the first four days shown are out_of_timeframe.
+  #                 The class of tables (calendars) can be set with :calendar
+  # :weekday_headers, to suppress a row of <th>Monday</th>... set to false, to replace standard "Monday", "Tuesday", supply an array
+  # Complex use:
+  # calendar_for({ :year => 1962 }, :week_start => :monday, :timeframe => 24, :html_classes => { :today => 'current' }, :weekday_headers => false) { |day| content_tag(:h1, day.day) }
+  def calendar_for(date_or_time_object_or_parameters = Time.now, *args, &block)
+    raise ArgumentError, "Missing block" unless block_given?
+
+    options = args.extract_options!
+    
+    options[:html_classes] ||= Hash.new
+    options[:html_classes][:calendar] ||= "calendar"
+    options[:html_classes][:today] ||= "today"
+    options[:html_classes][:out_of_timeframe] ||= "null"
+    
+    weekdays = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
+    options[:week_start] ||= 0
+    case options[:week_start]
+    when Integer
+      week_start = options[:week_start]
+    when String, Symbol
+      week_start = weekdays.index(options[:week_start].to_s.capitalize)
+    end    
+    unless options[:weekday_headers] == false
+      weekdays = options[:weekday_headers] if (options[:weekday_headers].is_a?(Array) && options[:weekday_headers].size == 7 )
+      table_headers = Array.new
+      week_start.times { weekdays << weekdays.shift }
+      weekdays.each { |w| table_headers << content_tag(:th, w) }
+      table_headers_row = content_tag(:tr, table_headers.join)
+    end 
+        
+    case date_or_time_object_or_parameters
+    when Date, Time
+      timeframe_starts_on = date_or_time_object_or_parameters
+    when String
+      timeframe_starts_on = Chronic.parse(date_or_time_object_or_parameters)
+    when Hash
+      date_params = date_or_time_object_or_parameters
+      timeframe_starts_on = Time.local(date_params[:year], date_params[:month], date_params[:day])
+    end    
+  
+    case options[:timeframe]
+    when :day
+      months, weeks, days = 1, 1, 1
+      calendar_starts_on = timeframe_starts_on.midnight
+    when :week
+      calendar_starts_on = timeframe_starts_on.midnight.monday.advance(:days => (week_start-1))
+      months, weeks = 1, 1
+    when :quarter
+      months = 4
+      calendar_starts_on = timeframe_starts_on.midnight.beginning_of_quarter.monday.advance(:days => (week_start-1))
+      timeframe_starts_on = timeframe_starts_on.beginning_of_quarter
+    when :year
+      months = 12
+      calendar_starts_on = timeframe_starts_on.midnight.beginning_of_year.monday.advance(:days => (week_start-1))
+      timeframe_starts_on = timeframe_starts_on.beginning_of_year
+    when Integer
+      months = options[:timeframe]
+      calendar_starts_on = timeframe_starts_on.midnight.beginning_of_month.monday.advance(:days => (week_start-1))
+    else
+      months = 1
+      calendar_starts_on = timeframe_starts_on.midnight.beginning_of_month.monday.advance(:days => (week_start-1))
+    end
+    
+    tables = Array.new
+    months.times do |m|
+      table_rows = Array.new
+      table_rows << table_headers_row if table_headers_row
+      weeks ||= ((timeframe_starts_on.end_of_month - calendar_starts_on)/(7.days)).ceil
+      weeks.times do |w|
+        table_cells = Array.new
+        (days || 7).times do |d|
+          current_date = calendar_starts_on.advance(:days => (w*7+d))
+          if current_date.midnight == Time.now.midnight
+            html_class = options[:html_classes][:today]
+          elsif current_date.month != timeframe_starts_on.month
+            html_class = options[:html_classes][:out_of_timeframe]
+          end
+          table_cells << content_tag(:td, yield(current_date), :class => html_class)
+        end
+        table_rows << content_tag(:tr, table_cells.join)
+      end
+      weeks = nil
+      html_rel = timeframe_starts_on.strftime('%Y%m%d')
+      timeframe_starts_on = timeframe_starts_on.advance(:months => 1)
+      calendar_starts_on = timeframe_starts_on.midnight.beginning_of_month.monday.advance(:days => (week_start-1))
+      tables << content_tag(:table, table_rows.join, :class => options[:html_classes][:calendar], :rel => html_rel)
+    end
+    
+    return tables  
+  end
+end
+
+ActionView::Base.send :include, CalendarHelper

data/test/helper_test.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class CalendarForTest < Test::Unit::TestCase
+  # no clue how to test this...
+
+  # should "probably rename this file and start testing for real" do
+  #   flunk "hey buddy, you should probably rename this file and start testing for real"
+  # end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+require 'calendar_for'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: farski-calendar_for
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Chris Kalafarski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-17 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: chris@farski.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/calendar_for.rb
+- test/helper_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/farski/calendar_for
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+