icalPal 4.2.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 363dff45c52135dcb0a151539ff513cc92f6ad086daacf8b7df141e52ca1aa1c
-  data.tar.gz: 0677a50a89478e2986d2f9cb896b6e970d647e50be60f65ca6a7f02458ca882e
+  metadata.gz: 261e842e93e9a86deda06bdbd1f365a574ef8022811138cc3659db1b48d322bc
+  data.tar.gz: 75c0f0726cea85b4fa1f1eb7e1638569acc80ec31d5380b2a92752dccdb59f63
 SHA512:
-  metadata.gz: 2562a1fd8f801c53efdc39a07b03a9506006e662732addb831070bfd0c02e56a3a5bd34aef940185f3878ea8af91295ac8d06e12822c3cc33fc06e61a1a71acb
-  data.tar.gz: 112c795e08d74e0a1b85506b14eef161b1c26682e6f1f77b1c2699f8f15d6cfb85d1a57f47b578c2561e90e99b984e3a8190d722486e19478b897f4e722b3169
+  metadata.gz: 1d2fcebc0aa063ebe0fa783d0e0a4ac0d05e51969fbd945cf9b724a47cd90029be25aafca590ef096b1b6af6eac03a78c9d0b199305d6dc8b2fe6cc9b7f41fc5
+  data.tar.gz: a2b98f4ad0a568cf5c2d6f31d277e13d7eb382c16886c612264767987e0ed08655c288e25f4ad6683b13497fb9cc1be9e262bdb034a71f513c5e61017a786d42

data/README.md

@@ -6,10 +6,7 @@
 
 ## Description
 
-icalPal is a command-line tool to query 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.
+icalPal is a command-line tool to query 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.
 
 <!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
 
@@ -52,10 +49,7 @@ brew install icalPal
 
 ### Compatability with icalBuddy
 
-icalPal tries to be compatible with
-[icalBuddy](https://github.com/ali-rantakari/icalBuddy) for
-command-line options and for output.  There are a some important
-differences to be aware of.
+icalPal tries to be compatible with [icalBuddy](https://github.com/ali-rantakari/icalBuddy) for command-line options 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*
@@ -71,8 +65,7 @@ icalPal also supports additional commands.
 
 ```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```
 
@@ -80,12 +73,9 @@ Shows only reminders that have a due date.
 
 ```icalPal reminders```
 
-*reminders*, *datedReminders*, *undatedReminders*, and
-*remindersDueBefore* 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 *events* commands.  Repeating reminders are treated the same
-as repeating events.
+Reminders can also be viewed in the *Scheduled Reminders* calendar, using the *events* commands.  Repeating reminders are treated the same as repeating events.
 
 ### Additional options
 
@@ -275,48 +265,22 @@ Environment variables:
 
 ## Output formats
 
-icalPal supports several output formats.  The **default** format tries
-to mimic icalBuddy as much as possible.
+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 into icalPal.
+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 into icalPal.
 
-Control characters are escaped in these formats to ensure they remain
-properly formatted.
+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.  See
-[RDoc](https://github.com/ajrosen/icalPal/blob/main/RDoc.md) for a
-breakdown of how icalPal uses RDoc::Markup.
+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.  See [RDoc](https://github.com/ajrosen/icalPal/blob/main/RDoc.md) for a breakdown of how icalPal uses RDoc::Markup.
 
 ## History
 
-I used icalBuddy for many years.  It's great for scripting,
-automation, and as a widget for apps like
-[Übersicht](https://tracesof.net/uebersicht/),
-[GeekTool](https://www.tynsoe.org/geektool/), and
-[SketchyBar](https://felixkratz.github.io/SketchyBar/).
-
-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](https://www.ruby-lang.org).  Using Ruby meant there is *much*
-less code; a little over 2,200 lines vs. 7,000.  It also means icalPal
-is multi-platform.
-
-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 and Tahoe (2.6.10) and
-[Homebrew](https://brew.sh/) (3.4.x).
-
-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*.
+I used icalBuddy for many years.  It's great for scripting, automation, and as a widget for apps like [Übersicht](https://tracesof.net/uebersicht/), [GeekTool](https://www.tynsoe.org/geektool/), and [SketchyBar](https://felixkratz.github.io/SketchyBar/).
+
+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](https://www.ruby-lang.org).  Using Ruby meant there is *much* less code; a little over 2,200 lines vs. 7,000.  It also means icalPal is multi-platform.
+
+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 and Tahoe (2.6.10) and [Homebrew](https://brew.sh/) (3.4.x).
+
+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

@@ -135,7 +135,9 @@ unless success
 
   $opts[:db].each do |db|
     # Use a real open to get a useful error
+    # rubocop: disable Style/FileOpen
     File.open(db).close
+    # rubocop: enable Style/FileOpen
   rescue Exception => e
     $log.fatal("#{e}: #{db}")
 
@@ -266,6 +268,7 @@ mu = case $opts[:output]
 
 items = $items[0..($opts[:li] - 1)]
 
+# Machine-friendly formats
 unless mu
   $log.debug("Output in #{$opts[:output]} format")
 
@@ -298,9 +301,9 @@ unless mu
   exit
 end
 
+# Human-readable formats
 $log.debug("Formatting with #{mu.inspect}")
 
-doc = RDoc::Markup::Document.new
 section = nil
 
 items.each_with_index do |i, j|
@@ -309,28 +312,30 @@ items.each_with_index do |i, j|
   # --li
   break if $opts[:li].positive? && j >= $opts[:li]
 
-  # Use RDoc::Markup::Verbatim to save the item
-  v = RDoc::Markup::Verbatim.new
-  v.format = i
-  doc << v
+  # Each item is a document
+  doc = RDoc::Markup::Document.new
 
   # Sections
   if $opts[:sep] && section != i[$opts[:sep]]
     $log.debug("New section '#{$opts[:sep]}': #{i[$opts[:sep]]}") if $log.level <= Logger::DEBUG
 
-    doc << RDoc::Markup::Raw.new($opts[:sep])
-
     doc << RDoc::Markup::BlankLine.new if j.positive?
-    if i[$opts[:sep]]
-      doc << RDoc::Markup::Heading.new(1, i[$opts[:sep]].to_s)
-      doc << RDoc::Markup::Rule.new(0)
-    end
+    doc << RDoc::Markup::Heading.new(1, "#{i[$opts[:sep]]}:")
+    doc << RDoc::Markup::Rule.new(0)
 
     section = i[$opts[:sep]]
   end
 
+  # Placeholder
+  if i['placeholder']
+    doc << RDoc::Markup::Raw.new(i['title'])
+    doc << RDoc::Markup::BlankLine.new
+    print doc.accept(mu)
+    next
+  end
+
   # Item
-  props = RDoc::Markup::List.new(:BULLET)
+  props = RDoc::Markup::List.new(:LABEL)
 
   # Properties
   $opts[:props].each_with_index do |prop, k|
@@ -342,22 +347,41 @@ items.each_with_index do |i, j|
 
     $log.debug("#{prop}: #{value}") if $log.level <= Logger::DEBUG
 
-    # Use Raw to save the property
-    props << RDoc::Markup::Raw.new(prop)
-
     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'])
+      props << RDoc::Markup::BlankLine.new unless $opts[:ps]
+
+      v = ((value.is_a?(Enumerable))? value.join('; ') : value)
+      v = mu.colorize(*mu.DATE_COLOR, v) if prop == 'datetime' && mu.respond_to?('colorize')
+
+      props << RDoc::Markup::ListItem.new(prop, RDoc::Markup::Paragraph.new(v))
     else
-      # First property, value only
+      # Choose bullet
+      if mu.is_a?(RDoc::Markup::ToICalPal) && !$opts[:nb]
+        bullet = (i['due_date'] && i['due_date'].between?(0, $nowto_i))? $opts[:ab] : $opts[:bullet]
+        props << RDoc::Markup::Raw.new("#{bullet} ")
+      end
+
+      # Maybe colorize label
+      mu.is_a?(RDoc::Markup::ToICalPal) &&
+        mu.COLOR_LABEL.any?(prop) &&
+        value = mu.colorize(i['symbolic_color_name'], i['color'], value)
+
+      # Maybe add calendar to title
+      prop == 'title' &&
+        i['calendar'] &&
+        mu.respond_to?('bold') &&
+        !$opts[:nc] &&
+        value += mu.bold(" (#{i['calendar']})")
+
       props << RDoc::Markup::Heading.new(2, value.to_s)
     end
   end
 
   # Print it
-  props << RDoc::Markup::BlankLine.new unless props.empty?
+  unless props.empty?
+    doc << props
+    doc << RDoc::Markup::BlankLine.new
+  end
 
-  doc << props
+  print doc.accept(mu)
 end
-
-print doc.accept(mu)

data/ext/extconf.rb

@@ -1,34 +1,19 @@
 begin
-  require 'mkmf'
   require 'rubygems/dependency_installer'
 
-  # Search Gem paths for one that is writable.
-  gemdir = nil
-  Gem.path.each { |p| gemdir = p if File.writable? p }
+  # Install dependencies that are not already installed
+  stubs = Gem::Specification.stubs.map(&:name)
 
-  # Dependencies common to all environments
-  dependencies = %w[ plist ]
+  dependencies = %w[ plist logger csv json open3 rdoc sqlite3 yaml ]
+  dependencies.reject! { |d| stubs.include?(d) }
 
-  # All other dependencies are included with the installation of Ruby
-  # in macOS. Adding these dependencies anyway will cause errors that
-  # prevent icalPal from being installed, so we need to be more
-  # granular.
-  if RUBY_VERSION >= '3.0'
-    dependencies.push('logger')
-    dependencies.push('csv')
-    dependencies.push('json')
-    dependencies.push('rdoc')
-    dependencies.push('sqlite3')
-    dependencies.push('yaml')
+  unless dependencies.empty?
+    di = Gem::DependencyInstaller.new
+    dependencies.each { |d| di.install(d) }
   end
 
-  di = Gem::DependencyInstaller.new(install_dir: gemdir)
-  dependencies.each { |d| di.install(d) }
-
 rescue Exception => e
   abort(e)
 end
 
-File.write('Makefile', "clean:\n\ttrue\ninstall:\n\ttrue")
-
 exit(0)

data/icalPal.gemspec

@@ -33,7 +33,7 @@ EOF
 
   s.post_install_message = <<-EOF
 
-Note: #{ICalPal::NAME} requires "Full Disk Access" in System Settings to access your calendar.
+Note: #{ICalPal::NAME} requires "Full Disk Access" in System Settings to access your calendar and reminders.
 Make sure the program that runs #{ICalPal::NAME}, not #{ICalPal::NAME} itself, has these permissions.
 
 EOF

data/lib/ToICalPal.rb

@@ -1,3 +1,5 @@
+require 'rdoc'
+
 ##################################################
 # Render an RDoc::Markup::Document, closely mimicking
 # icalBuddy[https://github.com/ali-rantakari/icalBuddy]
@@ -45,19 +47,11 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
   # Color for datetime value
   DATE_COLOR = [ 'yellow', '#ffff00' ].freeze
 
-  # @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
-  # @option opts [Array<String>] :ps List of property separators
-  # @option opts [String] :ss Section separator
-  def initialize(opts)
-    super
-    @opts = opts
-  end
+  # Accessors for constants
+  def NO_LABEL() NO_LABEL end
+  def COLOR_LABEL() COLOR_LABEL end
+  def LABEL_COLOR() LABEL_COLOR end
+  def DATE_COLOR() DATE_COLOR end
 
   # Start a new document
   def start_accepting
@@ -70,29 +64,20 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
     @res.join
   end
 
-  # Add a bullet for the first property of an item
+  # Add a list
   #
   # @param _arg [Array] Ignored
-  def accept_list_start(_arg)
-    return if @opts[:nb] || @item['placeholder']
-
-    if @item['due_date'] && (@item['due_date']).between?(0, $nowto_i)
-      # Use alert bullet for overdue items
-      @res << "#{@opts[:ab]} "
-    else
-      @res << "#{@opts[:bullet]} "
-    end
-  end
+  def accept_list_start(_arg) end
 
   # Add a property name
   #
   # @param arg [RDoc::Markup::ListItem]
   # @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 << (@options[:ps][@ps] || '    ')
+    @res << colorize(*LABEL_COLOR, arg.label) << ': ' unless @options[:npn] || NO_LABEL.any?(arg.label)
 
-    @ps += 1 unless @ps == @opts[:ps].count - 1
+    @ps += 1 unless @ps == @options[:ps].count - 1
   end
 
   # Add a blank line
@@ -102,65 +87,38 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
     @res << "\n"
   end
 
-  # Add either a section header or the first property of an item
-  #
-  # @param h [RDoc::Markup::Heading]
-  # @option h [Integer] :level 1 for a section header
-  # @option h [Integer] :level 2 for a property name
-  # @option h [String] :text The header's text
+  # Add a heading
   def accept_heading(h)
-    h = RDoc::Markup::Heading.new(h.level, colorize(@item['symbolic_color_name'], @item['color'], h.text)) if (h.level == 2) || COLOR_LABEL.any?(@prop)
     @res << h.text
-
-    case h.level
-    when 1
-      @res << ':'
-    when 2
-      if @prop == 'title' && @item['calendar']
-        @res << bold(" (#{@item['calendar']})") unless @opts[:nc] || @item['title'] == @item['calendar']
-      end
-    end
   end
 
-  # Add the property value
+  # Add a paragraph
   #
   # @param p [RDoc::Markup::Paragraph]
   # @option p [Array<String>] :parts The property's text
   def accept_paragraph(p)
-    t = p.parts.join('; ').gsub("\n", "\n    ")
-    t = colorize(*DATE_COLOR, t) if @prop == 'datetime'
-    @res << t
+    @res << p.parts.join('; ').gsub("\n", "\n    ")
   end
 
-  # Add a section separator
+  # Add a section separator and a blank line
   #
   # @param _weight Ignored
   def accept_rule(_weight)
-    @res << @opts[:ss]
+    @res << @options[:ss]
     accept_blank_line
   end
 
-  # 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
+  # Add raw text
   #
   # @param arg [RDoc::Markup::Raw]
-  # @option arg [Object] :parts The property
   def accept_raw(arg)
-    @prop = arg.parts[0]
+    @res << arg.parts
   end
 
   # @param str [String]
   # @return [String] str with increased intensity[#BOLD]
   def bold(str)
-    return str unless @opts[:palette]
+    return str unless @options[:palette]
 
     BOLD + str + NORM
   end
@@ -169,9 +127,9 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
   # @param c24 [String] Color used for \--color
   # @return [String] str in color, depending on opts[#]
   def colorize(c8, c24, str)
-    return str unless c8 && c24 && @opts[:palette]
+    return str unless c8 && c24 && @options[:palette]
 
-    case @opts[:palette]
+    case @options[:palette]
     when 8                      # Default colour table
       c = ANSI[c8.downcase.to_sym]
       c ||= ANSI[c24[0..6].downcase.to_sym]

data/lib/event.rb

@@ -45,7 +45,7 @@ module ICalPal
         EventKit::EKScheduledReminderFlag[@self['flags']] if @self['calendar'] == 'Scheduled Reminders'
 
       when 'location'           # location[ address]
-        (@self['location'])? [ @self['location'], @self['address'] ].join(' ').chop : nil
+        [ @self['location'], @self['address'] ].uniq.join(' ').chop if @self['location']
 
       when 'notes'              # \n -> :nnr
         (@self['notes'])? @self['notes'].strip.gsub("\n", $opts[:nnr]) : nil
@@ -75,11 +75,11 @@ module ICalPal
     def initialize(obj)
       # Placeholder for days with no events
       return @self = {
-        $opts[:sep] => obj,
-        'sdate' => obj,
-        'placeholder' => true,
-        'title' => 'Nothing.',
-      } if $opts[:sed] && obj.is_a?(DateTime)
+               $opts[:sep] => obj,
+               'sdate' => obj,
+               'placeholder' => true,
+               'title' => 'Nothing.',
+             } if $opts[:sed] && obj.is_a?(DateTime)
 
       super
 

data/lib/icalPal.rb

@@ -124,6 +124,8 @@ module ICalPal
     end
   end
 
+  # @!group Contants
+
   # Epoch + 31 years (Mon Jan  1 00:00:00 UTC 2001)
   ITIME = 978_307_200
 
@@ -132,6 +134,8 @@ module ICalPal
   # <tt><i>SU, MO, TU, WE, TH, FR, SA</i></tt>
   DOW = { SU: 0, MO: 1, TU: 2, WE: 3, TH: 4, FR: 5, SA: 6 }.freeze
 
+  # #!endgroup
+
   # @!group Accessors
   def [](k)
     @self[k]

data/lib/utils.rb

@@ -51,7 +51,7 @@ end
 
 # Get the application icalPal is most likely running in
 #
-# @return [Integer] The basename of the program whose parent process id is 1 (launchd)
+# @return [String] The basename of the program whose parent process id is 1 (launchd)
 def ancestor
   ppid = Process.ppid
 

data/lib/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: icalPal
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.1
 platform: ruby
 authors:
 - Andy Rosen
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |
   Inspired by icalBuddy and maintains close compatability.  Includes
@@ -45,7 +44,7 @@ metadata:
   rubygems_mfa_required: 'true'
 post_install_message: |2+
 
-  Note: icalPal requires "Full Disk Access" in System Settings to access your calendar.
+  Note: icalPal requires "Full Disk Access" in System Settings to access your calendar and reminders.
   Make sure the program that runs icalPal, not icalPal itself, has these permissions.
 
 rdoc_options: []
@@ -62,8 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Command-line tool to query the macOS Calendar and Reminders
 test_files: []