icalPal 3.3.0 → 3.5.0

data/lib/options.rb

@@ -1,8 +1,7 @@
 # rubocop: disable Style/FormatString, Style/FormatStringToken
 
-require 'optparse'
+autoload(:OptionParser, 'optparse')
 
-require_relative 'defaults'
 require_relative 'version'
 
 module ICalPal
@@ -27,9 +26,9 @@ module ICalPal
       @op = OptionParser.new
       @op.summary_width = 23
       @op.banner += ' [-c] COMMAND'
-      @op.version = ICalPal::VERSION
+      @op.version = VERSION
 
-      @op.accept(ICalPal::RDT) { |s| ICalPal::RDT.conv(s) }
+      @op.accept(RDT) { |s| RDT.conv(s) }
 
       # head
       @op.on_head("\nCOMMAND must be one of the following:\n\n")
@@ -55,6 +54,7 @@ module ICalPal
              'For the tasks commands this should be a directory containing .sqlite files',
              "(default: #{$defaults[:tasks][:db]})")
       @op.on('--cf=FILE', "Set config file path (default: #{$defaults[:common][:cf]})")
+      @op.on('--norc', 'Ignore ICALPAL and ICALPAL_CONFIG environment variables')
       @op.on('-o', '--output=FORMAT', OUTFORMATS,
              "Print as FORMAT (default: #{$defaults[:common][:output]})", "[#{OUTFORMATS.join(', ')}]")
 
@@ -83,8 +83,8 @@ module ICalPal
       # dates
       @op.separator("\nChoosing dates:\n\n")
 
-      @op.on('--from=DATE', ICalPal::RDT, 'List events starting on or after DATE')
-      @op.on('--to=DATE', ICalPal::RDT, 'List events starting on or before DATE',
+      @op.on('--from=DATE', RDT, 'List events starting on or after DATE')
+      @op.on('--to=DATE', RDT, 'List events starting on or before DATE',
              'DATE can be yesterday, today, tomorrow, +N, -N, or anything accepted by DateTime.parse()',
              'See https://ruby-doc.org/stdlib-2.6.1/libdoc/date/rdoc/DateTime.html#method-c-parse')
       @op.separator('')
@@ -172,6 +172,14 @@ module ICalPal
       @op.on_tail('%s%s %sAdditional arguments' % pad('ICALPAL'))
       @op.on_tail('%s%s %sAdditional arguments from a file' % pad('ICALPAL_CONFIG'))
       @op.on_tail("%s%s %s(default: #{$defaults[:common][:cf]})" % pad(''))
+
+      @op.on_tail('')
+
+      note = 'Do not quote or escape values.'
+      note += '  Options set in ICALPAL override ICALPAL_CONFIG.'
+      note += '  Options on the command line override ICALPAL.'
+
+      @op.on_tail("#{@op.summary_indent}#{note}")
     end
 
     # Parse options from the CLI and merge them with other sources
@@ -184,11 +192,45 @@ module ICalPal
         env = {}
         cf = {}
 
-        # Load from CLI, environment, configuration file
+        # Load from CLI
         @op.parse!(into: cli)
-        @op.parse!(ENV['ICALPAL'].split, into: env) rescue nil
-        cli[:cf] ||= ENV['ICALPAL_CONFIG'] || $defaults[:common][:cf]
-        @op.parse!(File.read(File.expand_path(cli[:cf])).split, into: cf) rescue nil
+
+        # Environment variable needs special parsing.
+        # OptionParser.parse doesn't handle whitespace in a
+        # comma-separated value.
+        begin
+          o = []
+
+          ENV['ICALPAL'].gsub(/^-/, ' -').split(' -').each do |e|
+            a = e.split(' ', 2)
+
+            if a[0]
+              o.push("-#{a[0]}")
+              o.push(a[1]) if a[1]
+            end
+          end
+
+          @op.parse!(o, into: env)
+        end if ENV['ICALPAL'] && !cli[:norc]
+
+        # Configuration file needs special parsing for the same reason
+        begin
+          o = []
+
+          cli[:cf] ||= ENV['ICALPAL_CONFIG'] || $defaults[:common][:cf]
+
+          File.read(File.expand_path(cli[:cf])).split("\n").each do |line|
+            a = line.split(' ', 2)
+
+            if a[0] && a[0][0] != '#'
+              o.push(a[0])
+              o.push(a[1]) if a[1]
+            end
+          end
+
+          @op.parse!(o, into: cf)
+        rescue StandardError
+        end unless cli[:norc]
 
         cli[:cmd] ||= @op.default_argv[0]
         cli[:cmd] ||= env[:cmd] if env[:cmd]
@@ -198,10 +240,10 @@ module ICalPal
         # Parse eventsNow and eventsToday commands
         cli[:cmd].match('events(Now|Today)(\+[0-9]+)?') do |m|
           cli[:now] = true if m[1] == 'Now'
-          cli[:days] = (m[1] == 'Today')? m[2].to_i + 1 : 1
+          cli[:days] = (m[1] == 'Today')? m[2].to_i : 1
 
           cli[:from] = $today
-          cli[:to] = $today + cli[:days]
+          cli[:to] = $today + cli[:days] if cli[:days]
           cli[:days] = Integer(cli[:to] - cli[:from])
 
           cli[:cmd] = 'events'
@@ -244,6 +286,7 @@ module ICalPal
           opts[:to] += 1 if opts[:to]
           opts[:to] ||= opts[:from] + 1 if opts[:from]
           opts[:to] = opts[:from] + opts[:days] if opts[:days]
+          opts[:to] = RDT.new(*opts[:to].to_a[0..2] + [ 23, 59, 59 ])
           opts[:days] ||= Integer(opts[:to] - opts[:from])
           opts[:from] = $now if opts[:n]
         end
@@ -287,7 +330,9 @@ module ICalPal
     # Pad non-options to align with options
     #
     # @param t [String] Text on the left side
-    # @return [String] Text indented by summary_indent, and padded according to summary_width
+    #
+    # @return [Array<String>] Array containing +summary_indent+, +t+,
+    # a number of spaces equal to (+summary_width+ - +t.length+)
     def pad(t)
       [ @op.summary_indent, t, ' ' * (@op.summary_width - t.length) ]
     end

data/lib/rdt.rb

@@ -1,9 +1,22 @@
-require 'date'
-
 module ICalPal
   # Child class of DateTime that adds support for relative dates (<em><b>R</b>elative<b>D</b>ate<b>T</b>ime</em>).
   class RDT < DateTime
 
+    # Create a new RDT from a Time object
+    def self.from_time(t)
+      new(*t.to_a[0..5].reverse)
+    end
+
+    # Create a new RDT from seconds since epoch
+    def self.from_epoch(s)
+      from_time(Time.at(s))
+    end
+
+    # Create a new RDT from seconds since iCal epoch
+    def self.from_itime(s)
+      from_epoch(s + ITIME)
+    end
+
     # Convert a String to an RDT
     #
     # @param str [String] can be +yesterday+, +today+, +tomorrow+,
@@ -28,7 +41,7 @@ module ICalPal
     # @return [String] A string representation of self relative to
     #  today.
     def to_s
-      return strftime($opts[:df]) if $opts[:nrd] && $opts[:df]
+      return strftime($opts[:df]) if $opts && $opts[:nrd] && $opts[:df]
 
       case Integer(RDT.new(year, month, day) - $today)
       when -2 then 'day before yesterday'
@@ -36,7 +49,7 @@ module ICalPal
       when 0 then 'today'
       when 1 then 'tomorrow'
       when 2 then 'day after tomorrow'
-      else strftime($opts[:df]) if $opts[:df]
+      else strftime($opts[:df]) if $opts && $opts[:df]
       end
     end
 
@@ -54,6 +67,11 @@ module ICalPal
       to_time.to_i
     end
 
+    # @return [Array] Only the year, month and day of self
+    def ymd
+      [ year, month, day ]
+    end
+
     # @see ICalPal::RDT.to_s
     #
     # @return [Boolean]

data/lib/utils.rb

@@ -9,10 +9,6 @@ def xmlify(key, 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
@@ -22,9 +18,6 @@ def xmlify(key, value)
     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

data/lib/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: icalPal
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Andy Rosen
 bindir: bin
 cert_chain: []
-date: 2025-03-24 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri-plist
@@ -37,6 +37,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: timezone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.99'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.99'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 description: |
   Inspired by icalBuddy and maintains close compatability.  Includes
   many additional features for querying, filtering, and formatting.
@@ -68,6 +88,7 @@ licenses:
 - GPL-3.0-or-later
 metadata:
   bug_tracker_uri: https://github.com/ajrosen/icalPal/issues
+  rubygems_mfa_required: 'true'
 post_install_message: |2+
 
   Note: icalPal requires "Full Disk Access" in System Settings to access your calendar.