.gitignore test/calendar_helper_test.rb @@ -1,3 +1,9 @@ +=== 0.2.3 / 2008-06-11 + +* Removed gem spec to be just a plugin because this is now a fork of original gem. +* Removed requirement for month and year. Defaults to current month and year. +* Added option for :month_name_text to override presentation of month name. + === 0.2.2 / 2007-08-29 * Fixed missing tr tag in thead section. [Ian Struble] History.txt @@ -14,6 +14,9 @@ Original implementation Geoffrey Grosenbach -- http://nubyonrails.com Test suite and conversion to a Rails plugin +Adam Meehan -- http://duckpunching.com +Forked plugin to put on GitHub and customize + Contributors ============ README.txt @@ -1,26 +1,17 @@ require 'rubygems' require 'rake' +require 'rake/testtask' 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'] -end - -# desc "Test task (actually runs specs)" -# task "test" do -# system "spec --format specdoc --color spec/*_spec.rb" -# end +desc 'Default: run unit tests.' +task :default => :test -# -- Rails-specific -- +desc 'Test the calendar_helper plugin.' +Rake::TestTask.new(:test) do |t| + t.libs << 'lib' + t.pattern = 'test/**/*_test.rb' + t.verbose = true +end desc 'Generate documentation for the calendar_helper plugin.' Rake::RDocTask.new(:rdoc) do |rdoc| Rakefile @@ -3,39 +3,38 @@ require 'date' # CalendarHelper allows you to draw a databound calendar with fine-grained CSS formatting module CalendarHelper - VERSION = '0.2.2' + VERSION = '0.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. + # calendar (which can then be customized using CSS). # However, this may be customized in a variety of ways -- changing the default CSS # classes, generating the individual day entries yourself, and so on. # - # The following options are required: - # :year # The year number to show the calendar for. - # :month # The month number to show the calendar for. - # # The following are optional, available for customizing the default behaviour: - # :table_class => "calendar" # The class for the <table> tag. - # :month_name_class => "monthName" # The class for the name of the month, at the top of the table. - # :other_month_class => "otherMonth" # Not implemented yet. - # :day_name_class => "dayName" # The class is for the names of the weekdays, at the top. - # :day_class => "day" # The class for the individual day number cells. + # :month => Time.now.month # The month to show the calendar for. Defaults to current month. + # :year => Time.now.year # The year to show the calendar for. Defaults to current year. + # :table_class => "calendar" # The class for the <table> tag. + # :month_name_class => "monthName" # The class for the name of the month, at the top of the table. + # :other_month_class => "otherMonth" # Not implemented yet. + # :day_name_class => "dayName" # The class is for the names of the weekdays, at the top. + # :day_class => "day" # The class for the individual day number cells. # This may or may not be used if you specify a block (see below). - # :abbrev => (0..2) # This option specifies how the day names should be abbreviated. + # :abbrev => (0..2) # This option specifies how the day names should be abbreviated. # 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 + # :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'. + # :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_name_text => nil # Displayed center in header row. Defaults to current month name from Date::MONTHNAMES hash. + # :previous_month_text => nil # Displayed left of the month name if set + # :next_month_text => nil # Displayed right of the month name if set # # 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], @@ -45,14 +44,15 @@ module CalendarHelper # +:day_class+. If the block returns nil, the default options are used. # # Example usage: - # calendar(:year => 2005, :month => 6) # This generates the simplest possible calendar. - # calendar({:year => 2005, :month => 6, :table_class => "calendar_helper"}) # This generates a calendar, as + # calendar # This generates the simplest possible calendar with the curent month and year. + # calendar({:year => 2005, :month => 6}) # This generates a calendar for June 2005. + # calendar({:table_class => "calendar_helper"}) # This generates a calendar, as # # before, but the <table>'s class # # is set to "calendar_helper". - # calendar(:year => 2005, :month => 6, :abbrev => (0..-1)) # This generates a simple calendar but shows the + # calendar(:abbrev => (0..-1)) # This generates a simple calendar but shows the # # entire day name ("Sunday", "Monday", etc.) instead # # of only the first three letters. - # calendar(:year => 2005, :month => 5) do |d| # This generates a simple calendar, but gives special days + # calendar 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 @@ -65,23 +65,23 @@ module CalendarHelper # For consistency with the themes provided in the calendar_styles generator, use "specialDay" as the CSS class for marked days. # def calendar(options = {}, &block) - raise(ArgumentError, "No year given") unless options.has_key?(:year) - raise(ArgumentError, "No month given") unless options.has_key?(:month) - - block ||= Proc.new {|d| nil} + block ||= Proc.new {|d| nil} defaults = { - :table_class => 'calendar', - :month_name_class => 'monthName', - :other_month_class => 'otherMonth', - :day_name_class => 'dayName', - :day_class => 'day', - :abbrev => (0..2), - :first_day_of_week => 0, - :accessible => false, - :show_today => true, + :year => Time.now.year, + :month => Time.now.month, + :table_class => 'calendar', + :month_name_class => 'monthName', + :other_month_class => 'otherMonth', + :day_name_class => 'dayName', + :day_class => 'day', + :abbrev => (0..2), + :first_day_of_week => 0, + :accessible => false, + :show_today => true, + :month_name_text => Date::MONTHNAMES[Time.now.month], :previous_month_text => nil, - :next_month_text => nil + :next_month_text => nil } options = defaults.merge options @@ -105,7 +105,7 @@ module CalendarHelper else colspan=7 end - cal << %(<th colspan="#{colspan}" class="#{options[:month_name_class]}">#{Date::MONTHNAMES[options[:month]]}</th>) + cal << %(<th colspan="#{colspan}" class="#{options[:month_name_class]}">#{options[:month_name_text]}</th>) cal << %(<th colspan="2">#{options[:next_month_text]}</th>) if options[:next_month_text] cal << %(</tr><tr class="#{options[:day_name_class]}">) day_names.each do |d| lib/calendar_helper.rb Manifest.txt about.yml test/test_calendar_helper.rb 95d48a253a77f30b203c7416358a027d820b1c01 Adam Meehan adam.meehan@gmail.com http://github.com/adzap/calendar_helper/commit/d934d4924fd46697dac228a5cbaba28d3d268f1f d934d4924fd46697dac228a5cbaba28d3d268f1f 2008-06-10T22:30:53-07:00 2008-06-10T22:30:53-07:00 first commit post fork removed gem spec to make just regular plugin removed requirement for :month and :year option values, which now default to current month and year added :month_name_text option to override month name presentation added myself to authors list to clarify plugin direction changed to version 0.3 6a33396537a7bee944060ea5cadb3bbc417faefa Adam Meehan adam.meehan@gmail.com