icalPal 3.1.1 → 3.3.0

data/bin/icalpal

@@ -11,6 +11,7 @@ begin
 
   require_relative '../lib/icalpal'
   require_relative '../lib/options'
+  require_relative '../lib/utils'
 rescue LoadError => e
   dep = e.message[/-- (.*)/, 1]
 
@@ -27,10 +28,15 @@ end
 
 # All kids love log!
 $log = Logger.new(STDERR, { level: $defaults[:common][:debug] })
-$log.formatter = proc do |s, t, p, m| # Severity, time, progname, msg
+$log.formatter = proc do |s, t, _p, m| # Severity, time, progname, msg
   ($log.level.positive?)? "#{s}: #{m}\n" :
-    "[%-5s] %s [%s] - %s\n" %
-    [ s, t.strftime('%H:%M:%S.%L'), caller(4, 1)[0].split('/')[-1], m ]
+    format("[%-5<sev>s] %<time>s [%<caller>s] - %<message>s\n",
+           {
+             sev: s,
+             time: t.strftime('%H:%M:%S.%L'),
+             caller: caller(4, 1)[0].split('/')[-1],
+             message: m
+           })
 end
 
 $opts = ICalPal::Options.new.parse_options
@@ -53,7 +59,7 @@ $log.info("Options: #{$opts}")
 def add(item)
   $log.info("Adding #{item.inspect} #{item['UUID']} (#{item['title']})") if item['UUID']
 
-  item['sday'] = ICalPal::RDT.new(*item['sdate'].to_a[0..2]) if item === ICalPal::Event && item['sdate']
+  item['sday'] = ICalPal::RDT.new(*item['sdate'].to_a[0..2]) if ICalPal::Event === item && item['sdate']
   $items.push(item)
 end
 
@@ -62,22 +68,63 @@ end
 # Load the data
 
 # What are we getting?
-klass = ICalPal::($opts[:cmd])
+klass = ICalPal.call($opts[:cmd])
+success = false
 
 # Get it
 $opts[:db].each do |db|
-    $log.debug("Trying #{db}")
+  $log.debug("Trying #{db}")
 
-    if klass == ICalPal::Reminder then
+  if klass == ICalPal::Reminder
+    begin
       # Load all .sqlite files
       $log.debug("Loading *.sqlite in #{db}")
-      Dir.glob("#{db}/*.sqlite").each { |d| $rows += ICalPal.load_data(d, klass::QUERY) }
-    else
-      # Load database
-      begin
-        $rows += ICalPal.load_data(db, klass::QUERY)
+      Dir.glob("#{db}/*.sqlite").each do |d|
+        $rows += ICalPal.load_data(d, klass::QUERY)
+        success = true
+
+      rescue SQLite3::CantOpenException
+        # Non-fatal exception, try the next one
       end
+    end
+  else
+    # Load database
+    begin
+      $rows += ICalPal.load_data(db, klass::QUERY)
+      success = true
+
+    rescue SQLite3::CantOpenException
+      # Non-fatal exception, try the next one
+    end
+  end
+end
+
+# Make sure we opened at least one database
+unless success
+  $log.fatal('Could not open database')
+
+  # SQLite3 does not return useful error messages.  If any databases
+  # failed because of EPERM (operation not permitted), our parent
+  # process might need Full Disk Access, and we should suggest that.
+  eperm = 0
+
+  $opts[:db].each do |db|
+    # Use a real open to get a useful error
+    File.open(db).close
+  rescue Exception => e
+    $log.fatal("#{e.class}: #{db}")
+
+    eperm = 1 if e.instance_of?(Errno::EPERM)
   end
+
+  if eperm.positive?
+    $stderr.puts
+    $stderr.puts "Does #{ancestor} have Full Disk Access in System Settings?"
+    $stderr.puts
+    $stderr.puts "Try running: open 'x-apple.systempreferences:com.apple.preference.security?Privacy_AllFiles'"
+  end
+
+  abort
 end
 
 $log.info("Loaded #{$rows.count} #{klass} rows")
@@ -91,25 +138,25 @@ $rows.each_with_index do |row, i|
   $log.debug("Row #{i}: #{row['ROWID']}:#{row['UUID']} - #{row['account']}/#{row['calendar']}/#{row['title']}")
 
   # --es/--is
-  if $opts[:es].any? row['account'] then
-    $log.debug(":es")
+  if $opts[:es].any? row['account']
+    $log.debug(':es')
     next
   end
 
-  unless $opts[:is].empty? or $opts[:is].any? row['account']
-    $log.debug(":is");
+  unless $opts[:is].empty? || ($opts[:is].any? row['account'])
+    $log.debug(':is')
     next
   end
 
   # --ec/--ic
-  unless klass == ICalPal::Store or !row['calendar']
-    if $opts[:ec].any? row['calendar'] then
-      $log.debug(":ec")
+  unless klass == ICalPal::Store || !row['calendar']
+    if $opts[:ec].any? row['calendar']
+      $log.debug(':ec')
       next
     end
 
-    unless $opts[:ic].empty? or $opts[:ic].any? row['calendar']
-      $log.debug(":ic")
+    unless $opts[:ic].empty? || ($opts[:ic].any? row['calendar'])
+      $log.debug(':ic')
       next
     end
   end
@@ -118,24 +165,24 @@ $rows.each_with_index do |row, i|
   item = klass.new(row)
 
   # --et/--it
-  if $opts[:et].any? item['type'] then
-    $log.debug(":et")
+  if $opts[:et].any? item['type']
+    $log.debug(':et')
     next
   end
 
-  unless $opts[:it].empty? or $opts[:it].any? item['type']
-    $log.debug(":it")
+  unless $opts[:it].empty? || ($opts[:it].any? item['type'])
+    $log.debug(':it')
     next
   end
 
   # --el/--il
-  if $opts[:el].any? item['list_name'] then
-    $log.debug(":el")
+  if $opts[:el].any? item['list_name']
+    $log.debug(':el')
     next
   end
 
-  unless $opts[:il].empty? or $opts[:il].any? item['list_name']
-    $log.debug(":il")
+  unless $opts[:il].empty? || ($opts[:il].any? item['list_name'])
+    $log.debug(':il')
     next
   end
 
@@ -144,8 +191,8 @@ $rows.each_with_index do |row, i|
     r = $opts[:match].split('=')
 
     if item[r[0]].to_s.respond_to?(:match)
-      unless item[r[0]].to_s.match(Regexp.new(r[1].to_s, Regexp::IGNORECASE)) then
-        $log.debug(":match")
+      unless item[r[0]].to_s.match(Regexp.new(r[1].to_s, Regexp::IGNORECASE))
+        $log.debug(':match')
         next
       end
     end
@@ -153,18 +200,18 @@ $rows.each_with_index do |row, i|
 
   if ICalPal::Event === item
     # Check for all-day and cancelled events
-    if $opts[:ea] && item['all_day'].positive? then
-      $log.debug(":ea")
+    if $opts[:ea] && item['all_day'].positive?
+      $log.debug(':ea')
       next
     end
 
-    if $opts[:ia] && !item['all_day'].positive? then
-      $log.debug(":ia")
+    if $opts[:ia] && !item['all_day'].positive?
+      $log.debug(':ia')
       next
     end
 
-    if item['status'] == :canceled then
-      $log.debug(":canceled")
+    if item['status'] == :canceled
+      $log.debug(':canceled')
       next
     end
 
@@ -173,14 +220,14 @@ $rows.each_with_index do |row, i|
       item.non_recurring.each { |i| add(i) }
   else
     # Check for dated reminders
-    if ICalPal::Reminder === item then
-      if $opts[:dated] == 1 and item['due_date'] > 0 then
-        $log.debug(":undated")
+    if ICalPal::Reminder === item
+      if $opts[:dated] == 1 && item['due_date'].positive?
+        $log.debug(':undated')
         next
       end
 
-      if $opts[:dated] == 2 and item['due_date'] == 0 then
-        $log.debug(":dated")
+      if $opts[:dated] == 2 && item['due_date'].zero?
+        $log.debug(':dated')
         next
       end
     end
@@ -216,7 +263,7 @@ $log.debug("#{$items.count} items remain")
 mu = case $opts[:output]
      when 'ansi' then RDoc::Markup::ToAnsi.new
      when 'default' then RDoc::Markup::ToICalPal.new($opts)
-     when 'html' then
+     when 'html'
        rdoc = RDoc::Options.new
        rdoc.pipe = true
        rdoc.output_decoration = false
@@ -236,7 +283,7 @@ unless mu
   $log.debug("Output in #{$opts[:output]} format")
 
   puts case $opts[:output]
-       when 'csv' then
+       when 'csv'
          # Get all headers
          headers = []
          items.each { |i| headers += i.keys }
@@ -249,15 +296,15 @@ unless mu
          table
        when 'hash' then items.map { |i| i.self }
        when 'json' then items.map { |i| i.self }.to_json
-       when 'xml' then
-         xml = items.map { |i| "<#{$opts[:cmd].chomp("s")}>#{i.to_xml}</#{$opts[:cmd].chomp("s")}>" }
-         "<#{$opts[:cmd]}>\n#{xml.join("")}</#{$opts[:cmd]}>"
+       when 'xml'
+         xml = items.map { |i| "<#{$opts[:cmd].chomp('s')}>#{i.to_xml}</#{$opts[:cmd].chomp('s')}>" }
+         "<#{$opts[:cmd]}>\n#{xml.join('')}</#{$opts[:cmd]}>"
        when 'yaml' then items.map { |i| i.self }.to_yaml
        when 'remind' then items.map { |i|
-                            "REM #{i['sdate'].strftime('%F AT %R')} " +
-                              "DURATION #{((i['edate'] - i['sdate']).to_f * 1440).to_i } " +
-                              "MSG #{i['title']}"
-                          }.join("\n")
+           "REM #{i['sdate'].strftime('%F AT %R')} " +
+             "DURATION #{((i['edate'] - i['sdate']).to_f * 1440).to_i} " +
+             "MSG #{i['title']}"
+         }.join("\n")
        else abort "No formatter for #{$opts[:output]}"
        end
 
@@ -302,20 +349,28 @@ items.each_with_index do |i, j|
 
     next unless value
     next if Array === value && !value[0]
-    next if String === value && value.length == 0
+    next if String === value && value.empty?
 
     $log.debug("#{prop}: #{value}")
 
     # Use Raw to save the property
     props << RDoc::Markup::Raw.new(prop)
 
-    unless k.positive?
+    if k.positive?
+      props << RDoc::Markup::BlankLine.new unless (i['placeholder'] || $opts[:ps])
+      props << RDoc::Markup::ListItem.new(prop, RDoc::Markup::Paragraph.new(value)) unless (i['placeholder'])
+    else
       # First property, value only
       props << RDoc::Markup::Heading.new(2, value.to_s)
-    else
-      props << RDoc::Markup::BlankLine.new unless (i['placeholder'] || $opts[:ps])
-      props << RDoc::Markup::ListItem.new(prop, RDoc::Markup::Paragraph.new(value)) unless(i['placeholder'])
     end
+
+    # unless k.positive?
+    #   # First property, value only
+    #   props << RDoc::Markup::Heading.new(2, value.to_s)
+    # else
+    #   props << RDoc::Markup::BlankLine.new unless (i['placeholder'] || $opts[:ps])
+    #   props << RDoc::Markup::ListItem.new(prop, RDoc::Markup::Paragraph.new(value)) unless (i['placeholder'])
+    # end
   end
 
   # Print it

data/icalPal.gemspec

@@ -1,27 +1,55 @@
-require './lib/version'
+require_relative 'lib/version'
 
 Gem::Specification.new do |s|
   s.name	= ICalPal::NAME
   s.version	= ICalPal::VERSION
 
-  s.summary	= "Command-line tool to query the macOS Calendar"
+  s.summary	= 'Command-line tool to query the macOS Calendar'
   s.description	= <<-EOF
 Inspired by icalBuddy and maintains close compatability.  Includes
 many additional features for querying, filtering, and formatting.
 EOF
 
-  s.authors	= "Andy Rosen"
-  s.email	= "ajr@corp.mlfs.org"
+  s.authors	= 'Andy Rosen'
+  s.email	= 'ajr@corp.mlfs.org'
   s.homepage	= "https://github.com/ajrosen/#{s.name}"
-  s.licenses	= [ "GPL-3.0-or-later" ]
+  s.licenses	= [ 'GPL-3.0-or-later' ]
 
-  s.files	= Dir[ "#{s.name}.gemspec", "bin/*", "lib/*.rb" ]
+  s.metadata = {
+    'bug_tracker_uri' => "https://github.com/ajrosen/#{s.name}/issues"
+  }
+
+  s.files	= Dir["#{s.name}.gemspec", 'bin/*', 'lib/*.rb']
   s.executables	= [ "#{s.name}" ]
-  s.extra_rdoc_files = [ "README.md" ]
+  s.extra_rdoc_files = [ 'README.md' ]
+
+  s.add_dependency 'nokogiri-plist', '~> 0.5.0'
+  s.add_dependency 'sqlite3', '~> 2.6.0' unless s.rubygems_version == `/usr/bin/gem --version`.strip
 
-  s.add_runtime_dependency "sqlite3", "~> 1"
-  s.add_runtime_dependency "nokogiri-plist", "~> 0.5.0"
+  # The macOS and Homebrew versions of rubygems have incompatible
+  # requirements for sqlite3.
+  # 
+  # macOS comes with version 1.3.13, so it does not need to be added
+  # as a dependency, but it cannot install anything newer:
+  # 
+  # requires Ruby version >= 3.0, < 3.4.dev. The current ruby version is 2.6.10.
+  # 
+  # Homebrew's Ruby formula does not come with sqlite3, so it does
+  # need to be added as a dependency, but it cannot install version
+  # 1.3.13:
+  # 
+  # error: call to undeclared function
+  # 
+  # So we must call add_dependency, but iff we are not building with
+  # macOS' Ruby installation.
 
   s.bindir = 'bin'
   s.required_ruby_version = '>= 2.6.0'
+
+  s.post_install_message = <<-EOF
+
+Note: #{ICalPal::NAME} requires "Full Disk Access" in System Settings to access your calendar.
+Make sure the program that runs #{ICalPal::NAME}, not #{ICalPal::NAME} itself, has these permissions.
+
+EOF
 end

data/lib/EventKit.rb

@@ -1,9 +1,12 @@
+# rubocop: disable Naming/ConstantName
+
 # Constants from EventKit[https://developer.apple.com/documentation/eventkit/]
+
 class EventKit
-  EKEntityType = [
-    'event',
-    'reminder',
-  ]
+  EKEntityType = %w[
+    event
+    reminder
+  ].freeze
 
   EKEventAvailability = {
     notSupported: -1,
@@ -11,28 +14,28 @@ class EventKit
     free: 1,
     tentative: 2,
     unavailable: 3,
-  }
+  }.freeze
 
   EKEventStatus = {
     none: 0,
     confirmed: 1,
     tentative: 2,
     canceled: 3,
-  }
+  }.freeze
 
-  EKRecurrenceFrequency = [
-    'daily',
-    'weekly',
-    'monthly',
-    'yearly',
-  ]
+  EKRecurrenceFrequency = %w[
+    daily
+    weekly
+    monthly
+    yearly
+  ].freeze
 
   EKReminderProperty = [
     'none',                     # 0
     'high', nil, nil, nil,      # 1
     'medium', nil, nil, nil,    # 5
     'low',                      # 9
-  ]
+  ].freeze
 
   # EKSourceType (with color)
   EKSourceType = [
@@ -43,10 +46,13 @@ class EventKit
     { name: 'Subscribed', color: '#FF0000' }, # Red
     { name: 'Birthdays',  color: '#FF00FF' }, # Magenta
     { name: 'Reminders',  color: '#066FF3' }, # Blue
-  ]
+  ].freeze
+
+  EKSpan = %w[
+    this
+    future
+  ].freeze
 
-  EKSpan = [
-    'this',
-    'future',
-  ]
 end
+
+# rubocop: enable Naming/ConstantName

data/lib/ToICalPal.rb

@@ -1,7 +1,6 @@
 ##################################################
 # Render an RDoc::Markup::Document, closely mimicking
 # icalBuddy[https://github.com/ali-rantakari/icalBuddy]
-
 class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
   # Standard
   # ANSI[https://www.itu.int/rec/dologin_pub.asp?lang=e&id=T-REC-T.416-199303-I!!PDF-E&type=items]
@@ -26,25 +25,25 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
     'pink':      '38;2;255;45;85',
     'purple':    '38;2;204;115;225',
     'rose':      '38;2;217;166;159',
-  }
+  }.freeze
 
   # Increased intensity
-  BOLD = '%c[1m' % 27.chr
+  BOLD = format('%c[1m', 27.chr)
 
   # Default rendition
-  NORM = '%c[0m' % 27.chr
+  NORM = format('%c[0m', 27.chr)
 
   # Properties for which we don't include labels
-  NO_LABEL = [ 'title', 'datetime' ]
+  NO_LABEL = %w[ title datetime ].freeze
 
   # Properties that are always colorized
-  COLOR_LABEL = [ 'title', 'calendar' ]
+  COLOR_LABEL = %w[ title calendar ].freeze
 
   # Default color for labels
-  LABEL_COLOR = [ 'cyan', '#00ffff' ]
+  LABEL_COLOR = [ 'cyan', '#00ffff' ].freeze
 
   # Color for datetime value
-  DATE_COLOR = [ 'yellow', '#ffff00' ]
+  DATE_COLOR = [ 'yellow', '#ffff00' ].freeze
 
   # @param opts [Hash] Used for conditional formatting
   # @option opts [String] :bullet Bullet
@@ -56,6 +55,7 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
   # @option opts [Array<String>] :ps List of property separators
   # @option opts [String] :ss Section separator
   def initialize(opts)
+    super(opts)
     @opts = opts
   end
 
@@ -72,15 +72,15 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
 
   # Add a bullet for the first property of an item
   #
-  # @param arg [Array] Ignored
-  def accept_list_start(arg)
+  # @param _arg [Array] Ignored
+  def accept_list_start(_arg)
     begin
       return if @item['placeholder']
     rescue
     end
 
     begin
-      if (@item['due_date'] + ICalPal::ITIME).between?(ICalPal::ITIME + 1, $now.to_i) then
+      if (@item['due_date'] + ICalPal::ITIME).between?(ICalPal::ITIME + 1, $now.to_i)
         @res << "#{@opts[:ab]} " unless @opts[:nb]
         return
       end
@@ -96,15 +96,15 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
   # @option arg [String] .label Contains the property name
   def accept_list_item_start(arg)
     @res << @opts[:ps][@ps] || '    ' unless @item['placeholder']
-    @res << colorize(*LABEL_COLOR, arg.label) << ": " unless @opts[:npn] || NO_LABEL.any?(arg.label)
+    @res << colorize(*LABEL_COLOR, arg.label) << ': ' unless @opts[:npn] || NO_LABEL.any?(arg.label)
 
     @ps += 1 unless @ps == @opts[:ps].count - 1
   end
 
   # Add a blank line
   #
-  # @param arg [Array] Ignored
-  def accept_blank_line(*arg)
+  # @param *_arg [Array] Ignored
+  def accept_blank_line(*_arg)
     @res << "\n"
   end
 
@@ -119,9 +119,9 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
     @res << h.text
 
     case h.level
-    when 1 then
-      @res << ":"
-    when 2 then
+    when 1
+      @res << ':'
+    when 2
       if @prop == 'title' && @item['calendar']
         @res << bold(" (#{@item['calendar']})") unless @opts[:nc] || @item['title'] == @item['calendar']
       end
@@ -140,8 +140,8 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
 
   # Add a section separator
   #
-  # @param weight Ignored
-  def accept_rule(weight)
+  # @param _weight Ignored
+  def accept_rule(_weight)
     @res << @opts[:ss]
     accept_blank_line
   end
@@ -167,6 +167,7 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
   # @return [String] str with increased intensity[#BOLD]
   def bold(str)
     return str unless @opts[:palette]
+
     BOLD + str + NORM
   end
 
@@ -177,27 +178,28 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
     return str unless c8 && c24 && @opts[:palette]
 
     case @opts[:palette]
-    when 8 then                 # Default colour table
+    when 8                      # Default colour table
       c = ANSI[c8.downcase.to_sym]
       c ||= ANSI[c24[0..6].downcase.to_sym]
       c ||= ANSI[:white]
 
-    when 24 then                # Direct colour in RGB space
+    when 24                     # Direct colour in RGB space
       rgb = c24[1..].split(/(\h\h)(\h\h)(\h\h)/)
       rgb.map! { |i| i.to_i(16) }
       c = [ 38, 2, rgb[1..] ].join(';')
     end
 
-    sprintf('%c[%sm%s%c[%sm', 27.chr, c, str, 27.chr, ANSI[:default])
+    # esc c str esc ansi
+    format('%<esc>c[%<color>sm%<string>s%<esc>c[%<ansi_default>sm',
+           { esc: 27.chr, color: c, string: str, ansi_default: ANSI[:default] })
   end
 
   # @!visibility private
 
   # @param a [Array] Ignored
-  def accept_list_end(a)
-  end
+  def accept_list_end(a) end
 
   # @param a [Array] Ignored
-  def accept_list_item_end(a)
-  end
+  def accept_list_item_end(a) end
+
 end

data/lib/calendar.rb

@@ -3,7 +3,7 @@ module ICalPal
   class Calendar
     include ICalPal
 
-    QUERY = <<~SQL
+    QUERY = <<~SQL.freeze
 SELECT DISTINCT
 
 Store.name AS account,
@@ -16,7 +16,6 @@ JOIN Store ON store_id = Store.rowid
 
 WHERE Store.disabled IS NOT 1
 AND Store.display_order IS NOT -1
-AND (Calendar.display_order IS NOT -1 OR external_rep IS NOT NULL)
 AND Calendar.flags IS NOT 519
 SQL
 

data/lib/defaults.rb

@@ -1,6 +1,6 @@
 # Does anybody really know what time it is?
 $now = ICalPal::RDT.now
-$today = ICalPal::RDT.new(*$now.to_a[0..2] + [0, 0, 0, $now.zone])
+$today = ICalPal::RDT.new(*$now.to_a[0..2] + [ 0, 0, 0, $now.zone ])
 
 # Defaults
 $defaults = {
@@ -40,27 +40,27 @@ $defaults = {
   tasks: {
     dated: 0,
     db: [ ICalPal::Reminder::DB_PATH ],
-    iep: [ 'title', 'notes', 'due', 'priority' ],
+    iep: %w[ title notes due priority ],
     sort: 'prio',
   },
   undatedTasks: {
     dated: 1,
     db: [ ICalPal::Reminder::DB_PATH ],
-    iep: [ 'title', 'notes', 'due', 'priority' ],
+    iep: %w[ title notes due priority ],
     sort: 'prio',
   },
   datedTasks: {
     dated: 2,
     db: [ ICalPal::Reminder::DB_PATH ],
-    iep: [ 'title', 'notes', 'due', 'priority' ],
+    iep: %w[ title notes due priority ],
     sort: 'prio',
   },
   stores: {
-    iep: [ 'account', 'type' ],
+    iep: %w[ account type ],
     sort: 'account',
   },
   calendars: {
-    iep: [ 'calendar', 'type', 'UUID' ],
+    iep: %w[ calendar type UUID ],
     sort: 'calendar',
   },
   events: {
@@ -69,10 +69,11 @@ $defaults = {
     eed: false,
     eep: [],
     from: $today,
-    iep: [ 'title', 'location', 'notes', 'url', 'attendees', 'datetime' ],
+    iep: %w[ title location notes url attendees datetime ],
     n: false,
     nnr: "\n       ",
     nrd: false,
+    now: false,
     ps: [ "\n    " ],
     sa: false,
     sed: false,