calendar_helper 0.2.0 → 0.2.1

data/History.txt

@@ -1,3 +1,14 @@
+=== 0.2.1 / 2007-07-07
+
+* Added html output to the tests for visual confirmation or
+  for developing new stylesheets. Run 'rake' and look
+  in the 'test/output' directory.
+* Adds a 'today' CSS class to the cell for the current day.
+  Can be turned of by sending option 'show_today => false'.
+  [Chris O'Sullivan]
+* Added 'accessible' option to show extra fields around 
+  days that are not in the current month. [Tom Armitage]
+
 === 0.2.0
 
 * Converted to hoe and a rubygem

data/Manifest.txt

@@ -9,5 +9,4 @@ generators/calendar_styles/templates/grey/style.css
 generators/calendar_styles/templates/red/style.css
 init.rb
 lib/calendar_helper.rb
-test/stylesheet_tester.html
 test/test_calendar_helper.rb

data/README.txt

@@ -17,6 +17,9 @@ Dynamic enhancements for starting week on Monday and highlighting weekends
 Geoffrey Grosenbach -- http://nubyonrails.com
 Test suite and conversion to a Rails plugin
 
+Tom Armitage -- http://infovore.org
+Improvements to markup (abbreviations on day-headings, <caption>); introduction of :accessible option.
+
 Usage
 =====
 

data/Rakefile

@@ -12,6 +12,7 @@ Hoe.new('calendar_helper', CalendarHelper::VERSION) do |p|
   p.description = "A simple method to create an HTML calendar for a single month. Can be styled with CSS. Usable with Ruby on Rails."
   p.url = "http://rubyforge.org/projects/seattlerb"
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.clean_globs = ['test/output']
 end
 
 # desc "Test task (actually runs specs)"

data/generators/calendar_styles/templates/blue/style.css

@@ -61,3 +61,6 @@
 .weekendDay {
   background-color: #ffffdd;
 }
+.today{
+	background-color: #4682b4;
+}

data/generators/calendar_styles/templates/grey/style.css

@@ -65,6 +65,10 @@
 .weekendDay {
   background-color: #787888;
 }
+.today {
+	background-color: white;
+	color: black;
+}
 
 Colors: 
   dk: 787888

data/generators/calendar_styles/templates/red/style.css

@@ -54,3 +54,7 @@
   color: white;
   background-color: black;
 }
+.today {
+	background-color: #1e90ff;
+	color: white;
+}

data/lib/calendar_helper.rb

@@ -3,7 +3,7 @@ require 'date'
 # CalendarHelper allows you to draw a databound calendar with fine-grained CSS formatting
 module CalendarHelper
 
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 
   # 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.
@@ -25,7 +25,16 @@ module CalendarHelper
   #                                             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.
+  #
   # 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
@@ -66,7 +75,9 @@ module CalendarHelper
       :day_name_class => 'dayName',
       :day_class => 'day',
       :abbrev => (0..2),
-      :first_day_of_week => 0
+      :first_day_of_week => 0,
+      :accessible => false,
+      :show_today => true
     }
     options = defaults.merge options
 
@@ -82,19 +93,30 @@ module CalendarHelper
     end
 
     cal = %(<table class="#{options[:table_class]}" border="0" cellspacing="0" cellpadding="0">) 
-    cal << %(<thead><tr class="#{options[:month_name_class]}"><th colspan="7">#{Date::MONTHNAMES[options[:month]]}</th></tr><tr class="#{options[:day_name_class]}">)
-    day_names.each {|d| cal << "<th>#{d[options[:abbrev]]}</th>"}
+    cal << %(<caption class="#{options[:month_name_class]}"></caption><thead><th colspan="7">#{Date::MONTHNAMES[options[:month]]}</th></tr><tr class="#{options[:day_name_class]}">)
+    day_names.each do |d|
+      unless d[options[:abbrev]].eql? d
+        cal << "<th scope='col'><abbr title='#{d}'>#{d[options[:abbrev]]}</abbr></th>"
+      else
+        cal << "<th scope='col'>#{d[options[:abbrev]]}</th>"
+      end
+    end
     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>)
+      if options[:accessible]
+        cal << %(">#{d.day}<span class="hidden"> #{Date::MONTHNAMES[d.month]}</span></td>)
+      else
+        cal << %(">#{d.day}</td>)
+      end
     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[:class] += " today" if (cur == Date.today) and options[:show_today]  
       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
@@ -102,7 +124,11 @@ module CalendarHelper
     (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>)
+      if options[:accessible]
+        cal << %(">#{d.day}<span class='hidden'> #{Date::MONTHNAMES[d.mon]}</span></td>)
+      else
+        cal << %(">#{d.day}</td>)        
+      end
     end unless last.wday == last_weekday
     cal << "</tr></tbody></table>"
   end

data/test/test_calendar_helper.rb

@@ -1,16 +1,21 @@
 require 'test/unit'
+require 'fileutils'
 require File.expand_path(File.dirname(__FILE__) + "/../lib/calendar_helper")
 
 class CalendarHelperTest < Test::Unit::TestCase
 
   include CalendarHelper
-  
-  
+
+  def test_with_output
+    output = "<h2>Past Month</h2>" + calendar_with_defaults
+    output << "<h2>Current Month</h2>" + calendar_for_this_month
+    write_sample "sample.html", output
+  end
+
   def test_simple
     assert_match %r{August}, calendar_with_defaults
   end
 
-
   def test_required_fields
     # Year and month are required
     assert_raises(ArgumentError) {
@@ -21,20 +26,20 @@ class CalendarHelperTest < Test::Unit::TestCase
     }
     assert_raises(ArgumentError) {
       calendar :month => 1
-    }    
+    }
   end
 
   def test_default_css_classes
     # :other_month_class is not implemented yet
-    { :table_class => "calendar", 
-      :month_name_class => "monthName", 
-      :day_name_class => "dayName", 
-      :day_class => "day" }.each do |key, value|
+    { :table_class => "calendar",
+      :month_name_class => "monthName",
+      :day_name_class => "dayName",
+      :day_class => "day"
+    }.each do |key, value|
       assert_correct_css_class_for_default value
     end
   end
 
-
   def test_custom_css_classes
     # Uses the key name as the CSS class name
     # :other_month_class is not implemented yet
@@ -43,14 +48,12 @@ class CalendarHelperTest < Test::Unit::TestCase
     end
   end
 
-  
   def test_abbrev
     assert_match %r{>Mon<}, calendar_with_defaults(:abbrev => (0..2))
     assert_match %r{>M<}, calendar_with_defaults(:abbrev => (0..0))
     assert_match %r{>Monday<}, calendar_with_defaults(:abbrev => (0..-1))
   end
 
-
   def test_block
     # Even days are special
     assert_match %r{class="special_day">2<}, calendar(:year => 2006, :month => 8) { |d|
@@ -60,14 +63,24 @@ class CalendarHelperTest < Test::Unit::TestCase
     }
   end
 
-
   def test_first_day_of_week
-    assert_match %r{<tr class="dayName">\s*<th>Sun}, calendar_with_defaults
-    assert_match %r{<tr class="dayName">\s*<th>Mon}, calendar_with_defaults(:first_day_of_week => 1)
+    assert_match %r{<tr class="dayName">\s*<th scope='col'><abbr title='Sunday'>Sun}, calendar_with_defaults
+    # testing that if the abbrev and contracted version are the same, there should be no abbreviation.
+    assert_match %r{<tr class="dayName">\s*<th scope='col'>Sunday}, calendar_with_defaults(:abbrev => (0..8))
+    assert_match %r{<tr class="dayName">\s*<th scope='col'><abbr title='Monday'>Mon}, calendar_with_defaults(:first_day_of_week => 1)
   end
 
-private
+  def test_today_is_in_calendar
+    todays_day = Date.today.day
+    assert_match %r{class="day.+today">#{todays_day}<}, calendar_for_this_month
+  end
 
+  def test_should_not_show_today
+    todays_day = Date.today.day
+    assert_no_match %r{today}, calendar_for_this_month(:show_today => false)
+  end
+
+  private
 
   def assert_correct_css_class_for_key(css_class, key)
     assert_match %r{class="#{css_class}"}, calendar_with_defaults(key => css_class)
@@ -82,4 +95,18 @@ private
     calendar options
   end
 
+  def calendar_for_this_month(options={})
+    options = { :year => Time.now.year, :month => Time.now.month}.merge options
+    calendar options
+  end
+
+  def write_sample(filename, content)
+    FileUtils.mkdir_p "test/output"
+    File.open("test/output/#{filename}", 'w') do |f|
+      f.write %(<html><head><title>Stylesheet Tester</title><link href="../../generators/calendar_styles/templates/grey/style.css" media="screen" rel="Stylesheet" type="text/css" /></head><body>)
+      f.write content
+      f.write %(</body></html>)
+    end
+  end
+
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: calendar_helper
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2007-06-24 00:00:00 -07:00
+  version: 0.2.1
+date: 2007-07-07 00:00:00 -07:00
 summary: Generates a configurable, CSS-tagged HTML calendar.
 require_paths: 
 - lib
@@ -40,7 +40,6 @@ files:
 - generators/calendar_styles/templates/red/style.css
 - init.rb
 - lib/calendar_helper.rb
-- test/stylesheet_tester.html
 - test/test_calendar_helper.rb
 test_files: 
 - test/test_calendar_helper.rb

data/test/stylesheet_tester.html

@@ -1,32 +0,0 @@
-<html>
-<head>
-  <title>Stylesheet Tester</title>
-  <link href="../generators/calendar_styles/templates/grey/style.css" media="screen" rel="Stylesheet" type="text/css" />
-<style>
-body, tr, td {
-  font-family: Verdana;
-}
-</style>
-</head>
-<body style="background-color: #eeeeee">
-
-  <table class="calendar" border="0" cellspacing="0" cellpadding="0">
-	<thead>
-		<tr class="monthName">
-			<th colspan="7">April</th>
-		</tr>
-		<tr class="dayName">
-			<th>Mon</th>			<th>Tue</th>			<th>Wed</th>			<th>Thu</th>			<th>Fri</th>			<th>Sat</th>			<th>Sun</th>		</tr>
-	</thead>
-	<tbody>
-		<tr>			<td class="otherMonth">27</td>			<td class="otherMonth">28</td>			<td class="otherMonth">29</td>			<td class="otherMonth">30</td>			<td class="otherMonth">31</td>			<td class="day weekendDay">1</td>			<td class="day weekendDay">2</td>		</tr>
-		<tr>			<td class="day">3</td>			<td class="day">4</td>			<td class="day">5</td>			<td class="day">6</td>			<td class="day">7</td>			<td class="day weekendDay">8</td>			<td class="day weekendDay">9</td>		</tr>
-		<tr>			<td class="day">10</td>			<td class="day">11</td>			<td class="day">12</td>			<td class="day">13</td>			<td class="day">14</td>			<td class="day weekendDay">15</td>			<td class="day weekendDay">16</td>		</tr>
-		<tr>			<td class="day">17</td>			<td class="day">18</td>			<td class="day">19</td>			<td class="day">20</td>			<td class="day">21</td>			<td class="day weekendDay">22</td>			<td class="day weekendDay">23</td>		</tr>
-		<tr>			<td class="day">24</td>			<td class="day">25</td>			<td class="day">26</td>			<td class="specialDay">27</td>			<td class="day">28</td>			<td class="day weekendDay">29</td>			<td class="day weekendDay">30</td>		</tr>
-		<tr>		</tr>
-	</tbody>
-  </table>
-
-</body>
-</html>