icalPal 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f91434d02dd357bcd02342b2d79418b91e23ec789a6a069a01f2f508685d8ca
-  data.tar.gz: 51cfa58c767650d0c7e62213ad4a58dbe9a2d5fc42f17d5ce18c8b65e6a178be
+  metadata.gz: 4dab143a05d8a63ae36b721ca6ba53180c75d8b4dd0f0cebdc84fb533968c248
+  data.tar.gz: 8d243a120762c90059e4206a2deb5e79b821e558cf9ad9a437ad84fbfbb6a21b
 SHA512:
-  metadata.gz: 20b4a10406535baf33986bd6bdf859376a6dfd7055815b2f263d6971d6e8255d5d60fa019c49c4de54ec3a4178e3752136478aafa5937176c80adfdfc36cc8aa
-  data.tar.gz: 8a5fbde979186c3347ed6c8c52f3b39b81fc6b303680e1923c0b011583b1c63651dc65b33e4e34a3794b5d01430cb7bd4dd66b2f12510374f13626e438aef079
+  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, or a Reminders database.
+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,7 +35,8 @@ 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*
@@ -184,27 +199,6 @@ Environment variables:
                             (default: /Users/ajr/.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*.
-
 ## Output formats
 
 icalPal supports several output formats.  The **default** format tries
@@ -242,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_relative '../lib/icalPal'
+  require_relative '../lib/options'
+rescue LoadError => e
+  dep = e.message[/-- (.*)/, 1]
 
-require 'csv'
-require 'json'
-require 'rdoc'
-require 'sqlite3'
-require 'yaml'
+  $stderr.puts "FATAL: icalPal is missing a dependency: #{dep}"
+  $stderr.puts
+  $stderr.puts "Install with 'gem install --user-install #{dep}'"
 
-require_relative '../lib/icalPal'
-require_relative '../lib/options'
+  exit
+end
 
 
 ##################################################

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

@@ -58,6 +58,9 @@ module ICalPal
     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}")
 
@@ -92,28 +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 do |k|
-      v = @self[k]
-
-      if v.respond_to?(:length) then
-        if v.length == 0 or v[0] == nil then
-          retval += "<#{k}/>"
-        else
-          # Keep non-blank and whitespace, except form feeds and vertical whitespace
-          v = v.gsub(/[^[[:print:]][[:space:]]]/, '.').gsub(/[\f\v]/, '.')
-          retval += "<#{k}>#{v}</#{k}>"
-        end
-      end
-    end
+    @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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icalPal
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Andy Rosen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-14 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -81,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