calendarium-romanum 0.7.1 → 0.8.0

data/data/universal-en.txt

@@ -122,7 +122,7 @@ locale: en
 24 sharbel : Saint Sharbel Makhluf, hermit
 25 f R james : Saint James, apostle
 26 m joachim_anne : Saints Joachim and Anne
-29 m R martha : Saint Martha
+29 m martha : Saint Martha
 30 peter_chrysologus : Saint Peter Chrysologus, bishop and doctor
 31 m ignatius_of_loyola : Saint Ignatius of Loyola, priest
 
@@ -203,11 +203,11 @@ locale: en
 = 11
 1 s all_saints : All Saints
 2 s all_souls : All Souls
-3 R de_porres : Saint Martin de Porres, religious
+3 de_porres : Saint Martin de Porres, religious
 4 m borromeo : Saint Charles Borromeo, bishop
-9 f lateran_basilica : Dedication of the Lateran basilica
+9 f2.5 lateran_basilica : Dedication of the Lateran basilica
 10 m leo_great : Saint Leo the Great, pope and doctor
-11 m R martin : Saint Martin of Tours, bishop
+11 m martin : Saint Martin of Tours, bishop
 12 m R josaphat : Saint Josaphat, bishop and martyr
 15 albert : Saint Albert the Great, bishop and doctor
 16 margaret_of_scotland : Saint Margaret of Scotland

data/data/universal-es.txt

@@ -122,7 +122,7 @@ locale: es
 24 sharbel : San Chárbel Makhlouf, Ermitaño
 25 f R james : Santiago, apóstol
 26 m joachim_anne : Santos Joaquín y Ana, padres de la Santísima Virgen María
-29 m R martha : Santa Marta
+29 m martha : Santa Marta
 30 peter_chrysologus : San Pedro Crisólogo, Obispo y Doctor de la Iglesia
 31 m ignatius_of_loyola : San Ignacio de Loyola, Presbítero
 
@@ -203,11 +203,11 @@ locale: es
 = 11
 1 s all_saints : Todos los Santos
 2 s all_souls : Conmemoración de Todos los Difuntos
-3 R de_porres : San Martín de Porres, Religioso
+3 de_porres : San Martín de Porres, Religioso
 4 m borromeo : San Carlos Borromeo, Obispo
-9 f lateran_basilica : Dedicación de la Basílica de Letrán
+9 f2.5 lateran_basilica : Dedicación de la Basílica de Letrán
 10 m leo_great : San León el Magno, Papa y Doctor de la Iglesia
-11 m R martin : San Martín de Tours, Obispo
+11 m martin : San Martín de Tours, Obispo
 12 m R josaphat : San Josafat, Obispo y Mártir
 15 albert : San Alberto Magno, Obispo y Doctor de la Iglesia
 16 margaret_of_scotland : Santa Margarita de Escocia

data/data/universal-fr.txt

@@ -122,7 +122,7 @@ locale: fr
 24 sharbel : Saint Charbel Makhlouf, ermite
 25 f R james : Saint Jacques, apôtre
 26 m joachim_anne : Saints Joachim et Anne
-29 m R martha : Sainte Marthe
+29 m martha : Sainte Marthe
 30 peter_chrysologus : Saint Pierre Chrysologue, évêque et docteur de l'Église
 31 m ignatius_of_loyola : Saint Ignace de Loyola, prêtre
 
@@ -203,11 +203,11 @@ locale: fr
 = 11
 1 s all_saints : Toussaint
 2 s all_souls : Commémoration des fidèles défunts
-3 R de_porres : Saint Martin de Porrès, religieux
+3 de_porres : Saint Martin de Porrès, religieux
 4 m borromeo : Saint Charles Borromée, évêque
-9 f lateran_basilica : Dédicace de la Basilique Saint-Jean-de-Latran
+9 f2.5 lateran_basilica : Dédicace de la Basilique Saint-Jean-de-Latran
 10 m leo_great : Saint Léon le Grand, pape et docteur de l'Église
-11 m R martin : Saint Martin de Tours, évêque
+11 m martin : Saint Martin de Tours, évêque
 12 m R josaphat : Saint Josaphat, évêque et martyr
 15 albert : Saint Albert le Grand, évêque et docteur de l'Église
 16 margaret_of_scotland : Sainte Marguerite

data/data/universal-it.txt

@@ -121,7 +121,7 @@ locale: it
 24 sharbel : San Charbel Makhlouf, eremita
 25 f R james : San Giacomo, apostolo
 26 m joachim_anne : Santi Gioacchino ed Anna, genitori della Beata Vergine Maria
-29 m R martha : Santa Marta
+29 m martha : Santa Marta
 30 peter_chrysologus : San Pietro Crisologo, vescovo e dottore della Chiesa
 31 m ignatius_of_loyola : Sant'Ignazio di Loyola, sacerdote
 
@@ -202,11 +202,11 @@ locale: it
 = 11
 1 s all_saints : Tutti i Santi
 2 s all_souls : Commemorazione di tutti i fedeli defunti
-3 R de_porres : San Martino de Porres, religioso
+3 de_porres : San Martino de Porres, religioso
 4 m borromeo : San Carlo Borromeo, vescovo
-9 f lateran_basilica : Dedicazione della basilica Lateranense
+9 f2.5 lateran_basilica : Dedicazione della basilica Lateranense
 10 m leo_great : San Leone Magno, papa e dottore della Chiesa
-11 m R martin : San Martino di Tours, vescovo
+11 m martin : San Martino di Tours, vescovo
 12 m R josaphat : San Giosafat, vescovo e martire
 15 albert : Sant'Alberto Magno, vescovo e dottore della Chiesa
 16 margaret_of_scotland : Santa Margherita di Scozia

data/data/universal-la.txt

@@ -122,7 +122,7 @@ locale: la
 24 sharbel : S. Sarbelii Makhlūf, presbyteri
 25 f R james :  S. Iacobi, apostoli
 26 m joachim_anne :  Ss. Ioachim et Annae, parentum B. Mariae Virginis
-29 m R martha :  S. Marthae
+29 m martha :  S. Marthae
 30 peter_chrysologus : S. Petri Chrysologi, episcopi et Ecclesiae doctoris
 31 m ignatius_of_loyola :  S. Ignatii de Loyola, presbyteri
 
@@ -203,11 +203,11 @@ locale: la
 = 11
 1 s all_saints :  OMNIUM SANCTORUM
 2 s all_souls : IN COMMEMORATIONE OMNIUM FIDELIUM DEFUNCTORUM
-3 R de_porres : S. Martini de Porres, religiosi
+3 de_porres : S. Martini de Porres, religiosi
 4 m borromeo :  S. Caroli Borromeo, episcopi
-9 f lateran_basilica :  IN DEDICATIONE BASILICAE LATERANENSIS
+9 f2.5 lateran_basilica :  IN DEDICATIONE BASILICAE LATERANENSIS
 10 m leo_great :  S. Leonis Magni, papae et Ecclesiae doctoris
-11 m R martin :  S. Martini Turonensis, episcopi
+11 m martin :  S. Martini Turonensis, episcopi
 12 m R josaphat :  S. Iosaphat, episcopi et martyris
 15 albert : S. Alberti Magni, episcopi et Ecclesiae doctoris
 16 margaret_of_scotland : S. Margaritae Scotiae

data/lib/calendarium-romanum.rb

@@ -8,6 +8,7 @@ end
   version
   i18n_setup
   abstract_date
+  rank_predicates
   rank
   enum
   enums
@@ -18,10 +19,14 @@ end
   perpetual_calendar
   temporale/dates
   temporale/celebration_factory
+  temporale/easter_table
+  temporale/extensions
   temporale/extensions/christ_eternal_priest
+  temporale/extensions/dedication_before_all_saints
   temporale
   sanctorale
   sanctorale_loader
+  sanctorale_writer
   sanctorale_factory
   transfers
   util

data/lib/calendarium-romanum/abstract_date.rb

@@ -4,8 +4,8 @@ module CalendariumRomanum
   class AbstractDate
     include Comparable
 
-    # @param month [Fixnum]
-    # @param day [Fixnum]
+    # @param month [Integer]
+    # @param day [Integer]
     # @raise [RangeError] on invalid +month+/+day+ value
     def initialize(month, day)
       validate! month, day
@@ -42,12 +42,15 @@ module CalendariumRomanum
 
     # Produce a +Date+ by providing a year to an +AbstractDate+
     #
-    # @param year [Fixnum]
+    # @param year [Integer]
     # @return [Date]
     def concretize(year)
       Date.new(year, month, day)
     end
 
+    # @since 0.8.0
+    alias in_year concretize
+
     private
 
     def validate!(month, day)

data/lib/calendarium-romanum/calendar.rb

@@ -17,19 +17,34 @@ module CalendariumRomanum
     # Returns a calendar for the liturgical year beginning with
     # Advent of the specified civil year.
     #
-    # @param year [Fixnum]
-    #   Civil year when the liturgical year begins.
-    # @param sanctorale [Sanctorale, nil]
-    #   If not provided, the +Calendar+ will only know celebrations
-    #   of the temporale cycle, no feasts of the saints!
-    # @param temporale [Temporale, nil]
-    #   If not provided, +Temporale+ for the given year with default
-    #   configuration will built.
-    # @param vespers [Boolean] Set to true if you want the +Calendar+ to populate {Day#vespers}
+    # @overload initialize(year, sanctorale = nil, temporale = nil, vespers: false)
+    #   @param year [Integer]
+    #     Civil year when the liturgical year begins.
+    #   @param sanctorale [Sanctorale, nil]
+    #     If not provided, the +Calendar+ will only know celebrations
+    #     of the temporale cycle, no feasts of the saints!
+    #   @param temporale [Temporale, nil]
+    #     If not provided, +Temporale+ for the given year with default
+    #     configuration will built.
+    #   @param vespers [Boolean] Set to true if you want the +Calendar+ to populate {Day#vespers}
+    #
+    # @overload initialize(temporale, sanctorale=nil, vespers: false)
+    #   @param temporale [Temporale]
+    #   @param sanctorale [Sanctorale, nil]
+    #     If not provided, the +Calendar+ will only know celebrations
+    #     of the temporale cycle, no feasts of the saints!
+    #   @param vespers [Boolean] Set to true if you want the +Calendar+ to populate {Day#vespers}
+    #   @since 0.8.0
+    #
     # @raise [RangeError]
     #   if +year+ is specified for which the implemented calendar
     #   system wasn't in force
     def initialize(year, sanctorale = nil, temporale = nil, vespers: false)
+      unless year.is_a? Integer
+        temporale = year
+        year = temporale.year
+      end
+
       if year < (EFFECTIVE_FROM.year - 1)
         raise system_not_effective
       end
@@ -43,7 +58,7 @@ module CalendariumRomanum
       @temporale = temporale || Temporale.new(year)
       @populate_vespers = vespers
 
-      @transferred = Transfers.new(@temporale, @sanctorale)
+      @transferred = Transfers.call(@temporale, @sanctorale).freeze
     end
 
     class << self
@@ -89,7 +104,7 @@ module CalendariumRomanum
     #   @return [Season]
     def_delegators :@temporale, :range_check, :season
 
-    # @return [Fixnum]
+    # @return [Integer]
     attr_reader :year
 
     # @return [Temporale]
@@ -98,6 +113,13 @@ module CalendariumRomanum
     # @return [Sanctorale]
     attr_reader :sanctorale
 
+    # Solemnities transferred to a date different from the usual one
+    # due to occurrence with a higher-ranking celebration.
+    #
+    # @return [Hash<Date=>Celebration>]
+    # @since 0.8.0
+    attr_reader :transferred
+
     # Do {Day} instances returned by this +Calendar+
     # have {Day#vespers} populated?
     # @return [Boolean]
@@ -138,9 +160,9 @@ module CalendariumRomanum
     # @overload day(date, vespers: false)
     #   @param date [Date]
     # @overload day(year, month, day, vespers: false)
-    #   @param year [Fixnum]
-    #   @param month [Fixnum]
-    #   @param day [Fixnum]
+    #   @param year [Integer]
+    #   @param month [Integer]
+    #   @param day [Integer]
     # @param vespers [Boolean]
     #   Set to +true+ in order to get {Day} with {Day#vespers}
     #   populated (overrides instance-wide setting {#populates_vespers?}).
@@ -230,7 +252,7 @@ module CalendariumRomanum
     private
 
     def celebrations_for(date)
-      tr = @transferred.get(date)
+      tr = @transferred[date]
       return [tr] if tr
 
       t = @temporale[date]

data/lib/calendarium-romanum/cli.rb

@@ -1,5 +1,17 @@
 require 'thor'
 
+# monkey patch preventing Thor from screwing formatting in our commands' long_desc
+# credits: https://github.com/erikhuda/thor/issues/398#issuecomment-237400762
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+         stdout.puts message
+       end
+    end
+  end
+end
+
 module CalendariumRomanum
 
   # Implementation of the +calendariumrom+ executable.
@@ -7,102 +19,48 @@ module CalendariumRomanum
   #
   # @api private
   class CLI < Thor
-    include CalendariumRomanum::Util
-
-    desc 'query 2007-06-05', 'show calendar information for a specified date'
-    option :calendar, default: 'universal-en', aliases: :c
-    option :locale, default: 'en', aliases: :l
+    desc 'query [DATE]', 'show calendar information for a specified date/month/year'
+    long_desc <<-EOS
+show calendar information for a specified date/month/year
+
+DATE formats:
+not specified - today
+2000-01-02    - single date
+2000-01       - month
+2000          - year
+EOS
+    option :calendar, default: Data::GENERAL_ROMAN_ENGLISH.siglum, aliases: :c, desc: 'sanctorale data file to use (filesystem path or identifier of a bundled one)'
+    option :locale, default: 'en', aliases: :l, desc: 'locale to use for localized strings'
     def query(date_str = nil)
-      I18n.locale = options[:locale]
-      calendar = options[:calendar]
-      if File.exist?(calendar)
-        begin
-          sanctorale = SanctoraleLoader.new.load_from_file(calendar)
-        rescue CalendariumRomanum::InvalidDataError
-          die! 'Invalid file format.'
-        end
-      else
-        data_file = Data[calendar]
-
-        if data_file.nil?
-          die! "Invalid calendar. Either loading a calendar from filesystem did not succeed, \n or a preinstalled calendar was specified which doesn't exist. See subcommand `calendars` for valid options."
-        end
-        sanctorale = data_file.load
-      end
-
-      pcal = PerpetualCalendar.new sanctorale: sanctorale
-
-      if date_str
-        begin
-          parsed_date = DateParser.new(date_str)
-          parsed_date.date_range.each do |day|
-            print_single_date(pcal, day)
-          end
-        rescue ArgumentError
-          die! 'Invalid date.'
-        end
-      else
-        print_single_date(pcal, Date.today)
-      end
+      Querier
+        .new(locale: options[:locale], calendar: options[:calendar])
+        .call(date_str)
     end
 
-    desc 'calendars', 'lists calendars available for querying'
+    desc 'calendars', 'list calendars available for querying'
     def calendars
       Data.each {|c| puts c.siglum }
     end
 
-    desc 'errors FILE1, ...', 'finds errors in sanctorale data files'
+    desc 'errors FILE1, ...', 'find errors in sanctorale data files'
     def errors(*files)
-      loader = SanctoraleLoader.new
       files.each do |path|
-        s = Sanctorale.new
         begin
-          loader.load_from_file path, s
+          sanctorale_from_path path
         rescue Errno::ENOENT, InvalidDataError => err
           die! err.message
         end
       end
     end
 
-    desc 'cmp FILE1, FILE2', 'detect differences in rank and colour of corresponding celebrations'
+    desc 'cmp FILE1, FILE2', 'detect differences between two sanctorale data files'
     def cmp(a, b)
-      loader = SanctoraleLoader.new
-      paths = [a, b]
-      sanctoralia = paths.collect {|source| loader.load_from_file source }
-      names = paths.collect {|source| File.basename source }
-
-      # a leap year must be chosen in order to iterate over
-      # all possible days of a Sanctorale
-      Year.new(1990).each_day do |d|
-        a, b = sanctoralia.collect {|s| s.get(d) }
-
-        0.upto([a.size, b.size].max - 1) do |i|
-          ca = a[i]
-          cb = b[i]
-          compared = [ca, cb]
-
-          if compared.index(&:nil?)
-            notnili = compared.index {|c| !c.nil? }
-
-            print date(d)
-            puts " only in #{names[notnili]}:"
-            puts celebration(compared[notnili])
-            puts
-            next
-          end
-
-          differences = %i(rank colour symbol).select do |property|
-            ca.public_send(property) != cb.public_send(property)
-          end
+      Comparator.new.call(a, b)
+    end
 
-          next if differences.empty?
-          print date(d)
-          puts " differs in #{differences.join(', ')}"
-          puts celebration(ca)
-          puts celebration(cb)
-          puts
-        end
-      end
+    desc 'dump YEAR', 'print calendar of the specified year for use in regression tests'
+    def dump(year)
+      Dumper.new.regression_tests_dump year.to_i
     end
 
     desc 'version', 'print version information'
@@ -110,40 +68,20 @@ module CalendariumRomanum
       puts 'calendarium-romanum CLI'
       puts "calendarium-romanum: version #{CalendariumRomanum::VERSION}, released #{CalendariumRomanum::RELEASE_DATE}"
     end
+  end
+end
 
-    private
-
-    def date(d)
-      "#{d.month}/#{d.day}"
-    end
-
-    def celebration(c)
-      "#{c.rank.priority} #{c.colour.symbol} | #{c.title}"
-    end
-
-    def die!(message, code = 1)
-      STDERR.puts message
-      exit code
-    end
-
-    def print_single_date(calendar, date)
-      day = calendar.day date
-
-      puts date
-      puts "season: #{day.season.name}"
-      puts
-
-      rank_length = day.celebrations.collect {|c| c.rank.short_desc.nil? ? 0 : c.rank.short_desc.size }.max
-      day.celebrations.each do |c|
-        if [Ranks::PRIMARY, Ranks::TRIDUUM].include? c.rank
-          puts c.title
-        elsif !c.rank.short_desc.nil?
-          print c.rank.short_desc.rjust(rank_length)
-          print ' : '
-          puts c.title
-        end
-      end
-    end
+# required files reopen the CLI class - require after the class'es main definition
+# in order to prevent superclass mismatch errors
+require_relative 'cli/helper'
 
+module CalendariumRomanum
+  class CLI
+    include Helper
   end
 end
+
+require_relative 'cli/comparator'
+require_relative 'cli/date_parser'
+require_relative 'cli/dumper'
+require_relative 'cli/querier'