doing 1.0.70 → 1.0.72

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10dc5d92f3e7079a9525d39c47fe0f69ef22f64ae5400cd9da1925f9b0fc1964
-  data.tar.gz: ec08df722ce07bbfcee808bfd4bd9eabe5470ef173f5d11e47fc52356b2c2c95
+  metadata.gz: 8ab378bf9ba26ec5c6f852afa702d74bd8323bb9e4aca92e3e94b081c578b637
+  data.tar.gz: 1c868eb6ac0dbb438f69679abfcb2fc587465ce9848c4da607f537b8c98d60ca
 SHA512:
-  metadata.gz: c56a9a328d2ed31e70633333be5f7666d9586154fba7cc59f34116f1a972156fb4dd7d087e59452bf860167e618dad815da8a113fe0e4cf9f12faafa98d68d72
-  data.tar.gz: 3152021d8017af18e4046736f1f994bd1821f95bece924ca9ad78de997ad3473cbfd411389ede1dfe6313a1c4fde3debdc9907f3f2da899b1bab823a02a932e7
+  metadata.gz: 257898f624de2463259c5b49e46bc1687edf56f428aa16d297d212554efabbff82f59f0ae98da9772fc1aa30673623d70a2903326dca6ffd510d6afec846ff43
+  data.tar.gz: f635bc6bbb42de40a4f5bdcd1abd1d4caeec1a94af7553f1bcff1d0fffcda6898c248941a38f7abfba807721a18d39fd1632d0ec228c56b940c502f036ac7f19

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.69<!--END VER-->.
+The current version of `doing` is <!--VER-->1.0.70<!--END VER-->.
 
     $ [sudo] gem install doing
 
@@ -617,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|

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '1.0.70'
+  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
   ##
@@ -904,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']
 
@@ -2005,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 1.0.70
+  version: 1.0.72
 platform: ruby
 authors:
 - Brett Terpstra