Version 3.8.0

Major update.  See CHANGELOG for details.

Author: ajrosen

.rubocop.yml

@@ -118,7 +118,7 @@ Style/GlobalStdStream:
   Enabled: false
 
 Style/GlobalVars:
-  AllowedVariables: [ $defaults, $items, $log, $now, $opts, $today, $rows ]
+  AllowedVariables: [ $defaults, $items, $log, $now, $opts, $today, $rows, $sections ]
 
 Style/LineEndConcatenation:
   Enabled: false

CHANGELOG.md

@@ -1,3 +1,68 @@
+icalPal-3.8.0
+==================
+
+  * Add properties for tasks commands
+	* id
+	* group
+	* section
+	* tags
+	* assignee
+	* timezone
+	* Notifications
+	  * due (due_date formatted with --df and --tf options)
+	  * alert (Early Reminder)
+	  * location, proximity (arriving or leaving), radius (in meters)
+	  * messaging (email addresses and phone numbers from "When Messaging")
+
+  * Limit properties for accounts command
+	* account
+	* notes
+	* owner
+	* type
+	* delegations
+
+  * Limit properties for calendar command
+	* account
+	* UUID
+	* shared\_owner_name, shared\_owner_address
+	* self\_identity_email, owner\_identity_email
+	* subcal\_account_id, subcal_url
+	* published_URL
+	* notes
+	* locale
+
+  * New command aliases
+	* reminders for tasks commands
+
+  * Property aliases
+	* name or title for account in accounts command
+	* name or title for calendar in calendars command
+	* name or event for title in events commands
+	* name, reminder, or task for title in tasks commands
+
+  * Bug fixes
+	* Add additional properties from --iep/--aep with --iep/--aep all
+	* Do not include properties twice
+	* Adjust indentation of task properties to match icalBuddy
+	* Sorting tasks
+	* Handle Errno::EPERM (needs Full Disk Access) for Reminders database
+
+icalPal-3.7.2
+==================
+
+  * atp, etp, and itp options were not aliases for aep, eep, and iep per the documentation
+
+icalPal-3.7.1
+==================
+
+  * Fix stores command (#36)
+
+
+icalPal-3.7.0
+==================
+
+  * Add sseconds/eseconds fields for easier post-processing
+
 icalPal-3.6.1 / 2025-05-18
 ==================
 

README.md

@@ -10,14 +10,13 @@ on any system with [Ruby](https://www.ruby-lang.org/) and access to a
 Calendar or Reminders database.
 
 <!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
-
 **Table of Contents**
 
 - [Installation](#installation)
 - [Features](#features)
-  - [Compatability with icalBuddy](#compatability-with-icalbuddy)
   - [Additional commands](#additional-commands)
   - [Additional options](#additional-options)
+  - [Additional properties](#additional-properties)
 - [Usage](#usage)
 - [Output formats](#output-formats)
 - [History](#history)
@@ -67,24 +66,61 @@ as *Stores*; you can run ```icalPal stores``` instead.
 
 Shows only reminders that have a due date.
 
+```icalPal reminders```
+
+*reminders*, *datedReminders*, and *undatedReminders* can be used instead of *tasks*
+
 ### 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```.
 * 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.
+* Copy your Calendar or Reminders database file and use ```--db``` on it.
 * ```--it``` and ```--et``` will filter by Calendar *type*.  Types are **Local**, **Exchange**, **CalDAV**, **MobileMe**, **Subscribed**, **Birthdays**, and **Reminders**
 * ```--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/).
+* ```--color``` uses a wider color palette.  Colors are what you have chosen in the Calendar and Reminders apps, including custom colors
 * ```--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
-versions of Ruby included with macOS Sequoia (2.6.10) and
-[Homebrew](https://brew.sh/) (3.4.4).
+versions of Ruby included with macOS Sequoia and Tahoe (2.6.10) and
+[Homebrew](https://brew.sh/) (3.4.x).
+
+### Additional properties
+
+Several additional properties are available for each command.
+
+* Accounts
+  * account
+  * notes
+  * owner
+  * type
+  * delegations
+
+* Calendar
+  * account
+  * shared\_owner_name, shared\_owner_address
+  * self\_identity_email, owner\_identity_email
+  * subcal_account_id, subcal_url
+  * published_URL
+  * notes
+  * locale
+
+* Tasks
+	* id
+	* group
+	* section
+	* tags
+	* assignee
+	* timezone
+	* Notifications
+	  * due (due_date formatted with --df and --tf options)
+	  * alert (Early Reminder)
+	  * location, proximity (arriving or leaving), radius (in meters)
+	  * messaging (email addresses and phone numbers from "When Messaging")
 
 ## Usage
 
@@ -109,16 +145,16 @@ Global options:
 ```
     -c, --cmd=COMMAND       Command to run
         --db=DB             Use DB file instead of Calendar
-                            (default: ["/Users/user/Library/Group Containers/group.com.apple.calendar/Calendar.sqlitedb", "/Users/user/Library/Calendars/Calendar.sqlitedb"]
+                            (default: ["$HOME/Library/Group Containers/group.com.apple.calendar/Calendar.sqlitedb", "/Users/user/Library/Calendars/Calendar.sqlitedb"]
                             For the tasks commands this should be a directory containing .sqlite files
-                            (default: /Users/user/Library/Group Containers/group.com.apple.reminders/Container_v1/Stores)
-        --cf=FILE           Set config file path (default: /Users/user/.icalpal)
+                            (default: $HOME/Library/Group Containers/group.com.apple.reminders/Container_v1/Stores)
+        --cf=FILE           Set config file path (default: $HOME/.icalpal)
         --norc              Ignore ICALPAL and ICALPAL_CONFIG environment variables
     -o, --output=FORMAT     Print as FORMAT (default: default)
                             [ansi, csv, default, hash, html, json, md, rdoc, remind, toc, xml, yaml]
 ```
 
-Including/excluding calendars and reminders:
+Including/excluding accounts, calendars, reminders and items:
 ```
         --is=ACCOUNTS       List of accounts to include
         --es=ACCOUNTS       List of accounts to exclude
@@ -133,8 +169,7 @@ Including/excluding calendars and reminders:
         --il=LISTS          List of reminder lists to include
         --el=LISTS          List of reminder lists to exclude
 
-        --match=FIELD=REGEXP
-                            Include only items whose FIELD matches REGEXP (ignoring case)
+        --match=FIELD=REGEX Include only items whose FIELD matches REGEXP (ignoring case)
 ```
 
 Choosing dates:

bin/icalpal

@@ -56,6 +56,7 @@ end
 $opts = ICalPal::Options.new.parse_options
 
 $rows = []                      # Rows from the database
+$sections = []                  # Calendar list sections
 $items = []                     # Items to be printed
 
 
@@ -93,19 +94,31 @@ $opts[:db].each do |db|
       # Load all .sqlite files
       $log.debug("Loading *.sqlite in #{db}")
       Dir.glob("#{db}/*.sqlite").each do |d|
-        $rows += ICalPal.load_data(d, klass::QUERY)
         success = true
 
+        rows = klass.load_data(d, klass::QUERY)
+        $rows += rows
+
+        sections = klass.load_data(d, klass::SECTIONS_QUERY)
+        $sections += sections
+
+        $log.info("Loaded #{rows.length} rows and #{sections.length} sections from #{d}")
       rescue SQLite3::CantOpenException
         # Non-fatal exception, try the next one
       end
+
+    rescue Errno::EPERM
+      # Probably need Full Disk Access
     end
   else
     # Load database
     begin
-      $rows += ICalPal.load_data(db, klass::QUERY)
+      rows = ICalPal.load_data(db, klass::QUERY)
+      $rows += rows
+
       success = true
 
+      $log.info("Loaded #{rows.length} rows from #{db}")
     rescue SQLite3::CantOpenException
       # Non-fatal exception, try the next one
     end
@@ -140,8 +153,7 @@ unless success
   abort
 end
 
-$log.info("Loaded #{$rows.count} #{klass} rows")
-$log.info("Window is #{$opts[:from]} to #{$opts[:to]}")
+$log.info("Window is #{$opts[:from]} to #{$opts[:to]}") if $opts[:from]
 
 
 ##################################################
@@ -191,8 +203,8 @@ $rows.each do |row|
   else
     # Check for dated reminders
     if ICalPal::Reminder === item
-      next if $opts[:dated] == 1 && item['due_date'].positive?
-      next if $opts[:dated] == 2 && item['due_date'].zero?
+      next if $opts[:dated] == 1 && item['due_date'] && item['due_date'].positive?
+      next if $opts[:dated] == 2 && (!item['due_date'] || item['due_date'].zero?)
     end
 
     add(item)
@@ -211,9 +223,14 @@ end
 
 # Sort the rows
 begin
-  $log.info("Sorting #{$items.count} items by #{[ $opts[:sep], $opts[:sort], 'sdate' ]}, reverse #{$opts[:reverse].inspect}")
+  sort = []
+  sort.push $opts[:sep] if $opts[:sep]
+  sort.push $opts[:sort] if $opts[:sort]
+  sort.push 'sdate'
+
+  $log.info("Sorting #{$items.count} items by #{sort}, reverse #{$opts[:reverse].inspect}")
 
-  $items.sort_by! { |i| [ i[$opts[:sep]], i[$opts[:sort]], i['sdate'] ] }
+  $items.sort_by! { |i| sort }
   $items.reverse! if $opts[:reverse]
 rescue Exception => e
   $log.info("Sorting failed: #{e}\n")

lib/EventKit.rb

@@ -37,6 +37,29 @@ class EventKit
     'low',                      # 9
   ].freeze
 
+  EKReminderDueDateDeltaUnit = %w[
+    minutes
+    hours
+    days
+    weeks
+    months
+  ].freeze
+
+  EKReminderProximity = [
+    nil,
+    'arriving',
+    'leaving'
+  ].freeze
+
+  EKReminderAccessLevel = [
+    { value: 2, level: 'can add' }
+  ].freeze
+
+  EKReminderSharingStatus = [
+    { value: 1, status: 'accepted' },
+    { value: 5, status: 'invited' }
+  ].freeze
+
   # EKSourceType (with color)
   EKSourceType = [
     { name: 'Local',      color: '#FFFFFF' }, # White

lib/calendar.rb

@@ -3,20 +3,41 @@ module ICalPal
   class Calendar
     include ICalPal
 
+    def [](k)
+      case k
+      when 'name', 'title'      # Aliases
+        @self['calendar']
+
+      else @self[k]
+      end
+    end
+
     QUERY = <<~SQL.freeze
 SELECT DISTINCT
 
-Store.name AS account,
-Calendar.title AS calendar,
-*
+s1.name AS account,
+
+c1.UUID,
+c1.title AS calendar,
+
+c1.shared_owner_name,
+c1.shared_owner_address,
+
+c1.published_URL,
+c1.self_identity_email,
+c1.owner_identity_email,
+c1.notes,
+c1.subcal_account_id,
+c1.subcal_url,
+c1.locale
 
-FROM #{self.name.split('::').last}
+FROM #{self.name.split('::').last} c1
 
-JOIN Store ON store_id = Store.rowid
+JOIN Store s1 ON c1.store_id = s1.rowid
 
-WHERE Store.disabled IS NOT 1
-AND Store.display_order IS NOT -1
-AND Calendar.flags IS NOT 519
+WHERE s1.disabled IS NOT 1
+AND s1.display_order IS NOT -1
+AND c1.flags IS NOT 519
 SQL
 
   end

lib/defaults.rb

@@ -44,24 +44,27 @@
     dated: 0,
     db: [ ICalPal::Reminder::DB_PATH ],
     iep: %w[ title notes due priority ],
+    ps: [ "\n    " ],
     sort: 'prio',
   },
 
   undatedTasks: {
     dated: 1,
     db: [ ICalPal::Reminder::DB_PATH ],
     iep: %w[ title notes due priority ],
+    ps: [ "\n    " ],
     sort: 'prio',
   },
 
   datedTasks: {
     dated: 2,
     db: [ ICalPal::Reminder::DB_PATH ],
     iep: %w[ title notes due priority ],
+    ps: [ "\n    " ],
     sort: 'prio',
   },
 
-  stores: {
+  accounts: {
     iep: %w[ account type ],
     sort: 'account',
   },