doing 2.1.2pre → 2.1.6pre

data/lib/doing/util_backup.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+require 'zlib'
+
+module Doing
+  module Util
+    ## Backup utils
+    module Backup
+      extend self
+      include Util
+
+      ##
+      ## Delete all but most recent 5 backups
+      ##
+      ## @param      limit  Maximum number of backups to retain
+      ##
+      def prune_backups(filename, limit = 10)
+        backups = get_backups(filename)
+        return unless backups.count > limit
+
+        backups[limit..-1].each do |file|
+          FileUtils.rm(File.join(backup_dir, file))
+        end
+      end
+
+      ##
+      ## Restore the most recent backup. If a filename is
+      ## provided, only backups of that filename will be used.
+      ##
+      ## @param      filename  The filename to restore, if
+      ##                       different from default
+      ##
+      def restore_last_backup(filename = nil, count: 1)
+        Doing.logger.benchmark(:restore_backup, :start)
+        filename ||= Doing.config.settings['doing_file']
+
+        result = get_backups(filename).slice(count - 1)
+        raise DoingRuntimeError, 'End of undo history' if result.nil?
+
+        backup_file = File.join(backup_dir, result)
+
+        save_undone(filename)
+        FileUtils.mv(backup_file, filename)
+        prune_backups_after(File.basename(backup_file))
+        Doing.logger.warn('File update:', "restored from #{result}")
+        Doing.logger.benchmark(:restore_backup, :finish)
+      end
+
+      ##
+      ## Undo last undo
+      ##
+      ## @param      filename  The filename
+      ##
+      def redo_backup(filename = nil, count: 1)
+        filename ||= Doing.config.settings['doing_file']
+        # redo_file = File.join(backup_dir, "undone___#{File.basename(filename)}")
+        undones = Dir.glob("undone*#{File.basename(filename)}", base: backup_dir).sort
+        total = undones.count
+        count = total if count > total
+
+        skipped = undones.slice!(0, count)
+        undone = skipped.pop
+
+        raise DoingRuntimeError, 'End of redo history' if undone.nil?
+
+        redo_file = File.join(backup_dir, undone)
+
+        FileUtils.move(redo_file, filename)
+
+        skipped.each do |f|
+          FileUtils.mv(File.join(backup_dir, f), File.join(backup_dir, f.sub(/^undone/, '')))
+        end
+
+        Doing.logger.warn('File update:', "restored undo step #{count}/#{total}")
+        Doing.logger.debug('Backup:', "#{total - skipped.count - 1} redos remaining")
+      end
+
+      def clear_undone(filename = nil)
+        filename ||= Doing.config.settings['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))
+        end
+      end
+
+      ##
+      ## Select from recent undos. If a filename is
+      ## provided, only backups of that filename will be used.
+      ##
+      ## @param      filename  The filename to restore
+      ##
+      def select_redo(filename = nil)
+        filename ||= Doing.config.settings['doing_file']
+
+        undones = Dir.glob("undone*#{File.basename(filename)}", base: backup_dir).sort
+
+        raise DoingRuntimeError, 'End of redo history' if undones.empty?
+
+        total = undones.count
+        options = undones.each_with_object([]) do |file, arr|
+          d, _base = date_of_backup(file)
+          next if d.nil?
+
+          arr.push("#{d.time_ago}\t#{File.join(backup_dir, file)}")
+        end
+
+        backup_file = show_menu(options, filename)
+        idx = undones.index(File.basename(backup_file))
+        skipped = undones.slice!(idx, undones.count - idx)
+        undone = skipped.shift
+
+        redo_file = File.join(backup_dir, undone)
+
+        FileUtils.move(redo_file, filename)
+
+        skipped.each do |f|
+          FileUtils.mv(File.join(backup_dir, f), File.join(backup_dir, f.sub(/^undone/, '')))
+        end
+
+        Doing.logger.warn('File update:', "restored undo step #{idx}/#{total}")
+        Doing.logger.debug('Backup:', "#{total - skipped.count - 1} redos remaining")
+      end
+
+      ##
+      ## Select from recent backups. If a filename is
+      ## provided, only backups of that filename will be used.
+      ##
+      ## @param      filename  The filename to restore
+      ##
+      def select_backup(filename = nil)
+        filename ||= Doing.config.settings['doing_file']
+
+        options = get_backups(filename).each_with_object([]) do |file, arr|
+          d, _base = date_of_backup(file)
+          next if d.nil?
+          arr.push("#{d.time_ago}\t#{File.join(backup_dir, file)}")
+        end
+
+        backup_file = show_menu(options, filename)
+        write_to_file(File.join(backup_dir, "undone___#{File.basename(filename)}"), IO.read(filename), backup: false)
+        FileUtils.mv(backup_file, filename)
+        prune_backups_after(File.basename(backup_file))
+        Doing.logger.warn('File update:', "restored from #{backup_file}")
+      end
+
+      def show_menu(options, filename)
+        if TTY::Which.which('colordiff')
+          preview = 'colordiff -U 1'
+          pipe = '| awk "(NR>2)"'
+        elsif TTY::Which.which('git')
+          preview = 'git --no-pager diff -U1 --color=always --minimal --word-diff'
+          pipe = ' | awk "(NR>4)"'
+        else
+          preview = 'diff -U 1'
+          pipe = if TTY::Which.which('delta')
+                   ' | delta --no-gitconfig --syntax-theme=1337'
+                 elsif TTY::Which.which('diff-so-fancy')
+                   ' | diff-so-fancy'
+                 elsif TTY::Which.which('ydiff')
+                   ' | ydiff -c always --wrap < /dev/tty'
+                 else
+                   cmd = 'sed -e "s/^-/`echo -e "\033[31m"`-/;s/^+/`echo -e "\033[32m"`+/;s/^@/`echo -e "\033[34m"`@/;s/\$/`echo -e "\033[0m"`/"'
+                   "| bash -c #{Shellwords.escape(cmd)}"
+                 end
+          pipe += ' | awk "(NR>2)"'
+        end
+
+        result = Doing::Prompt.choose_from(options,
+                                           prompt: 'Select a backup to restore',
+                                           sorted: false,
+                                           fzf_args: [
+                                             '--delimiter="\t"',
+                                             '--with-nth=1',
+                                             %(--preview='#{preview} "#{filename}" {2} #{pipe}'),
+                                             '--disabled',
+                                             '--height=10',
+                                             '--preview-window="right,70%,nowrap,follow"',
+                                             '--header="Select a revision to restore"'
+                                           ])
+        raise UserCancelled unless result
+
+        result.strip.split(/\t/).last
+      end
+
+      ##
+      ## Writes a copy of the content to a dated backup file
+      ## in a hidden directory
+      ##
+      ## @param      content  The data to back up
+      ##
+      def write_backup(filename = nil)
+        Doing.logger.benchmark(:_write_backup, :start)
+        filename ||= Doing.config.settings['doing_file']
+
+        unless File.exist?(filename)
+          Doing.logger.debug('Backup:', "original file doesn't exist (#{filename})")
+          return
+        end
+
+        backup_file = File.join(backup_dir, "#{timestamp_filename}___#{File.basename(filename)}")
+        # compressed = Zlib::Deflate.deflate(content)
+        # Zlib::GzipWriter.open(backup_file + '.gz') do |gz|
+        #   gz.write(IO.read(filename))
+        # end
+
+        FileUtils.cp(filename, backup_file)
+
+        prune_backups(filename, 15)
+        clear_undone(filename)
+        Doing.logger.benchmark(:_write_backup, :finish)
+      end
+
+      private
+
+      def timestamp_filename
+        Time.now.strftime('%Y-%m-%d_%H.%M.%S')
+      end
+
+      def get_backups(filename = nil)
+        filename ||= Doing.config.settings['doing_file']
+        backups = Dir.glob("*___#{File.basename(filename)}", base: backup_dir).sort.reverse
+        backups.delete_if { |f| f =~ /^undone/ }
+      end
+
+      def save_undone(filename = nil)
+        filename ||= Doing.config.settings['doing_file']
+        undone_file = File.join(backup_dir, "undone#{timestamp_filename}___#{File.basename(filename)}")
+        FileUtils.cp(filename, undone_file)
+      end
+
+      ##
+      ## Retrieve date from backup filename
+      ##
+      ## @param      filename  The filename
+      ##
+      def date_of_backup(filename)
+        m = filename.match(/^(?:undone)?(?<date>\d{4}-\d{2}-\d{2})_(?<time>\d{2}\.\d{2}\.\d{2})___(?<file>.*?)$/)
+        return nil if m.nil?
+
+        [Time.parse("#{m['date']} #{m['time'].gsub(/\./, ':')}"), m['file']]
+      end
+
+      ##
+      ## Return a location for storing backups, creating if needed
+      ##
+      ## @return     Path to backup directory
+      ##
+      def backup_dir
+        @backup_dir ||= create_backup_dir
+      end
+
+      def create_backup_dir
+        dir = File.expand_path(Doing.config.settings['backup_dir']) || File.join(user_home, '.doing_backup')
+        if File.exist?(dir) && !File.directory?(dir)
+          raise DoingRuntimeError, "Backup error: #{dir} is not a directory"
+
+        end
+
+        unless File.exist?(dir)
+          FileUtils.mkdir_p(dir)
+          Doing.logger.warn('Backup:', "backup directory created at #{dir}")
+        end
+
+        dir
+      end
+
+      ##
+      ## Delete backups newer than selected filename
+      ##
+      ## @param      filename  The filename
+      ##
+      def prune_backups_after(filename)
+        target_date, base = date_of_backup(filename)
+        return if target_date.nil?
+
+        counter = 0
+        get_backups(base).each do |file|
+          date, _base = date_of_backup(file)
+          if date && target_date < date
+            FileUtils.mv(File.join(backup_dir, file), File.join(backup_dir, "undone#{file}"))
+            counter += 1
+          end
+        end
+        Doing.logger.debug('Backup:', "deleted #{counter} files newer than restored backup")
+      end
+    end
+  end
+end

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '2.1.2pre'
+  VERSION = '2.1.6pre'
 end

data/lib/doing/wwid.rb

@@ -183,7 +183,25 @@ module Doing
 
       date = nil
       iso_rx = /\d{4}-\d\d-\d\d \d\d:\d\d/
-      done_rx = /(?<=^| )@(?<tag>done|finished|completed?)\((?<date>.*?)\)/i
+      watch_tags = [
+        'start(?:ed)?',
+        'beg[ia]n',
+        'done',
+        'finished',
+        'completed?',
+        'waiting',
+        'defer(?:red)?'
+      ]
+      if @config['date_tags']
+        date_tags = @config['date_tags']
+        date_tags = date_tags.split(/ *, */) if date_tags.is_a?(String)
+        date_tags.map! do |tag|
+          tag.sub(/^@/, '').gsub(/\((?!\?:)(.*?)\)/, '(?:\1)').strip
+        end
+        watch_tags.concat(date_tags).uniq!
+      end
+
+      done_rx = /(?<=^| )@(?<tag>#{watch_tags.join('|')})\((?<date>.*?)\)/i
       date_rx = /^(?:\s*- )?(?<date>.*?) \| (?=\S)/
 
       title.gsub!(done_rx) do
@@ -244,7 +262,7 @@ module Doing
       return frag.cap_first if @content.section?(frag)
 
       section = nil
-      re = frag.split('').join('.*?')
+      re = frag.to_rx(distance: 2, case_type: :ignore)
       sections.each do |sect|
         next unless sect =~ /#{re}/i
 
@@ -286,7 +304,7 @@ module Doing
     def guess_view(frag, guessed: false, suggest: false)
       views.each { |view| return view if frag.downcase == view.downcase }
       view = false
-      re = frag.split('').join('.*?')
+      re = frag.to_rx(distance: 2, case_type: :ignore)
       views.each do |v|
         next unless v =~ /#{re}/i
 
@@ -423,8 +441,9 @@ module Doing
     # @param      item    [Item] the item to reset/resume
     # @param      resume  [Boolean] removing @done tag if true
     #
-    def reset_item(item, resume: false)
-      item.date = Time.now
+    def reset_item(item, date: nil, resume: false)
+      date ||= Time.now
+      item.date = date
       item.tag('done', remove: true) if resume
       logger.info('Reset:', %(Reset #{resume ? 'and resumed ' : ''} "#{item.title}" in #{item.section}))
       item
@@ -528,10 +547,25 @@ module Doing
       last_entry
     end
 
-    def all_tags(items, opt: {})
-      all_tags = []
-      items.each { |item| all_tags.concat(item.tags).uniq! }
-      all_tags.sort
+    def all_tags(items, opt: {}, counts: false)
+      if counts
+        all_tags = {}
+        items.each do |item|
+          item.tags.each do |tag|
+            if all_tags.key?(tag.downcase)
+              all_tags[tag.downcase] += 1
+            else
+              all_tags[tag.downcase] = 1
+            end
+          end
+        end
+
+        all_tags.sort_by { |tag, count| count }
+      else
+        all_tags = []
+        items.each { |item| all_tags.concat(item.tags.map(&:downcase)).uniq! }
+        all_tags.sort
+      end
     end
 
     def tag_groups(items, opt: {})
@@ -656,6 +690,7 @@ module Doing
         end
 
         if keep && opt[:tag]
+          opt[:tag_bool] = opt[:bool].normalize_bool if opt[:bool]
           opt[:tag_bool] ||= :and
           tag_match = opt[:tag].nil? || opt[:tag].empty? ? true : item.tags?(opt[:tag], opt[:tag_bool])
           keep = false unless tag_match
@@ -666,7 +701,7 @@ module Doing
           search_match = if opt[:search].nil? || opt[:search].empty?
                            true
                          else
-                           item.search(opt[:search], case_type: opt[:case].normalize_case, fuzzy: opt[:fuzzy])
+                           item.search(opt[:search], case_type: opt[:case].normalize_case)
                          end
 
           keep = false unless search_match
@@ -708,7 +743,7 @@ module Doing
 
         keep = false if keep && opt[:only_timed] && !item.interval
 
-        if keep && opt[:tag_filter] && !opt[:tag_filter]['tags'].empty?
+        if keep && opt[:tag_filter]
           keep = item.tags?(opt[:tag_filter]['tags'], opt[:tag_filter]['bool'])
           keep = opt[:not] ? !keep : keep
         end
@@ -745,7 +780,7 @@ module Doing
 
         keep
       end
-      count = opt[:count]&.positive? ? opt[:count] : filtered_items.length
+      count = opt[:count].to_i&.positive? ? opt[:count].to_i : filtered_items.count
 
       output = Items.new
 
@@ -914,12 +949,19 @@ module Doing
         if opt[:resume] && !opt[:reset]
           repeat_item(item, { editor: opt[:editor] })
         elsif opt[:reset]
+          res = Prompt.enter_text('Start date (blank for current time)', default_response: '')
+          if res =~ /^ *$/
+            date = Time.now
+          else
+            date = res.chronify(guess: :begin)
+          end
+
           res = if item.tags?('done', :and) && !opt[:resume]
                   opt[:force] ? true : Prompt.yn('Remove @done tag?', default_response: 'y')
                 else
                   opt[:resume]
                 end
-          @content.update_item(item, reset_item(item, resume: res))
+          @content.update_item(item, reset_item(item, date: date, resume: res))
         end
         write(@doing_file)
 
@@ -1309,20 +1351,6 @@ module Doing
       end
     end
 
-    ##
-    ## Restore a backed up version of a file
-    ##
-    ## @param      file  [String] The filepath to restore
-    ##
-    def restore_backup(file)
-      if File.exist?("#{file}~")
-        FileUtils.cp("#{file}~", file)
-        logger.warn('File update:', "Restored #{file.sub(/^#{Util.user_home}/, '~')}")
-      else
-        logger.error('Restore error:', 'No backup file found')
-      end
-    end
-
     ##
     ## Rename doing file with date and start fresh one
     ##
@@ -1387,8 +1415,35 @@ module Doing
     ##
     ## @return     [String] The selected section name
     ##
-    def choose_section
-      choice = Prompt.choose_from(@content.section_titles.sort, prompt: 'Choose a section > ', fzf_args: ['--height=60%'])
+    def choose_section(include_all: false)
+      options = @content.section_titles.sort
+      options.unshift('All') if include_all
+      choice = Prompt.choose_from(options, prompt: 'Choose a section > ', fzf_args: ['--height=60%'])
+      choice ? choice.strip : choice
+    end
+
+    ##
+    ## Generate a menu of tags and allow user selection
+    ##
+    ## @return     [String] The selected tag name
+    ##
+    def choose_tag(section = 'All', items: nil, include_all: false)
+      items ||= @content.in_section(section)
+      tags = all_tags(items, counts: true).map { |t, c| "@#{t} (#{c})" }
+      tags.unshift('No tag filter') if include_all
+      choice = Prompt.choose_from(tags, sorted: false, multiple: true, prompt: 'Choose tag(s) > ', fzf_args: ['--height=60%'])
+      choice ? choice.split(/\n/).map { |t| t.strip.sub(/ \(.*?\)$/, '')}.join(' ') : choice
+    end
+
+    ##
+    ## Generate a menu of sections and tags and allow user selection
+    ##
+    ## @return     [String] The selected section or tag name
+    ##
+    def choose_section_tag
+      options = @content.section_titles.sort
+      options.concat(@content.all_tags.sort.map { |t| "@#{t}" })
+      choice = Prompt.choose_from(options, prompt: 'Choose a section or tag > ', fzf_args: ['--height=60%'])
       choice ? choice.strip : choice
     end
 
@@ -1427,17 +1482,25 @@ module Doing
     ##
     ## @param      opt   [Hash] Additional Options
     ##
-    def list_section(opt = {})
+    def list_section(opt = {}, items: Items.new)
       opt[:config_template] ||= 'default'
-      cfg = @config.dig('templates',
-                        opt[:config_template]).deep_merge({
-                                                            'wrap_width' => @config['wrap_width'] || 0,
-                                                            'date_format' => @config['default_date_format'],
-                                                            'order' => @config['order'] || 'asc',
-                                                            'tags_color' => @config['tags_color'],
-                                                            'duration' => @config['duration'],
-                                                            'interval_format' => @config['interval_format']
-                                                          })
+
+      tpl_cfg = @config.dig('templates', opt[:config_template])
+
+      cfg = if opt[:view_template]
+              @config.dig('views', opt[:view_template]).deep_merge(tpl_cfg)
+            else
+              tpl_cfg
+            end
+
+      cfg.deep_merge({
+                       'wrap_width' => @config['wrap_width'] || 0,
+                       'date_format' => @config['default_date_format'],
+                       'order' => @config['order'] || 'asc',
+                       'tags_color' => @config['tags_color'],
+                       'duration' => @config['duration'],
+                       'interval_format' => @config['interval_format']
+                     })
       opt[:duration] ||= cfg['duration'] || false
       opt[:interval_format] ||= cfg['interval_format'] || 'text'
       opt[:count] ||= 0
@@ -1468,9 +1531,9 @@ module Doing
                 end
       end
 
-      items = filter_items(Items.new, opt: opt).reverse
+      items = filter_items(items, opt: opt)
 
-      items.reverse! if opt[:order] =~ /^d/i
+      items.reverse! unless opt[:order] =~ /^d/i
 
       if opt[:interactive]
         opt[:menu] = !opt[:force]
@@ -1869,6 +1932,7 @@ EOS
         output + tail
       when :markdown
         pad = sorted_tags_data.map {|k, v| k }.group_by(&:size).max.last[0].length
+        pad = 7 if pad < 7
         output = <<~EOS
   | #{' ' * (pad - 7) }project | time     |
   | #{'-' * (pad - 1)}: | :------- |

data/lib/doing.rb

@@ -6,9 +6,14 @@ require 'yaml'
 require 'pp'
 require 'csv'
 require 'tempfile'
+require 'zlib'
+require 'base64'
+
 require 'chronic'
 require 'tty-link'
 require 'tty-which'
+require 'tty-markdown'
+require 'plist'
 # require 'amatch'
 require 'haml'
 require 'json'
@@ -16,12 +21,14 @@ require 'logger'
 require 'safe_yaml/load'
 require 'doing/hash'
 require 'doing/colors'
+require 'doing/template_string'
 require 'doing/string'
 require 'doing/string_chronify'
 require 'doing/time'
 require 'doing/array'
 require 'doing/symbol'
 require 'doing/util'
+require 'doing/util_backup'
 require 'doing/configuration'
 require 'doing/section'
 require 'doing/items'
@@ -35,6 +42,8 @@ require 'doing/hooks'
 require 'doing/plugin_manager'
 require 'doing/pager'
 require 'doing/completion'
+require 'doing/boolean_term_parser'
+require 'doing/phrase_parser'
 # require 'doing/markdown_document_listener'
 
 # Main doing module

data/lib/examples/plugins/say_export.rb

@@ -73,7 +73,7 @@ module Doing
       {
         trigger: 'say(?:it)?',
         templates: [
-          { name: 'say', trigger: 'say(?:it)?' }
+          { name: 'say', trigger: 'say(?:it)?', format: 'text', filename: 'say.txt' }
         ],
         config: {
           'say_voice' => 'Fiona'

data/lib/examples/plugins/wiki_export/wiki_export.rb

@@ -11,9 +11,9 @@ module Doing
       {
         trigger: 'wiki',
         templates: [
-          { name: 'wiki_page', trigger: 'wiki.?page' },
-          { name: 'wiki_index', trigger: 'wiki.?index' },
-          { name: 'wiki_css', trigger: 'wiki.?css' }
+          { name: 'wiki_page', trigger: 'wiki.?page', format: 'haml', filename: 'wiki.haml' },
+          { name: 'wiki_index', trigger: 'wiki.?index', format: 'haml', filename: 'wiki_index.haml' },
+          { name: 'wiki_css', trigger: 'wiki.?css', format: 'css', filename: 'wiki.css' }
         ]
       }
     end

data/lib/templates/doing-dayone-entry.erb

@@ -0,0 +1,6 @@
+<% @items.each do |i| %>Doing on <%= i[:date_object].strftime('%A %m/%d/%y') %>
+
+<%= i[:title] %><% if i[:note].length.positive? %><%= "\n\n" + i[:note].map{|n| n.strip }.join("\n    ") %><% end %>
+
+<% if i[:human_time] && i[:time] != "00:00:00" %>_Took <%= i[:human_time] %>._<% end %>
+<% end %>

data/lib/templates/doing-dayone.erb

@@ -0,0 +1,5 @@
+# <%= @page_title %>
+<% @items.each do |i| %>
+- [<%= i[:done] %>] <%= i[:date] %> <%= i[:title] %> <% if i[:time] && i[:time] != "00:00:00" %>[**<%= i[:time] %>**]<% end %><% if i[:note].length.positive? %><%= "\n\n    " + i[:note].map{|n| n.strip }.join("\n    ") %><% end %><% end %>
+
+<%= @totals %>