calrom 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d42310796615e6626842e77d06cf282159c50ce621910d7c44f61cfdc0de91ae
-  data.tar.gz: eb40b6b35e68543447d12ebb1ca91be7212a07c92e392ce50cc994b48e9103c7
+  metadata.gz: c2e561032a6b91d68a87839856d8ce94b794187a539ac544fc907cfd2568add7
+  data.tar.gz: 8c9ab4bbdc83cc0c9884dbb4fb9f658c578e83956ce63da45b8698f59c55124f
 SHA512:
-  metadata.gz: 66a58f4609c50cd65f581bf9cbc8e8c52c2d7330b475d0d45fd0cec9cf6c63d16259c2bbaf83bfde1726486bf8916edc399dd0b9e70287882e34b461fa0f010f
-  data.tar.gz: 7dd18b19ba33a6caa6da2ebb08eedcd0ca12ebcb56f8500e75c35acd61509bfcfe53541608937c205677bd3ad36c951aff197ef02915f020721051a652b8a304
+  metadata.gz: e49e7f177d74b28c08ad6bd6ea25c4579857a6ca16ec68483b8fa4e1ad62807754f7010aad598ee156f728e94fd203042ae31f669f187b6ca52f3abcc0a2eec3
+  data.tar.gz: 2d416f813d7e688b1e855dcb28f27ba47002118c7de8d526ef8b86cd9571edd1bde6fdd9c0eb4c40a23bae75ab17fa66df43a7628b8f3d5ac5d29fd0be7b8bf7

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # oldest supported and newest MRI
+        # TODO: versions known to have worked back in Travis days; update needed
+        ruby-version:
+          - 2.5.0
+          - 3.0.0
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install --jobs=3
+      - name: Run tests
+        run: bundle exec rake

data/.travis.yml

@@ -1,11 +1,11 @@
 language: ruby
 
-dist: trusty
+dist: focal
 
 # oldest supported and newest MRI
 rvm:
   - 2.5.0
-  - 2.7.1
+  - 3.0.0
 
 install: bundle install --jobs=3
 

data/CHANGELOG.md

@@ -1,5 +1,57 @@
 # Changelog
 
+## [0.4.0] 2022-06-27
+
+### Added
+
+- date range selection: cal-like option `-3` to select the current month together
+  with the preceding and following one (contributed by Fabio Soares @fabiosoaresv)
+- if exactly one sanctorale data file is specified and its YAML front matter
+  references a parent calendar (key `extends`), the file is loaded with its complete
+  graph of parents
+- option `--[no-]load-parents` to explicitly enable/disable loading of parent calendars
+- basic support for remote calendars: the `--calendar=` option now accepts
+  also a calendar API URL like
+  `--calendar=http://calapi.inadiutorium.cz/api/v0/en/calendars/general-la`,
+  the referenced API is expected to be compatible with
+  [Liturgical Calendar API](http://calapi.inadiutorium.cz/) v0
+- calendar listing (`--calendars`) marks default calendar as such
+- calendar listing lists each calendar's parents
+- option `--verbose`
+- condensed view (`--format=condensed`), intended for use cases like printing current day
+  in a window manager toolbar and the like
+- option `--to-sunday=` to configure which temporale solemnities should be transferred to Sunday
+  (e.g. `--to-sunday=epiphany`)
+- option `--temporale-extension=` to activate temporale extension
+  (supported values are [temporale extension](https://github.com/igneus/calendarium-romanum/tree/master/lib/calendarium-romanum/temporale/extensions)
+  class names, e.g. `--temporale-extension=ChristEternalPriest`)
+- any class in the `Calrom::Formatter` module is considered formatter and its
+  lowercased name can be used as value for the `--format=` option - custom formatters
+  can be added by defining new classes in the namespace
+- options `--day-filter=` and `--celebration-filter=` for filtering days and celebrations
+  by a Ruby expression
+- environment variable `CALROM_CURRENT_DATE` can be used to override current date
+  (intended mainly for testing)
+
+### Changed
+
+- automated locale selection based on sanctorale data file relies solely on the `locale` key
+  of the file's YAML front matter (previously it relied on a file naming convention)
+- option `--calendar=` expands tilde in path (if it isn't expanded by shell,
+  as is the case e.g. in configuration files)
+- when displaying just a single day, highlighting of the current day is disabled by default
+  (i.e. if the day being displayed is current day, it won't be highlighted as such)
+- list view (`--list`): rank is not printed for ferials and Sundays
+- overview view always arranges the displayed months in multiple columns, just like `cal`
+  (previously date ranges spanning less than three months were printed in a single column)
+- date range specification: support for dates with year higher than 9999 (e.g. `10000-01-01`)
+
+### Fixed
+
+- crash on invalid value of `--locale`
+- list view: when printing a date range between the same months of different years
+  (e.g. 2000-01-xx .. 2001-01-xx), year was not printed in month headings
+
 ## [0.3.0] 2020-06-21
 
 ### Added

data/README.md

@@ -1,6 +1,6 @@
 # calrom
 
-[![Build Status](https://travis-ci.org/calendarium-romanum/calrom.svg?branch=master)](https://travis-ci.org/calendarium-romanum/calrom)
+![Build Status](https://github.com/calendarium-romanum/calrom/actions/workflows/ci.yml/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/calrom.svg)](https://badge.fury.io/rb/calrom)
 
 Command line utility providing access to the Roman Catholic
@@ -46,6 +46,35 @@ Print liturgical calendar for the current month (default):
 
 `$ calrom 2028-01-15 2028-03-07`
 
+### Day and celebration filtering
+
+In addition to specifying date range, filtering is a way to further refine
+the selection of data to be displayed. Options `--day-filter=` and `--celebration-filter=`
+both accept a snippet of Ruby code, which is then `eval`ed in context of each
+`CalendariumRomanum::Day` / `CalendariumRomanum::Celebration` within the selected date range
+and only days/celebrations for which the expression evaluates truthy are displayed.
+
+Display only Saturdays:
+
+`$ calrom --day-filter='date.saturday?'`
+
+Display all Mondays with a celebration of a rank higher than memorial:
+
+`$ calrom --day-filter='date.monday?' --day-filter='celebrations[0].rank > MEMORIAL_GENERAL'`
+
+(As you can see, `calendarium-romanum` constants like ranks or seasons are available
+as top-level constants. Noone likes extensive writing in the terminal.)
+
+Display only ferials:
+
+`$ calrom --celebration-filter='ferial?'`
+
+Display only celebrations in green:
+
+`$ calrom --celebration-filter='colour == GREEN'`
+
+The options can be combined and used repeatedly to narrow the selection down as needed.
+
 ### Selecting calendar
 
 There are a few calendars bundled in calrom (actually in the calendarium-romanum gem)
@@ -69,12 +98,28 @@ of the local church:
 
 `$ calrom --calendar=universal-la --calendar=path/to/our_local_celebrations.txt`
 
+Please note that specifying more than one calendar disables automatic loading of
+parent calendars. If any of the listed calendars extends a parent calendar,
+the parent either has to be explicitly listed using the `--calendar` option in order to be loaded,
+or automatic parent loading has to be explicitly enabled using the `--load-parents` option.
+
+Limited support for remote calendars is provided. Calendar URL from the
+[Liturgical Calendar API](http://calapi.inadiutorium.cz/) or a compatible calendar API
+is accepted as a value of `--calendar=`:
+
+`$ calrom --calendar=http://calapi.inadiutorium.cz/api/v0/en/calendars/general-la`
+
 ### Data presentation settings
 
 Print detailed listing:
 
 `$ calrom -l`
 
+Print current day in a condensed format (intended mainly for use cases like
+window manager toolbars):
+
+`$ calrom --format=condensed --today`
+
 Disable colours:
 
 `$ calrom --no-color`
@@ -94,13 +139,11 @@ They are processed in this order and both are used if available.
 Their syntax is that of shell options and arguments (with the sole exception that newline
 is not considered end of shell input, but generic whitespace), supported are all options and arguments
 accepted by the command.
-It usually makes sense to use configuration files only for the most fundamental settings
-you will never change, like selecting calendar (if you know you will always check this single one)
-or disabling colours (if you hate colourful output).
 
 If a custom configuration file location is specified on the command line,
 `$ calrom --config=path/to/my/custom/config`, the standard system-wide and user-specific configuration
-files are *not* loaded.
+files are *not* loaded. Empty config path `$ calrom --config=` makes calrom ignore all configuration
+files and use the built-in default configuration.
 
 Example configuration file, loading the proper calendar of the archdiocese of Prague
 and disabling colours:
@@ -108,15 +151,27 @@ and disabling colours:
 ```bash
 # shell-like comments can be used in configuration files
 
---calendar=czech-cs       # celebrations common for the whole Czech Republic
---calendar=czech-cechy-cs # Bohemia
---calendar=czech-praha-cs # archdiocese of Prague
---calendar=/home/igneus/calendar_data/local_church.txt # path to a custom calendar file with proper celebrations of the parish where I live (titular feast of the church, dedication)
+--calendar=czech-praha-cs # calendar of the archdiocese of Prague
+--calendar=~/calendar_data/local_church.txt # path to a custom calendar file with proper celebrations of the parish where I live (titular feast of the church, dedication)
+
+--load-parents # load also parent calendars specified by the calendar file(s)
+               # (default if just one calendar file is specified, but we specified two)
 
 --no-color # disable colours
 ```
 
-(Configuration file format is inspired by [.rspec][dotrspec].)
+(Configuration file format is inspired by [.rspec][dotrspec], [.yardopts][dotyardopts]
+and others.)
+
+Most options work in such a way that if several conflicting options are provided,
+the last one wins. You can thus e.g. set your favourite display format (e.g. `--list`)
+or date range (e.g. `-3`) in the configuration file and override it, if necessary,
+by providing some other option from the same group on the command line.
+An exception from this rule is the `--calendar=` option, repeated occurrences of which
+do not cancel each other, but are all composed together in the given order to build a calendar
+by layering.
+Also repeated occurrences of the `--day-filter=` and `--celebration-filter=` options
+don't cancel each other, but all specified filtering expressions are applied.
 
 ## Running tests
 
@@ -131,17 +186,16 @@ Clone the repository, `$ bundle install` to install dependencies, then:
 ## Project roadmap
 
 * [x] detailed listing of a day/month/year/range of dates
-* [ ] month/year overview - options and output mostly mimicking
+* [x] month/year overview - options and output mostly mimicking
   the BSD Unix [`cal`][cal] utility,
   but with liturgical colours and celebration ranks
-* [ ] condensed format (but with detailed information) suitable for awesome/i3 toolbars etc.
+* [x] condensed format (but with detailed information) suitable for awesome/i3 toolbars etc.
 * [x] machine-readable detailed listing
 * [ ] year summary: lectionary cycles, movable feasts
 * [x] configuration file to set default options
 * [x] specify calendar data path (with support for layering several calendars)
 * [ ] option to auto-select one of optional celebrations - with multiple supported strategies (prefer ferial, take first non-ferial, configured whitelist, blacklist)
 * [ ] integrate online data sources
-* [ ] interactive browsing
 
 ## Backward compatibility
 
@@ -168,7 +222,7 @@ command line interface
 
 * [(BSD version of) `cal`][cal] should be mimicked where reasonable
 * the [Command-Line Options][taoup] chapter from E. S. Raymond's
-  "The Art of Unix Programming" should be consulted in the rest
+  *The Art of Unix Programming* should be consulted in the rest
   of cases
 
 ## License
@@ -182,3 +236,4 @@ GNU/GPL 3.0 or later
 [cal]: https://www.freebsd.org/cgi/man.cgi?query=cal
 [taoup]: http://www.catb.org/esr/writings/taoup/html/ch10s05.html
 [dotrspec]: https://relishapp.com/rspec/rspec-core/v/2-0/docs/configuration/read-command-line-configuration-options-from-files
+[dotyardopts]: https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#yardopts-options-file

data/calrom.gemspec

@@ -20,7 +20,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'calendarium-romanum', '~> 0.6.0'
+  spec.add_dependency 'calendarium-romanum', '~> 0.9.0'
+  spec.add_dependency 'calendarium-romanum-remote', '~> 0.3.0'
   spec.add_dependency 'colorize', '~> 0.8'
   spec.add_dependency 'pattern-match', '~> 1.0'
 

data/lib/calrom/cli.rb

@@ -4,20 +4,42 @@ module Calrom
       begin
         config_files = OptionParser.call(argv).configs
 
+        config = EnvironmentReader.call
         config = OptionParser.call(
           rc_options(config_files.empty? ? nil : config_files) +
-          argv
+          argv,
+          config
         )
 
         calendar = config.calendar
-      rescue ::OptionParser::ParseError, InputError => e
+      rescue OptionParser::Error, InputError => e
         STDERR.puts e.message
         exit 1
       end
 
-      I18n.locale = config.locale
+      begin
+        I18n.locale = config.locale
+      rescue I18n::InvalidLocale
+        locales_help = I18n.available_locales.join(', ')
+        STDERR.puts "Locale '#{config.locale}' unsupported (available locales: #{locales_help})"
+        exit 1
+      end
+
+      unless config.verbose
+        HTTPI.log = false
+      end
 
-      config.formatter.call calendar, config.date_range
+      begin
+        config.build_formatter.call calendar, config.date_range
+      rescue CR::Remote::UnexpectedResponseError => e
+        STDERR.puts "Remote calendar query failed: #{e.message}"
+        exit 1
+      rescue InputError => e
+        STDERR.puts e.message
+        exit 1
+      rescue Errno::EPIPE
+        # broken pipe - simply stop execution, exit successfully
+      end
     end
 
     private
@@ -42,7 +64,7 @@ module Calrom
 
         begin
           OptionParser.call(options)
-        rescue ::OptionParser::ParseError => e
+        rescue OptionParser::Error => e
           raise InputError.new("Error loading '#{f}': #{e.message}")
         end
 

data/lib/calrom/config.rb

@@ -8,12 +8,55 @@ module Calrom
       self.date_range = Month.new(today.year, today.month)
       self.sanctorale = []
       self.configs = []
+      self.verbose = false
+      self.highlight = Set.new(%i(colour rank today))
+      self.transfer_to_sunday = []
+      self.temporale_extensions = []
+      self.filter_days = []
+      self.filter_celebrations = []
     end
 
-    attr_accessor :today, :date_range, :formatter, :colours, :sanctorale, :locale, :configs
+    ATTRIBUTES = [
+      :today,
+      :date_range,
+      :formatter,
+      :colours,
+      :sanctorale,
+      :transfer_to_sunday,
+      :temporale_extensions,
+      :locale,
+      :configs,
+      :load_parents,
+      :highlight,
+      :verbose,
+      :filter_days,
+      :filter_celebrations,
+    ]
+
+    attr_accessor *ATTRIBUTES
+
+    def ==(b)
+      self.class == b.class &&
+        ATTRIBUTES.all? {|prop| public_send(prop) == b.public_send(prop) }
+    end
 
     def calendar
-      CR::PerpetualCalendar.new(sanctorale: build_sanctorale)
+      calendar =
+        if is_remote_calendar?
+          if @sanctorale.size > 1
+            raise InputError.new '--calendar option provided multiple times, but at least one of the calendars is remote. Remote calendars cannot be layered.'
+          end
+
+          CR::Remote::Calendar.new date_range.first.year, @sanctorale.last
+        else
+          CR::PerpetualCalendar.new(sanctorale: build_sanctorale, temporale_options: temporale_options, vespers: true)
+        end
+
+      FilteringCalendar.new(
+        calendar,
+        filter_days,
+        filter_celebrations,
+      )
     end
 
     def build_sanctorale
@@ -22,56 +65,86 @@ module Calrom
       end
 
       data = @sanctorale.collect do |s|
+        expanded = File.expand_path s
+
         if s == '-'
           CR::SanctoraleLoader.new.load_from_string STDIN.read
-        elsif File.file? s
-          CR::SanctoraleLoader.new.load_from_file s
-        elsif CR::Data[s]
-          CR::Data[s].load
         else
-          raise InputError.new "\"#{s}\" is neither a file, nor a valid identifier of a bundled calendar. " +
-                               "Valid identifiers are: " +
-                               CR::Data.each.collect(&:siglum).inspect
+          data_file =
+            if File.file? expanded
+              SanctoraleFile.new expanded
+            elsif CR::Data[s]
+              CR::Data[s]
+            else
+              raise InputError.new "\"#{s}\" is neither a file, nor a valid identifier of a bundled calendar. " +
+                                   "Valid identifiers are: " +
+                                   CR::Data.each.collect(&:siglum).inspect
+            end
+
+          if load_parents?
+            data_file.load_with_parents
+          else
+            data_file.load
+          end
         end
       end
 
       CR::SanctoraleFactory.create_layered(*data)
     end
 
+    def temporale_options
+      {transfer_to_sunday: transfer_to_sunday, extensions: temporale_extensions}
+    end
+
     def locale
-      @locale || locale_in_file_name || DEFAULT_LOCALE
+      @locale || locale_in_file_metadata || DEFAULT_LOCALE
     end
 
-    def formatter
-      if @formatter == :list || (@formatter.nil? && date_range.is_a?(Day))
-        Formatter::List.new highlighter(Highlighter::List), today
-      elsif @formatter == :easter
-        Formatter::Easter.new
-      elsif @formatter == :calendars
-        Formatter::Calendars.new highlighter(Highlighter::Overview), today
-      elsif @formatter == :csv
-        Formatter::Csv.new
-      elsif @formatter == :json
-        Formatter::Json.new
-      else
-        Formatter::Overview.new highlighter(Highlighter::Overview), today
+    def build_formatter
+      highlighter = Highlighter::List
+      klass = @formatter && Formatter.const_get(@formatter.capitalize)
+
+      if @formatter.nil?
+        klass = date_range.is_a?(Day) ? Formatter::List : Formatter::Overview
+      end
+
+      if [Formatter::Calendars, Formatter::Overview].include? klass
+        highlighter = Highlighter::Overview
       end
+
+      klass.new build_highlighter(highlighter), today
     end
 
-    def highlighter(colourful)
+    def build_highlighter(colourful)
       if (self.colours == false || (self.colours.nil? && !STDOUT.isatty))
         return Highlighter::No.new
       end
 
-      colourful.new
+      Highlighter::Selective.new highlight, colourful.new
+    end
+
+    # Should calendars be loaded including parent files they reference?
+    def load_parents?
+      load_parents == true ||
+        (load_parents.nil? && @sanctorale.size == 1)
+    end
+
+    def highlight
+      if date_range.is_a? Day
+        @highlight - [:today]
+      else
+        @highlight
+      end
     end
 
     private
 
-    def locale_in_file_name
-      locale = (sanctorale.last || DEFAULT_DATA.siglum).split('-').last&.to_sym
+    def locale_in_file_metadata
+      is_remote_calendar? ? nil : build_sanctorale.metadata['locale']&.to_sym
+    end
 
-      I18n.available_locales.include?(locale) ? locale : nil
+    def is_remote_calendar?
+      !!@sanctorale.find {|s| s =~ /^https?:\/\// }
     end
   end
 end

data/lib/calrom/date_range.rb

@@ -13,7 +13,6 @@ module Calrom
         .each_with_index do |m,i|
         if i == 0 && first.day > 1
           # first month, incomplete
-          end_of_month = first.next_month - first.day + 1
           yield self.class.new(first, m.last)
         elsif m.first.year == last.year && m.first.month == last.month && last != m.last
           # last month, incomplete
@@ -23,6 +22,11 @@ module Calrom
         end
       end
     end
+
+    def spans_multiple_months?
+      first.month != last.month ||
+        first.year != last.year
+    end
   end
 
   class Year < DateRange
@@ -41,11 +45,30 @@ module Calrom
     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)
       @year = year
       @month = month
-      super Date.new(year, month, 1), next_month_beginning - 1
+
+      super Date.new(year, month, 1), Date.new(year, month, -1)
     end
 
     def to_s
@@ -59,7 +82,7 @@ module Calrom
     end
 
     def succ
-      n = next_month_beginning
+      n = Date.new(@year, @month, 1).next_month
       self.class.new(n.year, n.month)
     end
 
@@ -76,16 +99,6 @@ module Calrom
     protected
 
     attr_reader :year, :month
-
-    private
-
-    def next_month_beginning
-      if @month == 12
-        Date.new(@year + 1, 1, 1)
-      else
-        Date.new(@year, @month + 1, 1)
-      end
-    end
   end
 
   class Day < DateRange

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/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

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module Calrom
   module Formatter
     # Prints list of available bundled calendars
@@ -7,16 +5,25 @@ module Calrom
       def call(calendar, date_range)
         last_locale = nil
         CR::Data.each do |d|
-          meta = load_front_matter d
+          sanctorale = d.load_with_parents
+          meta = sanctorale.metadata
           puts if last_locale && last_locale != meta['locale']
-          puts "%-20s:  %s  [%s]" % [d.siglum, meta['title'], 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
-
-      def load_front_matter(data_file)
-        YAML.load File.read data_file.path
-      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

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

data/lib/calrom/formatter/easter.rb

@@ -1,7 +1,7 @@
 module Calrom
   module Formatter
     # Prints (only) date of Easter for the specified year.
-    class Easter
+    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'

data/lib/calrom/formatter/formatter.rb

@@ -1,15 +1,26 @@
 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(calendar, date_range)
       end
+
+      private
+
+      def puts(s = '')
+        @io.puts s
+      end
+
+      def print(s)
+        @io.print s
+      end
     end
   end
 end

data/lib/calrom/formatter/json.rb

@@ -3,14 +3,14 @@ require 'json'
 module Calrom
   module Formatter
     # JSON format mimicking Church Calendar API v0 (https://github.com/igneus/church-calendar-api)
-    class Json
+    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 "["
 
-        date_range.each_with_index do |date, i|
-          day = calendar[date]
+        calendar.each_day_in_range(date_range).each_with_index do |day,i|
+          date = day.date
           hash = {
             date: date,
             season: day.season.symbol,

data/lib/calrom/formatter/list.rb

@@ -2,22 +2,20 @@ module Calrom
   module Formatter
     class List < Formatter
       def call(calendar, date_range)
-        print_months = date_range.first.month != date_range.last.month
+        print_months = date_range.spans_multiple_months?
 
         puts date_range.to_s
         puts
 
         current_month = nil
 
-        date_range.each do |date|
-          liturgical_day = calendar[date]
-
+        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 unless current_month == nil
             puts liturgical_day.date.strftime('%B') #current_month
             puts
+
+            current_month = liturgical_day.date.month
           end
 
           day liturgical_day
@@ -42,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

@@ -4,10 +4,10 @@ require 'stringio'
 module Calrom
   module Formatter
     class Overview < Formatter
-      def call(calendar, date_range, io = STDOUT)
-        colnum = (date_range.is_a?(Year) || date_range.each_month.to_a.size > 3) ? 3 : 1 # TODO: expose configuration
+      def call(calendar, date_range)
+        colnum = 3 # TODO: expose configuration
         if date_range.is_a? Year
-          io.puts center_on(weekdays.size * colnum + 2 * (colnum - 1), date_range.to_s)
+          puts center_on(weekdays.size * colnum + 2 * (colnum - 1), date_range.to_s)
         end
 
         date_range.each_month.each_slice(colnum) do |months|
@@ -16,7 +16,7 @@ module Calrom
               print_month io, calendar, month, date_range.is_a?(Year)
             end
           end
-          print_columns columns, io
+          print_columns columns, @io
         end
       end
 
@@ -29,14 +29,19 @@ module Calrom
         io.puts weekdays
 
         io.print '   ' * month.first.wday
-        month.each do |date|
-          liturgical_day = calendar[date]
+        calendar.each_day_in_range(month, include_skipped: true) do |liturgical_day|
+          date = liturgical_day.date
 
-          celebration = liturgical_day.celebrations.first
+          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
 
-          datestr = date.day.to_s.rjust(2)
-          datestr = highlighter.colour(datestr, celebration.colour)
-          datestr = highlighter.rank(datestr, celebration.rank)
           if date == today
             datestr = highlighter.today datestr
           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

data/lib/calrom/option_parser.rb

@@ -6,20 +6,28 @@ module Calrom
   class OptionParser
     using PatternMatch
 
+    # Raised when the options being parsed are invalid.
+    #
+    # Exceptions raised by the option parsing library are translated to this exception,
+    # thus hiding implementation details (the option parsing library's exception types)
+    # from the outer world.
+    class Error < RuntimeError; end
+
     class CustomizedOptionParser < ::OptionParser
       def separator(string)
         super "\n" + string
       end
     end
 
-    def self.call(argv)
-      self.new.call(argv)
+    def self.call(*args)
+      self.new.call(*args)
     end
 
-    def call(argv)
-      config = Config.new
+    def call(argv, config = nil)
+      config ||= Config.new
 
       today = config.today
+
       year = today.year
       month = today.month
       day = nil
@@ -42,6 +50,7 @@ module Calrom
           calrom 2000        - whole year 2000
           calrom -y 2000     - also whole year 2000
           calrom -y          - whole current year
+          calrom -3          - display the previous, current and next month surrounding today
 
         Specifying date range (not cal-compatible):
 
@@ -70,23 +79,28 @@ module Calrom
           end
         end
 
+        # cal
+        opts.on('-3', 'display the previous, current and next month surrounding today') do |value|
+          range_type = :three_months
+        end
+
         # cal
         opts.on('-y', '--year', 'display specified (or current) year') do |value|
           range_type = :year
         end
 
         opts.on('--yesterday', 'display previous day') do |value|
-          day = Date.today - 1
+          day = today - 1
           range_type = :day
         end
 
         opts.on('--today', 'display current day') do |value|
-          day = Date.today
+          day = today
           range_type = :day
         end
 
         opts.on('--tomorrow', 'display following day') do |value|
-          day = Date.today + 1
+          day = today + 1
           range_type = :day
         end
 
@@ -96,8 +110,21 @@ module Calrom
           config.sanctorale << value
         end
 
-        locales_help = I18n.available_locales.join(', ')
-        opts.on('--locale=LOCALE', "override language in which temporale celebration titles are rendered (supported: #{locales_help})") do |value|
+        opts.on('--[no-]load-parents', 'explicitly enable/disable parent calendar loading') do |value|
+          config.load_parents = value
+        end
+
+        transferable = CR::Temporale::SUNDAY_TRANSFERABLE_SOLEMNITIES
+        opts.on('--to-sunday=SOLEMNITY', transferable, 'transfer solemnity to Sunday' + supported_values(transferable)) do |value|
+          config.transfer_to_sunday << value.to_sym
+        end
+
+        extensions = CR::Temporale::Extensions.all.collect {|cls| cls.name.split('::').last.to_sym }
+        opts.on('--temporale-extension=EXTENSION', extensions, 'use temporale extension' + supported_values(extensions)) do |value|
+          config.temporale_extensions << CR::Temporale::Extensions.const_get(value)
+        end
+
+        opts.on('--locale=LOCALE', 'override language in which temporale celebration titles are rendered' + supported_values(I18n.available_locales)) do |value|
           config.locale = value.to_sym
         end
 
@@ -107,12 +134,23 @@ module Calrom
           config.formatter = :list
         end
 
-        supported_formats = %i(overview list csv json)
+        supported_formats =
+          Calrom::Formatter.constants
+            .collect(&:downcase)
+            .delete_if {|i| i == :formatter }
         formats_help = supported_formats.join(', ')
         opts.on('--format=FORMAT', supported_formats, "specify output format (supported: #{formats_help})") do |value|
           config.formatter = value
         end
 
+        opts.on('--day-filter=EXPR', 'display only days for which the expression (Ruby snippet executed in context of each CalendariumRomanum::Day instance) evaluates as truthy') do |expr|
+          config.filter_days << expr
+        end
+
+        opts.on('--celebration-filter=EXPR', 'display only celebrations for which the expression (Ruby snippet executed in context of each CalendariumRomanum::Celebration instance) evaluates as truthy') do |expr|
+          config.filter_celebrations << expr
+        end
+
         # cal
         opts.on('-e', '--easter', 'display date of Easter (only)') do
           config.formatter = :easter
@@ -126,6 +164,10 @@ module Calrom
           config.colours = value
         end
 
+        opts.on('-v', '--verbose', 'enable verbose output') do
+          config.verbose = true
+        end
+
         opts.separator 'Debugging options'
 
         # cal
@@ -142,6 +184,7 @@ module Calrom
 
         opts.on('-V', '--version', 'display calrom version') do
           puts 'calrom v' + Calrom::VERSION
+          puts 'using calendarium-romanum v' + CR::VERSION
           exit
         end
 
@@ -153,9 +196,13 @@ module Calrom
         end
       end
 
-      arguments = opt_parser.parse argv
+      begin
+        arguments = opt_parser.parse argv
+      rescue ::OptionParser::ParseError => e
+        raise Error.new(e.message)
+      end
 
-      iso_date_regexp = /^(\d{4}-\d{2}-\d{2})$/
+      iso_date_regexp = /^(\d{4,}-\d{2}-\d{2})$/
       match(arguments) do
         with(_[iso_date_regexp.(date)]) do
           range_type = :day
@@ -233,6 +280,8 @@ module Calrom
           Day.new(day)
         when :free
           DateRange.new(day, another_day)
+        when :three_months
+          ThreeMonths.new(year, month)
         else
           Month.new(year, month)
         end
@@ -244,5 +293,9 @@ module Calrom
 
       range
     end
+
+    def supported_values(values)
+       " (supported: #{values.join(', ')})"
+    end
   end
 end

data/lib/calrom/refinement/calendarium-romanum/triduum_nameclash_workaround.rb

@@ -0,0 +1,34 @@
+module Calrom
+  module Refinement
+    module CalendariumRomanum
+      # Refinement used when evaluating the Day/Celebration filter expressions.
+      # Allows the user (at least in simple cases) to write just `TRIDUUM` both
+      # as a season and as a rank.
+      module TriduumNameClashWorkaround
+        refine CR::Season do
+          alias_method :old_equal, :==
+
+          def ==(other)
+            if other.is_a?(CR::Rank) && self == CR::Seasons::TRIDUUM
+              return CR::Ranks::TRIDUUM == other
+            end
+
+            old_equal other
+          end
+        end
+
+        refine CR::Rank do
+          alias_method :old_equal, :==
+
+          def ==(other)
+            if other.is_a?(CR::Season) && self == CR::Ranks::TRIDUUM
+              return CR::Seasons::TRIDUUM == other
+            end
+
+            old_equal other
+          end
+        end
+      end
+    end
+  end
+end

data/lib/calrom/sanctorale_file.rb

@@ -0,0 +1,14 @@
+module Calrom
+  # Wraps arbitrary sanctorale files and allows handling and loading them exactly
+  # the same way as bundled sanctorale files.
+  #
+  # Erm, yes, according to calendarium-romanum documentation the parent class is actually
+  # not intended for use like this. But we take the risk of breakage by future
+  # calendarium-romanum releases ;)
+  class SanctoraleFile < CR::Data::SanctoraleFile
+    def initialize(path)
+      @siglum = nil
+      @path = path
+    end
+  end
+end

data/lib/calrom/version.rb

@@ -1,3 +1,3 @@
 module Calrom
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/calrom.rb

@@ -1,20 +1,29 @@
 require 'calendarium-romanum'
+require 'calendarium-romanum/remote'
 require 'colorized_string'
 
+# make useful calendarium-romanum constants available as top-level constants
+include CalendariumRomanum::Constants
+
 module Calrom
   CR = CalendariumRomanum
 end
 
 require 'calrom/version'
+require 'calrom/refinement/calendarium-romanum/triduum_nameclash_workaround'
 require 'calrom/cli'
 require 'calrom/option_parser'
+require 'calrom/environment_reader'
 require 'calrom/config'
 require 'calrom/date_range'
 require 'calrom/rc_parser'
 require 'calrom/exceptions'
+require 'calrom/sanctorale_file'
+require 'calrom/filtering_calendar'
 require 'calrom/formatter/formatter'
 require 'calrom/formatter/list'
 require 'calrom/formatter/overview'
+require 'calrom/formatter/condensed'
 require 'calrom/formatter/csv'
 require 'calrom/formatter/json'
 require 'calrom/formatter/easter'
@@ -22,3 +31,4 @@ require 'calrom/formatter/calendars'
 require 'calrom/highlighter/no'
 require 'calrom/highlighter/list'
 require 'calrom/highlighter/overview'
+require 'calrom/highlighter/selective'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calrom
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jakub Pavlík
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-21 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: calendarium-romanum
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: calendarium-romanum-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +130,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -132,8 +147,11 @@ files:
 - lib/calrom/cli.rb
 - lib/calrom/config.rb
 - lib/calrom/date_range.rb
+- lib/calrom/environment_reader.rb
 - lib/calrom/exceptions.rb
+- lib/calrom/filtering_calendar.rb
 - lib/calrom/formatter/calendars.rb
+- lib/calrom/formatter/condensed.rb
 - lib/calrom/formatter/csv.rb
 - lib/calrom/formatter/easter.rb
 - lib/calrom/formatter/formatter.rb
@@ -143,8 +161,11 @@ files:
 - lib/calrom/highlighter/list.rb
 - lib/calrom/highlighter/no.rb
 - lib/calrom/highlighter/overview.rb
+- lib/calrom/highlighter/selective.rb
 - lib/calrom/option_parser.rb
 - lib/calrom/rc_parser.rb
+- lib/calrom/refinement/calendarium-romanum/triduum_nameclash_workaround.rb
+- lib/calrom/sanctorale_file.rb
 - lib/calrom/version.rb
 homepage: https://github.com/calendarium-romanum/calrom
 licenses: