kalenteri 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Antti Koskinen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,61 @@
+= kalenteri
+
+== Description
+
+A gem for building calendars. Designed to be framework-agnostic.
+
+At the moment this library is mostly for html generation. However, it should
+be easy to extend the Calendar class for other purposes.
+
+
+== Install
+
+Add Github as gem source (unless you already have it)
+$ gem sources -a http://gems.github.com
+
+$ sudo gem install ajk-kalenteri
+
+
+== Synopsis
+
+  require 'kalenteri'
+
+  # creates a new calendar object with monday as first weekday.
+  cal = Kalenteri::HTMLCalendar(Kalenteri::MONDAY)
+
+  # A HTML table for single month...
+  basic_month = cal.format_month(2009, 10)
+  # ...and for the whole year.
+  basic_year = cal.format_year(2009)
+
+  # You can use a block with the format method.
+  # A Date object will be passed for each day.
+  # The block should return a string which will be
+  # used inside the table cells.
+  detailed_month = cal.format_month(2009, 10) do |day|
+    my_day_details(day)
+  end
+
+
+== Support
+
+Bugs? Problems? Questions?
+
+4ntti.koskinen@gmail.com
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+== Copyright
+
+Copyright (c) 2009 Antti Koskinen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "kalenteri"
+    gem.summary = %Q{General purpose library for building calendars}
+    #gem.description = %Q{}
+    gem.email = "4ntti.koskinen@gmail.com"
+    gem.homepage = "http://github.com/ajk/kalenteri"
+    gem.authors = ["Antti Koskinen"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "kalenteri #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/kalenteri.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kalenteri}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Antti Koskinen"]
+  s.date = %q{2009-10-04}
+  s.email = %q{4ntti.koskinen@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "kalenteri.gemspec",
+     "lib/kalenteri.rb",
+     "lib/kalenteri/calendar.rb",
+     "lib/kalenteri/html_calendar.rb",
+     "test/calendar_test.rb",
+     "test/html_calendar_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/ajk/kalenteri}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{General purpose library for building calendars}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/calendar_test.rb",
+     "test/html_calendar_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/lib/kalenteri.rb

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+require 'kalenteri/calendar'
+require 'kalenteri/html_calendar'
+
+module Kalenteri
+
+  VERSION = "0.1.1"
+
+  SUNDAY    = 0
+  MONDAY    = 1
+  TUESDAY   = 2
+  WEDNESDAY = 3
+  THURSDAY  = 4
+  FRIDAY    = 5
+  SATURDAY  = 6
+
+end
+

data/lib/kalenteri/calendar.rb

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+require 'date'
+
+module Kalenteri
+  class Calendar
+
+    attr_reader :first_weekday
+    attr_accessor :day_name, :day_abbr, :month_name, :month_abbr
+
+    def initialize(day=Kalenteri::SUNDAY)
+      # @firstweekday is an integer specifying the first day of the week.
+      # Sunday is day-of-week 0; Saturday is day-of-week 6.
+      if (0..6).include?(day)
+        @first_weekday = day
+      else
+        raise ArgumentError, "Day must be an integer between 0 and 6."
+      end
+      @day_name   = Date::DAYNAMES.dup
+      @day_abbr   = Date::ABBR_DAYNAMES.dup
+      @month_name = Date::MONTHNAMES.dup
+      @month_abbr = Date::ABBR_MONTHNAMES.dup
+    end
+
+    # Day numbers in one week.
+    # The first value will be the @firstweekday.
+    def weekdays
+      [0,1,2,3,4,5,6,0,1,2,3,4,5][@first_weekday, 7].each { |x|
+        yield(x) if block_given?
+      }
+    end
+
+    # An iterator for all days in the month specified as Date objects.
+    # First and last days yielded are possibly in previous or next months,
+    # so that full weeks are generated.
+    def iter_month_dates(year, month)
+      firstd = Date.new(year, month, 1)
+      lastd = Date.new(year, month, -1)
+      first_in_monthcal(firstd).upto(last_in_monthcal(lastd)) do |d|
+        yield(d)
+      end
+    end
+
+    # First weekday (as Date object) of the first week of the month
+    # as specified by @firstweekday
+    def first_in_monthcal(first_day)
+      while first_day.wday != @first_weekday
+        first_day -= 1
+      end
+      return first_day
+    end
+
+    # Last weekday (as Date object) of the last week of the month
+    # as specified by @firstweekday.
+    def last_in_monthcal(last_day)
+      last_weekday = weekdays().last
+      while last_day.wday != last_weekday
+        last_day += 1
+      end
+      return last_day
+    end
+
+    # Return a array of the weeks in the month of the year as full weeks.
+    # Weeks are arrays of seven Date objects.
+    def month_calendar(year, month)
+      dates = []
+      iter_month_dates(year, month) do |day|
+        dates << day
+      end
+      return split_to_weeks(dates)
+    end
+
+    def split_to_weeks(dates, weeks=[])
+      if dates.size % 7 != 0 # DEBUG
+        raise 'Calendar month is not divisible to weeks!'
+      end
+      return weeks if dates.empty?
+      weeks << dates[0...7]
+      return split_to_weeks(dates[7..-1], weeks)
+    end
+
+    def year_rows
+      [1,4,7,10].each do |first|
+        yield(first, first+1, first+2)
+      end
+    end
+  end
+end
+

data/lib/kalenteri/html_calendar.rb

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+# Creates caledars as HTML tables.
+module Kalenteri
+  class HTMLCalendar < Calendar
+
+    attr_accessor :day_classes, :month_header, :year_header
+
+    def initialize(weekday=Kalenteri::SUNDAY)
+      super(weekday)
+      @day_classes= %w[sun mon tue wed thu fri sat]
+      if defined?(I18n)
+        rails_i18n!
+      end
+      @today = Time.respond_to?(:zone) && Time.zone ? Time.zone.now.to_date : Date.today
+    end
+
+    def rails_i18n!
+      @day_name = begin
+                    I18n.t("date.day_names", :raise => true).dup
+                  rescue I18n::MissingTranslationData
+                    Date::DAYNAMES.dup
+                  end
+      @day_abbr = begin
+                    I18n.t("date.abbr_day_names", :raise => true).dup
+                  rescue I18n::MissingTranslationData
+                    Date::ABBR_DAYNAMES.dup
+                  end
+      @month_name = begin
+                      I18n.t("date.month_names", :raise => true).dup
+                    rescue I18n::MissingTranslationData
+                      Date::MONTHNAMES.dup
+                    end
+      @month_abbr = begin
+                      I18n.t("date.abbr_month_names", :raise => true).dup
+                    rescue I18n::MissingTranslationData
+                      Date::ABBR_MONTHNAMES.dup
+                    end
+    end
+
+    # Returns a calendar for the given year as nested HTML tables,
+    # three months per row.
+    def format_year(year=@today.year, &block)
+      @year_header ||= lambda { |year|
+        %(<tr><th colspan="3" class="year">#{year}</th></tr>)
+      }
+      # use simple month name formatter
+      @month_header ||= lambda { |year, month|
+        %(<tr><th colspan="7" class="month">#{@month_name[month]}</th></tr>\n)
+      }
+      cal = %(<table border="0" cellpadding="0" cellspacing="0" class="year">\n)
+      cal << @year_header[year]
+      self.year_rows do |c1, c2, c3|
+        cal << "<tr>"
+        cal << %(<td class="month" valign="top">#{format_month(year, c1, &block)}</td>)
+        cal << %(<td class="month" valign="top">#{format_month(year, c2, &block)}</td>)
+        cal << %(<td class="month" valign="top">#{format_month(year, c3, &block)}</td>)
+        cal << "</tr>"
+      end
+      cal << "</table>"
+      return cal
+    end
+
+    # Returns a month's calendar as an HTML table.
+    def format_month(year=@today.year, month=@today.month, &block)
+      @year = year
+      @month = month
+      if block.nil?
+        block = lambda {|d| d.month == @month ? d.mday : '&nbsp;'}
+      end
+
+      # How month name header should be presented. You can replace this with your own
+      # for e.g. next and previous month links.
+      @month_header ||= lambda { |year, month|
+        %(<tr><th colspan="7" class="month">#{@month_name[month]} #{year}</th></tr>\n)
+      }
+
+      cal = %(<table border="0" cellpadding="0" cellspacing="0" class="month">\n)
+      cal << @month_header[@year, @month]
+      cal << format_week_header()
+      self.month_calendar(@year, @month).each do |days|
+        cal << format_week(days, block)
+      end
+      cal << "</table>"
+      return cal
+    end
+
+    def format_week_header
+      wh = "<tr>\n"
+      self.weekdays() do |d|
+        wh << %(<th scope="col" class="#{@day_classes[d]}">#{@day_abbr[d]}</th>\n)
+      end
+      wh << "</tr>\n"
+      return wh
+    end
+
+    def format_week(the_week, block)
+      wr = "<tr>\n"
+      the_week.each do |day|
+        klass = @day_classes[day.wday]
+        klass += ' today' if day.to_s == @today.to_s
+        klass += ' noday' if day.month != @month
+        wr << %(<td class="#{klass}">#{block.call(day)}</td>\n)
+      end
+      wr << "</tr>\n"
+      return wr
+    end
+
+  end
+end
+

data/test/calendar_test.rb

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+require 'test_helper'
+
+class CalendarTest < Test::Unit::TestCase
+  include Kalenteri
+
+  context "Weekday list" do
+    should "have length of seven" do
+      (SUNDAY..SATURDAY).each do |day|
+        cal = Calendar.new(day)
+        assert_equal 7, cal.weekdays.size
+      end
+    end
+
+    should "have proper elements" do
+      cal = Calendar.new(SUNDAY)
+      assert_equal SUNDAY, cal.weekdays.first
+      assert_equal SATURDAY, cal.weekdays.last
+
+      cal = Calendar.new(MONDAY)
+      assert_equal MONDAY, cal.weekdays.first
+      assert_equal SUNDAY, cal.weekdays.last
+    end
+  end
+
+  context "In September 2009" do
+
+    context "first day of calendar page" do
+      setup do
+        @day = Date.parse("2009-09-1")
+        @cal = Calendar.new()
+        @first = @cal.first_in_monthcal(@day)
+      end
+
+      should "not be first day of month" do
+        assert_equal TUESDAY, @day.wday
+        assert_not_equal @day, @first
+      end
+
+      should "be in previous month" do
+        assert_equal @first.mon, @day.mon - 1
+      end
+
+      should "be sunday" do
+        assert_equal SUNDAY, @first.wday
+        assert_equal @cal.first_weekday, @first.wday
+      end
+    end
+
+    context "last day of calendar page" do
+      setup do
+        @day = Date.parse("2009-09-30")
+        @cal = Calendar.new(SUNDAY)
+        @last = @cal.last_in_monthcal(@day)
+      end
+
+      should "not be last day of month" do
+        assert_equal WEDNESDAY, @day.wday
+        assert_not_equal @day, @last
+      end
+
+      should "be in next month" do
+        assert_equal @last.mon, @day.mon + 1
+      end
+
+      should "be saturday" do
+        assert_equal SATURDAY, @last.wday
+        assert_equal @cal.weekdays.last, @last.wday
+      end
+    end
+
+    context "month array" do
+      setup do
+        cal = Calendar.new(SUNDAY)
+        @month = cal.month_calendar(2009, 9)
+      end
+
+      should "have five weeks" do
+        assert_equal 5, @month.size
+      end
+
+      should "have seven days in each week" do
+        @month.each do |week|
+          assert_equal 7, week.size
+          week.each {|day| assert_kind_of(Date, day) }
+        end
+      end
+    end
+
+  end
+end

data/test/html_calendar_test.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+require 'test_helper'
+require 'nokogiri'
+require 'open-uri'
+
+class HTMLCalendarTest < Test::Unit::TestCase
+  include Kalenteri
+
+  context "Html output for August 2009" do
+    setup do
+      @cal = HTMLCalendar.new(Kalenteri::SUNDAY)
+      @cal.month_header = lambda {|year, month|
+        %(<tr><th>prev</th><th colspan="5" class="month">My #{@cal.month_name[month]} #{year}</th><th>next</th></tr>\n)
+      }
+      table = @cal.format_month(2009, 8) do |day|
+        if day.month != 8
+          "not August"
+        else
+          day.mday
+        end
+      end
+      @xhtml = <<-EOF
+        <!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">
+        <head><title></title></head>
+        <body>#{table}</body>
+        </html>
+      EOF
+      @doc = Nokogiri::HTML(@xhtml)
+    end
+
+    should "be a table" do
+      assert_equal "html > body > table", @doc.css('body').children.first.css_path
+    end
+
+    should "be valid xhtml document" do
+      xsd = Nokogiri::XML::Schema(open('http://www.w3.org/2002/08/xhtml/xhtml1-strict.xsd'))
+      assert_equal [], xsd.validate(Nokogiri::XML(@xhtml)) # This gives a list of errors unless valid
+    end
+
+    should "use overridden month header" do
+      header = @doc.css('th.month').first
+      assert_equal 5, header[:colspan].to_i
+      assert_equal "My August 2009", header.inner_html
+    end
+
+    should "have a css class for each day of week" do
+      classes = @doc.css('td').remove_class('noday').map {|td| td[:class]}.uniq
+      assert_equal @cal.day_classes, classes
+      assert_equal @cal.day_classes, %w[sun mon tue wed thu fri sat]
+    end
+
+    should "mark out-of-month days with 'noday'-class" do
+      oom = @doc.css('td.noday')
+      assert_equal 11, oom.size
+      assert oom.all? {|td| td.inner_html == "not August" }
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'kalenteri'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: kalenteri
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Antti Koskinen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-04 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: 4ntti.koskinen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- kalenteri.gemspec
+- lib/kalenteri.rb
+- lib/kalenteri/calendar.rb
+- lib/kalenteri/html_calendar.rb
+- test/calendar_test.rb
+- test/html_calendar_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ajk/kalenteri
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 2
+summary: General purpose library for building calendars
+test_files: 
+- test/test_helper.rb
+- test/calendar_test.rb
+- test/html_calendar_test.rb