Escape control characters in CSV and Remind output (#41)

Author: ajrosen

CHANGELOG.md

@@ -1,4 +1,9 @@
-icalPal-3.9.0
+icalPal-3.9.2
+==================
+
+  * Escape control characters in CSV and Remind output
+
+icalPal-3.9.1
 ==================
 
   * Implement tasksDueBefore command

README.md

@@ -280,11 +280,12 @@ 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
+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.
+
 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.

bin/icalpal

@@ -290,7 +290,7 @@ unless mu
        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']}"
+             "MSG #{i['title'].gsub(/([[:cntrl:]])/) { |c| c.dump[1..-2] } }"
          }.join("\n")
        else abort "No formatter for #{$opts[:output]}"
        end

lib/icalPal.rb

@@ -88,14 +88,17 @@ def initialize(obj)
     obj['symbolic_color_name'] ||= type[:color]
   end
 
-  # Create a new CSV::Row with values from +self+.  Newlines are
-  # replaced with '\n' to ensure each Row is a single line of text.
+  # Create a new CSV::Row with values from +self+.  Control characters
+  # are escaped to ensure they are not interpreted by the terminal.
   #
   # @param headers [Array] Key names used as the header row in a CSV::Table
   # @return [CSV::Row] The +Store+, +Calendar+, +CalendarItem+, or
   # +Reminder+ as a CSV::Row
   def to_csv(headers)
-    values = headers.map { |h| (@self[h].respond_to?(:gsub))? @self[h].gsub("\n", '\n') : @self[h] }
+    values = headers.map do |h|
+      (@self[h].respond_to?(:gsub))?
+        @self[h].gsub(/([[:cntrl:]])/) { |c| c.dump[1..-2] } : @self[h]
+    end
 
     CSV::Row.new(headers, values)
   end

lib/options.rb

@@ -337,6 +337,8 @@ def parse_options
         raise(OptionParser::InvalidArgument, '--li cannot be negative') if opts[:li].negative?
         raise(OptionParser::InvalidOption, 'Start date must be before end date') if opts[:from] && opts[:from] > opts[:to]
         raise(OptionParser::MissingArgument, 'No properties to display') if opts[:props].empty?
+        raise(OptionParser::InvalidArgument, 'Cannot use remind output with tasks') if opts[:cmd] == 'tasks' &&
+          opts[:output] == 'remind'
 
       rescue StandardError => e
         @op.abort("#{e}\n\n#{@op.help}\n#{e}")

lib/reminder.rb

@@ -53,7 +53,7 @@ def [](k)
       when 'name', 'reminder', 'task' # Aliases
         @self['title']
 
-      else @self[k]
+      else super
       end
     end
 

lib/version.rb

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