doing 2.1.27 → 2.1.31pre

data/lib/doing/configuration.rb

@@ -220,9 +220,9 @@ module Doing
               return nil unless create
             end
 
-            resolved = real_path.count.positive? ? "Resolved #{real_path.join('->')}, but " : ''
+            resolved = real_path.count.positive? ? "Resolved #{real_path.join('.')}, but " : ''
             Doing.logger.log_now(:warn, "#{resolved}#{path} is unknown")
-            new_path = [*real_path, path, *paths].join('->')
+            new_path = [*real_path, path, *paths].join('.')
             Doing.logger.log_now(:warn, "Continuing will create the path #{new_path}")
             res = Prompt.yn('Key path not found, create it?', default_response: true)
             raise InvalidArgument, 'Invalid key path' unless res
@@ -374,7 +374,7 @@ module Doing
         deprecated = true
         config['editors']['default'] ||= config['editor']
         config.delete('editor')
-        Doing.logger.debug('Deprecated:', "config key 'editor' is now 'editors->default', please update your config.")
+        Doing.logger.debug('Deprecated:', "config key 'editor' is now 'editors.default', please update your config.")
       end
 
       if config.key?('config_editor_app') && !config['editors']['config']
@@ -382,7 +382,7 @@ module Doing
         config['editors']['config'] = config['config_editor_app']
         config.delete('config_editor_app')
         Doing.logger.debug('Deprecated:',
-                           "config key 'config_editor_app' is now 'editors->config', please update your config.")
+                           "config key 'config_editor_app' is now 'editors.config', please update your config.")
       end
 
       if config.key?('editor_app') && !config['editors']['doing_file']
@@ -390,7 +390,7 @@ module Doing
         config['editors']['doing_file'] = config['editor_app']
         config.delete('editor_app')
         Doing.logger.debug('Deprecated:',
-                           "config key 'editor_app' is now 'editors->doing_file', please update your config.")
+                           "config key 'editor_app' is now 'editors.doing_file', please update your config.")
       end
 
       Doing.logger.warn('Deprecated:', 'outdated keys found, please run `doing config --update`.') if deprecated

data/lib/doing/item.rb

@@ -272,7 +272,7 @@ module Doing
     end
 
     def highlight_search(search, distance: nil, negate: false, case_type: nil)
-      prefs = Doing.config.settings['search'] || {}
+      prefs = Doing.setting('search', {})
       matching = prefs.fetch('matching', 'pattern').normalize_matching
       distance ||= prefs.fetch('distance', 3).to_i
       case_type ||= prefs.fetch('case', 'smart').normalize_case
@@ -311,7 +311,7 @@ module Doing
     ## @return     [Boolean] matches search criteria
     ##
     def search(search, distance: nil, negate: false, case_type: nil)
-      prefs = Doing.config.settings['search'] || {}
+      prefs = Doing.setting('search', {})
       matching = prefs.fetch('matching', 'pattern').normalize_matching
       distance ||= prefs.fetch('distance', 3).to_i
       case_type ||= prefs.fetch('case', 'smart').normalize_case
@@ -354,6 +354,24 @@ module Doing
       negate ? !matches : matches
     end
 
+    ##
+    ## Test if item has a @done tag
+    ##
+    ## @return     [Boolean] true item has @done tag
+    ##
+    def finished?
+      tags?('done')
+    end
+
+    ##
+    ## Test if item does not contain @done tag
+    ##
+    ## @return     [Boolean] true if item is missing @done tag
+    ##
+    def unfinished?
+      tags?('done', negate: true)
+    end
+
     ##
     ## Test if item is included in never_finish config and
     ## thus should not receive a @done tag
@@ -436,7 +454,7 @@ module Doing
     private
 
     def should?(key)
-      config = Doing.config.settings
+      config = Doing.settings
       return true unless config[key].is_a?(Array)
 
       config[key].each do |tag|

data/lib/doing/items.rb

@@ -131,9 +131,9 @@ module Doing
       out = []
       @sections.each do |section|
         out.push(section.original)
-        items = in_section(section.title).sort_by { |i| i.date }
-        items.reverse! if Doing.config.settings['doing_file_sort'].normalize_order == :desc
-        items.each { |item| out.push(item.to_s)}
+        items = in_section(section.title).sort_by(&:date)
+        items.reverse! if Doing.setting('doing_file_sort').normalize_order == :desc
+        items.each { |item| out.push(item.to_s) }
       end
 
       out.join("\n")
@@ -141,8 +141,8 @@ module Doing
 
     # @private
     def inspect
-      "#<Doing::Items #{count} items, #{@sections.count} sections: #{@sections.map { |s| "<Section:#{s.title} #{in_section(s.title).count} items>" }.join(', ')}>"
+      sections = @sections.map { |s| "<Section:#{s.title} #{in_section(s.title).count} items>" }.join(', ')
+      "#<Doing::Items #{count} items, #{@sections.count} sections: #{sections}>"
     end
-
   end
 end

data/lib/doing/note.rb

@@ -5,7 +5,6 @@ module Doing
   ## This class describes an item note.
   ##
   class Note < Array
-
     ##
     ## Initializes a new note
     ##
@@ -28,9 +27,10 @@ module Doing
     ##
     def add(note, replace: false)
       clear if replace
-      if note.is_a?(String)
+      case note
+      when String
         append_string(note)
-      elsif note.is_a?(Array)
+      when Array
         append(note)
       end
     end
@@ -55,7 +55,7 @@ module Doing
     ## @return     [Array] Stripped note
     ##
     def strip_lines
-      map(&:strip)
+      Note.new(map(&:strip))
     end
 
     def strip_lines!
@@ -64,8 +64,24 @@ module Doing
 
     ##
     ## Note as multi-line string
-    def to_s
-      compress.strip_lines.map { |l| "\t\t#{l}" }.join("\n")
+    ##
+    ## @param      prefix  [String] prefix for each line (default two tabs, TaskPaper format)
+    ##
+    def to_s(prefix: "\t\t")
+      compress.strip_lines.map { |l| "#{prefix}#{l}" }.join("\n")
+    end
+
+    ##
+    ## Returns note as a single line, newlines separated by
+    ## space
+    ##
+    ## @return     [String] Line representation of the Note.
+    ##
+    ## @param      separator  The separator with which to
+    ##                        join multiple lines
+    ##
+    def to_line(separator: ' ')
+      compress.strip_lines.join(separator)
     end
 
     # @private
@@ -94,7 +110,7 @@ module Doing
     ## @param      lines  [Array] Array of strings
     ##
     def append(lines)
-      concat(lines)
+      concat(lines.utf8)
       replace compress
     end
 
@@ -105,7 +121,7 @@ module Doing
     ##                    newlines will be split
     ##
     def append_string(input)
-      concat(input.split(/\n/).map(&:strip))
+      concat(input.utf8.split(/\n/).map(&:strip))
       replace compress
     end
   end

data/lib/doing/plugins/export/dayone_export.rb

@@ -45,7 +45,9 @@ module Doing
 
     def self.render(wwid, items, variables: {})
 
-      return if items.nil?
+      return unless items.good?
+
+      config = Doing.settings
 
       opt = variables[:options]
       trigger = opt[:output]
@@ -78,7 +80,7 @@ module Doing
         title = "#{title} @section(#{i.section})" unless variables[:is_single]
 
         tags.concat(i.tag_array).sort!.uniq!
-        flagged = day_flagged = true if i.tags?(wwid.config['marker_tag'])
+        flagged = day_flagged = true if i.tags?(config['marker_tag'])
 
         interval = wwid.get_interval(i, record: true) if i.title =~ /@done\((\d{4}-\d\d-\d\d \d\d:\d\d.*?)\)/ && opt[:times]
         interval ||= false
@@ -123,8 +125,8 @@ module Doing
       end
 
 
-      template = if wwid.config['export_templates']['dayone'] && File.exist?(File.expand_path(wwid.config['export_templates']['dayone']))
-                   IO.read(File.expand_path(wwid.config['export_templates']['dayone']))
+      template = if config['export_templates']['dayone'] && File.exist?(File.expand_path(config['export_templates']['dayone']))
+                   IO.read(File.expand_path(config['export_templates']['dayone']))
                  else
                    self.template('dayone')
                  end
@@ -144,8 +146,8 @@ module Doing
                     starred: hsh[:starred])
         end
       when :entries
-        entry_template = if wwid.config['export_templates']['dayone_entry'] && File.exist?(File.expand_path(wwid.config['export_templates']['dayone_entry']))
-                           IO.read(File.expand_path(wwid.config['export_templates']['dayone_entry']))
+        entry_template = if config['export_templates']['dayone_entry'] && File.exist?(File.expand_path(config['export_templates']['dayone_entry']))
+                           IO.read(File.expand_path(config['export_templates']['dayone_entry']))
                          else
                            self.template('dayone-entry')
                          end

data/lib/doing/plugins/export/html_export.rb

@@ -58,14 +58,14 @@ module Doing
         }
       end
 
-      template = if wwid.config['export_templates']['haml'] && File.exist?(File.expand_path(wwid.config['export_templates']['haml']))
-                   IO.read(File.expand_path(wwid.config['export_templates']['haml']))
+      template = if Doing.setting('export_templates.haml') && File.exist?(File.expand_path(Doing.setting('export_templates.haml')))
+                   IO.read(File.expand_path(Doing.setting('export_templates.haml')))
                  else
                    self.template('html')
                  end
 
-      style = if wwid.config['export_templates']['css'] && File.exist?(File.expand_path(wwid.config['export_templates']['css']))
-                IO.read(File.expand_path(wwid.config['export_templates']['css']))
+      style = if Doing.setting('export_templates.css') && File.exist?(File.expand_path(Doing.setting('export_templates.css')))
+                IO.read(File.expand_path(Doing.setting('export_templates.css')))
               else
                 self.template('css')
               end

data/lib/doing/plugins/export/json_export.rb

@@ -29,16 +29,12 @@ module Doing
       max = last_date.strftime('%F')
       min = items[0].date.strftime('%F')
       items.each_with_index do |i, index|
-        if String.method_defined? :force_encoding
-          title = i.title.force_encoding('utf-8')
-          note = i.note.map { |line| line.force_encoding('utf-8').strip } if i.note
-        else
-          title = i.title
-          note = i.note.map { |line| line.strip } if i.note
-        end
+        title = i.title.utf8
+        note = i.note.utf8
 
         end_date = i.end_date || ''
         interval = wwid.get_interval(i, formatted: false) || 0
+        duration = i.duration || 0
         note ||= ''
 
         tags = []
@@ -49,14 +45,15 @@ module Doing
           attributes[tag[0]] = tag[1] if tag[1]
         end
 
-        if opt[:output] == 'json'
-
+        case opt[:output]
+        when 'json'
           i = {
             date: i.date,
             end_date: end_date,
             title: title.strip, #+ " #{note}"
-            note: note.instance_of?(Array) ? note.to_s : note,
+            note: note.to_s(prefix: ''),
             time: interval.time_string(format: :clock),
+            duration: duration.time_string(format: :clock),
             tags: tags
           }
 
@@ -64,7 +61,7 @@ module Doing
 
           items_out << i
 
-        elsif opt[:output] == 'timeline'
+        when 'timeline'
           new_item = {
             'id' => index + 1,
             'content' => title.strip, #+ " #{note}"
@@ -74,26 +71,28 @@ module Doing
             'style' => 'color:#4c566b;background-color:#d8dee9;'
           }
 
-
-          if interval && interval.to_i > 0
+          if interval.to_i&.positive?
             new_item['end'] = end_date.strftime('%F %T')
             if interval.to_i > 3600
               new_item['type'] = 'range'
               new_item['style'] = 'color:white;background-color:#a2bf8a;'
             end
           end
-          new_item['style'] = 'color:white;background-color:#f7921e;' if i.tags?(wwid.config['marker_tag'])
+          new_item['style'] = 'color:white;background-color:#f7921e;' if i.tags?(Doing.setting('marker_tag'))
           items_out.push(new_item)
         end
       end
-      if opt[:output] == 'json'
+      case opt[:output]
+      when 'json'
         Doing.logger.debug('JSON Export:', "#{items_out.count} items output to JSON")
         JSON.pretty_generate({
-          'section' => variables[:page_title],
-          'items' => items_out,
-          'timers' => wwid.tag_times(format: :json, sort_by: opt[:sort_tags], sort_order: opt[:tag_order])
-        })
-      elsif opt[:output] == 'timeline'
+                               'section' => variables[:page_title],
+                               'items' => items_out,
+                               'timers' => wwid.tag_times(format: :json,
+                                                          sort_by: opt[:sort_tags],
+                                                          sort_order: opt[:tag_order])
+                             })
+      when 'timeline'
         template = <<~EOTEMPLATE
                     <!doctype html>
                     <html>

data/lib/doing/plugins/export/markdown_export.rb

@@ -66,8 +66,8 @@ module Doing
         }
       end
 
-      template = if wwid.config['export_templates']['markdown'] && File.exist?(File.expand_path(wwid.config['export_templates']['markdown']))
-                   IO.read(File.expand_path(wwid.config['export_templates']['markdown']))
+      template = if Doing.setting('export_templates.markdown') && File.exist?(File.expand_path(Doing.setting('export_templates.markdown')))
+                   IO.read(File.expand_path(Doing.setting('export_templates.markdown')))
                  else
                    self.template(nil)
                  end

data/lib/doing/plugins/export/template_export.rb

@@ -24,8 +24,8 @@ module Doing
 
       out = ''
       items.each do |item|
-        if opt[:highlight] && item.title =~ /@#{wwid.config['marker_tag']}\b/i
-          flag = Doing::Color.send(wwid.config['marker_color'])
+        if opt[:highlight] && item.title =~ /@#{Doing.setting('marker_tag')}\b/i
+          flag = Doing::Color.send(Doing.setting('marker_color'))
           reset = Doing::Color.reset + Doing::Color.default
         else
           flag = ''
@@ -34,7 +34,7 @@ module Doing
 
         placeholders = {}
 
-        if !item.note.empty? && wwid.config['include_notes']
+        if !item.note.empty? && Doing.setting('include_notes')
           note = item.note.map(&:strip).delete_if(&:empty?)
           note.map! { |line| "#{line.sub(/^\t*/, '')}  " }
 
@@ -133,7 +133,7 @@ module Doing
 
       # Doing.logger.debug('Template Export:', "#{items.count} items output to template #{opt[:template]}")
       if opt[:totals]
-        out += wwid.tag_times(format: wwid.config['timer_format'].to_sym,
+        out += wwid.tag_times(format: Doing.setting('timer_format').to_sym,
                               sort_by: opt[:sort_tags],
                               sort_order: opt[:tag_order])
       end

data/lib/doing/plugins/import/calendar_import.rb

@@ -23,7 +23,7 @@ module Doing
       limit_start = options[:start].to_i
       limit_end = options[:end].to_i
 
-      section = options[:section] || wwid.config['current_section']
+      section = options[:section] || Doing.setting('current_section')
       options[:no_overlap] ||= false
       options[:autotag] ||= wwid.auto_tag
 

data/lib/doing/plugins/import/doing_import.rb

@@ -63,7 +63,7 @@ module Doing
         title.gsub!(/ +/, ' ')
         title.strip!
         section = options[:section] || item.section
-        section ||= wwid.config['current_section']
+        section ||= Doing.setting('current_section')
 
         new_item = Item.new(item.date, title, section)
         new_item.note = item.note

data/lib/doing/plugins/import/timing_import.rb

@@ -24,7 +24,7 @@ module Doing
     ##
     def self.import(wwid, path, options: {})
       exit_now! 'Path to JSON report required' if path.nil?
-      section = options[:section] || wwid.config['current_section']
+      section = options[:section] || Doing.setting('current_section')
       options[:no_overlap] ||= false
       options[:autotag] ||= wwid.auto_tag
       wwid.content.add_section(section) unless wwid.content.section?(section)

data/lib/doing/section.rb

@@ -13,7 +13,7 @@ module Doing
       @original = if original.nil?
                     "#{title}:"
                   else
-                    original =~ /:(\s+@\S+(\(.*?\))?)*$/ ? original : "#{original}:"
+                    original =~ /:(\s+@[^ (]+(\([^)]*\))?)*?$/ ? original : "#{original}:"
                   end
     end
 

data/lib/doing/string/highlight.rb

@@ -35,10 +35,9 @@ module Doing
 
     def highlight_search(search, distance: nil, negate: false, case_type: nil)
       out = dup
-      prefs = Doing.config.settings['search'] || {}
-      matching = prefs.fetch('matching', 'pattern').normalize_matching
-      distance ||= prefs.fetch('distance', 3).to_i
-      case_type ||= prefs.fetch('case', 'smart').normalize_case
+      matching = Doing.setting('search.matching', 'pattern').normalize_matching
+      distance ||= Doing.setting('search.distance', 3).to_i
+      case_type ||= Doing.setting('search.case', 'smart').normalize_case
 
       if search.rx? || matching == :fuzzy
         rx = search.to_rx(distance: distance, case_type: case_type)

data/lib/doing/string/string.rb

@@ -2,6 +2,14 @@
 
 class ::String
   include Doing::Color
+
+  def utf8
+    if String.method_defined? :force_encoding
+      dup.force_encoding('utf-8')
+    else
+      self
+    end
+  end
 end
 
 require_relative 'highlight'

data/lib/doing/util.rb

@@ -159,7 +159,7 @@ module Doing
 
       return ENV['EDITOR'] if ENV['DOING_EDITOR_TEST']
 
-      editor_config = Doing.config.settings['editors']
+      editor_config = Doing.setting('editors')
 
       if editor_config.is_a?(String)
         msg = "Please update your configuration, 'editors' should be a mapping."

data/lib/doing/util_backup.rb

@@ -30,7 +30,7 @@ module Doing
       ## @param      limit  Maximum number of backups to retain
       ##
       def clear_redo(filename)
-        filename ||= Doing.config.settings['doing_file']
+        filename ||= Doing.setting('doing_file')
         backups = Dir.glob("undone*___#{File.basename(filename)}", base: backup_dir).sort.reverse
         backups.each do |file|
           FileUtils.rm(File.join(backup_dir, file))
@@ -44,7 +44,7 @@ module Doing
       ## @return     [String] filename
       ##
       def last_backup(filename = nil, count: 1)
-        filename ||= Doing.config.settings['doing_file']
+        filename ||= Doing.setting('doing_file')
 
         backup = get_backups(filename).slice(count - 1)
         backup.nil? ? nil : File.join(backup_dir, backup)
@@ -59,7 +59,7 @@ module Doing
       ##
       def restore_last_backup(filename = nil, count: 1)
         Doing.logger.benchmark(:restore_backup, :start)
-        filename ||= Doing.config.settings['doing_file']
+        filename ||= Doing.setting('doing_file')
 
         backup_file = last_backup(filename, count: count)
         raise DoingRuntimeError, 'End of undo history' if backup_file.nil?
@@ -77,7 +77,7 @@ module Doing
       ## @param      filename  The filename
       ##
       def redo_backup(filename = nil, count: 1)
-        filename ||= Doing.config.settings['doing_file']
+        filename ||= Doing.setting('doing_file')
         # redo_file = File.join(backup_dir, "undone___#{File.basename(filename)}")
         undones = Dir.glob("undone*#{File.basename(filename)}", base: backup_dir).sort.reverse
         total = undones.count
@@ -101,7 +101,7 @@ module Doing
       end
 
       def clear_undone(filename = nil)
-        filename ||= Doing.config.settings['doing_file']
+        filename ||= Doing.setting('doing_file')
         # redo_file = File.join(backup_dir, "undone___#{File.basename(filename)}")
         Dir.glob("undone*#{File.basename(filename)}", base: backup_dir).each do |f|
           FileUtils.rm(File.join(backup_dir, f))
@@ -115,7 +115,7 @@ module Doing
       ## @param      filename  The filename to restore
       ##
       def select_redo(filename = nil)
-        filename ||= Doing.config.settings['doing_file']
+        filename ||= Doing.setting('doing_file')
 
         undones = Dir.glob("undone*#{File.basename(filename)}", base: backup_dir).sort
 
@@ -155,7 +155,7 @@ module Doing
       ## @param      filename  The filename to restore
       ##
       def select_backup(filename = nil)
-        filename ||= Doing.config.settings['doing_file']
+        filename ||= Doing.setting('doing_file')
 
         options = get_backups(filename).each_with_object([]) do |file, arr|
           d, _base = date_of_backup(file)
@@ -219,7 +219,7 @@ module Doing
       ##
       def write_backup(filename = nil)
         Doing.logger.benchmark(:_write_backup, :start)
-        filename ||= Doing.config.settings['doing_file']
+        filename ||= Doing.setting('doing_file')
 
         unless File.exist?(filename)
           Doing.logger.debug('Backup:', "original file doesn't exist (#{filename})")
@@ -234,7 +234,7 @@ module Doing
 
         FileUtils.cp(filename, backup_file)
 
-        prune_backups(filename, Doing.config.settings['history_size'].to_i)
+        prune_backups(filename, Doing.setting('history_size').to_i)
         clear_undone(filename)
         Doing.logger.benchmark(:_write_backup, :finish)
       end
@@ -246,13 +246,13 @@ module Doing
       end
 
       def get_backups(filename = nil, include_forward: false)
-        filename ||= Doing.config.settings['doing_file']
+        filename ||= Doing.setting('doing_file')
         backups = Dir.glob("*___#{File.basename(filename)}", base: backup_dir).sort.reverse
         backups.delete_if { |f| f =~ /^undone/ } unless include_forward
       end
 
       def save_undone(filename = nil)
-        filename ||= Doing.config.settings['doing_file']
+        filename ||= Doing.setting('doing_file')
         undone_file = File.join(backup_dir, "undone#{timestamp_filename}___#{File.basename(filename)}")
         FileUtils.cp(filename, undone_file)
       end
@@ -279,7 +279,7 @@ module Doing
       end
 
       def create_backup_dir
-        dir = File.expand_path(Doing.config.settings['backup_dir']) || File.join(user_home, '.doing_backup')
+        dir = File.expand_path(Doing.setting('backup_dir')) || File.join(user_home, '.doing_backup')
         if File.exist?(dir) && !File.directory?(dir)
           raise DoingRuntimeError, "Backup error: #{dir} is not a directory"
 

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '2.1.27'
+  VERSION = '2.1.31pre'
 end