doing 1.0.67 → 1.0.72

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2adffea75d109f047bd36b1ce55c48b83bc61a5d05d2060ece89fc8041faaabd
-  data.tar.gz: 546e1c04bf9f0b319905e21a0aadb4ce9afb2eee8c49b7e8bc551d589d4f75d0
+  metadata.gz: 8ab378bf9ba26ec5c6f852afa702d74bd8323bb9e4aca92e3e94b081c578b637
+  data.tar.gz: 1c868eb6ac0dbb438f69679abfcb2fc587465ce9848c4da607f537b8c98d60ca
 SHA512:
-  metadata.gz: 34db37e7c5974f97bad9516970bccb8d1a3b28bd0eefec7fbbf57628137cd763fc5f5473c85cee05334088f64d8a7f8621d1bd6f41fc694ad4534569e3360313
-  data.tar.gz: 510d4f38fbe89ba480aedf9f8845c99f33c7265c1f852be76151f75aed6e10fee49e9912e1b1161f6ebbd5b7b98889663e289136fe9e63828b71544c0b1fcd7c
+  metadata.gz: 257898f624de2463259c5b49e46bc1687edf56f428aa16d297d212554efabbff82f59f0ae98da9772fc1aa30673623d70a2903326dca6ffd510d6afec846ff43
+  data.tar.gz: f635bc6bbb42de40a4f5bdcd1abd1d4caeec1a94af7553f1bcff1d0fffcda6898c248941a38f7abfba807721a18d39fd1632d0ec228c56b940c502f036ac7f19

data/README.md

@@ -25,11 +25,9 @@ While I'm working, I have hourly reminders to record what I'm working on, and I
 
 If there's something I want to look at later but doesn't need to be added to a task list or tracker, I can type `doing later check out the pinboard bookmarks from macdrifter`. When I get back to my computer --- or just need a refresher after a distraction --- I can type `doing last` to see what the last thing on my plate was. I can also type `doing recent` (or just `doing`) to get a list of the last few entries. `doing today` gives me everything since midnight for the current day, making it easy to see what I've accomplished over a sleepless night.
 
-_Side note:_ I actually use the library behind this utility as part of another script that mirrors entries in [Day One](http://dayoneapp.com) that have the tag `wwid`. I can use the hourly writing reminders and enter my stuff in the quick entry popup. Someday I'll get around to cleaning that up and putting it out there.
-
 ## Installation
 
-The current version of `doing` is <!--VER-->1.0.66<!--END VER-->.
+The current version of `doing` is <!--VER-->1.0.70<!--END VER-->.
 
     $ [sudo] gem install doing
 
@@ -464,6 +462,7 @@ You can also include a `--no-date` switch to add `@done` without a finish date,
 
 By default `doing finish` works on a single entry, the last entry or the most recent entry matching a `--tag` or `--search` query. Specifying `doing finish 10` would finish any unfinished entries within the last 10 entries. In the case of `--tag` or `--search` queries, the count serves as the maximum number of matches doing will act on, sorted in reverse date order (most recent first). A count of 0 will disable the limit entirely, acting on all matching entries.
 
+Both `finish` and `cancel` accept `--unfinished` as an argument. This causes them to act on the last entry not already marked @done, no matter how far back it's dated or how many @done entries come after it. You can use `doing finish --unfinished X -s SECTION` to finish the last X unfinished entries in SECTION.
 
 ##### Tagging and Autotagging
 
@@ -618,6 +617,30 @@ Now you can run `doing import --type timing -s SECTION PATH`, where SECTION is t
     # Import to default section (Currently) and prefix entries with '[Imported]'
     doing import --prefix="[Imported]" "~/Desktop/All Activities.json"
 
+#### 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.
+
+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 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.
+
+Run `doing help select` for a list of options:
+
+    -a, --archive         - Archive selected items
+    -c, --cancel          - Cancel selected items (add @done without timestamp)
+    -d, --delete          - Delete selected items
+    -e, --editor          - Edit selected item(s)
+    -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)
+    -s, --section=SECTION - Select from a specific section (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.
+
 ---
 
 ## Extras

data/bin/doing

@@ -245,7 +245,7 @@ command :template do |c|
   c.action do |_global_options, options, args|
     raise 'No type specified, use `doing template [HAML|CSS]`' if args.empty?
 
-    case options[:t]
+    case args[0]
     when /html|haml/i
       $stdout.puts wwid.haml_template
     when /css/i
@@ -256,6 +256,51 @@ command :template do |c|
   end
 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>
+
+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.'
+command :select do |c|
+  c.desc 'Select from a specific section'
+  c.arg_name 'SECTION'
+  c.flag %i[s section]
+
+  c.desc 'Tag selected entries'
+  c.arg_name 'TAG'
+  c.flag %i[t tag]
+
+  # 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
+
+  c.desc 'Archive selected items'
+  c.switch %i[a archive], negatable: false, default_value: false
+
+  c.desc 'Move selected items to section'
+  c.arg_name 'SECTION'
+  c.flag %i[m move]
+
+  c.desc 'Cancel selected items (add @done without timestamp)'
+  c.switch %i[c cancel], negatable: false, default_value: false
+
+  c.desc 'Delete selected items'
+  c.switch %i[d delete], negatable: false, default_value: false
+
+  c.desc 'Edit selected item(s)'
+  c.switch %i[e editor], negatable: false, default_value: false
+
+  c.desc 'Add @done with current time to selected item(s)'
+  c.switch %i[f finish], negatable: false, default_value: false
+
+  c.desc 'Add flag to selected item(s)'
+  c.switch %i[flag], negatable: false, default_value: false
+
+  c.action do |_global_options, options, args|
+    section = options[:section] || 'All'
+    edit = options[:editor]
+    wwid.interactive(options)
+  end
+end
+
 desc 'Add an item to the Later section'
 arg_name 'ENTRY'
 command :later do |c|
@@ -368,7 +413,7 @@ command %i[done did] do |c|
 
       date = options[:took] ? finish_date - took : finish_date
     elsif options[:took]
-      finish_date = options[:back] ? date + took : nil
+      finish_date = date + took
     elsif options[:back]
       finish_date = date
     else
@@ -446,6 +491,9 @@ command :cancel do |c|
   c.arg_name 'BOOLEAN'
   c.flag [:bool], must_match: /(?:and|all|any|or|not|none)/i, default_value: 'AND'
 
+  c.desc 'Cancel last entry (or entries) not already marked @done'
+  c.switch %i[u unfinished], negatable: false, default_value: false
+
   c.action do |_global_options, options, args|
     section = wwid.guess_section(options[:s]) || options[:s].cap_first
 
@@ -478,7 +526,8 @@ command :cancel do |c|
       sequential: false,
       tag: tags,
       tag_bool: options[:bool],
-      tags: ['done']
+      tags: ['done'],
+      unfinished: options[:unfinished]
     }
     wwid.tag_last(opts)
   end
@@ -512,6 +561,9 @@ command :finish do |c|
   c.arg_name 'BOOLEAN'
   c.flag [:bool], must_match: /(?:and|all|any|or|not|none)/i, default_value: 'AND'
 
+  c.desc 'Finish last entry (or entries) not already marked @done'
+  c.switch %i[u unfinished], negatable: false, default_value: false
+
   c.desc %(Auto-generate finish dates from next entry's start time.
   Automatically generate completion dates 1 minute before next start date.
   --auto overrides the --date and --back parameters.)
@@ -574,7 +626,8 @@ command :finish do |c|
       sequential: options[:auto],
       tag: tags,
       tag_bool: options[:bool],
-      tags: ['done']
+      tags: ['done'],
+      unfinished: options[:unfinished]
     }
     wwid.tag_last(opts)
   end
@@ -648,6 +701,9 @@ command :tag do |c|
   c.desc 'Remove given tag(s)'
   c.switch %i[r remove], negatable: false, default_value: false
 
+  c.desc 'Tag last entry (or entries) not marked @done'
+  c.switch %i[u unfinished], negatable: false, default_value: false
+
   c.desc 'Autotag entries based on autotag configuration in ~/.doingrc'
   c.switch %i[a autotag], negatable: false, default_value: false
 
@@ -691,7 +747,8 @@ command :tag do |c|
       date: options[:date],
       remove: options[:r],
       section: section,
-      tags: tags
+      tags: tags,
+      unfinished: options[:unfinished]
     }
     wwid.tag_last(opts)
   end
@@ -706,9 +763,17 @@ command [:mark, :flag] do |c|
   c.desc 'Remove mark'
   c.switch %i[r remove], negatable: false, default_value: false
 
+  c.desc 'Mark last entry not marked @done'
+  c.switch %i[u unfinished], negatable: false, default_value: false
+
   c.action do |_global_options, options, _args|
     mark = wwid.config['marker_tag'] || 'flagged'
-    wwid.tag_last({ tags: [mark], section: options[:s], remove: options[:r] })
+    wwid.tag_last({
+      remove: options[:r],
+      section: options[:s],
+      tags: [mark],
+      unfinished: options[:unfinished]
+    })
   end
 end
 
@@ -737,7 +802,7 @@ command :show do |c|
 
   c.desc 'Sort order (asc/desc)'
   c.arg_name 'ORDER'
-  c.flag %i[s sort], must_match: /^(?:a|d)/i, default_value: 'ASC'
+  c.flag %i[s sort], must_match: /^[ad].*/i, default_value: 'ASC'
 
   c.desc %(
     Date range to show, or a single day to filter date on.

data/lib/doing/helpers.rb

@@ -6,6 +6,7 @@ class ::Hash
     tags = tags.split(/ *, */) if tags.is_a? String
     bool = bool.normalize_bool if bool.is_a? String
     item = self
+    tags.map! {|t| t.strip.sub(/^@/, '')}
     case bool
     when :and
       result = true

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '1.0.67'
+  VERSION = '1.0.72'
 end

data/lib/doing/wwid.rb

@@ -3,6 +3,7 @@
 require 'deep_merge'
 require 'open3'
 require 'pp'
+require 'shellwords'
 
 ##
 ## @brief      Main "What Was I Doing" methods
@@ -318,8 +319,8 @@ class WWID
 
     note = input_lines.length > 1 ? input_lines[1..-1] : []
     # If title line ends in a parenthetical, use that as the note
-    if note.empty? && title =~ /\(.*?\)$/
-      title.sub!(/\((.*?)\)$/) do
+    if note.empty? && title =~ /\s+\(.*?\)$/
+      title.sub!(/\s+\((.*?)\)$/) do
         m = Regexp.last_match
         note.push(m[1])
         ''
@@ -765,6 +766,129 @@ class WWID
     all_items.max_by { |item| item['date'] }
   end
 
+
+  ##
+  ## @brief      Display an interactive menu of entries
+  ##
+  ## @param      opt   (Hash) Additional options
+  ##
+  def interactive(opt = {})
+    raise "Select command requires that fzf be installed" unless exec_available('fzf')
+
+    section = opt[:section] ? guess_section(opt[:section]) : 'All'
+
+
+    if section =~ /^all$/i
+      combined = { 'items' => [] }
+      @content.each do |_k, v|
+        combined['items'] += v['items']
+      end
+      items = combined['items'].dup.sort_by { |item| item['date'] }.reverse
+    else
+      items = @content[section]['items']
+    end
+
+
+    options = items.map.with_index do |item, i|
+      out = [
+        i,
+        ') ',
+        item['date'],
+        ' | ',
+        item['title'],
+      ]
+      if opt[:section] =~ /^all/i
+        out.concat([
+          ' (',
+          item['section'],
+          ') '
+        ])
+      end
+      out.join('')
+    end
+
+    res = `echo #{Shellwords.escape(options.join("\n"))}|fzf -m`
+    selected = []
+    res.split(/\n/).each do |item|
+      idx = item.match(/^(\d+)\)/)[1].to_i
+      selected.push(items[idx])
+    end
+
+    if selected.empty?
+      @results.push("No selection")
+      return
+    end
+
+    if opt[:delete]
+      res = yn("Delete #{selected.size} items?", default_response: 'y')
+      if res
+        selected.each {|item| delete_item(item) }
+        write(@doing_file)
+      end
+      return
+    end
+
+    if opt[:flag]
+      tag = @config['marker_tag'] || 'flagged'
+      selected.map! {|item| tag_item(item, tag, date: false) }
+    end
+
+    if opt[:finish] || opt[:cancel]
+      tag = 'done'
+      selected.map! {|item| tag_item(item, tag, date: !opt[:cancel])}
+    end
+
+    if opt[:tag]
+      tag = opt[:tag]
+      selected.map! {|item| tag_item(item, tag, date: false)}
+    end
+
+    if opt[:archive] || opt[:move]
+      section = opt[:archive] ? 'Archive' : guess_section(opt[:move])
+      selected.map! {|item| move_item(item, section) }
+    end
+
+    write(@doing_file)
+
+    if opt[:editor]
+
+      editable_items = []
+
+      selected.each do |item|
+        editable = "#{item['date']} | #{item['title']}"
+        old_note = item['note'] ? item['note'].map(&:strip).join("\n") : nil
+        editable += "\n#{old_note}" unless old_note.nil?
+        editable_items << editable
+      end
+
+      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.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?
+          delete_item(selected[i])
+        else
+          note = input_lines.length > 1 ? input_lines[1..-1] : []
+
+          note.map!(&:strip)
+          note.delete_if { |line| line =~ /^\s*$/ || line =~ /^#/ }
+
+          date = title.match(/^([\d\-: ]+) \| /)[1]
+          title.sub!(/^([\d\-: ]+) \| /, '')
+
+          item = selected[i].dup
+          item['title'] = title
+          item['note'] = note
+          item['date'] = Time.parse(date)
+          update_item(selected[i], item)
+        end
+      end
+
+      write(@doing_file)
+    end
+  end
+
   ##
   ## @brief      Tag the last entry or X entries
   ##
@@ -781,6 +905,7 @@ class WWID
     opt[:autotag] ||= false
     opt[:back] ||= false
     opt[:took] ||= nil
+    opt[:unfinished] ||= false
 
     sec_arr = []
 
@@ -816,10 +941,11 @@ class WWID
         items.map! do |item|
           break if idx == count
 
+          finished = opt[:unfinished] && item.has_tags?('done', :and)
           tag_match = opt[:tag].nil? || opt[:tag].empty? ? true : item.has_tags?(opt[:tag], opt[:tag_bool])
           search_match = opt[:search].nil? || opt[:search].empty? ? true : item.matches_search?(opt[:search])
 
-          if tag_match && search_match
+          if tag_match && search_match && !finished
             if opt[:autotag]
               new_title = autotag(item['title']) if @auto_tag
               if new_title == item['title']
@@ -832,12 +958,6 @@ class WWID
               if opt[:sequential]
                 done_date = next_start - 1
                 next_start = item['date']
-              elsif opt[:back]
-                if opt[:back].is_a? Integer
-                  done_date = item['date'] + opt[:back]
-                else
-                  done_date = item['date'] + (opt[:back] - item['date'])
-                end
               elsif opt[:took]
                 if item['date'] + opt[:took] > Time.now
                   item['date'] = Time.now - opt[:took]
@@ -845,6 +965,12 @@ class WWID
                 else
                   done_date = item['date'] + opt[:took]
                 end
+              elsif opt[:back]
+                if opt[:back].is_a? Integer
+                  done_date = item['date'] + opt[:back]
+                else
+                  done_date = item['date'] + (opt[:back] - item['date'])
+                end
               else
                 done_date = Time.now
               end
@@ -902,6 +1028,71 @@ class WWID
     write(@doing_file)
   end
 
+  def move_item(item, section)
+    old_section = item['section']
+    new_item = item.dup
+    new_item['section'] = section
+
+    section_items = @content[old_section]['items']
+    section_items.delete(item)
+    @content[old_section]['items'] = section_items
+
+    archive_items = @content[section]['items']
+    archive_items.push(new_item)
+    # archive_items = archive_items.sort_by { |item| item['date'] }
+    @content[section]['items'] = archive_items
+
+    @results.push("Entry moved to #{section}: #{new_item['title']}")
+    return new_item
+  end
+
+  ##
+  ## @brief      Delete an item from the index
+  ##
+  ## @param      old_item
+  ##
+  def delete_item(old_item)
+    section = old_item['section']
+
+    section_items = @content[section]['items']
+    deleted = section_items.delete(old_item)
+    @results.push("Entry deleted: #{deleted['title']}")
+    @content[section]['items'] = section_items
+  end
+
+  ##
+  ## @brief      Tag an item from the index
+  ##
+  ## @param      old_item  (Item) The item to tag
+  ## @param      tag       (string) The tag to apply
+  ## @param      date      (Boolean) Include timestamp?
+  ##
+  def tag_item(old_item, tag, date: false)
+    title = old_item['title'].dup
+    done_date = Time.now
+    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
+      @results.push(%(Item already @#{tag}: "#{title}" in #{old_item['section']}))
+      return old_item
+    end
+  end
+
+  ##
+  ## @brief      Update an item in the index with a modified item
+  ##
+  ## @param      old_item  The old item
+  ## @param      new_item  The new item
+  ##
   def update_item(old_item, new_item)
     section = old_item['section']
 
@@ -2003,4 +2194,12 @@ EOS
     minutes = (minutes % 60).to_i
     [days, hours, minutes]
   end
+
+  def exec_available(cli)
+    if File.exists?(File.expand_path(cli))
+      File.executable?(File.expand_path(cli))
+    else
+      system "which #{cli}", :out => File::NULL, :err => File::NULL
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 1.0.67
+  version: 1.0.72
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake