calendarium-romanum 0.4.0 → 0.8.0

data/lib/calendarium-romanum/cli.rb

@@ -1,104 +1,87 @@
 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.
+  # _Not_ loaded by default when you +require+ the gem.
+  #
+  # @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
-    def query(date_str=nil)
-      I18n.locale = options[:locale]
-
-      data_file = Data[options[:calendar]]
-      if data_file.nil?
-        STDERR.puts 'Invalid calendar. See subcommand `calendars` for valid options.'
-        exit 1
-      end
-      sanctorale = data_file.load
-
-      date =
-        if date_str
-          begin
-            Date.parse(date_str)
-          rescue ArgumentError
-            STDERR.puts 'Invalid date.'
-            exit 1
-          end
-        else
-          Date.today
-        end
-      calendar = Calendar.for_day(date, sanctorale)
-      day = calendar.day date
-
-      puts date
-      puts "season: #{day.season}"
-      puts
-
-      rank_length = day.celebrations.collect {|c| c.rank.short_desc.size }.max
-      day.celebrations.each do |c|
-        print c.rank.short_desc.rjust(rank_length)
-        print ' : '
-        puts c.title
-      end
+    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)
+      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
-        loader.load_from_file path, s
+        begin
+          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
-      sanctorales = []
-
-      [a, b].each do |source|
-        s = Sanctorale.new
-        loader.load_from_file source, s
-        sanctorales << s
-      end
-
-      # a leap year must be chosen in order to iterate over
-      # all possible days of a Sanctorale
-      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
+      Comparator.new.call(a, b)
+    end
 
-          ca = celebs[0][i]
-          cb = celebs[1][i]
+    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
 
-          if ca.rank != cb.rank || ca.colour != cb.colour
-            puts "#{d.month}/#{d.day}"
-            print_celebration ca
-            print_celebration cb
-            puts
-          end
-        end
-      end
+    desc 'version', 'print version information'
+    def version
+      puts 'calendarium-romanum CLI'
+      puts "calendarium-romanum: version #{CalendariumRomanum::VERSION}, released #{CalendariumRomanum::RELEASE_DATE}"
     end
+  end
+end
 
-    private
+# required files reopen the CLI class - require after the class'es main definition
+# in order to prevent superclass mismatch errors
+require_relative 'cli/helper'
 
-    def print_celebration(c)
-      puts "#{c.rank.priority} #{c.colour.symbol} | #{c.title}"
-    end
+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'

data/lib/calendarium-romanum/cli/comparator.rb

@@ -0,0 +1,63 @@
+module CalendariumRomanum
+  class CLI
+    # Compares two sanctorale data files, reports differences.
+    #
+    # @api private
+    class Comparator
+      include Helper
+
+      def call(path_a, path_b)
+        paths = [path_a, path_b]
+        sanctoralia = paths.collect {|source| sanctorale_from_path source }
+        names = paths.collect {|source| File.basename source }
+
+        all_possible_dates.each do |d|
+          a, b = sanctoralia.collect {|sanctorale| sanctorale[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
+
+            next if differences.empty?
+            print date(d)
+            puts " differs in #{differences.join(', ')}"
+            puts celebration(ca)
+            puts celebration(cb)
+            puts
+          end
+        end
+      end
+
+      private
+
+      def all_possible_dates
+        # a leap year must be chosen in order to iterate over
+        # all possible days of a Sanctorale
+        Util::Year.new(1990).each_day
+      end
+
+      def date(d)
+        "#{d.month}/#{d.day}"
+      end
+
+      def celebration(c)
+        "#{c.rank.priority} #{c.colour.symbol} | #{c.title}"
+      end
+    end
+  end
+end

data/lib/calendarium-romanum/cli/date_parser.rb

@@ -0,0 +1,30 @@
+module CalendariumRomanum
+  class CLI
+    # @api private
+    class DateParser
+      def self.parse(date_str)
+        /(?<year>\d{4})([\/-](?<month>\d{1,2})([\/-](?<day>\d{1,2}))?)?/.match(date_str) do |m|
+          date_segments =
+            %i(year month day)
+              .collect {|name| m[name] }
+              .compact
+              .collect(&:to_i)
+
+          build_range(*date_segments)
+        end || raise(ArgumentError.new('Unparseable date'))
+      end
+
+      def self.build_range(*args)
+        case args.size
+        when 1
+          Util::Year.new(*args)
+        when 2
+          Util::Month.new(*args)
+        else
+          date = Date.new(*args)
+          date..date
+        end
+      end
+    end
+  end
+end

data/lib/calendarium-romanum/cli/dumper.rb

@@ -0,0 +1,68 @@
+module CalendariumRomanum
+  class CLI
+    # Produces a condensed text representation of a Calendar, used in regression tests.
+    # Not loaded by default by +require 'calendarium-romanum'+
+    #
+    # @api private
+    class Dumper
+      def initialize(io=STDOUT)
+        @io = io
+      end
+
+      # Dumps +calendar+. If +other_calendars+ are specified, dumps an alternative entry
+      # for any date for which any of +other_calendars+ differs from +calendar+.
+      def call(calendar, *other_calendars)
+        @io.puts "Calendar for liturgical year #{calendar.year}"
+        calendar.each do |day|
+          dump_day(day)
+
+          other_calendars.each do |cal|
+            day2 = cal[day.date]
+            if day2 != day
+              @io.print 'or '
+              dump_day(day2)
+            end
+          end
+        end
+      end
+
+      # Produces the dump used for regression tests for the specified +year+.
+      def regression_tests_dump(year)
+        sanctorale = Data::GENERAL_ROMAN_LATIN.load
+        calendar = Calendar.new(
+          year,
+          sanctorale,
+          vespers: true
+        )
+        calendar_with_transfers = Calendar.new(
+          Temporale.new(year, transfer_to_sunday: Temporale::SUNDAY_TRANSFERABLE_SOLEMNITIES),
+          sanctorale,
+          vespers: true
+        )
+        calendar_with_extensions = Calendar.new(
+          Temporale.new(year, extensions: Temporale::Extensions.all),
+          sanctorale,
+          vespers: true
+        )
+
+        I18n.with_locale(:la) do
+          call(
+            calendar,
+            calendar_with_transfers,
+            calendar_with_extensions,
+          )
+        end
+      end
+
+      private
+
+      def dump_day(day)
+        @io.puts [day.date, day.season.symbol, day.season_week, !day.vespers.nil?].join(' ')
+
+        day.celebrations.each do |c|
+          @io.puts ['-', c.title.inspect, c.rank.priority, c.colour.symbol, c.symbol, (c.date && "#{c.date.month}/#{c.date.day}"), c.cycle].join(' ')
+        end
+      end
+    end
+  end
+end

data/lib/calendarium-romanum/cli/helper.rb

@@ -0,0 +1,23 @@
+module CalendariumRomanum
+  class CLI
+    # Mixin providing helper methods used by multiple CLI-related classes.
+    #
+    # @api private
+    module Helper
+      def sanctorale_from_path(path)
+        loader = SanctoraleLoader.new
+
+        if path == '-'
+          loader.load(STDIN)
+        else
+          loader.load_from_file(path)
+        end
+      end
+
+      def die!(message, code = 1)
+        STDERR.puts message
+        exit code
+      end
+    end
+  end
+end

data/lib/calendarium-romanum/cli/querier.rb

@@ -0,0 +1,73 @@
+module CalendariumRomanum
+  class CLI
+    # "Queries" a Calendar.
+    # Builds liturgical calendar according to the specified options and
+    # prints calendar entries for the specified period.
+    #
+    # @api private
+    class Querier
+      include Helper
+
+      def initialize(locale: :en, calendar: 'universal-en')
+        @locale = locale
+        @calendar = calendar
+      end
+
+      def call(date_str = nil)
+        I18n.locale = @locale
+
+        pcal = PerpetualCalendar.new sanctorale: sanctorale
+
+        today = Date.today
+        date_range = today..today
+
+        if date_str
+          begin
+            date_range = DateParser.parse(date_str)
+          rescue ArgumentError
+            die! 'Invalid date.'
+          end
+        end
+
+        date_range.each do |day|
+          print_single_date(pcal, day)
+        end
+      end
+
+      private
+
+      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
+
+      def sanctorale
+        if File.exist?(@calendar)
+          begin
+            sanctorale_from_path(@calendar)
+          rescue CalendariumRomanum::InvalidDataError
+            die! 'Invalid file format.'
+          end
+        elsif data_file = Data[@calendar]
+          data_file.load
+        else
+          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
+      end
+    end
+  end
+end

data/lib/calendarium-romanum/cr.rb

@@ -0,0 +1,16 @@
+require 'calendarium-romanum'
+
+# The module name {CalendariumRomanum} is quite long,
+# hence constant +CR+ is provided as a convenient shortcut.
+# It is _not_ loaded by +require 'calendarium-romanum'+,
+# must be required explicitly +require 'calendarium-romanum/cr'+ -
+# because there's a good chance
+# that the short constant name clashes with a constant
+# defined by some other code.
+#
+# @example
+#   require 'calendarium-romanum/cr'
+#
+#   calendar = CR::Calendar.new 2000
+# @since 0.7.0
+CR = CalendariumRomanum