jirametrics 2.10 → 2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6d6dd1e6c2811b1395ef0ce25d1458db4c3b88c2e4ab774e6c2db045549e51e
-  data.tar.gz: 53d614e48e61a7fad285d72de82f6f59a0c9024c33f39b36478c7c01866150c2
+  metadata.gz: f219c386b574f433dbaf649b9b7cccc42114401b45ff703a7c8f228c52d815c4
+  data.tar.gz: 68af46ec7256e3b4004c4fd8016d52b17b0fa2bb717e9265b164dc5fa59fca56
 SHA512:
-  metadata.gz: '079f3d1f72a7d4cfd3d3da08d508cacfe4f04d6926e3674d5c6654cb290b8f1a1d7bbdb585bc587b743a888b85a19714294cdd15a9f891e2a7b52f5303b70d6f'
-  data.tar.gz: 9a6bdfbe92dc04d8264efad3d6be1569383f604968fa3c83fbda33fb20b25210b545cb86102a1e51926348f58aad97328c119be772e15f72090932fc40fff5d4
+  metadata.gz: 71d289169562b3e4029549ab0db5ef1c4d25bc933d860f6f2a834f6caa39bbb5de93db2932996b7a5d75b4b6fb16f021ac5666cad3d57092dea6b4db4f8b7e97
+  data.tar.gz: 425c213d81982d99f9d933d7ad8dbeb4f87f92ec97188d763b51edcb2f7b85a1072da80c0a5df8566a6325223e9b35d98b180e18fd67d1e50cb2d44b1b0e3872

data/lib/jirametrics/aging_work_in_progress_chart.rb

@@ -2,6 +2,7 @@
 
 require 'jirametrics/chart_base'
 require 'jirametrics/groupable_issue_chart'
+require 'jirametrics/board_movement_calculator'
 
 class AgingWorkInProgressChart < ChartBase
   include GroupableIssueChart
@@ -16,13 +17,33 @@ class AgingWorkInProgressChart < ChartBase
         This chart shows only work items that have started but not completed, grouped by the column
         they're currently in. Hovering over a dot will show you the ID of that work item.
       </p>
-      <div>
-        The #{color_block '--non-working-days-color'} shaded area indicates the 85%
-        mark for work items that have passed through here; 85% of
-        previous work items left this column while still inside the shaded area. Any work items above
-        the shading are outliers and they are the items that you should pay special attention to.
+      <p>
+        The shaded areas indicate what percentage of the work has passed that column within that time.
+        Notes:
+        <ul>
+          <li>It only shows columns that are considered "in progress". If you see a column that wouldn't normally
+          be thought of that way, then likely issues were moving backwards or continued to progress after hitting
+          that column.</li>
+          <li>If you see a colour group that drops as it moves to the right, that generally indicates that
+            a different number of data points is being included in each column. Probably because tickets moved
+             backwards athough it could also indicate that a ticket jumped over columns as it moved to the right.
+           </li>
+        </ul>
+      </p>
+      <div style="border: 1px solid gray; padding: 0.2em">
+        <% @percentiles.keys.sort.reverse.each do |percent| %>
+          <span style="padding-left: 0.5em; padding-right: 0.5em; vertical-align: middle;"><%= color_block @percentiles[percent] %> <%= percent %>%</span>
+        <% end %>
       </div>
     HTML
+    percentiles(
+      50 => '--aging-work-in-progress-chart-shading-50-color',
+      85 => '--aging-work-in-progress-chart-shading-85-color',
+      98 => '--aging-work-in-progress-chart-shading-98-color',
+      100 => '--aging-work-in-progress-chart-shading-100-color'
+    )
+    show_all_columns false
+
     init_configuration_block(block) do
       grouping_rules do |issue, rule|
         rule.label = issue.type
@@ -36,13 +57,17 @@ class AgingWorkInProgressChart < ChartBase
 
     @header_text += " on board: #{@all_boards[@board_id].name}"
     data_sets = make_data_sets
-    column_headings = @board_columns.collect(&:name)
 
-    adjust_visibility_of_unmapped_status_column data_sets: data_sets, column_headings: column_headings
+    adjust_visibility_of_unmapped_status_column data_sets: data_sets
+    adjust_chart_height
 
     wrap_and_render(binding, __FILE__)
   end
 
+  def show_all_columns show = true # rubocop:disable Style/OptionalBooleanParameter
+    @show_all_columns = show
+  end
+
   def determine_board_columns
     unmapped_statuses = current_board.possible_statuses.collect(&:id)
 
@@ -51,7 +76,7 @@ class AgingWorkInProgressChart < ChartBase
 
     @fake_column = BoardColumn.new({
       'name' => '[Unmapped Statuses]',
-      'statuses' => unmapped_statuses.collect { |id| { 'id' => id.to_s } }.uniq
+      'statuses' => unmapped_statuses.collect { |id| { 'id' => id.to_s } }.uniq # rubocop:disable Performance/ChainArrayAllocation
     })
     @board_columns = columns + [@fake_column]
   end
@@ -62,7 +87,7 @@ class AgingWorkInProgressChart < ChartBase
       board.id == @board_id && board.cycletime.in_progress?(issue)
     end
 
-    percentage = 85
+    @max_age = 20
     rules_to_issues = group_issues aging_issues
     data_sets = rules_to_issues.keys.collect do |rules|
       {
@@ -73,7 +98,10 @@ class AgingWorkInProgressChart < ChartBase
             column = column_for issue: issue
             next if column.nil?
 
-            { 'y' => age,
+            @max_age = age if age > @max_age
+
+            {
+              'y' => age,
               'x' => column.name,
               'title' => ["#{issue.key} : #{issue.summary} (#{label_days age})"]
             }
@@ -83,45 +111,70 @@ class AgingWorkInProgressChart < ChartBase
         'backgroundColor' => rules.color
       }
     end
-    data_sets << {
-      'type' => 'bar',
-      'label' => "#{percentage}%",
-      'barPercentage' => 1.0,
-      'categoryPercentage' => 1.0,
-      'backgroundColor' => CssVariable['--aging-work-in-progress-chart-shading-color'],
-      'data' => days_at_percentage_threshold_for_all_columns(percentage: percentage, issues: @issues).drop(1)
-    }
-  end
 
-  def days_at_percentage_threshold_for_all_columns percentage:, issues:
-    accumulated_status_ids_per_column.collect do |_column, status_ids|
-      ages = ages_of_issues_that_crossed_column_boundary issues: issues, status_ids: status_ids
-      index = ages.size * percentage / 100
-      ages.sort[index.to_i] || 0
+    calculator = BoardMovementCalculator.new board: @all_boards[@board_id], issues: issues, today: date_range.end
+
+    column_indexes_to_remove = []
+    unless @show_all_columns
+      column_indexes_to_remove = indexes_of_leading_and_trailing_zeros(calculator.age_data_for(percentage: 100))
+
+      column_indexes_to_remove.reverse_each do |index|
+        @board_columns.delete_at index
+      end
+    end
+
+    @row_index_offset = data_sets.size
+
+    bar_data = []
+    calculator.stacked_age_data_for(percentages: @percentiles.keys).each do |percentage, data|
+      column_indexes_to_remove.reverse_each { |index| data.delete_at index }
+      color = @percentiles[percentage]
+
+      data_sets << {
+        'type' => 'bar',
+        'label' => "#{percentage}%",
+        'barPercentage' => 1.0,
+        'categoryPercentage' => 1.0,
+        'backgroundColor' => color,
+        'data' => data
+      }
+      bar_data << data
     end
+    @bar_data = adjust_bar_data bar_data
+
+    data_sets
   end
 
-  def accumulated_status_ids_per_column
-    accumulated_status_ids = []
-    @board_columns.reverse.filter_map do |column|
-      next if column == @fake_column
+  def adjust_bar_data input
+    return [] if input.empty?
+
+    row_size = input.first.size
 
-      accumulated_status_ids += column.status_ids
-      [column.name, accumulated_status_ids.dup]
-    end.reverse
+    output = []
+    output << input.first
+    input.drop(1).each do |row|
+      previous_row = output.last
+      output << 0.upto(row_size - 1).collect { |i| row[i] + previous_row[i] }
+    end
+
+    output
   end
 
-  def ages_of_issues_that_crossed_column_boundary issues:, status_ids:
-    issues.filter_map do |issue|
-      stop = issue.first_time_in_status(*status_ids)&.to_time
-      start, = issue.board.cycletime.started_stopped_times(issue)
+  def indexes_of_leading_and_trailing_zeros list
+    result = []
+    0.upto(list.size - 1) do |index|
+      break unless list[index].zero?
 
-      # Skip if either it hasn't crossed the boundary or we can't tell when it started.
-      next if stop.nil? || start.nil?
-      next if stop < start
+      result << index
+    end
 
-      (stop.to_date - start.to_date).to_i + 1
+    stop_at = result.empty? ? 0 : (result.last + 1)
+    (list.size - 1).downto(stop_at).each do |index|
+      break unless list[index].zero?
+
+      result << index if list[index].zero?
     end
+    result
   end
 
   def column_for issue:
@@ -130,7 +183,7 @@ class AgingWorkInProgressChart < ChartBase
     end
   end
 
-  def adjust_visibility_of_unmapped_status_column data_sets:, column_headings:
+  def adjust_visibility_of_unmapped_status_column data_sets:
     column_name = @fake_column.name
 
     has_unmapped = data_sets.any? do |set|
@@ -143,8 +196,19 @@ class AgingWorkInProgressChart < ChartBase
       @description_text += "<p>The items shown in #{column_name.inspect} are not visible on the " \
         'board but are still active. Most likely everyone has forgotten about them.</p>'
     else
-      column_headings.pop
+      # @column_headings.pop
       @board_columns.pop
     end
   end
+
+  def percentiles percentile_color_hash
+    @percentiles = percentile_color_hash.transform_values { |value| CssVariable[value] }
+  end
+
+  def adjust_chart_height
+    min_height = @max_age * 5
+
+    @canvas_height = min_height if min_height > @canvas_height
+    @canvas_height = 400 if min_height > 400
+  end
 end

data/lib/jirametrics/aging_work_table.rb

@@ -3,7 +3,7 @@
 require 'jirametrics/chart_base'
 
 class AgingWorkTable < ChartBase
-  attr_accessor :today, :board_id
+  attr_accessor :today
   attr_reader :any_scrum_boards
 
   def initialize block
@@ -22,18 +22,32 @@ class AgingWorkTable < ChartBase
         If there are expedited items that haven't yet started then they're at the bottom of the table.
         By the very definition of expedited, if we haven't started them already, we'd better get on that.
       </p>
+      <p>
+        Legend:
+        <ul>
+        <li><b>E:</b> Whether this item is <b>E</b>xpedited.</li>
+        <li><b>B/S:</b> Whether this item is either <b>B</b>locked or <b>S</b>talled.</li>
+        <li><b>Forecast:</b> A forecast of how long it is likely to take to finish this work item.</li>
+        </ul>
+      </p>
     TEXT
 
     instance_eval(&block)
   end
 
   def run
-    @today = date_range.end
+    initialize_calculator
     aging_issues = select_aging_issues + expedited_but_not_started
 
     wrap_and_render(binding, __FILE__)
   end
 
+  # This is its own method simply so the tests can initialize the calculator without doing a full run.
+  def initialize_calculator
+    @today = date_range.end
+    @calculator = BoardMovementCalculator.new board: current_board, issues: issues, today: @today
+  end
+
   def expedited_but_not_started
     @issues.select do |issue|
       started_time, stopped_time = issue.board.cycletime.started_stopped_times(issue)
@@ -94,26 +108,51 @@ class AgingWorkTable < ChartBase
   end
 
   def sprints_text issue
-    sprint_ids = []
-
-    issue.changes.each do |change|
-      next unless change.sprint?
-
-      sprint_ids << change.raw['to'].split(/\s*,\s*/).collect { |id| id.to_i }
-    end
-    sprint_ids.flatten!
-
-    issue.board.sprints.select { |s| sprint_ids.include? s.id }.collect do |sprint|
+    issue.sprints.collect do |sprint|
       icon_text = nil
       if sprint.active?
         icon_text = icon_span title: 'Active sprint', icon: '➡️'
-      else
+      elsif sprint.closed?
         icon_text = icon_span title: 'Sprint closed', icon: '✅'
       end
       "#{sprint.name} #{icon_text}"
     end.join('<br />')
   end
 
+  def dates_text issue
+    date = date_range.end
+    due = issue.due_date
+    message = nil
+
+    days_remaining, error = @calculator.forecasted_days_remaining_and_message issue: issue, today: @today
+
+    unless error
+      if due
+        if due < date
+          message = "Due: <b>#{due}</b> (#{label_days (@today - due).to_i} ago)"
+          error = 'Overdue'
+        elsif due == date
+          message = 'Due: <b>today</b>'
+        else
+          error = 'Due date at risk' if date_range.end + days_remaining > due
+          message = "Due: <b>#{due}</b> (#{label_days (due - @today).to_i})"
+        end
+      else
+        "#{label_days days_remaining} left."
+      end
+    end
+
+    text = +''
+    text << "<span title='#{error}' style='color: red'>ⓘ </span>" if error
+    if days_remaining
+      text << "#{label_days days_remaining} left"
+    else
+      text << 'Unable to forecast'
+    end
+    text << ' | ' << message if message
+    text
+  end
+
   def age_cutoff age = nil
     @age_cutoff = age.to_i if age
     @age_cutoff
@@ -133,4 +172,8 @@ class AgingWorkTable < ChartBase
 
     result.reverse
   end
+
+  def priority_text issue
+    "<img src='#{issue.priority_url}' title='Priority: #{issue.priority_name}' />"
+  end
 end

data/lib/jirametrics/atlassian_document_format.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+class AtlassianDocumentFormat
+  attr_reader :users
+
+  def initialize users:, timezone_offset:
+    @users = users
+  end
+
+  def to_html input
+    if input.is_a? String
+      input
+        .gsub(/{color:(#\w{6})}([^{]+){color}/, '<span style="color: \1">\2</span>') # Colours
+        .gsub(/\[~accountid:([^\]]+)\]/) { expand_account_id $1 } # Tagged people
+        .gsub(/\[([^\|]+)\|(https?[^\]]+)\]/, '<a href="\2">\1</a>') # URLs
+        .gsub("\n", '<br />')
+    else
+      input['content'].collect { |element| adf_node_to_html element }.join("\n")
+    end
+  end
+
+  # ADF is Atlassian Document Format
+  # https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/
+  def adf_node_to_html node
+    closing_tag = nil
+    node_attrs = node['attrs']
+
+    result = +''
+    case node['type']
+    when 'blockquote'
+      result << '<blockquote>'
+      closing_tag = '</blockquote>'
+    when 'bulletList'
+      result << '<ul>'
+      closing_tag = '</ul>'
+    when 'codeBlock'
+      result << '<code>'
+      closing_tag = '</code>'
+    when 'date'
+      result << Time.at(node_attrs['timestamp'].to_i / 1000, in: @timezone_offset).to_date.to_s
+    when 'decisionItem'
+      result << '<li>'
+      closing_tag = '</li>'
+    when 'decisionList'
+      result << '<div>Decisions<ul>'
+      closing_tag = '</ul></div>'
+    when 'emoji'
+      result << node_attrs['text']
+    when 'expand'
+      # TODO: Maybe, someday, make this actually expandable. For now it's always open
+      result << "<div>#{node_attrs['title']}</div>"
+    when 'hardBreak'
+      result << '<br />'
+    when 'heading'
+      level = node_attrs['level']
+      result << "<h#{level}>"
+      closing_tag = "</h#{level}>"
+    when 'inlineCard'
+      url = node_attrs['url']
+      result << "[Inline card]: <a href='#{url}'>#{url}</a>"
+    when 'listItem'
+      result << '<li>'
+      closing_tag = '</li>'
+    when 'media'
+      text = node_attrs['alt'] || node_attrs['id']
+      result << "Media: #{text}"
+    when 'mediaSingle', 'mediaGroup'
+      result << '<div>'
+      closing_tag = '</div>'
+    when 'mention'
+      user = node_attrs['text']
+      result << "<b>#{user}</b>"
+    when 'orderedList'
+      result << '<ol>'
+      closing_tag = '</ol>'
+    when 'panel'
+      type = node_attrs['panelType']
+      result << "<div>#{type.upcase}</div>"
+    when 'paragraph'
+      result << '<p>'
+      closing_tag = '</p>'
+    when 'rule'
+      result << '<hr />'
+    when 'status'
+      text = node_attrs['text']
+      result << text
+    when 'table'
+      result << '<table>'
+      closing_tag = '</table>'
+    when 'tableCell'
+      result << '<td>'
+      closing_tag = '</td>'
+    when 'tableHeader'
+      result << '<th>'
+      closing_tag = '</th>'
+    when 'tableRow'
+      result << '<tr>'
+      closing_tag = '</tr>'
+    when 'text'
+      marks = adf_marks_to_html node['marks']
+      result << marks.collect(&:first).join
+      result << node['text']
+      result << marks.collect(&:last).join
+    when 'taskItem'
+      state = node_attrs['state'] == 'TODO' ? '☐' : '☑'
+      result << "<li>#{state} "
+      closing_tag = '</li>'
+    when 'taskList'
+      result << "<ul class='taskList'>"
+      closing_tag = '</ul>'
+    else
+      result << "<p>Unparseable section: #{node['type']}</p>"
+    end
+
+    node['content']&.each do |child|
+      result << adf_node_to_html(child)
+    end
+
+    result << closing_tag if closing_tag
+    result
+  end
+
+  def adf_marks_to_html list
+    return [] if list.nil?
+
+    mappings = [
+      ['strong', '<b>', '</b>'],
+      ['code', '<code>', '</code>'],
+      ['em', '<em>', '</em>'],
+      ['strike', '<s>', '</s>'],
+      ['underline', '<u>', '</u>']
+    ]
+
+    list.filter_map do |mark|
+      type = mark['type']
+      if type == 'textColor'
+        color = mark['attrs']['color']
+        ["<span style='color: #{color}'>", '</span>']
+      elsif type == 'link'
+        href = mark['attrs']['href']
+        title = mark['attrs']['title']
+        ["<a href='#{href}' title='#{title}'>", '</a>']
+      else
+        line = mappings.find { |key, _open, _close| key == type }
+        [line[1], line[2]] if line
+      end
+    end
+  end
+
+  def expand_account_id account_id
+    user = @users.find { |u| u.account_id == account_id }
+    text = account_id
+    text = "@#{user.display_name}" if user
+    "<span class='account_id'>#{text}</span>"
+  end
+end

data/lib/jirametrics/board.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
 class Board
-  attr_reader :visible_columns, :raw, :possible_statuses, :sprints, :board_type
+  attr_reader :visible_columns, :raw, :possible_statuses, :sprints
   attr_accessor :cycletime, :project_config
 
   def initialize raw:, possible_statuses:
     @raw = raw
-    @board_type = raw['type']
     @possible_statuses = possible_statuses
     @sprints = []
 
     columns = raw['columnConfig']['columns']
+    ensure_uniqueness_of_column_names! columns
 
     # For a Kanban board, the first column here will always be called 'Backlog' and will NOT be
     # visible on the board. If the board is configured to have a kanban backlog then it will have
     # statuses matched to it and otherwise, there will be no statuses.
-    columns = columns[1..] if kanban?
+    columns = columns.drop(1) if kanban?
 
     @backlog_statuses = []
     @visible_columns = columns.filter_map do |column|
@@ -66,13 +66,9 @@ class Board
     status_ids
   end
 
-  def kanban?
-    @board_type == 'kanban'
-  end
-
-  def scrum?
-    @board_type == 'scrum'
-  end
+  def board_type = raw['type']
+  def kanban? = (board_type == 'kanban')
+  def scrum? = (board_type == 'scrum')
 
   def id
     @raw['id'].to_i
@@ -88,4 +84,36 @@ class Board
   def name
     @raw['name']
   end
+
+  def accumulated_status_ids_per_column
+    accumulated_status_ids = []
+    visible_columns.reverse.filter_map do |column|
+      next if column == @fake_column
+
+      accumulated_status_ids += column.status_ids
+      [column.name, accumulated_status_ids.dup]
+    end.reverse
+  end
+
+  def ensure_uniqueness_of_column_names! json
+    all_names = []
+    json.each do |column_json|
+      name = column_json['name']
+      if all_names.include? name
+        (2..).each do |i|
+          new_name = "#{name}-#{i}"
+          next if all_names.include?(new_name)
+
+          name = new_name
+          column_json['name'] = new_name
+          break
+        end
+      end
+      all_names << name
+    end
+  end
+
+  def estimation_configuration
+    EstimationConfiguration.new raw: raw['estimation']
+  end
 end

data/lib/jirametrics/board_config.rb

@@ -13,6 +13,7 @@ class BoardConfig
     @board = @project_config.all_boards[id]
 
     instance_eval(&@block)
+    raise "Must specify a cycletime for board #{@id}" if @board.cycletime.nil?
   end
 
   def cycletime label = nil, &block