icalPal 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc2cfd940c507b46cafd9c893beb25c47c82850ba7c1e02aaffcb6bc76eda208
-  data.tar.gz: e28610d838feaf2c05b41badd96bad57185501529cd73c7f0b7f5889290a59ef
+  metadata.gz: fd12b179a212d0582bd2740c8697f994f75d71fab58ab9ca28c8330e59e33b08
+  data.tar.gz: ab00df9c7f7b5fce00f8a247f346f5049f019d5336973eaec5e17d1970e773da
 SHA512:
-  metadata.gz: 2cdd430f7a66418a87cccf5c037f24d0e4fe39e594db5b951ea004c13eadafd15f398bfc0beac8b5fe4c987664a1ee56d9e113354a438e06cf2fe9c3d88c3304
-  data.tar.gz: ee2276cb96b75d93727bc9dcf4595cd8bef64ccd0893e4e3647f0c5a74d559cddf86434bf0a392176e3a05f7339d8b9651347e5c6098c45467aaf8c163349b62
+  metadata.gz: 5b2a5690bcf64c79fff82138dfeb27063dcc79d65ca29082e387cc396c7787d8beeec4beaf5ab56492bfb1739e1dcabfb2012ebceb34b899b90a118a8cf522b5
+  data.tar.gz: d65423b35e47f5287cb44406f618d8cb90825163d1d416e3dc2b1921483fa67ad6e62873c692fd25173a1485d8507a4f70c276a66e2a626cf0d4573e1e5571c8

data/bin/icalPal

@@ -11,6 +11,7 @@ begin
 
   require_relative '../lib/icalpal'
   require_relative '../lib/options'
+  require_relative '../lib/utils'
 rescue LoadError => e
   dep = e.message[/-- (.*)/, 1]
 
@@ -101,7 +102,27 @@ end
 # Make sure we opened at least one database
 unless success
   $log.fatal('Could not open database')
-  $opts[:db].each { |db| $log.fatal("Tried #{db}") }
+
+  # SQLite3 does not return useful error messages.  If any databases
+  # failed because of EPERM (operation not permitted), our parent
+  # process might need Full Disk Access, and we should suggest that.
+  eperm = 0
+
+  $opts[:db].each do |db|
+    # Use a real open to get a useful error
+    File.open(db).close
+  rescue Exception => e
+    $log.fatal("#{e.class}: #{db}")
+
+    eperm = 1 if e.instance_of?(Errno::EPERM)
+  end
+
+  if eperm.positive?
+    $stderr.puts
+    $stderr.puts "Does #{ancestor} have Full Disk Access in System Settings?"
+    $stderr.puts
+    $stderr.puts "Try running: open 'x-apple.systempreferences:com.apple.preference.security?Privacy_AllFiles'"
+  end
 
   abort
 end

data/bin/icalpal

@@ -0,0 +1,382 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'logger'
+
+  require 'csv'
+  require 'json'
+  require 'rdoc'
+  require 'sqlite3'
+  require 'yaml'
+
+  require_relative '../lib/icalpal'
+  require_relative '../lib/options'
+  require_relative '../lib/utils'
+rescue LoadError => e
+  dep = e.message[/-- (.*)/, 1]
+
+  $stderr.puts "FATAL: icalpal is missing a dependency: #{dep}"
+  $stderr.puts
+  $stderr.puts "Install with 'gem install --user-install #{dep}'"
+
+  exit
+end
+
+
+##################################################
+# Load options
+
+# All kids love log!
+$log = Logger.new(STDERR, { level: $defaults[:common][:debug] })
+$log.formatter = proc do |s, t, _p, m| # Severity, time, progname, msg
+  ($log.level.positive?)? "#{s}: #{m}\n" :
+    format("[%-5<sev>s] %<time>s [%<caller>s] - %<message>s\n",
+           {
+             sev: s,
+             time: t.strftime('%H:%M:%S.%L'),
+             caller: caller(4, 1)[0].split('/')[-1],
+             message: m
+           })
+end
+
+$opts = ICalPal::Options.new.parse_options
+
+$rows = []                      # Rows from the database
+$items = []                     # Items to be printed
+
+
+##################################################
+# All kids love log!
+
+$log.info("Options: #{$opts}")
+
+
+##################################################
+# Add an item to the list
+#
+# @param item[Object]
+
+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 ICalPal::Event === item && item['sdate']
+  $items.push(item)
+end
+
+
+##################################################
+# Load the data
+
+# What are we getting?
+klass = ICalPal.call($opts[:cmd])
+success = false
+
+# Get it
+$opts[:db].each do |db|
+  $log.debug("Trying #{db}")
+
+  if klass == ICalPal::Reminder
+    begin
+      # 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
+
+      rescue SQLite3::CantOpenException
+        # Non-fatal exception, try the next one
+      end
+    end
+  else
+    # Load database
+    begin
+      $rows += ICalPal.load_data(db, klass::QUERY)
+      success = true
+
+    rescue SQLite3::CantOpenException
+      # Non-fatal exception, try the next one
+    end
+  end
+end
+
+# Make sure we opened at least one database
+unless success
+  $log.fatal('Could not open database')
+
+  # SQLite3 does not return useful error messages.  If any databases
+  # failed because of EPERM (operation not permitted), our parent
+  # process might need Full Disk Access, and we should suggest that.
+  eperm = 0
+
+  $opts[:db].each do |db|
+    # Use a real open to get a useful error
+    File.open(db).close
+  rescue Exception => e
+    $log.fatal("#{e.class}: #{db}")
+
+    eperm = 1 if e.instance_of?(Errno::EPERM)
+  end
+
+  if eperm.positive?
+    $stderr.puts
+    $stderr.puts "Does #{ancestor} have Full Disk Access in System Settings?"
+    $stderr.puts
+    $stderr.puts "Try running: open 'x-apple.systempreferences:com.apple.preference.security?Privacy_AllFiles'"
+  end
+
+  abort
+end
+
+$log.info("Loaded #{$rows.count} #{klass} rows")
+
+
+##################################################
+# Process the data
+
+# Add rows
+$rows.each_with_index do |row, i|
+  $log.debug("Row #{i}: #{row['ROWID']}:#{row['UUID']} - #{row['account']}/#{row['calendar']}/#{row['title']}")
+
+  # --es/--is
+  if $opts[:es].any? row['account']
+    $log.debug(':es')
+    next
+  end
+
+  unless $opts[:is].empty? || ($opts[:is].any? row['account'])
+    $log.debug(':is')
+    next
+  end
+
+  # --ec/--ic
+  unless klass == ICalPal::Store || !row['calendar']
+    if $opts[:ec].any? row['calendar']
+      $log.debug(':ec')
+      next
+    end
+
+    unless $opts[:ic].empty? || ($opts[:ic].any? row['calendar'])
+      $log.debug(':ic')
+      next
+    end
+  end
+
+  # Instantiate an item
+  item = klass.new(row)
+
+  # --et/--it
+  if $opts[:et].any? item['type']
+    $log.debug(':et')
+    next
+  end
+
+  unless $opts[:it].empty? || ($opts[:it].any? item['type'])
+    $log.debug(':it')
+    next
+  end
+
+  # --el/--il
+  if $opts[:el].any? item['list_name']
+    $log.debug(':el')
+    next
+  end
+
+  unless $opts[:il].empty? || ($opts[:il].any? item['list_name'])
+    $log.debug(':il')
+    next
+  end
+
+  # --match
+  if $opts[:match]
+    r = $opts[:match].split('=')
+
+    if item[r[0]].to_s.respond_to?(:match)
+      unless item[r[0]].to_s.match(Regexp.new(r[1].to_s, Regexp::IGNORECASE))
+        $log.debug(':match')
+        next
+      end
+    end
+  end
+
+  if ICalPal::Event === item
+    # Check for all-day and cancelled events
+    if $opts[:ea] && item['all_day'].positive?
+      $log.debug(':ea')
+      next
+    end
+
+    if $opts[:ia] && !item['all_day'].positive?
+      $log.debug(':ia')
+      next
+    end
+
+    if item['status'] == :canceled
+      $log.debug(':canceled')
+      next
+    end
+
+    (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
+      if $opts[:dated] == 1 && item['due_date'].positive?
+        $log.debug(':undated')
+        next
+      end
+
+      if $opts[:dated] == 2 && item['due_date'].zero?
+        $log.debug(':dated')
+        next
+      end
+    end
+
+    add(item)
+  end
+end
+
+# Add placeholders for empty days
+if $opts[:sed] && $opts[:sd] && klass == ICalPal::Event
+  days = $items.collect { |i| i['sday'] }.uniq.sort
+
+  $opts[:days].times do |n|
+    day = $opts[:from] + n
+    $items.push(klass.new(day)) unless days.any? { |i| i.to_s == day.to_s }
+  end
+end
+
+# Sort the rows
+begin
+  $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 Exception => e
+  $log.info("Sorting failed: #{e}\n")
+end
+
+$log.debug("#{$items.count} items remain")
+
+# Configure formatting
+mu = case $opts[:output]
+     when 'ansi' then RDoc::Markup::ToAnsi.new
+     when 'default' then RDoc::Markup::ToICalPal.new($opts)
+     when 'html'
+       rdoc = RDoc::Options.new
+       rdoc.pipe = true
+       rdoc.output_decoration = false
+       RDoc::Markup::ToHtml.new(rdoc)
+     when 'md' then RDoc::Markup::ToMarkdown.new
+     when 'rdoc' then RDoc::Markup::ToRdoc.new
+     when 'toc' then RDoc::Markup::ToTableOfContents.new
+     end
+
+
+##################################################
+# Print the data
+
+items = $items[0..$opts[:li] - 1]
+
+unless mu
+  $log.debug("Output in #{$opts[:output]} format")
+
+  puts case $opts[:output]
+       when 'csv'
+         # Get all headers
+         headers = []
+         items.each { |i| headers += i.keys }
+         headers.uniq!
+
+         # Populate a CSV::Table
+         table = CSV::Table.new([], headers: headers)
+         items.each { |i| table << i.to_csv(headers) }
+
+         table
+       when 'hash' then items.map { |i| i.self }
+       when 'json' then items.map { |i| i.self }.to_json
+       when 'xml'
+         xml = items.map { |i| "<#{$opts[:cmd].chomp('s')}>#{i.to_xml}</#{$opts[:cmd].chomp('s')}>" }
+         "<#{$opts[:cmd]}>\n#{xml.join('')}</#{$opts[:cmd]}>"
+       when 'yaml' then items.map { |i| i.self }.to_yaml
+       when 'remind' then items.map { |i|
+           "REM #{i['sdate'].strftime('%F AT %R')} " +
+             "DURATION #{((i['edate'] - i['sdate']).to_f * 1440).to_i} " +
+             "MSG #{i['title']}"
+         }.join("\n")
+       else abort "No formatter for #{$opts[:output]}"
+       end
+
+  exit
+end
+
+$log.debug("Formatting with #{mu.inspect}")
+
+doc = RDoc::Markup::Document.new
+section = nil
+
+items.each_with_index do |i, j|
+  $log.debug("Print #{j}: #{i.inspect}")
+
+  # --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
+
+  # Sections
+  if $opts[:sep] && section != i[$opts[:sep]]
+    $log.debug("New section '#{$opts[:sep]}': #{i[$opts[:sep]]}")
+
+    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)
+    doc << RDoc::Markup::Rule.new(0)
+
+    section = i[$opts[:sep]]
+  end
+
+  # Item
+  props = RDoc::Markup::List.new(:BULLET)
+
+  # Properties
+  $opts[:props].each_with_index do |prop, k|
+    value = i[prop]
+
+    next unless value
+    next if Array === value && !value[0]
+    next if String === value && value.empty?
+
+    $log.debug("#{prop}: #{value}")
+
+    # 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'])
+    else
+      # First property, value only
+      props << RDoc::Markup::Heading.new(2, value.to_s)
+    end
+
+    # unless k.positive?
+    #   # First property, value only
+    #   props << RDoc::Markup::Heading.new(2, value.to_s)
+    # else
+    #   props << RDoc::Markup::BlankLine.new unless (i['placeholder'] || $opts[:ps])
+    #   props << RDoc::Markup::ListItem.new(prop, RDoc::Markup::Paragraph.new(value)) unless (i['placeholder'])
+    # end
+  end
+
+  # Print it
+  props << RDoc::Markup::BlankLine.new unless props.empty?
+
+  doc << props
+end
+
+print doc.accept(mu)

data/icalPal.gemspec

@@ -15,13 +15,41 @@ EOF
   s.homepage	= "https://github.com/ajrosen/#{s.name}"
   s.licenses	= [ 'GPL-3.0-or-later' ]
 
+  s.metadata = {
+    'bug_tracker_uri' => "https://github.com/ajrosen/#{s.name}/issues"
+  }
+
   s.files	= Dir["#{s.name}.gemspec", 'bin/*', 'lib/*.rb']
   s.executables	= [ "#{s.name}" ]
   s.extra_rdoc_files = [ 'README.md' ]
 
-  s.add_runtime_dependency 'nokogiri-plist', '~> 0.5.0'
-  s.add_runtime_dependency 'sqlite3', '~> 2'
+  s.add_dependency 'nokogiri-plist', '~> 0.5.0'
+  s.add_dependency 'sqlite3', '~> 2.6.0' unless s.rubygems_version == `/usr/bin/gem --version`.strip
+
+  # The macOS and Homebrew versions of rubygems have incompatible
+  # requirements for sqlite3.
+  # 
+  # macOS comes with version 1.3.13, so it does not need to be added
+  # as a dependency, but it cannot install anything newer:
+  # 
+  # requires Ruby version >= 3.0, < 3.4.dev. The current ruby version is 2.6.10.
+  # 
+  # Homebrew's Ruby formula does not come with sqlite3, so it does
+  # need to be added as a dependency, but it cannot install version
+  # 1.3.13:
+  # 
+  # error: call to undeclared function
+  # 
+  # So we must call add_dependency, but iff we are not building with
+  # macOS' Ruby installation.
 
   s.bindir = 'bin'
   s.required_ruby_version = '>= 2.6.0'
+
+  s.post_install_message = <<-EOF
+
+Note: #{ICalPal::NAME} requires "Full Disk Access" in System Settings to access your calendar.
+Make sure the program that runs #{ICalPal::NAME}, not #{ICalPal::NAME} itself, has these permissions.
+
+EOF
 end

data/lib/defaults.rb

@@ -73,6 +73,7 @@ $defaults = {
     n: false,
     nnr: "\n       ",
     nrd: false,
+    now: false,
     ps: [ "\n    " ],
     sa: false,
     sed: false,

data/lib/event.rb

@@ -130,7 +130,7 @@ module ICalPal
         $log.debug("multi-day event #{i + 1}") if (i.positive?)
 
         self['daynum'] = i + 1
-        events.push(clone) if in_window?(self['sdate'])
+        events.push(clone) if in_window?(self['sdate'], self['edate'])
 
         self['sdate'] += 1
         self['edate'] += 1
@@ -287,8 +287,8 @@ module ICalPal
     # @param s [RDT] Event start
     # @param e [RDT] Event end
     # @return [Boolean]
-    def in_window?(s, e = s)
-      if $opts[:n]
+    def in_window?(s, e)
+      if $opts[:now]
         if ($now >= s && $now < e)
           $log.debug("now: #{s} to #{e} vs. #{$now}")
           true

data/lib/icalPal.rb

@@ -110,38 +110,6 @@ module ICalPal
     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 "<#{key}/>"
-
-    # String, Integer
-    when String then "<#{key}>#{value}</#{key}>"
-    when Integer then "<#{key}>#{value}</#{key}>"
-
-    # Array
-    when Array
-      # Treat empty arrays as nil values
-      xmlify(key, nil) if value[0].nil?
-
-      retval = ''
-      value.each { |x| retval += xmlify("#{key}0", x) }
-      "<#{key}>#{retval}</#{key}>"
-
-    # RDT
-    when ICalPal::RDT then "<#{key}>#{value}</#{key}>"
-
-    # Unknown
-    else "<#{key}>#{value}</#{key}>"
-    end
-  end
-
   # Get the +n+'th +dow+ in month +m+
   #
   # @param n [Integer] Integer between -4 and +4

data/lib/options.rb

@@ -197,7 +197,7 @@ module ICalPal
 
         # Parse eventsNow and eventsToday commands
         cli[:cmd].match('events(Now|Today)(\+[0-9]+)?') do |m|
-          cli[:n] = true if m[1] == 'Now'
+          cli[:now] = true if m[1] == 'Now'
           cli[:days] = (m[1] == 'Today')? m[2].to_i + 1 : 1
 
           cli[:from] = $today

data/lib/utils.rb

@@ -0,0 +1,45 @@
+# 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 "<#{key}/>"
+
+    # String, Integer
+  when String then "<#{key}>#{value}</#{key}>"
+  when Integer then "<#{key}>#{value}</#{key}>"
+
+    # Array
+  when Array
+    # Treat empty arrays as nil values
+    xmlify(key, nil) if value[0].nil?
+
+    retval = ''
+    value.each { |x| retval += xmlify("#{key}0", x) }
+    "<#{key}>#{retval}</#{key}>"
+
+    # RDT
+  when ICalPal::RDT then "<#{key}>#{value}</#{key}>"
+
+    # Unknown
+  else "<#{key}>#{value}</#{key}>"
+  end
+end
+
+# Get the application icalPal is most likely running in
+#
+# @return [Integer] The basename of the program whose parent process id is 1 (launchd)
+def ancestor
+  ppid = Process.ppid
+
+  while (ppid != 1)
+    ps = `ps -p #{ppid} -o ppid,command | tail -1`
+    ppid = ps[/^[0-9 ]+ /].to_i
+  end
+
+  ps[ps.rindex('/') + 1..].chop
+end

data/lib/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: icalPal
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Andy Rosen
 bindir: bin
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri-plist
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.6.0
 description: |
   Inspired by icalBuddy and maintains close compatability.  Includes
   many additional features for querying, filtering, and formatting.
@@ -49,6 +49,7 @@ extra_rdoc_files:
 files:
 - README.md
 - bin/icalPal
+- bin/icalpal
 - icalPal.gemspec
 - lib/EventKit.rb
 - lib/ToICalPal.rb
@@ -60,11 +61,18 @@ files:
 - lib/rdt.rb
 - lib/reminder.rb
 - lib/store.rb
+- lib/utils.rb
 - lib/version.rb
 homepage: https://github.com/ajrosen/icalPal
 licenses:
 - GPL-3.0-or-later
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/ajrosen/icalPal/issues
+post_install_message: |2+
+
+  Note: icalPal requires "Full Disk Access" in System Settings to access your calendar.
+  Make sure the program that runs icalPal, not icalPal itself, has these permissions.
+
 rdoc_options: []
 require_paths:
 - lib
@@ -79,7 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Command-line tool to query the macOS Calendar
 test_files: []
+...