bahai_date 1.0.0

data/spec/bahai_date/bahai_date_spec.rb

@@ -0,0 +1,251 @@
+require 'bahai_date/bahai_date'
+
+module BahaiDate
+
+  describe BahaiDate do
+
+    it "can be created from a year, month and day" do
+      bahai_date = BahaiDate.new(year: 1, month: 1, day: 1)
+
+      expect(bahai_date).to_not be_nil
+    end
+
+    it "can be created from a gregorian Date object" do
+      bahai_date = BahaiDate.new(date: Date.new(2010, 1, 1))
+
+      expect(bahai_date).to_not be_nil
+    end
+
+    it "raises an error if invalid arguments are passed to the initializer" do
+      expect { BahaiDate.new }.to raise_error(ArgumentError)
+      expect { BahaiDate.new({}) }.to raise_error(ArgumentError)
+      expect { BahaiDate.new(day: 1) }.to raise_error(ArgumentError)
+    end
+
+    context "when validating the Baha'i Era date" do
+
+      context "year" do
+        it "raises an error if less than 1" do
+          expect { BahaiDate.new(year: 0, month: 1, day: 1) 
+                 }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "month" do
+        it "raises an error if 0" do
+           expect { BahaiDate.new(year: 1, month: 0, day: 1)
+                  }.to raise_error(ArgumentError)
+        end
+        it "raises an error if less than -1" do
+           expect { BahaiDate.new(year: 1, month: -2, day: 1)
+                  }.to raise_error(ArgumentError)
+        end
+        it "raises an error if greater than 19" do
+           expect { BahaiDate.new(year: 1, month: 20, day: 1) 
+                  }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "day" do
+        it "raises an error if less than 1" do
+           expect { BahaiDate.new(year: 1, month: 1, day: 0)
+                  }.to raise_error(ArgumentError)
+        end
+        it "raises an error if greater than 19" do
+           expect { BahaiDate.new(year: 1, month: 1, day: 20) 
+                  }.to raise_error(ArgumentError)
+        end
+        context "in Ayyam-i-Ha" do
+          it "raises an error if greater than 4 on a non-leap year" do
+             expect { BahaiDate.new(year: 1, month: -1, day: 5)
+                    }.to raise_error(ArgumentError)
+          end
+          it "doesn't raise an error if 5 on a leap year" do
+             expect { BahaiDate.new(year: 4, month: -1, day: 5) 
+                    }.not_to raise_error
+          end
+          it "raises an error if greater than 5 on a leap year" do
+             expect { BahaiDate.new(year: 4, month: -1, day: 6) 
+                    }.to raise_error(ArgumentError)
+          end
+        end
+      end
+
+    end
+
+    it "exposes weekday, day, month, year and gregorian_date" do
+      bahai_date = BahaiDate.new(year: 1, month: 1, day: 1)
+
+      expect(bahai_date.weekday).to be_an_instance_of(Weekday) 
+      expect(bahai_date.day).to be_an_instance_of(Day) 
+      expect(bahai_date.month).to be_an_instance_of(Month) 
+      expect(bahai_date.year).to be_an_instance_of(Year) 
+      expect(bahai_date.gregorian_date).to be_an_instance_of(Date)
+    end
+
+    context "when converting to a gregorian date" do
+
+      it "handles the first day of the calendar" do
+        bahai_date = BahaiDate.new(year: 1, month: 1, day: 1)
+        expect(bahai_date.gregorian_date).to eq(Date.new(1844,3,21))
+      end
+
+      it "handles the last day of the year" do
+        bahai_date = BahaiDate.new(year: 1, month: 19, day: 19)
+        expect(bahai_date.gregorian_date).to eq(Date.new(1845,3,20))
+      end
+
+      it "handles the year component" do
+        bahai_date = BahaiDate.new(year: 2, month: 1, day: 1)
+        expect(bahai_date.gregorian_date).to eq(Date.new(1845,3,21))
+      end
+
+      context "in a leap year" do
+        it "handles the day before Ayyam-i-Ha" do
+          bahai_date = BahaiDate.new(year: 168, month: 18, day: 19)
+          expect(bahai_date.gregorian_date).to eq(Date.new(2012,2,25))
+        end
+
+        it "handles the first day of Ayyam-i-Ha" do
+          bahai_date = BahaiDate.new(year: 168, month: -1, day: 1)
+          expect(bahai_date.gregorian_date).to eq(Date.new(2012,2,26))
+        end
+
+        it "handles the last day of Ayyam-i-Ha" do
+          bahai_date = BahaiDate.new(year: 168, month: -1, day: 5)
+          expect(bahai_date.gregorian_date).to eq(Date.new(2012,3,1))
+        end
+
+        it "handles the first day of the month after Ayyam-i-Ha" do
+          bahai_date = BahaiDate.new(year: 168, month: 19, day: 1)
+          expect(bahai_date.gregorian_date).to eq(Date.new(2012,3,2))
+        end
+      end
+
+      context "in a non-leap year" do
+        it "handles the last day of Ayyam-i-Ha" do
+          bahai_date = BahaiDate.new(year: 169, month: -1, day: 4)
+          expect(bahai_date.gregorian_date).to eq(Date.new(2013,3,1))
+        end
+      end
+
+    end
+
+
+    context "when converting from gregorian date" do
+
+      it "handles the first day of the calendar" do
+         bahai_date = BahaiDate.new(date: Date.new(1844,3,21))
+         expect(bahai_date.year.bahai_era).to be 1
+         expect(bahai_date.month.number).to be 1
+         expect(bahai_date.day.number).to be 1
+      end
+
+      it "handles the last day of the year" do
+        bahai_date = BahaiDate.new(date: Date.new(1845,3,20))
+        expect(bahai_date.year.bahai_era).to be 1
+        expect(bahai_date.month.number).to be 19
+        expect(bahai_date.day.number).to be 19
+      end
+
+      it "handles the year component" do
+        bahai_date = BahaiDate.new(date: Date.new(1845,3,21))
+        expect(bahai_date.year.bahai_era).to be 2
+        expect(bahai_date.month.number).to be 1
+        expect(bahai_date.day.number).to be 1
+      end
+
+      context "in a leap year" do
+        it "handles the day before Ayyam-i-Ha" do
+          bahai_date = BahaiDate.new(date: Date.new(2012,2,25))
+          expect(bahai_date.year.bahai_era).to be 168
+          expect(bahai_date.month.number).to be 18
+          expect(bahai_date.day.number).to be 19
+        end
+
+        it "handles the first day of Ayyam-i-Ha" do
+          bahai_date = BahaiDate.new(date: Date.new(2012,2,26))
+          expect(bahai_date.year.bahai_era).to be 168
+          expect(bahai_date.month.number).to be -1
+          expect(bahai_date.day.number).to be 1
+        end
+
+        it "handles the last day of Ayyam-i-Ha" do
+          bahai_date = BahaiDate.new(date: Date.new(2012,3,1))
+          expect(bahai_date.year.bahai_era).to be 168
+          expect(bahai_date.month.number).to be -1
+          expect(bahai_date.day.number).to be 5
+        end
+
+        it "handles the first day of the month after Ayyam-i-Ha" do
+          bahai_date = BahaiDate.new(date: Date.new(2012,3,2))
+          expect(bahai_date.year.bahai_era).to be 168
+          expect(bahai_date.month.number).to be 19
+          expect(bahai_date.day.number).to be 1
+        end
+      end
+
+      context "in a non-leap year" do
+        it "handles the last day of Ayyam-i-Ha" do
+          bahai_date = BahaiDate.new(date: Date.new(2013,3,1))
+          expect(bahai_date.year.bahai_era).to be 169
+          expect(bahai_date.month.number).to be -1
+          expect(bahai_date.day.number).to be 4
+        end
+      end
+
+    end
+
+    it "can get weekday from a gregorian date accurately" do
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,21))
+      expect(bahai_date.weekday.number).to be 6
+
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,22))
+      expect(bahai_date.weekday.number).to be 7
+
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,23))
+      expect(bahai_date.weekday.number).to be 1
+
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,24))
+      expect(bahai_date.weekday.number).to be 2
+
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,25))
+      expect(bahai_date.weekday.number).to be 3
+
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,26))
+      expect(bahai_date.weekday.number).to be 4
+
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,27))
+      expect(bahai_date.weekday.number).to be 5
+
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,28))
+      expect(bahai_date.weekday.number).to be 6
+    end
+
+    it "can be converted to string" do
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,21))
+      expect(bahai_date.to_s).to eq "1.1.1"
+    end
+
+    it "can provide the date in long format" do
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,21))
+      expect(bahai_date.long_format).to eq "Istijlal 1 Baha 1 B.E."
+    end
+
+    it "can provide an array of occasions for a given day" do
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,21))
+      occasions_array = bahai_date.occasions
+      expect(occasions_array.size).to be 2
+      expect(occasions_array.first.short_title).to eq "Naw-Ruz"
+      expect(occasions_array.last.short_title).to eq "Feast of Baha"
+    end
+
+    it "can advance to the next day" do
+      bahai_date = BahaiDate.new(date: Date.new(1844,3,21))
+      bahai_date.next_day!
+      expect(bahai_date.gregorian_date).to eq Date.new(1844,3,22)
+    end
+
+  end
+
+end

data/spec/bahai_date/day_spec.rb

@@ -0,0 +1,68 @@
+require 'bahai_date/day'
+require 'bahai_date/weekday'
+require 'bahai_date/occasion_factory'
+
+module BahaiDate
+
+  describe Day do
+
+    it "can be created given a number from 1 to 19" do
+      expect(Day.new(1)).to_not be_nil
+      expect(Day.new(19)).to_not be_nil
+    end
+
+    it "can't be created with a number other than 1 to 19" do
+      expect { Day.new(0) }.to raise_error(
+        ArgumentError, "'0' is not a valid day. Please use 1 to 19.")
+
+      expect { Day.new(20) }.to raise_error(
+        ArgumentError, "'20' is not a valid day. Please use 1 to 19.")
+
+      expect { Day.new('hello') }.to raise_error(
+        ArgumentError, "'0' is not a valid day. Please use 1 to 19.")
+    end
+
+    subject(:day) { Day.new(1) }
+
+    it "can be converted to string" do
+      expect(day.to_s).to eq "Baha"
+    end
+
+    it "provides access to the day number" do
+      expect(day.number).to be 1
+    end
+
+    it "provides access to the translated title" do
+      expect(day.translation).to eq "Splendour"
+    end
+
+    it "provides access to the title in HTML" do
+      expect(day.html).to eq "Bahá"
+    end
+
+    context "working with the weekday" do
+      it "is initially nil" do
+        expect(day.weekday).to be_nil
+      end
+
+      it "can be set" do
+        weekday = day.set_weekday(Weekday.new(1))
+        expect(day.weekday).to be weekday
+      end
+    end
+
+    context "working with the occasions" do
+      it "is initially nil" do
+        expect(day.occasions).to be_nil
+      end
+
+      it "can be set" do
+        occasions = day.set_occasions(OccasionFactory.new(1, 1, 1).occasions)
+        expect(day.occasions).to be occasions
+      end
+    end
+
+
+  end
+
+end

data/spec/bahai_date/month_spec.rb

@@ -0,0 +1,75 @@
+require 'bahai_date/month'
+
+module BahaiDate
+
+  describe Month do
+    it "can be created given a number from 1 to 19 or -1" do
+      expect(Month.new(1)).to_not be_nil
+      expect(Month.new(19)).to_not be_nil
+      expect(Month.new(-1)).to_not be_nil
+    end
+
+    it "can't be created with a number other than 1 to 19 or -1" do
+      expect { Month.new(0) }.to raise_error(
+        ArgumentError, "'0' is not a valid month. Please use 1 to 19 or -1 for Ayyam-i-Ha.")
+
+      expect { Month.new(-2) }.to raise_error(
+        ArgumentError, "'-2' is not a valid month. Please use 1 to 19 or -1 for Ayyam-i-Ha.")
+
+      expect { Month.new(20) }.to raise_error(
+        ArgumentError, "'20' is not a valid month. Please use 1 to 19 or -1 for Ayyam-i-Ha.")
+
+      expect { Month.new('hello') }.to raise_error(
+        ArgumentError, "'0' is not a valid month. Please use 1 to 19 or -1 for Ayyam-i-Ha.")
+    end
+
+    context "when created using -1" do
+
+      it "has a title of Ayyam-i-Ha" do
+        month = Month.new(-1)
+
+        expect(month.to_s).to eq "Ayyam-i-Ha"
+      end
+    end
+
+    subject(:month) { Month.new(1) }
+
+    it "can be converted to string" do
+      expect(month.to_s).to eq "Baha"
+    end
+
+    it "provides access to the month number" do
+      expect(month.number).to be 1
+    end
+
+    it "provides access to the translated title" do
+      expect(month.translation).to eq "Splendour"
+    end
+
+    it "provides access to the title in HTML" do
+      expect(month.html).to eq "Bahá"
+    end
+
+    context "working with a hash of days" do
+      it "is readable" do
+        month = Month.new(1)
+        expect(month.days).to eq({})
+      end
+
+      it "can be added to" do
+        month = Month.new(1)
+        month.set_day(1)
+        expect(month.days[1].number).to be 1
+      end
+
+      it "doesn't create a new Day object if one exists" do
+        month = Month.new(1)
+        day = month.set_day(1)
+        month.set_day(1)
+        expect(month.days[1]).to be day
+      end
+    end
+
+  end
+
+end

data/spec/bahai_date/occasion_factory_spec.rb

@@ -0,0 +1,92 @@
+require 'bahai_date/occasion_factory'
+
+module BahaiDate
+
+  describe OccasionFactory do
+
+    it "can be created given a year, month, and day" do
+      occasion_factory = OccasionFactory.new(1, 1, 1)
+      expect(occasion_factory).not_to be_nil
+    end
+
+    it "provides a valid occasion for feast days" do
+      occasions = OccasionFactory.new(1, 2, 1).occasions
+      expect(occasions.first.type).to eq :feast
+    end
+
+    it "provides a valid occasion for days of fasting" do
+      occasions = OccasionFactory.new(1, 19, 2).occasions
+      expect(occasions.first.type).to eq :fasting
+    end
+
+    it "provides a valid occasion for days during ayyam-i-ha" do
+      occasions = OccasionFactory.new(1, -1, 1).occasions
+      expect(occasions.first.type).to eq :ayyam_i_ha
+    end
+
+    it "provides a valid occasion for days during the festival of ridvan" do
+      occasions = OccasionFactory.new(1, 2, 14).occasions
+      expect(occasions.first.type).to eq :ridvan
+    end
+
+    it "provides a valid occasion for holy days" do
+      occasions = OccasionFactory.new(1, 1, 1).occasions
+      expect(occasions.first.type).to eq :holy
+    end
+
+    it "provides valid occasions when more than one occurs on the same day" do
+      occasions = OccasionFactory.new(1, 1, 1).occasions
+      expect(occasions.size).to be 2
+      expect(occasions.first.type).to eq :holy
+      expect(occasions.last.type).to eq :feast
+    end
+
+    context "for dates before 172 B.E." do
+      it "provides the Declaration of the Bab on the correct day" do
+        occasions = OccasionFactory.new(1, 4, 7).occasions
+        expect(occasions.first.short_title).to eq "Declaration of the Bab"
+
+        occasions = OccasionFactory.new(1, 4, 8).occasions
+        expect(occasions.size).to be 0
+      end
+
+      it "provides the Martyrdom of the Bab on the correct day" do
+        occasions = OccasionFactory.new(1, 6, 16).occasions
+        expect(occasions.first.short_title).to eq "Martyrdom of the Bab"
+      end
+
+      it "provides the Birth of the Bab on the correct day" do
+        occasions = OccasionFactory.new(1, 12, 5).occasions
+        expect(occasions.first.short_title).to eq "Birth of the Bab"
+      end
+
+      it "provides the Birth of Baha'u'llah on the correct day" do
+        occasions = OccasionFactory.new(1, 13, 9).occasions
+        expect(occasions.first.short_title).to eq "Birth of Baha'u'llah"
+      end
+    end
+
+    context "for dates after 172 B.E." do
+      it "provides the Declaration of the Bab on the correct day" do
+        occasions = OccasionFactory.new(172, 4, 7).occasions
+        expect(occasions.size).to be 0
+
+        occasions = OccasionFactory.new(172, 4, 8).occasions
+        expect(occasions.first.short_title).to eq "Declaration of the Bab"
+      end
+
+      it "provides the Martyrdom of the Bab on the correct day" do
+        occasions = OccasionFactory.new(172, 6, 17).occasions
+        expect(occasions.first.short_title).to eq "Martyrdom of the Bab"
+      end
+
+      it "provides the Birth of the Bab on the correct day" do
+        occasions = OccasionFactory.new(172, 13, 10).occasions
+        expect(occasions.first.short_title).to eq "Birth of the Bab"
+      end
+
+    end
+
+  end
+
+end

data/spec/bahai_date/occasion_spec.rb

@@ -0,0 +1,28 @@
+require 'bahai_date/occasion'
+
+module BahaiDate
+
+  describe Occasion do
+
+    subject(:occasion) {
+      Occasion.new({
+        :type => :ayyam_i_ha,
+        :work_suspended => false,
+        :title => "Test title",
+        :short_title => "Test short title",
+        :title_html => "Test title html",
+        :short_title_html => "Test short title html"
+      })
+    }
+ 
+    it "can be created given an options hash" do
+      expect(occasion).not_to be_nil
+    end
+
+    it "exposes a work_suspended? method" do
+      expect(occasion.work_suspended?).to be false 
+    end
+
+  end
+
+end

data/spec/bahai_date/weekday_spec.rb

@@ -0,0 +1,46 @@
+require 'bahai_date/weekday'
+
+module BahaiDate
+
+  describe Weekday do
+    it "can be created given a number from 1 to 7" do
+      expect(Weekday.new(1)).to_not be_nil
+      expect(Weekday.new(7)).to_not be_nil
+    end
+
+    it "can't be created with a number other than 1 to 7" do
+      expect { Weekday.new(0) }.to raise_error(
+        ArgumentError, "'0' is not a valid weekday. Please use 1 to 7.")
+
+      expect { Weekday.new(8) }.to raise_error(
+        ArgumentError, "'8' is not a valid weekday. Please use 1 to 7.")
+
+      expect { Weekday.new('hello') }.to raise_error(
+        ArgumentError, "'0' is not a valid weekday. Please use 1 to 7.")
+    end
+
+    subject(:weekday) { Weekday.new(1) }
+
+    it "can be converted to string" do
+      expect(weekday.to_s).to eq "Jalal"
+    end
+
+    it "provides access to the day number" do
+      expect(weekday.number).to be 1
+    end
+
+    it "provides access to the translated title" do
+      expect(weekday.translation).to eq "Glory"
+    end
+
+    it "provides access to the title in HTML" do
+      expect(weekday.html).to eq "Jalál"
+    end
+
+    it "provides access to the English equivalent" do
+      expect(weekday.english_equivalent).to eq("Saturday")
+    end
+
+  end
+
+end

data/spec/bahai_date/year_calendar_spec.rb

@@ -0,0 +1,45 @@
+require 'bahai_date/year_calendar'
+
+module BahaiDate
+
+  describe YearCalendar do
+
+    subject(:year_calendar) { YearCalendar.new(1) }
+
+    it "can be created" do
+      expect(year_calendar).not_to be_nil
+    end
+
+    it "is an instance of year" do
+      expect(year_calendar).to be_a Year
+    end
+
+    it "has months set" do
+      months = year_calendar.months
+      expect(months.size).to be 20
+      expect(months[-1]).not_to be_nil
+      expect(months[1]).not_to be_nil
+      expect(months[19]).not_to be_nil
+    end
+
+    it "has days set" do
+      days = year_calendar.months[1].days
+      expect(days.size).to be 19
+      expect(days[1]).not_to be_nil
+      expect(days[19]).not_to be_nil
+    end
+
+    it "has weekdays set" do
+      day = year_calendar.months[1].days[1]
+      expect(day.weekday).not_to be_nil
+      expect(day.weekday.number).to be 6
+    end
+
+    it "has occasions set" do
+      day = year_calendar.months[1].days[1]
+      expect(day.occasions.size).to be 2
+    end
+
+  end
+
+end

data/spec/bahai_date/year_data_spec.rb

@@ -0,0 +1,19 @@
+require 'bahai_date/year_data'
+
+module BahaiDate
+
+  describe YearData do
+
+    it "supplies a Date object for Naw Ruz of a given year" do
+      expect(YearData.nawruz_for(1844)).to eq(Date.new(1844,3,21))
+    end
+
+    it "determines whether a year is leap or not" do
+      expect(YearData.is_leap?(1)).to eq(false)
+      expect(YearData.is_leap?(4)).to eq(true)
+      expect(YearData.is_leap?(168)).to eq(true)
+    end
+
+  end
+
+end