doing 1.0.74 → 1.0.79

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 652cc285b42ce068d4640a6aff95d2058d1fba60715e41ce4599bfcbe7051507
-  data.tar.gz: 7a940801f8fa9d78b27688b6c92f4fcdb4b5765c28888cb6f1218245d4535376
+  metadata.gz: 24a207b31d2f64fc81c00b1484f62a5ab2609ded162fc9733cb54463c652d63e
+  data.tar.gz: dfc767b0d8cec0229e9ad3823f5853d81c343261198c6638e364331920dc7989
 SHA512:
-  metadata.gz: df8f8c529b18238a5d069b79c9e43382f2751d18f1dd022e7d918467f31dadd6b6a50780034b516d4d9b321ddcc4d3ebb7a40db9b96a4059adf49eda119663f9
-  data.tar.gz: b67333df19e976fe0cbde7645c6cc8a9098813a023090f7e52bd60052283202f2dff8406beacb28d921d7c947dac2d885caab7fe3388c578a17b73181a4cbbc5
+  metadata.gz: 1f64972ed2d157a0b52afa882d257190d236ebb5805d0ff8049d3ab65ca92974a1cbe2e11ba2ee1ea9cd04b751bd4cc6874f409d442cdfb9347c37bacb6fc47c
+  data.tar.gz: 9d3432a35cd14d44474ef32e90df40943a2a9ed7eb7c232a2361816aba255b7ed39992dc7b4cfa000afb93abbe4cea3036c9eec244a2fe141f7dca70ce400095

data/README.md

@@ -27,7 +27,7 @@ If there's something I want to look at later but doesn't need to be added to a t
 
 ## Installation
 
-The current version of `doing` is <!--VER-->1.0.73<!--END VER-->.
+The current version of `doing` is <!--VER-->1.0.78<!--END VER-->.
 
     $ [sudo] gem install doing
 
@@ -268,7 +268,7 @@ You can add additional custom views. Just nest them under the `views` key (inden
         count: 5
         wrap_width: 0
         date_format: '%F %_I:%M%P'
-        template: '%date | %title%note' 
+        template: '%date | %title%note'
 
 The `section` key is the default section to pull entries from. Count and section can be overridden at runtime with the `-c` and `-s` flags. Setting `section` to `All` will combine all sections in the output.
 
@@ -505,7 +505,7 @@ You can include a `transform` section in the autotag config which contains pairs
     transform:
     - (\w+)-\d+:$1
 
-This creates a search pattern looking for a string of word characters followed by a hyphen and one or more digits, e.g. `@projecttag-12`. Do not include the @ symbol in the pattern. The replacement (`$1`) indicates that the first matched group (in parenthesis) should be used to generate the new tag, resulting in `@projecttag` being added to the entry.
+This creates a search pattern looking for a string of word characters followed by a hyphen and one or more digits, e.g. `@projecttag-12`. Do not include the @ symbol in the pattern. The replacement (`$l`) indicates that the first matched group (in parenthesis) should be used to generate the new tag, resulting in `@projecttag` being added to the entry.
 
 ##### Annotating
 
@@ -619,11 +619,14 @@ Now you can run `doing import --type timing -s SECTION PATH`, where SECTION is t
 
 #### Interactive Usage
 
-If you have `fzf` installed (<https://github.com/junegunn/fzf>), you can use `doing select` to get a menu of all your items (or items in a given section) which can be searched with fuzzy matching. The menu allows multiple selections to be acted on directly.
+FuzzyFileFinder (`fzf`) is included with doing (<https://github.com/junegunn/fzf>), and you can use `doing select` to get a menu of all your items (or items in a given section) which can be searched with fuzzy matching. The menu allows multiple selections to be acted on directly.
+
+To use the menu, type a search string or use the arrow keys to navigate up and down. Tip: searching is "fuzzy" by default, but you can start your search with a single quote (`'`) to force an exact match. Press tab on an entry you'd like to perform an action on. A marker will show up on the left indicating the entry is selected. Repeat the process and select as many entries as needed. When you hit Return, the selection will be passed back to doing. Use Control-A to select all visible entries.
 
-To use the menu, type a search string or use the arrow keys to navigate up and down. Press tab on an entry you'd like to perform an action on. A marker will show up on the left indicating the entry is selected. Repeat the process and select as many entries as needed. When you hit Return, the selection will be passed back to doing.
+Doing can perform several functions with this menu. Not all of doing's features are available, but the core functionality you'd need is there, plus you can open the selected entries on one page in your text editor, make changes to them, and when you save and close the entries are updated accordingly. This allows editing of everything from timestamps to tags to notes.
 
-Doing can perform several functions with this menu. Not all of doing's features are available, but the core functionality you'd need is there, plus you can open all selected entries in your editor, make changes to them, and when you save and close the entries are updated accordingly. This allows editing of everything from timestamps to tags to notes.
+If no actions are specified, an interactive menu of options will be
+presented.
 
 Run `doing help select` for a list of options:
 
@@ -634,13 +637,19 @@ Run `doing help select` for a list of options:
     -f, --finish          - Add @done with current time to selected item(s)
     --flag                - Add flag to selected item(s)
     -m, --move=SECTION    - Move selected items to section (default: none)
+    -o, --output=FORMAT   - Output format for export (doing|taskpaper|csv|html|json|template|timeline) (default: none)
+    -q, --query=QUERY     - Initial search query for filtering (default: none)
+    -r, --remove          - Reverse -c, -f, --flag, and -t (remove instead of adding)
     -s, --section=SECTION - Select from a specific section (default: none)
+    --save_to=FILE        - Save selected entries to file using --output format (default: none)
     -t, --tag=TAG         - Tag selected entries (default: none)
 
 For example, `doing select -d -a` would present the menu, and then mark selected entries as @done (with timestamp) and move them to the Archive section.
 
 Multiple actions can be performed at once by combining options. You can also combine the `--editor` switch with any other options. Other actions will be performed first, then the entries --- with any modifications performed --- will be presented in the editor for tweaking.
 
+**Note:** when using the `--editor` flag to open selections in your text editor, entries will be separated by `---` lines. These must remain in place for doing to track the changes. You can do anything you want to the entries, modify dates, change text, add notes, etc., as long as you leave the dividers in place. You can even delete an entry entirely, leaving the dividers around the missing line and the entry will be removed from your doing file when you save and exit the editor.
+
 ---
 
 ## Extras

data/bin/doing

@@ -257,9 +257,9 @@ command :template do |c|
 end
 
 desc 'Display an interactive menu to perform operations (requires fzf)'
-long_desc 'Requires that `fzf` be installed and available in your path. <https://github.com/junegunn/fzf>
+long_desc 'List all entries and select with typeahead fuzzy matching.
 
-List all entries and select with typeahead fuzzy matching. Multiple selections are allowed, hit tab to add the highlighted entry to the selection. Return processes the selected entries.'
+Multiple selections are allowed, hit tab to add the highlighted entry to the selection. Return processes the selected entries.'
 command :select do |c|
   c.desc 'Select from a specific section'
   c.arg_name 'SECTION'
@@ -269,6 +269,9 @@ command :select do |c|
   c.arg_name 'TAG'
   c.flag %i[t tag]
 
+  c.desc 'Reverse -c, -f, --flag, and -t (remove instead of adding)'
+  c.switch %i[r remove], negatable: false
+
   # c.desc 'Add @done to selected item(s), using start time of next item as the finish time'
   # c.switch %i[a auto], negatable: false, default_value: false
 
@@ -279,6 +282,10 @@ command :select do |c|
   c.arg_name 'SECTION'
   c.flag %i[m move]
 
+  c.desc 'Initial search query for filtering'
+  c.arg_name 'QUERY'
+  c.flag %i[q query]
+
   c.desc 'Cancel selected items (add @done without timestamp)'
   c.switch %i[c cancel], negatable: false, default_value: false
 
@@ -294,9 +301,15 @@ command :select do |c|
   c.desc 'Add flag to selected item(s)'
   c.switch %i[flag], negatable: false, default_value: false
 
+  c.desc 'Save selected entries to file using --output format'
+  c.arg_name 'FILE'
+  c.flag %i[save_to]
+
+  c.desc 'Output format for export (doing|taskpaper|csv|html|json|template|timeline)'
+  c.arg_name 'FORMAT'
+  c.flag %i[o output], must_match: /^(?:doing|taskpaper|html|csv|json|template|timeline)$/i
+
   c.action do |_global_options, options, args|
-    section = options[:section] || 'All'
-    edit = options[:editor]
     wwid.interactive(options)
   end
 end

data/lib/doing/helpers.rb

@@ -92,7 +92,7 @@ class ::String
   def link_urls(opt = {})
     opt[:format] ||= :html
     if opt[:format] == :html
-      gsub(%r{(?mi)((http|https)://)?([\w\-_]+(\.[\w\-_]+)+)([\w\-.,@?^=%&:/~+#]*[\w\-@^=%&/~+#])?}) do |_match|
+      gsub(%r{(?mi)((http|https)://)([\w\-_]+(\.[\w\-_]+)+)([\w\-.,@?^=%&:/~+#]*[\w\-@^=%&/~+#])?}) do |_match|
         m = Regexp.last_match
         proto = m[1].nil? ? 'http://' : ''
         %(<a href="#{proto}#{m[0]}" title="Link to #{m[0]}">[#{m[3]}]</a>)

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '1.0.74'
+  VERSION = '1.0.79'
 end

data/lib/doing/wwid.rb

@@ -300,7 +300,7 @@ class WWID
       tmpfile.unlink
     end
 
-    input.split(/\n/).delete_if {|line| line =~ /^#/ }.join("\n").strip
+    input.split(/\n/).delete_if {|line| line =~ /^#/ }.join("\n")
   end
 
   #
@@ -462,7 +462,7 @@ class WWID
   ## @return     (Bool) yes or no
   ##
   def yn(question, default_response: false)
-    default = default_response ? 'y' : 'n'
+    default = default_response ? default_response : 'n'
 
     # if this isn't an interactive shell, answer default
     return default.downcase == 'y' unless $stdout.isatty
@@ -766,6 +766,22 @@ class WWID
     all_items.max_by { |item| item['date'] }
   end
 
+  ##
+  ## @brief      Generate a menu of options and allow user selection
+  ##
+  ## @return     (String) The selected option
+  ##
+  def choose_from(options, prompt)
+    puts prompt
+    options.each_with_index do |section, i|
+      puts format('% 3d: %s', i + 1, section)
+    end
+    print "#{colors['green']}> #{colors['default']}"
+    num = STDIN.gets
+    return false if num =~ /^[a-z ]*$/i
+
+    options[num.to_i - 1]
+  end
 
   ##
   ## @brief      Display an interactive menu of entries
@@ -773,7 +789,7 @@ class WWID
   ## @param      opt   (Hash) Additional options
   ##
   def interactive(opt = {})
-    exit_now! "Select command requires that fzf be installed" unless exec_available('fzf')
+    fzf = File.join(File.dirname(__FILE__), '../helpers/fuzzyfilefinder')
 
     section = opt[:section] ? guess_section(opt[:section]) : 'All'
 
@@ -807,7 +823,7 @@ class WWID
       out.join('')
     end
 
-    res = `echo #{Shellwords.escape(options.join("\n"))}|fzf -m`
+    res = `echo #{Shellwords.escape(options.join("\n"))}|#{fzf} --header="Arrows to navigate, tab to mark for selection, enter to perform action" --prompt="Select entries to act on> " -m --bind ctrl-a:select-all -q "#{opt[:query]}"`
     selected = []
     res.split(/\n/).each do |item|
       idx = item.match(/^(\d+)\)/)[1].to_i
@@ -819,6 +835,68 @@ class WWID
       return
     end
 
+    actions = %i[editor delete tag flag finish cancel tag archive output save_to]
+    has_action = false
+    actions.each do |a|
+      if opt[a]
+        has_action = true
+        break
+      end
+    end
+
+    unless has_action
+      action = choose_from(
+                           [
+                            "add tag",
+                            "remove tag",
+                            "archive",
+                            "cancel",
+                            "delete",
+                            "edit",
+                            "finish",
+                            "flag",
+                            "move",
+                            "output format"
+                          ],
+                            'What do you want to do with the selected items?')
+      case action
+      when /(add|remove) tag/
+        print "Enter tag: "
+        tag = STDIN.gets
+        return if tag =~ /^ *$/
+        opt[:tag] = tag.strip
+        opt[:remove] = true if action =~ /remove tag/
+      when /output format/
+        output_format = choose_from(%w[doing taskpaper json timeline html csv], 'Which output format?')
+        return if tag =~ /^ *$/
+        opt[:output] = output_format.strip
+        res = yn("Save to file?", default_response: 'n')
+        if res
+          print "File path/name: "
+          filename = STDIN.gets.strip
+          return if filename.empty?
+          opt[:save_to] = filename
+        end
+      when /archive/
+        opt[:archive] = true
+      when /delete/
+        opt[:delete] = true
+      when /edit/
+        opt[:editor] = true
+      when /finish/
+        opt[:finish] = true
+      when /cancel/
+        opt[:cancel] = true
+      when /move/
+        section = choose_section.strip
+        return if section =~ /^ *$/
+        opt[:move] = section.strip
+      when /flag/
+        opt[:flag] = true
+      end
+    end
+
+
     if opt[:delete]
       res = yn("Delete #{selected.size} items?", default_response: 'y')
       if res
@@ -830,17 +908,35 @@ class WWID
 
     if opt[:flag]
       tag = @config['marker_tag'] || 'flagged'
-      selected.map! {|item| tag_item(item, tag, date: false) }
+      selected.map! do |item|
+        if opt[:remove]
+          untag_item(item, tag)
+        else
+          tag_item(item, tag, date: false)
+        end
+      end
     end
 
     if opt[:finish] || opt[:cancel]
       tag = 'done'
-      selected.map! {|item| tag_item(item, tag, date: !opt[:cancel])}
+      selected.map! do |item|
+        if opt[:remove]
+          untag_item(item, tag)
+        else
+          tag_item(item, tag, date: !opt[:cancel])
+        end
+      end
     end
 
     if opt[:tag]
       tag = opt[:tag]
-      selected.map! {|item| tag_item(item, tag, date: false)}
+      selected.map! do |item|
+        if opt[:remove]
+          untag_item(item, tag)
+        else
+          tag_item(item, tag, date: false)
+        end
+      end
     end
 
     if opt[:archive] || opt[:move]
@@ -860,13 +956,17 @@ class WWID
         editable += "\n#{old_note}" unless old_note.nil?
         editable_items << editable
       end
+      divider = "\n-----------\n"
+      input = editable_items.map(&:strip).join(divider) + "\n\n# You may delete entries, but leave all divider lines in place"
 
-      new_items = fork_editor(editable_items.join("\n---\n") + "\n\n# You may delete entries, but leave all --- lines in place").split(/\n---\n/)
+      new_items = fork_editor(input).split(/#{divider}/)
 
       new_items.each_with_index do |new_item, i|
+
         input_lines = new_item.split(/[\n\r]+/).delete_if {|line| line =~ /^#/ || line =~ /^\s*$/ }
         title = input_lines[0]&.strip
-        if title.nil? || title =~ /^---$/ || title.strip.empty?
+
+        if title.nil? || title =~ /^#{divider.strip}$/ || title.strip.empty?
           delete_item(selected[i])
         else
           note = input_lines.length > 1 ? input_lines[1..-1] : []
@@ -880,13 +980,47 @@ class WWID
           item = selected[i].dup
           item['title'] = title
           item['note'] = note
-          item['date'] = Time.parse(date)
+          item['date'] = Time.parse(date) || selected[i]['date']
           update_item(selected[i], item)
         end
       end
 
       write(@doing_file)
     end
+
+    if opt[:output]
+      selected.map! do |item|
+        item['title'] = "#{item['title']} @project(#{item['section']})"
+        item
+      end
+
+      @content = {'Export' => {'original' => 'Export:', 'items' => selected}}
+      options = {section: 'Export'}
+
+      if opt[:output] !~ /(doing|taskpaper)/
+        options[:output] = opt[:output]
+      else
+        options[:template] = '- %date | %title%note'
+      end
+
+      output = list_section(options)
+
+      if opt[:save_to]
+        file = File.expand_path(opt[:save_to])
+        if File.exist?(file)
+          # Create a backup copy for the undo command
+          FileUtils.cp(file, "#{file}~")
+        end
+
+        File.open(file, 'w+') do |f|
+          f.puts output
+        end
+
+        @results.push("Export saved to #{file}")
+      else
+        puts output
+      end
+    end
   end
 
   ##
@@ -1068,6 +1202,33 @@ class WWID
     @content[section]['items'] = section_items
   end
 
+  ##
+  ## @brief      Remove a tag on an item from the index
+  ##
+  ## @param      old_item  (Item) The item to tag
+  ## @param      tag       (string) The tag to remove
+  ##
+  def untag_item(old_item, tags)
+    title = old_item['title'].dup
+    if tags.is_a? ::String
+      tags = tags.split(/ *, */).map {|t| t.strip.gsub(/\*/,'[^ (]*') }
+    end
+
+    tags.each do |tag|
+      if title =~ /@#{tag}/
+        title.chomp!
+        title.gsub!(/ +@#{tag}(\(.*?\))?/, '')
+        new_item = old_item.dup
+        new_item['title'] = title
+        update_item(old_item, new_item)
+        return new_item
+      else
+        @results.push(%(Item isn't tagged @#{tag}: "#{title}" in #{old_item['section']}))
+        return old_item
+      end
+    end
+  end
+
   ##
   ## @brief      Tag an item from the index
   ##
@@ -1075,23 +1236,29 @@ class WWID
   ## @param      tag       (string) The tag to apply
   ## @param      date      (Boolean) Include timestamp?
   ##
-  def tag_item(old_item, tag, date: false)
+  def tag_item(old_item, tags, remove: false, date: false)
     title = old_item['title'].dup
+    if tags.is_a? ::String
+      tags = tags.split(/ *, */).map(&:strip)
+    end
+
     done_date = Time.now
-    if title !~ /@#{tag}/
-      title.chomp!
-      if date
-        title += " @#{tag}(#{done_date.strftime('%F %R')})"
+    tags.each do |tag|
+      if title !~ /@#{tag}/
+        title.chomp!
+        if date
+          title += " @#{tag}(#{done_date.strftime('%F %R')})"
+        else
+          title += " @#{tag}"
+        end
+        new_item = old_item.dup
+        new_item['title'] = title
+        update_item(old_item, new_item)
+        return new_item
       else
-        title += " @#{tag}"
+        @results.push(%(Item already @#{tag}: "#{title}" in #{old_item['section']}))
+        return old_item
       end
-      new_item = old_item.dup
-      new_item['title'] = title
-      update_item(old_item, new_item)
-      return new_item
-    else
-      @results.push(%(Item already @#{tag}: "#{title}" in #{old_item['section']}))
-      return old_item
     end
   end
 
@@ -1305,10 +1472,10 @@ class WWID
       if File.exist?(file)
         # Create a backup copy for the undo command
         FileUtils.cp(file, "#{file}~")
+      end
 
-        File.open(file, 'w+') do |f|
-          f.puts output
-        end
+      File.open(file, 'w+') do |f|
+        f.puts output
       end
 
       if @config.key?('run_after')
@@ -1522,13 +1689,16 @@ class WWID
         note ||= ''
 
         tags = []
+        attributes = {}
         skip_tags = %w[meanwhile done cancelled flagged]
         i['title'].scan(/@([^(\s]+)(?:\((.*?)\))?/).each do |tag|
           tags.push(tag[0]) unless skip_tags.include?(tag[0])
+          attributes[tag[0]] = tag[1] if tag[1]
         end
+
         if opt[:output] == 'json'
 
-          items_out << {
+          i = {
             date: i['date'],
             end_date: end_date,
             title: title.strip, #+ " #{note}"
@@ -1537,6 +1707,10 @@ class WWID
             tags: tags
           }
 
+          attributes.each { |attr, val| i[attr.to_sym] = val }
+
+          items_out << i
+
         elsif opt[:output] == 'timeline'
           new_item = {
             'id' => index + 1,
@@ -1640,7 +1814,7 @@ class WWID
 
       totals = opt[:totals] ? tag_times('html', opt[:sort_tags]) : ''
       engine = Haml::Engine.new(template)
-      puts engine.render(Object.new,
+      out = engine.render(Object.new,
                          { :@items => items_out, :@page_title => page_title, :@style => style, :@totals => totals })
     else
       items.each do |item|
@@ -1652,11 +1826,12 @@ class WWID
           reset = ''
         end
 
-        if (item.has_key?('note') && !item['note'].empty?) && @config[:include_notes]
+        if (item.key?('note') && !item['note'].empty?) && @config[:include_notes]
           note_lines = item['note'].delete_if do |line|
-                         line =~ /^\s*$/
-                       end.map { |line| "\t\t" + line.sub(/^\t*/, '').sub(/^-/, '—') + '  ' }
-          if opt[:wrap_width] && opt[:wrap_width] > 0
+            line =~ /^\s*$/
+          end
+          note_lines.map! { |line| "\t\t#{line.sub(/^\t*/, '').sub(/^-/, '—')}  " }
+          if opt[:wrap_width]&.positive?
             width = opt[:wrap_width]
             note_lines.map! do |line|
               line.strip.gsub(/(.{1,#{width}})(\s+|\Z)/, "\t\\1\n")
@@ -1669,7 +1844,7 @@ class WWID
         output = opt[:template].dup
 
         output.gsub!(/%[a-z]+/) do |m|
-          if colors.has_key?(m.sub(/^%/, ''))
+          if colors.key?(m.sub(/^%/, ''))
             colors[m.sub(/^%/, '')]
           else
             m

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 1.0.74
+  version: 1.0.79
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -168,6 +168,7 @@ files:
 - lib/doing/helpers.rb
 - lib/doing/version.rb
 - lib/doing/wwid.rb
+- lib/helpers/fuzzyfilefinder
 - lib/templates/doing.css
 - lib/templates/doing.haml
 homepage: http://brettterpstra.com/project/doing/