calendarium-romanum 0.4.0 → 0.8.0

data/liturgical_law/2006_notification.md

@@ -0,0 +1,37 @@
+---
+source: Notitiae 475-476/2006, p. 96 http://www.cultodivino.va/content/dam/cultodivino/notitiae/2006/475-476%20DEF.pdf#page=34
+note: |
+  Not an act of liturgical legislation in a proper sense, but an authoritative example
+  of correct application of the law in force.
+---
+
+CONGREGATIO DE CULTU DIVINO ET DISCIPLINA SACRAMENTORUM
+
+NOTIFICAZIONE
+
+La Congregazione per il Culto Divino e la Disciplina dei Sacramenti si fa premura
+di attirare l’attenzione sulla occorrenza di alcune celebrazioni che ricorreranno
+nell’anno 2008. In particolare, si fa presente che la solennità di San Giuseppe (19 marzo)
+ricorre il mercoledì della Settimana Santa e la solennità dell’Annunciazione del Signore
+(25 marzo) il martedì fra l’Ottava di Pasqua.
+
+Secondo la normativa vigente contenuta nelle Normae Universales de Anno Liturgico
+et de Calendario, le summenzionate solennità devono essere trasferite in tal modo:
+« Sollemnitas S. Ioseph, ubi est de praecepto servanda, si cum Dominica
+in Palmis de Passione Domini occurrit, anticipatur sabbato praecedenti, die 18 martii.
+Ubi vero non est de praecepto servanda, a Conferentia Episcoporum ad alium diem
+extra Quadragesimam transferri potest » (n. 56 f);
+« Sollemnitas vero Annuntiationis Domini, quotiescumque occurrit aliquo die Hebdomadae
+Sanctae, semper ad feriam II post dominicam II Paschae erit transferenda » (n. 60).
+
+Pertanto, è stabilito che nell’anno 2008 la solennità di San Giuseppe sarà celebrata
+il 15 marzo, ovvero il sabato precedente la Domenica delle Palme, mentre la solennità
+dell’Annunciazione del Signore sarà celebrata il 31 marzo, ovvero il lunedì dopo
+la II Domenica di Pasqua.
+
+```ruby
+calendar = CR::PerpetualCalendar.new(sanctorale: CR::Data::GENERAL_ROMAN_LATIN.load)
+
+expect(calendar[Date.new(2008, 3, 15)].celebrations[0].symbol).to be :joseph
+expect(calendar[Date.new(2008, 3, 31)].celebrations[0].symbol).to be :annunciation
+```

data/liturgical_law/2012_declarationes.md

@@ -0,0 +1,38 @@
+---
+source: Notitiae 549-550/2012, p. 269; http://www.cultodivino.va/content/dam/cultodivino/notitiae/2012/549-550 DEF.pdf#page=80
+note: |
+  Not an act of liturgical legislation in a proper sense, but an authoritative example
+  of correct application of the law in force.
+---
+
+# Declaratio circa Sollemnitatem Annuntiationis Domini anno 2013 celebrandam
+
+Cum anno 2013, die 25 martii incidat feria II Hebdomadae
+Sanctae, iuxta Tabulam dierum liturgicorum secundum ordinem
+praecedentiae dispositam et secundum n. 60 Normarum de Anno
+liturgico et de Calendario, sollemnitas Annuntiationis Domini
+celebrabitur die 8 aprilis, scilicet feria II post Dominicam II Paschae, sicut
+ex editione typica tertia Missalis Romani patet.
+
+```ruby
+calendar = CR::Calendar.new(2012, CR::Data::GENERAL_ROMAN_LATIN.load)
+
+day = calendar[Date.new(2013, 4, 8)]
+expect(day.celebrations.first.symbol).to be :annunciation
+```
+
+# Declaratio circa sollemnitatem Immaculatae Conceptionis Beatae Mariae Virginis a. 2013 in Dominica II Adventus incidentem
+
+Cum anno 2013, die 8 decembris incidat Dominica II Adventus,
+iuxta Tabulam dierum liturgicorum secundum ordinem praecedentiae
+dispositam et secundum nn. 5 et 60 Normarum de Anno liturgico
+et de Calendario, sollemnitas Immaculatae Conceptionis Beatae
+Mariae Virginis celebrabitur die 9 decembris, feria II post Dominica
+II Adventus.
+
+```ruby
+calendar = CR::Calendar.new(2013, CR::Data::GENERAL_ROMAN_LATIN.load)
+
+day = calendar[Date.new(2013, 12, 9)]
+expect(day.celebrations.first.symbol).to be :bvm_immaculate
+```

data/liturgical_law/README.md

@@ -0,0 +1,74 @@
+# Liturgical Law
+
+This directory contains documents of liturgical legislation
+implemented by the library. Each document is reproduced in Latin,
+in a form of a Markdown file.
+
+## Main documents, development overview
+
+Fundamental outline of the calendar system is contained in the document
+*Normae universales de anno liturgico et de calendario*, first published in 1969.
+Most of the 1969 text is in force without a substantial change up to this day,
+but during the years some important parts were changed, a particularly hot matter
+being the rules concerning transfer of impeded solemnities.
+Apart of updates of the *Normae* themselves, a few additional rules were added
+to the calendar system by separate documents (the more formal ones being CDW decrees,
+the less formal ones notifications).
+
+* **1969 Normae universales de anno liturgico et de calendario**
+  initial outline of the calendar system
+* **1970 Missale Romanum, editio typica**
+  [updated](http://www.cultodivino.va/content/dam/cultodivino/notitiae/1970/54 1.pdf#page=49)
+  paragraphs 13, 56, 59 and 60 of the *Normae*
+* **1975 Missale Romanum, editio typica altera**
+  [updated](http://www.cultodivino.va/content/dam/cultodivino/notitiae/1975/111-112.pdf#page=27)
+  paragraphs 14, 47 and 59 of the *Normae* (mostly mere terminological changes;
+  the change of paragraph 59 dropped a few categories from the *Table of Liturgical Days*)
+* **1977 Decree about the feast of Baptism of the Lord**
+  with an improved rule of computing it's date for places where Epiphany is celebrated
+  on a Sunday
+* **1990 Decree updating Normae, n. 5**
+  (transfer rule for a solemnity impeded by a privileged Sunday)
+* **1998 Notification concerning occurrence of the memorial of the Immaculate Heart of Mary**
+
+## Code examples
+
+The Markdown files, in addition to the text of documents of liturgical
+legislation, contain also blocks of Ruby code, each proving
+that the immediately preceding part of the document is implemented
+by the library. The documents illustrated with code blocks thus constitute
+sort of a test suite in the [literate programming](https://en.wikipedia.org/wiki/Literate_programming)
+style. This test suite is integrated in the project's main test suite
+(see `spec/liturgical_law_spec.rb`)
+
+Utilities commonly used in the code blocks:
+
+```ruby
+# RSpec expectations are available in the code blocks
+expect(1).to be_truthy
+
+# method `year` returns a random year (which is a valid liturgical years
+# for calendarium-romanum) and should be used in all examples which need
+# a single year and don't require a particular one
+expect(year).to be_a Integer
+expect(year).to be >= 1970
+# year is the same for the whole example, even if called multiple times
+a = year; b = year
+expect(a).to be b
+
+# method `years` returns a representative Enumerable of (valid liturgical)
+# years and should be used in all examples which test across several years
+# and don't require particular ones
+expect(years).to be_a Enumerable
+yrs = years.to_a
+expect(yrs[0]).to be_a Integer
+
+# method `years_with` returns an array of years (which are valid liturgical years
+# for calendarium-romanum) matching the specified condition
+yrs = years_with {|y| true }
+expect(yrs).to be_an Array
+expect(yrs[0]).to be_an Integer
+# if no matching year is found an exception is raised
+expect { years_with {|y| false } }
+  .to raise_exception(RuntimeError, /no matching year/)
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendarium-romanum
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Jakub Pavlík
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-26 00:00:00.000000000 Z
+date: 2020-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -81,16 +81,30 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.5'
 description: calendar computations according to the Roman Catholic liturgical calendar
-  as instituted by MP Mysterii Paschalis of Paul VI (1969).
+  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.
 email: jkb.pavlik@gmail.com
 executables:
 - calendariumrom
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
 - bin/calendariumrom
+- calendarium-romanum.gemspec
 - config/locales/cs.yml
 - config/locales/en.yml
+- config/locales/es.yml
 - config/locales/fr.yml
 - config/locales/it.yml
 - config/locales/la.yml
@@ -106,57 +120,65 @@ files:
 - data/czech-ostrava-cs.txt
 - data/czech-plzen-cs.txt
 - data/czech-praha-cs.txt
+- data/easter_dates.txt
+- data/universal-1969-la.txt
 - data/universal-en.txt
+- data/universal-es.txt
 - data/universal-fr.txt
 - data/universal-it.txt
 - data/universal-la.txt
+- doc/data_readme.md
+- doc/images/class_diagram.png
+- doc/images/class_diagram.puml
+- doc/yard_readme.rdoc
 - lib/calendarium-romanum.rb
 - lib/calendarium-romanum/abstract_date.rb
 - lib/calendarium-romanum/calendar.rb
 - lib/calendarium-romanum/cli.rb
+- lib/calendarium-romanum/cli/comparator.rb
+- lib/calendarium-romanum/cli/date_parser.rb
+- lib/calendarium-romanum/cli/dumper.rb
+- lib/calendarium-romanum/cli/helper.rb
+- lib/calendarium-romanum/cli/querier.rb
+- lib/calendarium-romanum/cr.rb
 - lib/calendarium-romanum/data.rb
 - lib/calendarium-romanum/day.rb
 - lib/calendarium-romanum/enum.rb
 - lib/calendarium-romanum/enums.rb
+- lib/calendarium-romanum/errors.rb
 - lib/calendarium-romanum/i18n_setup.rb
 - lib/calendarium-romanum/ordinalizer.rb
 - lib/calendarium-romanum/perpetual_calendar.rb
 - lib/calendarium-romanum/rank.rb
+- lib/calendarium-romanum/rank_predicates.rb
 - lib/calendarium-romanum/sanctorale.rb
 - lib/calendarium-romanum/sanctorale_factory.rb
-- lib/calendarium-romanum/sanctoraleloader.rb
+- lib/calendarium-romanum/sanctorale_loader.rb
+- lib/calendarium-romanum/sanctorale_writer.rb
 - lib/calendarium-romanum/temporale.rb
+- lib/calendarium-romanum/temporale/celebration_factory.rb
 - lib/calendarium-romanum/temporale/dates.rb
+- lib/calendarium-romanum/temporale/easter_table.rb
+- lib/calendarium-romanum/temporale/extensions.rb
 - lib/calendarium-romanum/temporale/extensions/christ_eternal_priest.rb
+- lib/calendarium-romanum/temporale/extensions/dedication_before_all_saints.rb
 - lib/calendarium-romanum/transfers.rb
 - lib/calendarium-romanum/util.rb
 - lib/calendarium-romanum/version.rb
-- spec/abstract_date_spec.rb
-- spec/calendar_spec.rb
-- spec/celebration_spec.rb
-- spec/cli_spec.rb
-- spec/colour_spec.rb
-- spec/data_spec.rb
-- spec/date_spec.rb
-- spec/dates_spec.rb
-- spec/day_spec.rb
-- spec/enum_spec.rb
-- spec/i18n_spec.rb
-- spec/ordinalizer_spec.rb
-- spec/perpetual_calendar_spec.rb
-- spec/rank_spec.rb
-- spec/readme_spec.rb
-- spec/sanctorale_factory_spec.rb
-- spec/sanctorale_spec.rb
-- spec/sanctoraleloader_spec.rb
-- spec/season_spec.rb
-- spec/spec_helper.rb
-- spec/temporale_spec.rb
+- liturgical_law/1969_normae_universales.md
+- liturgical_law/1977_decretum_de_celebratione_baptismatis_domini.md
+- liturgical_law/1990_decretum_de_variatione_inducenda.md
+- liturgical_law/1998_notificatio_de_occurrentia.md
+- liturgical_law/2002_normae_universales.md
+- liturgical_law/2006_notification.md
+- liturgical_law/2012_declarationes.md
+- liturgical_law/README.md
 homepage: http://github.com/igneus/calendarium-romanum
 licenses:
 - LGPL-3.0
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://www.rubydoc.info/gems/calendarium-romanum/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -165,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -173,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Roman Catholic liturgical calendar computations

data/lib/calendarium-romanum/sanctoraleloader.rb

@@ -1,115 +0,0 @@
-module CalendariumRomanum
-
-  # understands a plaintext calendar format
-  # and knows how to transform it to Celebrations
-  # and fill them in a Sanctorale
-  #
-  # Format of the file:
-  # 1/31 m : S. Ioannis Bosco, presbyteri
-  #
-  # <month>/<day> <rank shortcut> : <title>
-  # rank shortcut is optional, default value is optional memorial
-  class SanctoraleLoader
-
-    RANK_CODES = {
-                  nil => Ranks::MEMORIAL_OPTIONAL,
-                  'm' => Ranks::MEMORIAL_GENERAL,
-                  'f' => Ranks::FEAST_GENERAL,
-                  's' => Ranks::SOLEMNITY_GENERAL
-                 }
-    COLOUR_CODES = {
-                    nil => Colours::WHITE,
-                    'w' => Colours::WHITE,
-                    'v' => Colours::VIOLET,
-                    'g' => Colours::GREEN,
-                    'r' => Colours::RED
-                   }
-
-    # dest should be a Sanctorale,
-    # src anything with #each_line
-    def load(src, dest=nil)
-      dest ||= Sanctorale.new
-
-      in_front_matter = false
-      month_section = nil
-      src.each_line.with_index(1) do |l, line_num|
-        # skip YAML front matter
-        if line_num == 1 && l.start_with?('---')
-          in_front_matter = true
-          next
-        elsif in_front_matter
-          if l.start_with?('---')
-            in_front_matter = false
-          end
-
-          next
-        end
-
-        # strip whitespace and comments
-        l.sub!(/#.*/, '')
-        l.strip!
-        next if l.empty?
-
-        # month section heading
-        n = l.match /^=\s*(\d+)\s*$/
-        unless n.nil?
-          month_section = n[1].to_i
-          unless month_section >= 1 && month_section <= 12
-            raise error("Invalid month #{month_section}", line_num)
-          end
-          next
-        end
-
-        # celebration record
-        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)
-        month ||= month_section
-        day = day.to_i
-        month = month.to_i
-
-        rank = RANK_CODES[rank_char && rank_char.downcase]
-        if rank.nil?
-          raise error("Invalid celebration rank code #{rank_char}", line_num)
-        end
-
-        if rank_num
-          rank_num = rank_num.to_f
-          rank_by_num = Ranks[rank_num]
-
-          if rank_by_num.nil?
-            raise error("Invalid celebration rank code #{rank_num}", line_num)
-          elsif rank_char && (rank.priority.to_i != rank_by_num.priority.to_i)
-            raise error("Invalid combination of rank letter #{rank_char.inspect} and number #{rank_num}.", line_num)
-          end
-
-          rank = rank_by_num
-        end
-
-        dest.add month, day, Celebration.new(
-                                             title.strip,
-                                             rank,
-                                             COLOUR_CODES[colour && colour.downcase]
-                                            )
-      end
-
-      dest
-    end
-
-    alias_method :load_from_string, :load
-
-    def load_from_file(filename, dest=nil, encoding='utf-8')
-      self.load File.open(filename, 'r', encoding: encoding), dest
-    end
-
-    private
-
-    def error(message, line_number)
-      RuntimeError.new("L#{line_number}: #{message}")
-    end
-  end
-end

data/spec/abstract_date_spec.rb

@@ -1,62 +0,0 @@
-require_relative 'spec_helper'
-
-describe CR::AbstractDate do
-  AD = CR::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
-
-  # test .new through .from_date on a complete leap year
-  describe '.from_date' do
-    YEAR = 2000
-
-    it 'the test year is leap' do
-      expect(Date.new(YEAR)).to be_leap
-    end
-
-    CR::Util::Year.new(YEAR).each do |date|
-      it date.to_s do
-        expect do
-          AD.from_date date
-        end.not_to raise_exception
-      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