icalPal 3.10.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 014f8b5179cd56cb757404df75a3d23145907d2f40b4186031ed5028ad5e92af
-  data.tar.gz: 8abe6a5c80c695fa61b0000ae20c52fcbd1fab29ab326fcb89fe1a4d469fae82
+  metadata.gz: b48ee501e87dc1c4c597bc9e45b6fd977668f107f942c857186de23245d22a4d
+  data.tar.gz: a4010b5cd6e901fc3d4a6eaa850c4b3303c97e0ca1075d868598ed8ab428b243
 SHA512:
-  metadata.gz: 24bafd17756e9e4ccce28dc0b23ea421d334f3d9c58f3fe62dd07cf26777b47c56587a52e61c5995a730b823a3ad2f0ebc8bef460205ebcde981df3e0bd35108
-  data.tar.gz: a21caa7650b168542625a176909e05e0f87825c452015e7292f5297aa8b9d96863dc22c1f921a197a97769c9b3fb5db0a593adf1b22784b1874e03ecb05a8b34
+  metadata.gz: 3f74dc669bd9b5352d12a5a40859cf1d2cab3cbbe3ed185223c5f8ec449af3115f415832191f6184ab76fe9ac74f0211ca80143d660440463f6a79080297ba54
+  data.tar.gz: afef75a278aa28007182a40ac9c1ed37369a5a72e0c3e8be92102160034b3f1ad013b879af0676e721cc8b0179de6c2ae28db023de657fb998fb73e53f06a54c

data/bin/icalPal

@@ -206,10 +206,10 @@ $rows.each do |row|
       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?)
+      next if $opts[:dated] == 'undatedTasks' && item['due_date'] && item['due_date'].positive?
+      next if $opts[:dated] == 'datedTasks' && (!item['due_date'] || item['due_date'].zero?)
 
-      if $opts[:dated] == 3
+      if $opts[:dated] == 'tasksDueBefore'
         next unless item['due_date']
         next unless item['due_date'].between?($opts[:from].to_i, $opts[:to].to_i)
       end

data/ext/extconf.rb

@@ -7,33 +7,18 @@ begin
   Gem.path.each { |p| gemdir = p if File.writable? p }
 
   # Dependencies common to all environments
-  dependencies = %w[ plist tzinfo ]
+  dependencies = %w[ plist ]
 
-  if RUBY_VERSION >= '3.4'
-    # bigdecimal is not part of the default gems starting from Ruby 3.4.0.
-    # csv is not part of the default gems starting from Ruby 3.4.0.
-    dependencies.push('bigdecimal')
+  # All dependencies are included with the installation of Ruby in
+  # macOS. Adding these dependencies anyway will cause errors that
+  # prevent icalPal from being installed.
+  unless RUBY_VERSION >= '2.6'
+    dependencies.push('logger')
     dependencies.push('csv')
-
-    # The macOS and Homebrew versions of rubygems have incompatible
-    # requirements for sqlite3.
-    #
-    # macOS 15.5 (Sequoia) comes with version 1.3.13, so it does not
-    # need to be added as a dependency, and 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 neither environment can install the other's sqlite3 gem.  We
-    # must install sqlite3, but iff we are not building with macOS'
-    # Ruby installation.
+    dependencies.push('json')
+    dependencies.push('rdoc')
     dependencies.push('sqlite3')
+    dependencies.push('yaml')
   end
 
   di = Gem::DependencyInstaller.new(install_dir: gemdir)

data/lib/ToICalPal.rb

@@ -97,7 +97,7 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
 
   # Add a blank line
   #
-  # @param *_arg [Array] Ignored
+  # @param _arg [Array] Ignored
   def accept_blank_line(*_arg)
     @res << "\n"
   end
@@ -109,7 +109,7 @@ class RDoc::Markup::ToICalPal < RDoc::Markup::Formatter
   # @option h [Integer] :level 2 for a property name
   # @option h [String] :text The header's text
   def accept_heading(h)
-    h.text = colorize(@item['symbolic_color_name'], @item['color'], h.text) if (h.level == 2) || COLOR_LABEL.any?(@prop)
+    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

data/lib/event.rb

@@ -95,8 +95,8 @@ module ICalPal
 
         # Save as seconds, Time, RDT
         ctime = obj[k] + ITIME
-        ctime -= Time.at(ctime).utc_offset if obj["#{k}_tz"] == '_float' && !zone
-        ttime = Time.at(ctime, in: zone)
+        ctime -= Time.at(ctime).utc_offset if obj["#{k.split('_')[0]}_tz"] == '_float' && !zone
+        ttime = (zone)? Time.at(ctime, in: zone) : Time.at(ctime)
 
         @self["#{k[0]}seconds"] = ctime
         @self["#{k[0]}ctime"] = ttime
@@ -265,7 +265,7 @@ module ICalPal
             c['edate'] = ICalPal.nth(nth, day, nedate)
           else
             %w[ sdate edate ].each do |d|
-              diff = day - c['sdate'].wday
+              diff = day - c[d].wday
               diff += 7 if diff.negative?
 
               t1 = Time.at(c[d].to_time)

data/lib/options.rb

@@ -275,15 +275,9 @@ module ICalPal
 
         # Handle tasks command variants
         if cli[:cmd] =~ /tasks/i
-          case cli[:cmd]
-          when 'undatedTasks'
-            cli[:dated] = 1
+          cli[:dated] = cli[:cmd]
 
-          when 'datedTasks'
-            cli[:dated] = 2
-
-          when 'tasksDueBefore'
-            cli[:dated] = 3
+          if cli[:dated] == 'tasksDueBefore'
             cli.delete(:days) unless cli[:days]
             cli[:from] = RDT.from_epoch(0) unless cli[:from]
             cli[:to] = $today unless cli[:to]
@@ -310,7 +304,7 @@ module ICalPal
         $log.level = opts[:debug]
 
         # For posterity
-        opts[:ruby] = RUBY_VERSION
+        opts[:ruby] = RUBY_DESCRIPTION
         opts[:version] = @op.version
 
         # From the Department of Redundancy Department

data/lib/rdt.rb

@@ -3,16 +3,28 @@ module ICalPal
   class RDT < DateTime
 
     # Create a new RDT from a Time object
+    #
+    # @param t [Time] The Time object
+    #
+    # @return [RDT] a new RDT
     def self.from_time(t)
-      new(*t.to_a[0..5].reverse, (t.gmt_offset / 3600).to_s)
+      new(*t.to_a[0..5].reverse, Rational((t.gmt_offset / 3600), 24))
     end
 
     # Create a new RDT from seconds since epoch
+    #
+    # @param s [Integer] Seconds since the Unix epoch (Thu Jan  1 00:00:00 UTC 1970)
+    #
+    # @return [RDT] a new RDT
     def self.from_epoch(s)
       from_time(Time.at(s))
     end
 
     # Create a new RDT from seconds since iCal epoch
+    #
+    # @param s [Integer] Seconds since the iCal epoch (Jan  1 00:00:00 UTC 2001)
+    #
+    # @return [RDT] a new RDT
     def self.from_itime(s)
       from_epoch(s + ITIME)
     end
@@ -25,15 +37,25 @@ module ICalPal
     # @return [RDT] a new RDT
     def self.conv(str)
       case str
-      when 'yesterday' then $today - 1
+      when 'yesterday' then $today.add(-1)
       when 'today' then $today
-      when 'tomorrow' then $today + 1
+      when 'tomorrow' then $today.add(1)
       when /^\+([0-9]+)/ then $today + Regexp.last_match(1).to_i
       when /^-([0-9]+)/ then $today - Regexp.last_match(1).to_i
       else parse(str)
       end
     end
 
+    # Add a number of days accounting for daylight saving time changes
+    #
+    # @param days [Integer] Number of days to add
+    # @return [RDT] A new RDT
+    def add(days)
+      n = self + days
+      t = Time.parse("#{n.year}-#{n.month}-#{n.day} #{n.hour}:#{n.min}:#{n.sec}")
+      RDT.from_time(t)
+    end
+
     # Values can be +day before yesterday+, +yesterday+,
     # +today+, +tomorrow+, +day after tomorrow+, or the result from
     # strftime
@@ -41,10 +63,10 @@ module ICalPal
     # @return [String] A string representation of self relative to
     #  today.
     def to_s
-      return strftime($opts[:df]) if $opts && $opts[:nrd] && $opts[:df]
+      return strftime($opts[:df]) if $opts && $opts[:df] && $opts[:nrd]
       return super unless $today && $opts
 
-      case Integer(RDT.new(*ymd, month, day) - $today)
+      case (self - $today).round
       when -2 then 'day before yesterday'
       when -1 then 'yesterday'
       when 0 then 'today'
@@ -68,13 +90,13 @@ module ICalPal
       to_time.to_i
     end
 
-    # @param [Integer] Optional UTC offset
+    # @param z [Integer] Optional UTC offset
     # @return [RDT] Self at 00:00:00
     def day_start(z = zone)
       RDT.new(year, month, day, 0, 0, 0, z)
     end
 
-    # @param [Integer] Optional UTC offset
+    # @param z [Integer] Optional UTC offset
     # @return [RDT] Self at 23:59:59
     def day_end(z = zone)
       RDT.new(year, month, day, 23, 59, 59, z)
@@ -90,9 +112,5 @@ module ICalPal
       [ hour, min, sec ]
     end
 
-    # @return [Array] Only the year, month and day of self
-    def ymd
-      [ year, month, day ]
-    end
   end
 end

data/lib/reminder.rb

@@ -1,5 +1,3 @@
-r 'tzinfo'
-
 module ICalPal
   # Class representing items from the <tt>Reminders</tt> database
   class Reminder
@@ -103,14 +101,9 @@ module ICalPal
 
       # Due date
       if @self['due_date']
-        begin
-          @self['due_date'] += ITIME
-          zone = TZInfo::Timezone.get(@self['timezone'])
-        rescue TZInfo::InvalidTimezoneIdentifier
-          zone = '+00:00'
-        end
-
-        @self['due'] = RDT.from_time(Time.at(@self['due_date'], in: zone))
+        @self['due_date'] += ITIME
+        @self['due_date'] -= obj['utc_offset'] if obj['utc_offset']
+        @self['due'] = RDT.from_time(Time.at(@self['due_date']))
       end
 
       # Notes
@@ -196,9 +189,9 @@ r1.zNotes as notes,
 r1.zPriority as priority,
 r1.zContactHandles as messaging,
 r1.zDueDateDeltaAlertsData as alert,
-r1.zTimezone as timezone,
 r1.zckIdentifier as id,
 r1.zCompleted as completed,
+r1.zDisplayDateUpdatedForSecondsFromGMT as utc_offset,
 
 bl1.zBadgeEmblem as badge,
 bl1.zColor as color,

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: icalPal
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Andy Rosen
@@ -22,7 +22,6 @@ extra_rdoc_files:
 files:
 - README.md
 - bin/icalPal
-- bin/icalpal
 - ext/extconf.rb
 - icalPal.gemspec
 - lib/EventKit.rb
@@ -62,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Command-line tool to query the macOS Calendar and Reminders
 test_files: []

data/bin/icalpal

@@ -1,363 +0,0 @@
-#!/usr/bin/env ruby
-
-# rubocop: disable Style/RedundantBegin
-
-# require a gem
-#
-# @param gem [String] The gem
-def r(gem)
-  begin
-    # puts "require \"#{gem}\""
-    require gem
-  rescue LoadError => e
-    $stderr.puts "FATAL: icalPal is missing a dependency: #{gem}"
-    $stderr.puts e
-    $stderr.puts
-    abort "Try installing with 'gem install #{gem}'"
-  end
-end
-
-# require_relative a library
-#
-# @param library [String] The library
-def rr(library)
-  begin
-    # puts "require_relative \"../lib/#{library}\""
-    require_relative "../lib/#{library}"
-  rescue LoadError => e
-    $stderr.puts "FATAL: Could not load library: #{library}"
-    $stderr.puts
-    abort e.message
-  end
-end
-
-# rubocop: enable Style/RedundantBegin
-
-%w[ logger csv json rdoc sqlite3 yaml ].each { |g| r g }
-%w[ icalPal defaults options utils ].each { |l| rr l }
-
-
-##################################################
-# 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
-  format("[%-5<sev>s] %<time>s [%<file>s:%<line>5s] - %<message>s\n",
-         {
-           sev: s,
-           time: t.strftime('%H:%M:%S.%L'),
-           file: caller(4, 1)[0].split('/')[-1].split(':')[0],
-           line: caller(4, 1)[0].split('/')[-1].split(':')[1],
-           message: m
-         })
-end
-
-$opts = ICalPal::Options.new.parse_options
-
-$rows = []                      # Rows from the database
-$sections = []                  # Calendar list sections
-$items = []                     # Items to be printed
-
-
-##################################################
-# All kids love log!
-
-$log.info("Options:\n#{$opts.to_json}")
-
-
-##################################################
-# Add an item to the list
-#
-# @param item[Object]
-
-def add(item)
-  $log.debug("Adding #{item.dump} #{item['UUID']} (#{item['title']})") if item['UUID']
-
-  $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
-    # Load all .sqlite files
-    $log.debug("Loading *.sqlite in #{db}")
-    Dir.glob("#{db}/*.sqlite").each do |d|
-      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}")
-    end
-  else
-    # Load database
-    rows = ICalPal.load_data(db, klass::QUERY)
-    $rows += rows
-
-    success = true
-
-    $log.info("Loaded #{rows.length} rows from #{db}")
-  end
-
-rescue Errno::EPERM
-  # Probably need Full Disk Access
-
-rescue SQLite3::CantOpenException
-  # Non-fatal exception, try the next one
-
-rescue StandardError => e
-  # Log the error and (try to) continue
-  $log.error("#{db}: #{e.message}")
-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.debug("Loaded #{$rows.length} #{klass} items")
-$log.info("Window is #{$opts[:from]} to #{$opts[:to]}") if $opts[:from]
-
-
-##################################################
-# Process the data
-
-# Add rows
-$rows.each do |row|
-  # --es/--is
-  next if $opts[:es].any? row['account']
-  next unless $opts[:is].empty? || ($opts[:is].any? row['account'])
-
-  # --ec/--ic
-  unless klass == ICalPal::Store || !row['calendar']
-    next if $opts[:ec].any? row['calendar']
-    next unless $opts[:ic].empty? || ($opts[:ic].any? row['calendar'])
-  end
-
-  # Instantiate an item
-  item = klass.new(row)
-
-  # --et/--it
-  next if $opts[:et].any? item['type']
-  next unless $opts[:it].empty? || ($opts[:it].any? item['type'])
-
-  # --el/--il
-  next if $opts[:el].any? item['list_name']
-  next unless $opts[:il].empty? || ($opts[:il].any? item['list_name'])
-
-  # --match
-  if $opts[:match]
-    r = $opts[:match].split('=')
-
-    if item[r[0]].to_s.respond_to?(:match)
-      next unless item[r[0]].to_s =~ Regexp.new(r[1], Regexp::IGNORECASE)
-    end
-  end
-
-  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?
-    next if item['status'] == :canceled
-
-    (item['has_recurrences'].positive?)?
-      item.recurring.each { |j| add(j) } :
-      item.non_recurring.each { |j| add(j) }
-  else
-    # 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)
-  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
-  $sort_attrs = []
-  $sort_attrs.push $opts[:sep] if $opts[:sep]
-  $sort_attrs.push $opts[:sort] if $opts[:sort]
-  $sort_attrs.push 'sdate'
-
-  $log.info("Sorting #{$items.count} items by #{$sort_attrs}, reverse #{$opts[:reverse].inspect}")
-
-  $items.sort!
-  $items.reverse! if $opts[:reverse]
-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'].gsub(/([[:cntrl:]])/) { |c| c.dump[1..-2] }}"
-         }.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?
-    if i[$opts[:sep]]
-      doc << RDoc::Markup::Heading.new(1, i[$opts[:sep]].to_s)
-      doc << RDoc::Markup::Rule.new(0)
-    end
-
-    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 value.is_a?(Array) && !value[0]
-    next if value.is_a?(String) && 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
-  end
-
-  # Print it
-  props << RDoc::Markup::BlankLine.new unless props.empty?
-
-  doc << props
-end
-
-print doc.accept(mu)