calrom 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f2a47dec05e4ed520cbe19a3057f8b2a2846659
-  data.tar.gz: 26d20de0bb41c7054a20c22c0b5cbcd44e57e130
+SHA256:
+  metadata.gz: 8080fbff35aedfe1af84126ea841c66f8f3a36a513bc89b4a5f2a736a7b3205f
+  data.tar.gz: c0ff3d64def3e7b227ba4f64e145e0c589c449ec516a04d82a2252d7d4456bf3
 SHA512:
-  metadata.gz: 1a8246694c98d8525a693b2afc72170205c715a59b79877c8e5b805846dc394e69be9b71bce65a5b50b56d22916f84610932140483ca1ed50577fcb5c708f1bc
-  data.tar.gz: 48f9f4df5a0d75f8eed66520c48b27173f10eb16dd17a7b0f685435d2e6f117dbd97af15cda3b4406ea3290839da81244895fc68cdb57b8fb78abfe29d4c729b
+  metadata.gz: 0cf9192362ddd378d703835fab6861e72c8cfd080a7320207bf8e02366898f75152bc8b036709685f0008b5e1afea91b064e6b620f5dedc54e4f797ff0fa5a8e
+  data.tar.gz: cf71e5c86049312c0568d725e0d236e57e9ad0cd205f729f8740af0922d30a4f2f028548abfdc1bc69ee30fcc6fc23f4dc6278ceafce9ac6774a97af3f1abd11

data/.travis.yml

@@ -1,5 +1,15 @@
-sudo: false
 language: ruby
+
+dist: trusty
+
+# oldest supported and newest MRI
 rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.13.6
+  - 2.5.0
+  - 2.7.1
+
+install: bundle install --jobs=3
+
+script: bundle exec rake
+
+git:
+  depth: 3

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [0.2.0] 2020-01-14
+
+### Added
+
+- cal-like view (is now default for month, year and date range listing)
+- support more cal-like ways of specifying date range
+  - month argument `calrom MONTH YEAR` (as an alternative to month option `cal -m MONTH YEAR`)
+  - month option with p/f flag `calrom -m 5p` / `calrom -m 5f` as a shortcut to specify a month of the previous/following year
+  - option to print the whole current year `calrom -y`
+- support arbitrary date range specified as two ISO dates
+- input is validated, errors handled and reported
+- cal-like option to print (only) the date of Easter
+- cal-like debugging options `-d` and `-H`
+- option `--[no-]color` to enable/disable ANSI colours (enabled by default)
+
+### Changed
+
+- list view: contains weekday names; month names instead of month numbers
+
+### Fixed
+
+- unhandled edge-case in `Calrom::Month` when dealing with the end of a year
+- liturgical colour violet
+
 ## [0.1.0] 2019-10-05
 
 ### Added

data/README.md

@@ -1,5 +1,8 @@
 # calrom
 
+[![Build Status](https://travis-ci.org/calendarium-romanum/calrom.svg?branch=master)](https://travis-ci.org/calendarium-romanum/calrom)
+[![Gem Version](https://badge.fury.io/rb/calrom.svg)](https://badge.fury.io/rb/calrom)
+
 Command line utility providing access to the Roman Catholic
 liturgical calendar (post-Vatican II).
 
@@ -9,11 +12,63 @@ Built on top of the [calendarium-romanum][caro] Ruby gem.
 
 calrom is a Ruby gem:
 
-`gem install calrom`
+`$ gem install calrom`
+
+## Usage
+
+### Specifying date range
+
+Print liturgical calendar for the current month (default):
+
+`$ calrom`
+
+... for a specified month of the current year:
+
+`$ calrom -m 9`
+
+... for a specified month of another year:
+
+`$ calrom -m 1 2028` or `$ calrom 1 2028`
+
+... for a whole year:
+
+`$ calrom 2017`
+
+... for the current year:
+
+`$ calrom -y`
+
+... for a specified date:
+
+`$ calrom 2028-01-15`
+
+... for an arbitrary date range:
+
+`$ calrom 2028-01-15 2028-03-07`
+
+### Data presentation settings
+
+Print detailed listing:
+
+`$ calrom -l`
+
+Disable colours:
+
+`$ calrom --no-color`
+
+## Running tests
+
+Clone the repository, `$ bundle install` to install dependencies, then:
+
+`$ rake cucumber` - run specs describing the command line interface
+
+`$ rake spec` - run specs describing internal implementation details
+
+`$ rake` - run all groups of specs one after another
 
 ## Project roadmap
 
-* [ ] detailed listing of a day/month/year/range of dates
+* [x] detailed listing of a day/month/year/range of dates
 * [ ] month/year overview - options and output mostly mimicking the
   the BSD Unix [`cal`][cal] utility,
   but with liturgical colours and celebration ranks

data/Rakefile

@@ -1,6 +1,10 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "cucumber/rake/task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+Cucumber::Rake::Task.new
+
+desc 'runs all tests'
+task :default => [:spec, :cucumber]

data/calrom.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'calendarium-romanum', '~> 0.6.0'
   spec.add_dependency 'colorize', '~> 0.8'
+  spec.add_dependency 'pattern-match', '~> 1.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'cucumber', '~> 1.3'

data/lib/calrom.rb

@@ -10,6 +10,11 @@ require 'calrom/cli'
 require 'calrom/option_parser'
 require 'calrom/config'
 require 'calrom/date_range'
+require 'calrom/exceptions'
 require 'calrom/formatter/formatter'
 require 'calrom/formatter/list'
+require 'calrom/formatter/overview'
+require 'calrom/formatter/easter'
+require 'calrom/highlighter/no'
 require 'calrom/highlighter/list'
+require 'calrom/highlighter/overview'

data/lib/calrom/cli.rb

@@ -1,16 +1,16 @@
 module Calrom
   class CLI
     def self.call(argv)
-      config = OptionParser.call argv
-      calendar = config.calendar
-
-      enumerator = Enumerator.new do |yielder|
-        config.date_range.each do |date|
-          yielder.yield calendar[date]
-        end
+      begin
+        config = OptionParser.call argv
+      rescue ::OptionParser::InvalidOption, InputError => e
+        STDERR.puts e.message
+        exit 1
       end
 
-      config.formatter.call enumerator, config.date_range
+      calendar = config.calendar
+
+      config.formatter.call calendar, config.date_range
     end
   end
 end

data/lib/calrom/config.rb

@@ -2,17 +2,31 @@ module Calrom
   class Config
     def initialize
       self.today = Date.today
-      self.date_range = CR::Util::Month.new(today.year, today.month)
+      self.date_range = Month.new(today.year, today.month)
     end
 
-    attr_accessor :today, :date_range
+    attr_accessor :today, :date_range, :formatter, :colours
 
     def calendar
       CR::PerpetualCalendar.new(sanctorale: CR::Data::GENERAL_ROMAN_ENGLISH.load)
     end
 
     def formatter
-      Formatter::List.new Highlighter::List.new, today
+      if @formatter == :list || (@formatter.nil? && date_range.is_a?(Day))
+        Formatter::List.new highlighter(Highlighter::List), today
+      elsif @formatter == :easter
+        Formatter::Easter.new
+      else
+        Formatter::Overview.new highlighter(Highlighter::Overview), today
+      end
+    end
+
+    def highlighter(colourful)
+      if self.colours == false
+        return Highlighter::No.new
+      end
+
+      colourful.new
     end
   end
 end

data/lib/calrom/date_range.rb

@@ -1,5 +1,28 @@
 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
+          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
+          yield self.class.new(m.first, last)
+        else
+          yield m
+        end
+      end
+    end
   end
 
   class Year < DateRange
@@ -10,15 +33,58 @@ 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 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), next_month_beginning - 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 = next_month_beginning
+      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
+
+    private
+
+    def next_month_beginning
+      if @month == 12
+        Date.new(@year + 1, 1, 1)
+      else
+        Date.new(@year, @month + 1, 1)
+      end
     end
   end
 
@@ -30,5 +96,9 @@ module Calrom
     def to_s
       first.to_s
     end
+
+    def each_month
+      yield self
+    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/formatter/easter.rb

@@ -0,0 +1,16 @@
+module Calrom
+  module Formatter
+    # Prints (only) date of Easter for the specified year.
+    class Easter
+      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 CalendariumRomanum::Temporale::Dates
+               .easter_sunday(date_range.first.year - 1)
+               .strftime('%D')
+      end
+    end
+  end
+end

data/lib/calrom/formatter/formatter.rb

@@ -8,7 +8,7 @@ module Calrom
 
       attr_reader :highlighter, :today
 
-      def call(days, date_range)
+      def call(calendar, date_range)
       end
     end
   end

data/lib/calrom/formatter/list.rb

@@ -1,7 +1,7 @@
 module Calrom
   module Formatter
     class List < Formatter
-      def call(days, date_range)
+      def call(calendar, date_range)
         print_months = date_range.first.month != date_range.last.month
 
         puts date_range.to_s
@@ -9,12 +9,14 @@ module Calrom
 
         current_month = nil
 
-        days.each do |liturgical_day|
+        date_range.each do |date|
+          liturgical_day = calendar[date]
+
           if print_months && liturgical_day.date.month != current_month
             current_month = liturgical_day.date.month
 
             puts
-            puts current_month
+            puts liturgical_day.date.strftime('%B') #current_month
             puts
           end
 
@@ -28,9 +30,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 += ' '
 

data/lib/calrom/formatter/overview.rb

@@ -0,0 +1,99 @@
+require 'set'
+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
+        if date_range.is_a? Year
+          io.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
+        month.each do |date|
+          liturgical_day = calendar[date]
+
+          celebration = liturgical_day.celebrations.first
+
+          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
+          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/option_parser.rb

@@ -1,51 +1,167 @@
 require 'optparse'
+require 'pattern-match'
 
 module Calrom
   # Parses command line options, produces Config.
   class OptionParser
+    using PatternMatch
+
     def self.call(argv)
+      self.new.call(argv)
+    end
+
+    def call(argv)
       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')
+        opts.on('-l', '--list', 'list mode') do
+          config.formatter = :list
+        end
+
+        # cal
+        opts.on('-e', '--easter', 'display date of Easter') do
+          config.formatter = :easter
+        end
 
-        opts.on('-mMONTH', '--month=MONTH', 'which month to list') do |value|
+        # 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('-y', '--year', 'display specified (or current) year') do |value|
+          range_type = :year
+        end
+
+        # 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.on(nil, '--[no-]color', 'enable/disable colours (enabled by default)') do |value|
+          config.colours = value
+        end
+
+        opts.on_tail(nil, '--version', 'display calrom version') do
+          puts 'calrom v' + Calrom::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_tail('-h', '--help', 'display this help') do
+          puts opts
+          exit
         end
       end
 
       arguments = opt_parser.parse argv
 
-      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)
+      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)
         else
           Month.new(year, month)
         end
 
-      config.freeze
+      beginning = CalendariumRomanum::Calendar::EFFECTIVE_FROM
+      if range.first < beginning
+        raise InputError.new("implemented calendar system in use only since #{beginning}")
+      end
+
+      range
     end
   end
 end

data/lib/calrom/version.rb

@@ -1,3 +1,3 @@
 module Calrom
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calrom
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jakub Pavlík
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-05 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: calendarium-romanum
@@ -39,19 +39,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
@@ -132,9 +132,14 @@ files:
 - lib/calrom/cli.rb
 - lib/calrom/config.rb
 - lib/calrom/date_range.rb
+- lib/calrom/exceptions.rb
+- lib/calrom/formatter/easter.rb
 - lib/calrom/formatter/formatter.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/option_parser.rb
 - lib/calrom/version.rb
 homepage: https://github.com/calendarium-romanum/calrom
@@ -157,7 +162,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