calendarium-romanum 0.4.0 → 0.8.0

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run specs with each fully supported locale'
+task :spec_all_locales do
+  %w(en la cs fr it).each do |locale|
+    sh "LOCALE=#{locale} rake spec"
+  end
+end
+
+desc 'Generates calendar dumps for regression tests anew'
+task :regression_refresh do
+  2020.upto(2030).each do |year|
+    sh "ruby -Ilib bin/calendariumrom dump #{year} > spec/regression_dumps/#{year}.txt"
+  end
+end

data/bin/calendariumrom

@@ -1,6 +1,9 @@
-#!/bin/env ruby
+#!/usr/bin/env ruby
 
 require 'calendarium-romanum'
 require 'calendarium-romanum/cli'
 
+# Don't warn about enforcing locales in the CLI.
+I18n.config.enforce_available_locales = true
+
 CalendariumRomanum::CLI.start ARGV

data/calendarium-romanum.gemspec

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+require_relative 'lib/calendarium-romanum/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'calendarium-romanum'
+  s.version     = CalendariumRomanum::VERSION
+  s.date        = CalendariumRomanum::RELEASE_DATE.to_s
+  s.summary     = 'Roman Catholic liturgical calendar computations'
+
+  s.description = 'calendar computations according to the Roman Catholic liturgical calendar as instituted by MP Mysterii Paschalis of Paul VI (1969) and defined in General Norms for the Liturgical Year and the Calendar and other documents of liturgical legislation.'
+
+  s.authors     = ['Jakub Pavlík']
+  s.email       = 'jkb.pavlik@gmail.com'
+  s.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.executables = %w(calendariumrom)
+  s.homepage    = 'http://github.com/igneus/calendarium-romanum'
+  s.licenses    = ['LGPL-3.0', 'MIT']
+  s.metadata = {
+    'documentation_uri' => 'https://www.rubydoc.info/gems/calendarium-romanum/',
+  }
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.add_dependency 'thor', '~> 0.18'
+  s.add_dependency 'i18n', '~> 0.6'
+  s.add_dependency 'roman-numerals', '~> 0.3'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.5'
+end

data/config/locales/cs.yml

@@ -4,6 +4,7 @@ cs:
       advent: Doba adventní
       christmas: Doba vánoční
       lent: Doba postní
+      triduum: Velikonoční triduum
       easter: Doba velikonoční
       ordinary: Liturgické mezidobí
     solemnity:
@@ -22,16 +23,20 @@ cs:
       holy_trinity: Nejsvětější Trojice
       corpus_christi: Těla a krve Páně
       sacred_heart: Nejsvětějšího srdce Ježíšova
+      mother_of_church: Panny Marie, Matky církve
       immaculate_heart: Neposkvrněného Srdce Panny Marie
       christ_king: Ježíše Krista krále
+      saturday_memorial_bvm: Sobotní památka Panny Marie
     extension:
       christ_eternal_priest: Ježíše Krista, nejvyššího a věčného kněze
+      dedication: Výročí posvěcení kostela
     ordinary:
       sunday: '%{week} neděle v mezidobí'
       ferial: '%{weekday} %{week} týdne v mezidobí'
     advent:
       sunday: '%{week} neděle adventní'
       ferial: '%{weekday} po %{week} neděli adventní'
+      before_christmas: '%{day} prosince'
     christmas:
       nativity_octave:
         ferial: '%{day} den v oktávu Narození Páně'

data/config/locales/en.yml

@@ -4,32 +4,39 @@ en:
       advent: Advent
       christmas: Christmas Season
       lent: Lent
+      triduum: Easter Triduum
       easter: Easter Season
       ordinary: Ordinary Time
     solemnity:
-      nativity: The Nativity of the Lord
-      holy_family: The Holy Family of Jesus, Mary and Joseph
-      mother_of_god: Octave Day of Christmas, of Mary, Mother of God
-      epiphany: The Epiphany of the Lord
+      nativity: Christmas
+      holy_family: The Holy Family
+      mother_of_god: Mary, Mother of God (Octave of Christmas)
+      epiphany: The Epiphany
       baptism_of_lord: The Baptism of the Lord
       ash_wednesday: Ash Wednesday
-      palm_sunday: Palm Sunday of the Passion of the Lord
-      good_friday: Friday of the Passion of the Lord
+      palm_sunday: Passion Sunday (Palm Sunday)
+      good_friday: Good Friday
       holy_saturday: Holy Saturday
-      easter_sunday: Easter Sunday of the Resurrection of the Lord
-      ascension: Ascension of the Lord
-      pentecost: Pentecost Sunday
-      holy_trinity: The Most Holy Trinity
-      corpus_christi: The Most Holy Body and Blood of Christ
-      sacred_heart: The Most Sacred Heart of Jesus
-      immaculate_heart: Immaculate Heart of Mary
-      christ_king: Our Lord Jesus Christ, King of the Universe
+      easter_sunday: Easter Sunday
+      ascension: The Ascension
+      pentecost: Pentecost
+      holy_trinity: Trinity Sunday
+      corpus_christi: Corpus Christi (The Body and Blood of Christ)
+      sacred_heart: The Sacred Heart of Jesus
+      mother_of_church: Mary, Mother of the Church
+      immaculate_heart: The Immaculate Heart of Mary
+      christ_king: Christ The King
+      saturday_memorial_bvm: The Memorial of the Blessed Virgin Mary on Saturday
+    extension:
+      christ_eternal_priest: Our Lord Jesus Christ, The Eternal High Priest
+      dedication: Anniversary of Dedication
     ordinary:
       sunday: '%{week} Sunday in Ordinary Time'
       ferial: '%{weekday}, %{week} week in Ordinary Time'
     advent:
       sunday: '%{week} Sunday of Advent'
       ferial: '%{weekday}, %{week} week of Advent'
+      before_christmas: '%{day} December'
     christmas:
       nativity_octave:
         ferial: '%{day} day of Christmas Octave'

data/config/locales/es.yml

@@ -0,0 +1,94 @@
+es:
+  temporale:
+    season:
+      advent: Adviento
+      christmas: Navidad
+      lent: Cuaresma
+      triduum: Triduo Pascual
+      easter: Pascua
+      ordinary: Tiempo Ordinario
+    solemnity:
+      nativity: Natividad
+      holy_family: La Sagrada Familia
+      mother_of_god: María, Madre de Dios (Octava de Navidad)
+      epiphany: La Epifanía
+      baptism_of_lord: El Bautismo del Señor
+      ash_wednesday: Miércoles de Ceniza
+      palm_sunday: Domingo de Ramos
+      good_friday: Viernes Santo
+      holy_saturday: Sábado Santo
+      easter_sunday: Domingo de Resurrección
+      ascension: La Ascensión
+      pentecost: Pentecostés
+      holy_trinity: Domingo de Trinidad
+      corpus_christi: Corpus Christi (Cuerpo y Sangre de Cristo)
+      sacred_heart: El Sagrado Corazón de Jesús
+      mother_of_church: María, Madre de la Iglesia
+      immaculate_heart: El Inmaculado Corazón de María
+      christ_king: Cristo Rey
+      saturday_memorial_bvm: The Memorial of the Blessed Virgin Mary on Saturday
+    extension:
+      christ_eternal_priest: Jesucristo, Sumo y Eterno Sacerdote
+      dedication: Aniversario Dedicación de la iglesia
+    ordinary:
+      sunday: '%{week} Domingo del Tiempo Ordinario'
+      ferial: '%{weekday}, %{week} semana del Tiempo Ordinario'
+    advent:
+      sunday: '%{week} Domingo de Adviento'
+      ferial: '%{weekday}, %{week} semana de Adviento'
+      before_christmas: '%{day} de Diciembre'
+    christmas:
+      nativity_octave:
+        ferial: '%{day} día de la Octava de Navidad'
+      sunday: '%{week} Sunday después de la Natividad del Señor'
+      ferial: '%{weekday} después de la Octava de Navidad'
+      after_epiphany:
+        ferial: '%{weekday} después de la Epifanía'
+    lent:
+      after_ashes:
+        ferial: '%{weekday} después del Miércoles de Ceniza'
+      sunday: '%{week} Domingo de Cuaresma'
+      ferial: '%{weekday}, %{week} semana de Cuaresma'
+      holy_week:
+        ferial: '%{weekday} de la Semana Santa'
+    easter:
+      octave:
+        ferial: '%{weekday} de Pascua'
+      sunday: '%{week} Domingo de Pascua'
+      ferial: '%{weekday}, %{week} semana de Pascua'
+  rank:
+    '1_1': Triduo Pascual
+    '1_2': Días litúrgicos primarios
+    '1_3': Solemnidades en el Calendario General
+    '1_4': Solemnidades
+    '2_5': Fiestas del Señor en el Calendario General
+    '2_6': Unprivileged Sundays
+    '2_7': Fiestas de Santos en el Calendario General
+    '2_8': Fiestas
+    '2_9': Días Privilegiados
+    '3_10': Memorias Obligatorias en el Calendario General
+    '3_11': Memorias Obligatorias
+    '3_12': Memorias Opcionales
+    '3_13': Días
+    '4_0': Conmemoraciones
+    short:
+      solemnity: solemnidad
+      feast: fiesta
+      sunday: Domingo
+      memorial: memoria
+      memorial_opt: memoria opcional
+      ferial: ferial
+      commemoration: conmemoración
+  weekday:
+    '0': Domingo
+    '1': Lunes
+    '2': Martes
+    '3': Miércoles
+    '4': Jueves
+    '5': Viernes
+    '6': Sábado
+  colour:
+    violet: violeta
+    white: blanco
+    green: verde
+    red: rojo

data/config/locales/fr.yml

@@ -4,6 +4,7 @@ fr:
       advent: "Temps de l'Avent"
       christmas: Temps de Noël
       lent: Temps du Carême
+      triduum: Triduum pascal
       easter: Temps de Pâques
       ordinary: Temps ordinaire
     solemnity:
@@ -22,14 +23,20 @@ fr:
       holy_trinity: La Très Sainte Trinité
       corpus_christi: Le Très Saint Corps et Sang du Christ
       sacred_heart: Le Sacré-Coeur de Jésus
+      mother_of_church: Sainte Marie, Mère de l’Eglise
       immaculate_heart: Le Coeur Immaculé de Marie
       christ_king: Notre Seigneur Jésus Christ, Roi de l'Univers
+      saturday_memorial_bvm: Mémoire de Sainte-Marie le samedi
+    extension:
+      christ_eternal_priest: Jésus Christ, prêtre éternel et souverain
+      dedication: Anniversaire de la Dédicace de l'église
     ordinary:
       sunday: '%{week} Dimanche de Temps Ordinaire'
       ferial: '%{weekday}, %{week} semaine de Temps Ordinaire'
     advent:
       sunday: '%{week} Dimanche de l''Avent'
       ferial: '%{weekday}, %{week} semaine de L''Avent'
+      before_christmas: '%{day} décembre'
     christmas:
       nativity_octave:
         ferial: 'Jour %{day} de l''Octave de Noël'

data/config/locales/it.yml

@@ -4,6 +4,7 @@ it:
       advent: Tempo di Avvento
       christmas: Tempo di Natale
       lent: Tempo di Quaresima
+      triduum: Triduo Pasquale
       easter: Tempo pasquale
       ordinary: Tempo ordinario
     solemnity:
@@ -22,14 +23,20 @@ it:
       holy_trinity: Santissima Trinità
       corpus_christi: Santissimo Corpo e Sangue di Cristo
       sacred_heart: Sacro Cuore di Gesù
+      mother_of_church: Maria Madre della Chiesa
       immaculate_heart: Cuore Immacolato di Maria
       christ_king: "Nostro Signore Gesù Cristo Re dell'universo"
+      saturday_memorial_bvm: Memoria di santa Maria in sabato
+    extension:
+      christ_eternal_priest: Nostro Signore Gesù Cristo Sommo e Eterno Sacerdote # I didn't find an official translation anywhere (as the feast is not celebrated in Italy) and had to translate myself - readers proficient in Italian are kindly asked for a check
+      dedication: Anniversario della Dedicazione della chiesa
     ordinary:
       sunday: '%{week} Domenica del Tempo Ordinario'
       ferial: '%{weekday} della %{week} settimana del Tempo Ordinario'
     advent:
       sunday: '%{week} Domenica Avvento'
       ferial: '%{weekday}, %{week} Avvento'
+      before_christmas: '%{day} dicembre'
     christmas:
       nativity_octave:
         ferial: '%{day}, Ottava di Natale'

data/config/locales/la.yml

@@ -4,6 +4,7 @@ la:
       advent: Tempus Adventus
       christmas: Tempus Nativitatis
       lent: Tempus Quadragesimae
+      triduum: Triduum Paschale
       easter: Tempus Paschale
       ordinary: Tempus per annum
     solemnity:
@@ -22,14 +23,20 @@ la:
       holy_trinity: Sanctissimae Trinitatis
       corpus_christi: Sanctissimi Corporis et Sanguinis Christi
       sacred_heart: Sacratissimi Cordis Iesu
+      mother_of_church: B. Mariae Virginis Ecclesiae Matris
       immaculate_heart: Immaculati Cordis B. Mariae Virginis
       christ_king: Domini nostri Iesu Christi universorum regis
+      saturday_memorial_bvm: Memoria Sanctae Mariae in Sabbato
+    extension:
+      christ_eternal_priest: Domini nostri Iesu Christi Summi et Aeterni Sacerdotis
+      dedication: Anniversarium dedicationis ecclesiae
     ordinary:
       sunday: 'Dominica %{week} per annum'
       ferial: '%{weekday}, hebdomada %{week} per annum'
     advent:
       sunday: 'Dominica %{week} Adventus'
       ferial: '%{weekday}, hebdomada %{week} Adventus'
+      before_christmas: 'Die %{day} decembris'
     christmas:
       nativity_octave:
         ferial: 'De die %{day} infra octavam Nativitatis'

data/data/README.md

@@ -23,7 +23,7 @@ a number from range 1-12.
 A calendar entry is a line of this format:
 
 ```
-[MONTH/]DAY [RANK] [COLOUR] : TITLE
+[MONTH/]DAY [RANK] [COLOUR] [IDENTIFIER] : TITLE
 ```
 
 If the calendar entry is preceded by a month heading, MONTH is
@@ -33,25 +33,27 @@ DAY must be a number valid as a possible date in the given month.
 (29 is valid in February, as it sometimes occurs;
 31 is not valid in April, as there is never April 31st.)
 
-RANK is a single letter m=memorial, f=feast, s=solemnity.
-If omitted, optional memorial is assumed.
-
-When it is desirable to specify rank of a celebration
-with greater precision, e.g. in order to distinguish feasts
-inscribed in the General Roman Calendar from proper feasts,
-use rank number instead of a rank letter.
-Rank priority numbers are defined in
-[lib/calendarium-romanum/enums.rb](../lib/calendarium-romanum/enums.rb)
-and correspond to section and subsection numbers in
-the Table of Liturgical Days
-(see end of the [General Norms](https://www.ewtn.com/library/CURIA/CDWLITYR.HTM)).
-This is why the sequence is non-continuous:
-`1.4` is followed by `2.5` and `2.9` by `3.10`.
+RANK is a rank code, which can have several forms:
+
+1. *no* rank code - optional memorial will be assumed
+1. single letter: `m` = memorial, `f` = feast, `s` = solemnity
+1. rank priority number, e.g. `1.3` (defined in
+   [lib/calendarium-romanum/enums.rb](../lib/calendarium-romanum/enums.rb),
+   and correspond to section and subsection numbers in the Table of Liturgical Days
+   in the [General Norms](https://www.ewtn.com/library/CURIA/CDWLITYR.HTM))
+1. letter and a priority number, e.g. `s1.3`
+1. letter with a specifying suffix, e.g. `sp`: suffix `p` distinguishes
+   proper solemnities/feasts/memorials from those inscribed in the General
+   Roman Calendar, suffix `l` (only allowed in combination `fl`)
+   distinguishes feasts of the Lord from other feasts inscribed
+   in the General Roman Calendar.
+
+Single letter codes are used to encode ranks of most celebrations
+inscribed in the General Roman Calendar, the other forms for other
+ranks (proper celebrations, feasts of the Lord etc.).
 
 The example below presents pairs of equivalent lines,
 the first one specifying rank by letter, the second one by number.
-Rank letters are always interpreted as if the celebration
-was inscribed in the General Roman Calendar.
 
 ```
 3/19 s : Saint Joseph Husband of the Blessed Virgin Mary
@@ -69,20 +71,22 @@ was inscribed in the General Roman Calendar.
 
 As an example of a proper celebration (which requires rank number
 when exact ranking is important) let's use solemnity of the
-principal patron of Bohemia, martyr duke St. Wenceslas:
+principal patron of Bohemia, martyr duke St. Wenceslas
+(three alternative ways to encode the same rank of a proper solemnity):
 
 ```
 9/28 1.4 R : Sv. Václava, mučedníka, hlavního patrona českého národa
+9/28 s1.4 R : Sv. Václava, mučedníka, hlavního patrona českého národa
+9/28 sp R : Sv. Václava, mučedníka, hlavního patrona českého národa
 ```
 
-When you have dificulties remembering meanings of the numbers,
-but are comfortable with rank letters, it might be helpful for you
-to use rank numbers *alongside* the letters.
-This is supported too, you will find this format used throughout
-the bundled data files.
+Feasts of the Lord similarly require a more specific rank code
+than the general `f`:
 
 ```
-9/28 s1.4 R : Sv. Václava, mučedníka, hlavního patrona českého národa
+11/9 2.5 lateran_basilica : Dedication of the Lateran basilica
+11/9 f2.5 lateran_basilica : Dedication of the Lateran basilica
+11/9 fl lateran_basilica : Dedication of the Lateran basilica
 ```
 
 COLOUR is a single letter R=red, W=white (G=green, V=violet normally
@@ -92,8 +96,47 @@ If not specified, white is default.
 
 TITLE is a simple text - title of the celebration - without formatting.
 
+IDENTIFIER is a single "word" consisting of lowercase letters and
+underscores, at least 2 characters long.
+It is optional and serves as a unique machine-readable identifier
+of the given celebration.
+
 There may be several entries for a day (optional memorials).
 
+### YAML metadata
+
+At the beginning of the file there may be a "YAML front matter"
+(cf. [use of YFM in Jekyll][yfm]) -
+a YAML document with arbitrary metadata.
+The front matter is parsed when loading the data file
+and it's contents are available to the application code
+in `Sanctorale#metadata`.
+
+Top-level structure of the document should be a Hash
+(or "mapping" in the [YAML specification][yamlspec]'s vocabulary).
+It may contain whatever the author finds useful.
+A few fields are suggested:
+
+* `title` - name of the calendar in the language of it's contents
+  (suitable for the end user)
+* `description` - description of the contents in English (suitable for
+  people who may not understand the language of the contents,
+  e.g. maintainers of multi-language calendar applications)
+* `locale` - 2-character code of the content's language
+  (may be used by applications to automatically select a matching
+  locale for temporale feast names)
+* `country` - ISO 3166 alpha2 country code (only for country-specific
+  data)
+* `province` - name of ecclesiastical province (only for
+  province-specific data)
+* `diocese` - name of diocese (only for diocese-specific data)
+* `extends` - either String or (if multiple parents are needed)
+  Array ("sequence" in the [YAML specification][yamlspec]'s vocabulary)
+  of more general data file(s) the given file extends
+  (usually as relative filesystem paths; can be used by applications
+  to automatically load hierarchies of sanctorale data -
+  see `SanctoraleFactory.load_with_parents`)
+
 ## Check your data
 
 Included is a script controlling correctness of data files
@@ -143,3 +186,6 @@ end
 
 layered_sanctorale = CR::SanctoraleFactory.create_layered(*layers)
 ```
+
+[yfm]: https://jekyllrb.com/docs/front-matter/
+[yamlspec]: https://yaml.org/spec/1.2/spec.html