school_days 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2011-01-21
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/school_days.rb
+lib/extensions/date.rb
+lib/extensions/fixnum.rb
+lib/school_days/calculator.rb
+lib/school_days/config.rb
+rails_generators/school_days_config/USAGE
+rails_generators/school_days_config/school_days_config_generator.rb
+rails_generators/school_days_config/templates/school_days.rb
+rails_generators/school_days_config/templates/school_days.yml
+script/console
+script/destroy
+script/generate
+test/fixtures/double_session_test.yml
+test/fixtures/invalid_config_test.yml
+test/fixtures/simple_test.yml
+test/test_config.rb
+test/test_date_extensions.rb
+test/test_fixnum_extensions.rb
+test/test_generator_helper.rb
+test/test_helper.rb
+test/test_school_days.rb
+test/test_school_days_config_generator.rb
+test/test_school_days_calculator.rb

data/PostInstall.txt

@@ -0,0 +1,2 @@
+
+For more information on school_days, see http://github.com/rwilcox/school_days

data/README.rdoc

@@ -0,0 +1,136 @@
+= school_days
+
+* http://github.com/rwilcox/school_days
+
+== DESCRIPTION:
+
+Like Business Time (https://github.com/bokmann/business_time), this gem has support for domain specific dates.
+
+Unlike Business Time, School Days focuses on the demands of keeping a school calendar
+
+
+== FEATURES:
+
+With School Days you can:
+
+  * 1.days.from_now.is_school_day
+  * Date.civil(2011, 05, 31).school_night?
+  * 2.school_days.from_now
+  
+In the school days configuration you can
+  * Set the start and end date of a school session (as in: when does school break for summer, then resume)
+  * Be able to set exceptional "in" days ("Normally, there is no school on Saturday, but we need to in this case")
+  * Be able to set exceptional "out" days (Weather days, for example)
+
+== PROBLEMS
+School Days only handles school day calculations. Unlike business time, which includes hour and minute level calculations, School Days deals only with days. This is a reasonable tradeoff, and does have some implementation advantages.
+
+For example, most school districts define a school day as being at least 4 hours of instructional time. If we supported sub-day calculations then the possibility of school being cancelled after 2 hours exists, and school days vs school hours getting unsynced is a possibility.
+
+Yes, I acknowledge that this might be a problem, as technically a school year is N hours long (not M days). Schools might gain an extra day, in time of prolonged emergency, by adding an extra few minutes onto their school day (for the last 10 weeks, for example).
+
+This gem focuses on the naive solution of managing this at the day level, and avoids this kind of accounting practice.
+
+Another potential problem is using the N.school_day.before/after syntax will not handle exceptionally included days that land outside the earliest start date  and latest end date defined in the school sessions section.
+
+If you really need to define an exceptional included day outside the school year please submit a patch... else just extend your start dates or end dates. Yes, I do consider this a major drawback, and may reconsider this feature in the future... right now I don't need it enough to hold up release of this gem.
+
+
+== SYNOPSIS:
+
+Yes, I know a lot about school calendars and how they operate. My mom is a school teacher (Hi Mom!!!), who taught in the same school us kids went to... so I learned a lot about school scheduling.
+
+I learned even more over the years when various disasters (snow storms, fires) happened and I watched the school calendar being adjusted in various ways.
+
+== REQUIREMENTS:
+
+This gem is meant to be used in a Rails (2) project. It will probably work in a Rails 3 environment, but this hasn't been tested yet (and I know the generator will not work)
+
+== INSTALL:
+
+gem install school_days
+
+in your Rails project, execute the generator to get a yaml file that gives you calendar configuration options
+
+script/generate school_days_config
+
+This will install an initializer and a yaml file (config/school_days.yml).
+
+
+== CONFIGURING SCHOOL DAYS:
+
+School days are a fickle beast. This gem has intelligent defaults, but I've also seen an amazing amount of variety in school calendars
+
+config/school_days.yml has one top level key (school_days) with the following subkeys:
+
+* school_sessions
+
+A school might have one session (think a school that runs from August until June, with a 3 month summer vacation). A school might also run on an increasingly popular 10 week session with 2 week vacation, running all year.
+
+The school sessions structure also allows this gem to be used by higher education (semester, trimester, and quarter system schools), in addition to primary/secondary education.
+
+Each subkey in the sessions section are named (arbitrary name), but each subkey must have a start_date and end_date.
+
+
+* exceptions
+
+By default, school_days assumes that every week day during a session is a school day. This is incorrect, and you can configure these exceptions here.
+
+This key has two subkeys:
+
+  * holidays
+  
+  This is a flat list of dates where there is no class
+  
+  * included_days
+  
+  I've seen schools have school days on a Saturday, in very rare circumstances. included_days list days where you would normally not have school (weekends)... but you do this year.
+  
+Days listed in any exceptions subkey have extreme override abilities - you could set your school year to end on June 1, 2011... but an included_day which includes June 2, 2011 means that June 2, 2011 is a school day.  
+
+== WHAT THIS GEM DOES NOT DO: 
+
+This gem is meant for ONE school calendar. This gem does not address the situation where you are (for example) writing a state level website and have multiple school districts each with their own calendar.
+
+If you do need such functionality, I suggest you make a pull request.
+
+It also does not deal with in-service days. This gem is only worried about days children are in school.
+
+This gem also relies on manual configuration every year. It can not possibly know the school holidays of your individual school, so it doesn't try. I realize this requires someone to remember to update the configuration to put new school information in.
+
+
+== 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.
+
+* I use GitFlow <https://github.com/nvie/gitflow> to develop, so bonus points for that.
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Ryan Wilcox
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/school_days'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'school_days' do
+  self.developer 'Ryan Wilcox', 'rwilcox@wilcoxd.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['activesupport','>= 2.0.2'], ["shoulda", "=2.11.3"]]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/extensions/date.rb

@@ -0,0 +1,36 @@
+
+
+module SchoolDays
+  module DateExtensions
+  def school_day?
+    # first, check the exceptional days and see if we can get a quick match
+    return false if SchoolDays.config.holiday_exceptions.include? self
+    return true if SchoolDays.config.included_day_exceptions.include? self
+
+    # Now, the laborous part.
+
+    # First, check to see if we are a week day
+    weekday = [1,2,3,4,5].include?(self.wday)
+    has_school = false
+
+    if weekday
+      has_school = true
+
+      # ok, now check to see if this weekday is in the school sessions
+      has_school = SchoolDays.config.school_sessions.any? do |current_session|
+        current_session[:start_date] <= self && current_session[:end_date] >= self
+      end
+    end
+
+    has_school
+  end
+
+  def school_night?
+    (self + 1).school_day?
+  end
+end
+end
+
+class Date
+  include SchoolDays::DateExtensions
+end

data/lib/extensions/fixnum.rb

@@ -0,0 +1,18 @@
+# hook into fixnum so we can say things like:
+#  5.school_days.from_now
+#  7.school_days.ago
+
+module SchoolDays
+  module FixnumExtensions
+    def school_days
+      SchoolDays::Calculator.new(self)
+    end
+    alias :school_day :school_days
+
+  end
+end
+
+class Fixnum
+  include SchoolDays::FixnumExtensions
+end
+  

data/lib/school_days/calculator.rb

@@ -0,0 +1,60 @@
+
+module SchoolDays
+  class Calculator
+    def initialize(days)
+      @days = days
+    end
+
+    def after(time = Time.now)
+      # example: 2.school_days.after(tuesday)
+      date = time
+      date = time.to_date if time.is_a?(Time)
+
+      @days.times do
+        begin
+          date = date + 1
+          raise SchoolDays::DateNotInSchoolCalendar unless is_in_school_year?(date)
+          # (if we are not in the school year at all, stop calculating, because
+          # once we go outside we'll never find another school day. WD-rpw 01-26-2011)
+        end until date.school_day?
+      end
+      date
+    end
+    alias_method :from_now, :after
+
+    def before(time = Time.now)
+      # example: 2.school_days.after(tuesday)
+      date = time
+      date = time.to_date if time.is_a?(Time)
+
+      @days.times do
+        begin
+          date = date - 1
+          raise SchoolDays::DateNotInSchoolCalendar unless is_in_school_year?(date)
+          # (if we are not in the school year at all, stop calculating, because
+          # once we go outside we'll never find another school day. WD-rpw 01-26-2011)
+        end until date.school_day?
+      end
+      date      
+    end
+    alias_method :until, :before
+
+    # a new method, more of a helper for this API then an actual public method...
+    # however, this will return the session a date is associated with, or nil
+    # if this falls totally outside the known school year
+    def school_session_for_date(date)
+      SchoolDays.config.school_sessions.detect do |school_session|
+        school_session[:start_date] < date && date < school_session[:end_date]
+      end
+    end
+
+    # another semi-private method. TODO: it seems useful to expose this, but how?
+    def is_in_school_year?(date)
+      # included exceptional days can be outside the school year
+      return true if SchoolDays.config.included_day_exceptions.include? date
+
+      # ok, now check ranges
+      SchoolDays.config.school_year_start < date && date < SchoolDays.config.school_year_end
+    end
+  end
+end

data/lib/school_days/config.rb

@@ -0,0 +1,66 @@
+require 'singleton'
+require 'yaml'
+require 'date'
+
+module SchoolDays
+
+  # controls the behavior of this gem.  Currently this gem only supports
+  # loading information from a YAML file (TODO: implement programatic ways)
+  # ... well, you could do it, but I don't care about that code path yet...
+  class ConfigBase
+    attr_accessor :school_sessions
+    attr_accessor :holiday_exceptions
+    attr_accessor :included_day_exceptions
+
+    def reset
+      self.school_sessions = {}
+      self.holiday_exceptions = []
+      self.included_day_exceptions = []
+    end
+
+    def load(filename)
+      reset
+      data = YAML::load(File.open(filename))
+      sessions = data["school_days"]["school_sessions"]
+
+      self.school_sessions = sessions.collect do |session_name, session_value|
+        if session_value["start_date"].nil? || session_value["end_date"].nil?
+          raise "start_date or end_date is blank for #{session_name} in #{filename}"
+        end
+
+        {:start_date => Date.parse(session_value["start_date"]),
+          :end_date => Date.parse(session_value["end_date"])}
+      end
+      
+      data["school_days"]["exceptions"]["holidays"].each do |holiday|
+        self.holiday_exceptions << Date.parse(holiday)
+      end
+
+      data["school_days"]["exceptions"]["included_days"].each do |extra_day|
+        self.included_day_exceptions << Date.parse(extra_day)
+      end
+    end
+
+    def school_year_start
+      res = self.school_sessions.min do |a, b|
+        a[:start_date] <=> b[:start_date]
+      end
+      res[:start_date]
+    end
+
+    def school_year_end
+      res = self.school_sessions.max do |a, b|
+        a[:end_date] <=> b[:end_date]
+      end
+      res[:end_date]
+    end
+  end
+
+  class Config < ConfigBase
+    include Singleton
+  end
+
+  def self.config
+    Config.instance
+  end
+end

data/lib/school_days.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require File.dirname(__FILE__) + '/school_days/config'
+require File.dirname(__FILE__) + '/school_days/calculator'
+
+require File.dirname(__FILE__) + '/extensions/date'
+require File.dirname(__FILE__) + '/extensions/fixnum'
+
+module SchoolDays
+  class DateNotInSchoolCalendar < RuntimeError
+  end
+end
+
+module SchoolDays
+  VERSION = '1.0.0'
+end

data/rails_generators/school_days_config/USAGE

@@ -0,0 +1,5 @@
+Description:
+Creates a school_days.yml config file and an initializer that loads the school days gem into your Rails app.
+
+Usage:
+  script/generate school_days_config

data/rails_generators/school_days_config/school_days_config_generator.rb

@@ -0,0 +1,17 @@
+class SchoolDaysConfigGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file('school_days.rb', "config/initializers/school_days.rb")
+      m.file('school_days.yml', "config/school_days.yml")
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a school_days.yml config file and an initializer that loads the school days gem into your Rails app.
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+end

data/rails_generators/school_days_config/templates/school_days.rb

@@ -0,0 +1,3 @@
+SchoolDays.config.load("#{RAILS_ROOT}/config/school_days.yml")
+
+# TODO: manually loading, like Business Time?? WD-rpw 01-21-2011

data/rails_generators/school_days_config/templates/school_days.yml

@@ -0,0 +1,14 @@
+school_days:
+  school_sessions:
+    school_year:
+        start_date: Aug 29, 2011
+        end_date: June 1, 2012
+  exceptions:
+    holidays:
+      - Jan 01, 2010
+      - July 4th, 2010
+      - December 25th, 2010
+    included_days:
+      - Aug 29, 2011
+      - May 29, 2011
+    

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/school_days.rb'}"
+puts "Loading school_days gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/fixtures/double_session_test.yml

@@ -0,0 +1,15 @@
+school_days:
+  school_sessions:
+    fall_semester:
+        start_date: Aug 29, 2011
+        end_date: December 15, 2011
+    spring_semester:
+        start_date: January 15, 2012
+        end_date: May 15, 2012
+  exceptions:
+    holidays:
+      - Jan 23, 2012
+      - May 1, 2012
+    included_days:
+      - Aug 27, 2011
+      - May 12, 2012

data/test/fixtures/invalid_config_test.yml

@@ -0,0 +1,16 @@
+school_days:
+  school_sessions:
+    fall_semester:
+        start_date: Aug 29, 2011
+        end_date: December 15, 2012
+    spring_semester:
+        start_start: January 15, 2012
+        end_date: May 15, 2012
+  exceptions:
+    holidays:
+      - Jan 01, 2010
+      - July 4th, 2010
+      - December 25th, 2010
+    included_days:
+      - Aug 29, 2011
+      - May 29, 2011

data/test/fixtures/simple_test.yml

@@ -0,0 +1,14 @@
+school_days:
+  school_sessions:
+    school_year:
+        start_date: Aug 30, 2010
+        end_date: June 1, 2011
+  exceptions:
+    holidays:
+      - Jan 01, 2011
+      - July 4th, 2011
+      - December 25th, 2010
+      - May 31, 2011
+    included_days:
+      - Aug 28, 2010
+      - May 29, 2011

data/test/test_config.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestConfig < Test::Unit::TestCase
+  should "load a file with one session with no errors" do
+    conf = SchoolDays::ConfigBase.new
+    assert_nothing_raised(Exception) {  conf.load( fixture_path() + "/simple_test.yml" )   }
+  end
+
+  should "load a file with two sessions correctly" do
+    conf = SchoolDays::ConfigBase.new
+    assert_nothing_raised(Exception) {  conf.load( fixture_path() + "/double_session_test.yml" )  }
+    assert conf.school_sessions.length == 2
+  end
+
+  context "holiday exceptions" do
+    should "only include listed holiday exceptions, as Ruby Date objects" do
+      conf = SchoolDays::ConfigBase.new
+      conf.load( fixture_path() + "/simple_test.yml" )
+
+      assert_contains( conf.holiday_exceptions, Date.parse("Jan 01, 2011") )
+      assert_does_not_contain( conf.holiday_exceptions, Date.parse("Jan 02, 2011") )
+    end
+  end
+
+  context "exceptional included days" do
+    should "only include exceptional included days, as Ruby date objects" do
+      conf = SchoolDays::ConfigBase.new
+      conf.load( fixture_path() + "/simple_test.yml" )
+
+      assert_contains( conf.included_day_exceptions, Date.parse("May 29, 2011") )
+      assert_does_not_contain( conf.included_day_exceptions, Date.parse("May 31, 2011") )
+    end
+  end
+
+  context "when loading an invalid config file" do
+    should "throw a Runtime error when we're missing start or end dates for a session" do
+      conf = SchoolDays::ConfigBase.new
+      assert_raise(RuntimeError) {  conf.load( fixture_path() + "/invalid_config_test.yml" )   }
+    end
+  end
+
+  context "when loading a file with one session" do
+    should "be able to find the start date" do
+      conf = SchoolDays::ConfigBase.new
+      conf.load( fixture_path() + "/simple_test.yml" )
+      assert_equal( Date.civil(2010, 8, 30).to_s, conf.school_year_start.to_s )
+    end
+
+    should "be able to find the end date" do
+      conf = SchoolDays::ConfigBase.new
+      conf.load( fixture_path() + "/simple_test.yml" )
+      assert_equal( Date.civil(2011, 6, 1).to_s, conf.school_year_end.to_s )
+    end
+  end
+
+  context "when loading a file with multiple sessions" do
+    should "be able to find the first start date" do
+      conf = SchoolDays::ConfigBase.new
+      conf.load( fixture_path() + "/double_session_test.yml" )
+      assert_equal( Date.civil(2011, 8, 29).to_s, conf.school_year_start.to_s )
+    end
+
+    should "be able to find the last end date" do
+      conf = SchoolDays::ConfigBase.new
+      conf.load( fixture_path() + "/double_session_test.yml" )
+      assert_equal( Date.civil(2012, 5, 15).to_s, conf.school_year_end.to_s )
+    end
+  end
+end

data/test/test_date_extensions.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+class TestDateExtensions < Test::Unit::TestCase
+
+  context "Date instances" do
+    setup do
+      SchoolDays.config.load( fixture_path() + "/simple_test.yml" )
+    end
+
+    should "Date should respond to school_day?" do
+      assert_nothing_raised(Exception) { Date.today.school_day? }
+    end
+
+    should "return true for school_day if the day is a weekday" do
+      days = (24..28).to_a # In January 2011 these are all weedays
+      days.each do |day|
+        date = Date.civil(2011, 01, day)
+        assert date.school_day?
+      end
+    end
+
+    should "return false for school_day? if the day is a weekend" do
+      weekend = Date.civil(2011, 01, 29)
+      assert !weekend.school_day?
+    end
+
+    should "return true if the day is a school night" do
+      date = Date.civil(2011, 1, 27) #Thursday
+      assert date.school_night?
+    end
+
+    should "return false if the day is not a school night" do
+      date = Date.civil(2011, 1, 28) #Friday
+      assert !date.school_night?
+    end
+
+    should "return true before an exceptional included day" do
+      date = Date.civil(2011, 5, 28)
+      assert date.school_night?
+    end
+
+    should "return false for school_day? if the day is flagged as a holiday" do
+      days = (24..28).to_a # In January 2011 these are all weedays
+      days.each do |day|
+        date = Date.civil(2011, 5, 31) # our simple_test.yml defines this as a holiday
+        # May 31, 2011 is a Tuesday.
+
+        assert !date.school_day?
+      end
+    end
+
+    should "return true for school_day? if a normally off day is flagged as an included day" do
+      date = Date.civil(2011, 5, 29) # while it is a Sunday in 2011, it's on our list
+      # of exceptional included days, so it must be included
+
+      assert date.school_day?
+    end
+
+    should "return true when the date is equal to the start date of a session" do
+      d = Date.civil(2010, 8, 30) # a monday
+      assert d.school_day?
+    end
+
+    should "return true when the date is equal to the last date of a session" do
+      d = Date.civil(2011, 6, 1)
+      assert d.school_day?
+    end
+
+    context "when looking at a single school session" do
+      setup do
+
+      end
+
+      should "return false for school_day? if the date is outside the session (and not in exceptional included days)" do
+        date = Date.civil(2011, 6, 2) # June 2 is a Thursday in 2011... but it's also outside the school session
+        assert !date.school_day?(), "Day outside school session still thinks its a school day"
+      end
+
+      should "return true for school_day? if the date is inside the session (and not in exceptional included days)" do
+        date = Date.civil(2010, 10, 18)
+        assert date.school_day?
+      end
+    end
+
+    context "when looking at multiple school sessions" do
+      setup do
+        SchoolDays.config.load( fixture_path() + "/double_session_test.yml" )
+      end
+
+      should "return false for school_day? if a weekday is is outside ALL of the sessions (and not in exceptional included days)" do
+        date = Date.civil(2012, 6, 2) # June 2 is a Thursday in 2011... but it's also outside the school session
+        assert !date.school_day?(), "Day outside school session still thinks its a school day"
+      end
+
+      should "return false for school_day if the weekday is between school sessions" do
+        date = Date.civil(2012, 12, 30) # Dec 30 is a Friday in 2011... but it's in between two school sessions
+        assert !date.school_day?(), "Day between school sessions still thinks its a school day"
+      end
+
+      should "return false for school_day? if a weekend is is outside ALL of the sessions (and not in exceptional included days)" do
+        date = Date.civil(2012, 5, 31) # a thursday in 2012
+        assert !date.school_day?
+      end
+      
+      should "return true for school_day? if the date is outside one session, but inside another" do
+        date = Date.civil(2012, 1, 16)
+        assert date
+      end
+    end
+    
+  end
+  
+end

data/test/test_fixnum_extensions.rb

@@ -0,0 +1,94 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+class TestFixnumExtensions < Test::Unit::TestCase
+
+  context "when adding a school day" do
+    setup do
+      SchoolDays.config.load( fixture_path() + "/double_session_test.yml" )
+    end
+
+    should "move to tomorrow (if tomorrow is a school day)" do
+      date = Date.civil(2011, 10, 18) # a Tuesday
+      assert_equal( date + 1, 1.school_day.after(date) )
+    end
+
+    should "move to Monday (if tomorrow is a weekend)" do
+      date = Date.civil(2011, 10, 21) # a Friday
+      assert_equal( date + 3, 1.school_days.after(date) )
+    end
+
+    should "move forward one week when adding 5 school days" do
+      date = Date.civil(2011, 10, 17) # a Monday
+      assert_equal( date + 7, 5.school_days.after(date) )
+    end
+
+    should "move forward onto an exceptional day" do
+      date = Date.civil(2012, 5, 11)
+      assert_equal( date + 1, 1.school_day.after(date) )
+    end
+
+    should "skip exceptional holidays" do
+      date = Date.civil(2012, 4, 30) # is a Tuesday, but May 1 is a holiday
+      assert_equal( (date + 2).to_s, (1.school_day.after(date)).to_s )
+      # so we expect May 2
+    end
+
+    should "move to the next session if we have multiple sessions" do
+      date = Date.civil(2011, 12, 12) # a Monday before semester break
+      assert_equal( Date.civil(2012, 1, 17), 5.school_days.after(date) )
+    end
+
+    should "elegantly handle a situation where we go outside the school year" do
+      date = Date.civil(2012, 5, 14)
+      assert_raise(SchoolDays::DateNotInSchoolCalendar) { 1.school_day.after(date) }
+    end
+  end
+
+  context "when subtracting a school day" do
+    setup do
+      SchoolDays.config.load( fixture_path() + "/double_session_test.yml" )
+    end
+
+    should "move to yesterday (if yesterday is a school day)" do
+      date = Date.civil(2011, 10, 18) # a Tuesday
+      assert_equal( date - 1, 1.school_day.before(date) )
+    end
+
+    should "move to Friday (if yesterday is a weekend)" do
+      date = Date.civil(2011, 10, 17) # a Monday
+      assert_equal( date - 3, 1.school_day.before(date) )
+    end
+
+    should "move back one week when adding 5 school days" do
+      date = Date.civil(2011, 10, 21) #a Friday
+      assert_equal( date - 7, 5.school_days.before(date) )
+    end
+
+    should "move backwards onto an exceptional day" do
+      date = Date.civil(2012, 5, 14)
+
+      assert date.school_day?
+      assert_equal( Date.civil(2012, 5, 12), 1.school_day.before(date) )
+
+    end
+
+    should "skip exceptional holidays" do
+      date = Date.civil(2012, 1, 25)
+      assert_equal( Date.civil(2012, 1, 20), 2.school_days.before(date) )
+    end
+
+    should "move to the previous session if we have multiple sessions" do
+      date = Date.civil(2012, 1, 16)
+      assert_equal( Date.civil(2011, 12, 14), 2.school_days.before(date) )
+    end
+
+    should "elegantly handle a situation where we go outside the school year" do
+      date = Date.civil(2011, 8, 26)
+      assert_raise(SchoolDays::DateNotInSchoolCalendar) { 1.school_day.before(date) }
+    end
+
+  end
+
+end
+

data/test/test_generator_helper.rb

@@ -0,0 +1,29 @@
+begin
+  require File.dirname(__FILE__) + '/test_helper'
+rescue LoadError
+  require 'test/unit'
+end
+require 'fileutils'
+
+# Must set before requiring generator libs.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+PROJECT_NAME = "myproject" unless defined?(PROJECT_NAME)
+app_root = File.join(TMP_ROOT, PROJECT_NAME)
+if defined?(APP_ROOT)
+  APP_ROOT.replace(app_root)
+else
+  APP_ROOT = app_root
+end
+if defined?(RAILS_ROOT)
+  RAILS_ROOT.replace(app_root)
+else
+  RAILS_ROOT = app_root
+end
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/helpers/generator_test_helper'

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'stringio'
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+
+require File.dirname(__FILE__) + '/../lib/school_days'
+
+def fixture_path()
+  File.dirname(__FILE__) + '/fixtures/'
+end

data/test/test_school_days.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestSchoolDays < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_school_days_calculator.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+class TestSchoolDaysCalculatorTest < Test::Unit::TestCase
+
+  context "identifying if a date is in the range of the whole school year" do
+    context "with a single session" do
+      setup do
+        SchoolDays.config.load( fixture_path() + "/simple_test.yml" )
+      end
+
+      should "return true when it falls in the school year" do
+        date = Date.civil(2010, 9, 9) # a Thursday
+        calc = SchoolDays::Calculator.new(nil)
+
+        assert calc.is_in_school_year?(date)
+      end
+
+      should "return false when it falls OUTSIDE of the school year" do
+        date = Date.civil(2011, 6, 2) # a friday
+        calc = SchoolDays::Calculator.new(nil)
+
+        assert !calc.is_in_school_year?(date)
+      end
+    end
+
+    context "with many sessions" do
+      setup do
+        SchoolDays.config.load( fixture_path() + "/double_session_test.yml" )
+      end
+
+      should "return true when it falls in the school year" do
+        date = Date.civil(2011, 9, 9) # a Friday
+        calc = SchoolDays::Calculator.new(nil)
+
+        assert calc.is_in_school_year?(date)
+
+        date = Date.civil(2012, 1, 16)
+        assert calc.is_in_school_year?(date)
+      end
+
+      should "return false when it falls OUTSIDE of the school year" do
+        date = Date.civil(2012, 5, 31) # a Thursday
+        calc = SchoolDays::Calculator.new(nil)
+
+        assert !calc.is_in_school_year?(date)
+      end
+    end
+  end
+end

data/test/test_school_days_config_generator.rb

@@ -0,0 +1,51 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+=begin
+# TODO: figure out why this test fails. RPW 01-21-2011
+
+require 'rails_generator'
+
+class TestSchoolDaysConfigGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_options
+    name = "myapp"
+    run_generator('school_days_config', [name], sources)
+    assert_directory_exists "some/directory"
+    assert_generated_file   "some_file"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "rails_generators"
+  end
+end
+
+=end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: school_days
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ryan Wilcox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 0
+        - 2
+        version: 2.0.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id003
+description: |-
+  Like Business Time (https://github.com/bokmann/business_time), this gem has support for domain specific dates.
+  
+  Unlike Business Time, School Days focuses on the demands of keeping a school calendar
+email: 
+- rwilcox@wilcoxd.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/school_days.rb
+- lib/extensions/date.rb
+- lib/extensions/fixnum.rb
+- lib/school_days/calculator.rb
+- lib/school_days/config.rb
+- rails_generators/school_days_config/USAGE
+- rails_generators/school_days_config/school_days_config_generator.rb
+- rails_generators/school_days_config/templates/school_days.rb
+- rails_generators/school_days_config/templates/school_days.yml
+- script/console
+- script/destroy
+- script/generate
+- test/fixtures/double_session_test.yml
+- test/fixtures/invalid_config_test.yml
+- test/fixtures/simple_test.yml
+- test/test_config.rb
+- test/test_date_extensions.rb
+- test/test_fixnum_extensions.rb
+- test/test_generator_helper.rb
+- test/test_helper.rb
+- test/test_school_days.rb
+- test/test_school_days_config_generator.rb
+- test/test_school_days_calculator.rb
+has_rdoc: true
+homepage: http://github.com/rwilcox/school_days
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: school_days
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Like Business Time (https://github.com/bokmann/business_time), this gem has support for domain specific dates
+test_files: 
+- test/test_config.rb
+- test/test_date_extensions.rb
+- test/test_fixnum_extensions.rb
+- test/test_generator_helper.rb
+- test/test_helper.rb
+- test/test_school_days.rb
+- test/test_school_days_calculator.rb
+- test/test_school_days_config_generator.rb