doing 1.0.61 → 1.0.65

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 406fa23f47c83c1b9b3c8fa1cd0e193761c0b13e7ec31f75fdf43b1375769d18
-  data.tar.gz: 2c7f30f6acfac0fb33266dd62ce204099c0358cef88e19de8f26c9e9a4f866f2
+  metadata.gz: a774718572df78395293b6294bcfa4bac94cfe2cde0ffec43e8bbea60b874534
+  data.tar.gz: fba4b65439084eae5b291bd65f5a1d14d49e5b5c4c8b70abd5e8f73fa39b3545
 SHA512:
-  metadata.gz: 547c64a9fbfdb026a0ecaf1b4b0ae203306907ddbdc7cff76062b82312293e36eb170b8874f3aa643e19a8f2d3310aea472f23b12128b7b9eeb300956210ca68
-  data.tar.gz: 37d3819348c3167b6c77a34f8e7e2311015c3975e8595303e04c1d89cb28d7d8a83d7dfea810440b846621d90fd8e7bd1538dd9e3f607a2002284d1405474de8
+  metadata.gz: 01bf52dbc6e7077e6ff2a67ab22504dda4be927f31da8be7e5383136b5cac500cd7920203b7383ebe302af5ddce375e0ee7389273a275edfde27971de8ae87bb
+  data.tar.gz: 79e7b8dcf00223118a0e3f5bb648ed33e920dc915909f62d1c21f2a19332f3d35336d3e5ca85a31632416b9fb9364d58db2fb6a4f90e7a200bc7cb706f76e14b

data/README.md

@@ -29,7 +29,7 @@ _Side note:_ I actually use the library behind this utility as part of another s
 
 ## Installation
 
-The current version of `doing` is <!--VER-->1.0.60<!--END VER-->.
+The current version of `doing` is <!--VER-->1.0.64<!--END VER-->.
 
     $ [sudo] gem install doing
 
@@ -167,7 +167,7 @@ The config also contains templates for various command outputs. Include placehol
     - 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.
 
-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.
+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. You can try it out [here](http://strftime.net).
 
 My normal template for the `recent` command looks like this:
 
@@ -394,24 +394,41 @@ Note that you can include a tag with synonyms in the whitelist as well to tag it
 
 #### Adding entries:
 
-    now, did      - Add an entry
+    now, next     - Add an entry
     later         - Add an item to the Later section
-    done          - Add a completed item with @done(date). No argument finishes last entry.
+    done, did     - Add a completed item with @done(date). No argument finishes last entry.
     meanwhile     - Finish any @meanwhile tasks and optionally create a new one
     again, resume - Duplicate the last entry as new entry (without @done tag)
 
-The `doing now` command can accept `-s section_name` to send the new entry straight to a non-default section. It also accepts `--back=AMOUNT` to let you specify a start date in the past using "natural language." For example, `doing now --back=25m ENTRY` or `doing now --back="yesterday 3:30pm" ENTRY`.
+##### now
 
-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.
+The `doing now` command adds an entry to the "Currently" section by default. It accepts `-s section_name` to send the new entry straight to a non-default section. It also accepts `--back=AMOUNT` to let you specify a start date in the past using "natural language." For example, `doing now --back=25m ENTRY` or `doing now --back="yesterday 3:30pm" ENTRY`.
 
 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`.
+> __Examples:__
+> 
+> - `doing now Working on project X` --- Add a new entry at the current time
+> - `doing now --section=Projects Working on @projectX` --- Add a new entry to a section titled "Projects"
+> - `doing now --back 30m` --- Add a new entry with a backdated start time, indicating you've been working on it for 30 minutes already
+> - `doing now --back 8am` --- Backdate a new entry to a specific time
+> - `doing now -f Starting the next thing` --- Add a new entry at the current time, and add a @done tag to the previous item with the current time as its completion date
+> - `doing now -f --back 30m Working on something new` --- Add a new entry and complete the last entry, but use a timestamp from 30 minutes ago for both.
 
-`doing done` can also backdate entries using natural language with `--back 15m` or `--back "3/15 3pm"`. That will modify the starting timestamp of the entry. You can also use `--took 1h20m` or `--took 1:20` to set the finish date based on a "natural language" time interval. If `--took` is used without `--back`, then the start date is adjusted (`--took` interval is subtracted) so that the completion date is the current time.
+##### done/finish
+
+`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 the Archive with `-a`.
+
+`doing done` can also backdate entries using natural language with `--back 15m` or `--back "3/15 3pm"`. That will modify the starting timestamp of the entry. Used on its own, it will set the start date, and the finish date will be the current time. You can also use `--took 1h20m` or `--took 1:20` to set the finish date based on a "natural language" time interval. If `--took` is used without `--back`, then the start date is adjusted (`--took` interval is subtracted) so that the completion date is the current time.
 
 When used with `doing done`, `--back` and `--took` allow time intervals to be accurately counted when entering items after the fact. `--took` is also available for the `doing finish` command, but cannot be used in conjunction with `--back`. (In `finish` they both set the end date, and neither has priority. `--back` allows specific days/times, `--took` uses time intervals.)
 
+> __Examples:__
+>
+> - `doing done --back 1h The thing I just did` --- Add an entry for a completed task that you started an hour ago and just finished 
+> - `doing done --back 1h --took 20m The thing I just finished` --- Record an entry you started an hour ago and finished 20 minutes later
+> - `doing done --took 20m` --- Finish the last task but change the finish date so that the total elapsed time is only 20 minutes (if the finish date would be in the future, start date will be adjusted accordingly)
+
 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 again` (or `doing resume`) will duplicate the last @done entry (most recently completed) with a new start date (and without the @done tag). To resume the last entry matching specific tags, use `--tag=TAG`. You can specify multiple tags by separating with a comma. Multiple tags are combined with 'AND' by default (all tags must exist on the entry to match), but you can use `--bool=` to set it to 'OR' or 'NOT'. By default the new entry will be added to the same section as the matching entry, but you can specify a section with `--in=SECTION`.
@@ -429,7 +446,7 @@ 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 (0 affects all entries). 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.
 
@@ -445,6 +462,8 @@ You can change the boolean using `--bool=OR` (last entry containing any of the s
 
 You can also include a `--no-date` switch to add `@done` without a finish date, meaning no time is tracked for the task. `doing cancel` is an alias for this. Like `finish`, `cancel` accepts a count to act on the last X entries, as well as `--archive` and `--section` options. `cancel` also accepts the `--tag` and `--bool` flags for tag filtering.
 
+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.
+
 
 ##### Tagging and Autotagging
 
@@ -576,6 +595,29 @@ Example: Archive all Currently items for _@client_ that are marked _@done_
 
     doing archive @client @done
 
+##### Importing
+
+Doing can currently only import tasks from Timing.app reports. If you want to sync up your Doing file with Timing's tracking:
+
+1. Open Timing and go to Reports
+2. Set the date span you want to import into doing
+3. Group by Project, Then by None
+4. Include Tasks with Title, (not as subgroup), Timespan, and Notes
+5. Uncheck App Usage
+6. Set File Format to JSON and Duration format to "XX:YY:ZZ"
+7. Include short entries if desired
+8. Export the report to a new file
+
+Now you can run `doing import --type timing -s SECTION PATH`, where SECTION is the name of the section you want to import the entries to (defauts to Currently), and PATH is the path to the JSON file. You can also add a tag (or tags) to all entries, or a custom prefix.
+
+(`--type timing` is the only option right now, so it doesn't need to be included)
+
+    # Import entries to Projects section and add @timing to all new entries
+    doing import -s Projects --tag=timing "~/Desktop/All Activities.json"
+
+    # Import to default section (Currently) and prefix entries with '[Imported]'
+    doing import --prefix="[Imported]" "~/Desktop/All Activities.json"
+
 ---
 
 ## Extras

data/bin/doing

@@ -310,7 +310,7 @@ end
 
 desc 'Add a completed item with @done(date). No argument finishes last entry.'
 arg_name 'ENTRY'
-command [:done, :did] do |c|
+command %i[done did] do |c|
   c.desc 'Remove @done tag'
   c.switch %i[r remove], negatable: false, default_value: false
 
@@ -367,15 +367,18 @@ command [:done, :did] do |c|
 
       date = options[:took] ? finish_date - took : finish_date
     elsif options[:took]
-      finish_date = date + took
+      finish_date = options[:back] ? date + took : nil
     elsif options[:back]
       finish_date = date
     else
       finish_date = Time.now
     end
 
+    if finish_date
+      donedate = options[:date] ? "(#{finish_date.strftime('%F %R')})" : ''
+    end
+
     section = wwid.guess_section(options[:s]) || options[:s].cap_first
-    donedate = options[:date] ? "(#{finish_date.strftime('%F %R')})" : ''
 
     if options[:e]
       raise 'No EDITOR variable defined in environment' if ENV['EDITOR'].nil?
@@ -394,8 +397,15 @@ command [:done, :did] do |c|
       if options[:r]
         wwid.tag_last({ tags: ['done'], count: 1, section: section, remove: true })
       else
-        wwid.tag_last({ tags: ['done'], count: 1, section: section, archive: options[:a], back: finish_date,
-                        date: options[:date] })
+        options = { tags: ['done'],
+          archive: options[:a],
+          back: finish_date,
+          count: 1,
+          date: options[:date],
+          section: section,
+          took: took == 0 ? nil : took
+        }
+        wwid.tag_last(options)
       end
     elsif !args.empty?
       title, note = wwid.format_input(args.join(' '))
@@ -1381,6 +1391,44 @@ command :undo do |c|
   end
 end
 
+desc 'Import entries from an external source'
+long_desc 'Imports entries from other sources. Currently only handles JSON reports exported from Timing.app.'
+arg_name 'PATH'
+command :import do |c|
+  c.desc 'Import type'
+  c.arg_name 'TYPE'
+  c.flag :type, default_value: 'timing'
+
+  c.desc 'Target section'
+  c.arg_name 'NAME'
+  c.flag %i[s section], default_value: wwid.current_section
+
+  c.desc 'Tag all imported entries'
+  c.arg_name 'TAGS'
+  c.flag :tag
+
+  c.desc 'Prefix entries with'
+  c.arg_name 'PREFIX'
+  c.flag :prefix
+
+  c.desc 'Allow entries that overlap existing times'
+  c.switch [:overlap], negatable: true
+
+  c.action do |_global_options, options, args|
+
+    section = wwid.guess_section(options[:s]) || options[:s].cap_first
+
+    if options[:type] =~ /^tim/i
+      args.each do |path|
+        wwid.import_timing(path, { section: section, tag: options[:tag], prefix: options[:prefix], no_overlap: !options[:overlap] })
+        wwid.write(wwid.doing_file)
+      end
+    else
+      raise 'Invalid import type'
+    end
+  end
+end
+
 pre do |global, _command, _options, _args|
   if global[:config_file] && global[:config_file] != wwid.config_file
     wwid.config_file = global[:config_file]

data/lib/doing/version.rb

@@ -1,3 +1,3 @@
 module Doing
-  VERSION = '1.0.61'
+  VERSION = '1.0.65'
 end

data/lib/doing/wwid.rb

@@ -7,7 +7,7 @@ require 'pp'
 ##
 ## @brief      Hash helpers
 ##
-class Hash
+class ::Hash
   def has_tags?(tags, bool = 'AND')
     tags = tags.split(/ *, */) if tags.is_a? String
     item = self
@@ -310,7 +310,7 @@ class WWID
       else
         @content[section]['items'][current - 1]['note'] = [] unless @content[section]['items'][current - 1].key? 'note'
 
-        @content[section]['items'][current - 1]['note'].push(line.gsub(/ *$/, ''))
+        @content[section]['items'][current - 1]['note'].push(line.chomp)
         # end
       end
     end
@@ -667,6 +667,96 @@ class WWID
     @results.push(%(Added "#{entry['title']}" to #{section}))
   end
 
+  def same_time?(item_a, item_b)
+    item_a['date'] == item_b['date'] ? get_interval(item_a, false) == get_interval(item_b, false) : false
+  end
+
+  def overlapping_time?(item_a, item_b)
+    return true if same_time?(item_a, item_b)
+
+    start_a = item_a['date']
+    interval = get_interval(item_a, false)
+    end_a = interval ? start_a + interval.to_i : start_a
+    start_b = item_b['date']
+    interval = get_interval(item_b, false)
+    end_b = interval ? start_b + interval.to_i : start_b
+    (start_a >= start_b && start_a <= end_b) || (end_a >= start_b && end_a <= end_b) || (start_a < start_b && end_a > end_b)
+  end
+
+  def dedup(items, no_overlap = false)
+
+    combined = []
+    @content.each do |_k, v|
+      combined += v['items']
+    end
+
+    items.delete_if do |item|
+      duped = false
+      combined.each do |comp|
+        duped = no_overlap ? overlapping_time?(item, comp) : same_time?(item, comp)
+        break if duped
+      end
+      # warn "Skipping overlapping entry: #{item['title']}" if duped
+      duped
+    end
+  end
+
+  ##
+  ## @brief      Imports a Timing report
+  ##
+  ## @param      path     (String) Path to JSON report file
+  ## @param      section  (String) The section to add to
+  ## @param      opt      (Hash) Additional Options
+  ##
+  def import_timing(path, opt = {})
+    section = opt[:section] || @current_section
+    opt[:no_overlap] ||= false
+
+    add_section(section) unless @content.has_key?(section)
+
+    add_tags = opt[:tag] ? opt[:tag].split(/[ ,]+/).map { |t| t.sub(/^@?/, '@') }.join(' ') : ''
+    prefix = opt[:prefix] ? opt[:prefix] : '[Timing.app]'
+    raise "File not found" unless File.exist?(File.expand_path(path))
+
+    data = JSON.parse(IO.read(File.expand_path(path)))
+    new_items = []
+    data.each do |entry|
+      # Only process task entries
+      next if entry.key?('activityType') && entry['activityType'] != 'Task'
+      # Only process entries with a start and end date
+      next unless entry.key?('startDate') && entry.key?('endDate')
+
+      # Round down seconds and convert UTC to local time
+      start_time = Time.parse(entry['startDate'].sub(/:\d\dZ$/, ':00Z')).getlocal
+      end_time = Time.parse(entry['endDate'].sub(/:\d\dZ$/, ':00Z')).getlocal
+      next unless start_time && end_time
+
+      tags = entry['project'].split(/ ▸ /).map {|proj| proj.gsub(/[^a-z0-9]+/i, '').downcase }
+      title = "#{prefix} "
+      title += entry.key?('activityTitle') && entry['activityTitle'] != '(Untitled Task)' ? entry['activityTitle'] : 'Working on'
+      tags.each do |tag|
+        if title =~ /\b#{tag}\b/i
+          title.sub!(/\b#{tag}\b/i, "@#{tag}")
+        else
+          title += " @#{tag}"
+        end
+      end
+      title = autotag(title) if @auto_tag
+      title += " @done(#{end_time.strftime('%Y-%m-%d %H:%M')})"
+      title.gsub!(/ +/, ' ')
+      title.strip!
+      new_entry = { 'title' => title, 'date' => start_time, 'section' => section }
+      new_entry['note'] = entry['notes'].split(/\n/).map(&:chomp) if entry.key?('notes')
+      new_items.push(new_entry)
+    end
+    total = new_items.count
+    new_items = dedup(new_items, opt[:no_overlap])
+    dups = total - new_items.count
+    @results.push(%(Skipped #{dups} items with overlapping times)) if dups > 0
+    @content[section]['items'].concat(new_items)
+    @results.push(%(Imported #{new_items.count} items to #{section}))
+  end
+
   ##
   ## @brief      Return the content of the last note for a given section
   ##
@@ -776,6 +866,7 @@ class WWID
     opt[:remove] ||= false
     opt[:autotag] ||= false
     opt[:back] ||= false
+    opt[:took] ||= nil
 
     sec_arr = []
 
@@ -833,6 +924,13 @@ class WWID
                 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]
+                  done_date = Time.now
+                else
+                  done_date = item['date'] + opt[:took]
+                end
               else
                 done_date = Time.now
               end

metadata

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