doing 2.1.113 → 2.1.115

data/lib/doing/template_string.rb

@@ -15,6 +15,7 @@ module Doing
       @original = string
       super(Doing::Color.coloring? ? Color.reset + string : string)
 
+      @stretch_widths = stretch_widths(placeholders)
       placeholders.each { |k, v| fill(k, v, wrap_width: wrap_width, color: color, tags_color: tags_color) }
     end
 
@@ -97,9 +98,8 @@ module Doing
 
     def fill(placeholder, value, wrap_width: 0, color: '', tags_color: '', reset: '')
       reparse
-      rx = /(?mi)(?<!\\)%(?<width>-?\d+)?(?:\^(?<mchar>.))?(?:(?<ichar>[ _t]|[^a-z0-9])(?<icount>\d+))?(?<prefix>.[ _t]?)?#{placeholder.sub(
-        /^%/, ''
-      )}(?<after>.*?)$/
+      placeholder_name = placeholder.sub(/^%/, '')
+      rx = /(?mi)(?<!\\)%(?<width>\*|-?\d+)?(?:\^(?<mchar>.))?(?:(?<ichar>[ _t]|[^a-z0-9])(?<icount>\d+))?(?<prefix>.[ _t]?)?#{placeholder_name}(?<after>.*?)$/
       ph = raw.match(rx)
 
       return unless ph
@@ -117,9 +117,9 @@ module Doing
         if !value.good?
           after
         else
-          pad = m['width'].to_i
+          pad = m['width'] == '*' ? next_stretch_width(placeholder_name) : m['width'].to_i
           mark = m['mchar'] || ''
-          if placeholder == 'shortdate' && m['width'].nil?
+          if placeholder_name == 'shortdate' && m['width'].nil?
             fmt_string = Doing.setting('shortdate_format.older', '%m/%d/%y %_I:%M%P', exact: true)
             pad = Date.today.strftime(fmt_string).length
           end
@@ -142,7 +142,6 @@ module Doing
 
             if wrap_width.positive? || pad.positive?
               width = pad.positive? ? pad : wrap_width
-
               out = value.gsub(/%/, '\%').strip.wrap(width,
                                                      pad: pad,
                                                      indent: indent,
@@ -184,5 +183,147 @@ module Doing
       end
       @parsed_colors = parse_colors
     end
+
+    private
+
+    def stretch_widths(placeholders)
+      keys = placeholders.keys.map { |k| Regexp.escape(k.sub(/^%/, '')) }.sort_by(&:length).reverse
+      return {} if keys.empty?
+
+      token_rx = /(?<!\\)%(?<width>\*|-?\d+)?(?:\^(?<mchar>.))?(?:(?<ichar>[ _t]|[^a-z0-9])(?<icount>\d+))?(?<prefix>.[ _t]?)?(?<name>#{keys.join('|')})/
+      queues = Hash.new { |h, k| h[k] = [] }
+      terminal_width = detected_terminal_width
+      raw.each_line do |line|
+        tokens = line.to_enum(:scan, token_rx).map { Regexp.last_match.dup }
+        next if tokens.empty?
+
+        literal_width = visible_literal_width(line.gsub(token_rx, ''))
+        reserved_width = literal_width
+        stretch_tokens = []
+
+        tokens.each do |token|
+          width_token = token['width']
+          name = token['name']
+          value = placeholders[name] || placeholders["%#{name}"]
+          natural = natural_placeholder_width(name, value)
+          if width_token == '*'
+            if block_placeholder?(name)
+              queues[name] << block_placeholder_width(terminal_width, token)
+            else
+              stretch_tokens << token
+            end
+          else
+            reserved_width += reserved_placeholder_width(width_token, natural)
+          end
+        end
+
+        next if stretch_tokens.empty?
+
+        remaining = terminal_width - reserved_width
+        widths = split_stretch_widths(remaining, stretch_tokens.length)
+        stretch_tokens.each_with_index do |token, idx|
+          queues[token['name']] << widths[idx]
+        end
+      end
+
+      queues
+    end
+
+    def split_stretch_widths(remaining, count)
+      return [] if count.zero?
+      return Array.new(count, 1) if remaining < count
+
+      base = remaining / count
+      extra = remaining % count
+      Array.new(count) { |idx| base + (idx < extra ? 1 : 0) }
+    end
+
+    def natural_placeholder_width(name, value)
+      # note placeholders are rendered on their own wrapped lines and should not
+      # reserve horizontal width on the title line
+      return 0 if block_placeholder?(name)
+      return 0 unless value.good?
+
+      normalized = if name =~ /^tags/ && value.respond_to?(:map)
+                     value.map(&:to_s).join(' ')
+                   elsif value.respond_to?(:join)
+                     value.join("\n")
+                   else
+                     value.to_s
+                   end
+
+      normalized.split("\n").map { |line| visible_literal_width(line) }.max || 0
+    end
+
+    def reserved_placeholder_width(width_token, natural_width)
+      return natural_width if width_token.nil? || width_token.empty?
+
+      minimum = width_token.to_i.abs
+      [natural_width, minimum].max
+    end
+
+    def block_placeholder?(name)
+      %w[note idnote odnote].include?(name)
+    end
+
+    def block_placeholder_width(terminal_width, token)
+      padding = block_placeholder_padding(token)
+      [terminal_width - padding, 1].max
+    end
+
+    def block_placeholder_padding(token)
+      indent = if token['ichar']
+                 char = token['ichar'] =~ /t/ ? "\t" : ' '
+                 char * token['icount'].to_i
+               else
+                 "\t"
+               end
+
+      visible_literal_width("#{indent}#{token['prefix']}")
+    end
+
+    def next_stretch_width(name)
+      widths = @stretch_widths[name]
+      return 1 if widths.nil? || widths.empty?
+
+      [widths.shift.to_i, 1].max
+    end
+
+    def visible_literal_width(string)
+      visible = strip_template_colors(string).gsub(/\\(%)/, '\1')
+      visible.uncolor.length
+    end
+
+    def detected_terminal_width
+      if $stdout.tty?
+        begin
+          require 'io/console'
+          console = IO.console
+          width = console.winsize[1].to_i if console
+          return width if width&.positive?
+        rescue StandardError
+          # Fall through to tty-screen detection.
+        end
+      end
+
+      tty_width = TTY::Screen.columns.to_i
+      return tty_width if tty_width.positive?
+
+      env_width = ENV['COLUMNS'].to_i
+      return env_width if env_width.positive?
+
+      80
+    end
+
+    def strip_template_colors(string)
+      working = string.dup
+      string.scan(/(?<!\\)(%((?:[fb]g?)?#[a-fA-F0-9]{6}|[a-z]+))/).each do |color|
+        valid_color = color[1].validate_color
+        next unless valid_color
+
+        working.sub!(/(?<!\\)%#{valid_color}/, '')
+      end
+      working
+    end
   end
 end

data/lib/doing/version.rb

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

data/lib/doing/wwid/display.rb

@@ -2,6 +2,7 @@
 
 module Doing
   class WWID
+    TEMPLATE_WIDTH_PLACEHOLDERS = %w[id tags date interval duration shortdate section title note idnote odnote chompnote].freeze
     ##
     ## Display contents of a section based on options
     ##
@@ -43,7 +44,7 @@ module Doing
           opt[:order] ||= cfg['order'] || :asc
           opt[:tag_order] ||= :asc
           opt[:tags_color] = cfg['tags_color'] || false if opt[:tags_color].nil?
-          opt[:template] ||= cfg['template']
+          opt[:template] ||= resolved_template(cfg)
           opt[:sort_tags] ||= opt[:tag_sort]
         end
 
@@ -263,7 +264,7 @@ module Doing
           opt[:wrap_width] = cfg['wrap_width']
           opt[:count] = count
           opt[:format] = cfg['date_format']
-          opt[:template] = opt[:template] || cfg['template']
+          opt[:template] = opt[:template] || resolved_template(cfg)
           opt[:order] = :asc
         end
 
@@ -372,6 +373,48 @@ module Doing
 
     private
 
+    def resolved_template(cfg)
+      template = cfg['template']
+      return template unless Doing.setting('template_version', 1).to_i >= 2
+
+      placeholders = cfg['placeholders']
+      return template unless placeholders.is_a?(Hash)
+
+      apply_placeholder_widths(template, placeholders)
+    end
+
+    def apply_placeholder_widths(template, placeholders)
+      keys = TEMPLATE_WIDTH_PLACEHOLDERS.map { |k| Regexp.escape(k) }.sort_by(&:length).reverse
+      token_rx = /(?<!\\)%(?<width>\*|-?\d+)?(?:\^(?<mchar>.))?(?:(?<ichar>[ _t]|[^a-z0-9])(?<icount>\d+))?(?<prefix>.[ _t]?)?(?<name>#{keys.join('|')})/i
+
+      template.gsub(token_rx) do
+        m = Regexp.last_match
+        name = m['name']
+
+        width = normalized_placeholder_width(placeholders[name] || placeholders[name.to_sym])
+        mchar = m['mchar'] ? "^#{m['mchar']}" : ''
+        indent = m['ichar'] ? "#{m['ichar']}#{m['icount']}" : ''
+        prefix = m['prefix'] || ''
+
+        "%#{width}#{mchar}#{indent}#{prefix}#{name}"
+      end
+    end
+
+    def normalized_placeholder_width(config)
+      width = config['width'] || config[:width] if config.is_a?(Hash)
+
+      return '' if width.nil?
+
+      case width.to_s
+      when /^stretch$/i
+        '*'
+      when /^auto$/i, /^$/
+        ''
+      else
+        width.to_i.to_s
+      end
+    end
+
     ##
     ## Generate output using available export plugins
     ##

data/man/doing.1.ronn

@@ -199,6 +199,8 @@ The config also contains templates for various command outputs. Include placehol
 
 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.
 
+`%title` and `%note` placeholders accept optional width formatting. Numeric width (for example `%60title`) wraps to that width. Negative width applies a minimum padded width. You can also use `*` as a stretch width marker (for example `%*title`), which expands that placeholder to fill remaining space on the template line based on terminal columns. Stretch width now accounts for the rendered minimum width of trailing fixed placeholders, so `%*title` expands up to where right-side content begins and that trailing content can sit at the right edge. Placeholders without any width marker keep natural rendered width and do not expand. When multiple `%*...` placeholders are on one line, remaining width is split evenly from left to right.
+
 My normal template for the `recent` command looks like this:
 
     recent:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doing
 version: !ruby/object:Gem::Version
-  version: 2.1.113
+  version: 2.1.115
 platform: ruby
 authors:
 - Brett Terpstra