calendarium-romanum 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ee4894a3821935522076c8a8c749be997e243ee
+  data.tar.gz: bbc5bc6e3c9dd24427eac5d9bef2fa51a73122e3
+SHA512:
+  metadata.gz: 0d38d06d95abf7994515a338fff2cf2b08970b2a19952eb39132ccc058f4c2e19e6673267461a4fd0e41dd4e95618cc2a8067981ded24c9477f27743bdd8c5f3
+  data.tar.gz: 79b0b9fa0aaaf6f1a2fbec31661b53c15b38fd4b60e23d8585813cbc61c4b3f73dd5a8978d6e52deda6e76be19c2833f73d92ba92ba93fa9e88f7899589e67ca

data/bin/calendariumrom

@@ -0,0 +1,65 @@
+#!/bin/env ruby
+
+require 'thor'
+require 'calendarium-romanum'
+require 'log4r'
+
+module CalendariumRomanum
+
+  class CLI < Thor
+    include CalendariumRomanum::Util
+
+    desc 'errors FILE1, ...', 'finds errors in sanctorale data files'
+    def errors(*files)
+      logger = Log4r::Logger['CalendariumRomanum::SanctoraleLoader']
+      logger.outputters << Log4r::StderrOutputter.new('stderr')
+
+      loader = SanctoraleLoader.new
+      files.each do |path|
+        s = Sanctorale.new
+        loader.load_from_file s, path
+      end
+    end
+
+    desc 'cmp FILE1, FILE2', 'detect differences in rank and colour of corresponding celebrations'
+    def rccompare(a, b)
+      loader = SanctoraleLoader.new
+      sanctorales = []
+
+      [a, b].each do |source|
+        s = Sanctorale.new
+        loader.load_from_file s, source
+        sanctorales << s
+      end
+
+      Year.new(1990).each_day do |d|
+        celebs = sanctorales.collect {|s| s.get d.month, d.day }
+        if celebs.find {|cc| cc.nil? }
+          next
+        end
+
+        celebs[0].each_index do |i|
+          if i >= celebs[1].size
+            break
+          end
+
+          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
+            puts
+          end
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  CalendariumRomanum::CLI.start ARGV
+end

data/lib/calendarium-romanum.rb

@@ -0,0 +1,13 @@
+%w{
+enums
+calendar
+temporale
+sanctorale
+sanctoraleloader
+transfers
+day
+abstract_date
+util
+}.each do |f| 
+  require_relative File.join('calendarium-romanum', f) 
+end

data/lib/calendarium-romanum/abstract_date.rb

@@ -0,0 +1,59 @@
+module CalendariumRomanum
+
+  # a date not bound to a particular year
+  class AbstractDate
+    include Comparable
+
+    def initialize(month, day)
+      validate! month, day
+      @month = month
+      @day = day
+    end
+
+    attr_reader :month, :day
+
+    def <=>(other)
+      if month != other.month
+        month <=> other.month
+      else
+        day <=> other.day
+      end
+    end
+
+    def hash
+      (month * 100 + day).hash
+    end
+
+    def eql?(other)
+      month == other.month && day == other.day
+    end
+
+    def concretize(year)
+      Date.new(year, month, day)
+    end
+
+    private
+
+    def validate!(month, day)
+      unless month >= 1 && month <= 12
+        raise RangeError.new("Invalid month #{month}.")
+      end
+
+      day_lte = case month
+                when 2
+                  28
+                when 1, 3, 5, 7, 8, 10, 12
+                  31
+                else
+                  30
+                end
+
+      unless day > 0 && day <= 31
+        raise RangeError.new("Invalid day #{day}.")
+      end
+      unless day <= day_lte
+        raise RangeError.new("Invalid day #{day} for month #{month}.")
+      end
+    end
+  end
+end

data/lib/calendarium-romanum/calendar.rb

@@ -0,0 +1,130 @@
+require 'date'
+require 'forwardable'
+
+module CalendariumRomanum
+
+  # Provides complete information concerning a liturgical year,
+  # it's days and celebrations occurring on them.
+  class Calendar
+
+    extend Forwardable
+
+    # year: Integer
+    # returns a calendar for the liturgical year beginning with
+    # Advent of the specified civil year.
+    def initialize(year, sanctorale=nil)
+      @year = year
+      @temporale = Temporale.new(year)
+      @sanctorale = sanctorale || Sanctorale.new
+      @transferred = Transfers.new(@temporale, @sanctorale)
+    end
+
+    class << self
+      def mk_date(*args)
+        ex = TypeError.new('Date, DateTime or three Integers expected')
+
+        if args.size == 3 then
+          args.each do |a|
+            unless a.is_a? Integer
+              raise ex
+            end
+          end
+          return Date.new *args
+
+        elsif args.size == 1 then
+          a = args.first
+          unless a.is_a? Date or a.is_a? DateTime
+            raise ex
+          end
+          return a
+
+        else
+          raise ex
+        end
+      end
+
+      # creates a Calendar for the liturgical year including given
+      # date
+      def for_day(date, sanctorale=nil)
+        return new(Temporale.liturgical_year(date), sanctorale)
+      end
+    end # class << self
+
+    def_delegators :@temporale, :range_check, :season
+    attr_reader :year
+    attr_reader :temporale
+    attr_reader :sanctorale
+
+    # returns a Calendar for the subsequent year
+    def succ
+      c = Calendar.new @year + 1, @sanctorale
+      return c
+    end
+
+    # returns a Calendar for the previous year
+    def pred
+      c = Calendar.new @year - 1, @sanctorale
+      return c
+    end
+
+    def ==(obj)
+      unless obj.is_a? Calendar
+        return false
+      end
+
+      return year == obj.year
+    end
+
+    # returns filled Day for the specified day
+    def day(*args)
+      if args.size == 2
+        date = Date.new(@year, *args)
+        unless @temporale.date_range.include? date
+          date = Date.new(@year + 1, *args)
+        end
+      else
+        date = self.class.mk_date *args
+        range_check date
+      end
+
+      s = @temporale.season(date)
+      return Day.new(
+                     date: date,
+                     season: s,
+                     season_week: @temporale.season_week(s, date),
+                     celebrations: celebrations_for(date)
+                    )
+    end
+
+    # Sunday lectionary cycle
+    def lectionary
+      LECTIONARY_CYCLES[@year % 3]
+    end
+
+    # Ferial lectionary cycle
+    def ferial_lectionary
+      @year % 2 + 1
+    end
+
+    def celebrations_for(date)
+      tr = @transferred.get(date)
+      return [tr] if tr
+
+      t = @temporale.get date
+      st = @sanctorale.get date
+
+      unless st.empty?
+        if st.first.rank > t.rank
+          if st.first.rank == Ranks::MEMORIAL_OPTIONAL
+            st.unshift t
+            return st
+          else
+            return st
+          end
+        end
+      end
+
+      return [t]
+    end
+  end # class Calendar
+end

data/lib/calendarium-romanum/day.rb

@@ -0,0 +1,59 @@
+require 'forwardable'
+
+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
+    end
+
+    attr_reader :date
+
+    def weekday
+      date.wday
+    end
+
+    # one of the Seasons (Symbol)
+    attr_reader :season
+
+    # week of the season (Integer)
+    attr_reader :season_week
+
+    # an Array of Celebrations, possibly empty
+    attr_reader :celebrations
+
+    # Celebration of the following day if it has first vespers
+    attr_reader :vespers
+  end
+
+  # information on one particular celebration of the liturgical year
+  # (like a Sunday, feast or memorial);
+  # some days have no (ferial office is used), some have one,
+  # some have more among which one may and may not be chosen
+  class Celebration
+    extend Forwardable
+
+    def initialize(title='', rank=Ranks::FERIAL, colour=Colours::GREEN)
+      @title = title
+      @rank = rank
+      @colour = colour
+    end
+
+    attr_reader :rank
+    def_delegators :@rank, :solemnity?, :feast?, :memorial?
+
+    attr_reader :title
+
+    attr_reader :colour
+    alias_method :color, :colour
+  end
+end

data/lib/calendarium-romanum/enums.rb

@@ -0,0 +1,84 @@
+module CalendariumRomanum
+
+  module Seasons
+    ADVENT = :advent
+    CHRISTMAS = :christmas
+    LENT = :lent
+    EASTER = :easter
+    ORDINARY = :ordinary
+    # is Triduum Sacrum a special season? For now I count Friday and Saturday
+    # to the Lent, Sunday to the Easter time
+  end
+
+  LECTIONARY_CYCLES = [:A, :B, :C]
+
+  class Rank < Struct.new(:priority, :desc, :short_desc)
+    include Comparable
+
+    @@instances = {}
+
+    def initialize(*args)
+      super(*args)
+
+      @@instances[self.priority] = self
+    end
+
+    def <=>(b)
+      b.priority <=> self.priority
+    end
+
+    alias_method :to_f, :priority
+    alias_method :to_s, :desc
+
+    def self.[](priority)
+      @@instances[priority]
+    end
+
+    def solemnity?
+      priority.to_i == 1
+    end
+
+    def feast?
+      priority.to_i == 2
+    end
+
+    def memorial?
+      priority.to_i == 3
+    end
+  end
+
+  # ranks of celebrations
+  module Ranks
+    # Values are at the same time references to sections
+    # of the Table of Liturgical Days.
+    # The lower value, the higher rank.
+    TRIDUUM           = Rank.new 1.1, 'Easter triduum'
+    PRIMARY           = Rank.new 1.2, 'Primary liturgical days' # description may not be exact
+    SOLEMNITY_GENERAL = Rank.new 1.3, 'Solemnities in the General Calendar', 'solemnity' # description may not be exact
+    SOLEMNITY_PROPER  = Rank.new 1.4, 'Proper solemnities', 'solemnity'
+
+    FEAST_LORD_GENERAL  = Rank.new 2.5, 'Feasts of the Lord in the General Calendar', 'feast'
+    SUNDAY_UNPRIVILEGED = Rank.new 2.6, 'Unprivileged Sundays'
+    FEAST_GENERAL       = Rank.new 2.7, 'Feasts of saints in the General Calendar', 'feast'
+    FEAST_PROPER        = Rank.new 2.8, 'Proper feasts', 'feast'
+    FERIAL_PRIVILEGED   = Rank.new 2.9, 'Privileged ferials'
+
+    MEMORIAL_GENERAL  = Rank.new 3.10, 'Obligatory memorials in the General Calendar', 'memorial'
+    MEMORIAL_PROPER   = Rank.new 3.11, 'Proper obligatory memorials', 'memorial'
+    MEMORIAL_OPTIONAL = Rank.new 3.12, 'Optional memorials', 'optional memorial'
+    FERIAL            = Rank.new 3.13, 'Unprivileged ferials', 'ferial'
+
+    def self.[](priority)
+      Rank[priority]
+    end
+  end
+
+  module Colours
+    GREEN = :green
+    VIOLET = :violet
+    WHITE = :white
+    RED = :red
+  end
+
+  Colors = Colours
+end

data/lib/calendarium-romanum/sanctorale.rb

@@ -0,0 +1,80 @@
+module CalendariumRomanum
+
+  # knows the fixed-date celebrations
+  class Sanctorale
+
+    def initialize
+      @days = {}
+
+      @solemnities = {}
+    end
+
+    attr_reader :solemnities
+
+    def add(month, day, celebration)
+      date = AbstractDate.new(month, day)
+      unless @days.has_key? date
+        @days[date] = []
+      end
+
+      if celebration.solemnity?
+        @solemnities[date] = celebration
+      end
+
+      @days[date] << celebration
+    end
+
+    # replaces content of the given day by given celebrations
+    def replace(month, day, celebrations)
+      date = AbstractDate.new(month, day)
+
+      if celebrations.first.solemnity?
+        @solemnities[date] = celebrations.first
+      elsif @solemnities.has_key? date
+        @solemnities.delete date
+      end
+
+      @days[date] = celebrations
+    end
+
+    # adds all Celebrations from another instance
+    def update(sanctorale)
+      sanctorale.each_day do |date, celebrations|
+        replace date.month, date.day, celebrations
+      end
+    end
+
+    # returns an Array with one or more Celebrations
+    # scheduled for the given day
+    #
+    # expected arguments: Date or two Integers (month, day)
+    def get(*args)
+      if args.size == 1 && args[0].is_a?(Date)
+        month = args[0].month
+        day = args[0].day
+      else
+        month, day = args
+      end
+
+      date = AbstractDate.new(month, day)
+      return @days[date] || []
+    end
+
+    # for each day for which an entry is available
+    # yields an AbstractDate and an Array of Celebrations
+    def each_day
+      @days.each_pair do |date, celebrations|
+        yield date, celebrations
+      end
+    end
+
+    # returns count of the _days_ with celebrations filled
+    def size
+      @days.size
+    end
+
+    def empty?
+      @days.empty?
+    end
+  end
+end