calendarium-romanum 0.0.1

data/lib/calendarium-romanum/transfers.rb

@@ -0,0 +1,44 @@
+module CalendariumRomanum
+
+  # Resolves transfers of solemnities.
+  class Transfers
+    def initialize(temporale, sanctorale)
+      @transferred = {}
+
+      dates = sanctorale.solemnities.keys.collect do |abstract_date|
+        temporale.concretize_abstract_date abstract_date
+      end.sort
+
+      dates.each do |date|
+        tc = temporale.get(date)
+        next unless tc.solemnity?
+
+        sc = sanctorale.get(date)
+        next unless sc.size == 1 && sc.first.solemnity?
+
+        loser = [tc, sc.first].sort_by(&:rank).first
+
+        transfer_to = date
+        begin
+          transfer_to = transfer_to.succ
+        end until valid_destination?(transfer_to, temporale, sanctorale)
+        @transferred[transfer_to] = loser
+      end
+    end
+
+    def get(date)
+      @transferred[date]
+    end
+
+    private
+
+    def valid_destination?(day, temporale, sanctorale)
+      return false if temporale.get(day).rank >= Ranks::FEAST_PROPER
+
+      sc = sanctorale.get(day)
+      return false if sc.size > 0 && sc.first.rank >= Ranks::FEAST_PROPER
+
+      true
+    end
+  end
+end

data/lib/calendarium-romanum/util.rb

@@ -0,0 +1,40 @@
+module CalendariumRomanum
+
+  module Util
+
+    # Abstract superclass for date enumerators.
+    class DateEnumerator
+      include Enumerable
+
+      def each
+        d = @start
+        begin
+          yield d
+          d = d.succ
+        end until enumeration_over? d
+      end
+
+      def enumeration_over?(date)
+        @start.send(@prop) != date.send(@prop)
+      end
+
+      alias_method :each_day, :each
+    end
+
+    # enumerates days of a year
+    class Year < DateEnumerator
+      def initialize(year)
+        @start = Date.new year, 1, 1
+        @prop = :year
+      end
+    end
+
+    # enumerates days of a month
+    class Month < DateEnumerator
+      def initialize(year, month)
+        @start = Date.new year, month, 1
+        @prop = :month
+      end
+    end
+  end
+end

data/spec/abstract_date_spec.rb

@@ -0,0 +1,45 @@
+require_relative 'spec_helper'
+
+describe AbstractDate do
+  AD = AbstractDate
+
+  describe '.new' do
+    describe 'fails on invalid' do
+      it 'month' do
+        expect do
+          AD.new(13, 1)
+        end.to raise_exception /Invalid month/
+      end
+
+      it 'day' do
+        expect do
+          AD.new(1, 32)
+        end.to raise_exception /Invalid day/
+      end
+
+      it 'day of month' do
+        expect do
+          AD.new(2, 30)
+        end.to raise_exception /Invalid day/
+      end
+    end
+  end
+
+  describe '#<' do
+    it { expect(AD.new(1, 1)).to be < AD.new(1, 2) }
+    it { expect(AD.new(1, 1)).to be < AD.new(2, 1) }
+    it { expect(AD.new(1, 1)).not_to be < AD.new(1, 1) }
+  end
+
+  describe '#==' do
+    it { expect(AD.new(1, 1)).to be == AD.new(1, 1) }
+    it { expect(AD.new(1, 1)).not_to be == AD.new(1, 2) }
+  end
+
+  describe 'as a Hash key' do
+    it 'different objects with the same values are considered same key' do
+      h = {AD.new(1, 1) => 1}
+      expect(h).to have_key AD.new(1, 1)
+    end
+  end
+end

data/spec/calendar_spec.rb

@@ -0,0 +1,217 @@
+require_relative 'spec_helper'
+
+describe Calendar do
+
+  describe 'core functions' do
+    before :all do
+      @c = Calendar.new 2013
+    end
+
+    describe '#==' do
+      it 'considers calendars with the same year same' do
+        Calendar.new(2014).should == Calendar.new(2014)
+      end
+
+      it 'considers calendars with different year different' do
+        Calendar.new(2014).should_not == Calendar.new(2010)
+      end
+    end
+
+    describe '#lectionary' do
+      it 'detects correctly' do
+        Calendar.new(2014).lectionary.should eq :B
+        Calendar.new(2013).lectionary.should eq :A
+        Calendar.new(2012).lectionary.should eq :C
+      end
+    end
+
+    describe '#ferial_lectionary' do
+      it 'detects correctly' do
+        Calendar.new(2014).ferial_lectionary.should eq 1
+        Calendar.new(2013).ferial_lectionary.should eq 2
+      end
+    end
+
+    describe '.for_day' do
+      it 'continues the previous year\'s calendar in summer' do
+        Calendar.for_day(Date.new(2014, 6, 9)).should eq Calendar.new(2013)
+      end
+
+      it 'provides the current year\'s calendar in December' do
+        Calendar.for_day(Date.new(2014, 12, 20)).should eq Calendar.new(2014)
+      end
+    end
+
+    describe '#day' do
+      it 'returns a Day' do
+        @c.day(2013, 12, 10).should be_a Day
+      end
+
+      it 'inserts correct year if not given' do
+        expect(@c.day(12, 10).date).to eq Date.new(2013, 12, 10)
+      end
+
+      it 'throws RangeError if given date not included in the year' do
+        expect { @c.day(2000, 1, 1) }.to raise_error RangeError
+      end
+
+      describe 'temporale features' do
+        describe 'season' do
+          it 'detects Advent correctly' do
+            @c.day(2013, 12, 10).season.should eq :advent
+          end
+        end
+
+        describe 'week of the season' do
+          describe 'Advent' do
+            it 'sets Advent week correctly' do
+              expect(@c.day(2013, 12, 10).season_week).to eq 2
+              expect(@c.day(2013, 12, 15).season_week).to eq 3
+            end
+          end
+
+          describe 'Christmas' do
+            it 'days before the first Sunday are week 0' do
+              expect(@c.day(2013, 12, 25).season_week).to eq 0
+            end
+
+            it 'first Sunday starts week 1' do
+              expect(@c.day(2013, 12, 29).season_week).to eq 1
+            end
+          end
+
+          describe 'Lent' do
+            it 'Ash Wednesday is week 0' do
+              expect(@c.day(2014, 3, 5).season_week).to eq 0
+            end
+          end
+
+          describe 'Easter' do
+            it 'Easter Sunday opens week 1' do
+              expect(@c.day(2014, 4, 20).season_week).to eq 1
+            end
+          end
+
+          describe 'Ordinary time' do
+            it 'Monday after Baptism of the Lord is week 1' do
+              expect(@c.day(2014, 1, 13).season_week).to eq 1
+            end
+
+            it 'Continue after Pentecost' do
+              expect(@c.day(2014, 6, 9).season_week).to eq 10
+            end
+          end
+        end
+      end
+
+      describe 'Temporale x Sanctorale resolution' do
+        before :all do
+          @s = Sanctorale.new
+          loader = SanctoraleLoader.new
+          loader.load_from_file(@s, File.join(File.dirname(__FILE__), '..', 'data', 'universal-en.txt'))
+          @c = Calendar.new 2013, @s
+        end
+
+        it '"empty" day results in a ferial' do
+          d = @c.day(7, 2)
+          expect(d.celebrations.size).to eq 1
+          expect(d.celebrations[0].rank).to eq FERIAL
+        end
+
+        it 'sanctorale feast' do
+          d = @c.day(7, 3)
+          expect(d.celebrations.size).to eq 1
+          expect(d.celebrations[0].rank).to eq FEAST_GENERAL
+          expect(d.celebrations[0].title).to include 'Thomas'
+        end
+
+        it 'optional memorial does not suppress ferial' do
+          d = @c.day(7, 14)
+          expect(d.celebrations.size).to eq 2
+
+          expect(d.celebrations[0].rank).to eq FERIAL
+
+          expect(d.celebrations[1].rank).to eq MEMORIAL_OPTIONAL
+          expect(d.celebrations[1].title).to include 'Lellis'
+        end
+
+        it 'obligate memorial does suppress ferial' do
+          d = @c.day(1, 17)
+          expect(d.celebrations.size).to eq 1
+
+          expect(d.celebrations[0].rank).to eq MEMORIAL_GENERAL
+        end
+
+        it 'Sunday suppresses feast' do
+          san = Sanctorale.new
+
+          d = Date.new 2015, 6, 28
+          expect(d).to be_sunday # ensure
+          san.add d.month, d.day, Celebration.new('St. None, programmer', FEAST_GENERAL)
+
+          c = Calendar.new 2014, san
+
+          celebs = c.day(d).celebrations
+          expect(celebs.size).to eq 1
+          expect(celebs[0].rank).to eq SUNDAY_UNPRIVILEGED
+        end
+
+        it 'suppressed fictive solemnity is transferred' do
+          san = Sanctorale.new
+
+          d = Temporale.new(2014).good_friday
+          st_none = Celebration.new('St. None, abbot, founder of the Order of Programmers (OProg)', SOLEMNITY_PROPER)
+          san.add d.month, d.day, st_none
+
+          c = Calendar.new 2014, san
+
+          # Good Friday suppresses the solemnity
+          celebs = c.day(d).celebrations
+          expect(celebs.size).to eq 1
+          expect(celebs[0].rank).to eq TRIDUUM
+          expect(celebs[0].title).to eq 'Friday of the Passion of the Lord'
+
+          # it is transferred on a day after the Easter octave
+          d = c.temporale.easter_sunday + 8
+          celebs = c.day(d).celebrations
+          expect(celebs.size).to eq 1
+          expect(celebs[0]).to eq st_none
+        end
+
+        it 'transfer of suppressed Annunciation (real world example)' do
+          c = Calendar.new 2015, @s
+
+          d = Date.new(2016, 3, 25)
+
+          # Good Friday suppresses the solemnity
+          celebs = c.day(d).celebrations
+          expect(celebs.size).to eq 1
+          expect(celebs[0].rank).to eq TRIDUUM
+          expect(celebs[0].title).to eq 'Friday of the Passion of the Lord'
+
+          # it is transferred on a day after the Easter octave
+          d = c.temporale.easter_sunday + 8
+          celebs = c.day(d).celebrations
+          expect(celebs.size).to eq 1
+          expect(celebs[0].title).to eq 'Annunciation of the Lord'
+        end
+      end
+    end
+
+    describe '#pred' do
+      it 'returns a calendar for the previous year' do
+        new_cal = @c.pred
+        expect(new_cal.year).to eq(@c.year - 1)
+        expect(new_cal.sanctorale).to eq (@c.sanctorale)
+      end
+    end
+
+    describe '#succ' do
+      it 'returns a calendar for the subsequent year' do
+        new_cal = @c.succ
+        expect(new_cal.year).to eq(@c.year + 1)
+        expect(new_cal.sanctorale).to eq (@c.sanctorale)
+      end
+    end
+  end
+end

data/spec/date_spec.rb

@@ -0,0 +1,10 @@
+# expectations concerning the Ruby implementation
+describe Date do
+  describe 'substraction' do
+    it 'returns Rational' do
+      date_diff = Date.new(2013,5,5) - Date.new(2013,5,1)
+      expect(date_diff).to be_a Rational
+      expect(date_diff.numerator).to eq 4
+    end
+  end
+end

data/spec/rank_spec.rb

@@ -0,0 +1,30 @@
+require_relative 'spec_helper'
+
+describe Rank do
+  describe 'comparison' do
+    it 'memorial x ferial' do
+      expect(MEMORIAL_GENERAL).to be > FERIAL
+    end
+  end
+
+  describe '[]' do
+    it 'has all existing instances indexed by rank number' do
+      expect(Ranks[1.1]).to eq Ranks::TRIDUUM
+    end
+  end
+
+  describe '#<' do
+    it { expect(Ranks[1.2]).to be < Ranks[1.1] }
+    it { expect(Ranks[1.1]).not_to be < Ranks[1.2] }
+  end
+
+  describe '#>' do
+    it { expect(Ranks[1.1]).to be > Ranks[1.2] }
+    it { expect(Ranks[1.2]).not_to be > Ranks[1.1] }
+  end
+
+  describe '#==' do
+    it { expect(Ranks[1.2]).to be == Ranks[1.2] }
+    it { expect(Ranks[1.2]).not_to be == Ranks[1.1] }
+  end
+end

data/spec/sanctorale_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+describe Sanctorale do
+  before :each do
+    @s = Sanctorale.new
+  end
+
+  describe '#get' do
+    describe 'for empty day' do
+      it 'returns an Array' do
+        expect(@s.get(1,3)).to be_an Array
+      end
+    end
+
+    describe 'for unempty day' do
+      before :each do
+        @c = Celebration.new('S. Antonii, abbatis', Ranks::MEMORIAL_GENERAL)
+        @s.add 1, 17, @c
+      end
+
+      it 'get by month, day' do
+        expect(@s.get(1, 17)).to eq [@c]
+      end
+
+      it 'get by Date' do
+        expect(@s.get(Date.new(2014, 1, 17))).to eq [@c]
+      end
+
+      it 'may have more Celebrations for a day' do
+        [
+         'S. Fabiani, papae et martyris',
+         'S. Sebastiani, martyris'
+        ].each {|t| @s.add 1, 20, Celebration.new(t) }
+        expect(@s.get(1, 20).size).to eq 2
+      end
+    end
+  end
+
+  describe '#add' do
+    it 'adds a Celebration to one month only' do
+      @s.add 1, 17, Celebration.new('S. Antonii, abbatis', Ranks::MEMORIAL_GENERAL)
+      expect(@s.get(2, 17)).to be_empty
+    end
+
+    it 'does not allow month 0' do
+      expect { @s.add 0, 1, Celebration.new('S. Nullius') }.to raise_exception RangeError
+    end
+
+    it 'does not allow month higher than 12' do
+      expect { @s.add 13, 1, Celebration.new('S. Nullius') }.to raise_exception RangeError
+    end
+
+    it 'adds solemnity to a dedicated container' do
+      expect { @s.add 1, 13, Celebration.new('S. Nullius', Ranks::SOLEMNITY_PROPER) }.to change { @s.solemnities.size }.by 1
+    end
+
+    it 'does not add non-solemnity to solemnities' do
+      expect { @s.add 1, 13, Celebration.new('S. Nullius') }.not_to change { @s.solemnities.size }
+    end
+  end
+
+  describe '#replace' do
+    it 'replaces the original celebration(s)' do
+      nemo = Celebration.new('S. Nullius')
+      nonus = Celebration.new('S. Noni', Ranks::SOLEMNITY_PROPER)
+
+      @s.add 1, 13, nemo
+      @s.replace 1, 13, [nonus]
+
+      expect(@s.get(1, 13)).to eq [nonus]
+    end
+
+    it 'adds solemnity to a dedicated container' do
+      nonus = Celebration.new('S. Noni', Ranks::SOLEMNITY_PROPER)
+      expect do
+        @s.replace 1, 13, [nonus]
+      end.to change { @s.solemnities.size }.by 1
+    end
+
+    it 'removes solemnity' do
+      nemo = Celebration.new('S. Nullius', Ranks::SOLEMNITY_PROPER)
+      nonus = Celebration.new('S. Noni')
+
+      @s.add 1, 13, nemo
+      expect do
+        @s.replace 1, 13, [nonus]
+      end.to change { @s.solemnities.size }.by -1
+    end
+  end
+
+  describe '#update' do
+    before :each do
+      @s2 = Sanctorale.new
+    end
+
+    it 'adds entries from the argument to receiver' do
+      @s2.add 1, 17, Celebration.new('S. Antonii, abbatis', Ranks::MEMORIAL_GENERAL)
+
+      expect(@s).to be_empty
+      @s.update @s2
+      expect(@s.size).to eq 1
+    end
+
+    it 'overwrites eventual previous content of the day' do
+      @s.add 1, 17, Celebration.new('S. Antonii, abbatis', Ranks::MEMORIAL_GENERAL)
+      cele = Celebration.new('S. Nulius, monachi')
+      @s2.add 1, 17, cele
+
+      @s.update @s2
+      expect(@s.get(1, 17)).to eq [cele]
+    end
+  end
+
+  describe '#size' do
+    it 'knows when the Sanctorale is empty' do
+      expect(@s.size).to eq 0
+    end
+
+    it 'knows when there is something' do
+      @s.add 1, 17, Celebration.new('S. Antonii, abbatis', Ranks::MEMORIAL_GENERAL)
+      expect(@s.size).to eq 1
+    end
+  end
+
+  describe '#empty?' do
+    it 'is empty at the beginning' do
+      expect(@s).to be_empty
+    end
+
+    it 'is never more empty once a record is entered' do
+      @s.add 1, 17, Celebration.new('S. Antonii, abbatis', Ranks::MEMORIAL_GENERAL)
+      expect(@s).not_to be_empty
+    end
+  end
+
+  describe '#each_day' do
+    it 'yields each date and corresponding Celebrations' do
+      cele = Celebration.new('S. Antonii, abbatis', Ranks::MEMORIAL_GENERAL)
+      @s.add 1, 17, cele
+
+      expect {|block| @s.each_day(&block) }.to yield_with_args(AbstractDate.new(1, 17), [cele])
+    end
+  end
+end