doing 2.1.37 → 2.1.40

data/lib/doing/wwid/timers.rb

@@ -0,0 +1,345 @@
+# frozen_string_literal: true
+
+module Doing
+  class WWID
+    # Timer methods for WWID class
+    module Timers
+      ##
+      ## Get total elapsed time for all tags in
+      ##             selection
+      ##
+      ## @param      format        [String] return format (html,
+      ##                           json, or text)
+      ## @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?
+
+        max = @timers.keys.sort_by(&:length).reverse[0].length + 1
+
+        total = @timers.delete('All')
+
+        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
+
+        sorted_tags_data.reverse! if sort_order.normalize_order == :asc
+        case format
+        when :html
+
+          output = <<EOHEAD
+            <table>
+            <caption id="tagtotals">Tag Totals</caption>
+            <colgroup>
+            <col style="text-align:left;"/>
+            <col style="text-align:left;"/>
+            </colgroup>
+            <thead>
+            <tr>
+              <th style="text-align:left;">project</th>
+              <th style="text-align:left;">time</th>
+            </tr>
+            </thead>
+            <tbody>
+EOHEAD
+          sorted_tags_data.reverse.each do |k, v|
+            if v.positive?
+              output += "<tr><td style='text-align:left;'>#{k}</td><td style='text-align:left;'>#{v.time_string(format: :clock)}</td></tr>\n"
+            end
+          end
+          tail = <<EOTAIL
+          <tr>
+            <td style="text-align:left;" colspan="2"></td>
+          </tr>
+          </tbody>
+          <tfoot>
+          <tr>
+            <td style="text-align:left;"><strong>Total</strong></td>
+            <td style="text-align:left;">#{total.time_string(format: :clock)}</td>
+          </tr>
+          </tfoot>
+          </table>
+EOTAIL
+          output + tail
+        when :markdown
+          pad = sorted_tags_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|
+            if v.positive?
+              output += "| #{' ' * (pad - k.length)}#{k} | #{v.time_string(format: :clock)} |\n"
+            end
+          end
+          tail = '[Tag Totals]'
+          output + tail
+        when :json
+          output = []
+          sorted_tags_data.reverse.each do |k, v|
+            output << {
+              'tag' => k,
+              'seconds' => v,
+              'formatted' => v.time_string(format: :clock)
+            }
+          end
+          output
+        when :human
+          output = []
+          sorted_tags_data.reverse.each do |k, v|
+            spacer = ''
+            (max - k.length).times do
+              spacer += ' '
+            end
+            output.push("┃ #{spacer}#{k}:#{v.time_string(format: :hm)} ┃")
+          end
+
+          header = '┏━━ Tag Totals '
+          (max - 2).times { header += '━' }
+          header += '┓'
+          footer = '┗'
+          (max + 12).times { footer += '━' }
+          footer += '┛'
+          divider = '┣'
+          (max + 12).times { divider += '━' }
+          divider += '┫'
+          output = output.empty? ? '' : "\n#{header}\n#{output.join("\n")}"
+          output += "\n#{divider}"
+          spacer = ''
+          (max - 6).times do
+            spacer += ' '
+          end
+          total_time = total.time_string(format: :hm)
+          total = "┃ #{spacer}total: "
+          total += total_time
+          total += ' ┃'
+          output += "\n#{total}"
+          output += "\n#{footer}"
+          output
+        else
+          output = []
+          sorted_tags_data.reverse.each do |k, v|
+            spacer = ''
+            (max - k.length).times do
+              spacer += ' '
+            end
+            output.push("#{k}:#{spacer}#{v.time_string(format: :clock)}")
+          end
+
+          output = output.empty? ? '' : "\n--- Tag Totals ---\n#{output.join("\n")}"
+          output += "\n\nTotal tracked: #{total.time_string(format: :clock)}\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##
+      ## Get total elapsed time for all tags in
+      ##             selection
+      ##
+      ## @param      format        [String] return format (html,
+      ##                           json, or text)
+      ## @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?
+
+        max = @timers.keys.sort_by(&:length).reverse[0].length + 1
+
+        total = @timers.delete('All')
+
+        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
+
+        sorted_tags_data.reverse! if sort_order.normalize_order == :asc
+        case format
+        when :html
+
+          output = <<EOHEAD
+            <table>
+            <caption id="tagtotals">Tag Totals</caption>
+            <colgroup>
+            <col style="text-align:left;"/>
+            <col style="text-align:left;"/>
+            </colgroup>
+            <thead>
+            <tr>
+              <th style="text-align:left;">project</th>
+              <th style="text-align:left;">time</th>
+            </tr>
+            </thead>
+            <tbody>
+EOHEAD
+          sorted_tags_data.reverse.each do |k, v|
+            if v.positive?
+              output += "<tr><td style='text-align:left;'>#{k}</td><td style='text-align:left;'>#{v.time_string(format: :clock)}</td></tr>\n"
+            end
+          end
+          tail = <<EOTAIL
+          <tr>
+            <td style="text-align:left;" colspan="2"></td>
+          </tr>
+          </tbody>
+          <tfoot>
+          <tr>
+            <td style="text-align:left;"><strong>Total</strong></td>
+            <td style="text-align:left;">#{total.time_string(format: :clock)}</td>
+          </tr>
+          </tfoot>
+          </table>
+EOTAIL
+          output + tail
+        when :markdown
+          pad = sorted_tags_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|
+            if v.positive?
+              output += "| #{' ' * (pad - k.length)}#{k} | #{v.time_string(format: :clock)} |\n"
+            end
+          end
+          tail = '[Tag Totals]'
+          output + tail
+        when :json
+          output = []
+          sorted_tags_data.reverse.each do |k, v|
+            output << {
+              'tag' => k,
+              'seconds' => v,
+              'formatted' => v.time_string(format: :clock)
+            }
+          end
+          output
+        when :human
+          output = []
+          sorted_tags_data.reverse.each do |k, v|
+            spacer = ''
+            (max - k.length).times do
+              spacer += ' '
+            end
+            output.push("┃ #{spacer}#{k}:#{v.time_string(format: :hm)} ┃")
+          end
+
+          header = '┏━━ Tag Totals '
+          (max - 2).times { header += '━' }
+          header += '┓'
+          footer = '┗'
+          (max + 12).times { footer += '━' }
+          footer += '┛'
+          divider = '┣'
+          (max + 12).times { divider += '━' }
+          divider += '┫'
+          output = output.empty? ? '' : "\n#{header}\n#{output.join("\n")}"
+          output += "\n#{divider}"
+          spacer = ''
+          (max - 6).times do
+            spacer += ' '
+          end
+          total_time = total.time_string(format: :hm)
+          total = "┃ #{spacer}total: "
+          total += total_time
+          total += ' ┃'
+          output += "\n#{total}"
+          output += "\n#{footer}"
+          output
+        else
+          output = []
+          sorted_tags_data.reverse.each do |k, v|
+            spacer = ''
+            (max - k.length).times do
+              spacer += ' '
+            end
+            output.push("#{k}:#{spacer}#{v.time_string(format: :clock)}")
+          end
+
+          output = output.empty? ? '' : "\n--- Tag Totals ---\n#{output.join("\n")}"
+          output += "\n\nTotal tracked: #{total.time_string(format: :clock)}\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
+end

data/lib/doing/wwid/wwidutil.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Doing
+  class WWID
+    # Util methods for WWID class
+    module WWIDUtil
+      ##
+      ## Remove items from an array that already exist in
+      ## @content based on start and end times
+      ##
+      ## @param      items       [Array] The items to
+      ##                         deduplicate
+      ## @param      no_overlap  [Boolean] Remove items with
+      ##                         overlapping time spans
+      ##
+      def dedup(items, no_overlap: false)
+        items.delete_if do |item|
+          duped = false
+          @content.each do |comp|
+            duped = no_overlap ? item.overlapping_time?(comp) : item.same_time?(comp)
+            break if duped
+          end
+          logger.count(:skipped, level: :debug, message: '%count overlapping %items') if duped
+          # logger.log_now(:debug, 'Skipped:', "overlapping entry: #{item.title}") if duped
+          duped
+        end
+      end
+
+      ##
+      ## Imports external entries
+      ##
+      ## @param      paths  [String] Path to JSON report file
+      ## @param      opt    [Hash] Additional Options
+      ##
+      def import(paths, opt)
+        opt ||= {}
+        Plugins.plugins[:import].each do |_, options|
+          next unless opt[:type] =~ /^(#{options[:trigger].normalize_trigger})$/i
+
+          if paths.count.positive?
+            paths.each do |path|
+              options[:class].import(self, path, options: opt)
+            end
+          else
+            options[:class].import(self, nil, options: opt)
+          end
+          break
+        end
+      end
+
+      ##
+      ## Load configuration files and updated the @settings
+      ## attribute with a Doing::Configuration object
+      ##
+      ## @param      filename  [String] (optional) path to
+      ##                       alternative config file
+      ##
+      def configure(filename = nil)
+        logger.benchmark(:configure, :start)
+
+        if filename
+          Doing.config_with(filename, { ignore_local: true })
+        elsif ENV['DOING_CONFIG']
+          Doing.config_with(ENV['DOING_CONFIG'], { ignore_local: true })
+        end
+
+        logger.benchmark(:configure, :finish)
+
+        Doing.set('backup_dir', ENV['DOING_BACKUP_DIR']) if ENV['DOING_BACKUP_DIR']
+      end
+
+      ##
+      ## Get difference between current content and last backup
+      ##
+      ## @param      filename  [String] The file path
+      ##
+      def get_diff(filename = nil)
+        configure if Doing.settings.nil?
+
+        filename ||= Doing.setting('doing_file')
+        init_doing_file(filename)
+        current_content = @content.clone
+        backup_file = Util::Backup.last_backup(filename, count: 1)
+        raise DoingRuntimeError, 'No undo history to diff' if backup_file.nil?
+
+        backup = WWID.new
+        backup.config = Doing.settings
+        backup.init_doing_file(backup_file)
+        current_content.diff(backup.content)
+      end
+
+      ##
+      ## Return a hash of changes between initial file read
+      ## and current Items object
+      ##
+      ## @return     [Hash] Hash containing `added` and
+      ##             `removed` keys with arrays of Item
+      ##
+      def changes
+        @content.diff(@initial_content)
+      end
+    end
+  end
+end