stephenrichards-holiday_calendar 1.0.10

data/test/modified_weekday_test.rb

@@ -0,0 +1,201 @@
+require File.dirname(__FILE__) + '/test_helper'
+# require File.dirname(__FILE__) + '/../lib/modified_weekday'
+
+
+
+class ModifiedWeekdayTest < Test::Unit::TestCase
+    
+
+    def test_that_two_modified_weekday_objects_created_with_the_same_expression_are_equal
+        mw1 = ModifiedWeekday.new(:last_thursday)
+        mw2 = ModifiedWeekday.new(:last_thursday)
+        
+        assert_equal mw1, mw2
+    end
+    
+    
+    def test_that_two_modified_weekday_objects_created_with_different_expressions_are_not_equal
+        mw1 = ModifiedWeekday.new(:last_thursday)
+        mw2 = ModifiedWeekday.new(:first_thursday)
+
+        assert_not_equal mw1, mw2
+    end        
+
+
+    def test_that_modified_object_created_with_expressions_and_dates_are_equal
+        # Given a ModifiedWeekday object created by an expression 
+        mwe = ModifiedWeekday.new(:first_thursday)
+        
+        # and a ModifiedWeekday object created by date for a first thursday
+        mwd = ModifiedWeekday.new(Date.new(2011,6,2))
+        
+        # when I compare them, they should be equal
+        assert mwd == mwe
+    end
+    
+    
+    def test_that_a_modified_weekday_created_with_a_last_friday_expression_matches_one_created_with_a_date
+        # Given a ModifiedWeekday object created by an expression 
+        mwe = ModifiedWeekday.new(:last_friday)
+        
+        # and a ModifiedWeekday object created by date for a first thursday
+        mwd = ModifiedWeekday.new(Date.new(2011,6,24))
+        
+        # when I compare them, they should be equal
+        assert mwd == mwe        
+        
+    end
+
+
+
+
+
+    def test_that_a_modified_weekday_object_with_last_modifier_can_be_properly_created
+        mw = ModifiedWeekday.new(:last_thursday)
+        assert_instance_of ModifiedWeekday, mw
+        assert_equal :last, mw.modifier
+        assert_equal :thursday, mw.weekday_name
+        assert_equal 4, mw.wday
+        assert_equal 0, mw.weekday_occurrance
+        assert_equal true, mw.is_last
+    end
+    
+    
+    
+    def test_that_a_modified_weekday_object_with_first_modifier_can_be_properly_created
+        mw = ModifiedWeekday.new(:first_monday)
+        assert_equal :first, mw.modifier
+        assert_equal :monday, mw.weekday_name
+        assert_equal 1, mw.wday
+        assert_equal 1, mw.weekday_occurrance
+        assert_equal false, mw.is_last
+    end
+    
+    
+    
+    def test_that_first_wednesday_is_generated_from_wednesday_first_june_2011
+        # given a date of 1/6/2011
+        date = Date.new(2011, 6, 1)
+        
+        # when I create a modified date from it
+        mw = ModifiedWeekday.new(date)
+
+        # then it should be described as the first monday
+        assert_equal :first_wednesday, mw.expression
+        assert_equal :wednesday, mw.weekday_name
+        assert_equal :first, mw.modifier
+        assert_equal 1, mw.weekday_occurrance
+        assert_equal false, mw.is_last
+    end
+    
+    
+    def test_that_first_thursday_is_generated_from_thursday_second_june_2011
+        # given a date of 2/6/2011
+        date = Date.new(2011, 6, 2)
+
+        # when I create a modified date from it
+        mw = ModifiedWeekday.new(date)
+
+        # then it should be described as the first monday
+        assert_equal :first_thursday, mw.expression
+        assert_equal :thursday, mw.weekday_name
+        assert_equal :first, mw.modifier
+        assert_equal 1, mw.weekday_occurrance
+        assert_equal false, mw.is_last
+    end        
+    
+    
+    def test_that_second_wednesday_is_generated_from_wednesday_eighth_june_2011
+        # given a date of 2/6/2011
+        date = Date.new(2011, 6, 8)
+
+        # when I create a modified date from it
+        mw = ModifiedWeekday.new(date)
+
+        # then it should be described as the first monday
+        assert_equal :second_wednesday, mw.expression
+        assert_equal :wednesday, mw.weekday_name
+        assert_equal :second, mw.modifier
+        assert_equal 2, mw.weekday_occurrance
+        assert_equal false, mw.is_last
+    end        
+    
+    
+    def test_that_second_thursday_is_generated_from_thursday_ninth_june_2011
+        # given a date of 9/6/2011
+        date = Date.new(2011, 6, 9)
+
+        # when I create a modified date from it
+        mw = ModifiedWeekday.new(date)
+
+        # then it should be described as the first monday
+        assert_equal :second_thursday, mw.expression
+        assert_equal :thursday, mw.weekday_name
+        assert_equal :second, mw.modifier
+        assert_equal 2, mw.weekday_occurrance
+        assert_equal false, mw.is_last
+    end        
+    
+ 
+    def test_that_fourth_wednesday_is_generated_from_wednesday_22_june_2011
+        # given a date of 22/6/2011
+        date = Date.new(2011, 6, 22)
+
+        # when I create a modified date from it
+        mw = ModifiedWeekday.new(date)
+
+        # then it should be described as the first monday
+        assert_equal :fourth_wednesday, mw.expression
+        assert_equal :wednesday, mw.weekday_name
+        assert_equal :fourth, mw.modifier
+        assert_equal 4, mw.weekday_occurrance
+        assert_equal false, mw.is_last
+    end   
+    
+    
+    def test_that_last_wednesday_is_generated_from_wednesday_29_june_2011
+        # given a date of 29/6/2011
+        date = Date.new(2011, 6, 29)
+        
+        # when I create a modified weekday from it
+        mw = ModifiedWeekday.new(date)
+        
+        # then it should be described as the fifth and last wednesday
+        assert_equal :last_wednesday, mw.expression
+        assert_equal :wednesday, mw.weekday_name
+        assert_equal :last, mw.modifier
+        assert_equal 5, mw.weekday_occurrance
+        assert_equal true, mw.is_last
+    end
+    
+    
+    
+    
+    def test_that_an_invalid_weekday_raises_an_exception
+        err = assert_raise ArgumentError do
+            mw = ModifiedWeekday.new(:second_wed)
+        end
+        assert_equal 'Invalid Weekday component passed to ModifiedWeekday.new: second_wed', err.message
+    end
+
+   
+   def test_that_an_invalid_modifier_raises_an_exception
+       err = assert_raise ArgumentError do
+           mw = ModifiedWeekday.new(:fifth_tuesday)
+       end
+       assert_equal 'Invalid weekday modifier passed to ModifiedWeekday.new: fifth_tuesday', err.message       
+   end
+
+    
+    # def test_sort_values_are_generated_correctly
+    #     assert_equal 11, ModifiedWeekday.new(:first_monday).sort_value
+    #     assert_equal 12, ModifiedWeekday.new(:first_tuesday).sort_value
+    #     assert_equal 23, ModifiedWeekday.new(:second_wednesday).sort_value
+    #     assert_equal 44, ModifiedWeekday.new(:fourth_thursday).sort_value
+    #     assert_equal 55, ModifiedWeekday.new(:last_friday).sort_value
+    # end
+        
+    
+    
+    
+end

data/test/public_holiday_specification_test.rb

@@ -0,0 +1,254 @@
+
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/../lib/public_holiday_specification'
+require File.dirname(__FILE__) + '/mocks/mock_public_holiday_specification'
+require File.dirname(__FILE__) + '/../lib/religious_festival'
+
+
+class PublicHolidaySpecificationTest < Test::Unit::TestCase
+    
+    def test_class_method_generates_valid_public_holiday_specification
+        # given a specification that uses a class method
+        phs = PublicHolidaySpecification.new(:name => 'Good Friday', :years => :all, :class_method => 'ReligiousFestival.good_friday')
+        
+        assert_instance_of PublicHolidaySpecification, phs
+        assert_true phs.uses_class_method?
+        assert_equal ReligiousFestival, phs.klass
+        assert_equal 'good_friday', phs.method_name
+        
+    end
+    
+    
+    
+    def test_instantiating_from_yaml_throws_error_if_yaml_spec_is_not_hash
+        # given a yaml_spac that is not a hash
+        yaml_spec = [1, 33, 4]
+        
+        # when I attempt to instantiate a PHS from it, I should get an exception
+        err = assert_raise ArgumentError do
+            phs = PublicHolidaySpecification.instantiate_from_yaml_definition('/path/to/file.yaml', 'Good Friday', yaml_spec)
+        end
+        
+        assert_equal "Invalid definition of Good Friday in public_holidays section of /path/to/file.yaml", err.message
+    end
+
+
+    def test_instantiating_from_yaml_spec_with_first_monday_works_as_expected
+        # given a first_monday yaml spec
+        yaml_spec = {'month' => 5, 'day' => 'first_monday', 'years' => 'all'}
+        
+        # when I instantiate a PHS
+        phs = PublicHolidaySpecification.instantiate_from_yaml_definition('filename', 'May Day', yaml_spec)
+
+        # then the object attributes should be as expected
+        assert_equal 'May Day', phs.name
+        assert_equal 5, phs.month
+        assert_equal ModifiedWeekday.new(:first_monday), phs.day
+        assert_false phs.uses_class_method
+        assert_nil phs.klass
+        assert_nil phs.method_name
+    end
+
+
+    def test_instantiating_from_yaml_spec_with_class_method_works_as_expected
+        # given a first_monday yaml spec
+        yaml_spec = {"class_method"=>"ReligiousFestival.good_friday", "years"=>"all"}
+        
+        # when I instantiate a PHS
+        phs = PublicHolidaySpecification.instantiate_from_yaml_definition('filename', 'Good Friday', yaml_spec)
+
+        # then the object attributes should be as expected
+        assert_equal 'Good Friday', phs.name
+        assert_nil phs.month
+        assert_nil phs.day
+        assert_true phs.uses_class_method
+        assert_equal ReligiousFestival, phs.klass
+        assert_equal 'good_friday', phs.method_name
+    end
+
+
+    
+    ###
+    ###
+    ### tests against mock objects to confirm private attributes are being set up correctly
+    ###
+    ###
+    
+    def test_mock_object_created_with_single_year_generates_a_range_of_1_year_in_the_years_attribute
+        # given an object created with a single year
+        phs = MockPublicHolidaySpecification.new(:name => 'test', :years => 2006, :month => 12, :day => 25)
+
+        # when I test the year, it should be a range 2006..2006
+        assert_instance_of Range, phs.years
+        assert_equal 2006..2006, phs.years
+    end
+    
+
+    
+    def test_mock_object_created_with_all_years_generates_a_range_of_all_years_in_the_years_attribute
+        # given an object created with a all years
+        phs = MockPublicHolidaySpecification.new(:name => 'test', :years => :all, :month => 12, :day => 25)
+
+        # when I test the year, it should be a range 2006..2006
+        assert_instance_of Range, phs.years
+        assert_equal 0..9999, phs.years
+    end        
+    
+    
+    def test_mock_object_created_with_range_of_years_generates_the_correct_range_in_the_years_attribute
+        # given an object created with a range of  years
+        phs = MockPublicHolidaySpecification.new(:name => 'test', :years => 1997..2006, :month => 12, :day => 25)
+
+        # when I test the year, it should be a range 2006..2006
+        assert_instance_of Range, phs.years
+        assert_equal 1997..2006, phs.years
+    end        
+    
+    def test_mock_object_created_with_english_month_names_generates_the_correct_month_number_in_the_month_attribute
+        # given an object created with a month of May
+        phs = MockPublicHolidaySpecification.new(:name => 'test', :years => :all, :month => 'May', :day => :first_monday)
+        
+        # when I test the month, it should be 5
+        assert_equal 5, phs.month
+    end
+    
+    
+    def test_mock_object_created_with_fixed_day_number_has_a_fixed_day_number_in_the_day_attribute
+        # given an object created with a day number
+        phs = MockPublicHolidaySpecification.new(:name => 'test', :years => 1997..2006, :month => 12, :day => 25)
+        
+        # when I test the day, it should be a fixnum 25            
+        assert_instance_of Fixnum, phs.day
+        assert_equal 25, phs.day
+    end    
+    
+    
+    def test_mock_object_created_with_first_monday_has_a_modified_weekday_object_as_the_day_attribute
+        # given an object created with a phrase like :first_monday
+        phs = MockPublicHolidaySpecification.new(:name => 'test', :years => :all, :month => 12, :day => :first_monday)
+        
+        # when I test the day, it should be a fixnum 25            
+        assert_instance_of ModifiedWeekday, phs.day
+    end
+    
+    
+    
+    
+    ###
+    ###
+    ### tests that the constructor validates incoming parameters properly
+    ###
+    ###    
+    
+    def test_exception_thrown_if_mandatory_paramaters_missing
+        err = assert_raise ArgumentError do
+            phs = PublicHolidaySpecification.new(:name => 'test')
+        end
+        assert_equal "Mandatory parameters are missing in a call to PublicHolidaySpecification.new: years, month, day", err.message
+    end
+    
+    
+    
+    def test_exception_thrown_if_invalid_paramaeter_passed_to_constructor
+        
+        err = assert_raise ArgumentError do
+            phs = PublicHolidaySpecification.new(:name => 'Test Holiday', :invalid_param => 'xxxx')
+        end
+        
+        assert_equal 'Invalid parameter passed to PublicHolidaySpecification.new: invalid_param => xxxx', err.message
+    end
+    
+    
+    def test_exception_thrown_if_invalid_year_passed_to_constructor
+        err = assert_raise ArgumentError do
+            phs = PublicHolidaySpecification.new(:name => 'Xmas', :years => :this_year, :month => 12, :day => 25)
+        end
+        assert_equal 'Invalid value passed as years parameter. Must be a Range, Fixnum or :all', err.message
+    end
+    
+    
+    def test_exception_thrown_if_invalid_month_passed_to_constructor
+        err = assert_raise ArgumentError do
+            phs = PublicHolidaySpecification.new(:name => 'Xmas', :years => :all, :month => 'décembre', :day => 25)
+        end
+        assert_equal 'Invalid month passed to PublicHolidaySpecification.new: décembre', err.message  
+    end
+    
+              
+    def test_exception_thrown_if_out_of_range_month_passed_to_constructor
+        err = assert_raise ArgumentError do
+            phs = PublicHolidaySpecification.new(:name => 'Xmas', :years => :all, :month => 33, :day => 25)
+        end
+        assert_equal 'Invalid month passed to PublicHolidaySpecification.new: 33', err.message  
+    end        
+    
+    
+    def test_exception_thrown_if_out_of_range_day_passed_to_constructor
+        err = assert_raise ArgumentError do
+            phs = PublicHolidaySpecification.new(:name => 'Xmas', :years => :all, :month => 12, :day => 125)
+        end
+        assert_equal 'Invalid value passed as :day parameter to PublicHolidaySpecification.new: 125', err.message  
+    end      
+    
+    
+    
+    
+    def test_exception_thrown_if_obsolete_carry_forward_used
+        err = assert_raise ArgumentError do
+            phs = PublicHolidaySpecification.new(:name => 'test', :years => :all, :month => 8, :day => 13, :carry_forward => true)  
+        end
+        assert_equal 'Invalid parameter passed to PublicHolidaySpecification.new: carry_forward => true', err.message
+    end
+    
+    
+    def test_default_take_before_is_empty_arry
+       # given a public holiday specification without take before specified
+       phs =  PublicHolidaySpecification.new(:name => 'test', :years => :all, :month => 8, :day => 13)  
+       
+       # when I see the take_before attribute, it should be an empty array
+       assert_equal Array.new, phs.take_before
+   end
+    
+   def test_default_take_after_is_empty_arry
+       # given a public holiday specification without take before specified
+       phs =  PublicHolidaySpecification.new(:name => 'test', :years => :all, :month => 8, :day => 13)  
+       
+       # when I see the take_after attribute, it should be an empty array
+       assert_equal Array.new, phs.take_after
+   end    
+   
+   def test_take_before_parameters_are_turned_into_valid_day_numbers
+       # given a public holiday specification with a take_before parameter of saturday, sunday
+       phs =  PublicHolidaySpecification.new(:name => 'test', :years => :all, :month => 8, :day => 13,
+                        :take_before => ['Saturday', 'Sunday'])
+
+       # when I see the take_after attribute, it should be an array of 6,0
+       assert_equal [6,0], phs.take_before
+   end       
+ 
+ 
+   def test_take_before_parameters_are_turned_into_valid_day_numbers
+       # given a public holiday specification with a take_before parameter of saturday, sunday
+       phs =  PublicHolidaySpecification.new(:name => 'test', :years => :all, :month => 8, :day => 13,
+                        :take_after => ['Saturday', 'Sunday'])
+
+       # when I see the take_after attribute, it should be an array of 6,0
+       assert_equal [6,0], phs.take_after
+   end 
+   
+   
+   def test_take_before_raises_exception_if_given_non_array
+       err = assert_raise ArgumentError do
+           phs = PublicHolidaySpecification.new(:name => 'test', :years => :all, :month => 8, :day => 13, :take_before => 'Saturday')  
+       end
+       assert_equal 'take_before or take_after parameters must be an array', err.message
+   end
+   
+   def test_take_before_raises_exception_if_given_day_numbers_out_of_range
+       err = assert_raise ArgumentError do
+           phs = PublicHolidaySpecification.new(:name => 'test', :years => :all, :month => 8, :day => 13, :take_before => [0,7])  
+       end
+       assert_equal 'day number passed as take_before and take_after parameters must be in range 0-6', err.message
+   end   
+  
+end