icalPal 1.2.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c08ab4aaf0558f9648fbefbb9eaea1aac9c50de2770e1897699b619ba92ef6b6
-  data.tar.gz: '087d14b6e855bdbf2681e526941baec600fed607a6e6760b09f4361bb33735d8'
+  metadata.gz: 4dab143a05d8a63ae36b721ca6ba53180c75d8b4dd0f0cebdc84fb533968c248
+  data.tar.gz: 8d243a120762c90059e4206a2deb5e79b821e558cf9ad9a437ad84fbfbb6a21b
 SHA512:
-  metadata.gz: 70934664b432d1b99e0f200bd1e78a2b142f9b1b9b405c8763913aa9d414a83171f4876e0145ff741854abd1b643fdb4a72031b564af14a2a4f1764cc494a13f
-  data.tar.gz: '0580e0d9556919516b1c2d4a4ea11306a2a8786ea80ee5ccc5821c97f899d7bc95c3499c7f5d9dc05ac091dba53867b01a7b676e0bd20881563d7529e16a1a31'
+  metadata.gz: 24f4b88c592e59f2ffbc116761d6da41b60a7e5d4554feea9bdb023450967eaa7921f5c4708a66bf76554926ab4e0ca52965470f7576cef1cce5aec9a6112cbb
+  data.tar.gz: d69cc1d2cd63072020a4059a352ccdb2262a189e10c3c4e1891bd1c953ea2cb60a577fc83bd2ab55b561d0a752b0fb4198495bc2a5f57909d4216101cc7ea012

data/README.md

@@ -4,16 +4,30 @@
 
 ## Description
 
-icalPal is a command-line tool to query a macOS Calendar database for
-accounts, calendars, and events.  It can be run on any system with
-[Ruby](https://www.ruby-lang.org/) and access to a Calendar database
-file.
+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.
 
 ## Installation
 
+As a system-wide Ruby gem:
+
 ```
 gem install icalPal
-icalPal events
+```
+
+or in your home diretory:
+
+```
+gem install --user-install icalPal
+```
+
+As a Homebrew formula:
+
+```
+brew tap ajrosen/icalPal
+brew install icalPal
 ```
 
 ## Features
@@ -21,11 +35,14 @@ icalPal events
 ### Compatability with [icalBuddy](https://github.com/ali-rantakari/icalBuddy)
 
 icalPal tries to be compatible with icalBuddy for command-line options
-and for output.  There are a few differences to be aware of.
+and for output.  There are a some important differences to be aware
+of.
 
 * Options require two hyphens, except for single-letter options that require one hyphen
 * *eventsFrom* is not supported.  Instead there is *--from*, *--to*, and *--days*
-* icalPal does not support the *tasks* commands yet
+* *uncompletedTasks* is simply *tasks*
+* *undatedUncompletedTasks* is simply *undatedTasks*
+* *tasksDueBefore:DATE* is not yet supported
 * The command can go anywhere; it doesn't have to be the last argument
 * Property separators are comma-delimited
 
@@ -35,6 +52,10 @@ and for output.  There are a few differences to be aware of.
 
 Shows a list of enabled Calendar accounts.  Internally they are known as *Stores*; you can run ```icalPal stores``` instead.
 
+```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```.
@@ -42,37 +63,45 @@ Shows a list of enabled Calendar accounts.  Internally they are known as *Stores
 * 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.
 * ```--it``` and ```--et``` will filter by Calendar *type*.  Types are **Local**, **Exchange**, **CalDAV**, **MobileMe**, **Subscribed**, and **Birthdays**
+* ```--il``` and ```-el``` will filter by Reminder list
 * ```--ia``` includes *only* all-day events (opposite of ```--ea```)
 * ```--aep``` is like ```--iep```, but *adds* to the default property list instead of replacing it.
 * ```--sep``` to separate by any property, not just calendar (```--sc```) or date (```--sd```)
 * ```--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/).
 
-Because icalPal is written in Ruby, and not a native Mac application, you can run it just about anywhere.  It's been tested with version of Ruby (2.6.10) included with macOS, and does not require any external dependencies.
+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
 
 COMMAND must be one of the following:
-
+```
     events                  Print events
+    tasks                   Print tasks
     calendars               Print calendars
     accounts                Print accounts
 
     eventsToday             Print events occurring today
     eventsToday+NUM         Print events occurring between today and NUM days into the future
     eventsNow               Print events occurring at present time
+    datedTasks              Print tasks with a due date
+    undatedTasks            Print tasks with no due date
+```
 
 Global options:
-
+```
     -c, --cmd=COMMAND       Command to run
-        --db=DB             Use DB file instead of Calendar
-        --cf=FILE           Set config file path (default: $HOME/.icalPal)
+        --db=DB             Use DB file instead of Calendar (default: /Users/ajr/Library/Calendars/Calendar.sqlitedb)
+                            For the tasks commands this should be a directory containing .sqlite files
+                            (default: /Users/ajr/Library/Group Containers/group.com.apple.reminders/Container_v1/Stores)
+        --cf=FILE           Set config file path (default: /Users/ajr/.icalPal)
     -o, --output=FORMAT     Print as FORMAT (default: default)
-                            [ansi, csv, default, hash, html, json, md, rdoc, toc, yaml, remind]
-
-Including/excluding calendars:
+                            [ansi, csv, default, hash, html, json, md, rdoc, remind, toc, xml, yaml]
+```
 
+Including/excluding calendars and reminders:
+```
         --is=ACCOUNTS       List of accounts to include
         --es=ACCOUNTS       List of accounts to exclude
 
@@ -83,8 +112,12 @@ Including/excluding calendars:
         --ic=CALENDARS      List of calendars to include
         --ec=CALENDARS      List of calendars to exclude
 
-Choosing dates:
+        --il=LISTS          List of reminder lists to include
+        --el=LISTS          List of reminder lists to exclude
+```
 
+Choosing dates:
+```
         --from=DATE         List events starting on or after DATE
         --to=DATE           List events starting on or before DATE
                             DATE can be yesterday, today, tomorrow, +N, -N, or anything accepted by DateTime.parse()
@@ -95,13 +128,19 @@ Choosing dates:
         --sed               Show empty dates with --sd
         --ia                Include only all-day events
         --ea                Exclude all-day events
+```
 
 Choose properties to include in the output:
-
+```
         --iep=PROPERTIES    List of properties to include
         --eep=PROPERTIES    List of properties to exclude
         --aep=PROPERTIES    List of properties to include in addition to the default list
 
+        --itp=PROPERTIES    List of task properties to include
+        --etp=PROPERTIES    List of task properties to exclude
+        --atp=PROPERTIES    List of task properties to include in addition to the default list
+                            Included for backwards compatability, these are aliases for --iep, --eep, and --aep
+
         --uid               Show event UIDs
         --eed               Exclude end datetimes
 
@@ -113,16 +152,20 @@ Choose properties to include in the output:
 
     Use 'all' for PROPERTIES to include all available properties (except any listed in --eep)
     Use 'list' for PROPERTIES to list all available properties and exit
+```
 
 Formatting the output:
-
+```
         --li=N              Show at most N items (default: 0 for no limit)
 
         --sc                Separate by calendar
         --sd                Separate by date
+        --sp                Separate by priority
         --sep=PROPERTY      Separate by PROPERTY
 
         --sort=PROPERTY     Sort by PROPERTY
+        --std               Sort tasks by due date (same as --sort=due_date)
+        --stda              Sort tasks by due date (ascending) (same as --sort=due_date -r)
     -r, --reverse           Sort in reverse
 
         --ps=SEPARATORS     List of property separators
@@ -133,53 +176,37 @@ Formatting the output:
                             See https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html#method-i-strftime for details
 
     -b, --bullet=STRING     Use STRING for bullets
+        --ab=STRING         Use STRING for alert bullets
+        --nb                Do not use bullets
         --nnr=SEPARATOR     Set replacement for newlines within notes
 
     -f                      Format output using standard ANSI colors
         --color             Format output using a larger color palette
+```
 
 Help:
-
+```
     -h, --help              Show this message
-    -V, -v, --version       Show version and exit (1.0)
+    -V, -v, --version       Show version and exit (2.0.0)
     -d, --debug=LEVEL       Set the logging level (default: warn)
                             [debug, info, warn, error, fatal]
+```
 
 Environment variables:
-
+```
     ICALPAL                 Additional arguments
     ICALPAL_CONFIG          Additional arguments from a file
-                            (default: $HOME/.icalPal)
-
-
-## History
-
-I have used icalBuddy for many years.  It's great for scripting,
-automation, and as a desktop widget for apps like
-[GeekTool](https://www.tynsoe.org/geektool/) and
-[Übersicht](https://tracesof.net/uebersicht/).
-
-As with many applications, I started to run into some limitations in
-icalBuddy.  The biggest being that active development ended in 2014.
-It's only thanks to the efforts of [Jim
-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.  Using Ruby means icalPal
-is multi-platform.  It also meant *much* less code; about 1,200 lines
-vs. 7,000.
-
-I won't pretend to understand **why** you would want this on Linux or
-Windows.  But since icalPal is written in Ruby and gets its data
-directly from the Calendar database file instead of an API, you *can*.
+                            (default: /Users/ajr/.icalPal)
+```
 
 ## Output formats
 
 icalPal supports several output formats.  The **default** format tries
 to mimic icalBuddy as much as possible.
 
-CSV, Hash, JSON, and YAML print all fields for all items in their
-respective formats.  From that you can analyze the results any way you like.
+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.
 
@@ -209,5 +236,29 @@ objects, one for each of the item's properties:
 
 The document will also include a number of
 [RDoc::Markup::Verbatim](https://ruby-doc.org/stdlib-2.6.10/libdoc/rdoc/rdoc/RDoc/Markup/Verbatim.html)
+and
+[RDoc::Markup::Raw](https://ruby-doc.org/stdlib-2.6.10/libdoc/rdoc/rdoc/RDoc/Markup/Raw.html)
 items.  They are not included in the output, but are used to pass
 information about the item and property to the default formatter.
+
+## History
+
+I used icalBuddy for many years.  It's great for scripting,
+automation, and as a desktop widget for apps like
+[GeekTool](https://www.tynsoe.org/geektool/) and
+[Übersicht](https://tracesof.net/uebersicht/).
+
+As with many applications, I started to run into some limitations in
+icalBuddy.  The biggest being that active development ended in 2014.
+It's only thanks to the efforts of [Jim
+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.
+
+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
+data directly from the Calendar and Reminders database files instead
+of an API, you *can*.

data/bin/icalPal

@@ -1,16 +1,25 @@
 #!/usr/bin/env ruby
-# *-*- mode: enh-ruby -*-*
 
-require 'logger'
+begin
+  require 'logger'
+
+  require 'csv'
+  require 'json'
+  require 'rdoc'
+  require 'sqlite3'
+  require 'yaml'
 
-require 'csv'
-require 'json'
-require 'rdoc'
-require 'sqlite3'
-require 'yaml'
+  require_relative '../lib/icalPal'
+  require_relative '../lib/options'
+rescue LoadError => e
+  dep = e.message[/-- (.*)/, 1]
 
-require_relative '../lib/icalPal'
-require_relative '../lib/options'
+  $stderr.puts "FATAL: icalPal is missing a dependency: #{dep}"
+  $stderr.puts
+  $stderr.puts "Install with 'gem install --user-install #{dep}'"
+
+  exit
+end
 
 
 ##################################################
@@ -44,7 +53,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['sdate']
+  item['sday'] = ICalPal::RDT.new(*item['sdate'].to_a[0..2]) if item === ICalPal::Event && item['sdate']
   $items.push(item)
 end
 
@@ -54,32 +63,17 @@ end
 
 # What are we getting?
 klass = ICalPal::($opts[:cmd])
-q = klass::QUERY
-
-$log.debug(q.gsub(/\n/, ' '))
 
 # Get it
-begin
-  stmt = $db.prepare(q)
-  abort(stmt.columns.sort.join(' ')) if $opts[:props].any? 'list'
-  $opts[:props] = stmt.columns - $opts[:eep] if $opts[:props].any? 'all'
-
-  # Iterate the SQLite3::ResultSet once
-  stmt.execute.each_with_index { |i, j| $rows[j] = i }
-  stmt.close
-
-  # Close the database
-  $db.close
-  $log.debug("Closed #{$opts[:db]}")
-
-rescue SQLite3::BusyException => e
-  $log.error("Non-fatal error closing database #{$db.filename}")
-
-rescue SQLite3::SQLException => e
-  abort(e.message)
+if klass == ICalPal::Reminder then
+  # Load all .sqlite files
+  Dir.glob("#{$opts[:db]}/*.sqlite").each { |db| $rows += ICalPal.load_data(db, klass::QUERY) }
+else
+  # Load database
+  $rows += ICalPal.load_data($opts[:db], klass::QUERY)
 end
 
-$log.info("Loaded #{$rows.count} rows from #{$opts[:db]}")
+$log.info("Loaded #{$rows.count} #{klass} rows")
 
 
 ##################################################
@@ -111,6 +105,7 @@ $rows.each_with_index do |row, i|
     next
   end
 
+  # Instantiate an item
   item = klass.new(row)
 
   # --et/--it
@@ -124,11 +119,18 @@ $rows.each_with_index do |row, i|
     next
   end
 
-  unless ICalPal::Event === item
-    # Always add non-event items
-    $log.debug("Adding non-event #{item}")
-    add(item)
-  else
+  # --el/--il
+  if $opts[:el].any? item['list_name'] then
+    $log.debug(":el")
+    next
+  end
+
+  unless $opts[:il].empty? or $opts[:il].any? item['list_name']
+    $log.debug(":il")
+    next
+  end
+
+  if ICalPal::Event === item
     # Check for all-day and cancelled events
     if $opts[:ea] && item['all_day'].positive? then
       $log.debug(":ea")
@@ -148,6 +150,21 @@ $rows.each_with_index do |row, i|
     (item['has_recurrences'].positive?)?
       item.recurring.each { |i| add(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")
+        next
+      end
+
+      if $opts[:dated] == 2 and item['due_date'] == 0 then
+        $log.debug(":dated")
+        next
+      end
+    end
+
+    add(item)
   end
 end
 
@@ -163,13 +180,13 @@ end
 
 # Sort the rows
 begin
-  $log.debug("Sorting/uniqing #{$items.count} items by #{[ $opts[:sep], $opts[:sort], 'sdate' ]}, reverse #{$opts[:reverse].inspect}")
+  $log.info("Sorting/uniqing #{$items.count} items by #{[ $opts[:sep], $opts[:sort], 'sdate' ]}, reverse #{$opts[:reverse].inspect}")
 
   $items.sort_by! { |i| [ i[$opts[:sep]], i[$opts[:sort]], i['sdate'] ] }
   $items.reverse! if $opts[:reverse]
   $items.uniq!
-rescue ArgumentError => e
-  $log.warn("Sorting failed, results may be unexpected\n")
+rescue Exception => e
+  $log.info("Sorting failed: #{e}\n")
 end
 
 $log.debug("#{$items.count} items remain")
@@ -211,6 +228,9 @@ 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 'yaml' then items.map { |i| i.self }.to_yaml
        when 'remind' then items.map { |i|
                             "REM #{i['sdate'].strftime('%F AT %R')} " +
@@ -225,7 +245,8 @@ end
 
 $log.debug("Formatting with #{mu.inspect}")
 
-section = nil if $opts[:sep]
+doc = RDoc::Markup::Document.new
+section = nil
 
 items.each_with_index do |i, j|
   $log.debug("Print #{j}: #{i.inspect}")
@@ -233,15 +254,16 @@ items.each_with_index do |i, j|
   # --li
   break if $opts[:li].positive? && j >= $opts[:li]
 
-  doc = RDoc::Markup::Document.new
+  # Use RDoc::Markup::Verbatim to save the item
+  v = RDoc::Markup::Verbatim.new
+  v.format = i
+  doc << v
 
   # Sections
   if $opts[:sep] && section != i[$opts[:sep]]
     $log.debug("New section '#{$opts[:sep]}': #{i[$opts[:sep]]}")
 
-    v = RDoc::Markup::Verbatim.new
-    v.format = { item: i, prop: $opts[:sep] }
-    doc << v
+    doc << RDoc::Markup::Raw.new($opts[:sep])
 
     doc << RDoc::Markup::BlankLine.new if j.positive?
     doc << RDoc::Markup::Heading.new(1, i[$opts[:sep]].to_s)
@@ -255,27 +277,30 @@ items.each_with_index do |i, j|
 
   # Properties
   $opts[:props].each_with_index do |prop, k|
-    next unless i[prop]
-    next if Array === i[prop] && !i[prop][0]
+    value = i[prop]
+
+    next unless value
+    next if Array === value && !value[0]
+    next if String === value && value.length == 0
 
-    $log.debug("#{prop}: #{i[prop]}")
+    $log.debug("#{prop}: #{value}")
 
-    v = RDoc::Markup::Verbatim.new
-    v.format = { item: i, prop: prop }
-    props << v
+    # Use Raw to save the property
+    props << RDoc::Markup::Raw.new(prop)
 
     unless k.positive?
       # First property, value only
-      props << RDoc::Markup::Heading.new(2, i[prop].to_s)
+      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(i[prop])) unless(i['placeholder'])
+      props << RDoc::Markup::ListItem.new(prop, RDoc::Markup::Paragraph.new(value)) unless(i['placeholder'])
     end
   end
 
   # Print it
-  unless props.empty?
-    doc << props
-    puts doc.accept(mu)
-  end
+  props << RDoc::Markup::BlankLine.new unless props.empty?
+
+  doc << props
 end
+
+print doc.accept(mu)

data/icalPal.gemspec

@@ -1,6 +1,8 @@
+require './lib/version'
+
 Gem::Specification.new do |s|
   s.name	= "icalPal"
-  s.version	= "1.2.1"
+  s.version	= ICalPal::VERSION
   s.summary	= "Command-line tool to query the macOS Calendar"
   s.description	= <<-EOF
 Inspired by icalBuddy and maintains close compatability.  Includes
@@ -17,6 +19,7 @@ EOF
   s.extra_rdoc_files = [ "README.md" ]
 
   s.add_runtime_dependency "sqlite3", "~> 1"
+  s.add_runtime_dependency "nokogiri-plist", "~> 0.5.0"
 
   s.bindir = 'bin'
   s.required_ruby_version = '>= 2.6.0'

data/lib/EventKit.rb

@@ -27,6 +27,13 @@ class EventKit
     'yearly',
   ]
 
+  EKReminderProperty = [
+    'none',                     # 0
+    'high', nil, nil, nil,      # 1
+    'medium', nil, nil, nil,    # 5
+    'low',                      # 9
+  ]
+
   # EKSourceType (with color)
   EKSourceType = [
     { name: 'Local',      color: '#FFFFFF' }, # White

data/lib/ToICalPal.rb

@@ -7,15 +7,25 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
   # ANSI[https://www.itu.int/rec/dologin_pub.asp?lang=e&id=T-REC-T.416-199303-I!!PDF-E&type=items]
   # colors
   ANSI = {
-    'black': 30,        '#000000': '38;5;0',
-    'red': 31,          '#ff0000': '38;5;1',
-    'green': 32,        '#00ff00': '38;5;2',
-    'yellow': 33,       '#ffff00': '38;5;3',
-    'blue': 34,         '#0000ff': '38;5;4',
-    'magenta': 35,      '#ff00ff': '38;5;5',
-    'cyan': 36,         '#00ffff': '38;5;6',
-    'white': 37,        '#ffffff': '38;5;255',
-    'default': 39,       'custom': nil,
+    'black':   30,  '#000000': '38;5;0',
+    'red':     31,  '#ff0000': '38;5;1',
+    'green':   32,  '#00ff00': '38;5;2',
+    'yellow':  33,  '#ffff00': '38;5;3',
+    'blue':    34,  '#0000ff': '38;5;4',
+    'magenta': 35,  '#ff00ff': '38;5;5',
+    'cyan':    36,  '#00ffff': '38;5;6',
+    'white':   37,  '#ffffff': '38;5;255',
+    'default': 39,  'custom': nil,
+
+    # Reminders custom colors
+    'brown':     '38;2;162;132;94',
+    'gray':      '38;2;91;98;106',
+    'indigo':    '38;2;88;86;214',
+    'lightblue': '38;2;90;200;250',
+    'orange':    '38;2;255;149;0',
+    'pink':      '38;2;255;45;85',
+    'purple':    '38;2;204;115;225',
+    'rose':      '38;2;217;166;159',
   }
 
   # Increased intensity
@@ -38,6 +48,8 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
 
   # @param opts [Hash] Used for conditional formatting
   # @option opts [String] :bullet Bullet
+  # @option opts [String] :ab Alert bullet
+  # @option opts [Boolean] :nb No bullet
   # @option opts [Boolean] :nc No calendar names
   # @option opts [Boolean] :npn No property names
   # @option opts [Integer] :palette (nil) 8 for \-f, 24 for \--color
@@ -67,6 +79,14 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
     rescue
     end
 
+    begin
+      if (@item['due_date'] + ICalPal::ITIME).between?(ICalPal::ITIME + 1, $now.to_i) then
+        @res << "#{@opts[:ab]} " unless @opts[:nb]
+        return
+      end
+    rescue
+    end
+
     @res << "#{@opts[:bullet]} " unless @opts[:nb]
   end
 
@@ -126,15 +146,21 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
     accept_blank_line
   end
 
-  # Don't add anything to the document, just save the item and
-  # property name for later
+  # Don't add anything to the document, just save the item for later
+  #
+  # @param arg [RDoc::Markup::Verbatim]
+  # @option arg [Object] :format The item
+  def accept_verbatim(arg)
+    @item = arg.format
+  end
+
+  # Don't add anything to the document, just save the property name
+  # for later
   #
-  # @param h [RDoc::Markup::Verbatim]
-  # @option h [String] :parts Ignored
-  # @option h [{item, prop => ICalPal::Event, String}] :format
-  def accept_verbatim(h)
-    @item = h.format[:item]
-    @prop = h.format[:prop]
+  # @param arg [RDoc::Markup::Raw]
+  # @option arg [Object] :parts The property
+  def accept_raw(arg)
+    @prop = arg.parts[0]
   end
 
   # @param str [String]

data/lib/defaults.rb

@@ -5,17 +5,21 @@ $today = ICalPal::RDT.new(*$now.to_a[0..2] + [0, 0, 0, $now.zone])
 # Defaults
 $defaults = {
   common: {
+    ab: '!',
     aep: [],
     bullet: '•',
     cf: "#{ENV['HOME']}/.icalPal",
     color: false,
     db: "#{ENV['HOME']}/Library/Calendars/Calendar.sqlitedb",
     debug: Logger::WARN,
+    df: '%b %-d, %Y',
     ec: [],
     eep: [],
+    el: [],
     es: [],
     et: [],
     ic: [],
+    il: [],
     is: [],
     it: [],
     li: 0,
@@ -27,11 +31,25 @@ $defaults = {
     sep: false,
     sort: nil,
     sp: false,
+    tf: '%-I:%M %p',
   },
   tasks: {
-    bullet: '!',
-    iep: [ 'notes', 'due', 'priority' ],
-    sort: 'priority',
+    dated: 0,
+    db: ICalPal::Reminder::DB_PATH,
+    iep: [ 'title', 'notes', 'due', 'priority' ],
+    sort: 'prio',
+  },
+  undatedTasks: {
+    dated: 1,
+    db: ICalPal::Reminder::DB_PATH,
+    iep: [ 'title', 'notes', 'due', 'priority' ],
+    sort: 'prio',
+  },
+  datedTasks: {
+    dated: 2,
+    db: ICalPal::Reminder::DB_PATH,
+    iep: [ 'title', 'notes', 'due', 'priority' ],
+    sort: 'prio',
   },
   stores: {
     iep: [ 'account', 'type' ],
@@ -43,7 +61,6 @@ $defaults = {
   },
   events: {
     days: nil,
-    df: '%b %-d, %Y',
     ea: false,
     eed: false,
     eep: [],
@@ -57,7 +74,6 @@ $defaults = {
     sed: false,
     sort: 'sdate',
     ss: "\n------------------------",
-    tf: '%-I:%M %p',
     to: nil,
     uid: false,
   }

data/lib/event.rb

@@ -114,6 +114,8 @@ module ICalPal
 
       # Repeat for multi-day events
       ((self['duration'] / 86400).to_i + 1).times do |i|
+        break if self['sdate'] > $opts[:to]
+
         $log.debug("multi-day event #{i + 1}") if (i > 0)
         self['daynum'] = i + 1
         retval.push(clone) if in_window?(self['sdate'])

data/lib/icalPal.rb

@@ -3,10 +3,12 @@ require_relative 'ToICalPal'
 require_relative 'calendar'
 require_relative 'event'
 require_relative 'rdt'
+require_relative 'reminder'
 require_relative 'store'
 
 # Encapsulate the _Store_ (accounts), _Calendar_ and _CalendarItem_
-# tables of a Calendar database
+# tables of a Calendar database, and the _Reminder_ table of a
+# Reminders database
 
 module ICalPal
   attr_reader :self
@@ -14,7 +16,7 @@ module ICalPal
   # Dynamic instantiation of our classes based on the command being
   # run
   #
-  # @param klass [String] One of +accounts+, +stores+, +calendars+, or +events+
+  # @param klass [String] One of +accounts+, +stores+, +calendars+, +events+, or +tasks+
   # @return [Class] The subclass of ICalPal
   def self.call(klass)
     case klass
@@ -22,13 +24,51 @@ module ICalPal
     when 'stores' then Store
     when 'calendars' then Calendar
     when 'events' then Event
-    when 'tasks' then Task
+    when 'tasks' then Reminder
     else
       $log.fatal("Unknown class: #{klass}")
       exit
     end
   end
 
+  # Load data
+  def self.load_data(db_file, q)
+    $log.debug(q.gsub(/\n/, ' '))
+
+    rows = []
+
+    begin
+      # Open the database
+      $log.debug("Opening database: #{db_file}")
+      db = SQLite3::Database.new(db_file, { readonly: true, results_as_hash: true })
+
+      # Prepare the query
+      stmt = db.prepare(q)
+      abort(stmt.columns.sort.join(' ')) if $opts[:props].any? 'list'
+      $opts[:props] = stmt.columns - $opts[:eep] if $opts[:props].any? 'all'
+
+      # Iterate the SQLite3::ResultSet once
+      stmt.execute.each_with_index { |i, j| rows[j] = i }
+      stmt.close
+
+      # Close the database
+      db.close
+      $log.debug("Closed #{db_file}")
+
+    rescue SQLite3::BusyException => e
+      $log.error("Non-fatal error closing database #{db.filename}")
+
+    rescue SQLite3::SQLException => e
+      $log.info("#{db_file}: #{e}")
+
+    rescue SQLite3::Exception => e
+      abort("#{db_file}: #{e}")
+
+    end
+
+    return(rows)
+  end
+
   # @param obj [ICalPal] A +Store+ or +Calendar+
   def initialize(obj)
     obj['type'] = EventKit::EKSourceType.find_index { |i| i[:name] == 'Subscribed' } if obj['subcal_url']
@@ -55,6 +95,49 @@ module ICalPal
     CSV::Row::new(headers, values)
   end
 
+  # Convert +self+ to XML
+  #
+  # @return [String] All fields in a simple XML format: <field>value</field>.
+  # Fields with empty values return <field/>.
+  def to_xml
+    retval = ""
+    @self.keys.each { |k| retval += xmlify(k, @self[k]) }
+
+    retval
+  end
+
+  # Convert a key/value pair to XML.  The value should be +nil+, +String+,
+  # +Integer+, +Array+, or +ICalPal::RDT+
+  #
+  # @param key The key
+  # @param value The value
+  # @return [String] The key/value pair in a simple XML format
+  def xmlify(key, value)
+    case value
+    # Nil
+    when NilClass then return("<#{key}/>")
+
+    # String, Integer
+    when String then return("<#{key}>#{value}</#{key}>")
+    when Integer then return("<#{key}>#{value}</#{key}>")
+
+    # Array
+    when Array then
+      # Treat empty arrays as nil values
+      return(xmlify(key, nil)) if value[0] == nil 
+
+      retval = ""
+      value.each { |x| retval += xmlify("#{key}0", x) }
+      return("<#{key}>#{retval}</#{key}>")
+
+    # RDT
+    when ICalPal::RDT then return("<#{key}>#{value.to_s}</#{key}>")
+
+    # Unknown
+    else return("<#{key}>#{value.to_s}</#{key}>")
+    end
+  end
+
   # Get the +n+'th +dow+ in month +m+
   #
   # @param n [Integer] Integer between -4 and +4

data/lib/options.rb

@@ -1,6 +1,7 @@
 require 'optparse'
 
 require_relative 'defaults'
+require_relative 'version'
 
 module ICalPal
   # Handle program options from all sources:
@@ -23,7 +24,7 @@ module ICalPal
       @op = OptionParser.new
       @op.summary_width = 23
       @op.banner += " [-c] COMMAND"
-      @op.version = '1.2.1'
+      @op.version = ICalPal::VERSION
 
       @op.accept(ICalPal::RDT) { |s| ICalPal::RDT.conv(s) }
 
@@ -31,6 +32,7 @@ module ICalPal
       @op.on("\nCOMMAND must be one of the following:\n\n")
 
       @op.on("%s%s %sPrint events" % pad('events'))
+      @op.on("%s%s %sPrint tasks" % pad('tasks'))
       @op.on("%s%s %sPrint calendars" % pad('calendars'))
       @op.on("%s%s %sPrint accounts" % pad('accounts'))
 
@@ -38,16 +40,20 @@ module ICalPal
       @op.on("%s%s %sPrint events occurring today" % pad('eventsToday'))
       @op.on("%s%s %sPrint events occurring between today and NUM days into the future" % pad('eventsToday+NUM'))
       @op.on("%s%s %sPrint events occurring at present time" % pad('eventsNow'))
+      @op.on("%s%s %sPrint tasks with a due date" % pad('datedTasks'))
+      @op.on("%s%s %sPrint tasks with no due date" % pad('undatedTasks'))
 
       # global
       @op.separator("\nGlobal options:\n\n")
 
       @op.on('-c=COMMAND', '--cmd=COMMAND', COMMANDS, 'Command to run')
-      @op.on('--db=DB', 'Use DB file instead of Calendar')
+      @op.on('--db=DB', "Use DB file instead of Calendar (default: #{$defaults[:common][:db]})",
+             'For the tasks commands this should be a directory containing .sqlite files',
+             "(default: #{$defaults[:tasks][:db]})")
       @op.on('--cf=FILE', "Set config file path (default: #{$defaults[:common][:cf]})")
       @op.on('-o', '--output=FORMAT', OUTFORMATS,
             "Print as FORMAT (default: #{$defaults[:common][:output]})", "[#{OUTFORMATS.join(', ')}]")
-
+      
       # include/exclude
       @op.separator("\nIncluding/excluding calendars:\n\n")
 
@@ -63,6 +69,10 @@ module ICalPal
       @op.on('--ic=CALENDARS', Array, 'List of calendars to include')
       @op.on('--ec=CALENDARS', Array, 'List of calendars to exclude')
 
+      @op.separator('')
+      @op.on('--il=LISTS', Array, 'List of reminder lists to include')
+      @op.on('--el=LISTS', Array, 'List of reminder lists to exclude')
+
       # dates
       @op.separator("\nChoosing dates:\n\n")
 
@@ -85,10 +95,11 @@ module ICalPal
       @op.on('--eep=PROPERTIES', Array, 'List of properties to exclude')
       @op.on('--aep=PROPERTIES', Array, 'List of properties to include in addition to the default list')
       @op.separator('')
-      # @op.on('--itp=PROPERTIES', Array, 'List of task properties to include')
-      # @op.on('--etp=PROPERTIES', Array, 'List of task properties to exclude')
-      # @op.on('--atp=PROPERTIES', Array, 'List of task properties to include in addition to the default list')
-      # @op.separator('')
+      @op.on('--itp=PROPERTIES', Array, 'List of task properties to include')
+      @op.on('--etp=PROPERTIES', Array, 'List of task properties to exclude')
+      @op.on('--atp=PROPERTIES', Array, 'List of task properties to include in addition to the default list',
+            'Included for backwards compatability, these are aliases for --iep, --eep, and --aep')
+      @op.separator('')
 
       @op.on('--uid', 'Show event UIDs')
       @op.on('--eed', 'Exclude end datetimes')
@@ -114,13 +125,12 @@ module ICalPal
       @op.separator('')
       @op.on('--sc', 'Separate by calendar')
       @op.on('--sd', 'Separate by date')
-      # @op.on('--sp', 'Separate by priority')
-      # @op.on('--sta', 'Sort tasks by due date (ascending)')
-      # @op.on('--std', 'Sort tasks by due date (descending)')
-      # @op.separator('')
+      @op.on('--sp', 'Separate by priority')
       @op.on('--sep=PROPERTY', 'Separate by PROPERTY')
       @op.separator('')
       @op.on('--sort=PROPERTY', 'Sort by PROPERTY')
+      @op.on('--std', 'Sort tasks by due date (same as --sort=due_date)')
+      @op.on('--stda', 'Sort tasks by due date (ascending) (same as --sort=due_date -r)')
       @op.on('-r', '--reverse', 'Sort in reverse')
 
       @op.separator('')
@@ -134,6 +144,7 @@ module ICalPal
 
       @op.separator('')
       @op.on('-b', '--bullet=STRING', String, 'Use STRING for bullets')
+      @op.on('--ab=STRING', String, 'Use STRING for alert bullets')
       @op.on('--nb', 'Do not use bullets')
       @op.on('--nnr=SEPARATOR', String, 'Set replacement for newlines within notes')
 
@@ -202,10 +213,21 @@ module ICalPal
           .merge(env)
           .merge(cli)
 
+        # datedTasks and undatedTasks
+        opts[:cmd] = "tasks" if opts[:cmd] == "datedTasks"
+        opts[:cmd] = "tasks" if opts[:cmd] == "undatedTasks"
+
         # All kids love log!
         $log.level = opts[:debug]
 
+        # For posterity
+        opts[:ruby] = RUBY_VERSION
+        opts[:version] = @op.version
+
         # From the Department of Redundancy Department
+        opts[:iep] += opts[:itp] if opts[:itp]
+        opts[:eep] += opts[:etp] if opts[:etp]
+        opts[:aep] += opts[:atp] if opts[:atp]
         opts[:props] = (opts[:iep] + opts[:aep] - opts[:eep]).uniq
 
         # From, to, days
@@ -217,6 +239,10 @@ module ICalPal
           opts[:from] = $now if opts[:n]
         end
 
+        # Sorting
+        opts[:sort] = 'due_date' if opts[:std] or opts[:stda]
+        opts[:reverse] = true if opts[:std]
+
         # Colors
         opts[:palette] = 8 if opts[:f]
         opts[:palette] = 24 if opts[:color]
@@ -225,7 +251,7 @@ module ICalPal
         unless opts[:sep]
           opts[:sep] = 'calendar' if opts[:sc]
           opts[:sep] = 'sday' if opts[:sd]
-          opts[:sep] = 'priority' if opts[:sp]
+          opts[:sep] = 'long_priority' if opts[:sp]
         end
         opts[:nc] = true if opts[:sc]
 
@@ -234,17 +260,6 @@ module ICalPal
         raise(OptionParser::InvalidOption, 'Start date must be before end date') if opts[:from] && opts[:from] > opts[:to]
         raise(OptionParser::MissingArgument, 'No properties to display') if opts[:props].empty?
 
-        # Open the database here so we can catch errors and print the help message
-        $log.debug("Opening database: #{opts[:db]}")
-        $db = SQLite3::Database.new(opts[:db], { readonly: true, results_as_hash: true })
-        $db.prepare('SELECT 1 FROM Calendar LIMIT 1').close
-
-      rescue SQLite3::SQLException => e
-        @op.abort("#{opts[:db]} is not a Calendar database")
-
-      rescue SQLite3::Exception => e
-        @op.abort("#{opts[:db]}: #{e}")
-
       rescue StandardError => e
         @op.abort("#{e}\n\n#{@op.help}\n#{e}")
       end
@@ -253,10 +268,10 @@ module ICalPal
     end
 
     # Commands that can be run
-    COMMANDS = %w{events eventsToday eventsNow calendars accounts stores}
+    COMMANDS = %w{events eventsToday eventsNow tasks datedTasks undatedTasks calendars accounts stores}
 
     # Supported output formats
-    OUTFORMATS = %w{ansi csv default hash html json md rdoc toc yaml remind}
+    OUTFORMATS = %w{ansi csv default hash html json md rdoc remind toc xml yaml}
 
     private
 

data/lib/reminder.rb

@@ -0,0 +1,110 @@
+require 'open3'
+require 'nokogiri-plist'
+
+module ICalPal
+  # Class representing items from the <tt>Reminders</tt> database
+  class Reminder
+    include ICalPal
+
+    def [](k)
+      case k
+      when 'notes' then         # Skip empty notes
+        @self['notes'].length > 0? @self['notes'] : nil
+
+      when 'priority' then      # Integer -> String
+        EventKit::EKReminderProperty[@self['priority']] if @self['priority'] > 0
+
+      when 'sdate' then         # For sorting
+        @self['title']
+
+      else @self[k]
+      end
+    end
+
+    def initialize(obj)
+      @self = {}
+      obj.keys.each { |k| @self[k] = obj[k] }
+
+      # Priority
+      @self['prio'] = 0 if @self['priority'] == 1 # high
+      @self['prio'] = 1 if @self['priority'] == 5 # medium
+      @self['prio'] = 2 if @self['priority'] == 9 # low
+      @self['prio'] = 3 if @self['priority'] == 0 # none
+
+      @self['long_priority'] = LONG_PRIORITY[@self['prio']]
+
+      # For sorting
+      @self['sdate'] = (@self['title'])? @self['title'] : ""
+
+      # Due date
+      @self['due'] = RDT.new(*Time.at(@self['due_date'] + ITIME).to_a.reverse[4..]) if @self['due_date']
+      @self['due_date'] = 0 unless @self['due_date']
+
+      # Notes
+      @self['notes'] = "" unless @self['notes']
+
+      # Color
+      @self['color'] = nil unless $opts[:palette]
+
+      if @self['color'] then
+        # Run command
+        stdin, stdout, stderr, e = Open3.popen3(PL_CONVERT)
+
+        # Send color bplist
+        stdin.write(@self['color'])
+        stdin.close
+
+        # Read output
+        plist = Nokogiri::PList(stdout.read)['$objects']
+
+        @self['color'] = plist[3]
+        @self['symbolic_color_name'] = (plist[2] == 'custom')? plist[4] : plist[2]
+      else
+        @self['color'] = DEFAULT_COLOR
+        @self['symbolic_color_name'] = DEFAULT_SYMBOLIC_COLOR
+      end
+    end
+
+    private
+
+    DEFAULT_COLOR = '#1BADF8'
+    DEFAULT_SYMBOLIC_COLOR = 'blue'
+
+    LONG_PRIORITY = [
+      "High priority",
+      "Medium priority",
+      "Low priority",
+      "No priority",
+    ]
+
+    PL_CONVERT = '/usr/bin/plutil -convert xml1 -o - -'
+
+    DB_PATH = "#{Dir::home}/Library/Group Containers/group.com.apple.reminders/Container_v1/Stores"
+
+    QUERY = <<~SQL
+SELECT DISTINCT
+
+zremcdReminder.zAllday as all_day,
+zremcdReminder.zDuedate as due_date,
+zremcdReminder.zFlagged as flagged,
+zremcdReminder.zNotes as notes,
+zremcdReminder.zPriority as priority,
+zremcdReminder.zTitle as title,
+
+zremcdBaseList.zBadgeEmblem as badge,
+zremcdBaseList.zColor as color,
+zremcdBaseList.zName as list_name,
+zremcdBaseList.zParentList as parent,
+zremcdBaseList.zSharingStatus as shared
+
+FROM zremcdReminder
+
+JOIN zremcdBaseList ON zremcdReminder.zList = zremcdBaseList.z_pk
+
+WHERE zremcdReminder.zCompleted = 0
+AND zremcdReminder.zMarkedForDeletion = 0
+
+SQL
+
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module ICalPal
+  VERSION = '2.1.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icalPal
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Andy Rosen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-06 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri-plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 description: |
   Inspired by icalBuddy and maintains close compatability.  Includes
   many additional features for querying, filtering, and formatting.
@@ -45,7 +59,9 @@ files:
 - lib/icalPal.rb
 - lib/options.rb
 - lib/rdt.rb
+- lib/reminder.rb
 - lib/store.rb
+- lib/version.rb
 homepage: https://github.com/ajrosen/icalPal
 licenses:
 - GPL-3.0-or-later
@@ -65,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Command-line tool to query the macOS Calendar