icalPal 3.8.3 → 3.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53e9d1413da61496024e336dfe5164e680f211603b5cd647fa9525a0aaff5899
-  data.tar.gz: a107b8fcf0dbee3eafc77c80d45b450ab2fad5d1ec2676299b3dc57f0070d5f4
+  metadata.gz: 726009d217b28c21e4a35339eef172f033429792b68d4c36157e6234f6221cab
+  data.tar.gz: cf2ee63838a89a8acf25719154d03654e1bbf1fe47459481ddcb5e09f19a31f0
 SHA512:
-  metadata.gz: 64bb5a9d98f5fd8c8aca7d184401e39ab1b6621445a3481da511ea7506ae82c7506f1e1e88e4344ca0954b79a973e79867dbec97f312fc35f3129c91fd5cbdba
-  data.tar.gz: 9796c5d7913b7ff5b0d642e61318e84c787c866b0a8c2bbc91344e566a81e2e187d57e22a70920e940a22bfdd4eb4d01d500f9ae7094fc92c91a80e8e671fd03
+  metadata.gz: 7120724aaa3be333484a6feca64cb1cf5b6f5ded5e93b5a4f6c99ec6e247ddd659bcc7c4f3af70b7b3e81dc28b1221bebac88d29c70bc497a89f242689ae088b
+  data.tar.gz: b452c105b9ea954aa9c68a9b7a4088599b32b0b1b29e3f783804ec692eef65e8c7a1d916d3b9061c475ed880b950f9eebf31d870c8eda7751f33e4fd79bc9ae9

data/README.md

@@ -51,7 +51,7 @@ differences to be aware of.
 * *eventsFrom* is not supported.  Instead there is *--from*, *--to*, and *--days*
 * *uncompletedTasks* is simply *tasks*
 * *undatedUncompletedTasks* is simply *undatedTasks*
-* *tasksDueBefore:DATE* is not yet supported
+* *tasksDueBefore:DATE* uses *--from*, *--to*, and *--days* instead of *:DATE*
 * The command can go anywhere; it doesn't have to be the last argument
 * Property separators are comma-delimited
 
@@ -68,16 +68,23 @@ Shows only reminders that have a due date.
 
 ```icalPal reminders```
 
-*reminders*, *datedReminders*, and *undatedReminders* can be used instead of *tasks*
+*reminders*, *datedReminders*, *undatedReminders*, and
+*remindersDueBefore* can be used instead of *tasks*
+
+Reminders can also be viewed in the *Scheduled Reminders* calendar,
+using the *tasks* commands.  Repeating reminders are treated the same
+as repeating events.
 
 ### 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.
+* Use ```-o``` to print the output in different formats.  CSV or JSON are interesting choices.
 * 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
+* ```--id``` includes completed reminders
+* ```--ed``` excludes uncompleted reminders
 * ```--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```)
@@ -111,6 +118,8 @@ Several additional properties are available for each command.
 
 * Tasks
 	* id
+	* grocery
+	* completed
 	* group
 	* section
 	* tags
@@ -139,15 +148,19 @@ COMMAND must be one of the following:
     eventsRemaining         Print events occurring between present time and midnight
     datedTasks              Print tasks with a due date
     undatedTasks            Print tasks with no due date
+    tasksDueBefore          Print uncompleted tasks due between the given dates
+
+    stores can be used instead of accounts
+    reminders can be used instead of tasks
 ```
 
 Global options:
 ```
     -c, --cmd=COMMAND       Command to run
         --db=DB             Use DB file instead of Calendar
-                            (default: ["$HOME/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", $HOME/Library/Calendars/Calendar.sqlitedb]
                             For the tasks commands this should be a directory containing .sqlite files
-                            (default: $HOME/Library/Group Containers/group.com.apple.reminders/Container_v1/Stores)
+                            (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)
@@ -169,6 +182,9 @@ Including/excluding accounts, calendars, reminders and items:
         --il=LISTS          List of reminder lists to include
         --el=LISTS          List of reminder lists to exclude
 
+        --id                Include completed reminders
+        --ed                Exclude uncompleted reminders
+
         --match=FIELD=REGEX Include only items whose FIELD matches REGEXP (ignoring case)
 ```
 
@@ -243,7 +259,7 @@ Formatting the output:
 Help:
 ```
     -h, --help              Show this message
-    -V, -v, --version       Show version and exit (2.0.0)
+    -V, -v, --version       Show version and exit (3.9.1)
     -d, --debug=LEVEL       Set the logging level (default: warn)
                             [debug, info, warn, error, fatal]
 ```
@@ -252,7 +268,7 @@ Environment variables:
 ```
     ICALPAL                 Additional arguments
     ICALPAL_CONFIG          Additional arguments from a file
-                            (default: /Users/user/.icalpal)
+                            (default: $HOME/.icalpal)
 
     Do not quote or escape values.  Options set in ICALPAL override ICALPAL_CONFIG.  Options on the command line override ICALPAL.
 ```
@@ -264,11 +280,12 @@ 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
+like.  [Remind](https://dianne.skoll.ca/projects/remind/) format uses a
 minimal implementation built into icalPal.
 
+Control characters are escaped in these formats to ensure they remain
+properly formatted.
+
 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)
 framework to build and render the items.
@@ -276,8 +293,8 @@ framework to build and render the items.
 Each item to be printed is a new
 [RDoc::Markup::Document](https://ruby-doc.org/stdlib-2.6.10/libdoc/rdoc/rdoc/RDoc/Markup/Document.html).
 
-When using one of the <em>separate by</em> options, a section header
-is added first.  The section contains:
+When using one of the _separate by_ options, a section header is added
+first.  The section contains:
 
 * [RDoc::Markup::BlankLine](https://ruby-doc.org/stdlib-2.6.10/libdoc/rdoc/rdoc/RDoc/Markup/BlankLine.html)
   (unless this is the first section)
@@ -315,9 +332,10 @@ 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; less than 2,000 lines vs. 7,000.  It also means
-icalPal is multi-platform.
+to start anew using my language of choice:
+[Ruby](https://www.ruby-lang.org).  Using Ruby meant there is *much*
+less code; a little over 2,000 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/bin/icalPal

@@ -191,7 +191,7 @@ $rows.each do |row|
     end
   end
 
-  if ICalPal::Event === item
+  if item.is_a?(ICalPal::Event)
     # Check for all-day and cancelled events
     next if $opts[:ea] && item['all_day'].positive?
     next if $opts[:ia] && !item['all_day'].positive?
@@ -201,10 +201,18 @@ $rows.each do |row|
       item.recurring.each { |j| add(j) } :
       item.non_recurring.each { |j| add(j) }
   else
-    # Check for dated reminders
-    if ICalPal::Reminder === item
+    # Check for completed or dated reminders
+    if item.is_a?(ICalPal::Reminder)
+      next if $opts[:ed] && item['completed'].zero?
+      next unless $opts[:id] || item['completed'].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?)
+
+      if $opts[:dated] == 3
+        next unless item['due_date']
+        next unless item['due_date'].between?($opts[:from].to_i, $opts[:to].to_i)
+      end
     end
 
     add(item)
@@ -230,7 +238,7 @@ begin
 
   $log.info("Sorting #{$items.count} items by #{sort}, reverse #{$opts[:reverse].inspect}")
 
-  $items.sort_by! { |i| [i[sort[0]], i[sort[1]], i[sort[2]] ] }
+  $items.sort_by! { |i| [ i[sort[0]], i[sort[1]], i[sort[2]] ] }
   $items.reverse! if $opts[:reverse]
 rescue Exception => e
   $log.info("Sorting failed: #{e}\n")
@@ -282,7 +290,7 @@ unless mu
        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']}"
+             "MSG #{i['title'].gsub(/([[:cntrl:]])/) { |c| c.dump[1..-2] } }"
          }.join("\n")
        else abort "No formatter for #{$opts[:output]}"
        end
@@ -327,8 +335,8 @@ items.each_with_index do |i, j|
     value = i[prop]
 
     next unless value
-    next if Array === value && !value[0]
-    next if String === value && value.empty?
+    next if value.is_a?(Array) && !value[0]
+    next if value.is_a?(String) && value.empty?
 
     $log.debug("#{prop}: #{value}")
 

data/bin/icalpal

@@ -191,7 +191,7 @@ $rows.each do |row|
     end
   end
 
-  if ICalPal::Event === item
+  if item.is_a?(ICalPal::Event)
     # Check for all-day and cancelled events
     next if $opts[:ea] && item['all_day'].positive?
     next if $opts[:ia] && !item['all_day'].positive?
@@ -201,10 +201,18 @@ $rows.each do |row|
       item.recurring.each { |j| add(j) } :
       item.non_recurring.each { |j| add(j) }
   else
-    # Check for dated reminders
-    if ICalPal::Reminder === item
+    # Check for completed or dated reminders
+    if item.is_a?(ICalPal::Reminder)
+      next if $opts[:ed] && item['completed'].zero?
+      next unless $opts[:id] || item['completed'].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?)
+
+      if $opts[:dated] == 3
+        next unless item['due_date']
+        next unless item['due_date'].between?($opts[:from].to_i, $opts[:to].to_i)
+      end
     end
 
     add(item)
@@ -230,7 +238,7 @@ begin
 
   $log.info("Sorting #{$items.count} items by #{sort}, reverse #{$opts[:reverse].inspect}")
 
-  $items.sort_by! { |i| [i[sort[0]], i[sort[1]], i[sort[2]] ] }
+  $items.sort_by! { |i| [ i[sort[0]], i[sort[1]], i[sort[2]] ] }
   $items.reverse! if $opts[:reverse]
 rescue Exception => e
   $log.info("Sorting failed: #{e}\n")
@@ -282,7 +290,7 @@ unless mu
        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']}"
+             "MSG #{i['title'].gsub(/([[:cntrl:]])/) { |c| c.dump[1..-2] } }"
          }.join("\n")
        else abort "No formatter for #{$opts[:output]}"
        end
@@ -327,8 +335,8 @@ items.each_with_index do |i, j|
     value = i[prop]
 
     next unless value
-    next if Array === value && !value[0]
-    next if String === value && value.empty?
+    next if value.is_a?(Array) && !value[0]
+    next if value.is_a?(String) && value.empty?
 
     $log.debug("#{prop}: #{value}")
 

data/lib/ToICalPal.rb

@@ -74,17 +74,14 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
   #
   # @param _arg [Array] Ignored
   def accept_list_start(_arg)
-    begin
-      return if @item['placeholder']
+    return if @opts[:nb] || @item['placeholder']
 
-      if (@item['due_date'] + ICalPal::ITIME).between?(ICalPal::ITIME + 1, $now.to_i)
-        @res << "#{@opts[:ab]} " unless @opts[:nb]
-        return
-      end
-    rescue
+    if @item['due_date'] && (@item['due_date']).between?(0, $now.to_i)
+      # Use alert bullet for overdue items
+      @res << "#{@opts[:ab]} "
+    else
+      @res << "#{@opts[:bullet]} "
     end
-
-    @res << "#{@opts[:bullet]} " unless @opts[:nb]
   end
 
   # Add a property name

data/lib/defaults.rb

@@ -64,6 +64,15 @@ $defaults = {
     sort: 'prio',
   },
 
+  tasksDueBefore: {
+    dated: 3,
+    db: [ ICalPal::Reminder::DB_PATH ],
+    iep: %w[ title notes due priority ],
+    ps: [ "\n    " ],
+    sort: 'prio',
+    to: $today,
+  },
+
   accounts: {
     iep: %w[ account type ],
     sort: 'account',

data/lib/event.rb

@@ -78,7 +78,7 @@ module ICalPal
         'sdate' => obj,
         'placeholder' => true,
         'title' => 'Nothing.',
-      } if DateTime === obj
+      } if obj.is_a?(DateTime)
 
       super
 

data/lib/icalPal.rb

@@ -88,14 +88,17 @@ module ICalPal
     obj['symbolic_color_name'] ||= type[:color]
   end
 
-  # Create a new CSV::Row with values from +self+.  Newlines are
-  # replaced with '\n' to ensure each Row is a single line of text.
+  # Create a new CSV::Row with values from +self+.  Control characters
+  # are escaped to ensure they are not interpreted by the terminal.
   #
   # @param headers [Array] Key names used as the header row in a CSV::Table
   # @return [CSV::Row] The +Store+, +Calendar+, +CalendarItem+, or
   # +Reminder+ as a CSV::Row
   def to_csv(headers)
-    values = headers.map { |h| (@self[h].respond_to?(:gsub))? @self[h].gsub("\n", '\n') : @self[h] }
+    values = headers.map do |h|
+      (@self[h].respond_to?(:gsub))?
+        @self[h].gsub(/([[:cntrl:]])/) { |c| c.dump[1..-2] } : @self[h]
+    end
 
     CSV::Row.new(headers, values)
   end

data/lib/options.rb

@@ -45,6 +45,10 @@ module ICalPal
       @op.on('%s%s %sPrint events occurring between present time and midnight' % pad('eventsRemaining'))
       @op.on('%s%s %sPrint tasks with a due date' % pad('datedTasks'))
       @op.on('%s%s %sPrint tasks with no due date' % pad('undatedTasks'))
+      @op.on('%s%s %sPrint uncompleted tasks due between the given dates' % pad('tasksDueBefore'))
+      @op.separator('')
+      @op.separator("#{@op.summary_indent}stores can be used instead of accounts")
+      @op.separator("#{@op.summary_indent}reminders can be used instead of tasks")
 
       # global
       @op.separator("\nGlobal options:\n\n")
@@ -78,6 +82,10 @@ module ICalPal
       @op.on('--il=LISTS', Array, 'List of reminder lists to include')
       @op.on('--el=LISTS', Array, 'List of reminder lists to exclude')
 
+      @op.separator('')
+      @op.on('--id', 'Include completed reminders')
+      @op.on('--ed', 'Exclude uncompleted reminders')
+
       @op.separator('')
       @op.on('--match=FIELD=REGEX', String, 'Include only items whose FIELD matches REGEX (ignoring case)')
 
@@ -273,9 +281,12 @@ module ICalPal
           .merge(env)
           .merge(cli)
 
-        # datedTasks and undatedTasks
-        opts[:cmd] = 'tasks' if opts[:cmd] == 'datedTasks'
-        opts[:cmd] = 'tasks' if opts[:cmd] == 'undatedTasks'
+        # Other tasks commands
+        if opts[:cmd] == 'tasksDueBefore'
+          opts.delete(:days) unless opts[:days]
+          opts[:from] = RDT.from_epoch(0) unless opts[:from]
+        end
+        opts[:cmd] = 'tasks' if %w[ datedTasks undatedTasks tasksDueBefore ].include? opts[:cmd]
 
         # Make sure opts[:db] and opts[:tasks] are Arrays
         opts[:db] = [ opts[:db] ] unless opts[:db].is_a?(Array)
@@ -326,6 +337,8 @@ module ICalPal
         raise(OptionParser::InvalidArgument, '--li cannot be negative') if opts[:li].negative?
         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?
+        raise(OptionParser::InvalidArgument, 'Cannot use remind output with tasks') if opts[:cmd] == 'tasks' &&
+          opts[:output] == 'remind'
 
       rescue StandardError => e
         @op.abort("#{e}\n\n#{@op.help}\n#{e}")
@@ -335,7 +348,7 @@ module ICalPal
     end
 
     # Commands that can be run
-    COMMANDS = %w[events eventsToday eventsNow eventsRemaining tasks datedTasks undatedTasks calendars accounts].freeze
+    COMMANDS = %w[events eventsToday eventsNow eventsRemaining tasks datedTasks undatedTasks tasksDueBefore calendars accounts].freeze
 
     # Supported output formats
     OUTFORMATS = %w[ansi csv default hash html json md rdoc remind toc xml yaml].freeze

data/lib/reminder.rb

@@ -1,8 +1,5 @@
 r 'timezone'
 
-# Images
-# Section
-
 module ICalPal
   # Class representing items from the <tt>Reminders</tt> database
   class Reminder
@@ -56,7 +53,7 @@ module ICalPal
       when 'name', 'reminder', 'task' # Aliases
         @self['title']
 
-      else @self[k]
+      else super
       end
     end
 
@@ -90,18 +87,16 @@ module ICalPal
 
       @self['long_priority'] = LONG_PRIORITY[@self['prio']] if @self['prio']
 
-      # For sorting
-      @self['sdate'] = (@self['title'])? @self['title'] : ''
-
       # Due date
       if @self['due_date']
         begin
+          @self['due_date'] += ITIME
           zone = Timezone.fetch(@self['timezone'])
         rescue Timezone::Error::InvalidZone
           zone = '+00:00'
         end
 
-        @self['due'] = RDT.from_time(Time.at(@self['due_date'] + ITIME, in: zone))
+        @self['due'] = RDT.from_time(Time.at(@self['due_date'], in: zone))
       end
 
       # Notes
@@ -165,12 +160,14 @@ r1.zContactHandles as messaging,
 r1.zDueDateDeltaAlertsData as alert,
 r1.zTimezone as timezone,
 r1.zckIdentifier as id,
+r1.zCompleted as completed,
 
 bl1.zBadgeEmblem as badge,
 bl1.zColor as color,
 bl1.zName as list_name,
 bl1.zParentList as parent,
 bl1.zSharingStatus as shared,
+bl1.zShouldCategorizeGroceryItems as grocery,
 
 -- section members
 json(bl1.ZMembershipsOfRemindersInSectionsAsData) -> '$.memberships' AS members,
@@ -236,8 +233,7 @@ FROM zremcdReminder r1
 
 LEFT OUTER JOIN zremcdBaseList bl1 ON r1.zList = bl1.z_pk
 
-WHERE r1.zCompleted = 0
-AND r1.zMarkedForDeletion = 0
+WHERE r1.zMarkedForDeletion = 0
 
 SQL
 

data/lib/version.rb

@@ -1,4 +1,4 @@
 module ICalPal
   NAME = 'icalPal'.freeze
-  VERSION = '3.8.3'.freeze
+  VERSION = '3.9.2'.freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: icalPal
 version: !ruby/object:Gem::Version
-  version: 3.8.3
+  version: 3.9.2
 platform: ruby
 authors:
 - Andy Rosen
 bindir: bin
 cert_chain: []
-date: 2025-08-08 00:00:00.000000000 Z
+date: 2025-08-23 00:00:00.000000000 Z
 dependencies: []
 description: |
   Inspired by icalBuddy and maintains close compatability.  Includes