icalPal 3.1.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0297e64a63dc4d2b65d99486da581c29a6358ba608fdcba131264645510fd70
-  data.tar.gz: d74cd82384fcfbeb340f3047c94e492ab6374d39d9d4e17a75c9e4e35b9429db
+  metadata.gz: fd12b179a212d0582bd2740c8697f994f75d71fab58ab9ca28c8330e59e33b08
+  data.tar.gz: ab00df9c7f7b5fce00f8a247f346f5049f019d5336973eaec5e17d1970e773da
 SHA512:
-  metadata.gz: 2ac7ff052d9007bde1d72c246545d35604293b4e6d60e994cf8c0c668749c694c72595fa61116021457c3a4031c31be70612c32a37ef50dbd17b8e7d85e272c2
-  data.tar.gz: b062c855186dc5e9624a2aa1a63e625263a7e355ac117b4b09271c377840126c31a4ff9568d71d416c2f4654627b5adadd8963df71089ea24f60a3e515f89b63
+  metadata.gz: 5b2a5690bcf64c79fff82138dfeb27063dcc79d65ca29082e387cc396c7787d8beeec4beaf5ab56492bfb1739e1dcabfb2012ebceb34b899b90a118a8cf522b5
+  data.tar.gz: d65423b35e47f5287cb44406f618d8cb90825163d1d416e3dc2b1921483fa67ad6e62873c692fd25173a1485d8507a4f70c276a66e2a626cf0d4573e1e5571c8

data/README.md

@@ -1,10 +1,10 @@
-[![Gem Version](https://badge.fury.io/rb/icalpal.svg)](https://badge.fury.io/rb/icalpal)
+[![Gem Version](https://badge.fury.io/rb/icalPal.svg)](https://badge.fury.io/rb/icalPal)
 
-# icalpal
+# icalPal
 
 ## Description
 
-icalpal is a command-line tool to query a macOS Calendar and Reminders
+icalPal is a command-line tool to query a macOS Calendar and Reminders
 databases for accounts, calendars, events, and tasks.  It can be run
 on any system with [Ruby](https://www.ruby-lang.org/) and access to a
 Calendar or Reminders database.
@@ -14,27 +14,27 @@ Calendar or Reminders database.
 As a system-wide Ruby gem:
 
 ```
-gem install icalpal
+gem install icalPal
 ```
 
 or in your home diretory:
 
 ```
-gem install --user-install icalpal
+gem install --user-install icalPal
 ```
 
 As a Homebrew formula:
 
 ```
-brew tap ajrosen/icalpal
-brew install icalpal
+brew tap ajrosen/icalPal
+brew install icalPal
 ```
 
 ## Features
 
 ### Compatability with [icalBuddy](https://github.com/ali-rantakari/icalBuddy)
 
-icalpal tries to be compatible with icalBuddy for command-line options
+icalPal tries to be compatible with icalBuddy for command-line options
 and for output.  There are a some important differences to be aware
 of.
 
@@ -48,17 +48,17 @@ of.
 
 ### Additional commands
 
-```icalpal accounts```
+```icalPal accounts```
 
-Shows a list of enabled Calendar accounts.  Internally they are known as *Stores*; you can run ```icalpal stores``` instead.
+Shows a list of enabled Calendar accounts.  Internally they are known as *Stores*; you can run ```icalPal stores``` instead.
 
-```icalpal datedTasks```
+```icalPal datedTasks```
 
 Shows only reminders that have a due date.
 
 ### Additional options
 
-* Options can be abbreviated, so long as they are unique.  Eg., ```icalpal -c ev --da 3``` is the same as ```icalpal -c events --days 3```.
+* Options can be abbreviated, so long as they are unique.  Eg., ```icalPal -c ev --da 3``` is the same as ```icalPal -c events --days 3```.
 * The ```-c``` part is optional, but you cannot abbreviate the command if you leave it off.
 * Use ```-o``` to print the output in different formats.  CSV or JSON are intertesting choices.
 * Copy your Calendar database file and use ```--db``` on it.
@@ -70,11 +70,11 @@ Shows only reminders that have a due date.
 * ```--color``` uses a wider color palette.  Calendar colors are what you have chosen in the Calendar app.  Not supported in all terminals, but looks great in [iTerm2](https://iterm2.com/).
 * ```--match``` lets you filter the results of any command to items where a *FIELD* matches a regular expression.  Eg., ```--match notes=zoom.us``` to show only Zoom meeetings
 
-Because icalpal is written in Ruby, and not a native Mac application, you can run it just about anywhere.  It's been tested with the version of Ruby (2.6.10) included with macOS.
+Because icalPal is written in Ruby, and not a native Mac application, you can run it just about anywhere.  It's been tested with the version of Ruby (2.6.10) included with macOS.
 
 ## Usage
 
-icalpal: Usage: icalpal [options] [-c] COMMAND
+icalPal: Usage: icalPal [options] [-c] COMMAND
 
 COMMAND must be one of the following:
 ```
@@ -205,14 +205,14 @@ Environment variables:
 
 ## Output formats
 
-icalpal supports several output formats.  The **default** format tries
+icalPal supports several output formats.  The **default** format tries
 to mimic icalBuddy as much as possible.
 
 CSV, Hash, JSON, XML, and YAML print all fields for all items in their
 respective formats.  From that you can analyze the results any way you
 like.
 
-[Remind](https://dianne.skoll.ca/projects/remind/) format uses a minimal implementation built in icalpal.
+[Remind](https://dianne.skoll.ca/projects/remind/) format uses a minimal implementation built in icalPal.
 
 Other formats such as ANSI, HTML, Markdown, RDoc, and TOC, use Ruby's
 [RDoc::Markup](https://ruby-doc.org/stdlib-2.6.10/libdoc/rdoc/rdoc/RDoc/Markup.html)
@@ -259,10 +259,10 @@ Lawton](https://github.com/jimlawton) that it even compiles anymore.
 
 Instead of trying to understand and extend the existing code, I chose
 to start anew using my language of choice: Ruby.  Using Ruby meant
-there is *much* less code; about 1,600 lines vs. 7,000.  It also means
-icalpal is multi-platform.
+there is *much* less code; about 1,800 lines vs. 7,000.  It also means
+icalPal is multi-platform.
 
 I won't pretend to understand **why** you would want to run this on
-Linux or Windows.  But since icalpal is written in Ruby and gets its
+Linux or Windows.  But since icalPal is written in Ruby and gets its
 data directly from the Calendar and Reminders database files instead
 of an API, you *can*.

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