calrom 0.1.0 → 0.4.0

data/lib/calrom/option_parser.rb

@@ -1,51 +1,301 @@
 require 'optparse'
+require 'pattern-match'
 
 module Calrom
   # Parses command line options, produces Config.
   class OptionParser
-    def self.call(argv)
-      config = Config.new
+    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(*args)
+      self.new.call(*args)
+    end
+
+    def call(argv, config = nil)
+      config ||= Config.new
 
       today = config.today
+
       year = today.year
       month = today.month
       day = nil
+      another_day = nil
 
       range_type = nil
 
-      opt_parser = ::OptionParser.new do |opts|
-        # for now does nothing, is default
-        opts.on('-l', '--list', 'list mode')
+      opt_parser = CustomizedOptionParser.new do |opts|
+        opts.banner = <<~EOS
+        Usage: calrom [options] [arg1 [arg2]]
+
+        Specifying date range (cal/ncal-compatible):
+
+          calrom             - current month
+          calrom -m 5        - May of the current year
+          calrom -m 5p       - May of the previous year
+          calrom -m 5f       - May of the following year
+          calrom -m 5 2000   - May 2000
+          calrom 5 2000      - also May 2000
+          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):
+
+          calrom 2000-05-31              - specified day (only)
+          calrom 2000-05-31 2000-07-01   - arbitrary date range
+          calrom (--yesterday|--today|--tomorrow)
+
+        EOS
 
-        opts.on('-mMONTH', '--month=MONTH', 'which month to list') do |value|
+        opts.separator 'Configuration files'
+
+        opts.on('--config=CONFIG', 'load configuration from file (may be used multiple times, all specified files will be loaded)') do |value|
+          config.configs << value
+        end
+
+        opts.separator 'Options selecting date range'
+
+        # cal
+        opts.on('-m MONTH', '--month=MONTH', 'display the specified month. \'f\' or \'p\' can be appended to display the same month of the following or previous year respectively') do |value|
           range_type = :month
-          month = value.to_i
+          if value =~ /^(\d+)([pf])$/
+            month = $1
+            year = validate_year(year) + ($2 == 'f' ? 1 : -1)
+          else
+            month = value
+          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 = today - 1
+          range_type = :day
+        end
+
+        opts.on('--today', 'display current day') do |value|
+          day = today
+          range_type = :day
+        end
+
+        opts.on('--tomorrow', 'display following day') do |value|
+          day = today + 1
+          range_type = :day
+        end
+
+        opts.separator "Options configuring liturgical calendar"
+
+        opts.on('-c CAL', '--calendar=CAL', 'specify (sanctorale) calendar to use. If repeated, layers all specified calendars one over another') do |value|
+          config.sanctorale << value
+        end
+
+        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
+
+        opts.separator 'Options affecting presentation'
+
+        opts.on('-l', '--list', 'display detailed listing of days and celebrations (synonym to --format=list)') do
+          config.formatter = :list
+        end
+
+        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
+        end
+
+        opts.on('--calendars', 'list bundled calendars') do |value|
+          config.formatter = :calendars
+        end
+
+        opts.on('--[no-]color', 'enable/disable colours (enabled by default)') do |value|
+          config.colours = value
+        end
+
+        opts.on('-v', '--verbose', 'enable verbose output') do
+          config.verbose = true
+        end
+
+        opts.separator 'Debugging options'
+
+        # cal
+        opts.on('-d YM', '--current-month=YM', 'use given month (YYYY-MM) as the current month (for debugging of date range selection)') do |value|
+          year, month = value.split '-'
+        end
+
+        # cal
+        opts.on('-H DATE', '--highlight-date=DATE', 'use given date as the current date (for debugging of highlighting)') do |value|
+          config.today = validate_day value
+        end
+
+        opts.separator 'Information regarding calrom'
+
+        opts.on('-V', '--version', 'display calrom version') do
+          puts 'calrom v' + Calrom::VERSION
+          puts 'using calendarium-romanum v' + CR::VERSION
+          exit
+        end
+
+        # Normally optparse defines this option by default, but once -H option is added,
+        # for some reason -h (if not defined explicitly) is treated as -H.
+        opts.on('-h', '--help', 'display this help') do
+          puts opts
+          exit
         end
       end
 
-      arguments = opt_parser.parse argv
+      begin
+        arguments = opt_parser.parse argv
+      rescue ::OptionParser::ParseError => e
+        raise Error.new(e.message)
+      end
 
-      if arguments.size > 0
-        arg = arguments[0]
-        if arg =~ /^\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
-          day = arg
-        else
+          day = date
+        end
+
+        with(_[iso_date_regexp.(date), iso_date_regexp.(another_date)]) do
+          range_type = :free
+          day = date
+          another_day = another_date
+        end
+
+        with(_[y]) do
           range_type ||= :year
-          year = arg.to_i
+          year = y
+        end
+
+        with(_[m, y]) do
+          range_type = :month
+          month, year = m, y
+        end
+
+        with([]) {}
+
+        with(_) do
+          raise InputError.new('too many arguments')
         end
       end
 
       config.date_range =
-        if range_type == :year
+        build_date_range(
+          range_type,
+          validate_year(year),
+          validate_month(month),
+          day && validate_day(day),
+          another_day && validate_day(another_day)
+        )
+
+      config.freeze
+    end
+
+    protected
+
+    def validate_year(year)
+      unless year.is_a?(Integer) || year =~ /^\d+$/
+        raise InputError.new("not a valid year #{year}")
+      end
+
+      year.to_i
+    end
+
+    def validate_month(month)
+      unless month.is_a?(Integer) ||
+             (month =~ /^\d+$/ && (1..12).include?(month.to_i))
+        raise InputError.new("not a valid month #{month}")
+      end
+
+      month.to_i
+    end
+
+    def validate_day(day)
+      return day if day.is_a? Date
+
+      Date.parse(day)
+    rescue ArgumentError
+      raise InputError.new("not a valid date #{day}")
+    end
+
+    def build_date_range(range_type, year, month, day, another_day=nil)
+      range =
+        case range_type
+        when :year
           Year.new(year)
-        elsif range_type == :day
-          Day.new(Date.parse(day))
+        when :day
+          Day.new(day)
+        when :free
+          DateRange.new(day, another_day)
+        when :three_months
+          ThreeMonths.new(year, month)
         else
           Month.new(year, month)
         end
 
-      config.freeze
+      beginning = CR::Calendar::EFFECTIVE_FROM
+      if range.first < beginning
+        raise InputError.new("implemented calendar system in use only since #{beginning}")
+      end
+
+      range
+    end
+
+    def supported_values(values)
+       " (supported: #{values.join(', ')})"
     end
   end
 end

data/lib/calrom/rc_parser.rb

@@ -0,0 +1,10 @@
+require 'shellwords'
+
+module Calrom
+  # Parses configuration file contents to an ARGV-like Array
+  class RcParser
+    def self.call(content)
+      Shellwords.split(content.gsub(/#.+?$/, ''))
+    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.1.0'
+  VERSION = '0.4.0'
 end

data/lib/calrom.rb

@@ -1,15 +1,34 @@
 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'
+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.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jakub Pavlík
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-05 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
@@ -39,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pattern-match
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +130,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -132,10 +147,25 @@ 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
+- lib/calrom/formatter/json.rb
 - lib/calrom/formatter/list.rb
+- lib/calrom/formatter/overview.rb
 - 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:
@@ -157,7 +187,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: Command line utility providing access to the Roman Catholic liturgical calendar