school_days 1.0.0 → 1.0.1

data/README.rdoc

@@ -13,7 +13,7 @@ Unlike Business Time, School Days focuses on the demands of keeping a school cal
 
 With School Days you can:
 
-  * 1.days.from_now.is_school_day
+  * 1.days.from_now.school_day?
   * Date.civil(2011, 05, 31).school_night?
   * 2.school_days.from_now
   
@@ -85,8 +85,10 @@ This key has two subkeys:
   * 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.  
+
+Note that exceptional days should fall in the school year as a whole (see the above note about FixNum#school_days.from)
+
+Example configure file can be found at: https://github.com/rwilcox/school_days/blob/master/rails_generators/school_days_config/templates/school_days.yml
 
 == WHAT THIS GEM DOES NOT DO: 
 
@@ -110,6 +112,58 @@ This gem also relies on manual configuration every year. It can not possibly kno
 * I use GitFlow <https://github.com/nvie/gitflow> to develop, so bonus points for that.
 
 
+== (GENERATED) Specifications for this gem
+
+The following are generated specifications for this gem. Computers know very little about making sense, *however* these should give you some idea of the capability of this gem
+
+    Config
+      Config should load a file with one session with no errors. 
+      Config should load a file with two sessions correctly. 
+      exceptional included days should only include exceptional included days, as Ruby date objects. 
+      holiday exceptions should only include listed holiday exceptions, as Ruby Date objects. 
+      when loading a file with multiple sessions should be able to find the first start date. 
+      when loading a file with multiple sessions should be able to find the last end date. 
+      when loading a file with one session should be able to find the end date. 
+      when loading a file with one session should be able to find the start date. 
+      when loading an invalid config file should throw a Runtime error when we're missing start or end dates for a session. 
+    DateExtension
+      Date instances should Date should respond to school_day?. 
+      Date instances should return false for school_day? if the day is a weekend. 
+      Date instances should return false for school_day? if the day is flagged as a holiday. 
+      Date instances should return false if the day is not a school night. 
+      Date instances should return true before an exceptional included day. 
+      Date instances should return true for school_day if the day is a weekday. 
+      Date instances should return true for school_day? if a normally off day is flagged as an included day. 
+      Date instances should return true if the day is a school night. 
+      Date instances should return true when the date is equal to the last date of a session. 
+      Date instances should return true when the date is equal to the start date of a session. 
+      Date instances when looking at a single school session should return false for school_day? if the date is outside the session (and not in exceptional included days). 
+      Date instances when looking at a single school session should return true for school_day? if the date is inside the session (and not in exceptional included days). 
+      Date instances when looking at multiple school sessions should return false for school_day if the weekday is between school sessions. 
+      Date instances when looking at multiple school sessions should return false for school_day? if a weekday is is outside ALL of the sessions (and not in exceptional included days). 
+      Date instances when looking at multiple school sessions should return false for school_day? if a weekend is is outside ALL of the sessions (and not in exceptional included days). 
+      Date instances when looking at multiple school sessions should return true for school_day? if the date is outside one session, but inside another. 
+    FixnumExtension
+      when adding a school day should elegantly handle a situation where we go outside the school year. 
+      when adding a school day should move forward one week when adding 5 school days. 
+      when adding a school day should move forward onto an exceptional day. 
+      when adding a school day should move to Monday (if tomorrow is a weekend). 
+      when adding a school day should move to the next session if we have multiple sessions. 
+      when adding a school day should move to tomorrow (if tomorrow is a school day). 
+      when adding a school day should skip exceptional holidays. 
+      when subtracting a school day should elegantly handle a situation where we go outside the school year. 
+      when subtracting a school day should move back one week when adding 5 school days. 
+      when subtracting a school day should move backwards onto an exceptional day. 
+      when subtracting a school day should move to Friday (if yesterday is a weekend). 
+      when subtracting a school day should move to the previous session if we have multiple sessions. 
+      when subtracting a school day should move to yesterday (if yesterday is a school day). 
+      when subtracting a school day should skip exceptional holidays. 
+    SchoolDaysCalculator
+      identifying if a date is in the range of the whole school year with a single session should return false when it falls OUTSIDE of the school year. 
+      identifying if a date is in the range of the whole school year with a single session should return true when it falls in the school year. 
+      identifying if a date is in the range of the whole school year with many sessions should return false when it falls OUTSIDE of the school year. 
+      identifying if a date is in the range of the whole school year with many sessions should return true when it falls in the school year. 
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -14,11 +14,14 @@ $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"]]
+  self.extra_deps         = [ ['activesupport','>= 2.0.2'] ]
+  self.extra_dev_deps     = [ ["shoulda", ">= 2.10.0"] ]
 
 end
 
 require 'newgem/tasks'
+require 'shoulda/tasks'
+
 Dir['tasks/**/*.rake'].each { |t| load t }
 
 # TODO - want other tests/tasks run by default? Add them to the list

data/lib/school_days.rb

@@ -13,5 +13,5 @@ module SchoolDays
 end
 
 module SchoolDays
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/test/test_date_extensions.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
 
-class TestDateExtensions < Test::Unit::TestCase
+class TestDateExtension < Test::Unit::TestCase
 
   context "Date instances" do
     setup do

data/test/test_fixnum_extensions.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
 
-class TestFixnumExtensions < Test::Unit::TestCase
+class TestFixnumExtension < Test::Unit::TestCase
 
   context "when adding a school day" do
     setup do

data/test/test_school_days.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class TestSchoolDays < Test::Unit::TestCase
+class TestSchoolDay < Test::Unit::TestCase
 
   def setup
   end

data/test/test_school_days_calculator.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
 
-class TestSchoolDaysCalculatorTest < Test::Unit::TestCase
+class TestSchoolDaysCalculator < Test::Unit::TestCase
 
   context "identifying if a date is in the range of the whole school year" do
     context "with a single session" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: school_days
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Ryan Wilcox
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 -05:00
+date: 2011-01-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,15 +40,15 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 37
+        hash: 39
         segments: 
         - 2
-        - 11
-        - 3
-        version: 2.11.3
-  type: :runtime
+        - 10
+        - 0
+        version: 2.10.0
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: hoe