doing 1.0.22 → 1.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73e09fb9dbc14de53c2464dba86178c402ecdba46d89873d83aea2abe97e1454
-  data.tar.gz: d8c1d0a5762a7fbef26522f1664414538647a6fd5b4b5f466844b4a1503cad98
+  metadata.gz: 6d74d1d69c6dbae627fc25dc8c14a8e8bff95072fdc2f1b1761ab6186c7c0a26
+  data.tar.gz: e17b0df1b7c2122c0d8ae33290ccf7e2763cf3e143acf0b60af061b8302c83d2
 SHA512:
-  metadata.gz: 968381dd7b6c260a550f6dad755a54f2388baaaaa84ace9a7ea1feafad92b889db04b3084f8236296c4b2bca45613abf2f2d11147b9c0afecf9dd21b869fdaac
-  data.tar.gz: f585f589879ea6f4c772a71be98c7d31622eee2c3a6a32b42d268890590f0239fb6755eb75d44bf14cf9d559460190edb0980655c535e75f350970fde1ad11ec
+  metadata.gz: 802dbf09b3b658640c52ca8e3b74f665fb163199bd0a3648f3f7831121e275a062df3ea47c31921b5b4f5390cbd29c3beeb7fa852624d0c00823a61081222cb9
+  data.tar.gz: dea212e53281258c783b0155c3304ada1d26a08db58d27b521d0080c19dec93c40c86f35c086383642d081caf85ac2ecf931a3ad2df927a0c6047cdea6d05b2d

data/README.md

@@ -4,7 +4,6 @@
 
 _If you're one of the rare people like me who find this useful, feel free to [buy me some coffee](http://brettterpstra.com/donate)._
 
-[Changelog](#changelog)
 
 ## Contents
 
@@ -15,6 +14,7 @@ _If you're one of the rare people like me who find this useful, feel free to [bu
 - [Usage](#usage)
 - [Extras](#extras)
 - [Troubleshooting](#troubleshooting)
+- [Changelog](#changelog)
 
 <!-- end toc -->
 
@@ -59,10 +59,15 @@ Notes can be prevented from ever appearing in output with the global option `--n
 A basic configuration looks like this:
 
     ---
-    doing_file: /Users/username/Dropbox/nvALT2.2/?? What was I doing.md
+    doing_file: /Users/username/Dropbox/doing.taskpaper
     current_section: Currently
     default_template: '%date: %title%note'
     default_date_format: '%Y-%m-%d %H:%M'
+    marker_tag: flagged
+    marker_color: yellow
+    default_tags: []
+    editor_app: TextEdit
+    :include_notes: true
     views:
       color:
         date_format: '%F %_I:%M%P'
@@ -88,16 +93,29 @@ A basic configuration looks like this:
         date_format: '%_I:%M%P'
         template: '%date > %title%odnote'
         wrap_width: 50
-    :include_notes: true
+    autotag:
+      whitelist:
+      - coding
+      - design
+      synonyms:
+        brainstorming:
+        - thinking
+        - idea
+    html_template:
+      haml: 
+      css: 
 
 
-  The config file is stored in `~/.doingrc`, and a skeleton file is created on the first run. Just run `doing` on its own to create the file.
+The config file is stored in `~/.doingrc`, and a skeleton file is created on the first run. Just run `doing` on its own to create the file.
 
 ### Per-folder configuration
 
 Any options found in a `.doingrc` anywhere in the hierarchy between your current folder and your home folder will be appended to the base configuration, overriding or extending existing options. This allows you to put a `.doingrc` file into the base of a project and add specific configurations (such as default tags) when working in that project on the command line. These can be cascaded, with the closest `.doingrc` to your current directory taking precedence, though I'm not sure why you'd want to deal with that.
 
-This can also be used to define custom HTML output on a per-project basis using the html_template option for custom templates.
+Possible uses:
+
+- Define custom HTML output on a per-project basis using the html_template option for custom templates. Customize time tracking reports based on project or client.
+- Define `default_tags` for a project so that every time you `doing now` from within that project directory or its subfolders, it gets tagged with that project automatically.
 
 Any part of the configuration can be copied into these local files and modified. You only need to include the parts you want to change or add.
 
@@ -144,7 +162,7 @@ The config also contains templates for various command outputs. Include placehol
     - you can prefix `bg` to affect background colors (`%bgyellow`)
     - prefix `bold` and `boldbg` for strong colors (`%boldgreen`, `%boldbgblue`)
     - there are some random special combo colors. Use `doing colors` to see the list
-- `%interval`: when used with the `-t` switch on the `show` command, it will display the time between a timestamp or `@start(date)` tag and the `@done(date)` tag, if it exists. Otherwise, it will remain empty.
+- `%interval`: when used with the `-t` switch on the `show` command, it will display the time between a timestamp or _@start(date)_ tag and the _@done(date)_ tag, if it exists. Otherwise, it will remain empty.
 
 Date formats are based on Ruby [`strftime`](http://www.ruby-doc.org/stdlib-2.1.1/libdoc/date/rdoc/Date.html#method-i-strftime) formatting.
 
@@ -303,7 +321,7 @@ There are bold variants for both foreground and background colors
     %boldbgred
     ... etc.
 
-And a few special colors you'll just have to try out to see:
+And a few special colors you'll just have to try out to see (or just run `doing colors`):
 
     %softpurple
     %hotpants
@@ -322,6 +340,37 @@ To export the default configurations for customization, use `doing templates --t
 
 Once you have either or both of the template files, edit `.doingrc` and look for the `html_template:` section. There are two subvalues, `haml:` and `css:`. Add the path to the templates you want to use. A tilde may be substituted for your home directory, e.g. `css: ~/styles/doing.css`.
 
+### Autotagging
+
+Keywords in your entries can trigger automatic tagging, just to make life easier. There are three tools available: default tags, whitelisting, and synonym tagging.
+
+Default tags are tags that are applied to every entry. You probably don't want to add these in the root configuration, but using a local `.doingrc` in a project directory that defines default tags for that project allows anything added from that directory to be tagged automatically. A local `.doingrc` in my Marked development directory might contain:
+
+    ---
+    default_tags: [marked,coding]
+
+And anything I enter while in the directory gets tagged with _@marked_ and _@coding_.
+
+A whitelist is a list of words that should be converted directly into _@tags_. If my whitelist contains "design" and I type `doing now working on site design`, that's automatically converted to "working on site @design."
+
+Synonyms allow you to define keywords that will trigger their parent tag. If I have a tag called _@design_, I can add "typography" as a synonym. Then entering `doing now working on site typography` will become "working on site typography @design."
+
+White lists and synonyms are defined like this:
+
+    autotag:
+      synonyms:
+        design:
+        - typography
+        - layout
+        brainstorming
+        - thinking
+        - idea
+      whitelist:
+      - brainstorming
+      - coding
+
+Note that you can include a tag with synonyms in the whitelist as well to tag it directly when used.
+
 ## Usage
 
     doing [global options] command [command options] [arguments...]
@@ -350,7 +399,7 @@ The `doing now` command can accept `-s section_name` to send the new entry strai
 
 If you want to use `--back` with `doing done` but want the end time to be different than the start time, you can either use `--took` in addition, or just use `--took` on its own as it will backdate the start time such that the end time is now and the duration is equal to the value of the `--took` argument.
 
-You can finish the last unfinished task when starting a new one using `doing now` with the `-f` switch. It will look for the last task not marked `@done` and add the `@done` tag with the start time of the new task (either the current time or what you specified with `--back`).
+You can finish the last unfinished task when starting a new one using `doing now` with the `-f` switch. It will look for the last task not marked _@done_ and add the _@done_ tag with the start time of the new task (either the current time or what you specified with `--back`).
 
 `doing done` is used to add an entry that you've already completed. Like `now`, you can specify a section with `-s section_name`. You can also skip straight to Archive with `-a`.
 
@@ -360,7 +409,7 @@ When used with `doing done`, `--back` and `--took` allow time intervals to be ac
 
 All of these commands accept a `-e` argument. This opens your command line editor (as defined in the environment variable `$EDITOR`). Add your entry, save the temp file, and close it. The new entry is added. Anything after the first line is included as a note on the entry.
 
-`doing meanwhile` is a special command for creating and finishing tasks that may have other entries come before they're complete. When you create an entry with `doing meanwhile [entry text]`, it will automatically complete the last @meanwhile item (dated `@done` tag) and add the `@meanwhile` tag to the new item. This allows time tracking on a more general basis, and still lets you keep track of the smaller things you do while working on an overarching project. The `meanwhile` command accepts `--back [time]` and will backdate the `@done` tag and start date of the new task at the same time. Running `meanwhile` with no arguments will simply complete the last `@meanwhile` task. 
+`doing meanwhile` is a special command for creating and finishing tasks that may have other entries come before they're complete. When you create an entry with `doing meanwhile [entry text]`, it will automatically complete the last _@meanwhile_ item (dated _@done_ tag) and add the _@meanwhile_ tag to the new item. This allows time tracking on a more general basis, and still lets you keep track of the smaller things you do while working on an overarching project. The `meanwhile` command accepts `--back [time]` and will backdate the _@done_ tag and start date of the new task at the same time. Running `meanwhile` with no arguments will simply complete the last _@meanwhile_ task. 
 
 See `doing help meanwhile` for more options.
 
@@ -372,9 +421,9 @@ See `doing help meanwhile` for more options.
 
 ##### Finishing
 
-`doing finish` by itself is the same as `doing done` by itself. It adds `@done(timestamp)` to the last entry. It also accepts a numeric argument to complete X number of tasks back in history. Add `-a` to also archive the affected entries.
+`doing finish` by itself is the same as `doing done` by itself. It adds _@done(timestamp)_ to the last entry. It also accepts a numeric argument to complete X number of tasks back in history. Add `-a` to also archive the affected entries.
 
-`doing finish` also provides an `--auto` flag, which you can use to set the end time of any entry to 1 minute before the start time of the next. Running a command such as `doing finish --auto 10` will go through the last 10 entries and sequentially update any without a `@done` tag with one set to the time just before the next entry in the list.
+`doing finish` also provides an `--auto` flag, which you can use to set the end time of any entry to 1 minute before the start time of the next. Running a command such as `doing finish --auto 10` will go through the last 10 entries and sequentially update any without a _@done_ tag with one set to the time just before the next entry in the list.
 
 As mentioned above, `finish` also accepts `--back "2 hours"` (sets the finish date from time now minus interval) or `--took 30m` (sets the finish date to time started plus interval) so you can accurately add times to completed tasks, even if you don't do it in the moment.
 
@@ -385,7 +434,7 @@ As mentioned above, `finish` also accepts `--back "2 hours"` (sets the finish da
 
     doing tag -c 3 client cancelled
 
-... will mark the last three entries as `@client @cancelled`. Add `-r` as a switch to remove the listed tags instead.
+... will mark the last three entries as _@client @cancelled_. Add `-r` as a switch to remove the listed tags instead.
 
 You can optionally define keywords for common tasks and projects in your `.doingrc` file. When these keywords appear in an item title, they'll automatically be converted into @tags. The `whitelist` tags are exact (but case insensitive) matches. 
 
@@ -420,20 +469,20 @@ You can also add notes at the time of entry by using the `-n` or `--note` flag w
 
 #### Displaying entries:
 
-    show          - List all entries
-    recent        - List recent entries
-    today         - List entries from today
-    yesterday     - List entries from yesterday
-    last          - Show the last entry
-    grep, search  - Show entries matching text or pattern
+    show      - List all entries
+    recent    - List recent entries
+    today     - List entries from today
+    yesterday - List entries from yesterday
+    last      - Show the last entry
+    grep      - Show entries matching text or pattern
 
 `doing show` on its own will list all entries in the "Currently" section. Add a section name as an argument to display that section instead. Use "all" to display all entries from all sections.
 
-You can filter the `show` command by tags. Simply list them after the section name (or `all`). The boolean defaults to `ANY`, meaning any entry that contains any of the listed tags will be shown. You can use `-b ALL` or `-b NONE` to change the filtering behavior: `doing show all done cancelled -b NONE` will show all tasks from all sections that do not have either `@done` or `@cancelled` tags.
+You can filter the `show` command by tags. Simply list them after the section name (or `all`). The boolean defaults to `ANY`, meaning any entry that contains any of the listed tags will be shown. You can use `-b ALL` or `-b NONE` to change the filtering behavior: `doing show all done cancelled -b NONE` will show all tasks from all sections that do not have either _@done_ or _@cancelled_ tags.
 
 Use `-c X` to limit the displayed results. Combine it with `-a newest` or `-a oldest` to choose which chronological end it trims from. You can also set the sort order of the output with `-s asc` or `-s desc`.
 
-The `show` command can also show the time spent on a task if it has a `@done(date)` tag with the `-t` option. This requires that you include a `%interval` token in template -> default in the config. You can also include `@start(date)` tags, which override the timestamp when calculating the intervals.
+The `show` command can also show the time spent on a task if it has a _@done(date)_ tag with the `-t` option. This requires that you include a `%interval` token in template -> default in the config. You can also include _@start(date)_ tags, which override the timestamp when calculating the intervals.
 
 If you have a use for it, you can use `-o csv` on the show or view commands to output the results as a comma-separated CSV to STDOUT. Redirect to a file to save it: `doing show all done -o csv > ~/Desktop/done.csv`. You can do the same with `-o json`.
 
@@ -481,7 +530,7 @@ You can also use tags to archive. You define the section first, and anything fol
 
 By default, tag archiving uses an `AND` boolean, meaning all the tags listed must exist on the entry for it to be moved. You can change this behavior with `-b OR` or `-b NONE` (`ALL` and `ANY` also work). 
 
-Example: Archive all Currently items for `@client` that are marked `@done`
+Example: Archive all Currently items for _@client_ that are marked _@done_
 
     doing archive @client @done
 
@@ -506,9 +555,7 @@ Pressing Spacebar and typing allows you to add a new entry to currently. You an
 
 Point of interest, the LaunchBar Action makes use of the `-o json` flag for outputting JSON to the action's script for parsing.
 
-<!--{% download 117 %}-->
-
-Download the Action at [brettterpstra.com](https://brettterpstra.com/projects/doing/)
+See <https://brettterpstra.com/projects/doing/> for the download.
 
 Evan Lovely has [created an Alfred workflow as well](http://www.evanlovely.com/blog/technology/alfred-for-terpstras-doing/).
 
@@ -540,9 +587,8 @@ Ruby is rife with encoding inconsistencies across platforms and versions. Feel f
 
 ### Support
 
-I'm not making any money on `doing`, and I don't plan to spend a lot of time fixing errors on an array of operating systems and platforms I don't even have access to. You'll probably have to solve some things on your own.
 
-That said, you can get support from other users (and occasionally me) on GitHub. If you run into a replicatable bug in your environment, please [post an issue](https://github.com/ttscoff/doing/issues) and include your platform, OS version, and the result of `ruby -v`, along with a copy/paste of the error message. To get a more verbose error message, try running `GLI_DEBUG=true doing [...]` for a full trace.
+As a free project, `doing` isn't heavily supported, but you can get support from myself and other users on GitHub. If you run into a replicatable bug in your environment, please [post an issue](https://github.com/ttscoff/doing/issues) and include your platform, OS version, and the result of `ruby -v`, along with a copy/paste of the error message. To get a more verbose error message, try running `GLI_DEBUG=true doing [...]` for a full trace.
 
 Please try not to email me directly about GitHub projects.
 
@@ -550,8 +596,17 @@ Please try not to email me directly about GitHub projects.
 
 Feel free to [poke around](http://github.com/ttscoff/doing/), I'll try to add more comments in the future (and retroactively).
 
+{% donate doing now sending coffee money to Brett. %}
+
 ## Changelog
 
+#### 1.0.23
+
+- Apply default_tags after autotagging to avoid tags triggering tags
+- Set `doing recent` to default to All sections instead of Currently
+- Fix error in time reporting
+- improved y/n prompt for TTY
+
 #### 1.0.22
 
 - Fix handling of "local" config files, allowing per-project configurations
@@ -673,7 +728,7 @@ Catching up on the changelog. Kind of. A lot has happened, mostly fixes.
 * Look, HTML output! (`--output html`)
 * Also, `--output csv`
 * let doing `archive` function on all sections
-* option to exclude date from `@done`,  
+* option to exclude date from _@done_,  
 * output newlines in sections and views
 * Flagging (`doing mark`)
 * fix for view/section guess error
@@ -692,9 +747,9 @@ Catching up on the changelog. Kind of. A lot has happened, mostly fixes.
 - `tags_color` in view config to highlight tags at the end of the lines. Can be set to any of the `%colors`.
 - Basic time tracking. 
   - `-t` on `show` and `view` will turn on time calculations
-  - Intervals between timestamps and dated `@done` tags are calculated for each line, if the tag exists. 
+  - Intervals between timestamps and dated _@done_ tags are calculated for each line, if the tag exists. 
   - You must include a `%interval` token in the appropriate template for it to show
-  - `@start(date)` tags can optionally be used to override the timestamp in the calculation
+  - _@start(date)_ tags can optionally be used to override the timestamp in the calculation
   - Any other tags in the line have that line's total added to them
   - Totals for tags can be displayed at the end of output with `--totals`
 
@@ -723,6 +778,8 @@ Catching up on the changelog. Kind of. A lot has happened, mostly fixes.
 - fuzzy section guessing when specified section isn't found
 - fuzzy view guessing for `doing view` command
 
+----
+
 #### 0.1.9
 
 - colors in templated output
@@ -749,3 +806,4 @@ Catching up on the changelog. Kind of. A lot has happened, mostly fixes.
   - save a tmp file and open it in an editor
   - allows multi-line entries, anything after first line is considered a note
   - assumed when no input is provided (`doing now`)
+

data/bin/doing

@@ -516,17 +516,19 @@ command :tag do |c|
       count = options[:c].to_i
 
       if count == 0
+        section_q = section == 'All' ? "" : " in section #{section}"
+
         if options[:a]
-          print "Are you sure you want to autotag all records? (y/N) "
+          question = "Are you sure you want to autotag all records#{section_q}"
         elsif options[:r]
-          print "Are you sure you want to remove #{tags.join(" and ")} from all records? (y/N) "
+          question = "Are you sure you want to remove #{tags.join(" and ")} from all records#{section_q}"
         else
-          print "Are you sure you want to add #{tags.join(" and ")} to all records? (y/N) "
+          question = "Are you sure you want to add #{tags.join(" and ")} to all records#{section_q}"
         end
 
-        res = STDIN.gets
+        res = wwid.yn(question,false)
 
-        unless res.strip =~ /^y(es)?$/i
+        unless res
           raise "Cancelled"
         end
       end
@@ -692,8 +694,8 @@ default_value 10
 arg_name 'count'
 command :recent do |c|
   c.desc 'Section'
-  c.default_value wwid.current_section
-  c.flag [:s,:section], :default_value => wwid.current_section
+  c.default_value "All"
+  c.flag [:s,:section], :default_value => "All"
 
   c.desc 'Show time intervals on @done tasks'
   c.default_value true
@@ -813,7 +815,6 @@ command :yesterday do |c|
   c.switch [:totals], :default_value => false, :negatable => true
 
   c.action do |global_options, options,args|
-    section = args.length > 0 ? args.join(" ") : wwid.current_section
     puts wwid.yesterday(options[:s],options[:t],options[:o],{:totals => options[:totals]}).chomp
 
   end

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '1.0.22'
+  VERSION = '1.0.23'
 end

data/lib/doing/wwid.rb

@@ -52,6 +52,7 @@ class WWID
     @content = {}
     @doingrc_needs_update = false
     @default_config_file = '.doingrc'
+    @interval_cache = {}
   end
 
   ##
@@ -97,7 +98,7 @@ class WWID
     }
     @config['templates']['recent'] ||= {
       'date_format' => '%_I:%M%P',
-      'template' => '%shortdate: %title',
+      'template' => '%shortdate: %title (%section)',
       'wrap_width' => 88
     }
     @config['views'] ||= {
@@ -426,6 +427,7 @@ class WWID
   ##
   def add_section(title)
     @content[title.cap_first] = {'original' => "#{title}:", 'items' => []}
+    @results.push(%Q{Added section "#{title.cap_first}"})
   end
 
   ##
@@ -451,9 +453,9 @@ class WWID
       if alt
         raise "Did you mean `doing view #{alt}`?"
       else
-        print "Create a new section called #{frag.cap_first} (y/N)?"
-        input = STDIN.gets
-        if input =~ /^y/i
+        res = yn("Section #{frag} not found, create it",false)
+
+        if res
           add_section(frag.cap_first)
           write(@doing_file)
           return frag.cap_first
@@ -464,6 +466,57 @@ class WWID
     section ? section.cap_first : guessed
   end
 
+  ##
+  ## @brief      Ask a yes or no question in the terminal
+  ##
+  ## @param      question     (String) The question to ask
+  ## @param      default      (Bool)   default response if no input
+  ##
+  ## @return     (Bool) yes or no
+  ##
+  def yn(question, default_response=false)
+    if default_response
+      default = 'y'
+    else
+      default = 'n'
+    end
+    # if this isn't an interactive shell, answer default
+    unless $stdout.isatty
+      if default.downcase == 'y'
+        return true
+      else
+        return false
+      end
+    end
+    # clear the buffer
+    if ARGV.length
+      ARGV.length.times do
+        ARGV.shift
+      end
+    end
+    system 'stty cbreak'
+    if default
+      if default =~ /y/i
+        options = "#{colors['white']}[#{colors['boldgreen']}Y#{colors['white']}/#{colors['boldwhite']}n#{colors['white']}]#{colors['default']}"
+      else
+        options = "#{colors['white']}[#{colors['boldwhite']}y#{colors['white']}/#{colors['boldgreen']}N#{colors['white']}]#{colors['default']}"
+      end
+    else
+      options = "#{colors['white']}[#{colors['boldwhite']}y#{colors['white']}/#{colors['boldwhite']}n#{colors['white']}]#{colors['default']}"
+    end
+    $stdout.syswrite "#{colors['boldwhite']}#{question.sub(/\?$/,'')} #{options}#{colors['boldwhite']}?#{colors['default']} "
+    res = $stdin.sysread 1
+    puts
+    system 'stty cooked'
+
+    res.chomp!
+    res.downcase!
+
+    res = default.downcase if res == ""
+
+    return res =~ /y/i
+  end
+
   ##
   ## @brief      Attempt to match a string with an existing view
   ##
@@ -507,7 +560,7 @@ class WWID
     opt[:back] ||= Time.now
     opt[:timed] ||= false
 
-    title = [title.strip.cap_first] + @config['default_tags'].map{|t| '@' + t.sub(/^ *@/,'').chomp}
+    title = [title.strip.cap_first]
     title = autotag(title.join(' '))
     unless @config['default_tags'].empty?
       title += @config['default_tags'].map{|t|
@@ -516,7 +569,7 @@ class WWID
           if title =~ /@#{dt}/
             ""
           else
-            '@' + dt
+            ' @' + dt
           end
         end
       }.delete_if {|t| t == "" }.join(" ")
@@ -1595,6 +1648,11 @@ EOS
     done = nil
     start = nil
 
+    if @interval_cache.keys.include? item['title']
+      seconds = @interval_cache[item['title']]
+      return seconds > 0 ? "%02d:%02d:%02d" % fmt_time(seconds) : false
+    end
+
     if item['title'] =~ /@done\((\d{4}-\d\d-\d\d \d\d:\d\d.*?)\)/
       done = Time.parse($1)
     else
@@ -1618,6 +1676,8 @@ EOS
       end
     }
 
+    @interval_cache[item['title']] = seconds
+
     return seconds unless formatted
 
     seconds > 0 ? "%02d:%02d:%02d" % fmt_time(seconds) : false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 1.0.22
+  version: 1.0.23
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-08 00:00:00.000000000 Z
+date: 2020-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake