calrom 0.1.0 → 0.4.0

data/lib/calrom/date_range.rb

@@ -1,5 +1,32 @@
 module Calrom
   class DateRange < Range
+    def each_month
+      return to_enum(:each_month) unless block_given?
+
+      if first.year == last.year && first.month == last.month
+        # a single month or it's part
+        yield self
+        return
+      end
+
+      (Month.new(first.year, first.month) .. Month.new(last.year, last.month))
+        .each_with_index do |m,i|
+        if i == 0 && first.day > 1
+          # first month, incomplete
+          yield self.class.new(first, m.last)
+        elsif m.first.year == last.year && m.first.month == last.month && last != m.last
+          # last month, incomplete
+          yield self.class.new(m.first, last)
+        else
+          yield m
+        end
+      end
+    end
+
+    def spans_multiple_months?
+      first.month != last.month ||
+        first.year != last.year
+    end
   end
 
   class Year < DateRange
@@ -10,16 +37,68 @@ module Calrom
     def to_s
       first.year.to_s
     end
+
+    def each_month
+      return to_enum(:each_month) unless block_given?
+
+      1.upto(12) {|month| yield Month.new(first.year, month) }
+    end
+  end
+
+  class ThreeMonths < DateRange
+    def initialize(year, month)
+      super first_day_of_last_month(year, month), last_day_of_next_month(year, month)
+    end
+
+    private
+
+    def first_day_of_last_month(year, month)
+      Date.new(year, month, 1).prev_month
+    end
+
+    def last_day_of_next_month(year, month)
+      n = Date.new(year, month).next_month
+
+      Date.new(n.year, n.month, -1)
+    end
   end
 
   class Month < DateRange
     def initialize(year, month)
-      super Date.new(year, month, 1), Date.new(year, month + 1, 1) - 1
+      @year = year
+      @month = month
+
+      super Date.new(year, month, 1), Date.new(year, month, -1)
     end
 
     def to_s
-      "#{first.month}/#{first.year}"
+      first.strftime '%B %Y'
+    end
+
+    def each_month
+      return to_enum(:each_month) unless block_given?
+
+      yield self
+    end
+
+    def succ
+      n = Date.new(@year, @month, 1).next_month
+      self.class.new(n.year, n.month)
     end
+
+    def <=>(other)
+      years_cmp = year <=> other.year
+
+      if years_cmp != 0
+        years_cmp
+      else
+        month <=> other.month
+      end
+    end
+
+    protected
+
+    attr_reader :year, :month
   end
 
   class Day < DateRange
@@ -30,5 +109,9 @@ module Calrom
     def to_s
       first.to_s
     end
+
+    def each_month
+      yield self
+    end
   end
 end

data/lib/calrom/environment_reader.rb

@@ -0,0 +1,36 @@
+module Calrom
+  # Reads configuration from environment variables
+  class EnvironmentReader
+    def self.call(config = nil)
+      new(config || Config.new).call
+    end
+
+    def initialize(config)
+      @config = config
+    end
+
+    def call
+      today
+
+      @config
+    end
+
+    private
+
+    def today
+      with_envvar 'CALROM_CURRENT_DATE' do |value, name|
+        begin
+          @config.today = Date.parse value
+        rescue ArgumentError
+          raise InputError.new "value of environment variable #{name} is not a valid date"
+        end
+      end
+    end
+
+    def with_envvar(name)
+      value = ENV[name]
+
+      yield value, name if value
+    end
+  end
+end

data/lib/calrom/exceptions.rb

@@ -0,0 +1,4 @@
+module Calrom
+  # Invalid user input. Message should be human-readable and helpful, intended for the user.
+  class InputError< RuntimeError; end
+end

data/lib/calrom/filtering_calendar.rb

@@ -0,0 +1,71 @@
+require 'delegate'
+
+module Calrom
+  # decorates /(Perpetual)?Calendar/, returns data filtered
+  class FilteringCalendar < SimpleDelegator
+    using Refinement::CalendariumRomanum::TriduumNameClashWorkaround
+
+    def initialize(calendar, days_filter_expressions=[], celebrations_filter_expressions=[])
+      super(calendar)
+
+      @days_filter = proc do |day|
+        days_filter_expressions.all? do |expr|
+          eval_filtering_expression(day, expr)
+        end
+      end
+
+      @celebrations_filter = proc do |celebration|
+        celebrations_filter_expressions.all? do |expr|
+          eval_filtering_expression(celebration, expr)
+        end
+      end
+    end
+
+    def [](arg)
+      raw = super(arg)
+
+      unless @days_filter.(raw)
+        return FilteredDay.build_skipped raw
+      end
+
+      FilteredDay.new raw, raw.celebrations.select(&@celebrations_filter)
+    end
+
+    def each_day_in_range(range, include_skipped: false)
+      return to_enum(__method__, range, include_skipped: include_skipped) unless block_given?
+
+      range.each do |date|
+        day = self[date]
+        yield day if (include_skipped || !day.skipped?)
+      end
+    end
+
+    private
+
+    def eval_filtering_expression(object, expression)
+      object.instance_eval expression
+    rescue StandardError, SyntaxError => exception
+      raise InputError.new "Filter expression '#{expression}' raised #{exception.class}: #{exception.message}"
+    end
+
+    class FilteredDay < SimpleDelegator
+      def initialize(day, filtered_celebrations)
+        super(day)
+
+        @filtered_celebrations = filtered_celebrations
+      end
+
+      def self.build_skipped(day)
+        new day, []
+      end
+
+      def celebrations
+        @filtered_celebrations
+      end
+
+      def skipped?
+        celebrations.empty?
+      end
+    end
+  end
+end

data/lib/calrom/formatter/calendars.rb

@@ -0,0 +1,29 @@
+module Calrom
+  module Formatter
+    # Prints list of available bundled calendars
+    class Calendars < Formatter
+      def call(calendar, date_range)
+        last_locale = nil
+        CR::Data.each do |d|
+          sanctorale = d.load_with_parents
+          meta = sanctorale.metadata
+          puts if last_locale && last_locale != meta['locale']
+          default = d == Config::DEFAULT_DATA ? ' [default]' : ''
+          puts "%-20s:  %s  [%s]%s" % [d.siglum, meta['title'], meta['locale'], default]
+
+          next unless meta['components']
+
+          parents =
+            meta['components']
+              .collect {|c| c['extends'] }
+              .compact
+              .map {|e| e.is_a?(Array) ? e : [e] } # 'extends' is String or Array
+              .flatten
+              .map {|p| p.sub(/\.\w{3,4}$/, '') } # file name to "siglum"
+          parents.each {|p| puts "  <  #{p}" }
+          last_locale = meta['locale']
+        end
+      end
+    end
+  end
+end

data/lib/calrom/formatter/condensed.rb

@@ -0,0 +1,51 @@
+module Calrom
+  module Formatter
+    class Condensed < Formatter
+      def call(calendar, date_range)
+        calendar.each_day_in_range(date_range) {|d| day d }
+      end
+
+      private
+
+      def day(liturgical_day)
+        c = liturgical_day.celebrations.first
+
+        colour = highlighter.colour(c.colour.name[0].upcase, c.colour)
+        rank = highlighter.rank(rank(c.rank), c.rank)
+        title = short_title c
+        more = additional_celebrations(liturgical_day) + vespers(liturgical_day)
+
+        puts "#{title} #{rank}#{colour}#{more}"
+      end
+
+      def rank(rank)
+        if rank.solemnity?
+          '*'
+        elsif rank.feast?
+          '+'
+        else
+          ''
+        end
+      end
+
+      def short_title(celebration)
+        if celebration.cycle == :sanctorale
+          # naive attempt to strip feast titles
+          celebration.title.sub /,[^,]*$/, ''
+        else
+          celebration.title
+        end
+      end
+
+      def additional_celebrations(day)
+        size = day.celebrations.size
+
+        size > 1 ? " +#{size-1}" : ''
+      end
+
+      def vespers(day)
+        day.vespers_from_following? ? '>' : ''
+      end
+    end
+  end
+end

data/lib/calrom/formatter/csv.rb

@@ -0,0 +1,27 @@
+require 'csv'
+
+module Calrom
+  module Formatter
+    class Csv < Formatter
+      def call(calendar, date_range)
+        CSV do |out|
+          out << %w(date title symbol rank rank_num colour season)
+
+          calendar.each_day_in_range(date_range) do |day|
+            day.celebrations.each do |c|
+              out << [
+                day.date,
+                c.title,
+                c.symbol,
+                c.rank.short_desc,
+                c.rank.priority,
+                c.colour.symbol,
+                day.season.symbol
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/calrom/formatter/easter.rb

@@ -0,0 +1,16 @@
+module Calrom
+  module Formatter
+    # Prints (only) date of Easter for the specified year.
+    class Easter < Formatter
+      def call(calendar, date_range)
+        unless date_range.is_a?(Year) || date_range.is_a?(Month)
+          raise 'unexpected date range, expected a year'
+        end
+
+        puts CR::Temporale::Dates
+               .easter_sunday(date_range.first.year - 1)
+               .strftime('%D')
+      end
+    end
+  end
+end

data/lib/calrom/formatter/formatter.rb

@@ -1,14 +1,25 @@
 module Calrom
   module Formatter
     class Formatter
-      def initialize(highlighter, today)
+      def initialize(highlighter, today, io = STDOUT)
         @highlighter = highlighter
         @today = today
+        @io = io
       end
 
       attr_reader :highlighter, :today
 
-      def call(days, date_range)
+      def call(calendar, date_range)
+      end
+
+      private
+
+      def puts(s = '')
+        @io.puts s
+      end
+
+      def print(s)
+        @io.print s
       end
     end
   end

data/lib/calrom/formatter/json.rb

@@ -0,0 +1,38 @@
+require 'json'
+
+module Calrom
+  module Formatter
+    # JSON format mimicking Church Calendar API v0 (https://github.com/igneus/church-calendar-api)
+    class Json < Formatter
+      def call(calendar, date_range)
+        # We build the outer JSON Array manually in order to be able to print
+        # vast amounts of calendar data without risking RAM exhaustion.
+        print "["
+
+        calendar.each_day_in_range(date_range).each_with_index do |day,i|
+          date = day.date
+          hash = {
+            date: date,
+            season: day.season.symbol,
+            season_week: day.season_week,
+            celebrations: day.celebrations.collect do |c|
+              {
+                title: c.title,
+                symbol: c.symbol,
+                colour: c.colour.symbol,
+                rank: c.rank.short_desc,
+                rank_num: c.rank.priority
+              }
+            end,
+            weekday: date.strftime('%A'),
+          }
+
+          puts "," if i > 0
+          print JSON.generate hash
+        end
+
+        puts "]"
+      end
+    end
+  end
+end

data/lib/calrom/formatter/list.rb

@@ -1,21 +1,21 @@
 module Calrom
   module Formatter
     class List < Formatter
-      def call(days, date_range)
-        print_months = date_range.first.month != date_range.last.month
+      def call(calendar, date_range)
+        print_months = date_range.spans_multiple_months?
 
         puts date_range.to_s
         puts
 
         current_month = nil
 
-        days.each do |liturgical_day|
+        calendar.each_day_in_range(date_range) do |liturgical_day|
           if print_months && liturgical_day.date.month != current_month
-            current_month = liturgical_day.date.month
-
-            puts
-            puts current_month
+            puts unless current_month == nil
+            puts liturgical_day.date.strftime('%B') #current_month
             puts
+
+            current_month = liturgical_day.date.month
           end
 
           day liturgical_day
@@ -28,9 +28,10 @@ module Calrom
         liturgical_day.celebrations.each_with_index do |celebration, i|
           s =
             if i > 0
-              ' ' * 3
+              ' ' * 6
             else
-              liturgical_day.date.day.to_s.rjust(3)
+              liturgical_day.date.strftime('%a') +
+                liturgical_day.date.day.to_s.rjust(3)
             end
           s += ' '
 
@@ -39,7 +40,7 @@ module Calrom
           s += highlighter.colour(colour.name[0].upcase, colour) +
                ' ' +
                highlighter.rank(celebration.title, rank) +
-               (rank.short_desc.nil? ? '' : ',  ' + rank.short_desc)
+               ((rank.short_desc.nil? || rank.sunday? || rank.ferial?) ? '' : ',  ' + rank.short_desc)
 
           if liturgical_day.date == today
             s = highlighter.today s

data/lib/calrom/formatter/overview.rb

@@ -0,0 +1,104 @@
+require 'set'
+require 'stringio'
+
+module Calrom
+  module Formatter
+    class Overview < Formatter
+      def call(calendar, date_range)
+        colnum = 3 # TODO: expose configuration
+        if date_range.is_a? Year
+          puts center_on(weekdays.size * colnum + 2 * (colnum - 1), date_range.to_s)
+        end
+
+        date_range.each_month.each_slice(colnum) do |months|
+          columns = months.collect do |month|
+            StringIO.new.tap do |io|
+              print_month io, calendar, month, date_range.is_a?(Year)
+            end
+          end
+          print_columns columns, @io
+        end
+      end
+
+      private
+
+      def print_month(io, calendar, month, year_in_heading)
+        heading = month.first.strftime(year_in_heading ? '%B' : '%B %Y')
+        io.puts center_on weekdays.size, heading
+
+        io.puts weekdays
+
+        io.print '   ' * month.first.wday
+        calendar.each_day_in_range(month, include_skipped: true) do |liturgical_day|
+          date = liturgical_day.date
+
+          if liturgical_day.skipped?
+            datestr = '  '
+          else
+            celebration = liturgical_day.celebrations.first
+
+            datestr = date.day.to_s.rjust(2)
+            datestr = highlighter.colour(datestr, celebration.colour)
+            datestr = highlighter.rank(datestr, celebration.rank)
+          end
+
+          if date == today
+            datestr = highlighter.today datestr
+          end
+          io.print datestr
+          if date.wday == 6
+            io.puts
+          else
+            io.print ' '
+          end
+        end
+      end
+
+      # localizable 2-character weekday shortcuts
+      def weekdays
+        @weekdays ||=
+          begin
+            sunday = Date.new 1987, 10, 25
+            sunday
+              .upto(sunday + 6)
+              .collect {|d| d.strftime('%a')[0..1] }
+              .join(' ')
+          end
+      end
+
+      # centers given string on a given line length
+      def center_on(line_length, content)
+        (' ' * (line_length / 2 - content.size / 2)) +
+          content
+      end
+
+      def print_columns(columns, io)
+        line_enumerators = columns.collect {|c| c.string.each_line }
+        not_yet_exhausted = Set.new line_enumerators
+        column_width = weekdays.size
+
+        loop do
+          break if not_yet_exhausted.empty?
+
+          line_enumerators.each do |l|
+            begin
+              line = l.next.chop
+              io.print line
+              io.print ' ' * (column_width - colour_aware_size(line))
+            rescue StopIteration
+              io.print ' ' * column_width
+              not_yet_exhausted.delete l
+            end
+            io.print '  '
+          end
+          io.puts
+        end
+      end
+
+      # String length ignoring colour codes
+      def colour_aware_size(str)
+        ColorizedString.new(str).uncolorize.size
+      end
+    end
+  end
+end

data/lib/calrom/highlighter/list.rb

@@ -1,8 +1,13 @@
 module Calrom
   module Highlighter
     class List
+      COLOUR_OVERRIDE = {
+        # 'colorize' does not know colour :violet
+        CR::Colours::VIOLET => :magenta,
+      }
+
       def colour(text, colour)
-        ColorizedString.new(text).colorize(colour.symbol)
+        ColorizedString.new(text).colorize(COLOUR_OVERRIDE[colour] || colour.symbol)
       end
 
       def rank(text, rank)

data/lib/calrom/highlighter/no.rb

@@ -0,0 +1,17 @@
+module Calrom
+  module Highlighter
+    class No
+      def colour(text, colour)
+        text
+      end
+
+      def rank(text, rank)
+        text
+      end
+
+      def today(text)
+        text
+      end
+    end
+  end
+end

data/lib/calrom/highlighter/overview.rb

@@ -0,0 +1,15 @@
+module Calrom
+  module Highlighter
+    class Overview < List
+      def rank(text, rank)
+        if rank.solemnity?
+          ColorizedString.new(text).colorize(mode: :bold)
+        elsif rank.feast?
+          ColorizedString.new(text).colorize(mode: :underline)
+        else
+          text
+        end
+      end
+    end
+  end
+end

data/lib/calrom/highlighter/selective.rb

@@ -0,0 +1,34 @@
+module Calrom
+  module Highlighter
+    class Selective
+      def initialize(selected, highlighter)
+        @selected = selected
+        @highlighter = highlighter
+      end
+
+      def colour(text, colour)
+        if @selected.include? __method__
+          @highlighter.public_send __method__, text, colour
+        else
+          text
+        end
+      end
+
+      def rank(text, rank)
+        if @selected.include? __method__
+          @highlighter.public_send __method__, text, rank
+        else
+          text
+        end
+      end
+
+      def today(text)
+        if @selected.include? __method__
+          @highlighter.public_send __method__, text
+        else
+          text
+        end
+      end
+    end
+  end
+end