calendar_helper 0.2.2 → 0.2.3

data/History.txt

@@ -1,3 +1,10 @@
+=== 2.2.3 / 2010-05-21
+
+* Don't crash if time zone is nil
+* Upgrade to latest Hoe
+* Added support to remove the month row on the table
+* Fixed bug where passed ID for day cell would throw error on missing class name.
+
 === 0.2.2 / 2007-08-29
 
 * Fixed missing tr tag in thead section. [Ian Struble]

data/README.txt

@@ -1,27 +1,61 @@
-CalendarHelper
-==============
+= CalendarHelper
 
-A simple helper for creating an HTML calendar. The "calendar" method will be automatically available to your view templates.
+== DESCRIPTION:
+
+A simple helper for creating an HTML calendar. The "calendar" method will be automatically available to your Rails view templates, or can be used with Sinatra or other webapps.
 
 There is also a Rails generator that copies some stylesheets for use alone or alongside existing stylesheets.
 
-Authors
-=======
+== SYNOPSIS:
+
+  # Simple
+  calendar(:year => 2005, :month => 6)
+  
+  # Set table class
+  calendar({:year => 2005, :month => 6, :table_class => "calendar_helper"})
+  
+  # Full featured
+  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
+
+If using with ERb (Rails), put in a printing tag.
+
+  <%= calendar(:year => @year, :month => @month, :first_day_of_week => 1) do |d|
+        render_calendar_cell(d)
+      end
+  %>
+
+With Haml, use a helper to set options for each cell.
+
+  = calendar(:year => @year, :month => @month, :first_day_of_week => 1) do |d|
+    - render_calendar_cell(d)
+
+In Sinatra, include the CalendarHelper module in your helpers:
+
+  helpers do
+    include CalendarHelper
+  end
+
+== AUTHORS:
 
 Jeremy Voorhis -- http://jvoorhis.com
 Original implementation
 
-Jarkko Laine -- http://jlaine.net/
-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.
+== Contributors:
+
+* Jarkko Laine http://jlaine.net/
+* Tom Armitage http://infovore.org
+* Bryan Larsen http://larsen.st
 
-Usage
-=====
+== USAGE:
 
 See the RDoc (or use "rake rdoc").
 

data/Rakefile

@@ -4,17 +4,24 @@ require 'rake/rdoctask'
 require 'hoe'
 require './lib/calendar_helper.rb'
 
-Hoe.new('calendar_helper', CalendarHelper::VERSION) do |p|
-  p.rubyforge_name = 'seattlerb'
-  p.author = 'Geoffrey Grosenbach'
-  p.email = 'boss AT topfunky.com'
-  p.summary = 'Generates a configurable, CSS-tagged HTML calendar.'
-  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']
+Hoe.spec 'calendar_helper' do
+  developer('Geoffrey Grosenbach', 'boss@topfunky.com')
+  
+  extra_deps << ['open4']
+  
+  # self.rubyforge_name = 'osxscreenshotx' # if different than 'osxscreenshot'
 end
 
+
+# Hoe.new('calendar_helper', CalendarHelper::VERSION) do |p|
+#   p.rubyforge_name = 'seattlerb'
+#   p.summary = 'Generates a configurable, CSS-tagged HTML calendar.'
+#   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)"
 # task "test" do
 #   system "spec --format specdoc --color spec/*_spec.rb"
@@ -27,6 +34,6 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'CalendarHelper'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('README.txt')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

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

@@ -18,6 +18,10 @@
   text-align: center;
 }
 
+thead tr {
+  color: black;
+}
+
 .monthName th {
   font-weight: normal;
   text-align: right;

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.2'
+  VERSION = '0.2.3'
 
   # 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.
@@ -34,6 +34,9 @@ module CalendarHelper
   #
   #   :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_header      => false             # If you use false, the current month header will disappear.
   #
   # 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],
@@ -77,7 +80,10 @@ module CalendarHelper
       :abbrev => (0..2),
       :first_day_of_week => 0,
       :accessible => false,
-      :show_today => true
+      :show_today => true,
+      :previous_month_text => nil,
+      :next_month_text => nil,
+      :month_header => true
     }
     options = defaults.merge options
 
@@ -92,8 +98,25 @@ module CalendarHelper
       day_names.push(day_names.shift)
     end
 
-    cal = %(<table class="#{options[:table_class]}" border="0" cellspacing="0" cellpadding="0">) 
-    cal << %(<caption class="#{options[:month_name_class]}"></caption><thead><tr><th colspan="7">#{Date::MONTHNAMES[options[:month]]}</th></tr><tr class="#{options[:day_name_class]}">)
+    # TODO Use some kind of builder instead of straight HTML
+    cal = %(<table class="#{options[:table_class]}" border="0" cellspacing="0" cellpadding="0">)
+    cal << %(<thead>)
+    
+    if (options[:month_header])
+      cal << %(<tr>)
+      if options[:previous_month_text] or options[:next_month_text]
+        cal << %(<th colspan="2">#{options[:previous_month_text]}</th>)
+        colspan=3
+      else
+        colspan=7
+      end
+      cal << %(<th colspan="#{colspan}" class="#{options[:month_name_class]}">#{Date::MONTHNAMES[options[:month]]}</th>)
+      cal << %(<th colspan="2">#{options[:next_month_text]}</th>) if options[:next_month_text]
+      cal << %(</tr>)
+    end
+    
+    cal << %(<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>"
@@ -114,9 +137,11 @@ module CalendarHelper
     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[:class] ||= options[:day_class]
+      cell_attrs[:class] += " weekendDay" if [0, 6].include?(cur.wday)
+      today = (Time.respond_to?(:zone) && !(zone = Time.zone).nil? ? zone.now.to_date : Date.today)
+      cell_attrs[:class] += " today" if (cur == 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

data/test/test_calendar_helper.rb

@@ -14,11 +14,13 @@ class CalendarHelperTest < Test::Unit::TestCase
   # include Inflector
   # include ActionController::Assertions::SelectorAssertions
   include CalendarHelper
-  
+
 
   def test_with_output
-    output = "<h2>Past Month</h2>" + calendar_with_defaults
-    output << "<h2>Current Month</h2>" + calendar_for_this_month
+    output = []
+    %w(calendar_with_defaults calendar_for_this_month calendar_with_next_and_previous).each do |methodname|
+      output << "<h2>#{methodname}</h2>\n" +  send(methodname.to_sym) + "\n\n"
+    end
     write_sample "sample.html", output
   end
 
@@ -118,6 +120,13 @@ class CalendarHelperTest < Test::Unit::TestCase
     calendar options
   end
 
+  def calendar_with_next_and_previous
+    calendar_for_this_month({
+      :previous_month_text => "PREVIOUS",
+      :next_month_text => "NEXT"
+    })
+  end
+
   def write_sample(filename, content)
     FileUtils.mkdir_p "test/output"
     File.open("test/output/#{filename}", 'w') do |f|

metadata

@@ -1,33 +1,71 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: calendar_helper
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
-date: 2007-08-29 00:00:00 -07:00
-summary: Generates a configurable, CSS-tagged HTML calendar.
-require_paths: 
-- lib
-email: boss AT topfunky.com
-homepage: http://rubyforge.org/projects/seattlerb
-rubyforge_project: seattlerb
-description: A simple method to create an HTML calendar for a single month. Can be styled with CSS. Usable with Ruby on Rails.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.2.3
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Geoffrey Grosenbach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+    version: 
+description: |-
+  A simple helper for creating an HTML calendar. The "calendar" method will be automatically available to your Rails view templates, or can be used with Sinatra or other webapps.
+  
+  There is also a Rails generator that copies some stylesheets for use alone or alongside existing stylesheets.
+email: 
+- boss@topfunky.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
 files: 
 - History.txt
 - MIT-LICENSE
@@ -41,28 +79,34 @@ files:
 - init.rb
 - lib/calendar_helper.rb
 - test/test_calendar_helper.rb
-test_files: 
-- test/test_calendar_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
-executables: []
-
-extensions: []
-
+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: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.3.0
-    version: 
+rubyforge_project: calendar_helper
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple helper for creating an HTML calendar
+test_files: 
+- test/test_calendar_helper.rb