calendarium-romanum 0.3.0 → 0.4.0

data/data/universal-it.txt

@@ -199,7 +199,7 @@ locale: it
 
 = 11
 1 s : Tutti i Santi
-2 : Commemorazione di tutti i fedeli defunti
+2 s : Commemorazione di tutti i fedeli defunti
 3 R : San Martino de Porres, religioso
 4 m : San Carlo Borromeo, vescovo
 9 f : Dedicazione della basilica Lateranense

data/data/universal-la.txt

@@ -199,7 +199,7 @@ locale: la
 
 = 11
 1 s :  OMNIUM SANCTORUM
-2 : IN COMMEMORATIONE OMNIUM FIDELIUM DEFUNCTORUM
+2 s : IN COMMEMORATIONE OMNIUM FIDELIUM DEFUNCTORUM
 3 R : S. Martini de Porres, religiosi
 4 m :  S. Caroli Borromeo, episcopi
 9 f :  IN DEDICATIONE BASILICAE LATERANENSIS

data/lib/calendarium-romanum.rb

@@ -6,6 +6,7 @@ enum
 enums
 data
 calendar
+perpetual_calendar
 temporale
 temporale/dates
 temporale/extensions/christ_eternal_priest

data/lib/calendarium-romanum/calendar.rb

@@ -6,17 +6,26 @@ module CalendariumRomanum
   # Provides complete information concerning a liturgical year,
   # it's days and celebrations occurring on them.
   class Calendar
-
     extend Forwardable
 
+    # Day when the implemented calendar system became effective
+    EFFECTIVE_FROM = Date.new(1970, 1, 1).freeze
+
     # year: Integer
     # returns a calendar for the liturgical year beginning with
     # Advent of the specified civil year.
-    def initialize(year, sanctorale=nil, temporale_class=nil)
+    def initialize(year, sanctorale=nil, temporale=nil)
+      if year < (EFFECTIVE_FROM.year - 1)
+        raise system_not_effective
+      end
+
+      if temporale && temporale.year != year
+        raise ArgumentError.new("Temporale year must be the same as year.")
+      end
+
       @year = year
       @sanctorale = sanctorale || Sanctorale.new
-      @temporale_class = temporale_class || Temporale
-      @temporale = @temporale_class.new(year)
+      @temporale = temporale || Temporale.new(year)
       @transferred = Transfers.new(@temporale, @sanctorale)
     end
 
@@ -56,18 +65,6 @@ module CalendariumRomanum
     attr_reader :temporale
     attr_reader :sanctorale
 
-    # returns a Calendar for the subsequent year
-    def succ
-      c = Calendar.new @year + 1, @sanctorale, @temporale_class
-      return c
-    end
-
-    # returns a Calendar for the previous year
-    def pred
-      c = Calendar.new @year - 1, @sanctorale, @temporale_class
-      return c
-    end
-
     def ==(obj)
       unless obj.is_a? Calendar
         return false
@@ -91,6 +88,10 @@ module CalendariumRomanum
         range_check date
       end
 
+      if date < EFFECTIVE_FROM
+        raise system_not_effective
+      end
+
       s = @temporale.season(date)
       return Day.new(
                      date: date,
@@ -110,6 +111,14 @@ module CalendariumRomanum
       @year % 2 + 1
     end
 
+    def freeze
+      @temporale.freeze
+      @sanctorale.freeze
+      super
+    end
+
+    private
+
     def celebrations_for(date)
       tr = @transferred.get(date)
       return [tr] if tr
@@ -120,8 +129,7 @@ module CalendariumRomanum
       unless st.empty?
         if st.first.rank > t.rank
           if st.first.rank == Ranks::MEMORIAL_OPTIONAL
-            st.unshift t
-            return st
+            return st.dup.unshift t
           else
             return st
           end
@@ -136,5 +144,9 @@ module CalendariumRomanum
 
       return [t]
     end
+
+    def system_not_effective
+      RangeError.new('Year out of range. Implemented calendar system has been in use only since 1st January 1970.')
+    end
   end # class Calendar
 end

data/lib/calendarium-romanum/cli.rb

@@ -85,16 +85,20 @@ module CalendariumRomanum
           ca = celebs[0][i]
           cb = celebs[1][i]
 
-          _print_cel = Proc.new {|c| puts "#{c.rank.priority} #{c.colour} | #{c.title}" }
-
           if ca.rank != cb.rank || ca.colour != cb.colour
             puts "#{d.month}/#{d.day}"
-            _print_cel.call ca
-            _print_cel.call cb
+            print_celebration ca
+            print_celebration cb
             puts
           end
         end
       end
     end
+
+    private
+
+    def print_celebration(c)
+      puts "#{c.rank.priority} #{c.colour.symbol} | #{c.title}"
+    end
   end
 end

data/lib/calendarium-romanum/data.rb

@@ -20,6 +20,7 @@ module CalendariumRomanum
       [
         GENERAL_ROMAN_LATIN = SanctoraleFile.new('universal-la.txt'),
         GENERAL_ROMAN_ENGLISH = SanctoraleFile.new('universal-en.txt'),
+        GENERAL_ROMAN_FRENCH = SanctoraleFile.new('universal-fr.txt'),
         GENERAL_ROMAN_ITALIAN = SanctoraleFile.new('universal-it.txt'),
         CZECH = SanctoraleFile.new('czech-cs.txt')
       ] \

data/lib/calendarium-romanum/day.rb

@@ -30,6 +30,14 @@ module CalendariumRomanum
 
     # an Array of Celebrations, possibly empty
     attr_reader :celebrations
+
+    def ==(other)
+      self.class == other.class &&
+        date == other.date &&
+        season == other.season &&
+        season_week == other.season_week &&
+        celebrations == other.celebrations
+    end
   end
 
   # information on one particular celebration of the liturgical year
@@ -58,5 +66,12 @@ module CalendariumRomanum
 
     attr_reader :colour
     alias_method :color, :colour
+
+    def ==(other)
+      self.class == other.class &&
+        title == other.title &&
+        rank == other.rank &&
+        colour == other.colour
+    end
   end
 end

data/lib/calendarium-romanum/enums.rb

@@ -3,14 +3,19 @@ module CalendariumRomanum
   class Colour
     def initialize(symbol)
       @symbol = symbol
+      @i18n_key = "colour.#{@symbol}"
     end
 
     attr_reader :symbol
     alias to_sym symbol
+
+    def name
+      I18n.t @i18n_key
+    end
   end
 
   class Colours < Enum
-    values do
+    values(index_by: :symbol) do
       [
         GREEN = Colour.new(:green),
         VIOLET = Colour.new(:violet),
@@ -26,14 +31,19 @@ module CalendariumRomanum
     def initialize(symbol, colour)
       @symbol = symbol
       @colour = colour
+      @i18n_key = "temporale.season.#{@symbol}"
     end
 
     attr_reader :symbol, :colour
     alias to_sym symbol
+
+    def name
+      I18n.t @i18n_key
+    end
   end
 
   class Seasons < Enum
-    values do
+    values(index_by: :symbol) do
       [
         ADVENT = Season.new(:advent, Colours::VIOLET),
         CHRISTMAS = Season.new(:christmas, Colours::WHITE),

data/lib/calendarium-romanum/ordinalizer.rb

@@ -21,13 +21,16 @@ module CalendariumRomanum
       end
 
       def english_ordinal(number)
-        case number
+        modulo = number % 10
+        modulo = 9 if number / 10 == 1
+
+        case modulo
         when 1
-          '1st'
+          "#{number}st"
         when 2
-          '2nd'
+          "#{number}nd"
         when 3
-          '3rd'
+          "#{number}rd"
         else
           "#{number}th"
         end

data/lib/calendarium-romanum/perpetual_calendar.rb

@@ -0,0 +1,49 @@
+module CalendariumRomanum
+  # When you want to query a calendar without caring about
+  # civil and liturgical years and Calendar instances
+  class PerpetualCalendar
+    def initialize(sanctorale: nil, temporale_factory: nil, temporale_options: nil, cache: {})
+      if temporale_factory && temporale_options
+        raise ArgumentError.new('Specify either temporale_factory or temporale_options, not both')
+      end
+
+      @sanctorale = sanctorale
+      @temporale_factory = temporale_factory || build_temporale_factory(temporale_options)
+
+      @cache = cache
+    end
+
+    # returns a resolved Day
+    def day(*args)
+      calendar_for(*args).day(*args)
+    end
+
+    # returns a Calendar instance for the liturgical year containing
+    # the specified day
+    def calendar_for(*args)
+      date = Calendar.mk_date(*args)
+      year = Temporale.liturgical_year date
+      calendar_instance year
+    end
+
+    # returns a Calendar instance for the specified liturgical year
+    def calendar_for_year(year)
+      calendar_instance year
+    end
+
+    private
+
+    def build_temporale_factory(temporale_options)
+      temporale_options ||= {}
+      lambda {|year| Temporale.new(year, **temporale_options) }
+    end
+
+    def calendar_instance(year)
+      if @cache.has_key? year
+        @cache[year]
+      else
+        @cache[year] = Calendar.new(year, @sanctorale, @temporale_factory.call(year))
+      end
+    end
+  end
+end

data/lib/calendarium-romanum/rank.rb

@@ -34,7 +34,7 @@ module CalendariumRomanum
     end
 
     def memorial?
-      priority.to_i == 3
+      priority.to_i == 3 && priority <= 3.12
     end
   end
 end

data/lib/calendarium-romanum/sanctorale.rb

@@ -43,7 +43,7 @@ module CalendariumRomanum
         @solemnities.delete date
       end
 
-      @days[date] = celebrations
+      @days[date] = celebrations.dup
     end
 
     # adds all Celebrations from another instance
@@ -85,5 +85,12 @@ module CalendariumRomanum
     def empty?
       @days.empty?
     end
+
+    def freeze
+      @days.freeze
+      @days.values.each &:freeze
+      @solemnities.freeze
+      super
+    end
   end
 end

data/lib/calendarium-romanum/temporale.rb

@@ -7,22 +7,23 @@ module CalendariumRomanum
 
     WEEK = 7
 
+    SUNDAY_TRANSFERABLE_SOLEMNITIES =
+      %i(epiphany ascension corpus_christi).freeze
+
     # year is Integer - the civil year when the liturgical year begins
-    def initialize(year)
+    def initialize(year, extensions: [], transfer_to_sunday: [])
       @year = year
+
+      @extensions = extensions
+      @transfer_to_sunday = transfer_to_sunday
+      validate_sunday_transfer!
+
       prepare_solemnities
     end
 
     attr_reader :year
 
     class << self
-      # Creates a subclass with specified extension modules included
-      def with_extensions(*extensions)
-        Class.new(self) do
-          extensions.each {|e| include e }
-        end
-      end
-
       # Determines liturgical year for the given date
       def liturgical_year(date)
         year = date.year
@@ -62,7 +63,7 @@ module CalendariumRomanum
               c(:ascension, Ranks::PRIMARY),
               c(:pentecost, Ranks::PRIMARY, Colours::RED),
               c(:holy_trinity, Ranks::SOLEMNITY_GENERAL),
-              c(:body_blood, Ranks::SOLEMNITY_GENERAL),
+              c(:corpus_christi, Ranks::SOLEMNITY_GENERAL),
               c(:sacred_heart, Ranks::SOLEMNITY_GENERAL),
               c(:christ_king, Ranks::SOLEMNITY_GENERAL),
 
@@ -75,15 +76,6 @@ module CalendariumRomanum
           end
       end
 
-      # Hook point for extensions to add new celebrations
-      def add_celebration(date_method, celebration)
-        if self == Temporale
-          raise RuntimeError.new("Don't add celebrations to Temporale itself, subclass it and modify the subclass.")
-        end
-
-        celebrations << C.new(date_method, celebration)
-      end
-
       private
 
       def c(date_method, rank, colour=Colours::WHITE)
@@ -96,6 +88,10 @@ module CalendariumRomanum
       end
     end
 
+    def transferred_to_sunday?(solemnity)
+      @transfer_to_sunday.include?(solemnity)
+    end
+
     def start_date
       first_advent_sunday
     end
@@ -132,13 +128,23 @@ module CalendariumRomanum
     ascension
     pentecost
     holy_trinity
-    body_blood
+    corpus_christi
     sacred_heart
     immaculate_heart
     christ_king
     ).each do |feast|
-      define_method feast do
-        Dates.public_send feast, year
+      if SUNDAY_TRANSFERABLE_SOLEMNITIES.include? feast
+        define_method feast do
+          Dates.public_send feast, year, sunday: transferred_to_sunday?(feast)
+        end
+      elsif feast == :baptism_of_lord
+        define_method feast do
+          Dates.public_send feast, year, epiphany_on_sunday: transferred_to_sunday?(:epiphany)
+        end
+      else
+        define_method feast do
+          Dates.public_send feast, year
+        end
       end
     end
 
@@ -188,7 +194,7 @@ module CalendariumRomanum
         week1_beginning = Dates.sunday_after(season_beginning)
       end
 
-      week = date_difference(date, week1_beginning) / Temporale::WEEK + 1
+      week = date_difference(date, week1_beginning) / WEEK + 1
 
       if seasonn == Seasons::ORDINARY
         # ordinary time does not begin with Sunday, but the first week
@@ -295,22 +301,43 @@ module CalendariumRomanum
       @memorials = {}
 
       self.class.celebrations.each do |c|
-        if c.date_method.is_a? Proc
-          date = instance_eval &c.date_method
+        prepare_celebration_date c.date_method, c.celebration
+      end
+
+      @extensions.each do |extension|
+        extension.each_celebration do |date_method, celebration|
+          date_proc = date_method
+          if date_method.is_a? Symbol
+            date_proc = extension.method(date_method)
+          end
+
+          prepare_celebration_date date_proc, celebration
+        end
+      end
+    end
+
+    def prepare_celebration_date(date_method, celebration)
+      if date_method.respond_to? :call
+        date = date_method.call(year)
+      else
+        date = public_send(date_method)
+      end
+
+      add_to =
+        if celebration.feast?
+          @feasts
+        elsif celebration.memorial?
+          @memorials
         else
-          date = public_send(c.date_method)
+          @solemnities
         end
-        celebration = c.celebration
-
-        add_to =
-          if celebration.feast?
-            @feasts
-          elsif celebration.memorial?
-            @memorials
-          else
-            @solemnities
-          end
-        add_to[date] = celebration
+      add_to[date] = celebration
+    end
+
+    def validate_sunday_transfer!
+      unsupported = @transfer_to_sunday - SUNDAY_TRANSFERABLE_SOLEMNITIES
+      unless unsupported.empty?
+        raise RuntimeError.new("Transfer of #{unsupported.inspect} to a Sunday not supported. Only #{SUNDAY_TRANSFERABLE_SOLEMNITIES} are allowed.")
       end
     end
   end