doing 2.1.99 → 2.1.103

data/lib/doing/normalize.rb

@@ -161,6 +161,27 @@ module Doing
       replace normalize_bool(default)
     end
 
+    ##
+    ## Convert totals-by string to a symbol
+    ##
+    ## @return     Symbol :tags or :section
+    ##
+    def normalize_totals_by(default = :tags)
+      case self
+      when /^t/i
+        :tags
+      when /^[sp]/i
+        :section
+      else
+        default.is_a?(Symbol) ? default : default.normalize_totals_by
+      end
+    end
+
+    ## @see #normalize_totals_by
+    def normalize_totals_by!(default = :tags)
+      replace normalize_totals_by(default)
+    end
+
     ##
     ## Adds ?: to any parentheticals in a regular expression
     ## to avoid match groups
@@ -217,6 +238,10 @@ module Doing
     def normalize_matching(default = :pattern)
       to_s.normalize_matching(default)
     end
+
+    def normalize_totals_by(default = :tags)
+      to_s.normalize_totals_by(default)
+    end
   end
 end
 

data/lib/doing/plugins/export/dayone_export.rb

@@ -127,7 +127,8 @@ module Doing
 
       totals = if opt[:totals]
                  wwid.tag_times(format: :markdown, sort_by: opt[:sort_tags],
-                                sort_order: opt[:tag_order])
+                                sort_order: opt[:tag_order],
+                                by: opt[:by])
                else
                  ''
                end

data/lib/doing/plugins/export/html_export.rb

@@ -70,7 +70,7 @@ module Doing
                 self.template('css')
               end
 
-      totals = opt[:totals] ? wwid.tag_times(format: :html, sort_by: opt[:sort_tags], sort_order: opt[:tag_order]) : ''
+      totals = opt[:totals] ? wwid.tag_times(format: :html, sort_by: opt[:sort_tags], sort_order: opt[:tag_order], by: opt[:by]) : ''
       engine = Haml::Engine.new(template)
       Doing.logger.debug('HTML Export:', "#{items_out.count} items output to HTML")
       @out = engine.render(Object.new,

data/lib/doing/plugins/export/json_export.rb

@@ -104,7 +104,8 @@ module Doing
                                'items' => items_out,
                                'timers' => wwid.tag_times(format: :json,
                                                           sort_by: opt[:sort_tags],
-                                                          sort_order: opt[:tag_order])
+                                                          sort_order: opt[:tag_order],
+                                                          by: opt[:by])
                              })
       when 'timeline'
         template = <<~EOTEMPLATE

data/lib/doing/plugins/export/markdown_export.rb

@@ -82,7 +82,8 @@ module Doing
 
       totals = if opt[:totals]
                  wwid.tag_times(format: :markdown, sort_by: opt[:sort_tags],
-                                sort_order: opt[:tag_order])
+                                sort_order: opt[:tag_order],
+                                by: opt[:by])
                else
                  ''
                end

data/lib/doing/plugins/export/template_export.rb

@@ -140,7 +140,8 @@ module Doing
         if opt[:totals]
           out += wwid.tag_times(format: Doing.setting('timer_format').to_sym,
                                 sort_by: opt[:sort_tags],
-                                sort_order: opt[:tag_order])
+                                sort_order: opt[:tag_order],
+                                by: opt[:by])
         end
         out
       end

data/lib/doing/types.rb

@@ -6,6 +6,7 @@ module Doing
     REGEX_TAG_SORT = /^(?:n(?:ame)?|t(?:ime)?)$/i.freeze
     REGEX_BOOL = /^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$/i.freeze
     REGEX_SORT_ORDER = /^(?:a(?:sc)?|d(?:esc)?)$/i.freeze
+    REGEX_TOTALS_BY = /^(?:t(?:ag(?:s)?)?|s(?:ec(?:tion|tions)?)?|p(?:roj(?:ect|ects)?)?)$/i.freeze
     REGEX_VALUE_QUERY = /^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$/.freeze
     REGEX_CLOCK = '(?:\d{1,2}+(?::\d{1,2}+)?(?: *(?:am|pm))?|midnight|noon)'
     REGEX_TIME = /^#{REGEX_CLOCK}$/i.freeze
@@ -30,6 +31,7 @@ module Doing
     OrderSymbol = Class.new(Symbol)
     TagArray = Class.new(Array)
     TagSortSymbol = Class.new(Symbol)
+    TotalsBySymbol = Class.new(Symbol)
     TemplateName = Class.new(String)
   end
 end

data/lib/doing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Doing
-  VERSION = '2.1.99'
+  VERSION = '2.1.103'
 end

data/lib/doing/wwid/timers.rb

@@ -11,12 +11,12 @@ module Doing
     ## @param      sort_by       [Symbol] Sort by :name or :time
     ## @param      sort_order    [Symbol] The sort order (:asc or :desc)
     ##
-    def tag_times(format: :text, sort_by: :time, sort_order: :asc)
-      return '' if @timers.empty?
+    def tag_times(format: :text, sort_by: :time, sort_order: :asc, by: nil)
+      groupings = normalize_totals_groupings(by)
+      totals = collect_totals(groupings)
+      return '' if totals.empty?
 
-      @timers.delete('meanwhile')
-
-      timers_snapshot = @timers.dup
+      timers_snapshot = totals[:tags] || {}
 
       budgets = Doing.setting('budgets', {}) || {}
       budgets = budgets.transform_keys { |k| k.to_s.downcase }
@@ -44,24 +44,123 @@ module Doing
         budgets_total += remaining
       end
 
-      max = @timers.keys.sort_by(&:length).reverse[0].length + 1
+      outputs = groupings.map do |group|
+        timer_data = totals[group]
+        next nil unless timer_data
+
+        render_totals_group(
+          format: format,
+          group: group,
+          timer_data: timer_data,
+          sort_by: sort_by,
+          sort_order: sort_order,
+          remaining_map: remaining_map,
+          budgets: budgets,
+          budgets_total: budgets_total,
+          budget_fmt: budget_fmt
+        )
+      end.compact
+
+      return '' if outputs.empty?
+      return outputs.first if format == :json && outputs.length == 1
+
+      format == :json ? outputs.to_h : outputs.join(format == :human ? "\n" : '')
+    end
+
+    ##
+    ## Gets the interval between entry's start
+    ##             date and @done date
+    ##
+    ## @param      item       [Item] The entry
+    ## @param      formatted  [Boolean] Return human readable
+    ##                        time (default seconds)
+    ## @param      record     [Boolean] Add the interval to the
+    ##                        total for each tag
+    ##
+    ## @return     Interval in seconds, or [d, h, m] array if
+    ##             formatted is true. False if no end date or
+    ##             interval is 0
+    ##
+    def get_interval(item, formatted: true, record: true)
+      if item.interval
+        seconds = item.interval
+        record_tag_times(item, seconds) if record
+        return seconds.positive? ? seconds : false unless formatted
+
+        return seconds.positive? ? seconds.time_string(format: :clock) : false
+      end
+
+      false
+    end
 
-      total = @timers.delete('All')
+    private
 
-      tags_data = @timers.delete_if { |_k, v| v.zero? }
-      sorted_tags_data = if sort_by.normalize_tag_sort == :name
-                           tags_data.sort_by { |k, _v| k }
-                         else
-                           tags_data.sort_by { |_k, v| v }
-                         end
+    ##
+    ## Record times for item tags
+    ##
+    ## @param      item  [Item] The item to record
+    ##
+    def record_tag_times(item, seconds)
+      item_hash = "#{item.date.strftime('%s')}#{item.title}#{item.section}"
+      return if @recorded_items.include?(item_hash)
+
+      @section_timers ||= {}
+      section = item.section.to_s.strip
+      section = 'Unknown' if section.empty?
+      @section_timers['All'] = @section_timers.fetch('All', 0) + seconds
+      @section_timers[section] = @section_timers.fetch(section, 0) + seconds
+
+      item.title.scan(/(?mi)@(\S+?)(\(.*\))?(?=\s|$)/).each do |m|
+        k = m[0] == 'done' ? 'All' : m[0].downcase
+        if @timers.key?(k)
+          @timers[k] += seconds
+        else
+          @timers[k] = seconds
+        end
+        @recorded_items.push(item_hash)
+      end
+    end
+
+    def normalize_totals_groupings(by)
+      return [:tags] if by.nil? || (by.respond_to?(:empty?) && by.empty?)
+
+      Array(by).map { |v| v.normalize_totals_by(:tags) }.uniq
+    end
+
+    def collect_totals(groupings)
+      totals = {}
+      totals[:tags] = @timers.dup if groupings.include?(:tags) && @timers.good?
+      totals[:section] = (@section_timers || {}).dup if groupings.include?(:section) && @section_timers.good?
+      totals
+    end
+
+    def sort_totals_data(data, sort_by:, sort_order:)
+      sorted = if sort_by.normalize_tag_sort == :name
+                 data.sort_by { |k, _v| k }
+               else
+                 data.sort_by { |_k, v| v }
+               end
+      sorted.reverse! if sort_order.normalize_order == :asc
+      sorted
+    end
+
+    def render_totals_group(format:, group:, timer_data:, sort_by:, sort_order:, remaining_map:, budgets:, budgets_total:, budget_fmt:)
+      timer_data = timer_data.dup
+      timer_data.delete('meanwhile')
+
+      max = timer_data.keys.sort_by(&:length).reverse[0].length + 1
+      total = timer_data.delete('All').to_i
+      group_data = timer_data.delete_if { |_k, v| v.zero? }
+      sorted_data = sort_totals_data(group_data, sort_by: sort_by, sort_order: sort_order)
+
+      title = group == :section ? 'Section Totals' : 'Tag Totals'
+      label = group == :section ? 'section' : 'tag'
 
-      sorted_tags_data.reverse! if sort_order.normalize_order == :asc
       case format
       when :html
-
         output = <<EOHEAD
           <table>
-          <caption id="tagtotals">Tag Totals</caption>
+          <caption id="#{group}totals">#{title}</caption>
           <colgroup>
           <col style="text-align:left;"/>
           <col style="text-align:left;"/>
@@ -74,16 +173,16 @@ module Doing
           </thead>
           <tbody>
 EOHEAD
-        sorted_tags_data.reverse.each do |k, v|
+        sorted_data.reverse.each do |k, v|
           next unless v.positive?
 
           budget_str = ''
-          if remaining_map.key?(k) && remaining_map[k].positive?
+          if group == :tags && remaining_map.key?(k) && remaining_map[k].positive?
             budget_str = " (budget left #{budget_fmt.call(remaining_map[k])})"
           end
           output += "<tr><td style='text-align:left;'>#{k}</td><td style='text-align:left;'>#{v.time_string(format: :clock)}#{budget_str}</td></tr>\n"
         end
-        tail = <<EOTAIL
+        output += <<EOTAIL
         <tr>
           <td style="text-align:left;" colspan="2"></td>
         </tr>
@@ -91,52 +190,54 @@ EOHEAD
         <tfoot>
         <tr>
           <td style="text-align:left;"><strong>Total</strong></td>
-          <td style="text-align:left;">#{total.time_string(format: :clock)}#{" (total budgets left #{budget_fmt.call(budgets_total)})" if budgets_total.positive?}</td>
+          <td style="text-align:left;">#{total.time_string(format: :clock)}#{group == :tags && budgets_total.positive? ? " (total budgets left #{budget_fmt.call(budgets_total)})" : ''}</td>
         </tr>
         </tfoot>
         </table>
 EOTAIL
-        output + tail
+        output
       when :markdown
-        pad = sorted_tags_data.map { |k, _| k }.group_by(&:size).max.last[0].length
+        pad = sorted_data.map { |k, _| k }.group_by(&:size).max.last[0].length
         pad = 7 if pad < 7
         output = <<~EOHEADER
           | #{' ' * (pad - 7)}project | time     |
           | #{'-' * (pad - 1)}: | :------- |
         EOHEADER
-        sorted_tags_data.reverse.each do |k, v|
+        sorted_data.reverse.each do |k, v|
           next unless v.positive?
 
           budget_str = ''
-          if remaining_map.key?(k) && remaining_map[k].positive?
+          if group == :tags && remaining_map.key?(k) && remaining_map[k].positive?
             budget_str = " (budget left #{budget_fmt.call(remaining_map[k])})"
           end
           output += "| #{' ' * (pad - k.length)}#{k} | #{v.time_string(format: :clock)}#{budget_str} |\n"
         end
-        tail = '[Tag Totals]'
-        output + tail
+        output + "[#{title}]"
       when :json
         output = []
-        sorted_tags_data.reverse.each do |k, v|
-          output << {
-            'tag' => k,
+        sorted_data.reverse.each do |k, v|
+          row = {
+            label => k,
             'seconds' => v,
-            'formatted' => v.time_string(format: :clock),
-            'budget' => budgets[k],
-            'remaining' => remaining_map[k],
-            'remaining_formatted' => (remaining_map[k] && remaining_map[k].positive? ? budget_fmt.call(remaining_map[k]) : nil)
+            'formatted' => v.time_string(format: :clock)
           }
+          if group == :tags
+            row['budget'] = budgets[k]
+            row['remaining'] = remaining_map[k]
+            row['remaining_formatted'] = (remaining_map[k] && remaining_map[k].positive? ? budget_fmt.call(remaining_map[k]) : nil)
+          end
+          output << row
         end
-        output
+        [group, output]
       when :human
         output = []
-        sorted_tags_data.reverse.each do |k, v|
+        sorted_data.reverse.each do |k, v|
           spacer = ''
           (max - k.length).times do
             spacer += ' '
           end
           line = "┃ #{spacer}#{k}:#{v.time_string(format: :hm)}"
-          if remaining_map.key?(k) && remaining_map[k].positive?
+          if group == :tags && remaining_map.key?(k) && remaining_map[k].positive?
             line += " (budget left #{budget_fmt.call(remaining_map[k])})"
           end
           line += ' ┃'
@@ -144,7 +245,7 @@ EOTAIL
         end
 
         total_content = "┃ #{' ' * (max - 6)}total: #{total.time_string(format: :hm)}"
-        total_content += " (total budgets left #{budget_fmt.call(budgets_total)})" if budgets_total.positive?
+        total_content += " (total budgets left #{budget_fmt.call(budgets_total)})" if group == :tags && budgets_total.positive?
         total_content += ' ┃'
         max_line_len = (output + [total_content]).map(&:length).max
 
@@ -154,8 +255,9 @@ EOTAIL
         end
         output = output.map { |l| pad_line.call(l) }
 
-        header = '┏━━ Tag Totals '
-        [(max_line_len - 16), 0].max.times { header += '━' }
+        header = "┏━━ #{title} "
+        # Keep top border width aligned with body/footer width.
+        [(max_line_len - title.length - 6), 0].max.times { header += '━' }
         header += '┓'
         footer = '┗'
         [(max_line_len - 2), 0].max.times { footer += '━' }
@@ -172,7 +274,7 @@ EOTAIL
         total_time = total.time_string(format: :hm)
         total_line = "┃ #{spacer}total: "
         total_line += total_time
-        total_line += " (total budgets left #{budget_fmt.call(budgets_total)})" if budgets_total.positive?
+        total_line += " (total budgets left #{budget_fmt.call(budgets_total)})" if group == :tags && budgets_total.positive?
         total_line += ' ┃'
         total_line = pad_line.call(total_line)
         output += "\n#{total_line}"
@@ -180,74 +282,24 @@ EOTAIL
         output
       else
         output = []
-        sorted_tags_data.reverse.each do |k, v|
+        sorted_data.reverse.each do |k, v|
           spacer = ''
           (max - k.length).times do
             spacer += ' '
           end
           line = "#{k}:#{spacer}#{v.time_string(format: :clock)}"
-          if remaining_map.key?(k) && remaining_map[k].positive?
+          if group == :tags && remaining_map.key?(k) && remaining_map[k].positive?
             line += " (budget left #{budget_fmt.call(remaining_map[k])})"
           end
           output.push(line)
         end
 
-        output = output.empty? ? '' : "\n--- Tag Totals ---\n#{output.join("\n")}"
+        output = output.empty? ? '' : "\n--- #{title} ---\n#{output.join("\n")}"
         output += "\n\nTotal tracked: #{total.time_string(format: :clock)}"
-        if budgets_total.positive?
-          output += " (total budgets left #{budget_fmt.call(budgets_total)})"
-        end
+        output += " (total budgets left #{budget_fmt.call(budgets_total)})" if group == :tags && budgets_total.positive?
         output += "\n"
         output
       end
     end
-
-    ##
-    ## Gets the interval between entry's start
-    ##             date and @done date
-    ##
-    ## @param      item       [Item] The entry
-    ## @param      formatted  [Boolean] Return human readable
-    ##                        time (default seconds)
-    ## @param      record     [Boolean] Add the interval to the
-    ##                        total for each tag
-    ##
-    ## @return     Interval in seconds, or [d, h, m] array if
-    ##             formatted is true. False if no end date or
-    ##             interval is 0
-    ##
-    def get_interval(item, formatted: true, record: true)
-      if item.interval
-        seconds = item.interval
-        record_tag_times(item, seconds) if record
-        return seconds.positive? ? seconds : false unless formatted
-
-        return seconds.positive? ? seconds.time_string(format: :clock) : false
-      end
-
-      false
-    end
-
-    private
-
-    ##
-    ## Record times for item tags
-    ##
-    ## @param      item  [Item] The item to record
-    ##
-    def record_tag_times(item, seconds)
-      item_hash = "#{item.date.strftime('%s')}#{item.title}#{item.section}"
-      return if @recorded_items.include?(item_hash)
-
-      item.title.scan(/(?mi)@(\S+?)(\(.*\))?(?=\s|$)/).each do |m|
-        k = m[0] == 'done' ? 'All' : m[0].downcase
-        if @timers.key?(k)
-          @timers[k] += seconds
-        else
-          @timers[k] = seconds
-        end
-        @recorded_items.push(item_hash)
-      end
-    end
   end
 end

data/lib/examples/plugins/wiki_export/wiki_export.rb

@@ -73,7 +73,7 @@ module Doing
                 self.template('wiki_css')
               end
 
-      totals = opt[:totals] ? wwid.tag_times(format: :html, sort_by: opt[:sort_tags], sort_order: opt[:tag_order]) : ''
+      totals = opt[:totals] ? wwid.tag_times(format: :html, sort_by: opt[:sort_tags], sort_order: opt[:tag_order], by: opt[:by]) : ''
       engine = Haml::Engine.new(template)
       Doing.logger.debug('Wiki Export:', "#{items_out.count} items output to #{variables[:page_title]} wiki page")
       @out = engine.render(Object.new,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 2.1.99
+  version: 2.1.103
 platform: ruby
 authors:
 - Brett Terpstra
@@ -944,7 +944,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A command line tool for managing What Was I Doing reminders
 test_files: []