calendarium-romanum 0.4.0 → 0.5.0

data/lib/calendarium-romanum/data.rb

@@ -25,18 +25,18 @@ module CalendariumRomanum
         CZECH = SanctoraleFile.new('czech-cs.txt')
       ] \
       +
-      %w(
-      czech-brno-cs.txt
-      czech-budejovice-cs.txt
-      czech-cechy-cs.txt
-      czech-hradec-cs.txt
-      czech-litomerice-cs.txt
-      czech-morava-cs.txt
-      czech-olomouc-cs.txt
-      czech-ostrava-cs.txt
-      czech-plzen-cs.txt
-      czech-praha-cs.txt
-      ).collect {|basename| SanctoraleFile.new(basename) }
+        %w(
+          czech-brno-cs.txt
+          czech-budejovice-cs.txt
+          czech-cechy-cs.txt
+          czech-hradec-cs.txt
+          czech-litomerice-cs.txt
+          czech-morava-cs.txt
+          czech-olomouc-cs.txt
+          czech-ostrava-cs.txt
+          czech-plzen-cs.txt
+          czech-praha-cs.txt
+        ).collect {|basename| SanctoraleFile.new(basename) }
     end
   end
 end

data/lib/calendarium-romanum/day.rb

@@ -4,16 +4,12 @@ module CalendariumRomanum
 
   # information on one particular day of the liturgical year
   class Day
-    def initialize(args={})
-      %i(date season season_week celebrations).each do |a|
-        if args.include? a
-          instance_variable_set "@#{a}", args.delete(a)
-        end
-      end
-
-      unless args.empty?
-        raise ArgumentError.new "Unexpected arguments #{args.keys.join(', ')}"
-      end
+    def initialize(date: nil, season: nil, season_week: nil, celebrations: nil, vespers: nil)
+      @date = date
+      @season = season
+      @season_week = season_week
+      @celebrations = celebrations ? celebrations.dup : []
+      @vespers = vespers
     end
 
     attr_reader :date
@@ -22,7 +18,7 @@ module CalendariumRomanum
       date.wday
     end
 
-    # one of the Seasons (Symbol)
+    # one of the Seasons
     attr_reader :season
 
     # week of the season (Integer)
@@ -31,12 +27,25 @@ module CalendariumRomanum
     # an Array of Celebrations, possibly empty
     attr_reader :celebrations
 
+    # nil or Celebration from which first Vespers are celebrated
+    # instead of Vespers of the day's other Celebrations.
+    # Please note that Calendar by default *doesn't* populate
+    # Vespers, - it's an opt-in feature.
+    attr_reader :vespers
+
     def ==(other)
       self.class == other.class &&
         date == other.date &&
         season == other.season &&
         season_week == other.season_week &&
-        celebrations == other.celebrations
+        celebrations == other.celebrations &&
+        vespers == other.vespers
+    end
+
+    # Are the day's Vespers suppressed in favour of first Vespers
+    # of a Sunday or solemnity?
+    def vespers_from_following?
+      !vespers.nil?
     end
   end
 
@@ -47,10 +56,11 @@ module CalendariumRomanum
   class Celebration
     extend Forwardable
 
-    def initialize(title='', rank=Ranks::FERIAL, colour=Colours::GREEN)
+    def initialize(title = '', rank = Ranks::FERIAL, colour = Colours::GREEN, symbol = nil)
       @title = title
       @rank = rank
       @colour = colour
+      @symbol = symbol
     end
 
     attr_reader :rank
@@ -65,7 +75,9 @@ module CalendariumRomanum
     end
 
     attr_reader :colour
-    alias_method :color, :colour
+    alias color colour
+
+    attr_reader :symbol
 
     def ==(other)
       self.class == other.class &&
@@ -73,5 +85,14 @@ module CalendariumRomanum
         rank == other.rank &&
         colour == other.colour
     end
+
+    def change(title: nil, rank: nil, colour: nil, color: nil, symbol: nil)
+      self.class.new(
+        title || self.title,
+        rank || self.rank,
+        colour || color || self.colour,
+        symbol || self.symbol
+      )
+    end
   end
 end

data/lib/calendarium-romanum/enum.rb

@@ -6,7 +6,7 @@ module CalendariumRomanum
     class << self
       extend Forwardable
 
-      def values(index_by: nil, &blk)
+      def values(index_by: nil)
         defined?(@indexed) && raise(RuntimeError.new('initialized repeatedly'))
 
         @indexed = {}
@@ -22,9 +22,7 @@ module CalendariumRomanum
         @indexed.freeze
       end
 
-      def all
-        @all
-      end
+      attr_reader :all
 
       def_delegators :@all, :each
       def_delegators :@indexed, :[]

data/lib/calendarium-romanum/enums.rb

@@ -54,7 +54,7 @@ module CalendariumRomanum
     end
   end
 
-  LECTIONARY_CYCLES = [:A, :B, :C]
+  LECTIONARY_CYCLES = [:A, :B, :C].freeze
 
   # ranks of celebrations
   class Ranks < Enum

data/lib/calendarium-romanum/errors.rb

@@ -0,0 +1,4 @@
+module CalendariumRomanum
+  # attempt to load invalid calendar data
+  class InvalidDataError < RuntimeError; end
+end

data/lib/calendarium-romanum/ordinalizer.rb

@@ -12,7 +12,8 @@ module CalendariumRomanum
           "#{number}."
         when :en
           english_ordinal(number)
-        # when :it # TODO
+        when :fr
+          french_ordinal(number)
         when :la, :it
           RomanNumerals.to_roman number
         else
@@ -20,6 +21,8 @@ module CalendariumRomanum
         end
       end
 
+      private
+
       def english_ordinal(number)
         modulo = number % 10
         modulo = 9 if number / 10 == 1
@@ -35,6 +38,15 @@ module CalendariumRomanum
           "#{number}th"
         end
       end
+
+      def french_ordinal(number)
+        case number
+        when 1
+          '1er'
+        else
+          "#{number}ème"
+        end
+      end
     end
   end
 end

data/lib/calendarium-romanum/rank.rb

@@ -2,27 +2,27 @@ module CalendariumRomanum
   class Rank
     include Comparable
 
-    def initialize(priority=nil, desc=nil, short_desc=nil)
+    def initialize(priority = nil, desc = nil, short_desc = nil)
       @priority = priority
       @desc = desc
       @short_desc = short_desc
     end
 
     attr_reader :priority
-    alias_method :to_f, :priority
+    alias to_f priority
 
     def desc
       @desc && I18n.t(@desc)
     end
 
-    alias_method :to_s, :desc
+    alias to_s desc
 
     def short_desc
       @short_desc && I18n.t(@short_desc)
     end
 
-    def <=>(b)
-      b.priority <=> self.priority
+    def <=>(other)
+      other.priority <=> priority
     end
 
     def solemnity?

data/lib/calendarium-romanum/sanctorale.rb

@@ -66,7 +66,7 @@ module CalendariumRomanum
       end
 
       date = AbstractDate.new(month, day)
-      return @days[date] || []
+      @days[date] || []
     end
 
     # for each day for which an entry is available
@@ -88,7 +88,7 @@ module CalendariumRomanum
 
     def freeze
       @days.freeze
-      @days.values.each &:freeze
+      @days.values.each(&:freeze)
       @solemnities.freeze
       super
     end

data/lib/calendarium-romanum/sanctoraleloader.rb

@@ -12,22 +12,22 @@ module CalendariumRomanum
   class SanctoraleLoader
 
     RANK_CODES = {
-                  nil => Ranks::MEMORIAL_OPTIONAL,
-                  'm' => Ranks::MEMORIAL_GENERAL,
-                  'f' => Ranks::FEAST_GENERAL,
-                  's' => Ranks::SOLEMNITY_GENERAL
-                 }
+      nil => Ranks::MEMORIAL_OPTIONAL,
+      'm' => Ranks::MEMORIAL_GENERAL,
+      'f' => Ranks::FEAST_GENERAL,
+      's' => Ranks::SOLEMNITY_GENERAL
+    }.freeze
     COLOUR_CODES = {
-                    nil => Colours::WHITE,
-                    'w' => Colours::WHITE,
-                    'v' => Colours::VIOLET,
-                    'g' => Colours::GREEN,
-                    'r' => Colours::RED
-                   }
+      nil => Colours::WHITE,
+      'w' => Colours::WHITE,
+      'v' => Colours::VIOLET,
+      'g' => Colours::GREEN,
+      'r' => Colours::RED
+    }.freeze
 
     # dest should be a Sanctorale,
     # src anything with #each_line
-    def load(src, dest=nil)
+    def load(src, dest = nil)
       dest ||= Sanctorale.new
 
       in_front_matter = false
@@ -51,7 +51,7 @@ module CalendariumRomanum
         next if l.empty?
 
         # month section heading
-        n = l.match /^=\s*(\d+)\s*$/
+        n = l.match(/^=\s*(\d+)\s*$/)
         unless n.nil?
           month_section = n[1].to_i
           unless month_section >= 1 && month_section <= 12
@@ -61,10 +61,9 @@ module CalendariumRomanum
         end
 
         # celebration record
-        m = l.match /^((\d+)\/)?(\d+)\s*(([mfs])?(\d\.\d{1,2})?)?\s*([WVRG])?\s*:(.*)$/i
+        m = l.match(/^((\d+)\/)?(\d+)\s*(([mfs])?(\d\.\d{1,2})?)?\s*([WVRG])?\s*:(.*)$/i)
         if m.nil?
           raise error("Syntax error, line skipped '#{l}'", line_num)
-          next
         end
 
         month, day, rank_char, rank_num, colour, title = m.values_at(2, 3, 5, 6, 7, 8)
@@ -90,26 +89,34 @@ module CalendariumRomanum
           rank = rank_by_num
         end
 
-        dest.add month, day, Celebration.new(
-                                             title.strip,
-                                             rank,
-                                             COLOUR_CODES[colour && colour.downcase]
-                                            )
+        begin
+          dest.add(
+            month,
+            day,
+            Celebration.new(
+              title.strip,
+              rank,
+              COLOUR_CODES[colour && colour.downcase]
+            )
+          )
+        rescue RangeError => err
+          raise error(err.message, line_num)
+        end
       end
 
       dest
     end
 
-    alias_method :load_from_string, :load
+    alias load_from_string load
 
-    def load_from_file(filename, dest=nil, encoding='utf-8')
-      self.load File.open(filename, 'r', encoding: encoding), dest
+    def load_from_file(filename, dest = nil, encoding = 'utf-8')
+      load File.open(filename, 'r', encoding: encoding), dest
     end
 
     private
 
     def error(message, line_number)
-      RuntimeError.new("L#{line_number}: #{message}")
+      InvalidDataError.new("L#{line_number}: #{message}")
     end
   end
 end

data/lib/calendarium-romanum/temporale.rb

@@ -33,13 +33,13 @@ module CalendariumRomanum
           return year - 1
         end
 
-        return year
+        year
       end
 
       # creates a Calendar for the liturgical year including given
       # date
       def for_day(date)
-        return new(liturgical_year(date))
+        new(liturgical_year(date))
       end
 
       C = Struct.new(:date_method, :celebration)
@@ -49,43 +49,37 @@ module CalendariumRomanum
       def celebrations
         @celebrations ||=
           begin
-            [
-              c(:nativity, Ranks::PRIMARY),
-              c(:holy_family, Ranks::FEAST_LORD_GENERAL),
-              c(:mother_of_god, Ranks::SOLEMNITY_GENERAL),
-              c(:epiphany, Ranks::PRIMARY),
-              c(:baptism_of_lord, Ranks::FEAST_LORD_GENERAL),
-              c(:ash_wednesday, Ranks::PRIMARY, Colours::VIOLET),
-              c(:good_friday, Ranks::TRIDUUM, Colours::RED),
-              c(:holy_saturday, Ranks::TRIDUUM, Colours::VIOLET),
-              c(:palm_sunday, Ranks::PRIMARY, Colours::RED),
-              c(:easter_sunday, Ranks::TRIDUUM),
-              c(:ascension, Ranks::PRIMARY),
-              c(:pentecost, Ranks::PRIMARY, Colours::RED),
-              c(:holy_trinity, Ranks::SOLEMNITY_GENERAL),
-              c(:corpus_christi, Ranks::SOLEMNITY_GENERAL),
-              c(:sacred_heart, Ranks::SOLEMNITY_GENERAL),
-              c(:christ_king, Ranks::SOLEMNITY_GENERAL),
-
-              # Immaculate Heart of Mary is actually (currently the only one)
-              # movable *sanctorale* feast, but as it would make little sense
-              # to add support for movable sanctorale feasts because of
-              # a single one, we cheat a bit and handle it in temporale.
-              c(:immaculate_heart, Ranks::MEMORIAL_GENERAL),
-            ]
+            %i(
+              nativity
+              holy_family
+              mother_of_god
+              epiphany
+              baptism_of_lord
+              ash_wednesday
+              good_friday
+              holy_saturday
+              palm_sunday
+              easter_sunday
+              ascension
+              pentecost
+              holy_trinity
+              corpus_christi
+              sacred_heart
+              christ_king
+              immaculate_heart
+            ).collect do |symbol|
+              date_method = symbol
+              C.new(
+                date_method,
+                CelebrationFactory.public_send(symbol)
+              )
+            end
+            # Immaculate Heart of Mary is actually (currently the only one)
+            # movable *sanctorale* feast, but as it would make little sense
+            # to add support for movable sanctorale feasts because of
+            # a single one, we cheat a bit and handle it in temporale.
           end
       end
-
-      private
-
-      def c(date_method, rank, colour=Colours::WHITE)
-        title = proc { I18n.t("temporale.solemnity.#{date_method}") }
-
-        C.new(
-          date_method,
-          Celebration.new(title, rank, colour)
-        )
-      end
     end
 
     def transferred_to_sunday?(solemnity)
@@ -97,7 +91,7 @@ module CalendariumRomanum
     end
 
     def end_date
-      Dates.first_advent_sunday(year+1) - 1
+      Dates.first_advent_sunday(year + 1) - 1
     end
 
     def date_range
@@ -113,26 +107,8 @@ module CalendariumRomanum
       end
     end
 
-    %i(
-    first_advent_sunday
-    nativity
-    holy_family
-    mother_of_god
-    epiphany
-    baptism_of_lord
-    ash_wednesday
-    palm_sunday
-    good_friday
-    holy_saturday
-    easter_sunday
-    ascension
-    pentecost
-    holy_trinity
-    corpus_christi
-    sacred_heart
-    immaculate_heart
-    christ_king
-    ).each do |feast|
+    (celebrations.collect(&:date_method) + [:first_advent_sunday])
+      .each do |feast|
       if SUNDAY_TRANSFERABLE_SOLEMNITIES.include? feast
         define_method feast do
           Dates.public_send feast, year, sunday: transferred_to_sunday?(feast)
@@ -152,20 +128,20 @@ module CalendariumRomanum
     def season(date)
       range_check date
 
-      if first_advent_sunday <= date and
-          nativity > date then
+      if (first_advent_sunday <= date) &&
+         nativity > date
         Seasons::ADVENT
 
-      elsif nativity <= date and
-          baptism_of_lord >= date then
+      elsif (nativity <= date) &&
+            (baptism_of_lord >= date)
         Seasons::CHRISTMAS
 
-      elsif ash_wednesday <= date and
-          easter_sunday > date then
+      elsif (ash_wednesday <= date) &&
+            easter_sunday > date
         Seasons::LENT
 
-      elsif easter_sunday <= date and
-          pentecost >= date then
+      elsif (easter_sunday <= date) &&
+            (pentecost >= date)
         Seasons::EASTER
 
       else
@@ -183,8 +159,10 @@ module CalendariumRomanum
         ash_wednesday
       when Seasons::EASTER
         easter_sunday
-      else # ordinary time
-        Dates.monday_after(baptism_of_lord)
+      when Seasons::ORDINARY # ordinary time
+        baptism_of_lord + 1
+      else
+        raise ArgumentError.new('unsupported season')
       end
     end
 
@@ -202,13 +180,13 @@ module CalendariumRomanum
         week += 1
 
         if date > pentecost
-          weeks_after_date = date_difference(Dates.first_advent_sunday(@year + 1), date) / 7
+          weeks_after_date = date_difference(Dates.first_advent_sunday(@year + 1), date) / WEEK
           week = 34 - weeks_after_date
           week += 1 if date.sunday?
         end
       end
 
-      return week
+      week
     end
 
     # returns a Celebration
@@ -226,7 +204,7 @@ module CalendariumRomanum
         end
       end
 
-      return @solemnities[date] || @feasts[date] || sunday(date) || @memorials[date] || ferial(date)
+      @solemnities[date] || @feasts[date] || sunday(date) || @memorials[date] || ferial(date)
     end
 
     private
@@ -246,7 +224,7 @@ module CalendariumRomanum
       week = Ordinalizer.ordinal season_week(seas, date)
       title = I18n.t "temporale.#{seas.to_sym}.sunday", week: week
 
-      return Celebration.new title, rank, seas.colour
+      Celebration.new title, rank, seas.colour
     end
 
     def ferial(date)
@@ -258,6 +236,8 @@ module CalendariumRomanum
       when Seasons::ADVENT
         if date >= Date.new(@year, 12, 17)
           rank = Ranks::FERIAL_PRIVILEGED
+          nth = Ordinalizer.ordinal(date.day)
+          title = I18n.t 'temporale.advent.before_christmas', day: nth
         end
       when Seasons::CHRISTMAS
         if date < mother_of_god
@@ -266,32 +246,32 @@ module CalendariumRomanum
           nth = Ordinalizer.ordinal(date.day - nativity.day + 1) # 1-based counting
           title = I18n.t 'temporale.christmas.nativity_octave.ferial', day: nth
         elsif date > epiphany
-          title = I18n.t "temporale.christmas.after_epiphany.ferial", weekday: I18n.t("weekday.#{date.wday}")
+          title = I18n.t 'temporale.christmas.after_epiphany.ferial', weekday: I18n.t("weekday.#{date.wday}")
         end
       when Seasons::LENT
         if week == 0
-          title = I18n.t "temporale.lent.after_ashes.ferial", weekday: I18n.t("weekday.#{date.wday}")
+          title = I18n.t 'temporale.lent.after_ashes.ferial', weekday: I18n.t("weekday.#{date.wday}")
         elsif date > palm_sunday
           rank = Ranks::PRIMARY
-          title = I18n.t "temporale.lent.holy_week.ferial", weekday: I18n.t("weekday.#{date.wday}")
+          title = I18n.t 'temporale.lent.holy_week.ferial', weekday: I18n.t("weekday.#{date.wday}")
         end
         rank = Ranks::FERIAL_PRIVILEGED unless rank > Ranks::FERIAL_PRIVILEGED
       when Seasons::EASTER
         if week == 1
           rank = Ranks::PRIMARY
-          title = I18n.t "temporale.easter.octave.ferial", weekday: I18n.t("weekday.#{date.wday}")
+          title = I18n.t 'temporale.easter.octave.ferial', weekday: I18n.t("weekday.#{date.wday}")
         end
       end
 
       week_ord = Ordinalizer.ordinal week
       title ||= I18n.t "temporale.#{seas.to_sym}.ferial", week: week_ord, weekday: I18n.t("weekday.#{date.wday}")
 
-      return Celebration.new title, rank, seas.colour
+      Celebration.new title, rank, seas.colour
     end
 
     # helper: difference between two Dates in days
     def date_difference(d1, d2)
-      return (d1 - d2).numerator
+      (d1 - d2).numerator
     end
 
     # prepare dates of temporale solemnities
@@ -317,11 +297,12 @@ module CalendariumRomanum
     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
+      date =
+        if date_method.respond_to? :call
+          date_method.call(year)
+        else
+          public_send(date_method)
+        end
 
       add_to =
         if celebration.feast?